easypost 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 677127854c0b4c489ee924bff20fac02917e38bf
-  data.tar.gz: 443d834ebc6347f523ad956c91706d7cd0e819b2
+  metadata.gz: 77a7386297f189954ea974f3704cd7b61317f680
+  data.tar.gz: 3f2f2a129f9413f73910743c64a9d1b957998814
 SHA512:
-  metadata.gz: bd9b8a2b041853716139a7d8913d51539b166408d3dea0eba5772b6ab2ce643b0d89e19c2f4c55c9c3c124567c9fb4edeb11535f788af273d697c011b1787364
-  data.tar.gz: fc58e08a4a748c936d60b048d2c1ce38191acde4a7a4f76653017ffb89e846f9551dbdbca6c4adf3a556ee5019cc8e7b4890631253f01db5bf9589b01ebb63d4
+  metadata.gz: 73d59ca7ab531ee6bd6b5bae9d5d8cb862501ba1e3a41d3a218c3853f9a7c96dc69fb5c0a67a94fd068c123f76037aaa8bd64ab0ddff01fe80e446aac254100c
+  data.tar.gz: 77174452488594f5b154548a784c9e294aa66e3a54b1267d1d3a7076475ed41fa6027db1af2a4b2b0b869588853982770e0d43bd797755fe68ed5bbd5f124487

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: 'CI'
+
+on:
+  push:
+    branches: [ master ]
+  pull_request: ~
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rubyversion: ['2.4', '2.5', '2.6', '2.7', '3.0']
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.rubyversion }}
+          bundler-cache: true
+      - name: run tests
+        run: bundle exec rspec

data/CHANGELOG

@@ -1,3 +1,43 @@
+=== 3.2.0 2021-01-14
+
+* Replace Travis CI with Github Actions
+* Add Ruby 3.0 to supported platforms (#110; thanks @maxwell)
+
+=== 3.1.5 2020-12-16
+
+* Fix attribute lookup when manually constructing objects (#105; thanks @drewtempelmeyer)
+* Flatten class names and clean up some other style issues
+* Fix `EasyPost::Address.create_and_verify`, broken since 3.1.0 (#108; thanks @rajbirverma)
+
+=== 3.1.4 2020-09-29
+
+* Don't modify params passed into Address#create (#78; thanks @TheRusskiy)
+* Don't modify `carriers` and `services` parameters to `Shipment.lowest_rate` (#71 / #103, thanks @vladvinnikov and @jurisgalang)
+* When constructing an easypost object, convert the key to a string (#102; thanks @Geesu)
+* Expose the raw HTTP response as `#http_body` on `EasyPost::Error` objects (#101; thanks @Geesu)
+
+=== 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,7 @@
 # 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://github.com/EasyPost/easypost-ruby/workflows/CI/badge.svg)](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
+[![Gem Version](https://badge.fury.io/rb/easypost.svg)](https://badge.fury.io/rb/easypost)
 
 
 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.2.0

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.rb

@@ -1,157 +1,147 @@
-require 'cgi'
-require 'set'
-require 'openssl'
-require 'rest_client'
-require 'multi_json'
+require "base64"
+require "cgi"
+require "net/http"
 
 # Resources
-require 'easypost/version'
-require 'easypost/util'
-require 'easypost/object'
-require 'easypost/resource'
-require 'easypost/address'
-require 'easypost/parcel'
-require 'easypost/customs_item'
-require 'easypost/customs_info'
-require 'easypost/shipment'
-require 'easypost/rate'
-require 'easypost/postage_label'
-require 'easypost/scan_form'
-require 'easypost/refund'
-require 'easypost/insurance'
-require 'easypost/event'
-require 'easypost/batch'
-require 'easypost/tracker'
-require 'easypost/item'
-require 'easypost/order'
-require 'easypost/pickup'
-require 'easypost/pickup_rate'
-require 'easypost/printer'
-require 'easypost/print_job'
-require 'easypost/carrier_account'
-require 'easypost/user'
-require 'easypost/report'
-require 'easypost/webhook'
-
-require 'easypost/error'
+require "easypost/version"
+require "easypost/util"
+require "easypost/object"
+require "easypost/resource"
+require "easypost/address"
+require "easypost/parcel"
+require "easypost/customs_item"
+require "easypost/customs_info"
+require "easypost/shipment"
+require "easypost/rate"
+require "easypost/postage_label"
+require "easypost/scan_form"
+require "easypost/refund"
+require "easypost/insurance"
+require "easypost/event"
+require "easypost/batch"
+require "easypost/tracker"
+require "easypost/item"
+require "easypost/order"
+require "easypost/pickup"
+require "easypost/pickup_rate"
+require "easypost/printer"
+require "easypost/print_job"
+require "easypost/carrier_account"
+require "easypost/user"
+require "easypost/report"
+require "easypost/webhook"
+
+require "easypost/error"
 
 module EasyPost
-  @@api_key = nil
-  @@api_base = 'https://api.easypost.com/v2'
-  @@api_version = nil
-  @@open_timeout = 30
-  @@timeout = 60
-
-  def self.api_url(url='')
-    @@api_base + url
-  end
+  @api_key = nil
+  @api_base = "https://api.easypost.com"
 
   def self.api_key=(api_key)
-    @@api_key = api_key
+    @api_key = api_key
   end
 
   def self.api_key
-    @@api_key
+    @api_key
   end
 
   def self.api_base=(api_base)
-    @@api_base = api_base
+    @api_base = api_base
   end
 
   def self.api_base
-    @@api_base
+    @api_base
   end
 
-  def self.api_version=(version)
-    @@api_version = version
-  end
+  def self.reset_http_config
+    @http_config = {
+      timeout: 60,
+      open_timeout: 30,
+      verify_ssl: OpenSSL::SSL::VERIFY_PEER,
+    }
+
+    ruby_version = Gem::Version.new(RUBY_VERSION)
+    if ruby_version >= Gem::Version.new("2.5.0")
+      @http_config[:min_version] = OpenSSL::SSL::TLS1_2_VERSION
+    else
+      @http_config[:ssl_version] = :TLSv1_2
+    end
 
-  def self.api_version
-    @@api_version
+    @http_config
   end
 
   def self.http_config
-    @@http_config ||= {
-      timeout: 60,
-      open_timeout: 30,
-      verify_ssl: false,
-      ssl_version: :TLSv1_2,
-    }
+    @http_config ||= reset_http_config
   end
 
   def self.http_config=(http_config_params)
-    self.http_config.merge!(http_config_params)
+    http_config.merge!(http_config_params)
   end
 
-  def self.request(method, url, api_key, params={}, headers={}, api_key_required=true)
-    api_key ||= @@api_key
-    if api_key_required
-      raise Error.new('No API key provided.') unless api_key
-    end
+  def self.make_client(uri)
+    client = if http_config[:proxy]
+               proxy_uri = URI(http_config[:proxy])
+               Net::HTTP.new(
+                 uri.host,
+                 uri.port,
+                 proxy_uri.host,
+                 proxy_uri.port,
+                 proxy_uri.user,
+                 proxy_uri.password
+               )
+             else
+               Net::HTTP.new(uri.host, uri.port)
+             end
+    client.use_ssl = true
+
+    http_config.each do |name, value|
+      # Discrepancies between RestClient and Net::HTTP.
+      if name == :verify_ssl
+        name = :verify_mode
+      elsif name == :timeout
+        name = :read_timeout
+      end
 
-    params = Util.objects_to_ids(params)
-    url = self.api_url(url)
-    case method.to_s.downcase.to_sym
-    when :get, :head, :delete
-      # Make params into GET parameters
-      if params && params.count > 0
-        query_string = Util.flatten_params(params).collect{|key, value| "#{key}=#{Util.url_encode(value)}"}.join('&')
-        url += "#{URI.parse(url).query ? '&' : '?'}#{query_string}"
+      # Handled in the creation of the client.
+      if name == :proxy
+        next
       end
-      payload = nil
-    else
-      payload = Util.flatten_params(params).collect{|(key, value)| "#{key}=#{Util.url_encode(value)}"}.join('&')
+
+      client.send("#{name}=", value)
     end
 
-    headers = {
-      :user_agent => "EasyPost/v2 RubyClient/#{VERSION}",
-      :authorization => "Bearer #{api_key}",
-      :content_type => 'application/x-www-form-urlencoded'
-    }.merge(headers)
-
-    opts = http_config.merge(
-      {
-        :method => method,
-        :url => url,
-        :headers => headers,
-        :payload => payload
-      }
-    )
+    client
+  end
 
-    begin
-      response = execute_request(opts)
-    rescue RestClient::ExceptionWithResponse => e
-      if response_code = e.http_code and response_body = e.http_body
-        begin
-          response_json = MultiJson.load(response_body, :symbolize_keys => true)
-        rescue MultiJson::DecodeError
-          raise Error.new("Invalid response from API, unable to decode.", response_code, response_body)
-        end
-        begin
-          raise NoMethodError if response_json[:error][:message] == nil
-          raise Error.new(response_json[:error][:message], response_code, response_body, response_json)
-        rescue NoMethodError, TypeError
-          raise Error.new(response_json[:error], response_code, response_body, response_json)
-        end
-      else
-        raise Error.new(e.message)
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      raise Error.new(e.message)
+  def self.make_request(method, path, api_key=nil, body=nil)
+    client = make_client(URI(@api_base))
+
+    request = Net::HTTP.const_get(method.capitalize).new(path)
+    if body
+      request.body = JSON.dump(EasyPost::Util.objects_to_ids(body))
     end
 
-    begin
-      response_json = MultiJson.load(response.body, :symbolize_keys => true)
-    rescue MultiJson::DecodeError
-      raise Error.new("Invalid response object from API, unable to decode.", response.code, response.body)
+    request["Content-Type"] = "application/json"
+    request["User-Agent"] = "EasyPost/v2 RubyClient/#{VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+    if api_key = api_key || @api_key
+      request["Authorization"] = "Basic #{Base64.strict_encode64("#{api_key}:")}"
     end
 
-    return [response_json, api_key]
-  end
+    response = client.request(request)
 
-  private
+    if (400..599).include? response.code.to_i
+      error = JSON.parse(response.body)["error"]
+      raise EasyPost::Error.new(error["message"], response.code.to_i, error["code"], error["errors"], response.body)
+    end
 
-  def self.execute_request(opts)
-    RestClient::Request.execute(opts)
+    if response["Content-Type"].include? "application/json"
+      JSON.parse(response.body)
+    else
+      response.body
+    end
+  rescue JSON::ParserError
+    raise RuntimeError.new(
+      "Invalid response object from API, unable to decode.\n#{response.body}"
+    )
   end
 end

data/lib/easypost/address.rb

@@ -1,58 +1,58 @@
-module EasyPost
-  class Address < Resource
-    attr_accessor :message # Backwards compatibility
-
-    def self.create(params={}, api_key=nil)
-      url = self.url
-
-      if params[:verify] || params[:verify_strict]
-        verify = params.delete(:verify) || []
-        verify_strict = params.delete(:verify_strict) || []
-
-        url += "?"
-        verify.each do |verification|
-          url += "verify[]=#{verification}&"
-        end
-        verify_strict.each do |verification|
-          url += "verify_strict[]=#{verification}&"
-        end
-      end
+class EasyPost::Address < EasyPost::Resource
+  attr_accessor :message # Backwards compatibility
 
-      response, api_key = EasyPost.request(:post, url, api_key, {address: params})
-      return Util.convert_to_easypost_object(response, api_key)
-    end
+  def self.create(params={}, api_key=nil)
+    url = self.url
+
+    address = params.reject { |k,_| k == :verify || k == :verify_strict }
+
+    if params[:verify] || params[:verify_strict]
+      verify = params[:verify] || []
+      verify_strict = params[:verify_strict] || []
 
-    def self.create_and_verify(params={}, carrier=nil, api_key=nil)
-      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)
-
-      if response.has_key?(:address)
-        if response.has_key?(:message)
-          response[:address][:message] = response[:message]
-        end
-        verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
-        return verified_address
-      else
-        raise Error.new("Unable to verify address.")
+      url += "?"
+      verify.each do |verification|
+        url += "verify[]=#{verification}&"
+      end
+      verify_strict.each do |verification|
+        url += "verify_strict[]=#{verification}&"
       end
     end
 
-    def verify(params={}, carrier=nil)
-      begin
-        response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
-      rescue
-        raise Error.new("Unable to verify address.")
-      end
+    response = EasyPost.make_request(:post, url, api_key, {address: address})
+    return EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
 
-      if response.has_key?(:address)
-        return EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
-      else
-        raise Error.new("Unable to verify address.")
+  def self.create_and_verify(params={}, carrier=nil, api_key=nil)
+    wrapped_params = {}
+    wrapped_params[self.class_name().to_sym] = params
+    wrapped_params[:carrier] = carrier
+    response = EasyPost.make_request(:post, url + '/create_and_verify', api_key, wrapped_params)
+
+    if response.has_key?("address")
+      if response.has_key?("message")
+        response["address"]["message"] = response["message"]
       end
+      verified_address = EasyPost::Util::convert_to_easypost_object(response["address"], api_key)
+      return verified_address
+    else
+      raise EasyPost::Error.new("Unable to verify address.")
+    end
+  end
 
-      return self
+  def verify(params={}, carrier=nil)
+    begin
+      response = EasyPost.make_request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
+    rescue
+      raise EasyPost::Error.new("Unable to verify address.")
     end
+
+    if response.has_key?("address")
+      return EasyPost::Util::convert_to_easypost_object(response["address"], api_key)
+    else
+      raise EasyPost::Error.new("Unable to verify address.")
+    end
+
+    return self
   end
 end