shippo 1.0.4 → 2.0.0

data/lib/shippo/api/transformers/list.rb

@@ -0,0 +1,73 @@
+require 'active_support/inflector'
+module Shippo
+  module API
+    module Transformers
+      # List Transformer: if it finds a key named like 'rates_list' it converts it
+      # to another member 'rates' containing equivalent list of object instances of
+      # the corresponding type, in the example above – Shippo::Rate.
+      class List
+        attr_accessor :h
+
+        # Matchers receive a key as a parameter, and they extract a candidate word to be
+        # tried in Coercing the values of the array to an object. For example, it could be
+        # "shipments" or "rates_list" or "items".
+        #
+        # They are tried in order they are defined.
+
+        MATCHERS = [
+          ->(key) {
+            case key.to_sym
+              when :items
+                :customs_items
+              else
+                nil
+            end
+          },
+
+          ->(key) {
+            reg = /^([\w_]+)_list$/
+            reg.match(key.to_s) ? reg.match(key.to_s)[1] : nil
+          },
+
+          ->(key) {
+            reg = /^([\w_]+s)$/
+            reg.match(key.to_s) ? reg.match(key.to_s)[1] : nil
+          }
+        ]
+
+        def initialize(hash)
+          self.h = hash
+        end
+
+        def transform
+          h.keys.each { |k| h[k].is_a?(Array) && !h[k].empty? }.each do |list_key|
+            type, *values = transform_list(list_key, h[list_key])
+            h[list_key]   = values if type
+          end
+        end
+
+        private
+
+        def detect_type_class(model_name)
+          type = model_name.to_s.singularize.camelize
+          "Shippo::#{type}".constantize rescue nil
+        end
+
+        def detect_type_name(list_key)
+          results = MATCHERS.map { |m| m.call(list_key) }.compact
+          results.is_a?(Array) && results.size > 0 ? results.first : nil
+        end
+
+        def transform_list(list_key, array)
+          if (type_name = detect_type_name(list_key)) &&
+            (type_class = detect_type_class(type_name))
+            type_array = array.map { |item| type_class.from(item) }
+            return type_name, *type_array
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shippo/api/version.rb

@@ -0,0 +1,5 @@
+module Shippo
+  module API
+    VERSION = '2.0.0'
+  end
+end

data/lib/shippo/exceptions.rb

@@ -0,0 +1,7 @@
+module Shippo
+  module Exceptions
+  end
+end
+
+require 'shippo/exceptions/error'
+Shippo.dir('shippo/exceptions')

data/lib/shippo/exceptions/api_error.rb

@@ -0,0 +1,20 @@
+class Shippo::Exceptions::APIError < ::Shippo::Exceptions::Error
+  attr_accessor :message, :req
+  def initialize(message = nil, req = nil)
+    super(message)
+    self.req = req
+  end
+
+  def to_s
+    "#{self.class.name} ⇨ #{req.url}#{response} ⇨ #{message}"
+  end
+
+  def response
+    req.response && req.response.http_code ? "[ ⇨ HTTP #{req.response.http_code} ]" : ''
+  end
+end
+
+class Shippo::Exceptions::UnsuccessfulResponseError < Shippo::Exceptions::APIError; end
+class Shippo::Exceptions::APIServerError < Shippo::Exceptions::APIError; end
+class Shippo::Exceptions::InvalidCategoryValueError < Shippo::Exceptions::APIError; end
+

data/lib/shippo/exceptions/error.rb

@@ -0,0 +1,22 @@
+class Shippo::Exceptions::Error < StandardError
+  attr_accessor :message
+
+  def initialize(thing = nil)
+    if thing.is_a?(String)
+      self.message = thing
+    elsif thing.respond_to?(:message)
+      self.message = thing.message
+    else
+      super(thing)
+    end
+  end
+
+  def to_s
+    "BOOM! ⇨ #{message}"
+  end
+end
+
+class Shippo::Exceptions::ConnectionError < Shippo::Exceptions::Error; end
+class Shippo::Exceptions::AuthenticationError < Shippo::Exceptions::Error; end
+class Shippo::Exceptions::MissingDataError < Shippo::Exceptions::Error; end
+class Shippo::Exceptions::AbstractClassInitError < Shippo::Exceptions::Error; end

data/lib/shippo/model/address.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Address < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end

data/lib/shippo/model/carrieraccount.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class CarrierAccount < ::Shippo::API::Resource
+    operations :list, :create, :update
+  end
+end

data/lib/shippo/model/customs_declaration.rb

@@ -0,0 +1,6 @@
+module Shippo
+  class CustomsDeclaration < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end
+

data/lib/shippo/model/customs_item.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class CustomsItem < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end

data/lib/shippo/model/manifest.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Manifest < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end

data/lib/shippo/model/parcel.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Parcel < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end

data/lib/shippo/model/rate.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Rate < ::Shippo::API::Resource
+    operations :list
+  end
+end

data/lib/shippo/model/refund.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Refund < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end

data/lib/shippo/model/shipment.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Shipment < ::Shippo::API::Resource
+    operations :list, :create, :rates
+  end
+end

data/lib/shippo/model/transaction.rb

@@ -0,0 +1,5 @@
+module Shippo
+  class Transaction < ::Shippo::API::Resource
+    operations :list, :create
+  end
+end

data/lib/shippo/tasks/shippo.rb

@@ -0,0 +1,22 @@
+require 'yard'
+require 'yard/rake/yardoc_task'
+require 'rake/application'
+require 'fileutils'
+# Main namespace for Shippo specific Rake tasks
+
+module Shippo
+  DOC_FOLDER = 'doc'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w(lib/**/*.rb - README.md CHANGELOG.md)
+end
+
+namespace :doc do
+  desc 'Generate API documentation and preview in browser'
+  task :read do
+    FileUtils.rm_rf([::Shippo::DOC_FOLDER])
+    Rake.application.invoke_task('yard')
+    Kernel.system("open #{::Shippo::DOC_FOLDER}/index.html")
+  end
+end

data/shippo.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shippo/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'shippo'
+  spec.version               = Shippo::API::VERSION
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.summary               = 'API client for Shippo® APIs. Shippo helps you connect with multiple carriers (FedEx, UPS, USPS and many others) via a unified modern API'
+  spec.description           = 'A gem for connecting with over 20 shipping carriers and consolidators via a single integration using Shippo API. Support for shipping rates, buying and printing labels, tracking as well as some carrier specific functionality such as signature required, adult signature confirmation, certified mail, delivery confirmation and many others.'
+  spec.authors               = ['Shippo & Contributors', 'Konstantin Gredeskoul']
+  spec.email                 = %w(support@goshippo.com kigster@gmail.com)
+  spec.files                 =  `git ls-files`.split($\).reject{ |f| f.match(%r{^(doc|spec)/}) }
+  spec.homepage              = 'http://github.com/goshippo/shippo-ruby-client'
+  spec.license               = 'MIT'
+  spec.metadata              = { 'shippo_documentation' => 'https://goshippo.com/docs/' }
+
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'mime-types', '~> 2'
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'hashie', '~> 3.4'
+  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_dependency 'colored2'
+  spec.add_dependency 'require_dir'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shippo
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Shippo & Contributors
+- Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,78 +17,262 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: colored2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
-    - - "<"
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_dir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :runtime
+        version: '3.4'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
-description: Quick and easy access to the Shippo API
-email: support@goshippo.com
+        version: '3.4'
+description: A gem for connecting with over 20 shipping carriers and consolidators
+  via a single integration using Shippo API. Support for shipping rates, buying and
+  printing labels, tracking as well as some carrier specific functionality such as
+  signature required, adult signature confirmation, certified mail, delivery confirmation
+  and many others.
+email:
+- support@goshippo.com
+- kigster@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- "./lib/shippo/address.rb"
-- "./lib/shippo/api_object.rb"
-- "./lib/shippo/carrieraccount.rb"
-- "./lib/shippo/container_object.rb"
-- "./lib/shippo/create.rb"
-- "./lib/shippo/customs_declaration.rb"
-- "./lib/shippo/customs_item.rb"
-- "./lib/shippo/error.rb"
-- "./lib/shippo/list.rb"
-- "./lib/shippo/manifest.rb"
-- "./lib/shippo/parcel.rb"
-- "./lib/shippo/rate.rb"
-- "./lib/shippo/refund.rb"
-- "./lib/shippo/resource.rb"
-- "./lib/shippo/shipment.rb"
-- "./lib/shippo/transaction.rb"
-- "./lib/shippo/update.rb"
-- example.rb
+- ".atom-build.json"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/example
 - lib/shippo.rb
-- test/test.rb
-homepage: http://goshippo.com
+- lib/shippo/api.rb
+- lib/shippo/api/api_object.rb
+- lib/shippo/api/category.rb
+- lib/shippo/api/category/base.rb
+- lib/shippo/api/category/purpose.rb
+- lib/shippo/api/category/source.rb
+- lib/shippo/api/category/state.rb
+- lib/shippo/api/category/status.rb
+- lib/shippo/api/extend/operation.rb
+- lib/shippo/api/extend/transformers.rb
+- lib/shippo/api/extend/url.rb
+- lib/shippo/api/operations.rb
+- lib/shippo/api/operations/create.rb
+- lib/shippo/api/operations/list.rb
+- lib/shippo/api/operations/rates.rb
+- lib/shippo/api/operations/update.rb
+- lib/shippo/api/operations/validate.rb
+- lib/shippo/api/request.rb
+- lib/shippo/api/resource.rb
+- lib/shippo/api/transformers/list.rb
+- lib/shippo/api/version.rb
+- lib/shippo/exceptions.rb
+- lib/shippo/exceptions/api_error.rb
+- lib/shippo/exceptions/error.rb
+- lib/shippo/model/address.rb
+- lib/shippo/model/carrieraccount.rb
+- lib/shippo/model/customs_declaration.rb
+- lib/shippo/model/customs_item.rb
+- lib/shippo/model/manifest.rb
+- lib/shippo/model/parcel.rb
+- lib/shippo/model/rate.rb
+- lib/shippo/model/refund.rb
+- lib/shippo/model/shipment.rb
+- lib/shippo/model/transaction.rb
+- lib/shippo/tasks/shippo.rb
+- shippo.gemspec
+homepage: http://github.com/goshippo/shippo-ruby-client
 licenses:
 - MIT
-metadata: {}
+metadata:
+  shippo_documentation: https://goshippo.com/docs/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -96,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -104,8 +289,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Shippo API
+summary: API client for Shippo® APIs. Shippo helps you connect with multiple carriers
+  (FedEx, UPS, USPS and many others) via a unified modern API
 test_files: []