taxjar-ruby 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57abdd838dccafdd3d06963feeb4300dcc50cf12
-  data.tar.gz: f9bd34f1b42043934a40f340616233165bb45c64
+  metadata.gz: f0124865033d49c8769192fb6b83f1e665dcf3ee
+  data.tar.gz: 9951d91514a63cedb64a949fb4d6c971696cce84
 SHA512:
-  metadata.gz: 3d40feec61b61684a9041eb88480674a096c75d4b8fce5dd4ab0b33283835cd956d3f9883dcde20e7ca92914bc69702149d18ceb224fef992c3bafe997318570
-  data.tar.gz: c985406fd1c1970628252a3a0a769df953db871fd318f03aea8232fb8f7bdfd0e1d3d9511078eb436cc9aecd505b995180534a1be4102960e33978ff3bd14667
+  metadata.gz: 75c264a26b5a1c199bb37aaf6206543fe7787a34177d67eb5b5ffa0fda9a458c02b4d695293735d153d7ad102056a598a36e02d0d82d6cac7ceeb0803f73a6f5
+  data.tar.gz: f69d0358b7e13c78570491fb808a61bc68c3a4449ff839f59d93ba2b5b3c04daa490fec73e6b0d2807b68d96bc876f2ba1084c9342f7a4a9008705d17eec6fb6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2.4.0 (2018-10-31)
+* Address validation for TaxJar Plus customers
+
 # 2.3.0 (2018-09-17)
 * Provide access to new jurisdiction names via `tax_for_order`
 

data/README.md

@@ -2,8 +2,7 @@
 
 <a href="http://developers.taxjar.com"><img src="http://www.taxjar.com/img/TJ_logo_color_office_png.png" alt="TaxJar" width="220"></a>
 
-A Ruby interface to the TaxJar [Sales Tax API](https://developers.taxjar.com/api/reference/). TaxJar makes sales tax filing easier for online sellers and merchants. 
-See local jurisdictional tax reports, get payment reminders, and more. You can use our API to access TaxJar API endpoints, which can get information on sales tax rates, categories or upload transactions.
+A Ruby interface to the TaxJar [Sales Tax API](https://developers.taxjar.com/api/reference/). TaxJar makes sales tax filing easier for online sellers and merchants. See local jurisdictional tax reports, get payment reminders, and more. You can use our API to access TaxJar API endpoints, which can get information on sales tax rates, categories or upload transactions.
 
 * This wrapper supports 100% of [SmartCalcs v2](http://developers.taxjar.com/api/#introduction)
 * Data returned from API calls are mapped to Ruby objects
@@ -76,18 +75,18 @@ client.categories
 ```ruby
 [
   #<Taxjar::Category:0x00000a @attrs={
-    :name => 'Digital Goods', 
-    :product_tax_code => 31000, 
+    :name => 'Digital Goods',
+    :product_tax_code => 31000,
     :description => 'Digital products transferred electronically.'
-  }>, 
+  }>,
   #<Taxjar::Category:0x00000a @attrs={
-    :name => 'Clothing', 
-    :product_tax_code => 20010, 
+    :name => 'Clothing',
+    :product_tax_code => 20010,
     :description => 'All human wearing apparel suitable for general use'
-  }>, 
+  }>,
   #<Taxjar::Category:0x00000a @attrs={
     :name => 'Non-Prescription',
-    :product_tax_code => 51010, 
+    :product_tax_code => 51010,
     :description => 'Drugs for human use without a prescription'
   }>
 ]
@@ -132,7 +131,7 @@ rates = client.rates_for_location('00150', {
 
 ```ruby
 #<Taxjar::Rate:0x00000a @attrs={
-  :zip => '90002', 
+  :zip => '90002',
   :state => 'CA',
   :state_rate => 0.065,
   :county => 'LOS ANGELES',
@@ -186,7 +185,7 @@ client.tax_for_order({
     :to_state => 'CA',
     :from_country => 'US',
     :from_zip => '92093',
-    :from_city => 'San Diego',                
+    :from_city => 'San Diego',
     :amount => 15,
     :shipping => 1.5,
     :nexus_addresses => [{:address_id => 1,
@@ -210,6 +209,12 @@ client.tax_for_order({
   :has_nexus => true,
   :freight_taxable => false,
   :tax_source => 'destination',
+  :jurisdictions => #<Taxjar::Jurisdictions:0x00000a @attrs={
+    :country => 'US',
+    :state => 'CA',
+    :county => 'LOS ANGELES',
+    :city => 'LOS ANGELES'
+  }>,
   :breakdown => #<Taxjar::Breakdown:0x00000a @attrs={
     :state_taxable_amount => 15,
     :state_tax_collectable => 0.98,
@@ -234,17 +239,6 @@ client.tax_for_order({
     ]
   }>
 }>
-
-#<Taxjar::Tax:0x00000a @attrs={
-  :order_total_amount => 27.12,
-  :shipping => 1.5,
-  :taxable_amount => 27.12,
-  :amount_to_collect => 5.42,
-  :rate => 0.2,
-  :has_nexus => true,
-  :freight_taxable => true,
-  :tax_source => 'origin'
-}>
 ```
 
 ### List order transactions
@@ -1148,7 +1142,7 @@ summarized_rates = client.summary_rates
 ]
 ```
 
-### Custom Options
+## Custom Options
 
 Pass a hash to any API method above for the following options:
 
@@ -1222,7 +1216,7 @@ TaxJar is released under the [MIT License](https://github.com/taxjar/taxjar-ruby
 
 ## Support
 
-Bug reports and feature requests should be filed on the [GitHub issue tracking page](https://github.com/taxjar/taxjar-ruby/issues). 
+Bug reports and feature requests should be filed on the [GitHub issue tracking page](https://github.com/taxjar/taxjar-ruby/issues).
 
 ## Contributing
 

data/lib/taxjar.rb

@@ -1,4 +1,5 @@
 require "taxjar/base"
+require "taxjar/address"
 require "taxjar/breakdown"
 require "taxjar/breakdown_line_item"
 require "taxjar/category"

data/lib/taxjar/address.rb

@@ -0,0 +1,13 @@
+require 'taxjar/base'
+
+module Taxjar
+  class Address < Taxjar::Base
+    extend ModelAttribute
+
+    attribute :country, :string
+    attribute :state,   :string
+    attribute :zip,     :string
+    attribute :city,    :string
+    attribute :street,  :string
+  end
+end

data/lib/taxjar/api/api.rb

@@ -19,7 +19,11 @@ module Taxjar
     def nexus_regions(options = {})
       perform_get_with_objects("/v2/nexus/regions", 'regions', options, Taxjar::NexusRegion)
     end
-    
+
+    def validate_address(options = {})
+      perform_post_with_objects("/v2/addresses/validate", 'addresses', options, Taxjar::Address)
+    end
+
     def validate(options = {})
       perform_get_with_object("/v2/validation", 'validation', options, Taxjar::Validation)
     end

data/lib/taxjar/api/utils.rb

@@ -23,6 +23,10 @@ module Taxjar
         perform_request_with_object(:post, path, object_key, options, klass)
       end
 
+      def perform_post_with_objects(path, object_key, options, klass)
+        perform_request_with_objects(:post, path, object_key, options, klass)
+      end
+
       def perform_put_with_object(path, object_key, options, klass)
         perform_request_with_object(:put, path, object_key, options, klass)
       end

data/lib/taxjar/version.rb

@@ -6,7 +6,7 @@ module Taxjar
     end
 
     def minor
-      3
+      4
     end
 
     def patch

data/spec/fixtures/addresses.json

@@ -0,0 +1,11 @@
+{
+    "addresses": [
+        {
+            "zip": "85297-2176",
+            "street": "3301 S Greenfield Rd",
+            "state": "AZ",
+            "country": "US",
+            "city": "Gilbert"
+        }
+    ]
+}

data/spec/fixtures/addresses_multiple.json

@@ -0,0 +1,18 @@
+{
+    "addresses": [
+        {
+            "zip": "85007-3646",
+            "street": "1109 S 9th Ave",
+            "state": "AZ",
+            "country": "US",
+            "city": "Phoenix"
+        },
+        {
+            "zip": "85006-2734",
+            "street": "1109 N 9th St",
+            "state": "AZ",
+            "country": "US",
+            "city": "Phoenix"
+        }
+    ]
+}

data/spec/taxjar/api/api_spec.rb

@@ -125,7 +125,7 @@ describe Taxjar::API do
       expect(rates.freight_taxable).to eq(true)
     end
   end
-
+  
   describe '#rate_for_location (eu)' do
     before do
       @postal_code = "00150"
@@ -219,7 +219,7 @@ describe Taxjar::API do
       expect(tax.breakdown.special_tax_rate).to eq(0)
       expect(tax.breakdown.special_district_tax_collectable).to eq(0)
     end
-
+    
     it 'allows access to breakdown.shipping' do
       tax = @client.tax_for_order(@order)
       expect(tax.breakdown.shipping.taxable_amount).to eq(1.5)
@@ -291,7 +291,7 @@ describe Taxjar::API do
         expect(tax.breakdown.country_tax_rate).to eq(0.24)
         expect(tax.breakdown.country_tax_collectable).to eq(6.47)
       end
-
+      
       it 'allows access to breakdown.shipping' do
         tax = @client.tax_for_order(@order)
         expect(tax.breakdown.shipping.taxable_amount).to eq(10)
@@ -353,7 +353,7 @@ describe Taxjar::API do
         expect(tax.breakdown.qst_tax_rate).to eq(0)
         expect(tax.breakdown.qst).to eq(0)
       end
-
+      
       it 'allows access to breakdown.shipping' do
         tax = @client.tax_for_order(@order)
         expect(tax.breakdown.shipping.taxable_amount).to eq(10)
@@ -388,12 +388,12 @@ describe Taxjar::API do
       end
     end
   end
-
+  
   describe '#nexus_regions' do
     before do
       stub_get('/v2/nexus/regions').to_return(body: fixture('nexus_regions.json'), headers: { content_type: 'application/json; charset=utf-8' })
     end
-
+    
     it 'requests the right resource' do
       @client.nexus_regions
       expect(a_get('/v2/nexus/regions')).to have_been_made
@@ -410,6 +410,67 @@ describe Taxjar::API do
     end
   end
 
+  describe '#validate_address' do
+    before do
+      stub_post('/v2/addresses/validate').to_return(body: fixture('addresses.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    end
+
+    it 'requests the right resource' do
+      @client.validate_address({
+        :country => 'US',
+        :state => 'AZ',
+        :zip => '85297',
+        :city => 'Gilbert',
+        :street => '3301 South Greenfield Rd'
+      })
+      expect(a_post('/v2/addresses/validate')).to have_been_made
+    end
+
+    it 'returns the requested address' do
+      addresses = @client.validate_address({
+        :country => 'US',
+        :state => 'AZ',
+        :zip => '85297',
+        :city => 'Gilbert',
+        :street => '3301 South Greenfield Rd'
+      })
+      expect(addresses).to be_an Array
+      expect(addresses.first).to be_a Taxjar::Address
+      expect(addresses.first.country).to eq('US')
+      expect(addresses.first.state).to eq('AZ')
+      expect(addresses.first.zip).to eq('85297-2176')
+      expect(addresses.first.city).to eq('Gilbert')
+      expect(addresses.first.street).to eq('3301 S Greenfield Rd')
+    end
+
+    describe 'multiple address matches' do
+      before do
+        stub_post('/v2/addresses/validate').to_return(body: fixture('addresses_multiple.json'), headers: { content_type: 'application/json; charset=utf-8' })
+      end
+
+      it 'returns the requested addresses' do
+        addresses = @client.validate_address({
+          :state => 'AZ',
+          :city => 'Phoenix',
+          :street => '1109 9th'
+        })
+        expect(addresses).to be_an Array
+        expect(addresses[0]).to be_a Taxjar::Address
+        expect(addresses[0].country).to eq('US')
+        expect(addresses[0].state).to eq('AZ')
+        expect(addresses[0].zip).to eq('85007-3646')
+        expect(addresses[0].city).to eq('Phoenix')
+        expect(addresses[0].street).to eq('1109 S 9th Ave')
+        expect(addresses[1]).to be_a Taxjar::Address
+        expect(addresses[1].country).to eq('US')
+        expect(addresses[1].state).to eq('AZ')
+        expect(addresses[1].zip).to eq('85006-2734')
+        expect(addresses[1].city).to eq('Phoenix')
+        expect(addresses[1].street).to eq('1109 N 9th St')
+      end
+    end
+  end
+
   describe '#validate' do
     before do
       @params = 'vat=FR40303265045'
@@ -437,7 +498,7 @@ describe Taxjar::API do
       expect(validation.vies_response.address).to eq("11 RUE AMPERE\n26600 PONT DE L ISERE")
     end
   end
-
+  
   describe '#summary_rates' do
     before do
       stub_get('/v2/summary_rates').to_return(body: fixture('summary_rates.json'), headers: { content_type: 'application/json; charset=utf-8' })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxjar-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -112,6 +112,7 @@ files:
 - README.md
 - Rakefile
 - lib/taxjar.rb
+- lib/taxjar/address.rb
 - lib/taxjar/api/api.rb
 - lib/taxjar/api/customer.rb
 - lib/taxjar/api/order.rb
@@ -137,6 +138,8 @@ files:
 - lib/taxjar/tax.rb
 - lib/taxjar/validation.rb
 - lib/taxjar/version.rb
+- spec/fixtures/addresses.json
+- spec/fixtures/addresses_multiple.json
 - spec/fixtures/categories.json
 - spec/fixtures/customer.json
 - spec/fixtures/customers.json
@@ -190,6 +193,8 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for Taxjar API
 test_files:
+- spec/fixtures/addresses.json
+- spec/fixtures/addresses_multiple.json
 - spec/fixtures/categories.json
 - spec/fixtures/customer.json
 - spec/fixtures/customers.json