taxjar-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b7e3dd712773b9ccabcb86e905ecf021c59d9cc
-  data.tar.gz: 514648f0f55fb724aef886ccab636f9c9e40f639
+  metadata.gz: bf9845756bfeec2ace638f0e6414d73e2aeba0b9
+  data.tar.gz: f1852b4526f2fe8fac2530324acee0ca41146a78
 SHA512:
-  metadata.gz: 46aa5499f10eb2033f826c2995ee376fe129377b0c829eb8227c161acb54b7d76549f31b738d11df8a09ca8fff7de9badaea8789b92588d0bd6297cfbdc62aa7
-  data.tar.gz: 767079085e61f59a7cf79bcb50f05994c5e7700d7b261012187ee1cfed209b2e3ef9429b0a01b5ea7712dc066c37313369ae39c9b109ea1e98afd85ae8658626
+  metadata.gz: b7dfb2ad328bc585763ca567f521a705fd799582ae32076051af68278dc618eae7593392a8b2c2af3c416685aa3c44878bb1660e55eb5b638b0152e908337df6
+  data.tar.gz: 073e8445230a589b9d67721df6e6fad3a14e92aba7c5bfe4e440de7fc7ec6c925044877a72aac0c0524e643262d2b5125f90e8207b33032f2d88bd5ec2f57201

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 TaxJar, http://www.taxjar.com
+Copyright (c) 2018 TaxJar, https://www.taxjar.com
 
 MIT License
 

data/README.md

@@ -938,6 +938,48 @@ Set request timeout in seconds:
 client.tax_for_order({ timeout: 30 })
 ```
 
+## Sandbox Environment
+
+You can easily configure the client to use the [TaxJar Sandbox](https://developers.taxjar.com/api/reference/#sandbox-environment):
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: 'YOUR_SANDBOX_API_TOKEN', api_url: 'https://api.sandbox.taxjar.com')
+```
+
+For testing specific [error response codes](https://developers.taxjar.com/api/reference/#errors), pass the custom `X-TJ-Expected-Response` header:
+
+```ruby
+client.set_api_config('headers', {
+  'X-TJ-Expected-Response' => 422
+})
+```
+
+## Error Handling
+
+When invalid data is sent to TaxJar or we encounter an error, we’ll throw a `Taxjar::Error` with the HTTP status code and error message. To catch these exceptions, refer to the example below. [Click here](https://developers.taxjar.com/api/guides/ruby/#error-handling) for a list of common error response classes.
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '9e0cd62a22f451701f29c3bde214')
+
+begin
+  order = client.create_order({
+    :transaction_date => '2015/05/14',
+    :to_country => 'US',
+    :to_state => 'CA',
+    :to_zip => '90002',
+    :amount => 17.45,
+    :shipping => 1.5,
+    :sales_tax => 0.95
+  })
+rescue Taxjar::Error => e
+  # <Taxjar::Error::NotAcceptable: transaction_id is missing>
+  puts e.class.name
+  puts e.message
+end
+```
+
 ## Tests
 
 An RSpec test suite is available to ensure API functionality:

data/lib/taxjar/api/request.rb

@@ -4,7 +4,8 @@ require 'http'
 module Taxjar
   module API
     class Request
-      BASE_URL = 'https://api.taxjar.com'
+      DEFAULT_API_URL = 'https://api.taxjar.com'
+      SANDBOX_API_URL = 'https://api.sandbox.taxjar.com'
 
       attr_reader :client, :uri, :headers, :request_method, :path, :object_key, :options
 
@@ -16,8 +17,9 @@ module Taxjar
         @client = client
         @request_method = request_method
         @path = path
-        @uri = Addressable::URI.parse(BASE_URL + path)
-        set_request_headers
+        @base_url = client.api_url ? client.api_url : DEFAULT_API_URL
+        @uri = Addressable::URI.parse(@base_url + path)
+        set_request_headers(client.headers || {})
         @object_key = object_key
         @options = options
         set_http_timeout
@@ -33,10 +35,11 @@ module Taxjar
 
       private
 
-        def set_request_headers
+        def set_request_headers(custom_headers = {})
           @headers = {}
           @headers[:user_agent] = client.user_agent
           @headers[:authorization] = "Bearer #{client.api_key}"
+          @headers.merge!(custom_headers)
         end
 
         def set_http_timeout

data/lib/taxjar/client.rb

@@ -12,6 +12,8 @@ module Taxjar
     include Taxjar::API::Refund
 
     attr_accessor :api_key
+    attr_accessor :api_url
+    attr_accessor :headers
 
     def initialize(options = {})
       options.each do |key, value|
@@ -24,6 +26,14 @@ module Taxjar
       !!@api_key
     end
 
+    def set_api_config(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def get_api_config(key)
+      instance_variable_get("@#{key}")
+    end
+
     def user_agent
       "TaxjarRubyGem/#{Taxjar::Version}"
     end

data/lib/taxjar/version.rb

@@ -6,7 +6,7 @@ module Taxjar
     end
 
     def minor
-      0
+      1
     end
 
     def patch

data/spec/helper.rb

@@ -11,35 +11,35 @@ RSpec.configure do |config|
 end
 
 def a_get(path)
-  a_request(:get, Taxjar::API::Request::BASE_URL + path)
+  a_request(:get, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def a_post(path)
-  a_request(:post, Taxjar::API::Request::BASE_URL + path)
+  a_request(:post, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def a_delete(path)
-  a_request(:delete, Taxjar::API::Request::BASE_URL + path)
+  a_request(:delete, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def a_put(path)
-  a_request(:put, Taxjar::API::Request::BASE_URL + path)
+  a_request(:put, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def stub_get(path)
-  stub_request(:get, Taxjar::API::Request::BASE_URL + path)
+  stub_request(:get, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def stub_post(path)
-  stub_request(:post, Taxjar::API::Request::BASE_URL + path)
+  stub_request(:post, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def stub_put(path)
-  stub_request(:put, Taxjar::API::Request::BASE_URL + path)
+  stub_request(:put, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def stub_delete(path)
-  stub_request(:delete, Taxjar::API::Request::BASE_URL + path)
+  stub_request(:delete, Taxjar::API::Request::DEFAULT_API_URL + path)
 end
 
 def fixture_path

data/spec/taxjar/api/request_spec.rb

@@ -1,9 +1,15 @@
 require 'helper'
 
 describe Taxjar::API::Request do
-  describe "#BASE_URL" do
+  describe "#DEFAULT_API_URL" do
     it 'should have taxjar api url' do
-      expect(Taxjar::API::Request::BASE_URL).to eq('https://api.taxjar.com')
+      expect(Taxjar::API::Request::DEFAULT_API_URL).to eq('https://api.taxjar.com')
+    end
+  end
+
+  describe "#SANDBOX_API_URL" do
+    it 'should have sandbox taxjar api url' do
+      expect(Taxjar::API::Request::SANDBOX_API_URL).to eq('https://api.sandbox.taxjar.com')
     end
   end
 
@@ -24,6 +30,14 @@ describe Taxjar::API::Request do
       expect(subject.uri.to_s).to eq('https://api.taxjar.com/api_path')
     end
 
+    it 'should return a sandbox uri' do
+      client = Taxjar::Client.new(api_key: 'AK', api_url: Taxjar::API::Request::SANDBOX_API_URL)
+      subject = Taxjar::API::Request.new(client, :get, '/api_path', 'object')
+      expect(subject).to respond_to(:uri)
+      expect(subject.uri).to be_instance_of(Addressable::URI)
+      expect(subject.uri.to_s).to eq('https://api.sandbox.taxjar.com/api_path')
+    end
+
     it 'should return headers' do
       expect(subject).to respond_to(:headers)
       expect(subject.headers).to be_instance_of(Hash)
@@ -31,6 +45,18 @@ describe Taxjar::API::Request do
       expect(subject.headers[:authorization]).to eq('Bearer AK')
     end
 
+    it 'should return custom headers' do
+      client = Taxjar::Client.new(api_key: 'AK', api_url: Taxjar::API::Request::SANDBOX_API_URL, headers: {
+        'X-TJ-Expected-Response' => 422
+      })
+      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[:authorization]).to eq('Bearer AK')
+      expect(subject.headers['X-TJ-Expected-Response']).to eq(422)
+    end
+
     it 'should return request method' do
       expect(subject).to respond_to(:request_method)
       expect(subject.request_method).to be_instance_of(Symbol)
@@ -102,7 +128,6 @@ describe Taxjar::API::Request do
           to_return(:status => 200, :body => '{"object": {"id": "3"}}',
                     :headers => {content_type: 'application/json; charset=UTF-8'})
 
-
         expect(subject.perform).to eq({id: '3'})
       end
     end
@@ -140,6 +165,7 @@ describe Taxjar::API::Request do
                                  "detail": "error explanation",
                                  "status": "'+ status.to_s + '"}',
                       :headers => {content_type: 'application/json; charset=UTF-8'})
+
           expect{subject.perform}.to raise_error(exception, 'error explanation')
         end
       end

data/spec/taxjar/client_spec.rb

@@ -13,6 +13,34 @@ describe Taxjar::Client do
     end
   end
 
+  describe "#set_api_config" do
+    it 'sets new api key' do
+      client = Taxjar::Client.new(api_key: 'AK')
+      client.set_api_config('api_key', 'ZZ')
+      expect(client.api_key).to eq('ZZ')
+    end
+
+    it 'sets new api url' do
+      client = Taxjar::Client.new(api_key: 'AK')
+      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')
+      client.set_api_config('api_key', 'ZZ')
+      expect(client.get_api_config('api_key')).to eq('ZZ')
+    end
+  end
+
   describe '#user_agent' do
     it 'returns string with version' do
       client = Taxjar::Client.new(api_key: 'AK')

data/taxjar-ruby.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
 
   spec.add_dependency 'addressable', '~> 2.3'
-  spec.add_dependency 'http', '~> 2.2.2'
+  spec.add_dependency 'http', '~> 2.2'
   spec.add_dependency 'memoizable', '~> 0.4.0'
   spec.add_dependency 'model_attribute', '~> 3.2'
   spec.add_development_dependency "bundler", "~> 1.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxjar-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: memoizable
   requirement: !ruby/object:Gem::Requirement
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Taxjar API