duty_calculator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3c4b31932cae832814571496bd4b0507a0454ad
+  data.tar.gz: c840f6489f535e44ba51128efffb1160f36c5aee
+SHA512:
+  metadata.gz: 6d2d67347a93c14d79f75c271c4339f8ee2140bdc5121b36391a34c7fa2b26415f628336dc23d3b1c2e4884753a5229b36da794bfc8133cfae9508bd1e3e6f72
+  data.tar.gz: 43c34e3cb1bc5ad7d6c3135c7664eb0a87ae534b61baf09048b5c143292604f066dc6b842417ef9b7ab77f52396fc30cb7c89dc63cdfb59bdc00d0be11a9357a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format doc
+--profile
+--drb

data/.travis.yml

@@ -0,0 +1,16 @@
+before_install:
+  - gem install bundler
+
+notifications:
+  email: false
+
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - 2.1.1
+ - 2.1.2
+ - ruby-head
+ - jruby
+
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in duty_calculator.gemspec
+gemspec
+gem 'rspec', :require => 'spec'
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'multi_xml'
+gem 'addressable'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Hanley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+![Travis CI](https://travis-ci.org/WalkerAndCoBrandsInc/duty-calculator.svg?branch=develop)
+# DutyCalculator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'duty_calculator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install duty_calculator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/duty_calculator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r duty_calculator -I ./lib"
+end

data/duty_calculator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duty_calculator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "duty_calculator"
+  spec.version       = DutyCalculator::VERSION
+  spec.authors       = ["Thomas Hanley"]
+  spec.email         = ["tom@walkerandcompany.com"]
+  spec.summary       = %q{Wrapper for dutycalculator.com}
+  spec.description   = %q{API documentation http://www.dutycalculator.com/api-center/dutycalculator-api-2-1-documentation/}
+  spec.homepage      = "https://github.com/tjhanley/duty-calculator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_runtime_dependency "hashie", "~> 2.1"
+  spec.add_runtime_dependency "multi_xml", "~> 0.5"
+  spec.add_runtime_dependency "addressable", "~> 2.3"
+end

data/lib/config/defaults.yml

@@ -0,0 +1,4 @@
+:api_root: http://www.dutycalculator.com/
+:api_version: api2.1
+:sandbox: false
+:debug: false

data/lib/duty_calculator.rb

@@ -0,0 +1,27 @@
+require "duty_calculator/version"
+require "duty_calculator/configuration"
+require "duty_calculator/currency"
+require "duty_calculator/category"
+require "duty_calculator/calculation"
+require "duty_calculator/error_messages"
+
+require "faraday"
+require "faraday_middleware"
+
+module DutyCalculator
+  class << self
+    attr_writer :configuration
+
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/duty_calculator/calculation.rb

@@ -0,0 +1,57 @@
+require "duty_calculator/client"
+require "addressable/uri"
+module DutyCalculator
+  class Calculation
+    class << self
+      def validate_params(params)
+        required = %w{from to province shipping_mode commercial_importer imported_wt imported_value classify_by shipping
+                      insurance currency preferential_rates detailed_result incl_hs_codes cat hs country_of_hs_code desc
+                      sku value weight qty origin reference}
+        msg = []
+        required.each do |r|
+          msg << r unless params.has_key?(r)
+        end
+        raise ArgumentError, "Missing arguments from hash #{msg.to_s}" if msg.size
+        return params
+      end
+    end
+
+=begin
+# https://docs.google.com/a/walkerandcobrands.com/document/d/16e_lh7MIjLGYvS_qZL7pUzOvTVte-cqTnr4jGo_VtIM/pub
+# from={ISO  alpha-3 country code or alpha-2 country code} \
+# &to={ISO  alpha-3 country code or alpha-2 country code} \
+# &province={ISO alpha-2 province code of ‘importing to’ country (only required for Canada and Brazil)} \
+# &shipping_mode={shipping mode} \
+# &commercial_importer={importer status (only required for Russia)} \
+# &imported_wt={total weight of products imported during the month (only required for Russia)} \
+# &imported_value={total value of products imported during the month (only required for Russia)} \
+# &classify_by={items classification identifier} \
+# &cat[0]={item ID or category ID} \
+# &hs[0]={item HS code} \
+# &country_of_hs_code[0]={ISO  alpha-3 country code or alpha-2 country code} \
+# &desc[0]={product description} \
+# &sku[0]={item sku } \
+# &value[0]={value per one item} \
+# &weight[0]={weight of one item} \
+# &qty[0]={item quantity} \
+# &origin[0]={ISO alpha-3 country code or alpha-2 country code} \
+# &reference[0]={product reference}  \
+# &shipping={shipping cost} \
+# &insurance={cost of insurance} \
+# &currency={ISO currency code} \preferential&output_currency={ISO currency code} \
+# &preferential_rates={1 to apply FTA and preferential rates, 0 to ignore FTA and preferential rates} \
+# &detailed_result={1 for detailed result, 0 for short result} \
+# &incl_hs_codes={include HS code for each item in response}
+#
+=end
+    def self.get(params={})
+
+      uri = Addressable::URI.new
+      uri.query_values = validate_params(params)
+
+      conn = DutyCalculator::Client.new
+      conn.get "#{DutyCalculator::Client.api_base}/calculation"
+    end
+  end
+end
+

data/lib/duty_calculator/category.rb

@@ -0,0 +1,10 @@
+require "duty_calculator/client"
+
+module DutyCalculator
+  class Category
+    def self.list_all
+      conn = DutyCalculator::Client.new
+      conn.get "#{DutyCalculator::Client.api_base}/categories"
+    end
+  end
+end

data/lib/duty_calculator/client.rb

@@ -0,0 +1,29 @@
+require 'duty_calculator'
+module DutyCalculator
+  class Client
+    def self.new
+      ::Faraday.new(url: DutyCalculator.configuration.api_root) do |faraday|
+        # middleware
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.use FaradayMiddleware::EncodeJson
+        # request defs
+        faraday.use Faraday::Request::UrlEncoded
+        # response defs
+        faraday.use Faraday::Response::ParseXml
+        faraday.use Faraday::Response::Mashify
+        faraday.use Faraday::Response::RaiseError unless DutyCalculator.configuration.debug
+        faraday.response :logger if DutyCalculator.configuration.debug
+
+        faraday.adapter ::Faraday.default_adapter
+      end
+    end
+
+    def self.api_base
+      if DutyCalculator.configuration.sandbox
+        return "#{DutyCalculator.configuration.api_version}/sandbox/#{DutyCalculator.configuration.api_key}"
+      else
+        return "#{DutyCalculator.configuration.api_version}/#{DutyCalculator.configuration.api_key}"
+      end
+    end
+  end
+end

data/lib/duty_calculator/configuration.rb

@@ -0,0 +1,24 @@
+require "yaml"
+
+require "duty_calculator"
+
+module DutyCalculator
+  class Configuration
+    attr_accessor :api_root, :api_version, :api_key, :api_base, :sandbox, :debug
+
+    def initialize
+      defaults = load_defaults
+      @api_root = defaults[:api_root]
+      @api_version = defaults[:api_version]
+
+      @sandbox = defaults[:sandbox]
+
+      @debug = defaults[:debug]
+    end
+
+    private
+    def load_defaults
+      YAML.load_file(File.join(File.dirname(__FILE__),'..','config','defaults.yml'))
+    end
+  end
+end

data/lib/duty_calculator/currency.rb

@@ -0,0 +1,10 @@
+require "duty_calculator/client"
+
+module DutyCalculator
+  class Currency
+    def self.list_all
+      conn = DutyCalculator::Client.new
+      conn.get "#{DutyCalculator::Client.api_base}/supported-currencies"
+    end
+  end
+end

data/lib/duty_calculator/error_messages.rb

@@ -0,0 +1,54 @@
+require "duty_calculator/client"
+
+module DutyCalculator
+  class ErrorMessages
+    ERRORS = {"4042" => "Specified API key could not be used with API 2.1",
+              "4043" => "This API key is for sandbox access only",
+              "4044" => "Request URI is invalid",
+              "4045" => "Access denied to the specified calculation. It belongs to a different user.",
+              "4046" => "Client id is invalid or missing",
+              "4061" => "Account does not support called service: Classification service - get HS codes, duty & tax rates and import restrictions",
+              "4062" => "Account does not support called service: Documents service",
+              "4063" => "Account does not support called operation: Classification service - get DutyCalculator item ID",
+              "4064" => "Account does not support called operation: Reporting service","4401" => "Parameter is missing",
+              "4421" => "Bad parameter: shipping cost can't be empty",
+              "4422" => "Bad parameter: shipment weight can't be empty",
+              "4423" => "Bad parameter: imported weight can't be empty",
+              "4424" => "Bad parameter: imported value can't be empty",
+              "4425" => "Bad parameter: insurance value can't be empty",
+              "4426" => "Bad parameter: both category and description for reference <product reference> can't be empty",
+              "4427" => "Bad parameter: SKU for reference <product reference> can't be empty",
+              "4428" => "Bad parameter: HS code for reference <product reference> can't be empty",
+              "4429" => "Bad parameter: description for reference <product reference> can't be empty","4701" => "Bad parameter: <parameter name> is invalid",
+              "4721" => "Classification for the selected import to country is not possible",
+              "4722" => "Bad parameter: country from code",
+              "4723" => "Bad parameter: country to code",
+              "4724" => "Bad parameter: country province to code",
+              "4725" => "Bad parameter: currency code",
+              "4726" => "Bad parameter: output currency code",
+              "4727" => "Bad parameter: importer status",
+              "4728" => "Bad parameter: products count is zero",
+              "4729" => "Bad parameter: values count is not equal with products count",
+              "4730" => "Bad parameter: DutyCalculator Item ID for reference <product reference> is invalid",
+              "4731" => "Bad parameter: quantity for reference <product reference>  is invalid",
+              "4732" => "Bad parameter: weight for reference <product reference> is invalid",
+              "4733" => "Bad parameter: amount for reference <product reference>  is invalid",
+              "4734" => "Bad parameter: amount unit for reference <product reference> should be one of the following: pcs, doz, gr",
+              "4735" => "Bad parameter: country of origin",
+              "4736" => "Bad parameter: classify_by",
+              "4737" => "Bad parameter: not all SKU stock keeping units have been classified",
+              "4738" => "Bad parameter: HS code for reference <product reference> could not be matched. Please file classification request",
+              "4739" => "Bad parameter: duty calculation id",
+              "4740" => "Bad parameter: internal order id",
+              "4741" => "Bad parameter: internal shipment id",
+              "4742" => "Bad parameter: internal credit note id",
+              "4743" => "Bad parameter: order type",
+              "4745" => "Bad parameter: product reference <product reference> not found",
+              "4746" => "Bad parameter: HS codes count is not equal with descriptions count",
+              "4747" => "Reference <product reference> could not be autoclassified",
+              "4755" => "Bad parameter: shipping mode is invalid"}
+    def self.for_code(code)
+      ERRORS[code]
+    end
+  end
+end

data/lib/duty_calculator/version.rb

@@ -0,0 +1,3 @@
+module DutyCalculator
+  VERSION = "0.0.1"
+end

data/spec/duty_calculator/configuration_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module DutyCalculator
+  describe Configuration do
+    let(:api_root) {'http://www.dutycalculator.com/'}
+    let(:api_version) {'api2.1'}
+    let(:sandbox) {'true'}
+    let(:debug) {'true'}
+
+    describe 'has defaults' do
+      it 'should default value' do
+        expect(Configuration.new.api_root).to eq(api_root)
+        expect(Configuration.new.api_version).to eq(api_version)
+      end
+    end
+    describe 'can override defaults' do
+      it 'can set value' do
+        config = Configuration.new
+        config.api_root = api_root
+        config.api_version = api_version
+        config.sandbox = sandbox
+        config.debug = debug
+
+        expect(config.api_root).to eq(api_root)
+        expect(config.api_version).to eq(api_version)
+        expect(config.sandbox).to eq(sandbox)
+        expect(config.debug).to eq(debug)
+      end
+    end
+  end
+end

data/spec/duty_calculator/currency_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module DutyCalculator
+  describe Currency do
+    describe '#list_all' do
+      pending "need to mock out endpoint"
+      it 'can gets xml' do
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "duty_calculator"
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # 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
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: duty_calculator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Hanley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: API documentation http://www.dutycalculator.com/api-center/dutycalculator-api-2-1-documentation/
+email:
+- tom@walkerandcompany.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- duty_calculator.gemspec
+- lib/config/defaults.yml
+- lib/duty_calculator.rb
+- lib/duty_calculator/calculation.rb
+- lib/duty_calculator/category.rb
+- lib/duty_calculator/client.rb
+- lib/duty_calculator/configuration.rb
+- lib/duty_calculator/currency.rb
+- lib/duty_calculator/error_messages.rb
+- lib/duty_calculator/version.rb
+- spec/duty_calculator/configuration_spec.rb
+- spec/duty_calculator/currency_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tjhanley/duty-calculator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for dutycalculator.com
+test_files:
+- spec/duty_calculator/configuration_spec.rb
+- spec/duty_calculator/currency_spec.rb
+- spec/spec_helper.rb