taxjar-ruby 2.5.0 → 3.0.2

data/lib/taxjar/api/request.rb

@@ -28,8 +28,15 @@ module Taxjar
       def perform
         options_key = [:get, :delete].include?(@request_method) ? :params : :json
         response = build_http_client.request(request_method, uri.to_s, options_key => @options)
-        response_body = symbolize_keys!(response.parse)
-        fail_or_return_response_body(response.code, response_body)
+        response_body =
+          begin
+            symbolize_keys!(response.parse(:json))
+          rescue JSON::ParserError
+            nil
+          end
+        fail_or_return_response_body(response, response_body)
+      rescue HTTP::Error => e
+        raise Taxjar::Error, e
       end
 
       private
@@ -67,16 +74,15 @@ module Taxjar
           object
         end
 
-        def fail_or_return_response_body(code, body)
-          e = extract_error(code, body)
-          fail(e) if e
-          body[object_key.to_sym]
-        end
-
-        def extract_error(code, body)
-          klass = Taxjar::Error::ERRORS[code]
-          if !klass.nil?
-            klass.from_response(body)
+        def fail_or_return_response_body(response, body)
+          if body.nil?
+            fail(Taxjar::Error.for_json_parse_error(response.code))
+          elsif response.status.success?
+            body[object_key.to_sym]
+          elsif !(klass = Taxjar::Error::ERRORS[response.code]).nil?
+            fail(klass.from_response(body))
+          else
+            fail(Taxjar::Error.from_response_code(response.code))
           end
         end
     end

data/lib/taxjar/client.rb

@@ -38,7 +38,14 @@ module Taxjar
     end
 
     def user_agent
-      "TaxjarRubyGem/#{Taxjar::Version}"
+      def platform
+        (`uname -a` || '').strip
+      rescue Errno::ENOENT, Errno::ENOMEM
+        ''
+      end
+      ruby_version = "ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+      openSSL_version = OpenSSL::OPENSSL_LIBRARY_VERSION
+      "TaxJar/Ruby (#{platform}; #{ruby_version}; #{openSSL_version}) taxjar-ruby/#{Taxjar::Version}"
     end
   end
 end

data/lib/taxjar/error.rb

@@ -61,6 +61,15 @@ module Taxjar
         new(message, code)
       end
 
+      def from_response_code(code)
+        message = HTTP::Response::Status::REASONS[code] || "Unknown Error"
+        new(message, code)
+      end
+
+      def for_json_parse_error(code)
+        ServerError.new("Couldn't parse response as JSON.", code)
+      end
+
     end
 
     def initialize(message = '', code = nil)

data/lib/taxjar/order.rb

@@ -8,6 +8,7 @@ module Taxjar
     attribute :user_id,          :integer
     attribute :transaction_date, :string
     attribute :provider,         :string
+    attribute :exemption_type,   :string
     attribute :from_country,     :string
     attribute :from_zip,         :string
     attribute :from_state,       :string

data/lib/taxjar/refund.rb

@@ -9,6 +9,7 @@ module Taxjar
     attribute :transaction_date,         :string
     attribute :transaction_reference_id, :string
     attribute :provider,                 :string
+    attribute :exemption_type,           :string
     attribute :from_country,             :string
     attribute :from_zip,                 :string
     attribute :from_state,               :string

data/lib/taxjar/tax.rb

@@ -12,6 +12,7 @@ module Taxjar
     attribute :has_nexus,          :boolean
     attribute :freight_taxable,    :boolean
     attribute :tax_source,         :string
+    attribute :exemption_type,     :string
 
     object_attr_reader Taxjar::Jurisdictions, :jurisdictions
     object_attr_reader Taxjar::Breakdown, :breakdown

data/lib/taxjar/version.rb

@@ -2,15 +2,15 @@ module Taxjar
   module Version
   module_function
     def major
-      2
+      3
     end
 
     def minor
-      5
+      0
     end
 
     def patch
-      0
+      2
     end
 
     def pre

data/spec/fixtures/order.json

@@ -4,6 +4,7 @@
     "user_id": 10649,
     "transaction_date": "2015-05-14T00:00:00Z",
     "provider": "api",
+    "exemption_type": "non_exempt",
     "from_country": "US",
     "from_zip": "93107",
     "from_state": "CA",

data/spec/fixtures/refund.json

@@ -5,6 +5,7 @@
     "transaction_date": "2015-05-14T00:00:00Z",
     "transaction_reference_id": "123",
     "provider": "api",
+    "exemption_type": "non_exempt",
     "from_country": "US",
     "from_zip": "93107",
     "from_state": "CA",

data/spec/fixtures/taxes.json

@@ -8,6 +8,7 @@
     "has_nexus": true,
     "freight_taxable": true,
     "tax_source": "destination",
+    "exemption_type": "non_exempt",
     "jurisdictions": {
       "country": "US",
       "state": "NJ",

data/spec/fixtures/taxes_canada.json

@@ -8,6 +8,7 @@
     "has_nexus": true,
     "freight_taxable": true,
     "tax_source": "destination",
+    "exemption_type": "non_exempt",
     "jurisdictions": {
       "country": "CA",
       "state": "ON"

data/spec/fixtures/taxes_international.json

@@ -8,6 +8,7 @@
     "has_nexus": true,
     "freight_taxable": true,
     "tax_source": "destination",
+    "exemption_type": "non_exempt",
     "jurisdictions": {
       "country": "FI"
     },

data/spec/taxjar/api/api_spec.rb

@@ -168,6 +168,7 @@ describe Taxjar::API do
                 :to_zip => '07446',
                 :amount => 16.50,
                 :shipping => 1.5,
+                :exemption_type => 'non_exempt',
                 :line_items => [{:line_item => {:id => '1',
                                                 :quantity => 1,
                                                 :unit_price => 15.0,
@@ -191,6 +192,7 @@ describe Taxjar::API do
       expect(tax.has_nexus).to eq(true)
       expect(tax.freight_taxable).to eq(true)
       expect(tax.tax_source).to eq('destination')
+      expect(tax.exemption_type).to eq('non_exempt')
     end
 
     it 'allows access to jurisdictions' do
@@ -275,6 +277,7 @@ describe Taxjar::API do
         expect(tax.has_nexus).to eq(true)
         expect(tax.freight_taxable).to eq(true)
         expect(tax.tax_source).to eq('destination')
+        expect(tax.exemption_type).to eq('non_exempt')
       end
 
       it 'allows access to jurisdictions' do
@@ -330,6 +333,7 @@ describe Taxjar::API do
         expect(tax.has_nexus).to eq(true)
         expect(tax.freight_taxable).to eq(true)
         expect(tax.tax_source).to eq('destination')
+        expect(tax.exemption_type).to eq('non_exempt')
       end
 
       it 'allows access to jurisdictions' do

data/spec/taxjar/api/order_spec.rb

@@ -71,6 +71,7 @@ describe Taxjar::API::Order do
       expect(order.user_id).to eq(10649)
       expect(order.transaction_date).to eq('2015-05-14T00:00:00Z')
       expect(order.provider).to eq('api')
+      expect(order.exemption_type).to eq('non_exempt')
       expect(order.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -107,6 +108,7 @@ describe Taxjar::API::Order do
       @order = {:transaction_id => '123',
                 :transaction_date => '2015/05/14',
                 :provider => 'api',
+                :exemption_type => 'non_exempt',
                 :to_country => 'US',
                 :to_zip => '90002',
                 :to_city => 'Los Angeles',
@@ -137,6 +139,7 @@ describe Taxjar::API::Order do
       expect(order.user_id).to eq(10649)
       expect(order.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(order.provider).to eq('api')
+      expect(order.exemption_type).to eq('non_exempt')
       expect(order.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -174,6 +177,7 @@ describe Taxjar::API::Order do
       @order = {:transaction_id => '123',
                 :amount => 17.95,
                 :shipping => 2.0,
+                :exemption_type => 'non_exempt',
                 :line_items => [{:id => 1,
                                  :quantity => 1,
                                  :product_identifier => '12-34243-0',
@@ -197,6 +201,7 @@ describe Taxjar::API::Order do
       expect(order.user_id).to eq(10649)
       expect(order.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(order.provider).to eq('api')
+      expect(order.exemption_type).to eq('non_exempt')
       expect(order.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -244,6 +249,7 @@ describe Taxjar::API::Order do
       expect(order.user_id).to eq(10649)
       expect(order.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(order.provider).to eq('api')
+      expect(order.exemption_type).to eq('non_exempt')
       expect(order.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')

data/spec/taxjar/api/refund_spec.rb

@@ -72,6 +72,7 @@ describe Taxjar::API::Refund do
       expect(refund.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(refund.transaction_reference_id).to eq("123")
       expect(refund.provider).to eql('api')
+      expect(refund.exemption_type).to eq('non_exempt')
       expect(refund.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -109,6 +110,7 @@ describe Taxjar::API::Refund do
                 :transaction_date => '2015/05/14',
                 :transaction_reference_id => '123',
                 :provider => 'api',
+                :exemption_type => 'non_exempt',
                 :to_country => 'US',
                 :to_zip => '90002',
                 :to_state => 'CA',
@@ -140,6 +142,7 @@ describe Taxjar::API::Refund do
       expect(refund.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(refund.transaction_reference_id).to eq("123")
       expect(refund.provider).to eq('api')
+      expect(refund.exemption_type).to eq('non_exempt')
       expect(refund.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -178,6 +181,7 @@ describe Taxjar::API::Refund do
                 :amount => 17.95,
                 :shipping => 2.0,
                 :sales_tax => 0.95,
+                :exemption_type => 'non_exempt',
                 :line_items => [{:quantity => 1,
                                  :product_identifier => '12-34243-9',
                                  :description => 'Heavy Widget',
@@ -201,6 +205,7 @@ describe Taxjar::API::Refund do
       expect(refund.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(refund.transaction_reference_id).to eq("123")
       expect(refund.provider).to eq('api')
+      expect(refund.exemption_type).to eq('non_exempt')
       expect(refund.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -249,6 +254,7 @@ describe Taxjar::API::Refund do
       expect(refund.transaction_date).to eq("2015-05-14T00:00:00Z")
       expect(refund.transaction_reference_id).to eq("123")
       expect(refund.provider).to eq('api')
+      expect(refund.exemption_type).to eq('non_exempt')
       expect(refund.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')

data/spec/taxjar/api/request_spec.rb

@@ -41,7 +41,7 @@ describe Taxjar::API::Request do
     it 'should return headers' do
       expect(subject).to respond_to(:headers)
       expect(subject.headers).to be_instance_of(Hash)
-      expect(subject.headers[:user_agent]).to match('TaxjarRubyGem')
+      expect(subject.headers[:user_agent]).to match(/^TaxJar\/Ruby \(.+\) taxjar-ruby\/\d+\.\d+\.\d+$/)
       expect(subject.headers[:authorization]).to eq('Bearer AK')
     end
 
@@ -52,7 +52,7 @@ describe Taxjar::API::Request do
       subject = Taxjar::API::Request.new(client, :get, '/api_path', 'object')
       expect(subject).to respond_to(:headers)
       expect(subject.headers).to be_instance_of(Hash)
-      expect(subject.headers[:user_agent]).to match('TaxjarRubyGem')
+      expect(subject.headers[:user_agent]).to match(/^TaxJar\/Ruby \(.+\) taxjar-ruby\/\d+\.\d+\.\d+$/)
       expect(subject.headers[:authorization]).to eq('Bearer AK')
       expect(subject.headers['X-TJ-Expected-Response']).to eq(422)
     end
@@ -124,8 +124,7 @@ describe Taxjar::API::Request do
       it "runs through the proxy" do
         stub_request(:get, "https://api.taxjar.com/api_path").
           with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
-                            'Host'=>'api.taxjar.com',
-                            'User-Agent'=>"TaxjarRubyGem/#{Taxjar::Version.to_s}"}).
+                            'Host'=>'api.taxjar.com'}).
           to_return(:status => 200, :body => '{"object": {"id": "3"}}',
                     :headers => {content_type: 'application/json; charset=UTF-8'})
 
@@ -138,8 +137,7 @@ describe Taxjar::API::Request do
       it 'should return a body if no errors' do
         stub_request(:get, "https://api.taxjar.com/api_path").
           with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
-                            'Host'=>'api.taxjar.com',
-                            'User-Agent'=>"TaxjarRubyGem/#{Taxjar::Version.to_s}"}).
+                            'Host'=>'api.taxjar.com'}).
           to_return(:status => 200, :body => '{"object": {"id": "3"}}',
                     :headers => {content_type: 'application/json; charset=UTF-8'})
 
@@ -159,8 +157,7 @@ describe Taxjar::API::Request do
                     with(:body => "{\"city\":\"New York\"}",
                          :headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
                                       'Content-Type'=>'application/json; charset=UTF-8',
-                                      'Host'=>'api.taxjar.com',
-                                      'User-Agent'=>"TaxjarRubyGem/#{Taxjar::Version.to_s}"}).
+                                      'Host'=>'api.taxjar.com'}).
           to_return(:status => 200, :body => '{"object": {"id": "3"}}',
                     :headers => {content_type: 'application/json; charset=UTF-8'})
 
@@ -168,13 +165,40 @@ describe Taxjar::API::Request do
       end
     end
 
+    it 'handles unexpected Content-Type responses' do
+      stub_request(:get, "https://api.taxjar.com/api_path").
+        with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
+                          'Host'=>'api.taxjar.com'}).
+        to_return(:status => 200, :body => 'Something unexpected',
+                  :headers => {content_type: 'text/html; charset=UTF-8'})
+
+      expect{subject.perform}.to raise_error(Taxjar::Error::ServerError)
+    end
+
+    [
+      HTTP::Error,
+      HTTP::ConnectionError,
+      HTTP::RequestError,
+      HTTP::ResponseError,
+      HTTP::StateError,
+      HTTP::TimeoutError,
+      HTTP::HeaderError
+    ].each do |http_error_class|
+      context "#{http_error_class}" do
+        it "is classified as a Taxjar::Error" do
+          stub_request(:get, "https://api.taxjar.com/api_path").to_raise(http_error_class)
+
+          expect{subject.perform}.to raise_error(Taxjar::Error)
+        end
+      end
+    end
+
     Taxjar::Error::ERRORS.each do |status, exception|
       context "when HTTP status is #{status}" do
         it "raises #{exception}" do
           stub_request(:get, "https://api.taxjar.com/api_path").
             with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
-                              'Host'=>'api.taxjar.com',
-                              'User-Agent'=>"TaxjarRubyGem/#{Taxjar::Version.to_s}"}).
+                              'Host'=>'api.taxjar.com'}).
             to_return(:status => status,
                       :body => '{"error": "Not Acceptable",
                                  "detail": "error explanation",
@@ -185,5 +209,41 @@ describe Taxjar::API::Request do
         end
       end
     end
+
+    context "when HTTP status is 502" do
+      it "raises Taxjar::Error" do
+        stub_request(:get, "https://api.taxjar.com/api_path").
+          with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
+                            'Host'=>'api.taxjar.com'}).
+          to_return(:status => 502,
+                    :body => '{}',
+                    :headers => {content_type: 'application/json; charset=UTF-8'})
+
+        expect{subject.perform}.to raise_error(
+          an_instance_of(Taxjar::Error).and having_attributes({
+            "message" => "Bad Gateway",
+            "code" => 502
+          })
+        )
+      end
+    end
+
+    context "when HTTP status is 5xx" do
+      it "raises Taxjar::Error" do
+        stub_request(:get, "https://api.taxjar.com/api_path").
+          with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
+                            'Host'=>'api.taxjar.com'}).
+          to_return(:status => 509,
+                    :body => '{}',
+                    :headers => {content_type: 'application/json; charset=UTF-8'})
+
+        expect{subject.perform}.to raise_error(
+          an_instance_of(Taxjar::Error).and having_attributes({
+            "message" => "Unknown Error",
+            "code" => 509
+          })
+        )
+      end
+    end
   end
 end

data/spec/taxjar/client_spec.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 describe Taxjar::Client do
-  describe '#api_key?' do 
+  describe '#api_key?' do
     it 'returns true if api_key is present' do
       client = Taxjar::Client.new(api_key: 'AK')
       expect(client.api_key?).to be true
@@ -25,14 +25,14 @@ describe Taxjar::Client do
       client.set_api_config('api_url', 'https://api.sandbox.taxjar.com')
       expect(client.api_url).to eq('https://api.sandbox.taxjar.com')
     end
-    
+
     it 'sets new custom headers' do
       client = Taxjar::Client.new(api_key: 'AK')
       client.set_api_config('headers', { 'X-TJ-Expected-Response' => 422 })
       expect(client.headers).to eq({ 'X-TJ-Expected-Response' => 422 })
     end
   end
-  
+
   describe "#get_api_config" do
     it 'gets a config value' do
       client = Taxjar::Client.new(api_key: 'AK')
@@ -44,7 +44,7 @@ describe Taxjar::Client do
   describe '#user_agent' do
     it 'returns string with version' do
       client = Taxjar::Client.new(api_key: 'AK')
-      expect(client.user_agent).to eq("TaxjarRubyGem/#{Taxjar::Version}")
+      expect(client.user_agent).to match(/^TaxJar\/Ruby \(.+\) taxjar-ruby\/\d+\.\d+\.\d+$/)
     end
   end
 end