easyship-rates-ruby-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 175eacb565636cc6b781053822beecfa8e7fb274
+  data.tar.gz: e0c738c96f7c98ece8dae119033803340beea7a2
+SHA512:
+  metadata.gz: 726b84aa0df2a24ee31e0588bba6c2f354c2b1f15a823d6d5390c7d4fd66e72c0c66e0f35a6f5d281db9ee9f7ea7e4aeb98bd6a99041fd1847713f41d949e960
+  data.tar.gz: 7314dff470e1d06684f6377257c7a795617ada837ef8f4a6e38aef55f3a629ac2ea55cb13decc259acad149042b6ac456713043f3bbe2c2626ddbe615647e041

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.ruby-version

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easyship-rates-ruby-api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,67 @@
+# EasyshipRatesRubyApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easyship-rates-ruby-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easyship-rates-ruby-api
+
+## Usage
+
+Create a file:
+
+**config/initializers/easyship_rate_ruby_api.rb**
+
+```ruby
+require 'easyship_rates_ruby_api'
+EasyshipRatesRubyApi.configure do |config|
+  config.uid = 'RATE_CALCULATOR_APPID'
+  config.secret = 'RATE_CALCULATOR_SECRET'
+end
+```
+
+### Get Rate
+
+```ruby
+client = EasyshipRatesRubyApi::Client.new
+client.get_token
+client.get_rate(length: 1, width: 1, height: 1, origin_country_id: 96, destination_country_id: 199, total_actual_weight: 1)
+```
+
+
+### Get All Rates
+
+```ruby
+client = EasyshipRatesRubyApi::Client.new
+client.get_token
+params = {
+    origin_country_id: 96,
+    destination_country_id: 199,
+    is_insured: true,
+    items: [
+      { category_id: 1, actual_weight: 30, length: 1, width: 1, height: 1, declared_customs_value: 100, declared_currency: 'HKD' }
+    ]
+  }
+client.get_all_rates(params)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/easyship/easyship-rates-ruby-api.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easyship/rates/ruby/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easyship-rates-ruby-api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easyship/rates/ruby/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'easyship-rates-ruby-api'
+  spec.version       = EasyshipRatesRubyApi::Version::STRING
+  spec.authors       = ['aloha']
+  spec.email         = ['y.alohac@gmail.com']
+
+  spec.summary       = 'Ruby API for Rate Calculator'
+  spec.description   = 'Ruby API for Rate Calculator'
+  spec.homepage      = 'https://github.com/easyship/easyship-rates-ruby-api'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'oauth2', '~> 1.2'
+  spec.add_dependency 'hashie', '~> 3.4'
+  spec.add_dependency 'multi_json', '~> 1.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/easyship/rates/ruby/api/api.rb

@@ -0,0 +1,6 @@
+module EasyshipRatesRubyApi
+  module Api
+    autoload :QueryHelpers, 'easyship/rates/ruby/api/api/query_helpers'
+    autoload :Rates, 'easyship/rates/ruby/api/api/rates'
+  end
+end

data/lib/easyship/rates/ruby/api/api/query_helpers.rb

@@ -0,0 +1,15 @@
+module EasyshipRatesRubyApi
+  module Api
+    module QueryHelpers
+      private
+
+      def simple_query(path, options = {})
+        headers = options.delete(:headers) || {}
+        params  = to_query(options)
+        path   += "#{path.include?('?') ? '&' : '?'}#{params}" if !params.empty?
+
+        Mash.from_json(get(path, headers))
+      end
+    end
+  end
+end

data/lib/easyship/rates/ruby/api/api/rates.rb

@@ -0,0 +1,46 @@
+module EasyshipRatesRubyApi
+  module Api
+    # Rate API
+    #
+    # @see https://github.com/easyship/easyship-rates Rate API
+    #
+    # [(contribute here)](https://github.com/easyship/easyship-rates-ruby-api)
+    module Rates
+      # Retrieve a Rate
+      #
+      # @param [Hash] options the options to get rate.
+      # @option options [String] :length length
+      # @option options [String] :width width
+      # @option options [String] :height height
+      # @option options [String] :origin_country_id origin_country_id
+      # @option options [String] :destination_country_id destination_country_id
+      # @option options [String] :total_actual_weight total_actual_weight
+      # @return [Easyship::Rates::Ruby::Mash]
+      def get_rate(options = {})
+        path = '/get_rates'
+        simple_query(path, options)
+      end
+
+      # Retrieve all detailed Rate
+      # @param [Hash] options the options to get rate.
+      # @option options [String] :origin_country_id
+      # @option options [String] :destination_country_id
+      # @option options [String] :is_insured
+      # @option options [Array<Hash>]  :items
+      # @param [Hash] items the options to item detail.
+      # @option items   [String] :category_id
+      # @option items   [String] :actual_weight
+      # @option items   [String] :length
+      # @option items   [String] :width
+      # @option items   [String] :height
+      # @option items   [String] :declared_customs_value
+      # @option items   [String] :declared_currency
+      # @return [Easyship::Rates::Ruby::Mash]
+      def get_all_rates(options = {})
+        path = '/get_all_rates'
+        defaults = {}
+        Mash.from_json(post(path, defaults.merge(options)).body)
+      end
+    end
+  end
+end

data/lib/easyship/rates/ruby/api/client.rb

@@ -0,0 +1,19 @@
+require 'cgi'
+
+module EasyshipRatesRubyApi
+  class Client
+    include Helpers::Request
+    include Helpers::Authorization
+    include Api::QueryHelpers
+    include Api::Rates
+
+    attr_reader :client_token, :client_secret, :client_options
+
+    def initialize(cuid = EasyshipRatesRubyApi.uid, csecret = EasyshipRatesRubyApi.secret, options = {})
+      @client_uid     = cuid
+      @client_secret  = csecret
+      raise EasyshipRatesRubyApi::Errors::ArgumentMissingError.new('please provide uid and secret') unless @client_uid && @client_secret
+      @client_options = options
+    end
+  end
+end

data/lib/easyship/rates/ruby/api/errors.rb

@@ -0,0 +1,32 @@
+module EasyshipRatesRubyApi
+  module Errors
+    class RateCalculatorError < StandardError
+      attr_reader :data
+      def initialize(data)
+        @data = data
+        super
+      end
+    end
+
+
+    class ArgumentMissingError   < StandardError; end
+
+    # Raised when a 401 response status code is received
+    class UnauthorizedError      < RateCalculatorError; end
+
+    # Raised when a 400 response status code is received
+    class GeneralError           < RateCalculatorError; end
+
+    # Raised when a 403 response status code is received
+    class AccessDeniedError      < RateCalculatorError; end
+
+    # Raised when a 404 response status code is received
+    class NotFoundError          < StandardError; end
+
+    # Raised when a 500 response status code is received
+    class InformRateCalculatorError    < StandardError; end
+
+    # Raised when a 502 or 503 response status code is received
+    class UnavailableError       < StandardError; end
+  end
+end

data/lib/easyship/rates/ruby/api/helpers.rb

@@ -0,0 +1,6 @@
+module EasyshipRatesRubyApi
+  module Helpers
+    autoload :Authorization, 'easyship/rates/ruby/api/helpers/authorization'
+    autoload :Request,       'easyship/rates/ruby/api/helpers/request'
+  end
+end

data/lib/easyship/rates/ruby/api/helpers/authorization.rb

@@ -0,0 +1,45 @@
+module EasyshipRatesRubyApi
+  module Helpers
+    module Authorization
+
+      DEFAULT_OAUTH_OPTIONS = {
+        staging_api_host: 'http://52.71.247.119',
+        production_api_host: '',
+        token_url: '/oauth2/token'
+      }
+
+      def client
+        @client ||= ::OAuth2::Client.new(@client_uid, @client_secret, parse_oauth_options)
+      end
+
+      def get_token(params = {})
+        @access_token ||= client.assertion.get_token(build_param(params))
+      end
+
+      def access_token
+        @access_token
+      end
+
+      private
+
+      # Since Rate Calculator using `/oauth2/token` instead of `/oauth/token`
+      def parse_oauth_options
+        {
+          site: @client_options[:site] || @client_options[:api_host] || (EasyshipRatesRubyApi.sandbox ? DEFAULT_OAUTH_OPTIONS[:staging_api_host] : DEFAULT_OAUTH_OPTIONS[:production_api_host]),
+          token_url: @client_options[:token_url] || DEFAULT_OAUTH_OPTIONS[:token_url]
+        }
+      end
+
+      def build_param(client_params)
+        {
+          iss: @client_uid,
+          aud: 'https://www.easyship-rate-calculator.com/oauth2/token',
+          prn: @client_uid,
+          exp: Time.now.to_i + 3600,
+          private_key: OpenSSL::PKey::RSA.new(@client_secret),
+          scope: 'get_rate get_all_rate me'
+        }.merge(client_params)
+      end
+    end
+  end
+end

data/lib/easyship/rates/ruby/api/helpers/request.rb

@@ -0,0 +1,66 @@
+module EasyshipRatesRubyApi
+  module Helpers
+    module Request
+
+      API_PATH = '/v1'
+
+      DEFAULT_HEADERS = {}
+
+      protected
+
+      def get(path, options = {})
+        response = access_token.get("#{API_PATH}#{path}", DEFAULT_HEADERS.merge(options))
+        raise_errors(response)
+        response.body
+      end
+
+      def post(path, options = {})
+        response = access_token.post("#{API_PATH}#{path}", { body: options })
+        raise_errors(response)
+        response
+      end
+
+      private
+
+      def raise_errors(response)
+        case response.status.to_i
+        when 401
+          data = Mash.from_json(response.body)
+          raise EasyshipRatesRubyApi::Errors::UnauthorizedError.new(data), "(#{data.status}): #{data.message}"
+        when 400
+          data = Mash.from_json(response.body)
+          raise EasyshipRatesRubyApi::Errors::GeneralError.new(data), "(#{data.status}): #{data.message}"
+        when 403
+          data = Mash.from_json(response.body)
+          raise EasyshipRatesRubyApi::Errors::AccessDeniedError.new(data), "(#{data.status}): #{data.message}"
+        when 404
+          raise EasyshipRatesRubyApi::Errors::NotFoundError, "(#{response.code}): #{response.message}"
+        when 500
+          raise EasyshipRatesRubyApi::Errors::InformRateCalculatorError, "Rate Calculator had an internal error. Please let them know in the forum. (#{response.code}): #{response.message}"
+        when 502..503
+          raise EasyshipRatesRubyApi::Errors::UnavailableError, "(#{response.code}): #{response.message}"
+        end
+      end
+
+      # Stolen from Rack::Util.build_query
+      def to_query(params)
+        params.map { |k, v|
+          if v.class == Array
+            to_query(v.map { |x| [k, x] })
+          else
+            v.nil? ? escape(k) : "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+          end
+        }.join('&')
+      end
+
+      def to_uri(path, options)
+        uri = URI.parse(path)
+
+        if options && options != {}
+          uri.query = to_query(options)
+        end
+        uri.to_s
+      end
+    end
+  end
+end

data/lib/easyship/rates/ruby/api/mash.rb

@@ -0,0 +1,17 @@
+require 'hashie'
+require 'multi_json'
+
+module EasyshipRatesRubyApi
+  # The generalized pseudo-object that is returned for all query
+  # requests.
+  class Mash < ::Hashie::Mash
+    # Convert a json string to a Mash
+    #
+    # @param [String] json_string
+    # @return [Easyship::Rates::Ruby::Mash]
+    def self.from_json(json_string)
+      result_hash = ::MultiJson.decode(json_string)
+      new(result_hash)
+    end
+  end
+end

data/lib/easyship/rates/ruby/api/version.rb

@@ -0,0 +1,9 @@
+module EasyshipRatesRubyApi
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    PRE   = nil
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+end

data/lib/easyship_rates_ruby_api.rb

@@ -0,0 +1,34 @@
+require 'oauth2'
+
+module EasyshipRatesRubyApi
+  class << self
+    attr_accessor :uid, :secret, :sandbox
+
+    # config/initializers/easyship_rate_ruby_api.rb (for instance)
+    #
+    # ```ruby
+    # EasyshipRatesRubyApi.configure do |config|
+    #   config.uid = 'uid'
+    #   config.secret = 'secret'
+    #   config.sandbox = true
+    # end
+    # ```
+    # elsewhere
+    #
+    # ```ruby
+    # client = EasyshipRatesRubyApi::Client.new
+    # ```
+    def configure
+      self.sandbox = false
+      yield self
+      true
+    end
+  end
+
+  autoload :Api,     'easyship/rates/ruby/api/api'
+  autoload :Client,  'easyship/rates/ruby/api/client'
+  autoload :Errors,  'easyship/rates/ruby/api/errors'
+  autoload :Helpers, 'easyship/rates/ruby/api/helpers'
+  autoload :Mash,    'easyship/rates/ruby/api/mash'
+  autoload :Version, 'easyship/rates/ruby/api/version'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: easyship-rates-ruby-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aloha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Ruby API for Rate Calculator
+email:
+- y.alohac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easyship-rates-ruby-api.gemspec
+- lib/easyship/rates/ruby/api/api.rb
+- lib/easyship/rates/ruby/api/api/query_helpers.rb
+- lib/easyship/rates/ruby/api/api/rates.rb
+- lib/easyship/rates/ruby/api/client.rb
+- lib/easyship/rates/ruby/api/errors.rb
+- lib/easyship/rates/ruby/api/helpers.rb
+- lib/easyship/rates/ruby/api/helpers/authorization.rb
+- lib/easyship/rates/ruby/api/helpers/request.rb
+- lib/easyship/rates/ruby/api/mash.rb
+- lib/easyship/rates/ruby/api/version.rb
+- lib/easyship_rates_ruby_api.rb
+homepage: https://github.com/easyship/easyship-rates-ruby-api
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby API for Rate Calculator
+test_files: []