taxjar-ruby 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a24105fb53dc4c4d32428f281018b7d38462860b
-  data.tar.gz: cbf114a54aa13bcc1e0bd16b2d05e743a74970dd
+  metadata.gz: de60a587fe7825100a642391d002f1c99d52f0ab
+  data.tar.gz: e92d5eec0d405dfe7ac2de168bbb996d714fb687
 SHA512:
-  metadata.gz: aac27c83a06389a8fde8dca6e51ea7cd8446bea7693a32a2d4ea6c5fd2f04113f158850a09d02f5ae19b9d929705868e67c9a533bb4833bfa7cea3e42127858f
-  data.tar.gz: 9913a9425272d1d1be3608c754d01eead9bd3d56bc50126f3e4ad360136b89002123d79b8dfcc1d78ef21abecc168dd7770cb714a3f1ee43826a9758a86ee83e
+  metadata.gz: 99d505a853e4c8d01f1126ff3f5dbfb8698a3e2dbc63bb14ff9fcd431cd196d9a73e584775587cc61d101b1b78e26b80eb8212ae5a478903530d6d226cf705d4
+  data.tar.gz: 6ea9d5d6d01e8235f2d2d47e5e4e21c5a2388e83ddb05bbdf4b09611bcbef0595b79bf3f522cd16fed2cde859134b8860ca0c9bdf90704e898d8f8c214eca6de

data/.travis.yml

@@ -6,4 +6,7 @@ rvm:
  - "2.1"
  - "2.2"
 
-script: bundle exec rspec
+script: bundle exec rspec
+
+before_install:
+  - gem install bundler

data/README.md

@@ -776,6 +776,109 @@ client.delete_refund(321)
 }>
 ```
 
+### Validate a VAT number
+
+#### Definition
+
+```ruby
+client.validate
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '9e0cd62a22f451701f29c3bde214')
+
+validation = client.validate({
+  :vat => 'FR40303265045'
+})
+```
+
+#### Example Response
+
+```ruby
+#<Taxjar::Validation @attrs={
+  :valid => true,
+  :exists => true,
+  :vies_available => true,
+  :vies_response => {
+    :country_code => "FR",
+    :vat_number => "40303265045",
+    :request_date => "2016-02-10",
+    :valid => true,
+    :name => "SA SODIMAS",
+    :address => "11 RUE AMPERE\n26600 PONT DE L ISERE"
+  }
+}>
+```
+
+### Summarize tax rates for all regions
+
+#### Definition
+
+```ruby
+client.summary_rates
+```
+
+#### Example Request
+
+```ruby
+require 'taxjar'
+client = Taxjar::Client.new(api_key: '9e0cd62a22f451701f29c3bde214')
+
+summarized_rates = client.summary_rates
+```
+
+#### Example Response
+
+```ruby
+[
+  {
+    :country_code => "US",
+    :country => "United States",
+    :region_code => "CA",
+    :region => "California",
+    :minimum_rate => {
+      :label => "State Tax",
+      :rate => 0.065
+    },
+    :average_rate => {
+      :label => "Tax",
+      :rate => 0.0827
+    }
+  },
+  {
+    :country_code => "CA",
+    :country => "Canada",
+    :region_code => "BC",
+    :region => "British Columbia",
+    :minimum_rate => {
+      :label => "GST",
+      :rate => 0.05
+    },
+    :average_rate => {
+      :label => "PST",
+      :rate => 0.12
+    }
+  },
+  {
+    :country_code => "UK",
+    :country => "United Kingdom",
+    :region_code => nil,
+    :region => nil,
+    :minimum_rate => {
+      :label => "VAT",
+      :rate => 0.2
+    },
+    :average_rate => {
+      :label => "VAT",
+      :rate => 0.2
+    }
+  }
+]
+```
+
 ## Tests
 
 An RSpec test suite is available to ensure API functionality:

data/lib/taxjar.rb

@@ -8,7 +8,9 @@ require "taxjar/order"
 require "taxjar/rate"
 require "taxjar/refund"
 require "taxjar/shipping"
+require "taxjar/summary_rate"
 require "taxjar/tax"
+require "taxjar/validation"
 require "taxjar/version"
 
 module Taxjar

data/lib/taxjar/api/api.rb

@@ -8,12 +8,20 @@ module Taxjar
       perform_get_with_objects("/v2/categories", 'categories', options, Taxjar::Category)
     end
 
-    def rates_for_location(postal_code, options ={})
+    def rates_for_location(postal_code, options = {})
       perform_get_with_object("/v2/rates/#{postal_code}", 'rate', options, Taxjar::Rate)
     end
 
     def tax_for_order(options = {})
       perform_post_with_object("/v2/taxes", 'tax', options, Taxjar::Tax)
     end
+    
+    def validate(options = {})
+      perform_get_with_object("/v2/validation", 'validation', options, Taxjar::Validation)
+    end
+    
+    def summary_rates(options = {})
+      perform_get_with_objects("/v2/summary_rates", 'summary_rates', options, Taxjar::SummaryRate)
+    end
   end
 end

data/lib/taxjar/summary_rate.rb

@@ -0,0 +1,29 @@
+require 'taxjar/base'
+
+module Taxjar
+  class SummaryRate < Taxjar::Base
+    extend ModelAttribute
+    
+    attribute :country_code, :string
+    attribute :country,       :string
+    attribute :region_code,  :string
+    attribute :region,       :string
+    
+    class MinimumRate < SummaryRate
+      extend ModelAttribute
+      
+      attribute :label, :string
+      attribute :rate,  :float
+    end
+    
+    class AverageRate < SummaryRate
+      extend ModelAttribute
+
+      attribute :label, :string
+      attribute :rate,  :float
+    end
+    
+    object_attr_reader MinimumRate, :minimum_rate
+    object_attr_reader AverageRate, :average_rate
+  end
+end

data/lib/taxjar/validation.rb

@@ -0,0 +1,23 @@
+require 'taxjar/base'
+
+module Taxjar
+  class Validation < Taxjar::Base
+    extend ModelAttribute
+    
+    attribute :valid,          :boolean
+    attribute :exists,         :boolean
+    attribute :vies_available, :boolean
+    
+    class ViesResponse < Validation
+      extend ModelAttribute
+
+      attribute :vat_number,   :string
+      attribute :request_date, :string
+      attribute :valid,        :boolean
+      attribute :name,         :string
+      attribute :address,      :string
+    end
+    
+    object_attr_reader ViesResponse, :vies_response
+  end
+end

data/lib/taxjar/version.rb

@@ -6,11 +6,11 @@ module Taxjar
     end
 
     def minor
-      2
+      3
     end
 
     def patch
-      2
+      0
     end
 
     def pre

data/spec/fixtures/summary_rates.json

@@ -0,0 +1,46 @@
+{
+  "summary_rates": [
+    {
+      "country_code": "US",
+      "country": "United States",
+      "region_code": "CA",
+      "region": "California",
+      "minimum_rate": {
+        "label": "State Tax",
+        "rate": 0.065
+      },
+      "average_rate": {
+        "label": "Tax",
+        "rate": 0.0827
+      }
+    },
+    {
+      "country_code": "CA",
+      "country": "Canada",
+      "region_code": "BC",
+      "region": "British Columbia",
+      "minimum_rate": {
+        "label": "GST",
+        "rate": 0.05
+      },
+      "average_rate": {
+        "label": "PST",
+        "rate": 0.12
+      }
+    },
+    {
+      "country_code": "UK",
+      "country": "United Kingdom",
+      "region_code": null,
+      "region": null,
+      "minimum_rate": {
+        "label": "VAT",
+        "rate": 0.2
+      },
+      "average_rate": {
+        "label": "VAT",
+        "rate": 0.2
+      }
+    }
+  ]
+}

data/spec/fixtures/validation.json

@@ -0,0 +1,15 @@
+{
+  "validation": {
+    "valid": true,
+    "exists": true,
+    "vies_available": true,
+    "vies_response": {
+      "country_code": "FR",
+      "vat_number": "40303265045",
+      "request_date": "2016-02-10",
+      "valid": true,
+      "name": "SA SODIMAS",
+      "address": "11 RUE AMPERE\n26600 PONT DE L ISERE"
+    }
+  }
+}

data/spec/taxjar/api/api_spec.rb

@@ -156,4 +156,59 @@ describe Taxjar::API do
       expect(tax.breakdown.line_items[0].special_tax_rate).to eq(0)
     end
   end
+  
+  describe '#validate' do
+    before do
+      @params = 'vat=FR40303265045'
+      stub_get("/v2/validation?#{@params}").to_return(body: fixture('validation.json'),
+                                                    headers: {content_type: 'application/json; charset=utf-8'})
+      @validation = {
+        :vat => 'FR40303265045'
+      }
+    end
+
+    it 'requests the right resource' do
+      @client.validate(@validation)
+      expect(a_get("/v2/validation?#{@params}")).to have_been_made
+    end
+
+    it 'returns the requested validation' do
+      validation = @client.validate(@validation)
+      expect(validation).to be_a Taxjar::Validation
+      expect(validation.valid).to eq(true)
+      expect(validation.exists).to eq(true)
+      expect(validation.vies_available).to eq(true)
+      expect(validation.vies_response.vat_number).to eq('40303265045')
+      expect(validation.vies_response.request_date).to eq('2016-02-10')
+      expect(validation.vies_response.valid).to eq(true)
+      expect(validation.vies_response.name).to eq('SA SODIMAS')
+      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'})
+    end
+
+    it 'requests the right resource' do
+      @client.summary_rates
+      expect(a_get('/v2/summary_rates')).to have_been_made
+    end
+
+    it 'returns the requested summarized rates' do
+      summarized_rates = @client.summary_rates
+      expect(summarized_rates).to be_an Array
+      expect(summarized_rates.first).to be_a Taxjar::SummaryRate
+      expect(summarized_rates.first.country_code).to eq('US')
+      expect(summarized_rates.first.country).to eq('United States')
+      expect(summarized_rates.first.region_code).to eq('CA')
+      expect(summarized_rates.first.region).to eq('California')
+      expect(summarized_rates.first.minimum_rate.label).to eq('State Tax')
+      expect(summarized_rates.first.minimum_rate.rate).to eq(0.065)
+      expect(summarized_rates.first.average_rate.label).to eq('Tax')
+      expect(summarized_rates.first.average_rate.rate).to eq(0.0827)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxjar-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -126,7 +126,9 @@ files:
 - lib/taxjar/rate.rb
 - lib/taxjar/refund.rb
 - lib/taxjar/shipping.rb
+- lib/taxjar/summary_rate.rb
 - lib/taxjar/tax.rb
+- lib/taxjar/validation.rb
 - lib/taxjar/version.rb
 - spec/fixtures/categories.json
 - spec/fixtures/order.json
@@ -135,7 +137,9 @@ files:
 - spec/fixtures/rates_intl.json
 - spec/fixtures/refund.json
 - spec/fixtures/refunds.json
+- spec/fixtures/summary_rates.json
 - spec/fixtures/taxes.json
+- spec/fixtures/validation.json
 - spec/helper.rb
 - spec/taxjar/api/api_spec.rb
 - spec/taxjar/api/order_spec.rb
@@ -165,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Taxjar API
@@ -177,7 +181,9 @@ test_files:
 - spec/fixtures/rates_intl.json
 - spec/fixtures/refund.json
 - spec/fixtures/refunds.json
+- spec/fixtures/summary_rates.json
 - spec/fixtures/taxes.json
+- spec/fixtures/validation.json
 - spec/helper.rb
 - spec/taxjar/api/api_spec.rb
 - spec/taxjar/api/order_spec.rb