shippo 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 105c04ef4d6f5e4b072873aa6bb6f03efad91223
-  data.tar.gz: 8dbddd63351b6e198f23fa7aeedad433ac797d96
+  metadata.gz: 2f9bf9beca739037960540287dff9d9a95ed04b0
+  data.tar.gz: 1dda325c2990112fdea3cc71fcad284a28f8d4a8
 SHA512:
-  metadata.gz: 3a9b9fb339fd6138f6c9d6c62e003d8e1cd3aaf885ca3626bc7936aa5066784fbdfa6a3233ef84f0b04407144811f7b0da550adec95fbf570473625f8f32580e
-  data.tar.gz: 8bf08f6931dd898d0e8516470cb2d8abade37614a425bc782b19132c57cb883844255180443d24cc88631a4239dcd1d4e9f0b7e926e669532280d5ac8ac65e99
+  metadata.gz: 039577c829fecb5a060e9ba366a297162ea8ba5a97e4863203e037fb0b0a9c2911243d9ceedfa0537c3be112b06fffa2bb0629ba710084a49ce0a1e1123e590c
+  data.tar.gz: 2c79359b3e1bd3842cbce98715bf6548226b1a5a3bdf238301ceaacd8d48bc175e33ff3d5911ba7de42660aa7c2d4c41fad64ab10774a800ee6b3ddfa64ba4fe

data/.gitignore

@@ -18,5 +18,4 @@ test/version_tmp
 tmp
 vendor/
 **/.DS_Store
-
 .idea/

data/.travis.yml

@@ -11,6 +11,6 @@ notifications:
     - shippo:JOD4pUgjGlhSJ1s8mNKUTxKB#devcistatus
   email:
     recipients:
-      - kigster@gmail.com
+      - wissam@goshippo.com
     on_success: change
     on_failure: always

data/CHANGELOG.md

@@ -1,12 +1,19 @@
+#### 2.0.4 release, Oct 6th 2016
+ - Rails5 Compatibility via relaxed dependencies
+   - removing mime-types dependency
+   - relaxing activesupport to allow version 5
+ - reorganizing exceptions to enable subclassing with additional parameters and more readable #to_s method
+ - adding bin/console for easy irb-ing 
+
 #### 2.0.3 release, Oct 3rd 2016
 
- * Handled RestClient::BadRequest to show response content
+ - Handled RestClient::BadRequest to show response content
 
 #### 2.0.2 release, Aug 17th 2016
 
- * Removed gem dependency `colored2` as directly decorating object and string was causing Rals Rack to throw errors when users uploaded large files.
- * Fixed url for `CarrierAccount` 
- * README fixes
+ - Removed gem dependency `colored2` as directly decorating object and string was causing Rals Rack to throw errors when users uploaded large files.
+ - Fixed url for `CarrierAccount` 
+ - README fixes
  
 #### 2.0.0-beta  July 7th, 2016
 

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'codeclimate-test-reporter', group: :test, require: nil
 
 # Specify your gem's dependencies in counter-cache.gemspec
 gemspec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/setup'
+require 'shippo'
+
+# 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/example

@@ -22,7 +22,6 @@ require 'awesome_print'
 require 'json'
 
 Shippo::API.token = ENV['SHIPPO_TOKEN']
-Shippo::API.debug = false # set to true for debugging output
 
 # Simple wrapper class to help us print objects to the STDOUT
 class ExampleHelper
@@ -32,12 +31,11 @@ class ExampleHelper
     puts 'OK'
     result
   rescue Exception => e
-    puts 'ERROR'
     raise(e)
   end
 
   def self.dump_object(instance, msg = nil)
-    return unless ENV['SHIPPO_DEBUG']
+    return unless Shippo::API.debug?
     sep
     puts "#{msg.upcase}:" if msg
     puts "\#<#{instance.class.inspect}:0x#{instance.object_id.to_s(16)}> ⇒ "
@@ -101,7 +99,7 @@ begin
     file.puts JSON.dump(shipment.to_hash)
   end
 rescue Shippo::Exceptions::APIServerError => e
-  puts "Server returned an error:\n#{e.inspect}"
+  puts "Server returned an error:\n#{e}"
   exit 3
 rescue Shippo::Exceptions::ConnectionError
   puts 'Error connecting to remote host. Is your Internet working?'

data/lib/shippo/api.rb

@@ -33,12 +33,12 @@ module Shippo
       %i[get put post].each do |method|
         define_method method do |*args|
           uri, params, headers = *args
-          request(method, uri, params || {}, headers || {})
+          self.request(method, uri, params || {}, headers || {})
         end
       end
 
       def debug?
-        Shippo::API.debug
+        self.debug
       end
     end
   end
@@ -47,4 +47,4 @@ end
 Dir[File.dirname(__FILE__) + '/api/*.rb'].each {|file| require file }
 Dir[File.dirname(__FILE__) + '/api/transformers/*.rb'].each {|file| require file }
 Dir[File.dirname(__FILE__) + '/api/extend/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/model/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/model/*.rb'].each {|file| require file }

data/lib/shippo/api/request.rb

@@ -2,6 +2,7 @@ require 'rest_client'
 require 'socket'
 require 'json'
 require 'set'
+require 'awesome_print'
 
 require 'shippo/exceptions'
 
@@ -58,8 +59,15 @@ module Shippo
         rescue ::RestClient::Unauthorized => e
           raise Shippo::Exceptions::AuthenticationError.new(e.message)
 
-        rescue ::JSON::JSONError, ::JSON::ParserError
-          raise Shippo::Exceptions::APIServerError.new('Unable to read data received back from the server', self)
+        rescue ::RestClient::BadRequest => e
+          if e.respond_to?(:response) && e.response.is_a?(RestClient::Response)
+            awesome_print_response(e) if Shippo::API.debug?
+            raise Shippo::Exceptions::APIServerError.new('Backend responded with an error',
+                                                         self, e.response, e.message)
+          end
+
+        rescue ::JSON::JSONError, ::JSON::ParserError => e
+          raise Shippo::Exceptions::InvalidJsonError.new(e.message)
 
         rescue ::RestClient::BadRequest => e
           raise Shippo::Exceptions::InvalidInputError.new(e.inspect)
@@ -81,11 +89,17 @@ module Shippo
       private
 
       def shippo_phone_home
-        payload = {}
+        payload     = {}
         request_url = url
         (method == :get) ? request_url = params_to_url(params, url) : payload = params.to_json
         setup_headers!(headers)
         opts = make_opts!(headers, method, payload, request_url)
+
+        if Shippo::API.debug?
+          puts "\nCLIENT REQUEST:"
+          ap opts
+        end
+
         make_request!(opts)
       end
 
@@ -120,6 +134,17 @@ module Shippo
         )
       end
 
+      def awesome_print_response(e)
+        begin
+          h = JSON.parse(e.response)
+          if h
+            puts "\nSERVER RESPONSE:"
+            ap JSON.parse(e.response)
+          end
+        rescue nil
+        end
+      end
+
       def base
         ::Shippo::API.base
       end
@@ -129,7 +154,7 @@ module Shippo
       end
 
       def connection_error_message(url, error)
-%Q[Could not connect to the Shippo API, via URL
+        %Q[Could not connect to the Shippo API, via URL
   #{url}.
 
 Please check your Internet connection, try again, if the problem

data/lib/shippo/api/version.rb

@@ -1,5 +1,5 @@
 module Shippo
   module API
-    VERSION = '2.0.3'
+    VERSION = '2.0.4'
   end
 end

data/lib/shippo/exceptions.rb

@@ -1,7 +1,8 @@
-module Shippo
-  module Exceptions
-  end
-end
-
 require 'shippo/exceptions/error'
-Dir[File.dirname(__FILE__) + '/exceptions/*.rb'].each {|file| require file }
+require 'shippo/exceptions/api_error'
+require 'shippo/exceptions/api_server_error'
+
+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/exceptions/api_error.rb

@@ -1,20 +1,35 @@
-class Shippo::Exceptions::APIError < ::Shippo::Exceptions::Error
-  attr_accessor :message, :req
-  def initialize(message = nil, req = nil)
-    super(message)
-    self.req = req
-  end
+module Shippo
+  module Exceptions
+    class APIError < ::Shippo::Exceptions::Error
+      attr_accessor :request,
+                    :response,
+                    :http_response_message
 
-  def to_s
-    "#{self.class.name} ⇨ #{req.url}#{response} ⇨ #{message}"
-  end
 
-  def response
-    req.response && req.response.http_code ? "[ ⇨ HTTP #{req.response.http_code} ]" : ''
+      def initialize(message = nil,
+                     request = nil,
+                     response = nil)
+        super(message)
+        self.request  = request
+        self.response = response
+      end
+
+      def to_s_members
+        super + %i(server_url response)
+      end
+
+      def server_url
+        @server_url ||= (request ? request.url : '')
+      end
+    end
   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
+
+class Shippo::Exceptions::UnsuccessfulResponseError < Shippo::Exceptions::APIError;
+end
+class Shippo::Exceptions::InvalidCategoryValueError < Shippo::Exceptions::APIError;
+end
+class Shippo::Exceptions::InvalidJsonError < Shippo::Exceptions::APIError;
+end
 

data/lib/shippo/exceptions/api_server_error.rb

@@ -0,0 +1,25 @@
+require 'shippo/exceptions/api_error'
+
+module Shippo
+  module Exceptions
+    #
+    # The +APIServerError+ happens when the server returns a parseable JSON response,
+    # but when such response indicates a failed operation due to either
+    # validation or other business, data or logic issues.
+    #
+    # The error adds the HTTP response message member, which would typically be
+    # "400 Bad Request"
+    #
+    class APIServerError < APIError
+
+      def initialize(message = nil, request = nil, response = nil, http_response_message = nil)
+        super(message, request, response)
+        self.http_response_message = http_response_message
+      end
+
+      def to_s_members
+        %i(http_response_message) + super
+      end
+    end
+  end
+end

data/lib/shippo/exceptions/error.rb

@@ -1,23 +1,42 @@
-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
+module Shippo
+  module Exceptions
+
+    class 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_members
+        %i()
+      end
+
+      def to_s
+        out = super
+        out << " (#{message}) " if message
+        to_s_members.each do |member|
+          out << member_to_s(member)
+        end
+        out
+      end
 
-  def to_s
-    "Error! ⇨ #{message}"
+      private
+
+      def member_to_s(member)
+        out   = ''
+        value = self.send(member)
+        out << "\n#{sprintf('%21s', member)}: '#{value}', " if value && (value != '')
+        out
+      end
+
+
+    end
   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
-class Shippo::Exceptions::InvalidInputError < Shippo::Exceptions::Error; end

data/shippo.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |spec|
   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 'activesupport', '>= 4'
   spec.add_dependency 'awesome_print'
 
   spec.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shippo
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Shippo & Contributors
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,20 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -71,14 +57,14 @@ dependencies:
   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
@@ -202,6 +188,7 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- bin/console
 - bin/example
 - lib/shippo.rb
 - lib/shippo/api.rb
@@ -227,6 +214,7 @@ files:
 - lib/shippo/api/version.rb
 - lib/shippo/exceptions.rb
 - lib/shippo/exceptions/api_error.rb
+- lib/shippo/exceptions/api_server_error.rb
 - lib/shippo/exceptions/error.rb
 - lib/shippo/model/address.rb
 - lib/shippo/model/carrieraccount.rb