taxjar-ruby 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b54cdb522b0b3744437e592154cf44893628a704
-  data.tar.gz: 500b74d372d771d99d3dc2924ae9e354fc2d1078
+  metadata.gz: 1bfb85c8da4a0794eaa7fb2634d811d6e1d48d1d
+  data.tar.gz: 8ac52df47adcebb45a240649322bd80820d8298b
 SHA512:
-  metadata.gz: 9dd20ccdf84c05232aaf5d68734043e99f16d3ef661aced05a6b0a1b2e22db1e940479bdcd52e38e87d4b7c32d672e4edce7f33c74b3eb803001c841b7bf17c7
-  data.tar.gz: 9374fdd910a31995f41e94225fa7bc41684844e9bfe8ff10b38435a3a4b15fdb0fb803548fae93d840072697a4caf1e6d8dae447c3ea5d83a2b7c1ae535e6943
+  metadata.gz: 49c6eb22aa02d983f00e2fb33cdcc98b7958fda8d3d0cf2d6dc28a32098075ec8c76f1ac93d7a24354677fac3df9f4483735164e035588f904bd498a3d290b8a
+  data.tar.gz: 9783ad5245bb139312e63ccaa560f080e649d439daf4006c5c5e3aec854e3e174169bb383a2f204ca66f6e72ab73d3a61362ad69ea2db1c823c50e7255e6a7f3

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.5.0] - 2019-06-19
+- Support `provider` param for marketplace exempt transactions
+- Add proxy support when instantiating client
+
 ## [2.4.1] - 2019-02-04
 - Relax HTTP.rb gem version requirements
 - Add RubyGems metadata
@@ -27,7 +31,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Update minimum required Ruby version to 2.0
 - Update HTTP (The Gem) to 2.2
 
-[Unreleased]: https://github.com/taxjar/taxjar-ruby/compare/v2.4.1...HEAD
+[Unreleased]: https://github.com/taxjar/taxjar-ruby/compare/v2.5.0...HEAD
+[2.5.0]: https://github.com/taxjar/taxjar-ruby/compare/v2.4.1...v2.5.0
 [2.4.1]: https://github.com/taxjar/taxjar-ruby/compare/v2.4.0...v2.4.1
 [2.4.0]: https://github.com/taxjar/taxjar-ruby/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/taxjar/taxjar-ruby/compare/v2.2.0...v2.3.0

data/README.md

@@ -18,7 +18,7 @@ Installing this gem also bundles the following dependencies:
 * [http](https://github.com/httprb/http.rb) - Fast Ruby HTTP client with a chainable API and full streaming support.
 * [addressable](https://github.com/sporkmonger/addressable) - Replacement for the URI implementation that is part of Ruby's standard library. It more closely conforms to the relevant RFCs and adds support for IRIs and URI templates.
 * [memoizable](https://github.com/dkubb/memoizable) - Memoize method return values.
-* [model_attribute](https://github.com/yammer/model_attribute) - Type casted attributes for non-ActiveRecord models. [Forked](https://github.com/taxjar/model_attribute) to handle floats and more types.
+* [model_attribute](https://github.com/yammer/model_attribute) - Type casted attributes for non-ActiveRecord models.
 
 ## Installation
 

data/lib/taxjar/api/request.rb

@@ -26,15 +26,20 @@ 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)
+        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)
       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

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|

data/lib/taxjar/order.rb

@@ -3,10 +3,11 @@ 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 :from_country,     :string
     attribute :from_zip,         :string
     attribute :from_state,       :string

data/lib/taxjar/refund.rb

@@ -3,11 +3,12 @@ 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 :from_country,             :string
     attribute :from_zip,                 :string
     attribute :from_state,               :string

data/lib/taxjar/version.rb

@@ -6,11 +6,11 @@ module Taxjar
     end
 
     def minor
-      4
+      5
     end
 
     def patch
-      1
+      0
     end
 
     def pre

data/spec/fixtures/order.json

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

data/spec/fixtures/refund.json

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

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,23 @@ 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.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -84,7 +87,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 +106,7 @@ describe Taxjar::API::Order do
 
       @order = {:transaction_id => '123',
                 :transaction_date => '2015/05/14',
+                :provider => 'api',
                 :to_country => 'US',
                 :to_zip => '90002',
                 :to_city => 'Los Angeles',
@@ -132,6 +136,7 @@ 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.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -146,7 +151,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')
@@ -191,6 +196,7 @@ 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.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -205,7 +211,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 +227,23 @@ 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.from_country).to eq('US')
       expect(order.from_zip).to eq('93107')
       expect(order.from_state).to eq('CA')
@@ -251,9 +258,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,24 @@ 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.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -83,9 +86,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 +108,7 @@ describe Taxjar::API::Refund do
       @refund = {:transaction_id => '321',
                 :transaction_date => '2015/05/14',
                 :transaction_reference_id => '123',
+                :provider => 'api',
                 :to_country => 'US',
                 :to_zip => '90002',
                 :to_state => 'CA',
@@ -135,6 +139,7 @@ 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.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -149,7 +154,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')
@@ -195,6 +200,7 @@ 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.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -209,7 +215,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 +231,24 @@ 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.from_country).to eq('US')
       expect(refund.from_zip).to eq('93107')
       expect(refund.from_state).to eq('CA')
@@ -256,9 +263,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')

data/spec/taxjar/api/request_spec.rb

@@ -119,6 +119,21 @@ describe Taxjar::API::Request do
       Taxjar::API::Request.new(client, :get, '/api_path', 'object')
     end
 
+    context 'with a proxy' do
+      let(:client){ Taxjar::Client.new(api_key: 'AK', http_proxy: ["127.0.0.1", 8080])}
+      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}"}).
+          to_return(:status => 200, :body => '{"object": {"id": "3"}}',
+                    :headers => {content_type: 'application/json; charset=UTF-8'})
+
+        expect(subject.perform).to eq({id: '3'})
+        expect(subject.send(:build_http_client).default_options.proxy).to eq({proxy_address: "127.0.0.1", proxy_port: 8080})
+      end
+    end
+
     context 'with get' do
       it 'should return a body if no errors' do
         stub_request(:get, "https://api.taxjar.com/api_path").

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxjar-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable