taxjar-ruby 2.4.1 → 3.0.1

data/lib/taxjar/api/request.rb

@@ -26,15 +26,25 @@ module Taxjar
       end
 
       def perform
-        options_key = @request_method == :get ? :params : :json
-        response = HTTP.timeout(@http_timeout).headers(headers)
-          .request(request_method, uri.to_s, options_key => @options)
-        response_body = symbolize_keys!(response.parse)
-        fail_or_return_response_body(response.code, response_body)
+        options_key = [:get, :delete].include?(@request_method) ? :params : :json
+        response = build_http_client.request(request_method, uri.to_s, options_key => @options)
+        response_body =
+          begin
+            symbolize_keys!(response.parse(:json))
+          rescue JSON::ParserError
+            nil
+          end
+        fail_or_return_response_body(response, response_body)
       end
 
       private
 
+        def build_http_client
+          http_client = HTTP.timeout(@http_timeout).headers(headers)
+          http_client = http_client.via(*client.http_proxy) if client.http_proxy
+          http_client
+        end
+
         def set_request_headers(custom_headers = {})
           @headers = {}
           @headers[:user_agent] = client.user_agent
@@ -62,16 +72,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

@@ -16,6 +16,7 @@ module Taxjar
     attr_accessor :api_key
     attr_accessor :api_url
     attr_accessor :headers
+    attr_accessor :http_proxy
 
     def initialize(options = {})
       options.each do |key, value|
@@ -37,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

@@ -3,10 +3,12 @@ require 'taxjar/base'
 module Taxjar
   class Order < Taxjar::Base
     extend ModelAttribute
-    
+
     attribute :transaction_id,   :string
     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

@@ -3,11 +3,13 @@ require 'taxjar/base'
 module Taxjar
   class Refund < Taxjar::Base
     extend ModelAttribute
-    
+
     attribute :transaction_id,           :string
     attribute :user_id,                  :integer
     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,11 +2,11 @@ module Taxjar
   module Version
   module_function
     def major
-      2
+      3
     end
 
     def minor
-      4
+      0
     end
 
     def patch

data/spec/fixtures/order.json

@@ -3,6 +3,8 @@
     "transaction_id": "123",
     "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

@@ -4,6 +4,8 @@
     "user_id": 10649,
     "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

@@ -28,7 +28,7 @@ describe Taxjar::API::Order do
 
     context "with parameters" do
       before do
-        stub_get('/v2/transactions/orders?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31').
+        stub_get('/v2/transactions/orders?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31&provider=api').
           to_return(body: fixture('orders.json'),
                     headers: {content_type: 'application/json; charset=utf-8'})
 
@@ -36,13 +36,15 @@ describe Taxjar::API::Order do
 
       it 'requests the right resource' do
         @client.list_orders(from_transaction_date: '2015/05/01',
-                                     to_transaction_date: '2015/05/31')
-        expect(a_get('/v2/transactions/orders?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31')).to have_been_made
+                            to_transaction_date: '2015/05/31',
+                            provider: 'api')
+        expect(a_get('/v2/transactions/orders?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31&provider=api')).to have_been_made
       end
 
       it 'returns the requested orders' do
         orders = @client.list_orders(from_transaction_date: '2015/05/01',
-                                     to_transaction_date: '2015/05/31')
+                                     to_transaction_date: '2015/05/31',
+                                     provider: 'api')
         expect(orders).to be_an Array
         expect(orders.first).to be_a String
         expect(orders.first).to eq('123')
@@ -52,22 +54,24 @@ describe Taxjar::API::Order do
 
   describe "#show_order" do
     before do
-        stub_get('/v2/transactions/orders/123').
+        stub_get('/v2/transactions/orders/123?provider=api').
           to_return(body: fixture('order.json'),
                     headers: {content_type: 'application/json; charset=utf-8'})
     end
 
     it 'requests the right resource' do
-      @client.show_order('123')
-      expect(a_get('/v2/transactions/orders/123')).to have_been_made
+      @client.show_order('123', provider: 'api')
+      expect(a_get('/v2/transactions/orders/123?provider=api')).to have_been_made
     end
 
     it 'returns the requested order' do
-      order = @client.show_order('123')
+      order = @client.show_order('123', provider: 'api')
       expect(order).to be_an Taxjar::Order
       expect(order.transaction_id).to eq('123')
       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')
@@ -84,7 +88,7 @@ describe Taxjar::API::Order do
     end
 
     it 'allows access to line_items' do
-      order = @client.show_order('123')
+      order = @client.show_order('123', provider: 'api')
       expect(order.line_items[0].id).to eq('1')
       expect(order.line_items[0].quantity).to eq(1)
       expect(order.line_items[0].product_identifier).to eq('12-34243-9')
@@ -103,6 +107,8 @@ 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',
@@ -132,6 +138,8 @@ describe Taxjar::API::Order do
       expect(order.transaction_id).to eq('123')
       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')
@@ -146,7 +154,7 @@ describe Taxjar::API::Order do
       expect(order.shipping).to eq(1.5)
       expect(order.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line_items' do
       order = @client.create_order(@order)
       expect(order.line_items[0].id).to eq('1')
@@ -169,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',
@@ -191,6 +200,8 @@ describe Taxjar::API::Order do
       expect(order.transaction_id).to eq('123')
       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')
@@ -205,7 +216,7 @@ describe Taxjar::API::Order do
       expect(order.shipping).to eq(1.5)
       expect(order.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line_items' do
       order = @client.update_order(@order)
       expect(order.line_items[0].id).to eq('1')
@@ -221,22 +232,24 @@ describe Taxjar::API::Order do
 
   describe "#delete_order" do
     before do
-        stub_delete('/v2/transactions/orders/123').
+        stub_delete('/v2/transactions/orders/123?provider=api').
           to_return(body: fixture('order.json'),
                     headers: {content_type: 'application/json; charset=utf-8'})
     end
 
     it 'requests the right resource' do
-      @client.delete_order('123')
-      expect(a_delete('/v2/transactions/orders/123')).to have_been_made
+      @client.delete_order('123', provider: 'api')
+      expect(a_delete('/v2/transactions/orders/123?provider=api')).to have_been_made
     end
 
     it 'returns the deleted order' do
-      order = @client.delete_order('123')
+      order = @client.delete_order('123', provider: 'api')
       expect(order).to be_an Taxjar::Order
       expect(order.transaction_id).to eq('123')
       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')
@@ -251,9 +264,9 @@ describe Taxjar::API::Order do
       expect(order.shipping).to eq(1.5)
       expect(order.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line items' do
-      order = @client.delete_order('123')
+      order = @client.delete_order('123', provider: 'api')
       expect(order.line_items[0].id).to eq('1')
       expect(order.line_items[0].quantity).to eq(1)
       expect(order.line_items[0].product_identifier).to eq('12-34243-9')

data/spec/taxjar/api/refund_spec.rb

@@ -28,7 +28,7 @@ describe Taxjar::API::Refund do
 
     context "with parameters" do
       before do
-        stub_get('/v2/transactions/refunds?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31').
+        stub_get('/v2/transactions/refunds?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31&provider=api').
           to_return(body: fixture('refunds.json'),
                     headers: {content_type: 'application/json; charset=utf-8'})
 
@@ -36,13 +36,15 @@ describe Taxjar::API::Refund do
 
       it 'requests the right resource' do
         @client.list_refunds(from_transaction_date: '2015/05/01',
-                                     to_transaction_date: '2015/05/31')
-        expect(a_get('/v2/transactions/refunds?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31')).to have_been_made
+                             to_transaction_date: '2015/05/31',
+                             provider: 'api')
+        expect(a_get('/v2/transactions/refunds?from_transaction_date=2015/05/01&to_transaction_date=2015/05/31&provider=api')).to have_been_made
       end
 
       it 'returns the requested refunds' do
         refunds = @client.list_refunds(from_transaction_date: '2015/05/01',
-                                     to_transaction_date: '2015/05/31')
+                                       to_transaction_date: '2015/05/31',
+                                       provider: 'api')
         expect(refunds).to be_an Array
         expect(refunds.first).to be_a String
         expect(refunds.first).to eq('321')
@@ -52,23 +54,25 @@ describe Taxjar::API::Refund do
 
   describe "#show_refund" do
     before do
-        stub_get('/v2/transactions/refunds/321').
+        stub_get('/v2/transactions/refunds/321?provider=api').
           to_return(body: fixture('refund.json'),
                     headers: {content_type: 'application/json; charset=utf-8'})
     end
 
     it 'requests the right resource' do
-      @client.show_refund('321')
-      expect(a_get('/v2/transactions/refunds/321')).to have_been_made
+      @client.show_refund('321', provider: 'api')
+      expect(a_get('/v2/transactions/refunds/321?provider=api')).to have_been_made
     end
 
     it 'returns the requested refund' do
-      refund = @client.show_refund('321')
+      refund = @client.show_refund('321', provider: 'api')
       expect(refund).to be_an Taxjar::Refund
       expect(refund.transaction_id).to eq('321')
       expect(refund.user_id).to eq(10649)
       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')
@@ -83,9 +87,9 @@ describe Taxjar::API::Refund do
       expect(refund.shipping).to eq(1.5)
       expect(refund.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line_items' do
-      refund = @client.show_refund('321')
+      refund = @client.show_refund('321', provider: 'api')
       expect(refund.line_items[0].id).to eq('1')
       expect(refund.line_items[0].quantity).to eq(1)
       expect(refund.line_items[0].product_identifier).to eq('12-34243-9')
@@ -105,6 +109,8 @@ describe Taxjar::API::Refund do
       @refund = {:transaction_id => '321',
                 :transaction_date => '2015/05/14',
                 :transaction_reference_id => '123',
+                :provider => 'api',
+                :exemption_type => 'non_exempt',
                 :to_country => 'US',
                 :to_zip => '90002',
                 :to_state => 'CA',
@@ -135,6 +141,8 @@ describe Taxjar::API::Refund do
       expect(refund.user_id).to eq(10649)
       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')
@@ -149,7 +157,7 @@ describe Taxjar::API::Refund do
       expect(refund.shipping).to eq(1.5)
       expect(refund.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line_items' do
       refund = @client.create_refund(@refund)
       expect(refund.line_items[0].id).to eq('1')
@@ -173,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',
@@ -195,6 +204,8 @@ describe Taxjar::API::Refund do
       expect(refund.user_id).to eq(10649)
       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')
@@ -209,7 +220,7 @@ describe Taxjar::API::Refund do
       expect(refund.shipping).to eq(1.5)
       expect(refund.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line_items' do
       refund = @client.update_refund(@refund)
       expect(refund.line_items[0].id).to eq('1')
@@ -225,23 +236,25 @@ describe Taxjar::API::Refund do
 
   describe "#delete_refund" do
     before do
-        stub_delete('/v2/transactions/refunds/321').
+        stub_delete('/v2/transactions/refunds/321?provider=api').
           to_return(body: fixture('refund.json'),
                     headers: {content_type: 'application/json; charset=utf-8'})
     end
 
     it 'requests the right resource' do
-      @client.delete_refund('321')
-      expect(a_delete('/v2/transactions/refunds/321')).to have_been_made
+      @client.delete_refund('321', provider: 'api')
+      expect(a_delete('/v2/transactions/refunds/321?provider=api')).to have_been_made
     end
 
-    it 'returns the delete refund' do
-      refund = @client.delete_refund('321')
+    it 'returns the deleted refund' do
+      refund = @client.delete_refund('321', provider: 'api')
       expect(refund).to be_an Taxjar::Refund
       expect(refund.transaction_id).to eq('321')
       expect(refund.user_id).to eq(10649)
       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')
@@ -256,9 +269,9 @@ describe Taxjar::API::Refund do
       expect(refund.shipping).to eq(1.5)
       expect(refund.sales_tax).to eq(0.95)
     end
-    
+
     it 'allows access to line_items' do
-      refund = @client.delete_refund('321')
+      refund = @client.delete_refund('321', provider: 'api')
       expect(refund.line_items[0].id).to eq('1')
       expect(refund.line_items[0].quantity).to eq(1)
       expect(refund.line_items[0].product_identifier).to eq('12-34243-9')