suretax 0.2.3 → 1.0.0

data/lib/suretax/api/response.rb

@@ -1,4 +1,4 @@
-require File.join( File.dirname(__FILE__), 'item_message.rb' )
+require File.join(File.dirname(__FILE__), "item_message.rb")
 
 module Suretax
   module Api
@@ -8,12 +8,12 @@ module Suretax
 
       def initialize(response_body)
         @body = JSON.generate(response_body)
-        @status = response_body.fetch('ResponseCode')
-        @transaction = response_body.fetch('TransId').to_s
-        @message = response_body.fetch('HeaderMessage')
-        @success = response_body.fetch('Successful') == 'Y'
-        @client_tracking = response_body['ClientTracking'] || nil
-        @total_tax = Amount.new(response_body['TotalTax'])
+        @status = response_body.fetch("ResponseCode")
+        @transaction = response_body.fetch("TransId").to_s
+        @message = response_body.fetch("HeaderMessage")
+        @success = response_body.fetch("Successful") == "Y"
+        @client_tracking = response_body["ClientTracking"] || nil
+        @total_tax = Amount.new(response_body["TotalTax"])
 
         build_groups(response_body)
         build_item_messages(response_body)
@@ -24,26 +24,25 @@ module Suretax
       end
 
       def item_errors?
-        @status == '9001'
+        @status == "9001"
       end
 
       private
 
-        def build_groups(response_body)
-          @groups = []
-          if response_body['GroupList'].respond_to?(:map)
-            @groups = response_body.fetch('GroupList').map do |group|
-              Group.new(group)
-            end
+      def build_groups(response_body)
+        @groups = []
+        if response_body["GroupList"].respond_to?(:map)
+          @groups = response_body.fetch("GroupList").map do |group|
+            Group.new(group)
           end
         end
+      end
 
-        def build_item_messages(response_body)
-          @item_messages =  Array(response_body.fetch('ItemMessages', [])).map do |item_message|
-            ItemMessage.new(item_message)
-          end
+      def build_item_messages(response_body)
+        @item_messages = Array(response_body.fetch("ItemMessages", [])).map do |item_message|
+          ItemMessage.new(item_message)
         end
+      end
     end
   end
 end
-

data/lib/suretax/api/tax.rb

@@ -4,17 +4,17 @@ module Suretax
       attr_reader :code, :description, :amount, :revenue, :county, :city, :rate, :taxable, :fee_rate, :tax_on_tax, :revenue_base
 
       def initialize(response_params)
-        @code = response_params.fetch('TaxTypeCode')
-        @description = response_params.fetch('TaxTypeDesc')
-        @amount = set_amount(response_params.fetch('TaxAmount').to_f)
-        @revenue = response_params['Revenue']
-        @county = response_params['CountyName']
-        @city = response_params['CityName']
-        @rate = set_amount(response_params['TaxRate'])
-        @taxable = set_amount(response_params['PercentTaxable'])
-        @fee_rate = set_amount(response_params['FeeRate'])
-        @tax_on_tax = set_amount(response_params['TaxOnTax'])
-        @revenue_base = set_amount(response_params['RevenueBase'])
+        @code = response_params.fetch("TaxTypeCode")
+        @description = response_params.fetch("TaxTypeDesc")
+        @amount = set_amount(response_params.fetch("TaxAmount").to_f)
+        @revenue = response_params["Revenue"]
+        @county = response_params["CountyName"]
+        @city = response_params["CityName"]
+        @rate = set_amount(response_params["TaxRate"])
+        @taxable = set_amount(response_params["PercentTaxable"])
+        @fee_rate = set_amount(response_params["FeeRate"])
+        @tax_on_tax = set_amount(response_params["TaxOnTax"])
+        @revenue_base = set_amount(response_params["RevenueBase"])
       end
 
       private
@@ -22,7 +22,6 @@ module Suretax
       def set_amount(value)
         Amount.new(value) unless value.nil?
       end
-
     end
   end
 end

data/lib/suretax/api/tax_amount.rb

@@ -1,11 +1,11 @@
-require 'monetize'
+require "monetize"
 
 module Suretax
   module Api
     class Amount
       attr_reader :precision, :divisor
 
-      def initialize(amount, currency = 'US6')
+      def initialize(amount, currency = "US6")
         @amount = Monetize.parse(amount, currency)
         @precision = count_significant_decimal_places
         @divisor = @amount.currency.subunit_to_unit
@@ -24,7 +24,7 @@ module Suretax
       end
 
       def cents
-        (("%.2f" % to_f).to_f * 100 ).to_i
+        (("%.2f" % to_f).to_f * 100).to_i
       end
 
       def params
@@ -40,7 +40,6 @@ module Suretax
       def count_significant_decimal_places
         @amount.currency.subunit_to_unit.to_s.scan(/0/).count
       end
-
     end
   end
 end

data/lib/suretax/concerns.rb

@@ -1,7 +1,5 @@
 module Suretax
   module Concerns
-
-    require 'suretax/concerns/validatable'
-
+    require "suretax/concerns/validatable"
   end
 end

data/lib/suretax/concerns/validatable.rb

@@ -1,7 +1,5 @@
 module Suretax::Concerns
-
   module Validatable
-
     def self.included(base)
       base.extend ClassMethods
       base.send(:include, Validations)
@@ -11,18 +9,17 @@ module Suretax::Concerns
       @errors = Errors.new
 
       self.class.validatable_attributes.each do |attribute_name|
-        value = self.send(attribute_name)
-        assertion = self.send("valid_#{attribute_name}?", value)
+        value = send(attribute_name)
+        assertion = send("valid_#{attribute_name}?", value)
 
         @errors[attribute_name] = Error.new(attribute_name, value) unless assertion
       end
 
       @errors
     end
-    alias_method :validate!, :errors
+    alias validate! errors
 
     class Error
-
       attr_accessor :message, :value, :attribute
 
       def initialize(attribute, value)
@@ -38,14 +35,14 @@ module Suretax::Concerns
       end
 
       def format_nested_errors(value)
-        value.map { |obj| obj.errors.messages.join(', ') }
+        value.map { |obj| obj.errors.messages.join(", ") }
       end
 
       def format_error(value)
         if value.nil?
           "nil"
         elsif value.is_a?(String) && value.empty?
-          %Q{''}
+          %('')
         else
           value
         end
@@ -56,15 +53,13 @@ module Suretax::Concerns
       end
     end
 
-    class Errors < Hash 
-
+    class Errors < Hash
       def messages
-        self.map { |key, value| value.message }
+        map { |_key, value| value.message }
       end
     end
 
     module ClassMethods
-
       attr_writer :validatable_attributes
 
       def validate(*attribute_names)
@@ -77,7 +72,6 @@ module Suretax::Concerns
     end
 
     module Validations
-
       def valid_data_year?(value)
         return false if blank?(value)
         value.length == 4 &&
@@ -85,11 +79,11 @@ module Suretax::Concerns
       end
 
       def valid_data_month?(value)
-        matches?(value,month_list_subexpression)
+        matches?(value, month_list_subexpression)
       end
 
       def valid_items?(items)
-        ! items.any? {|item| item.errors.any? }
+        items.none? { |item| item.errors.any? }
       end
 
       def valid_list?(value)
@@ -100,7 +94,7 @@ module Suretax::Concerns
         return false if blank?(value)
         numeric?(value) && value.length <= 10
       end
-      alias_method :valid_customer_number?, :valid_client_number?
+      alias valid_customer_number? valid_client_number?
 
       def valid_business_unit?(value)
         blank?(value) || (value.length <= 20 && alphanumeric?(value))
@@ -117,7 +111,7 @@ module Suretax::Concerns
       end
 
       def valid_return_file_code?(value)
-        matches?(value.to_s,'[Q0]')
+        matches?(value.to_s, "[Q0]")
       end
 
       def valid_client_tracking?(value)
@@ -129,7 +123,7 @@ module Suretax::Concerns
       end
 
       def valid_response_type?(value)
-        matches?(value, '[DS][1-9]')
+        matches?(value, "[DS][1-9]")
       end
 
       def valid_line_number?(value)
@@ -160,14 +154,14 @@ module Suretax::Concerns
       def valid_tax_exemption_code_list?(value)
         valid_list?(value) && !blank?(value.first)
       end
-      alias_method :valid_tax_exemption_codes?, :valid_tax_exemption_code_list?
+      alias valid_tax_exemption_codes? valid_tax_exemption_code_list?
 
       def optional_north_american_phone_number?(value)
         blank?(value) || north_american_phone_number?(value)
       end
-      alias_method :valid_bill_to_number?, :optional_north_american_phone_number?
-      alias_method :valid_orig_number?, :optional_north_american_phone_number?
-      alias_method :valid_term_number?, :optional_north_american_phone_number?
+      alias valid_bill_to_number? optional_north_american_phone_number?
+      alias valid_orig_number? optional_north_american_phone_number?
+      alias valid_term_number? optional_north_american_phone_number?
 
       private
 
@@ -184,24 +178,24 @@ module Suretax::Concerns
       end
 
       def numeric?(value)
-        matches?(value,'\d+')
+        matches?(value, '\d+')
       end
 
       def alphanumeric?(value)
-        matches?(value,'[a-z0-9]+')
+        matches?(value, "[a-z0-9]+")
       end
 
       def blank?(value)
-        value.nil? || matches?(value,'\s*')
+        value.nil? || matches?(value, '\s*')
       end
 
-      def matches?(value,subexpression)
+      def matches?(value, subexpression)
         /\A#{subexpression}\z/i === value
       end
 
       # Month numbers 1-12 with optional leading zero
       def month_list_subexpression
-        "0?(?:" + (1..12).to_a.join('|') + ")"
+        "0?(?:" + (1..12).to_a.join("|") + ")"
       end
     end
   end

data/lib/suretax/configuration.rb

@@ -4,8 +4,8 @@ module Suretax
   class Configuration
     include Singleton
 
-    REQUEST_VERSIONS = [1, 2, 3, 4]
-    CANCEL_VERSIONS  = [1]
+    REQUEST_VERSIONS = [1, 2, 3, 4].freeze
+    CANCEL_VERSIONS  = [1].freeze
 
     attr_accessor :validation_key, :base_url, :client_number,
       :request_version, :cancel_version, :logger
@@ -43,18 +43,18 @@ module Suretax
 
     def request_path
       @request_path ||=
-        '/Services/V%02d/SureTax.asmx/PostRequest' % request_version
+        "/Services/V%02d/SureTax.asmx/PostRequest" % request_version
     end
 
     def cancel_path
       @cancel_path ||=
-        '/Services/V%02d/SureTax.asmx/CancelPostRequest' % cancel_version
+        "/Services/V%02d/SureTax.asmx/CancelPostRequest" % cancel_version
     end
 
     private
 
     def test_host
-      'https://testapi.taxrating.net'
+      "https://testapi.taxrating.net"
     end
 
     def register_currencies
@@ -63,22 +63,19 @@ module Suretax
 
     def register_dollar_with_six_decimal_places
       Money::Currency.register(
-        {
-          priority: 1,
-          iso_code: "US6",
-          iso_numeric: "840",
-          name: "Dollar with six decimal places",
-          symbol: "$",
-          subunit: "Cent",
-          subunit_to_unit: 1000000,
-          symbol_first: true,
-          html_entity: "$",
-          decimal_mark: ".",
-          thousands_separator: ",",
-          symbolize_names: true
-        }
+        priority: 1,
+iso_code: "US6",
+iso_numeric: "840",
+name: "Dollar with six decimal places",
+symbol: "$",
+subunit: "Cent",
+subunit_to_unit: 1_000_000,
+symbol_first: true,
+html_entity: "$",
+decimal_mark: ".",
+thousands_separator: ",",
+symbolize_names: true
       )
     end
-
   end
 end

data/lib/suretax/connection.rb

@@ -1,14 +1,13 @@
-require 'uri'
-require 'json'
+require "uri"
+require "json"
 
 module Suretax
-
   class Connection
     attr_accessor :headers
 
     def initialize(args = {})
       @link = Excon.new(args[:base_url] || api_host)
-      @headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      @headers = { "Content-Type" => "application/x-www-form-urlencoded" }
     end
 
     def post(body = {})
@@ -46,5 +45,4 @@ module Suretax
       Suretax.configuration
     end
   end
-
 end

data/lib/suretax/constants/regulatory_codes.rb

@@ -1,11 +1,11 @@
 module Suretax
   REGULATORY_CODES = {
-    ilec:     '00', 
-    ixc:      '01', 
-    clec:     '02', 
-    voip:     '03', 
-    isp:      '04', 
-    wireless: '05', 
-    default:  '99'
-  }
+    ilec:     "00",
+    ixc:      "01",
+    clec:     "02",
+    voip:     "03",
+    isp:      "04",
+    wireless: "05",
+    default:  "99"
+  }.freeze
 end

data/lib/suretax/constants/response_groups.rb

@@ -1,8 +1,8 @@
 module Suretax
-  RESPONSE_GROUPS = { 
-    by_state: '00', 
-    by_state_and_invoice: '01', 
-    by_state_and_customer: '02', 
-    by_state_and_customer_and_invoice: '03' 
-  }
+  RESPONSE_GROUPS = {
+    by_state: "00",
+    by_state_and_invoice: "01",
+    by_state_and_customer: "02",
+    by_state_and_customer_and_invoice: "03"
+  }.freeze
 end

data/lib/suretax/constants/sales_type_codes.rb

@@ -1,8 +1,8 @@
 module Suretax
   SALES_TYPE_CODES = {
-    residential:  'R', 
-    business:     'B', 
-    industrial:   'I', 
-    lifeline:     'L' 
-  }
+    residential:  "R",
+    business:     "B",
+    industrial:   "I",
+    lifeline:     "L"
+  }.freeze
 end

data/lib/suretax/constants/tax_situs_codes.rb

@@ -1,12 +1,12 @@
 module Suretax
-  TAX_SITUS_RULES =  { 
-    two_of_three:       '01', 
-    billed_to_number:   '02',
-    origination_number: '03', 
-    billing_zip:        '04', 
-    billing_zip_plus_4: '05',
-    private_lines:      '06', 
-    point_to_point:     '07', 
-    vat:                '14' 
-  }
+  TAX_SITUS_RULES = {
+    two_of_three:       "01",
+    billed_to_number:   "02",
+    origination_number: "03",
+    billing_zip:        "04",
+    billing_zip_plus_4: "05",
+    private_lines:      "06",
+    point_to_point:     "07",
+    vat:                "14"
+  }.freeze
 end