easypost 3.0.0 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 677127854c0b4c489ee924bff20fac02917e38bf
-  data.tar.gz: 443d834ebc6347f523ad956c91706d7cd0e819b2
+  metadata.gz: c78ad14a13a665a9397b5d2ade56cdad38a669f0
+  data.tar.gz: e73234c20adee8cfcbc37f2b93fb1c5aa2a6843d
 SHA512:
-  metadata.gz: bd9b8a2b041853716139a7d8913d51539b166408d3dea0eba5772b6ab2ce643b0d89e19c2f4c55c9c3c124567c9fb4edeb11535f788af273d697c011b1787364
-  data.tar.gz: fc58e08a4a748c936d60b048d2c1ce38191acde4a7a4f76653017ffb89e846f9551dbdbca6c4adf3a556ee5019cc8e7b4890631253f01db5bf9589b01ebb63d4
+  metadata.gz: 29e64cace8628e794a110868fbf3395fe560f1334ebe04218ccab054edf84f64631895196a09967ad06021b405162ee660eb29e86992847dfcfd45dc5b7b1549
+  data.tar.gz: f5e58cd6bdbe1cf61b3e272986470eb5beb7c9ba8738a4ebe05b727803c741a518ab5d64876ba2ff8bbb5ae2f331c8f6b977b4f53c1839336ebb72c3ef08337a

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+    - 2.2
+    - 2.3
+    - 2.4
+    - 2.5
+    - 2.6
+    - 2.7
+script: "bundle exec rspec"

data/CHANGELOG

@@ -1,3 +1,25 @@
+=== 3.1.3 2020-06-26
+
+* Fix bug causing Authorization header to be included in User-Agent header. All users must upgrade.
+
+=== 3.1.2 2020-06-24
+
+* Bad gem push. New version required.
+
+=== 3.1.1 2020-06-23
+
+* Fix bug where EasyPost.http_config was invalid when not explicitly initialized.
+
+=== 3.1.0 2020-06-23
+
+* Add Shipment Invoice and Refund Report
+* Remove dependencies on `RestClient` and `MultiJson`
+* Remove some deprecated endpoints
+
+=== 3.0.1 2018-05-17
+
+* Enforce TLS certificate validity by default
+
 === 3.0.0 2018-02-09
 
 * Require use of ruby ~> 2.0 and TLSv1.2

data/README.md

@@ -1,6 +1,6 @@
 # EasyPost Ruby Client Library
 
-[<img src="https://circleci.com/gh/EasyPost/easypost-ruby.png?circle-token=80adb5236ed1fdce20810b055af79c63c3d5796b">](https://circleci.com/gh/EasyPost/easypost-ruby)
+[![Build Status](https://travis-ci.com/EasyPost/easypost-ruby.svg?branch=master)](https://travis-ci.com/EasyPost/easypost-ruby)
 
 
 EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.1.3

data/easypost.gemspec

@@ -1,27 +1,31 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'easypost/version'
+require "easypost/version"
 
 Gem::Specification.new do |spec|
-  spec.name        = 'easypost'
-  spec.version     = EasyPost::VERSION
-  spec.date        = Time.now.strftime("%Y-%m-%d")
-  spec.summary     = 'EasyPost Ruby Client Library'
-  spec.description = 'Client library for accessing the EasyPost shipping API via Ruby.'
-  spec.authors     = ['Sawyer Bateman']
-  spec.email       = 'contact@easypost.com'
-  spec.homepage    = 'https://www.easypost.com/docs'
+  spec.name = "easypost"
+  spec.version = EasyPost::VERSION
+  spec.licenses = ["MIT"]
+  spec.date = Time.now.strftime("%Y-%m-%d")
+  spec.summary = "EasyPost Ruby Client Library"
+  spec.description = "Client library for accessing the EasyPost shipping API via Ruby."
+  spec.authors = ["Jake Epstein", "Andrew Tribone", "James Brown"]
+  spec.email = "support@easypost.com"
+  spec.homepage = "https://www.easypost.com/docs"
 
-  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.required_ruby_version = '~> 2.0'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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.required_ruby_version = "~> 2.2"
 
-  spec.add_dependency 'rest-client', '>= 1.7'
-  spec.add_dependency 'multi_json', '>= 1.3.0'
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency "pry", "~> 0.13"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "webmock", "~> 3.8"
+  spec.add_development_dependency "vcr", "~> 5.1"
 end

data/lib/easypost/address.rb

@@ -18,7 +18,7 @@ module EasyPost
         end
       end
 
-      response, api_key = EasyPost.request(:post, url, api_key, {address: params})
+      response = EasyPost.make_request(:post, url, api_key, {address: params})
       return Util.convert_to_easypost_object(response, api_key)
     end
 
@@ -26,7 +26,7 @@ module EasyPost
       wrapped_params = {}
       wrapped_params[self.class_name().to_sym] = params
       wrapped_params[:carrier] = carrier
-      response, api_key = EasyPost.request(:post, url + '/create_and_verify', api_key, wrapped_params)
+      response = EasyPost.make_request(:post, url + '/create_and_verify', api_key, wrapped_params)
 
       if response.has_key?(:address)
         if response.has_key?(:message)
@@ -41,13 +41,13 @@ module EasyPost
 
     def verify(params={}, carrier=nil)
       begin
-        response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
+        response = EasyPost.make_request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
       rescue
         raise Error.new("Unable to verify address.")
       end
 
-      if response.has_key?(:address)
-        return EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
+      if response.has_key?("address")
+        return EasyPost::Util::convert_to_easypost_object(response["address"], api_key)
       else
         raise Error.new("Unable to verify address.")
       end

data/lib/easypost/batch.rb

@@ -4,47 +4,47 @@ module EasyPost
     def self.create_and_buy(params={}, api_key=nil)
       wrapped_params = {}
       wrapped_params[self.class_name().to_sym] = params
-      response, api_key = EasyPost.request(:post, url + '/create_and_buy', api_key, wrapped_params)
+      response = EasyPost.make_request(:post, url + '/create_and_buy', api_key, wrapped_params)
 
       return Util.convert_to_easypost_object(response, api_key)
     end
 
     def buy(params={})
-      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/buy', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
     def label(params={})
-      response, api_key = EasyPost.request(:post, url + '/label', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/label', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
     def remove_shipments(params={})
-      response, api_key = EasyPost.request(:post, url + '/remove_shipments', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/remove_shipments', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
     def add_shipments(params={})
-      response, api_key = EasyPost.request(:post, url + '/add_shipments', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/add_shipments', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
     def stamp_and_barcode_by_reference(params={})
-      response, api_key = EasyPost.request(:get, url + '/stamp_and_barcode_by_reference', @api_key, params)
+      response = EasyPost.make_request(:get, url + '/stamp_and_barcode_by_reference', @api_key, params)
 
       return response
     end
 
     def create_scan_form(params={})
-      response, api_key = EasyPost.request(:post, url + '/scan_form', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/scan_form', @api_key, params)
 
       return response
     end

data/lib/easypost/carrier_account.rb

@@ -1,7 +1,7 @@
 module EasyPost
   class CarrierAccount < Resource
     def self.types
-      response, api_key = EasyPost.request(:get, "/carrier_types", @api_key)
+      response = EasyPost.make_request(:get, "/carrier_types", @api_key)
       return Util.convert_to_easypost_object(response, api_key)
     end
   end

data/lib/easypost/customs_info.rb

@@ -1,4 +1,9 @@
 module EasyPost
   class CustomsInfo < Resource
+
+    def self.all(filters={}, api_key=nil)
+      raise NotImplementedError.new('CustomsInfo.all not implemented.')
+    end
+
   end
 end

data/lib/easypost/customs_item.rb

@@ -1,4 +1,9 @@
 module EasyPost
   class CustomsItem < Resource
+
+    def self.all(filters={}, api_key=nil)
+      raise NotImplementedError.new('CustomsItem.all not implemented.')
+    end
+
   end
 end

data/lib/easypost/error.rb

@@ -1,38 +1,31 @@
 module EasyPost
   class Error < StandardError
     attr_reader :message
-    attr_reader :http_status
-    attr_reader :http_body
-    attr_reader :json_body
-    attr_reader :param
+    attr_reader :status
+    attr_reader :http_status # deprecated
     attr_reader :code
     attr_reader :errors
 
-    def initialize(message=nil, http_status=nil, http_body=nil, json_body={})
+    def initialize(message = nil, status = nil, code = nil, errors = nil)
       @message = message
-      @http_status = http_status
-      @http_body = http_body
-      @json_body = json_body
-
-      @param = @json_body.fetch(:error, {}).fetch(:param, nil)
-      @code = @json_body.fetch(:error, {}).fetch(:code, nil)
-      @errors = @json_body.fetch(:error, {}).fetch(:errors, nil)
+      @status = status
+      @http_status = status # deprecated
+      @code = code
+      @errors = errors
 
       super(message)
     end
 
     def to_s
-      s = "#{@code} (#{@http_status}): #{@message}";
-      if @errors
-          s += "\nField errors:\n"
-          @errors.each do |field_error|
-            field_error.each do |k, v|
-              s += "  #{k}: #{v}\n"
-            end
-            s += "\n"
-          end
-      end
-      s
+      "#{code} (#{status}): #{message} #{errors}".strip
+    end
+
+    def ==(other)
+      other.is_a?(Error) &&
+        message == other.message &&
+        status == other.status &&
+        code == other.code &&
+        errors == other.errors
     end
   end
 end

data/lib/easypost/item.rb

@@ -2,7 +2,7 @@ module EasyPost
   class Item < Resource
 
     def self.retrieve_reference(params={}, api_key=nil)
-      response, api_key = EasyPost.request(:get, url + '/retrieve_reference', api_key, params)
+      response = EasyPost.make_request(:get, url + '/retrieve_reference', api_key, params)
       return EasyPost::Util::convert_to_easypost_object(response, api_key) if response
     end
 

data/lib/easypost/object.rb

@@ -1,3 +1,5 @@
+require "set"
+
 module EasyPost
   class EasyPostObject
     include Enumerable
@@ -22,12 +24,12 @@ module EasyPost
     end
 
     def to_s(*args)
-      MultiJson.dump(@values, :pretty => true)
+      JSON.dump(@values)
     end
 
-    def inspect()
+    def inspect
       id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
-      "#<#{self.class}:#{id_string}> JSON: " + MultiJson.dump(@values, :pretty => true)
+      "#<#{self.class}:#{id_string}> JSON: " + to_json
     end
 
     def refresh_from(values, api_key, partial=false)
@@ -47,8 +49,7 @@ module EasyPost
     end
 
     def [](k)
-      k = k.to_sym if k.is_a?(String)
-      @values[k]
+      @values[k.to_s]
     end
 
     def []=(k, v)
@@ -64,7 +65,7 @@ module EasyPost
     end
 
     def to_json(options = {})
-      MultiJson.dump(@values)
+      JSON.dump(@values)
     end
 
     def as_json(options = {})
@@ -144,6 +145,5 @@ module EasyPost
         end
       end
     end
-
   end
 end

data/lib/easypost/order.rb

@@ -2,7 +2,7 @@ module EasyPost
   class Order < Resource
 
     def get_rates(params={})
-      response, api_key = EasyPost.request(:get, url + '/rates', @api_key, params)
+      response = EasyPost.make_request(:get, url + '/rates', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
@@ -16,11 +16,15 @@ module EasyPost
         params[:service] = temp.service
       end
 
-      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/buy', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
+    def self.all(filters={}, api_key=nil)
+      raise NotImplementedError.new('Order.all not implemented.')
+    end
+
   end
 end

data/lib/easypost/pickup.rb

@@ -9,17 +9,22 @@ module EasyPost
         params[:service] = temp.service
       end
 
-      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/buy', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
     def cancel(params={})
-      response, api_key = EasyPost.request(:post, url + '/cancel', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/cancel', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
+
+    def self.all(filters={}, api_key=nil)
+      raise NotImplementedError.new('Pickup.all not implemented.')
+    end
+
   end
 end

data/lib/easypost/printer.rb

@@ -2,7 +2,7 @@ module EasyPost
   class Printer < Resource
 
     def job
-      response, api_key = EasyPost.request(
+      response = EasyPost.make_request(
         :get, url + '/jobs', @api_key
       )
       return EasyPost::Util::convert_to_easypost_object(response, api_key)
@@ -15,7 +15,7 @@ module EasyPost
         params[:postage_label] = temp
       end
 
-      response, api_key = EasyPost.request(
+      response = EasyPost.make_request(
         :post, url + '/print_postage_label', @api_key, params
       )
       return true

data/lib/easypost/report.rb

@@ -5,7 +5,7 @@ module EasyPost
       wrapped_params = {}
       wrapped_params[class_name.to_sym] = params
 
-      response, api_key = EasyPost.request(:post, url, api_key, params)
+      response = EasyPost.make_request(:post, url, api_key, params)
       return Util.convert_to_easypost_object(response, api_key)
     end
 
@@ -24,7 +24,7 @@ module EasyPost
     def self.all(filters={}, api_key=nil)
       url = "#{self.url}/#{filters[:type]}"
 
-      response, api_key = EasyPost.request(:get, url, api_key, filters)
+      response = EasyPost.make_request(:get, url, api_key, filters)
       return EasyPost::Util::convert_to_easypost_object(response, api_key) if response
     end
   end

data/lib/easypost/resource.rb

@@ -11,9 +11,9 @@ module EasyPost
         raise NotImplementedError.new('Resource is an abstract class.  You should perform actions on its subclasses (Address, Shipment, etc.)')
       end
       if(self.class_name[-1..-1] == 's' || self.class_name[-1..-1] == 'h')
-        return "/#{CGI.escape(self.class_name.downcase)}es"
+        return "/v2/#{CGI.escape(self.class_name.downcase)}es"
       else
-        return "/#{CGI.escape(class_name.downcase)}s"
+        return "/v2/#{CGI.escape(class_name.downcase)}s"
       end
     end
 
@@ -25,13 +25,13 @@ module EasyPost
     end
 
     def refresh
-      response, api_key = EasyPost.request(:get, url, @api_key, @retrieve_options)
+      response = EasyPost.make_request(:get, url, @api_key, @retrieve_options)
       refresh_from(response, api_key)
       return self
     end
 
     def self.all(filters={}, api_key=nil)
-      response, api_key = EasyPost.request(:get, url, api_key, filters)
+      response = EasyPost.make_request(:get, url, api_key, filters)
       return Util.convert_to_easypost_object(response, api_key)
     end
 
@@ -44,12 +44,12 @@ module EasyPost
     def self.create(params={}, api_key=nil)
       wrapped_params = {}
       wrapped_params[self.class_name().to_sym] = params
-      response, api_key = EasyPost.request(:post, self.url, api_key, wrapped_params)
+      response = EasyPost.make_request(:post, self.url, api_key, wrapped_params)
       return Util.convert_to_easypost_object(response, api_key)
     end
 
     def delete
-      response, api_key = EasyPost.request(:delete, url, @api_key)
+      response = EasyPost.make_request(:delete, url, @api_key)
       refresh_from(response, api_key)
       return self
     end
@@ -68,7 +68,7 @@ module EasyPost
 
         wrapped_params = {self.class.class_name => values}
 
-        response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
+        response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
         refresh_from(response, api_key)
       end
       return self

data/lib/easypost/scan_form.rb

@@ -1,7 +1,7 @@
 module EasyPost
   class ScanForm < Resource
     def self.create(params={}, api_key=nil)
-      response, api_key = EasyPost.request(:post, self.url, api_key, params)
+      response = EasyPost.make_request(:post, self.url, api_key, params)
       return Util.convert_to_easypost_object(response, api_key)
     end
   end

data/lib/easypost/shipment.rb

@@ -2,7 +2,7 @@ module EasyPost
   class Shipment < Resource
 
     def get_rates(params={})
-      response, api_key = EasyPost.request(:get, url + '/rates', @api_key, params)
+      response = EasyPost.make_request(:get, url + '/rates', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
@@ -15,7 +15,7 @@ module EasyPost
         params[:rate] = temp
       end
 
-      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/buy', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
@@ -28,14 +28,14 @@ module EasyPost
         params[:amount] = temp
       end
 
-      response, api_key = EasyPost.request(:post, url + '/insure', @api_key, params)
+      response = EasyPost.make_request(:post, url + '/insure', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
     end
 
     def refund(params={})
-      response, api_key = EasyPost.request(:get, url + '/refund', @api_key, params)
+      response = EasyPost.make_request(:get, url + '/refund', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self
@@ -55,7 +55,7 @@ module EasyPost
         params[:file_format] = temp
       end
 
-      response, api_key = EasyPost.request(:get, url + '/label', @api_key, params)
+      response = EasyPost.make_request(:get, url + '/label', @api_key, params)
       self.refresh_from(response, @api_key, true)
 
       return self

data/lib/easypost/tracker.rb

@@ -2,13 +2,13 @@ module EasyPost
   class Tracker < Resource
     def self.create_list(params={}, api_key=nil)
       url = self.url + '/create_list'
-      response, api_key = EasyPost.request(:post, url, api_key, params)
+      response = EasyPost.make_request(:post, url, api_key, params)
       return true
     end
 
     def self.all_updated(params={}, api_key=nil)
       url = self.url + '/all_updated'
-      response, api_key = EasyPost.request(:get, url, api_key, params)
+      response = EasyPost.make_request(:get, url, api_key, params)
       return Util.convert_to_easypost_object(response, api_key)
     end
   end

data/lib/easypost/user.rb

@@ -1,9 +1,7 @@
 module EasyPost
   class User < Resource
     def self.create(params={}, api_key=nil)
-      wrapped_params = {}
-      wrapped_params[self.class_name().to_sym] = params
-      response, api_key = EasyPost.request(:post, self.url, api_key, wrapped_params, {}, false)
+      response = EasyPost.make_request(:post, self.url, api_key, {self.class_name.to_sym => params})
       return Util.convert_to_easypost_object(response, api_key)
     end
 
@@ -14,7 +12,7 @@ module EasyPost
 
         wrapped_params = {user: values}
 
-        response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
+        response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
         refresh_from(response, api_key)
       end
       return self
@@ -25,7 +23,7 @@ module EasyPost
     end
 
     def self.all_api_keys
-      response, api_key = EasyPost.request(:get, "/api_keys", @api_key)
+      response = EasyPost.make_request(:get, "/api_keys", @api_key)
       return Util.convert_to_easypost_object(response, api_key)
     end
 

data/lib/easypost/util.rb

@@ -42,6 +42,8 @@ module EasyPost
         'ShipmentReport' => Report,
         'PaymentLogReport' => Report,
         'TrackerReport' => Report,
+        'RefundReport' => Report,
+        'ShipmentInvoiceReport' => Report,
         'Webhook' => Webhook
       }
 
@@ -70,6 +72,8 @@ module EasyPost
         'shprep' => Report,
         'plrep' => Report,
         'trkrep' => Report,
+        'refrep' => Report,
+        'shpinvrep' => Report,
         'hook' => Webhook
       }
 
@@ -99,49 +103,5 @@ module EasyPost
         return response
       end
     end
-
-    def self.symbolize_names(obj)
-      case obj
-      when Hash
-        result = {}
-        obj.each do |k, v|
-          k = (k.to_sym rescue k) || k
-          obj[k] = symbolize_names(v)
-        end
-        return result
-      when Array
-        return obj.map { |v| symbolize_names(v) }
-      else
-        return obj
-      end
-    end
-
-    def self.url_encode(key)
-      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-    end
-
-    def self.flatten_params(params, parent_key=nil)
-      result = []
-      if params.is_a?(Hash)
-        params.each do |k, v|
-          calculated_key = parent_key ? "#{parent_key}[#{url_encode(k)}]" : url_encode(k)
-          if v.is_a?(Hash) or v.is_a?(Array)
-            result += flatten_params(v, calculated_key)
-          else
-            result << [calculated_key, v]
-          end
-        end
-      elsif params.is_a?(Array)
-        params.each_with_index do |v, i|
-          calculated_key = parent_key ? "#{parent_key}[#{i}]" : i
-          if v.is_a?(Hash) or v.is_a?(Array)
-            result += flatten_params(v, calculated_key)
-          else
-            result << [calculated_key, v]
-          end
-        end
-      end
-      return result
-    end
   end
 end