Initial Ruby SDK commit

Author: marcus

.gitignore

@@ -48,3 +48,6 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.DS_Store
+tags

.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--protected
+--markup markdown
+-
+LICENSE

Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

avatax.gemspec

@@ -0,0 +1,39 @@
+require File.expand_path('../lib/avatax/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rake', '~> 12.0.0')
+  s.add_development_dependency('rspec', '~> 3.0.0')
+  s.add_development_dependency('webmock', '>= 2.0.0')
+  s.add_runtime_dependency('faraday', '>= 0.10')
+  s.add_runtime_dependency('faraday_middleware', '>= 0.10')
+  s.add_runtime_dependency('multi_json', '>= 1.0.3')
+  s.add_runtime_dependency('hashie', '>= 3.0.0')
+  s.authors = ["Marcus Vorwaller"]
+  s.description = %q{A Ruby wrapper for the AvaTax REST and Search APIs}
+  s.post_install_message =<<eos
+********************************************************************************
+
+AvaTax REST API
+------------------------------
+Our developer site documents the AvaTax REST API.
+(http://developer.avatax.com).
+Blog
+----------------------------
+The Developer Blog is a great place to learn more about the API and AvaTax integrations
+Subscribe to the RSS feed be notified of new posts:
+(http://developer.avatax.com/blog).
+
+********************************************************************************
+eos
+  s.email = ['marcus.vorwaller@avalara.com']
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/avadev/AvaTax-REST-V2-Ruby-SDK'
+  s.name = 'avatax'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 2.0.0') if s.respond_to? :required_rubygems_version=
+  s.summary = %q{Ruby wrapper for the AvaTax API}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = AvaTax::VERSION.dup
+end

lib/avatax.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../avatax/configuration', __FILE__)
+require File.expand_path('../avatax/api', __FILE__)
+require File.expand_path('../avatax/client', __FILE__)
+
+module AvaTax
+  extend Configuration
+
+  # Alias for Avatax::Client.new
+  #
+  # @return [Avatax::Client]
+  def self.client(options={})
+    AvaTax::Client.new(options)
+  end
+
+  # Delegate to AvaTax::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to AvaTax::Client
+  def self.respond_to?(method, include_all=false)
+    return client.respond_to?(method, include_all) || super
+  end
+
+end

lib/avatax/api.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module AvaTax
+  class API
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = AvaTax.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+  end
+end

lib/avatax/client.rb

@@ -0,0 +1,7 @@
+module AvaTax
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include AvaTax::Client::Accounts
+  end
+end

lib/avatax/client/accounts.rb

@@ -0,0 +1,59 @@
+module AvaTax
+  class Client
+    module Accounts
+      # Retrieve all accounts
+      #
+      # # For Registrar Use Only
+      #
+      # @param options [Hash] with include, filter, top, skip, and order_by params
+      # @return [Hashie::Mash] The requested accounts.
+      # @example Returns a list of accounts
+      #   AvaTax.accounts({ $filter: '' })
+      #
+      # _You must be authenticated as an Avalara Registrar to use this route_
+      # @see http://developer.avalara.com/avatax/filtering-in-rest/ More information on filtering in REST
+      def accounts(options={})
+        get('/api/v2/accounts', options)
+      end
+
+      # Retrieve an account
+      #
+      # @param include [Array] an array of child objects to return underneath the primary object.
+      # The include array can contain
+      #
+      # * Subscriptions
+      # * Users 
+      # @return [Hashie::Mash] The requested accounts.
+      # @example Returns a list of accounts
+      #   AvaTax.accounts({ $filter: 'id in (111444, 222555)' })
+      def account(id, include=[])
+        if !include.empty?
+          options = {
+            '$include': include.join(','),
+          }
+        end
+        get("/api/v2/accounts/#{id}", options || {})
+      end
+
+      # Resets the existing license key for this account to a new key. To reset your account, you must specify the ID of the account you wish to reset and confirm the action. Resetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created.
+      #
+      # @param options [Hash] should be a hash with { confirmResetLicenseKey: true }
+      #
+      # @return [Hashie::Mash] The result of the action
+      #
+      # @example
+      #   AvaTax.reset_license_key(4444999, { confirmLicenseKey: true })
+      #```
+      # {
+      #  "accountId": 123456789,
+      #  "privateLicenseKey": "742A02AA463CDE741E932EC365360CA3CF378BD9",
+      #  "httpRequestHeader": "Basic MTIzNDU2Nzg5Ojc0MkEwMkFBNDYzQ0RFNzQxRTkzMkVDMzY1MzYwQ0EzQ0YzNzhCRDk="
+      # }
+      #```
+     def reset_license_key(id, options={})
+        post("/api/v2/accounts/#{id}/resetlicensekey", options)
+      end
+
+    end
+  end
+end

lib/avatax/configuration.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module AvaTax
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :app_name,
+      :app_version,
+      :machine_name,
+      :environment,
+      :endpoint,
+      :user_agent,
+      :username,
+      :password,
+      :connection_options,
+      :logger,
+    ].freeze
+
+    DEFAULT_APP_NAME = nil
+    DEFAULT_APP_VERSION = nil
+    DEFAULT_MACHINE_NAME = nil
+    DEFAULT_ENDPOINT = 'https://rest.avatax.com'
+    DEFAULT_USER_AGENT = "AvaTax Ruby Gem #{AvaTax::VERSION}".freeze
+    DEFAULT_USERNAME = nil
+    DEFAULT_PASSWORD = nil
+    DEFAULT_CONNECTION_OPTIONS = {}
+    DEFAULT_LOGGER = false
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Reset config values when extended
+    def self.extended(base)
+      base.reset
+    end
+
+    # Allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.app_name = DEFAULT_APP_NAME
+      self.app_version = DEFAULT_APP_VERSION
+      self.machine_name = DEFAULT_MACHINE_NAME
+      self.endpoint = DEFAULT_ENDPOINT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.username = DEFAULT_USERNAME
+      self.password = DEFAULT_PASSWORD
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.logger = DEFAULT_LOGGER
+    end
+
+  end
+end

lib/avatax/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday_middleware'
+
+module AvaTax
+
+  module Connection
+    private
+
+    def connection
+      options = {
+        :headers => {'Accept' => "application/json; charset=utf-8", 'User-Agent' => user_agent},
+        :url => endpoint,
+      }.merge(connection_options)
+
+      c = Faraday::Connection.new(options)
+      c.use Faraday::Response::ParseJson
+      c.response :logger if logger
+      c.use Faraday::Request::UrlEncoded
+      c.basic_auth(username, password)
+
+      c
+    end
+  end
+end

lib/avatax/request.rb

@@ -0,0 +1,37 @@
+require 'hashie'
+
+module AvaTax
+  module Request
+
+    def get(path, options)
+      request(:get, path, options)
+    end
+
+    def post(path, options)
+      request(:post, path, options)
+    end
+
+    def put(path, options)
+      request(:put, path, options)
+    end
+
+    def delete(path, options)
+      request(:delete, path, options)
+    end
+
+    def request(method, path, options)
+      response = connection.send('get') do |request|
+        case method
+        when :get, :delete
+          request.url(URI.encode(path), options)
+        when :post, :put
+          request.path = URI.encode(path)
+          request.body = options unless options.empty?
+        end
+      end
+
+      ::Hashie::Mash.new response.body
+    end
+
+  end
+end

lib/avatax/version.rb

@@ -0,0 +1,3 @@
+module AvaTax
+  VERSION = '0.0.1'.freeze unless defined?(::AvaTax::VERSION)
+end

spec/avatax/client/accounts_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe AvaTax::Client do
+  before do
+    @client = AvaTax::Client.new()
+  end
+
+  describe ".accounts" do
+    before do
+      stub_get("/api/v2/accounts").
+        to_return(:body => fixture("accounts.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.accounts()
+      expect(a_get("/api/v2/accounts")).to have_been_made
+    end
+
+    it "should return an array of accounts" do
+      accounts = @client.accounts
+      expect(accounts).to be_a Object
+      expect(accounts['value'].first['id']).to equal 200000251
+      expect(accounts.value.first.id).to equal 200000251
+    end
+  end
+end