taxjar-ruby 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf9845756bfeec2ace638f0e6414d73e2aeba0b9
-  data.tar.gz: f1852b4526f2fe8fac2530324acee0ca41146a78
+  metadata.gz: 0fa1ef8cd573c3ec624180399c2a29ddccfcc82d
+  data.tar.gz: dc58878c74697adc26b9750f0a1a64bc4dc38df9
 SHA512:
-  metadata.gz: b7dfb2ad328bc585763ca567f521a705fd799582ae32076051af68278dc618eae7593392a8b2c2af3c416685aa3c44878bb1660e55eb5b638b0152e908337df6
-  data.tar.gz: 073e8445230a589b9d67721df6e6fad3a14e92aba7c5bfe4e440de7fc7ec6c925044877a72aac0c0524e643262d2b5125f90e8207b33032f2d88bd5ec2f57201
+  metadata.gz: ae413a7c6e7318eb960976f8236095b7e679afcafe241a284d8fdc5ee071a552df1cf87db42ac52afc03dbb39c2e3d3fb3963f7e60ca5825b670dfb8a27cb7ec
+  data.tar.gz: 2f9acee68886bc4fefe8645c7eca656a337624831df83c30f11f66725dbf36be70e76f18d33e1372aa2338c2a96ca22138b83299c0203aafe4d96fb7d8aa3029

data/.editorconfig

@@ -0,0 +1,17 @@
+# http://editorconfig.org/
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+
+[Rakefile]
+indent_style=space
+indent_size=2
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_style=space
+indent_size=2
+trim_trailing_whitespace = true

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 2.1.0 (2018-03-21)
+* Sandbox environment support with `api_url` and custom headers
+
+# 2.0.0 (2017-10-30)
+* Update minimum required Ruby version to 2.0
+* Update HTTP (The Gem) to 2.2

data/README.md

@@ -781,6 +781,228 @@ client.delete_refund('321')
   ]
 }>
 ```
+
+### List customers
+
+#### Definition
+
+```ruby
+client.list_customers
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '48ceecccc8af930bd02597aec0f84a78')
+
+client.list_customers
+```
+
+#### Example Response
+
+```ruby
+['123', '124', '125']
+```
+
+### Show customer
+
+#### Definition
+
+```ruby
+client.show_customer
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '48ceecccc8af930bd02597aec0f84a78')
+
+client.show_customer('123')
+```
+
+#### Example Response
+
+```ruby
+#<Taxjar::Customer @attrs={
+  :customer_id => "123",
+  :exemption_type => "wholesale",
+  :exempt_regions => [
+    [0] {
+      :country => "US",
+      :state => "FL"
+    },
+    [1] {
+      :country => "US",
+      :state => "PA"
+    }
+  ],
+  :name => "Dunder Mifflin Paper Company",
+  :country => "US",
+  :state => "PA",
+  :zip => "18504",
+  :city => "Scranton",
+  :street => "1725 Slough Avenue"
+}>
+```
+
+### Create customer
+
+#### Definition
+
+```ruby
+client.create_customer
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '48ceecccc8af930bd02597aec0f84a78')
+
+customer = client.create_customer({
+  :customer_id => '123',
+  :exemption_type => 'wholesale',
+  :name => 'Dunder Mifflin Paper Company',
+  :exempt_regions => [
+    {
+      :country => 'US',
+      :state => 'FL'
+    },
+    {
+      :country => 'US',
+      :state => 'PA'
+    }
+  ],
+  :country => 'US',
+  :state => 'PA',
+  :zip => '18504',
+  :city => 'Scranton',
+  :street => '1725 Slough Avenue'
+})
+```
+
+#### Example Response
+
+```ruby
+#<Taxjar::Customer @attrs={
+  :customer_id => "123",
+  :exemption_type => "wholesale",
+  :exempt_regions => [
+    [0] {
+      :country => "US",
+      :state => "FL"
+    },
+    [1] {
+      :country => "US",
+      :state => "PA"
+    }
+  ],
+  :name => "Dunder Mifflin Paper Company",
+  :country => "US",
+  :state => "PA",
+  :zip => "18504",
+  :city => "Scranton",
+  :street => "1725 Slough Avenue"
+}>
+```
+
+### Update customer
+
+#### Definition
+
+```ruby
+client.update_customer
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '48ceecccc8af930bd02597aec0f84a78')
+
+customer = client.update_customer({
+  :customer_id => '123',
+  :exemption_type => 'wholesale',
+  :name => 'Sterling Cooper',
+  :exempt_regions => [
+    {
+      :country => 'US',
+      :state => 'NY'
+    }
+  ],
+  :country => 'US',
+  :state => 'NY',
+  :zip => '10010',
+  :city => 'New York',
+  :street => '405 Madison Ave'
+})
+```
+
+#### Example Response
+
+```ruby
+#<Taxjar::Customer @attrs={
+  :customer_id => "123",
+  :exemption_type => "wholesale",
+  :exempt_regions => [
+    [0] {
+      :country => "US",
+      :state => "NY"
+    }
+  ],
+  :name => "Sterling Cooper",
+  :country => "US",
+  :state => "NY",
+  :zip => "10010",
+  :city => "New York",
+  :street => "405 Madison Ave"
+}>
+```
+
+### Delete customer
+
+#### Definition
+
+```ruby
+client.delete_customer
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '48ceecccc8af930bd02597aec0f84a78')
+
+client.delete_customer('123')
+```
+
+#### Example Response
+
+```ruby
+#<Taxjar::Customer @attrs={
+  :customer_id => "123",
+  :exemption_type => "wholesale",
+  :exempt_regions => [
+    [0] {
+      :country => "US",
+      :state => "FL"
+    },
+    [1] {
+      :country => "US",
+      :state => "PA"
+    }
+  ],
+  :name => "Dunder Mifflin Paper Company",
+  :country => "US",
+  :state => "PA",
+  :zip => "18504",
+  :city => "Scranton",
+  :street => "1725 Slough Avenue"
+}>
+```
+
 ### List nexus regions
 
 #### Definition

data/lib/taxjar.rb

@@ -3,6 +3,8 @@ require "taxjar/breakdown"
 require "taxjar/breakdown_line_item"
 require "taxjar/category"
 require "taxjar/client"
+require "taxjar/customer"
+require "taxjar/exempt_region"
 require "taxjar/line_item"
 require "taxjar/nexus_region"
 require "taxjar/order"

data/lib/taxjar/api/customer.rb

@@ -0,0 +1,30 @@
+require 'taxjar/api/utils'
+
+module Taxjar
+  module API
+    module Customer
+      include Taxjar::API::Utils
+
+      def list_customers(options = {})
+        perform_get_with_array("/v2/customers", 'customers', options)
+      end
+
+      def show_customer(id, options = {})
+        perform_get_with_object("/v2/customers/#{id}", 'customer', options, Taxjar::Customer)
+      end
+
+      def create_customer(options = {})
+        perform_post_with_object("/v2/customers", 'customer', options, Taxjar::Customer)
+      end
+
+      def update_customer(options = {})
+        id = options.fetch(:customer_id)
+        perform_put_with_object("/v2/customers/#{id}", 'customer', options, Taxjar::Customer)
+      end
+
+      def delete_customer(id, options={})
+        perform_delete_with_object("/v2/customers/#{id}", 'customer', options, Taxjar::Customer)
+      end
+    end
+  end
+end

data/lib/taxjar/client.rb

@@ -1,4 +1,5 @@
 require 'taxjar/api/api'
+require 'taxjar/api/customer'
 require 'taxjar/api/order'
 require 'taxjar/api/refund'
 require 'taxjar/error'
@@ -8,6 +9,7 @@ require 'taxjar/api/utils'
 module Taxjar
   class Client
     include Taxjar::API
+    include Taxjar::API::Customer
     include Taxjar::API::Order
     include Taxjar::API::Refund
 

data/lib/taxjar/customer.rb

@@ -0,0 +1,20 @@
+require 'taxjar/base'
+
+module Taxjar
+  class Customer < Taxjar::Base
+    extend ModelAttribute
+
+    attribute :customer_id,    :string
+    attribute :exemption_type, :string
+    attribute :name,           :string
+    attribute :country,        :string
+    attribute :state,          :string
+    attribute :zip,            :string
+    attribute :city,           :string
+    attribute :street,         :string
+
+    def exempt_regions
+      map_collection(Taxjar::ExemptRegion, :exempt_regions)
+    end
+  end
+end

data/lib/taxjar/exempt_region.rb

@@ -0,0 +1,10 @@
+require 'taxjar/base'
+
+module Taxjar
+  class ExemptRegion < Taxjar::Base
+    extend ModelAttribute
+
+    attribute :country, :string
+    attribute :state,   :string
+  end
+end

data/lib/taxjar/version.rb

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

data/spec/fixtures/customer.json

@@ -0,0 +1,22 @@
+{
+  "customer": {
+    "customer_id": "123",
+    "exemption_type": "wholesale",
+    "exempt_regions": [
+      {
+        "country": "US",
+        "state": "FL"
+      },
+      {
+        "country": "US",
+        "state": "PA"
+      }
+    ],
+    "name": "Dunder Mifflin Paper Company",
+    "country": "US",
+    "state": "PA",
+    "zip": "18504",
+    "city": "Scranton",
+    "street": "1725 Slough Avenue"
+  }
+}

data/spec/fixtures/customers.json

@@ -0,0 +1,7 @@
+{
+    "customers": [
+        "123",
+        "456"
+    ]
+}
+  

data/spec/taxjar/api/customer_spec.rb

@@ -0,0 +1,202 @@
+require 'helper'
+
+describe Taxjar::API::Order do
+  before do
+    @client = Taxjar::Client.new(api_key: 'AK')
+  end
+
+  describe "#list_customers" do
+    context "without parameters" do
+      before do
+        stub_get('/v2/customers').to_return(body: fixture('customers.json'),
+                  headers: {content_type: 'application/json; charset=utf-8'})
+      end
+
+      it 'requests the right resource' do
+        @client.list_customers
+        expect(a_get('/v2/customers')).to have_been_made
+      end
+
+      it 'returns the requested customers' do
+        customers = @client.list_customers
+        expect(customers).to be_an Array
+        expect(customers.first).to be_a String
+        expect(customers.first).to eq('123')
+      end
+    end
+  end
+
+  describe "#show_customer" do
+    before do
+        stub_get('/v2/customers/123').
+          to_return(body: fixture('customer.json'),
+                    headers: {content_type: 'application/json; charset=utf-8'})
+    end
+
+    it 'requests the right resource' do
+      @client.show_customer('123')
+      expect(a_get('/v2/customers/123')).to have_been_made
+    end
+
+    it 'returns the requested customer' do
+      customer = @client.show_customer('123')
+      expect(customer).to be_an Taxjar::Customer
+      expect(customer.customer_id).to eq('123')
+      expect(customer.exemption_type).to eq('wholesale')
+      expect(customer.name).to eq('Dunder Mifflin Paper Company')
+      expect(customer.country).to eq('US')
+      expect(customer.state).to eq('PA')
+      expect(customer.zip).to eq('18504')
+      expect(customer.city).to eq('Scranton')
+      expect(customer.street).to eq('1725 Slough Avenue')
+    end
+
+    it 'allows access to exempt_regions' do
+      customer = @client.show_customer('123')
+      expect(customer.exempt_regions[0].country).to eq('US')
+      expect(customer.exempt_regions[0].state).to eq('FL')
+      expect(customer.exempt_regions[1].country).to eq('US')
+      expect(customer.exempt_regions[1].state).to eq('PA')
+    end
+  end
+
+  describe "#create_customer" do
+    before do
+      stub_post("/v2/customers").to_return(body: fixture('customer.json'),
+                                            headers: {content_type: 'application/json; charset=utf-8'})
+
+      @customer = {
+        :customer_id => '123',
+        :exemption_type => 'wholesale',
+        :name => 'Dunder Mifflin Paper Company',
+        :exempt_regions => [
+          {
+            :country => 'US',
+            :state => 'FL'
+          },
+          {
+            :country => 'US',
+            :state => 'PA'
+          }
+        ],
+        :country => 'US',
+        :state => 'PA',
+        :zip => '18504',
+        :city => 'Scranton',
+        :street => '1725 Slough Avenue'
+      }
+    end
+
+    it 'requests the right resource' do
+      @client.create_customer(@customer)
+      expect(a_post("/v2/customers")).to have_been_made
+    end
+
+    it 'returns the created customer' do
+      customer = @client.create_customer(@customer)
+      expect(customer.customer_id).to eq('123')
+      expect(customer.exemption_type).to eq('wholesale')
+      expect(customer.name).to eq('Dunder Mifflin Paper Company')
+      expect(customer.country).to eq('US')
+      expect(customer.state).to eq('PA')
+      expect(customer.zip).to eq('18504')
+      expect(customer.city).to eq('Scranton')
+      expect(customer.street).to eq('1725 Slough Avenue')
+    end
+
+    it 'allows access to exempt_regions' do
+      customer = @client.create_customer(@customer)
+      expect(customer.exempt_regions[0].country).to eq('US')
+      expect(customer.exempt_regions[0].state).to eq('FL')
+      expect(customer.exempt_regions[1].country).to eq('US')
+      expect(customer.exempt_regions[1].state).to eq('PA')
+    end
+  end
+
+  describe "#update_customer" do
+    before do
+      @customer_id = 123
+      stub_put("/v2/customers/#{@customer_id}").to_return(body: fixture('customer.json'),
+                                            headers: {content_type: 'application/json; charset=utf-8'})
+
+      @customer = {
+        :customer_id => '123',
+        :exemption_type => 'wholesale',
+        :name => 'Dunder Mifflin Paper Company',
+        :exempt_regions => [
+          {
+            :country => 'US',
+            :state => 'FL'
+          },
+          {
+            :country => 'US',
+            :state => 'PA'
+          }
+        ],
+        :country => 'US',
+        :state => 'PA',
+        :zip => '18504',
+        :city => 'Scranton',
+        :street => '1725 Slough Avenue'
+      }
+    end
+
+    it 'requests the right resource' do
+      @client.update_customer(@customer)
+      expect(a_put("/v2/customers/#{@customer_id}")).to have_been_made
+    end
+
+    it 'returns the updated customer' do
+      customer = @client.update_customer(@customer)
+      expect(customer.customer_id).to eq('123')
+      expect(customer.exemption_type).to eq('wholesale')
+      expect(customer.name).to eq('Dunder Mifflin Paper Company')
+      expect(customer.country).to eq('US')
+      expect(customer.state).to eq('PA')
+      expect(customer.zip).to eq('18504')
+      expect(customer.city).to eq('Scranton')
+      expect(customer.street).to eq('1725 Slough Avenue')
+    end
+
+    it 'allows access to exempt_regions' do
+      customer = @client.update_customer(@customer)
+      expect(customer.exempt_regions[0].country).to eq('US')
+      expect(customer.exempt_regions[0].state).to eq('FL')
+      expect(customer.exempt_regions[1].country).to eq('US')
+      expect(customer.exempt_regions[1].state).to eq('PA')
+    end
+  end
+
+  describe "#delete_customer" do
+    before do
+        stub_delete('/v2/customers/123').to_return(body: fixture('customer.json'),
+                    headers: {content_type: 'application/json; charset=utf-8'})
+    end
+
+    it 'requests the right resource' do
+      @client.delete_customer('123')
+      expect(a_delete('/v2/customers/123')).to have_been_made
+    end
+
+    it 'returns the deleted customer' do
+      customer = @client.delete_customer('123')
+      expect(customer.customer_id).to eq('123')
+      expect(customer.exemption_type).to eq('wholesale')
+      expect(customer.name).to eq('Dunder Mifflin Paper Company')
+      expect(customer.country).to eq('US')
+      expect(customer.state).to eq('PA')
+      expect(customer.zip).to eq('18504')
+      expect(customer.city).to eq('Scranton')
+      expect(customer.street).to eq('1725 Slough Avenue')
+    end
+
+    it 'allows access to exempt_regions' do
+      customer = @client.delete_customer('123')
+      expect(customer.exempt_regions[0].country).to eq('US')
+      expect(customer.exempt_regions[0].state).to eq('FL')
+      expect(customer.exempt_regions[1].country).to eq('US')
+      expect(customer.exempt_regions[1].state).to eq('PA')
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxjar-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -101,16 +101,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/taxjar.rb
 - lib/taxjar/api/api.rb
+- lib/taxjar/api/customer.rb
 - lib/taxjar/api/order.rb
 - lib/taxjar/api/refund.rb
 - lib/taxjar/api/request.rb
@@ -120,7 +123,9 @@ files:
 - lib/taxjar/breakdown_line_item.rb
 - lib/taxjar/category.rb
 - lib/taxjar/client.rb
+- lib/taxjar/customer.rb
 - lib/taxjar/error.rb
+- lib/taxjar/exempt_region.rb
 - lib/taxjar/line_item.rb
 - lib/taxjar/nexus_region.rb
 - lib/taxjar/order.rb
@@ -132,6 +137,8 @@ files:
 - lib/taxjar/validation.rb
 - lib/taxjar/version.rb
 - spec/fixtures/categories.json
+- spec/fixtures/customer.json
+- spec/fixtures/customers.json
 - spec/fixtures/nexus_regions.json
 - spec/fixtures/order.json
 - spec/fixtures/orders.json
@@ -149,6 +156,7 @@ files:
 - spec/fixtures/validation.json
 - spec/helper.rb
 - spec/taxjar/api/api_spec.rb
+- spec/taxjar/api/customer_spec.rb
 - spec/taxjar/api/order_spec.rb
 - spec/taxjar/api/refund_spec.rb
 - spec/taxjar/api/request_spec.rb
@@ -176,12 +184,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Taxjar API
 test_files:
 - spec/fixtures/categories.json
+- spec/fixtures/customer.json
+- spec/fixtures/customers.json
 - spec/fixtures/nexus_regions.json
 - spec/fixtures/order.json
 - spec/fixtures/orders.json
@@ -199,6 +209,7 @@ test_files:
 - spec/fixtures/validation.json
 - spec/helper.rb
 - spec/taxjar/api/api_spec.rb
+- spec/taxjar/api/customer_spec.rb
 - spec/taxjar/api/order_spec.rb
 - spec/taxjar/api/refund_spec.rb
 - spec/taxjar/api/request_spec.rb