tax_cloud 0.3.0 → 0.5.0

data/lib/tax_cloud/address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   # An <tt>Address</tt> defines an address in the United States.
   class Address < Record
@@ -19,9 +21,11 @@ module TaxCloud #:nodoc:
     # Returns a verified TaxCloud::Address.
     def verify
       params = to_hash.downcase_keys
-      params = params.merge(
-        'uspsUserID' => TaxCloud.configuration.usps_username
-      ) if TaxCloud.configuration.usps_username
+      if TaxCloud.configuration.usps_username
+        params = params.merge(
+          'uspsUserID' => TaxCloud.configuration.usps_username
+        )
+      end
       response = TaxCloud.client.request(:verify_address, params)
       TaxCloud::Responses::VerifyAddress.parse(response)
     end
@@ -29,8 +33,9 @@ module TaxCloud #:nodoc:
     # Complete zip code.
     # Returns a 9-digit Zip Code, when available.
     def zip
-      return nil unless zip5 && zip5.length > 0
-      [zip5, zip4].select { |z| z && z.length > 0 }.join('-')
+      return nil unless zip5 && !zip5.empty?
+
+      [zip5, zip4].select { |z| z && !z.empty? }.join('-')
     end
 
     # Convert the object to a usable hash for SOAP requests

data/lib/tax_cloud/cart_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   # A <tt>CartItem</tt> defines a single line item for the purchase. Used to calculate the tax amount.
   class CartItem < Record

data/lib/tax_cloud/client.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   # A <tt>Client</tt> communicates with the TaxCloud service.
   class Client < Savon::Client
     # Create a new client.
     def initialize
-      super wsdl: TaxCloud::WSDL_URL
+      super client_params
     end
 
     # Make a safe SOAP call.
@@ -34,16 +36,24 @@ module TaxCloud #:nodoc:
     # Authorization hash to use with all SOAP requests
     def auth_params
       return {} unless TaxCloud.configuration
+
       {
         'apiLoginID' => TaxCloud.configuration.api_login_id,
         'apiKey' => TaxCloud.configuration.api_key
       }
     end
 
-    def safe(&block)
+    def client_params
+      { wsdl: TaxCloud::WSDL_URL }.tap do |params|
+        params[:open_timeout] = TaxCloud.configuration.open_timeout if TaxCloud.configuration.open_timeout
+        params[:read_timeout] = TaxCloud.configuration.read_timeout if TaxCloud.configuration.read_timeout
+      end
+    end
+
+    def safe
       yield
     rescue Savon::SOAPFault => e
-      raise TaxCloud::Errors::SoapError.new(e)
+      raise TaxCloud::Errors::SoapError, e
     end
   end
 end

data/lib/tax_cloud/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   # TaxCloud gem configuration.
   class Configuration
@@ -7,13 +9,22 @@ module TaxCloud #:nodoc:
     attr_accessor :api_key
     # Optional USPS username.
     attr_accessor :usps_username
+    # Savon client option open_timeout.
+    attr_accessor :open_timeout
+    # Savon client option read_timeout.
+    attr_accessor :read_timeout
+
+    def initialize
+      @open_timeout = 2
+      @read_timeout = 2
+    end
 
     # Check the configuration.
     #
     # Will raise a TaxCloud::Errors::MissingConfigOption if any of the API login ID or the API key are missing.
     def check!
-      fail TaxCloud::Errors::MissingConfigOption.new('api_login_id') unless api_login_id && api_login_id.strip.length > 0
-      fail TaxCloud::Errors::MissingConfigOption.new('api_key') unless api_key && api_key.strip.length > 0
+      raise TaxCloud::Errors::MissingConfigOption, 'api_login_id' unless api_login_id && !api_login_id.strip.empty?
+      raise TaxCloud::Errors::MissingConfigOption, 'api_key' unless api_key && !api_key.strip.empty?
     end
   end
 end

data/lib/tax_cloud/errors/api_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Errors #:nodoc:
     # This error is raised when the TaxCloud service
@@ -10,8 +11,7 @@ module TaxCloud #:nodoc:
       def initialize(message, raw)
         super(compose_message('api_error',
                               message: message,
-                              raw: raw
-        ))
+                              raw: raw))
       end
     end
   end

data/lib/tax_cloud/errors/missing_config_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Errors #:nodoc:
     # This error is raised when attempting to create a new client

data/lib/tax_cloud/errors/missing_config_option_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Errors #:nodoc:
     # This error is raised when a configuration

data/lib/tax_cloud/errors/soap_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Errors #:nodoc:
     # This error is raised when a SOAP call fails.
@@ -9,15 +10,14 @@ module TaxCloud #:nodoc:
       # Create the new error.
       # === Parameters
       # [e] SOAP response.
-      def initialize(e)
-        @fault = e
-        e.to_hash.tap do |fault|
+      def initialize(exception)
+        @fault = exception
+        exception.to_hash.tap do |fault|
           fault_code = fault[:fault][:faultcode]
           fault_string = parse_fault(fault[:fault][:faultstring])
           super(compose_message('soap_error',
                                 message: fault_string,
-                                code: fault_code
-          ))
+                                code: fault_code))
         end
       end
 

data/lib/tax_cloud/errors/tax_cloud_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Errors #:nodoc:
     # Default parent TaxCloud error for all custom errors. This handles the base
@@ -25,8 +26,8 @@ module TaxCloud #:nodoc:
         @summary = create_summary(key, attributes)
         @resolution = create_resolution(key, attributes)
 
-        "\nProblem:\n  #{@problem}" +
-        "\nSummary:\n  #{@summary}" +
+        "\nProblem:\n  #{@problem}" \
+        "\nSummary:\n  #{@summary}" \
         "\nResolution:\n  #{@resolution}"
       end
 
@@ -43,7 +44,7 @@ module TaxCloud #:nodoc:
       #
       # Returns a localized error message string.
       def translate(key, options)
-        ::I18n.translate("#{BASE_KEY}.#{key}", { locale: :en }.merge(options)).strip
+        ::I18n.translate("#{BASE_KEY}.#{key}", **{ locale: :en }.merge(options)).strip
       end
 
       # Create the problem.

data/lib/tax_cloud/errors/unexpected_soap_response_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Errors #:nodoc:
     # This error is raised when TaxCloud returns an
@@ -12,8 +13,7 @@ module TaxCloud #:nodoc:
         super(compose_message('unexpected_soap_response',
                               key: key,
                               raw: raw,
-                              chain: chain
-        ))
+                              chain: chain))
       end
     end
   end

data/lib/tax_cloud/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tax_cloud/errors/tax_cloud_error'
 require 'tax_cloud/errors/missing_config_error'
 require 'tax_cloud/errors/missing_config_option_error'

data/lib/tax_cloud/record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   # A generic TaxCloud record.
   class Record

data/lib/tax_cloud/responses/authorized.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud Authorized API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=Authorized.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=Authorized.
     class Authorized < Generic
       response_key :authorized
     end

data/lib/tax_cloud/responses/authorized_with_capture.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud AuthorizedWithCapture API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=AuthorizedWithCapture.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=AuthorizedWithCapture.
     class AuthorizedWithCapture < Generic
       response_key :authorized_with_capture
     end

data/lib/tax_cloud/responses/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # A base TaxCloud SOAP response.
@@ -49,7 +51,8 @@ module TaxCloud #:nodoc:
         chain.split('/').each do |key|
           current_value = current_value[key.to_sym]
           next if current_value
-          fail TaxCloud::Errors::UnexpectedSoapResponse.new(raw, key, chain)
+
+          raise TaxCloud::Errors::UnexpectedSoapResponse.new(raw, key, chain)
         end
         current_value
       end
@@ -75,9 +78,7 @@ module TaxCloud #:nodoc:
         elsif self.dsl[:error_number]
           return true if match(self.dsl[:error_number]) == '0'
         end
-        if self.dsl[:error_message]
-          fail TaxCloud::Errors::ApiError.new(match(self.dsl[:error_message]), raw)
-        end
+        raise TaxCloud::Errors::ApiError.new(match(self.dsl[:error_message]), raw) if self.dsl[:error_message]
       end
     end
   end

data/lib/tax_cloud/responses/captured.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud Captured API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=Captured.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=Captured.
     class Captured < Generic
       response_key :captured
     end

data/lib/tax_cloud/responses/cart_item.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # A single item in the response to a TaxCloud Lookup API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=Lookup.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=Lookup.
     class CartItem
       # The index of the cart item.
       attr_accessor :cart_item_index
@@ -14,7 +18,7 @@ module TaxCloud #:nodoc:
       # [savon_response] SOAP response.
       def initialize(savon_response)
         self.cart_item_index = savon_response[:cart_item_index].to_i
-        self.tax_amount = savon_response[:tax_amount].to_f
+        self.tax_amount = BigDecimal(savon_response[:tax_amount])
       end
     end
   end

data/lib/tax_cloud/responses/generic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # A generic response to a TaxCloud API call.

data/lib/tax_cloud/responses/lookup.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud Lookup API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=Lookup.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=Lookup.
     class Lookup < Base
       # Cart ID.
       attr_accessor :cart_id
@@ -20,13 +22,13 @@ module TaxCloud #:nodoc:
         self.cart_id = match('lookup_response/lookup_result/cart_id')
         # there can be on response or an array of responses
         cart_item_responses = match('lookup_response/lookup_result/cart_items_response/cart_item_response')
-        if cart_item_responses.is_a?(Array)
-          self.cart_items = cart_item_responses.map do |cart_item_response|
-            TaxCloud::Responses::CartItem.new(cart_item_response)
-          end
-        else
-          self.cart_items = [TaxCloud::Responses::CartItem.new(cart_item_responses)]
-        end
+        self.cart_items = if cart_item_responses.is_a?(Array)
+                            cart_item_responses.map do |cart_item_response|
+                              TaxCloud::Responses::CartItem.new(cart_item_response)
+                            end
+                          else
+                            [TaxCloud::Responses::CartItem.new(cart_item_responses)]
+                          end
       end
 
       # Total tax amount in this cart.

data/lib/tax_cloud/responses/ping.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud Ping API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=Ping.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=Ping.
     class Ping < Generic
       response_key :ping
     end

data/lib/tax_cloud/responses/returned.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud Returned API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=Returned.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=Returned.
     class Returned < Generic
       response_key :returned
     end

data/lib/tax_cloud/responses/tax_code_groups.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud getTICGroups API call.
     #
-    # https://api.taxcloud.net/1.0/TaxCloud.asmx?op=GetTICGroups
+    # https://api.taxcloud.com/1.0/TaxCloud.asmx?op=GetTICGroups
     class TaxCodeGroups < Base
       response_type 'get_tic_groups_response/get_tic_groups_result/response_type'
       error_message 'get_tic_groups_response/get_tic_groups_result/messages/response_message/message'

data/lib/tax_cloud/responses/tax_codes.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud getTICs API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=GetTICs.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=GetTICs.
     class TaxCodes < Base
       response_type 'get_ti_cs_response/get_ti_cs_result/response_type'
       error_message 'get_ti_cs_response/get_ti_cs_result/messages/response_message/message'

data/lib/tax_cloud/responses/tax_codes_by_group.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud getTICsByGroup API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=GetTICsByGroup.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=GetTICsByGroup.
     class TaxCodesByGroup < Base
       response_type 'get_ti_cs_by_group_response/get_ti_cs_by_group_result/response_type'
       error_message 'get_ti_cs_by_group_response/get_ti_cs_by_group_result/messages/response_message/message'

data/lib/tax_cloud/responses/verify_address.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   module Responses #:nodoc:
     # Response to a TaxCloud VerifyAddress API call.
     #
-    # See https://api.taxcloud.net/1.0/TaxCloud.asmx?op=VerifyAddress.
+    # See https://api.taxcloud.com/1.0/TaxCloud.asmx?op=VerifyAddress.
     class VerifyAddress < Base
       error_number 'verify_address_response/verify_address_result/err_number'
       error_message 'verify_address_response/verify_address_result/err_description'

data/lib/tax_cloud/responses.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tax_cloud/responses/base'
 require 'tax_cloud/responses/generic'
 require 'tax_cloud/responses/ping'

data/lib/tax_cloud/tax_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TaxCloud #:nodoc:
   # A TIC (Taxability Information Code), otherwise known as a Tax Code.
   #