easypost 3.0.0 → 3.1.5

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

metadata

@@ -1,93 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.5
 platform: ruby
 authors:
-- Sawyer Bateman
+- Jake Epstein
+- Andrew Tribone
+- James Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
+        version: '0.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '5.1'
 description: Client library for accessing the EasyPost shipping API via Ruby.
-email: contact@easypost.com
+email: support@easypost.com
 executables:
 - easypost-irb
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -95,7 +98,6 @@ files:
 - Rakefile
 - VERSION
 - bin/easypost-irb
-- circle.yml
 - easypost.gemspec
 - lib/easypost.rb
 - lib/easypost/address.rb
@@ -126,23 +128,9 @@ files:
 - lib/easypost/util.rb
 - lib/easypost/version.rb
 - lib/easypost/webhook.rb
-- spec/address_spec.rb
-- spec/batch_spec.rb
-- spec/carrier_account_spec.rb
-- spec/insurance_spec.rb
-- spec/item_spec.rb
-- spec/order_spec.rb
-- spec/pickup_spec.rb
-- spec/report_spec.rb
-- spec/scan_form_spec.rb
-- spec/shipment_spec.rb
-- spec/spec_helper.rb
-- spec/support/constant.rb
-- spec/tracker_spec.rb
-- spec/user_spec.rb
-- spec/webhook_spec.rb
 homepage: https://www.easypost.com/docs
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -152,31 +140,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: EasyPost Ruby Client Library
-test_files:
-- spec/address_spec.rb
-- spec/batch_spec.rb
-- spec/carrier_account_spec.rb
-- spec/insurance_spec.rb
-- spec/item_spec.rb
-- spec/order_spec.rb
-- spec/pickup_spec.rb
-- spec/report_spec.rb
-- spec/scan_form_spec.rb
-- spec/shipment_spec.rb
-- spec/spec_helper.rb
-- spec/support/constant.rb
-- spec/tracker_spec.rb
-- spec/user_spec.rb
-- spec/webhook_spec.rb
+test_files: []

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.0.0

data/spec/address_spec.rb

@@ -1,81 +0,0 @@
-require 'spec_helper'
-
-describe EasyPost::Address do
-  describe ".create_and_verify" do
-    context "for a successful response without an address" do
-      it "should raise an error" do
-        expect(EasyPost).to receive(:request).and_return([{}, ""])
-        expect {
-          EasyPost::Address.create_and_verify(ADDRESS[:california])
-        }.to raise_error EasyPost::Error, /Unable to verify addres/
-      end
-    end
-  end
-
-  describe '#create' do
-    it 'creates an address object' do
-      address = EasyPost::Address.create(ADDRESS[:california])
-
-      expect(address).to be_an_instance_of(EasyPost::Address)
-      expect(address.company).to eq('EasyPost')
-    end
-  end
-
-  describe '#verify' do
-    it 'verifies an address with an error' do
-      address = EasyPost::Address.create(
-        ADDRESS[:california].reject {|k,v| k == :street1 || k == :company}
-      )
-
-      expect(address.street1).to be_nil
-      expect(address.street2).to eq('Unit 1')
-      expect(address.city).to eq('San Francisco')
-      expect(address.state).to eq('CA')
-      expect(address.zip).to eq('94107')
-      expect(address.country).to eq('US')
-
-      expect {
-        address.verify()
-      }.to raise_error EasyPost::Error, /Unable to verify addres/
-    end
-
-    it 'verifies an address without message' do
-      address = EasyPost::Address.create(ADDRESS[:california])
-
-      expect(address.street2).to be
-
-      verified_address = address.verify()
-      expect(verified_address).to be_an_instance_of(EasyPost::Address)
-      expect(verified_address[:message]).to be_nil
-    end
-
-    it 'verifies an address using a carrier' do
-      address = EasyPost::Address.create(ADDRESS[:california])
-
-      expect(address.company).to eq('EasyPost')
-      expect(address.street1).to eq('164 Townsend Street')
-      expect(address.city).to eq('San Francisco')
-      expect(address.state).to eq('CA')
-      expect(address.zip).to eq('94107')
-      expect(address.country).to eq('US')
-
-      verified_address = address.verify(carrier: :usps)
-      expect(verified_address).to be_an_instance_of(EasyPost::Address)
-    end
-
-    it 'is not able to verify address' do
-      address = EasyPost::Address.create(
-        company: 'Simpler Postage Inc',
-        street1: '388 Junk Teerts',
-        street2: 'Apt 20',
-        city: 'San Francisco',
-        state: 'CA',
-        zip: '941abc07'
-      )
-
-      expect {
-        address.verify()
-      }.to raise_error(EasyPost::Error, /Unable to verify addres/)
-    end
-  end
-end

data/spec/batch_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-
-describe EasyPost::Batch do
-  describe '#create' do
-    it 'creates a batch object' do
-      batch = EasyPost::Batch.create({
-        shipment: [{
-          from_address: ADDRESS[:california],
-          to_address: EasyPost::Address.create(ADDRESS[:missouri]),
-          parcel: EasyPost::Parcel.create(PARCEL[:dimensions])
-        }, {
-          from_address: ADDRESS[:california],
-          to_address: EasyPost::Address.create(ADDRESS[:canada]),
-          parcel: EasyPost::Parcel.create(PARCEL[:dimensions]),
-        }],
-        reference: "batch123456789"
-      })
-      expect(batch).to be_an_instance_of(EasyPost::Batch)
-      expect(batch.num_shipments).to eq(2)
-      expect(batch.reference).to eq("batch123456789")
-      expect(batch.state).to eq("creating")
-    end
-  end
-
-  describe '#create_and_buy' do
-    it 'creates a batch object and delayed jobs for purchasing the postage_labels' do
-      batch = EasyPost::Batch.create({
-        shipment: [{
-          from_address: ADDRESS[:california],
-          to_address: EasyPost::Address.create(ADDRESS[:missouri]),
-          parcel: EasyPost::Parcel.create(PARCEL[:dimensions]),
-          carrier: "usps",
-          service: "priority"
-        }, {
-          from_address: ADDRESS[:california],
-          to_address: EasyPost::Address.create(ADDRESS[:canada]),
-          parcel: EasyPost::Parcel.create(PARCEL[:dimensions]),
-          carrier: "usps",
-          service: "prioritymailinternational"
-        }],
-        reference: "batch123456789"
-      })
-      expect(batch).to be_an_instance_of(EasyPost::Batch)
-      expect(batch.state).to eq("creating")
-      expect(batch.num_shipments).to eq(2)
-    end
-  end
-end