duty_calculator 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da4d51bf8a977b247e81ccc0e740f83e6d32a513
-  data.tar.gz: ad9381a27607fb9e63ab1d388ad5c2fba5fd05c8
+  metadata.gz: 3074281a85d5dd3f9b02fa22f529ec9950650a2f
+  data.tar.gz: ea02f8be01351e59884132c5b09327958bdb0c79
 SHA512:
-  metadata.gz: dbc1d596554960cc2c69d812de23aa99cdd4197a13652028f61af8a7d99057c7444cb56ad69f3bc2eee424233f36282fd74d6ccc7bdf5d32351dec1fd82b5f5c
-  data.tar.gz: f1531aff60374c32f2769ca52094464bbc5eb331e8c3d65a5a5de3372c848bdf239d168e340c6819bf4541f6e25f6f9e0afa2d352d90e1a0e3dde83a0490757a
+  metadata.gz: b10a1295f4f29c9f5590024754a99bd93d96fb55932f011f6683fe0a1be2bbb9579426ec067fd3a50e61667ec5a96c56393b903c6e3b8b16dc13f7e5cda30615
+  data.tar.gz: 99923120a6705604b59beb285d78e984e2f0ce16baad6c2068f2c74b3aebe562f8be1bf070d68609c571e78728d9f96b4dc4d525cbbf32434205af9439965095

data/Gemfile

@@ -5,5 +5,8 @@ gemspec
 gem 'rspec', :require => 'spec'
 gem 'faraday'
 gem 'faraday_middleware'
+gem 'hashie'
 gem 'multi_xml'
 gem 'addressable'
+gem 'vcr'
+gem 'webmock'

data/README.md

@@ -37,6 +37,31 @@ end
 
 ```
 
+### Get Calculation
+
+```
+duty_calculation = DutyCalculator::Calculation.get(params)
+
+0> duty_calculation.keys
+=> ["id", "item", "total_charges"]
+
+0> duty_calculation.total_charges.keys
+=> ["customs_value", "duty", "sales_tax", "total"]
+
+0> duty_calculation.total_charges.customs_value
+=> #<Hashie::Mash amount=#<Hashie::Mash currency="CAD" value=1556.0> name="FOB">
+
+0> duty_calculation.total_charges.sales_tax
+=> #<Hashie::Mash amount=#<Hashie::Mash currency="CAD" value=77.8> name="GST">
+
+0> duty_calculation.total_charges.duty
+=> #<Hashie::Mash amount=#<Hashie::Mash currency="CAD" value=0.0>>
+
+0> duty_calculation.total_charges.total
+=> #<Hashie::Mash amount=#<Hashie::Mash currency="CAD" value=77.8>>
+
+```
+
 ### Listing Categories
 
 ```ruby
@@ -83,6 +108,11 @@ end
  }
 ```
 
+## TODO
+
+- Port other objects to response nicer objects with `Hashie::Mash`
+- Coerce sub `Array` for `item` to use `Response` object
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/duty_calculator/fork )

data/duty_calculator.gemspec

@@ -20,9 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.20"
   spec.add_dependency "faraday", "~> 0.9"
   spec.add_dependency "faraday_middleware", "~> 0.9"
-  spec.add_runtime_dependency "hashie", "~> 2.1"
+  spec.add_runtime_dependency "hashie", "~> 3.3"
   spec.add_runtime_dependency "multi_xml", "~> 0.5"
   spec.add_runtime_dependency "addressable", "~> 2.3"
 end

data/lib/duty_calculator.rb

@@ -3,10 +3,12 @@ require "duty_calculator/configuration"
 require "duty_calculator/currency"
 require "duty_calculator/category"
 require "duty_calculator/calculation"
+require "duty_calculator/response"
 require "duty_calculator/error_messages"
 
 require "faraday"
 require "faraday_middleware"
+require "hashie"
 
 module DutyCalculator
   class << self

data/lib/duty_calculator/calculation.rb

@@ -1,4 +1,5 @@
 require "duty_calculator/client"
+require "duty_calculator/response"
 require "addressable/uri"
 module DutyCalculator
   class Calculation
@@ -38,10 +39,11 @@ module DutyCalculator
       transformed_params = transform_params(validate_params(params))
       conn = DutyCalculator::Client.new
       resp = conn.get "#{DutyCalculator::Client.api_base}/calculation", transformed_params
-      raise Exception, "Duty Calculator Error: #{DutyCalculator::ErrorMessages.for_code(resp.body["error"]["code"])}" if resp.body["error"]
+      hashed_resp = DutyCalculator::Response.new(resp.to_hash)
+      resp = Hashie::Mash.new(hashed_resp)
+      raise Exception, "Duty Calculator Error: #{DutyCalculator::ErrorMessages.for_code(resp.body.error.code)}" if resp.body.error
       raise Exception, "HTTP Status Code #{resp.status}" if resp.status.to_i != 200
-      return resp.body
+      resp.body.duty_calculation
     end
-
   end
 end

data/lib/duty_calculator/response.rb

@@ -0,0 +1,22 @@
+require "hashie"
+module DutyCalculator
+  class Response < Hash
+    include ::Hashie::Extensions::Coercion
+    coerce_value Hash, Response
+
+    def initialize(hash = {})
+      super
+      hash.each_pair do |k,v|
+        if k == '__content__' && v.to_s == 0.to_s
+          self['value'] = v.to_f
+        elsif k == '__content__' && v.to_i > 0
+          self['value'] = v.to_f
+        elsif k == '__content__'
+          self['value'] = v
+        else
+          self[k] = v
+        end
+      end
+    end
+  end
+end

data/lib/duty_calculator/version.rb

@@ -1,3 +1,3 @@
 module DutyCalculator
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/duty_calculator/calculation_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module DutyCalculator
-  describe Configuration do
+  describe Calculation do
     describe ".transform_params" do
       context "for a single product" do
         let(:params) do
@@ -21,8 +21,8 @@ module DutyCalculator
         it "makes a hash with numerical index keys for array values" do
           transformed = DutyCalculator::Calculation.transform_params(params)
 
-          expect(transformed["from"]).to eq(params[:from])
-          expect(transformed["cat"]).to eq({ 0 => params[:cat].first })
+          expect(transformed[:from]).to eq(params[:from])
+          expect(transformed[:cat]).to eq({ 0 => params[:cat].first })
         end
       end
 
@@ -44,8 +44,94 @@ module DutyCalculator
         it "makes a hash with numerical index keys for array values" do
           transformed = DutyCalculator::Calculation.transform_params(params)
 
-          expect(transformed["from"]).to eq(params[:from])
-          expect(transformed["cat"]).to eq({ 0 => params[:cat].first, 1 => params[:cat].last })
+          expect(transformed[:from]).to eq(params[:from])
+          expect(transformed[:cat]).to eq({ 0 => params[:cat].first, 1 => params[:cat].last })
+        end
+      end
+    end
+    describe ".get" do
+      before do
+        DutyCalculator.configure do |config|
+          config.api_key = "DUTY_CALC"
+          config.sandbox = true
+          config.debug = true
+        end
+      end
+      context "for a single product" do
+        let(:params) do
+          {
+              from: "US",
+              to: "CA",
+              shipping_mode: "USPS",
+              insurance: 0.0,
+              currency: "USD",
+              origin: "US",
+              reference: "ORD12345",
+              preferential_rates: 0,
+              detailed_result: 1,
+              incl_hs_codes: 1,
+              shipping: 10.0,
+              cat: ["522"],
+              hs: ["9019100020", "9019100020"],
+              country_of_hs_code: ["CN"],
+              desc: ["Hydrotherapy Spa Bath"],
+              weight: ["1.0"],
+              weight_unit: ["lb"],
+              value: [ "1234.00" ],
+              sku: [ "300101" ],
+              qty: [ 1 ],
+              commercial_importer: 0,
+              classify_by: 'cat',
+          }
+        end
+        it 'makes a nice hash' do
+          VCR.use_cassette('calculate__nice_hash_for_single_product') do
+            duty_calculation = DutyCalculator::Calculation.get(params)
+            expect(duty_calculation.item.id.class).to eq(String)
+            expect(duty_calculation.item.hs_code.class).to eq(String)
+            expect(duty_calculation.item.sales_tax.amount.value.class).to eq(Float)
+            expect(duty_calculation.total_charges.duty.amount.currency.class).to eq(String)
+            expect(duty_calculation.total_charges.sales_tax.name).to eq("GST")
+            expect(duty_calculation.total_charges.sales_tax.amount.value.class).to eq(Float)
+          end
+        end
+      end
+      context "for multiple products" do
+        let(:params) do
+          {
+              from: "US",
+              to: "CA",
+              shipping_mode: "USPS",
+              insurance: 0.0,
+              currency: "USD",
+              origin: "US",
+              reference: "ORD12345",
+              preferential_rates: 0,
+              detailed_result: 1,
+              incl_hs_codes: 1,
+              shipping: 10.0,
+              cat: ["522","522"],
+              hs: ["9019100020", "9019100020"],
+              country_of_hs_code: ["CN", "DE"],
+              desc: ["Hydrotherapy Spa Bath", "Hydrotherapy Spa Bath"],
+              weight: ["1.0", "2.0"],
+              weight_unit: ["lb", "lb"],
+              value: [ "1234.00", "2345.67" ],
+              sku: [ "300101", "300102" ],
+              qty: [ 1, 2 ],
+              commercial_importer: 0,
+              classify_by: 'cat',
+          }
+        end
+
+        it 'makes a nice hash' do
+          VCR.use_cassette('calculate__nice_hash_for_multiple_products') do
+            duty_calculation = DutyCalculator::Calculation.get(params)
+            expect(duty_calculation.item.size).to eq(2)
+            expect(duty_calculation.total_charges.duty.amount.currency.class).to eq(String)
+            expect(duty_calculation.total_charges.sales_tax.name).to eq("GST")
+            expect(duty_calculation.total_charges.sales_tax.amount.value.class).to eq(Float)
+          end
         end
       end
     end

data/spec/duty_calculator/response_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module DutyCalculator
+  describe Response do
+    context ".initialize" do
+      it "coerces some uglyness" do
+        hash = {
+            "string_value" => "stringerific",
+            "__content__" => "should_be_string",
+            "nested_integer" => {
+                "__content__" => "1223"
+            },
+            "nested_zero" => {
+                "__content__" => "0"
+            }
+        }
+        response = DutyCalculator::Response.new(hash)
+        expect(response["string_value"].class).to eq(String)
+        expect(response.keys.include?("value")).to eq(true)
+        expect(response.keys.include?("__content__")).to_not eq(true)
+        expect(response["value"].class).to eq(String)
+        expect(response["nested_integer"]["value"].class).to eq(Float)
+        expect(response["nested_zero"]["value"].class).to eq(Float)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,10 +5,14 @@ require "duty_calculator"
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+ABS_PATH = File.expand_path(File.dirname(File.dirname(__FILE__)))
+Dir[File.join(ABS_PATH, "spec/support/**/*.rb")].each {|f| require f}
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.raise_errors_for_deprecations!
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

data/spec/support/vcr.rb

@@ -0,0 +1,16 @@
+require 'vcr'
+require 'webmock'
+
+VCR.configure do |c|
+  c.cassette_library_dir  = File.join(ABS_PATH, "spec", "vcr")
+  c.hook_into :webmock
+  c.ignore_hosts '127.0.0.1', 'localhost'
+end
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.around(:each, :vcr) do |example|
+    name = example.metadata[:full_description].split(/\s+/, 2).join("/").underscore.gsub(/[^\w\/]+/, "_")
+    VCR.use_cassette( name, :record => :new_episodes, :match_requests_on => [:query] ) { example.call }
+  end
+end

data/spec/vcr/calculate__nice_hash_for_multiple_products.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.dutycalculator.com/api2.1/sandbox/DUTY_CALC/calculation?cat%5B%5D=522&cat%5B%5D=522&classify_by=cat&commercial_importer=0&country_of_hs_code%5B%5D=CN&country_of_hs_code%5B%5D=DE&currency=USD&desc%5B%5D=Hydrotherapy%20Spa%20Bath&desc%5B%5D=Hydrotherapy%20Spa%20Bath&detailed_result=1&from=US&hs%5B%5D=9019100020&hs%5B%5D=9019100020&incl_hs_codes=1&insurance=0.0&origin=US&preferential_rates=0&qty%5B%5D=1&qty%5B%5D=2&reference=ORD12345&shipping=10.0&shipping_mode=USPS&sku%5B%5D=300101&sku%5B%5D=300102&to=CA&value%5B%5D=1234.00&value%5B%5D=2345.67&weight%5B%5D=1.0&weight%5B%5D=2.0&weight_unit%5B%5D=lb&weight_unit%5B%5D=lb
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.6.1
+      Date:
+      - Mon, 30 Mar 2015 23:38:08 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.5.9-1ubuntu4.5
+      Set-Cookie:
+      - DebugLevel=0; expires=Wed, 29-Apr-2015 23:38:02 GMT; Max-Age=2592000; path=/
+      - PHPSESSID=r063q1h863c4k1590p9n4fbsm0; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+    body:
+      encoding: UTF-8
+      string: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<duty-calculation id=\"191674998\">\n\t<item
+        id=\"522\" hs-code=\"9019100020\" reference=\"0\" quality-score=\"validated\">\n\t\t<customs-value
+        name=\"FOB\">\n\t\t\t<amount currency=\"CAD\">1556</amount>\n\t\t</customs-value>\n\t\t<duty>\n\t\t\t<amount
+        currency=\"CAD\">0</amount>\n\t\t</duty>\n\t\t<sales-tax name=\"GST\">\n\t\t\t<amount
+        currency=\"CAD\">77.8</amount>\n\t\t</sales-tax>\n\t\t<total>\n\t\t\t<amount
+        currency=\"CAD\">77.8</amount>\n\t\t</total>\n\t</item>\n\t<item id=\"522\"
+        hs-code=\"9019100020\" reference=\"1\" quality-score=\"validated\">\n\t\t<customs-value
+        name=\"FOB\">\n\t\t\t<amount currency=\"CAD\">5915.49</amount>\n\t\t</customs-value>\n\t\t<duty>\n\t\t\t<amount
+        currency=\"CAD\">0</amount>\n\t\t</duty>\n\t\t<sales-tax name=\"GST\">\n\t\t\t<amount
+        currency=\"CAD\">295.77</amount>\n\t\t</sales-tax>\n\t\t<total>\n\t\t\t<amount
+        currency=\"CAD\">295.77</amount>\n\t\t</total>\n\t</item>\n\t<total-charges>\n\t\t<customs-value
+        name=\"FOB\">\n\t\t\t<amount currency=\"CAD\">7471.49</amount>\n\t\t</customs-value>\n\t\t<duty>\n\t\t\t<amount
+        currency=\"CAD\">0</amount>\n\t\t</duty>\n\t\t<sales-tax name=\"GST\">\n\t\t\t<amount
+        currency=\"CAD\">373.57</amount>\n\t\t</sales-tax>\n\t\t<total>\n\t\t\t<amount
+        currency=\"CAD\">373.57</amount>\n\t\t</total>\n\t</total-charges>\n</duty-calculation>\n"
+    http_version: 
+  recorded_at: Mon, 30 Mar 2015 23:35:40 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr/calculate__nice_hash_for_single_product.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.dutycalculator.com/api2.1/sandbox/DUTY_CALC/calculation?cat%5B%5D=522&classify_by=cat&commercial_importer=0&country_of_hs_code%5B%5D=CN&currency=USD&desc%5B%5D=Hydrotherapy%20Spa%20Bath&detailed_result=1&from=US&hs%5B%5D=9019100020&hs%5B%5D=9019100020&incl_hs_codes=1&insurance=0.0&origin=US&preferential_rates=0&qty%5B%5D=1&reference=ORD12345&shipping=10.0&shipping_mode=USPS&sku%5B%5D=300101&to=CA&value%5B%5D=1234.00&weight%5B%5D=1.0&weight_unit%5B%5D=lb
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.6.1
+      Date:
+      - Mon, 30 Mar 2015 23:38:04 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.5.9-1ubuntu4.5
+      Set-Cookie:
+      - DebugLevel=0; expires=Wed, 29-Apr-2015 23:37:58 GMT; Max-Age=2592000; path=/
+      - PHPSESSID=39hst3dqjsj0pt69g6tij9j5r0; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+    body:
+      encoding: UTF-8
+      string: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<duty-calculation id=\"191674997\">\n\t<item
+        id=\"522\" hs-code=\"9019100020\" reference=\"0\" quality-score=\"validated\">\n\t\t<customs-value
+        name=\"FOB\">\n\t\t\t<amount currency=\"CAD\">1556</amount>\n\t\t</customs-value>\n\t\t<duty>\n\t\t\t<amount
+        currency=\"CAD\">0</amount>\n\t\t</duty>\n\t\t<sales-tax name=\"GST\">\n\t\t\t<amount
+        currency=\"CAD\">77.8</amount>\n\t\t</sales-tax>\n\t\t<total>\n\t\t\t<amount
+        currency=\"CAD\">77.8</amount>\n\t\t</total>\n\t</item>\n\t<total-charges>\n\t\t<customs-value
+        name=\"FOB\">\n\t\t\t<amount currency=\"CAD\">1556</amount>\n\t\t</customs-value>\n\t\t<duty>\n\t\t\t<amount
+        currency=\"CAD\">0</amount>\n\t\t</duty>\n\t\t<sales-tax name=\"GST\">\n\t\t\t<amount
+        currency=\"CAD\">77.8</amount>\n\t\t</sales-tax>\n\t\t<total>\n\t\t\t<amount
+        currency=\"CAD\">77.8</amount>\n\t\t</total>\n\t</total-charges>\n</duty-calculation>\n"
+    http_version: 
+  recorded_at: Mon, 30 Mar 2015 23:35:36 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duty_calculator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Thomas Hanley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -133,11 +161,16 @@ files:
 - lib/duty_calculator/configuration.rb
 - lib/duty_calculator/currency.rb
 - lib/duty_calculator/error_messages.rb
+- lib/duty_calculator/response.rb
 - lib/duty_calculator/version.rb
 - spec/duty_calculator/calculation_spec.rb
 - spec/duty_calculator/configuration_spec.rb
 - spec/duty_calculator/currency_spec.rb
+- spec/duty_calculator/response_spec.rb
 - spec/spec_helper.rb
+- spec/support/vcr.rb
+- spec/vcr/calculate__nice_hash_for_multiple_products.yml
+- spec/vcr/calculate__nice_hash_for_single_product.yml
 homepage: https://github.com/tjhanley/duty-calculator
 licenses:
 - MIT
@@ -166,4 +199,8 @@ test_files:
 - spec/duty_calculator/calculation_spec.rb
 - spec/duty_calculator/configuration_spec.rb
 - spec/duty_calculator/currency_spec.rb
+- spec/duty_calculator/response_spec.rb
 - spec/spec_helper.rb
+- spec/support/vcr.rb
+- spec/vcr/calculate__nice_hash_for_multiple_products.yml
+- spec/vcr/calculate__nice_hash_for_single_product.yml