avatax 21.9.0 → 22.2.0

data/lib/avatax/client.rb

@@ -1,35 +1,37 @@
-module AvaTax
-  class Client < API
-    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
-
-    include AvaTax::Client::Accounts
-    include AvaTax::Client::Addresses
-    include AvaTax::Client::Batches
-    include AvaTax::Client::CertExpressInvites
-    include AvaTax::Client::Companies
-    include AvaTax::Client::Contacts
-    include AvaTax::Client::Customers
-    include AvaTax::Client::Definitions
-    include AvaTax::Client::FilingCalendars
-    include AvaTax::Client::Filings
-    include AvaTax::Client::Free
-    include AvaTax::Client::FundingRequests
-    include AvaTax::Client::Items
-    include AvaTax::Client::JurisdictionOverrides
-    include AvaTax::Client::Locations
-    include AvaTax::Client::Nexus
-    include AvaTax::Client::Notices
-    include AvaTax::Client::Onboarding
-    include AvaTax::Client::PointOfSale
-    include AvaTax::Client::Registrar
-    include AvaTax::Client::Settings
-    include AvaTax::Client::Subscriptions
-    include AvaTax::Client::TaxCodes
-    include AvaTax::Client::TaxContent
-    include AvaTax::Client::TaxRules
-    include AvaTax::Client::Transactions
-    include AvaTax::Client::Upcs
-    include AvaTax::Client::Users
-    include AvaTax::Client::Utilities
-  end
-end
+module AvaTax
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include AvaTax::Client::Accounts
+    include AvaTax::Client::Addresses
+    include AvaTax::Client::Batches
+    include AvaTax::Client::CertExpressInvites
+    include AvaTax::Client::Companies
+    include AvaTax::Client::Contacts
+    include AvaTax::Client::Customers
+    include AvaTax::Client::Definitions
+    include AvaTax::Client::FilingCalendars
+    include AvaTax::Client::Filings
+    include AvaTax::Client::Free
+    include AvaTax::Client::FundingRequests
+    include AvaTax::Client::Items
+    include AvaTax::Client::JurisdictionOverrides
+    include AvaTax::Client::Locations
+    include AvaTax::Client::Nexus
+    include AvaTax::Client::Notices
+    include AvaTax::Client::Onboarding
+    include AvaTax::Client::PointOfSale
+    include AvaTax::Client::Registrar
+    include AvaTax::Client::Settings
+    include AvaTax::Client::Subscriptions
+    include AvaTax::Client::TaxCodes
+    include AvaTax::Client::TaxContent
+    include AvaTax::Client::TaxRules
+    include AvaTax::Client::Transactions
+    include AvaTax::Client::Upcs
+    include AvaTax::Client::Users
+    include AvaTax::Client::Utilities
+    include AvaTax::Client::ShippingVerification
+    include AvaTax::Client::AgeVerification
+  end
+end

data/lib/avatax/configuration.rb

@@ -1,76 +1,76 @@
-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,
-      :custom_logger,
-      :custom_logger_options,
-      :proxy,
-      :faraday_response,
-      :response_big_decimal_conversion
-    ].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 = {request: {timeout: 1200}} # timeout in seconds
-    DEFAULT_LOGGER = false
-    DEFAULT_CUSTOM_LOGGER = nil
-    DEFAULT_CUSTOM_LOGGER_OPTIONS = {}
-    DEFAULT_PROXY = nil
-    DEFAULT_FARADAY_RESPONSE = false
-    DEFAULT_RESPONSE_BIG_DECIMAL_CONVERSION = 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
-      self.custom_logger = DEFAULT_CUSTOM_LOGGER
-      self.custom_logger_options = DEFAULT_CUSTOM_LOGGER_OPTIONS
-      self.proxy = DEFAULT_PROXY
-      self.faraday_response = DEFAULT_FARADAY_RESPONSE
-      self.response_big_decimal_conversion = DEFAULT_RESPONSE_BIG_DECIMAL_CONVERSION
-    end
-
-  end
-end
+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,
+      :custom_logger,
+      :custom_logger_options,
+      :proxy,
+      :faraday_response,
+      :response_big_decimal_conversion
+    ].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 = {request: {timeout: 1200}} # timeout in seconds
+    DEFAULT_LOGGER = false
+    DEFAULT_CUSTOM_LOGGER = nil
+    DEFAULT_CUSTOM_LOGGER_OPTIONS = {}
+    DEFAULT_PROXY = nil
+    DEFAULT_FARADAY_RESPONSE = false
+    DEFAULT_RESPONSE_BIG_DECIMAL_CONVERSION = 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
+      self.custom_logger = DEFAULT_CUSTOM_LOGGER
+      self.custom_logger_options = DEFAULT_CUSTOM_LOGGER_OPTIONS
+      self.proxy = DEFAULT_PROXY
+      self.faraday_response = DEFAULT_FARADAY_RESPONSE
+      self.response_big_decimal_conversion = DEFAULT_RESPONSE_BIG_DECIMAL_CONVERSION
+    end
+
+  end
+end

data/lib/avatax/connection.rb

@@ -1,49 +1,49 @@
-require 'faraday_middleware'
-
-module AvaTax
-
-  module Connection
-    private
-    AUTHORIZATION_FILTER_REGEX = /(Authorization\:\ \"Basic\ )(\w+)\=/
-    REMOVED_LABEL = '\1[REMOVED]'
-
-    def connection
-      client_id = "#{app_name};#{app_version};RubySdk;#{AvaTax::VERSION.dup};#{machine_name}"
-      options = {
-        :headers =>
-          {
-           'Accept' => "application/json; charset=utf-8",
-           'User-Agent' => user_agent,
-           'X-Avalara-Client' => client_id
-          },
-        :url => endpoint,
-        :proxy => proxy
-      }.merge(connection_options)
-
-      Faraday.new(options) do |faraday|
-        if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.2.2') and response_big_decimal_conversion
-          Oj.default_options = {
-            bigdecimal_load: :bigdecimal
-          }
-        end
-
-        faraday.response :json, content_type: /\bjson$/
-        faraday.basic_auth(username, password)
-
-        if logger
-          faraday.response :logger do |logger|
-            logger.filter(AUTHORIZATION_FILTER_REGEX, REMOVED_LABEL)
-          end
-        end
-
-        if custom_logger
-          faraday.response :logger, custom_logger, custom_logger_options do |logger|
-            logger.filter(AUTHORIZATION_FILTER_REGEX, REMOVED_LABEL)
-          end
-        end
-
-        faraday.adapter Faraday.default_adapter
-      end
-    end
-  end
-end
+require 'faraday_middleware'
+
+module AvaTax
+
+  module Connection
+    private
+    AUTHORIZATION_FILTER_REGEX = /(Authorization\:\ \"Basic\ )(\w+)\=/
+    REMOVED_LABEL = '\1[REMOVED]'
+
+    def connection
+      client_id = "#{app_name};#{app_version};RubySdk;API_VERSION;#{machine_name}"
+      options = {
+        :headers =>
+          {
+           'Accept' => "application/json; charset=utf-8",
+           'User-Agent' => user_agent,
+           'X-Avalara-Client' => client_id
+          },
+        :url => endpoint,
+        :proxy => proxy
+      }.merge(connection_options)
+
+      Faraday.new(options) do |faraday|
+        if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.2.2') and response_big_decimal_conversion
+          Oj.default_options = {
+            bigdecimal_load: :bigdecimal
+          }
+        end
+
+        faraday.response :json, content_type: /\bjson$/
+        faraday.basic_auth(username, password)
+
+        if logger
+          faraday.response :logger do |logger|
+            logger.filter(AUTHORIZATION_FILTER_REGEX, REMOVED_LABEL)
+          end
+        end
+
+        if custom_logger
+          faraday.response :logger, custom_logger, custom_logger_options do |logger|
+            logger.filter(AUTHORIZATION_FILTER_REGEX, REMOVED_LABEL)
+          end
+        end
+
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/avatax/request.rb

@@ -1,42 +1,51 @@
-require 'faraday'
-require 'json'
-
-module AvaTax
-  module Request
-
-    def get(path, options={})
-      request(:get, path, nil, options)
-    end
-
-    def post(path, model, options={})
-      request(:post, path, model, options)
-    end
-
-    def put(path, model, options={})
-      request(:put, path, model, options)
-    end
-
-    def delete(path, options={})
-      request(:delete, path, nil, options)
-    end
-
-    def request(method, path, model, options={})
-      response = connection.send(method) do |request|
-        case method
-        when :get, :delete
-          request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")
-        when :post, :put
-          request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")
-          request.headers['Content-Type'] = 'application/json'
-          request.body = model.to_json unless model.empty?
-        end
-      end
-
-      if faraday_response
-        response
-      else
-        response.body
-      end
-    end
-  end
-end
+require 'faraday'
+require 'json'
+require "erb"
+
+
+module AvaTax
+  module Request
+
+    def get(path, options={}, apiversion="")
+      request(:get, path, nil, options, apiversion)
+    end
+
+    def post(path, model, options={}, apiversion="")
+      request(:post, path, model, options, apiversion)
+    end
+
+    def put(path, model, options={}, apiversion="")
+      request(:put, path, model, options, apiversion)
+    end
+
+    def delete(path, options={}, apiversion="")
+      request(:delete, path, nil, options, apiversion)
+    end
+
+    def request(method, path, model, options={}, apiversion="")
+      response = connection.send(method) do |request|
+        request.headers['X-Avalara-Client'] = request.headers['X-Avalara-Client'].gsub("API_VERSION", apiversion)
+        case method
+        when :get, :delete
+          request.url("#{encode_path(path)}?#{URI.encode_www_form(options)}")
+        when :post, :put
+          request.url("#{encode_path(path)}?#{URI.encode_www_form(options)}")
+          request.headers['Content-Type'] = 'application/json'
+          request.body = model.to_json unless model.empty?
+        end
+      end
+
+      if faraday_response
+        response
+      else
+        response.body
+      end
+    end
+
+    private
+
+    def encode_path(path)
+      path.split('/').map { |part| ERB::Util.url_encode(part) }.join('/')
+    end
+  end
+end

data/lib/avatax/version.rb

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

data/lib/avatax.rb

@@ -1,26 +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
+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

data/spec/avatax/client/accounts_spec.rb

@@ -1,13 +1,13 @@
-require File.expand_path('../../../spec_helper', __FILE__)
-
-describe AvaTax::Client do
-
-  describe ".accounts" do
-    it "should return an array of accounts" do
-      accounts = @client.query_accounts
-      expect(accounts).to be_a Object
-      expect(accounts['value'].first['id']).to be_a Integer
-    end
-  end
-
-end
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe AvaTax::Client do
+
+  describe ".accounts" do
+    it "should return an array of accounts" do
+      accounts = @client.query_accounts
+      expect(accounts).to be_a Object
+      expect(accounts['value'].first['id']).to be_a Integer
+    end
+  end
+
+end

data/spec/avatax/client/transactions_spec.rb

@@ -1,80 +1,80 @@
-require File.expand_path('../../../spec_helper', __FILE__)
-
-describe AvaTax::Client do
-
-  describe ".transactions" do
-    before do
-      @base_transaction = {
-        type: 'SalesInvoice',
-        companyCode: @company_code,
-        date: '2017-06-05',
-        customerCode: 'ABC',
-        addresses: {
-          ShipFrom: {
-            line1: "123 Main Street",
-            city: "Irvine",
-            region: "CA",
-            country: "US",
-            postalCode: "92615"
-          },
-          ShipTo: {
-            line1: "100 Market Street",
-            city: "San Francisco",
-            region: "CA",
-            country: "US",
-            postalCode: "94105"
-          }
-        },
-        lines: [{amount: 100}]
-      }
-    end
-
-    it "should create a transaction" do
-      transaction = @client.create_transaction(@base_transaction)
-      expect(transaction).to be_a Object
-      expect(transaction["id"]).to be_a Integer
-      expect(transaction["status"]).to eq "Saved"
-    end
-
-  end
-
-
-  # Test the option of faraday_response, the returned response should be a type of Faraday response rather than Hashie
-  describe ".transaction_with_faraday_response" do
-    before do
-      @client.faraday_response = true
-      @base_transaction = {
-        type: 'SalesInvoice',
-        companyCode: @company_code,
-        date: '2017-06-05',
-        customerCode: 'ABC',
-        addresses: {
-          ShipFrom: {
-            line1: "123 Main Street",
-            city: "Irvine",
-            region: "CA",
-            country: "US",
-            postalCode: "92615"
-          },
-          ShipTo: {
-            line1: "100 Market Street",
-            city: "San Francisco",
-            region: "CA",
-            country: "US",
-            postalCode: "94105"
-          }
-        },
-        lines: [{amount: 100}]
-      }
-    end
-
-    it "should create a transaction and return the faraday response" do
-      faraday_trans = @client.create_transaction(@base_transaction)
-      expect(faraday_trans).to be_a Object
-      expect(faraday_trans["status"]) == 201
-      expect(faraday_trans["reason_phrase"]) == "Created"
-      expect(faraday_trans["request_headers"]).to be_a Object
-      expect(faraday_trans["body"]).to be_a Object
-    end
-  end
-end
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe AvaTax::Client do
+
+  describe ".transactions" do
+    before do
+      @base_transaction = {
+        type: 'SalesInvoice',
+        companyCode: @company_code,
+        date: '2017-06-05',
+        customerCode: 'ABC',
+        addresses: {
+          ShipFrom: {
+            line1: "123 Main Street",
+            city: "Irvine",
+            region: "CA",
+            country: "US",
+            postalCode: "92615"
+          },
+          ShipTo: {
+            line1: "100 Market Street",
+            city: "San Francisco",
+            region: "CA",
+            country: "US",
+            postalCode: "94105"
+          }
+        },
+        lines: [{amount: 100}]
+      }
+    end
+
+    it "should create a transaction" do
+      transaction = @client.create_transaction(@base_transaction)
+      expect(transaction).to be_a Object
+      expect(transaction["id"]).to be_a Integer
+      expect(transaction["status"]).to eq "Saved"
+    end
+
+  end
+
+
+  # Test the option of faraday_response, the returned response should be a type of Faraday response rather than Hashie
+  describe ".transaction_with_faraday_response" do
+    before do
+      @client.faraday_response = true
+      @base_transaction = {
+        type: 'SalesInvoice',
+        companyCode: @company_code,
+        date: '2017-06-05',
+        customerCode: 'ABC',
+        addresses: {
+          ShipFrom: {
+            line1: "123 Main Street",
+            city: "Irvine",
+            region: "CA",
+            country: "US",
+            postalCode: "92615"
+          },
+          ShipTo: {
+            line1: "100 Market Street",
+            city: "San Francisco",
+            region: "CA",
+            country: "US",
+            postalCode: "94105"
+          }
+        },
+        lines: [{amount: 100}]
+      }
+    end
+
+    it "should create a transaction and return the faraday response" do
+      faraday_trans = @client.create_transaction(@base_transaction)
+      expect(faraday_trans).to be_a Object
+      expect(faraday_trans["status"]) == 201
+      expect(faraday_trans["reason_phrase"]) == "Created"
+      expect(faraday_trans["request_headers"]).to be_a Object
+      expect(faraday_trans["body"]).to be_a Object
+    end
+  end
+end