suretax 0.2.3 → 1.0.0

data/lib/suretax/constants/transaction_type_codes.rb

@@ -482,6 +482,6 @@ module Suretax
     "980512" => "Leasing, Deferred Payment Contract - Greater Than 6 Months - Stream",
     "990101" => "General Sales, General Sales",
     "999999" => "General Sales, Tax Exempt Products and Services",
-    "010151" => "Long Distance, Long Distance Toll - INTRASTATE",
-  }
+    "010151" => "Long Distance, Long Distance Toll - INTRASTATE"
+  }.freeze
 end

data/lib/suretax/response.rb

@@ -1,7 +1,6 @@
-require 'json'
+require "json"
 
 module Suretax
-
   class Response
     attr_reader :response, :body, :status, :api
 
@@ -9,8 +8,8 @@ module Suretax
       @response = api_response
       sanitized_body = remove_xml_brackets(api_response.body)
 
-      if sanitized_body == 'invalid request' 
-        invalid_request_response(sanitized_body) 
+      if sanitized_body == "invalid request"
+        invalid_request_response(sanitized_body)
       else
         valid_request_response(sanitized_body)
       end
@@ -45,7 +44,7 @@ module Suretax
 
     def remove_xml_brackets(response_string)
       if matches = response_string.match(extract_json_from_urlencoded_string_regex)
-        matches['json_string']
+        matches["json_string"]
       else
         response_string
       end
@@ -53,9 +52,9 @@ module Suretax
 
     def map_response_code_to_http_status(api_status_code)
       case api_status_code
-      when '9999'
+      when "9999"
         200
-      when '9001'
+      when "9001"
         409
       else
         400
@@ -63,7 +62,7 @@ module Suretax
     end
 
     def log_response
-      logger.debug "\nSureTax Response Received:\n#{@body.inspect}" if logger
+      logger&.debug "\nSureTax Response Received:\n#{@body.inspect}"
     end
 
     def logger
@@ -73,7 +72,5 @@ module Suretax
     def configuration
       Suretax.configuration
     end
-
   end
-
 end

data/lib/suretax/version.rb

@@ -1,3 +1,3 @@
 module Suretax
-  VERSION = '0.2.3'
+  VERSION = "1.0.0".freeze
 end

data/spec/lib/suretax/api/group_spec.rb

@@ -1,49 +1,48 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Suretax::Api::Group do
-
   let(:group) { Suretax::Api::Group.new(group_hash) }
 
-  context 'with a v01 API response' do
-    let(:group_hash) { valid_test_response_body['GroupList'].first }
+  context "with a v01 API response" do
+    let(:group_hash) { valid_test_response_body["GroupList"].first }
 
-    it 'should have a state' do
-      expect(group.state).to eql('CA')
+    it "should have a state" do
+      expect(group.state).to eql("CA")
     end
 
-    it 'should have an invoice number' do
-      expect(group.invoice).to eql('1')
+    it "should have an invoice number" do
+      expect(group.invoice).to eql("1")
     end
 
-    it 'should have a customer number' do
-      expect(group.customer).to eql('000000007')
+    it "should have a customer number" do
+      expect(group.customer).to eql("000000007")
     end
 
-    it 'should have a list of taxes' do
+    it "should have a list of taxes" do
       expect(group.taxes.count).to eql(8)
     end
   end
 
-  context 'with a v03 API response' do
-    let(:group_hash) { valid_v03_response_body['GroupList'].first }
+  context "with a v03 API response" do
+    let(:group_hash) { valid_v03_response_body["GroupList"].first }
 
-    it 'should have a state' do
-      expect(group.state).to eql('CA')
+    it "should have a state" do
+      expect(group.state).to eql("CA")
     end
 
-    it 'should have an invoice number' do
-      expect(group.invoice).to eql('1')
+    it "should have an invoice number" do
+      expect(group.invoice).to eql("1")
     end
 
-    it 'should have a line number' do
-      expect(group.line).to eql('1')
+    it "should have a line number" do
+      expect(group.line).to eql("1")
     end
 
-    it 'should have a customer number' do
-      expect(group.customer).to eql('000000007')
+    it "should have a customer number" do
+      expect(group.customer).to eql("000000007")
     end
 
-    it 'should have a list of taxes' do
+    it "should have a list of taxes" do
       expect(group.taxes.count).to eql(8)
     end
   end

data/spec/lib/suretax/api/request_item_spec.rb

@@ -1,18 +1,16 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Suretax::Api::RequestItem do
-
   let(:args) { suretax_valid_request_item_params }
   let(:subject) { Suretax::Api::RequestItem.new(args) }
 
-  describe '#tax_exemption_codes' do
-
-    it 'should have two codes' do
+  describe "#tax_exemption_codes" do
+    it "should have two codes" do
       expect(subject.tax_exemption_codes.count).to eql(2)
     end
   end
 
-  describe '#params' do
+  describe "#params" do
     {
       bill_to_number: "8585260000",
       customer_number: "000000007",
@@ -34,7 +32,7 @@ describe Suretax::Api::RequestItem do
       unit_type: "00",
       units: "1",
       zipcode: "",
-      user_defined_field: '',
+      user_defined_field: "",
       ship_from_zipcode: "",
       ship_from_plus_four: "",
       order_placement_zipcode: "",
@@ -50,20 +48,20 @@ describe Suretax::Api::RequestItem do
       common_carrier: "1",
       origin_country_code: "",
       dest_country_code: ""
-    }.each_pair do |key,value|
+    }.each_pair do |key, value|
       it "##{key} should return the correct value" do
-        subject.send("#{key.to_s}=",value)
+        subject.send("#{key}=", value)
         expect(subject.send(key)).to eql(value)
       end
     end
   end
 
-  describe '#params' do
+  describe "#params" do
     let(:valid_params) do
-      valid_encoded_test_request_body['ItemList'].first
+      valid_encoded_test_request_body["ItemList"].first
     end
 
-    it 'should return a valid parameters hash' do
+    it "should return a valid parameters hash" do
       expect(subject.params).to eql(valid_params)
     end
   end

data/spec/lib/suretax/api/request_item_validations_spec.rb

@@ -1,40 +1,39 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe "Suretax API Request Item Validations" do
-
   let(:request_item) do
     Suretax::Api::RequestItem.new(suretax_valid_request_item_params)
   end
 
-  describe '#customer_number' do
-    it 'should not be valid when it is not a number' do
-      request_item.customer_number = ''
+  describe "#customer_number" do
+    it "should not be valid when it is not a number" do
+      request_item.customer_number = ""
 
       expect(request_item.errors.any?).to eq true
-      expect(request_item.errors.messages).to eq [%Q{Invalid customer_number: ''}]
+      expect(request_item.errors.messages).to eq [%(Invalid customer_number: '')]
     end
 
-    it 'should not be valid when the length is wrong' do
-      request_item.customer_number = '1' * 11
+    it "should not be valid when the length is wrong" do
+      request_item.customer_number = "1" * 11
 
       expect(request_item.errors.any?).to eq true
-      expect(request_item.errors.messages).to eq [%Q{Invalid customer_number: #{'1' * 11}}]
+      expect(request_item.errors.messages).to eq [%(Invalid customer_number: #{'1' * 11})]
     end
 
-    it 'should not be valid when it is not a number' do
-      request_item.customer_number = 'a' * 9
+    it "should not be valid when it is not a number" do
+      request_item.customer_number = "a" * 9
 
       expect(request_item.errors.any?).to eq true
-      expect(request_item.errors.messages).to eq [%Q{Invalid customer_number: #{'a' * 9}}]
+      expect(request_item.errors.messages).to eq [%(Invalid customer_number: #{'a' * 9})]
     end
 
-    it 'should be valid when it is a nine-digit number' do
+    it "should be valid when it is a nine-digit number" do
       expect(request_item.errors.any?).to eq false
     end
   end
 
-  describe '#invoice_number' do
-    %w{123 a1234 abcdef}.each do |value|
+  describe "#invoice_number" do
+    %w[123 a1234 abcdef].each do |value|
       it "can be '#{value}'" do
         request_item.invoice_number = value
 
@@ -42,35 +41,35 @@ describe "Suretax API Request Item Validations" do
       end
     end
 
-    it 'cannot be longer than 20 characters' do
-      request_item.invoice_number = '1' * 21
+    it "cannot be longer than 20 characters" do
+      request_item.invoice_number = "1" * 21
 
       expect(request_item.errors.any?).to eq true
-      expect(request_item.errors.messages).to eq [%Q{Invalid invoice_number: #{'1' * 21}}]
+      expect(request_item.errors.messages).to eq [%(Invalid invoice_number: #{'1' * 21})]
     end
 
-    it 'can be blank' do
+    it "can be blank" do
       request_item.invoice_number = nil
 
       expect(request_item.errors.any?).to eq false
     end
   end
 
-  describe '#line_number' do
-    it 'must not be more than 20 characters in length' do
-      request_item.line_number = '1' * 21
+  describe "#line_number" do
+    it "must not be more than 20 characters in length" do
+      request_item.line_number = "1" * 21
 
       expect(request_item.errors.any?).to eq true
-      expect(request_item.errors.messages).to eq [%Q{Invalid line_number: #{'1' * 21}}]
+      expect(request_item.errors.messages).to eq [%(Invalid line_number: #{'1' * 21})]
     end
 
-    it 'can be blank' do
+    it "can be blank" do
       request_item.line_number = nil
 
       expect(request_item.errors.any?).to eq false
     end
 
-    %w{1 40 580 12345678901234567890 a D0 S10}.each do |number|
+    %w[1 40 580 12345678901234567890 a D0 S10].each do |number|
       it "can be '#{number}'" do
         request_item.line_number = number
 
@@ -78,37 +77,35 @@ describe "Suretax API Request Item Validations" do
       end
     end
 
-    %w{_}.each do |bad_content|
+    %w[_].each do |bad_content|
       it "cannot be '#{bad_content}'" do
         request_item.line_number = bad_content
 
         expect(request_item.errors.any?).to eq true
-        expect(request_item.errors.messages).to eq [%Q{Invalid line_number: #{bad_content}}]
+        expect(request_item.errors.messages).to eq [%(Invalid line_number: #{bad_content})]
       end
     end
   end
 
-  context 'phone number fields' do
-    %w{orig_number term_number bill_to_number}.each do |phone_method|
-
+  context "phone number fields" do
+    %w[orig_number term_number bill_to_number].each do |phone_method|
       describe "##{phone_method}" do
-        it_should_behave_like 'optional phone number' do
+        it_should_behave_like "optional phone number" do
           let(:subject) { phone_method }
         end
       end
-
     end
   end
 
-  describe '#tax_situs_rule' do
-    it 'must be present' do
+  describe "#tax_situs_rule" do
+    it "must be present" do
       request_item.tax_situs_rule = nil
 
       expect(request_item.errors.any?).to eq true
-      expect(request_item.errors.messages).to eq [%Q{Invalid tax_situs_rule: nil}]
+      expect(request_item.errors.messages).to eq [%(Invalid tax_situs_rule: nil)]
     end
 
-    %w{01 02 03 04 05 06 07 14}.each do |number|
+    %w[01 02 03 04 05 06 07 14].each do |number|
       it "can be '#{number}'" do
         request_item.tax_situs_rule = number
 
@@ -116,121 +113,121 @@ describe "Suretax API Request Item Validations" do
       end
     end
 
-    %w{a D0 S10 _}.each do |bad_content|
+    %w[a D0 S10 _].each do |bad_content|
       it "cannot be '#{bad_content}'" do
         request_item.tax_situs_rule = bad_content
 
         expect(request_item.errors.any?).to eq true
-        expect(request_item.errors.messages).to eq [%Q{Invalid tax_situs_rule: #{bad_content}}]
+        expect(request_item.errors.messages).to eq [%(Invalid tax_situs_rule: #{bad_content})]
       end
     end
   end
 
-  describe '#trans_type_code' do
-    context 'when present' do
-      it 'should pass validation' do
-        request_item.trans_type_code = '010101'
+  describe "#trans_type_code" do
+    context "when present" do
+      it "should pass validation" do
+        request_item.trans_type_code = "010101"
 
         expect(request_item.errors.any?).to eq false
       end
     end
 
-    context 'when absent' do
-      it 'should fail validation' do
+    context "when absent" do
+      it "should fail validation" do
         request_item.trans_type_code = nil
 
         expect(request_item.errors.any?).to eq true
-        expect(request_item.errors.messages).to eq [%Q{Invalid trans_type_code: nil}]
+        expect(request_item.errors.messages).to eq [%(Invalid trans_type_code: nil)]
       end
     end
   end
 
-  describe '#sales_type_code' do
-    context 'when present' do
-      it 'should allow valid codes' do
-        %w{R B I L}.each do |code|
+  describe "#sales_type_code" do
+    context "when present" do
+      it "should allow valid codes" do
+        %w[R B I L].each do |code|
           request_item.sales_type_code = code
 
           expect(request_item.errors.any?).to eq false
         end
       end
 
-      it 'should not allow invalid codes' do
-        %w{A X Y Z}.each do |code|
+      it "should not allow invalid codes" do
+        %w[A X Y Z].each do |code|
           request_item.sales_type_code = code
 
           expect(request_item.errors.any?).to eq true
-          expect(request_item.errors.messages).to eq [%Q{Invalid sales_type_code: #{code}}]
+          expect(request_item.errors.messages).to eq [%(Invalid sales_type_code: #{code})]
         end
       end
     end
 
-    context 'when absent' do
-      it 'should fail validation' do
+    context "when absent" do
+      it "should fail validation" do
         request_item.sales_type_code = nil
 
         expect(request_item.errors.any?).to eq true
-        expect(request_item.errors.messages).to eq [%Q{Invalid sales_type_code: nil}]
+        expect(request_item.errors.messages).to eq [%(Invalid sales_type_code: nil)]
       end
     end
   end
 
-  describe '#regulatory_code' do
-    context 'when present' do
-      it 'should allow valid codes' do
-        %w{00 01 02 03 04 05 99}.each do |code|
+  describe "#regulatory_code" do
+    context "when present" do
+      it "should allow valid codes" do
+        %w[00 01 02 03 04 05 99].each do |code|
           request_item.regulatory_code = code
 
           expect(request_item.errors.any?).to eq false
         end
       end
 
-      it 'should not allow invalid codes' do
-        %w{44 77 4 f -}.each do |code|
+      it "should not allow invalid codes" do
+        %w[44 77 4 f -].each do |code|
           request_item.regulatory_code = code
 
           expect(request_item.errors.any?).to eq true
-          expect(request_item.errors.messages).to eq [%Q{Invalid regulatory_code: #{code}}]
+          expect(request_item.errors.messages).to eq [%(Invalid regulatory_code: #{code})]
         end
       end
     end
 
-    context 'when absent' do
-      it 'should fail validation' do
+    context "when absent" do
+      it "should fail validation" do
         request_item.regulatory_code = nil
 
         expect(request_item.errors.any?).to eq true
-        expect(request_item.errors.messages).to eq [%Q{Invalid regulatory_code: nil}]
+        expect(request_item.errors.messages).to eq [%(Invalid regulatory_code: nil)]
       end
     end
   end
 
-  describe '#tax_exemption_codes' do
-    context 'when present' do
-      context 'and the list has content' do
-        it 'should pass validation' do
-          request_item.tax_exemption_codes = ['00']
+  describe "#tax_exemption_codes" do
+    context "when present" do
+      context "and the list has content" do
+        it "should pass validation" do
+          request_item.tax_exemption_codes = ["00"]
 
           expect(request_item.errors.any?).to eq false
         end
       end
 
-      context 'and the list is empty' do
-        it 'should fail validation' do
+      context "and the list is empty" do
+        it "should fail validation" do
           request_item.tax_exemption_codes = []
 
           expect(request_item.errors.any?).to eq true
-          expect(request_item.errors.messages).to eq [%Q{Invalid tax_exemption_codes: []}]
+          expect(request_item.errors.messages).to eq [%(Invalid tax_exemption_codes: [])]
         end
       end
     end
 
-    context 'when absent' do
-      it 'should fail validation' do
+    context "when absent" do
+      it "should fail validation" do
         request_item.tax_exemption_codes = nil
 
         expect(request_item.errors.any?).to eq true
-        expect(request_item.errors.messages).to eq [%Q{Invalid tax_exemption_codes: nil}]
+        expect(request_item.errors.messages).to eq [%(Invalid tax_exemption_codes: nil)]
       end
     end
   end