easypost 3.5.1 → 5.2.0

data/README.md

@@ -1,113 +1,225 @@
 # EasyPost Ruby Client Library
 
 [![Build Status](https://github.com/EasyPost/easypost-ruby/workflows/CI/badge.svg)](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
+[![Coverage Status](https://coveralls.io/repos/github/EasyPost/easypost-ruby/badge.svg?branch=master)](https://coveralls.io/github/EasyPost/easypost-ruby?branch=master)
 [![Gem Version](https://badge.fury.io/rb/easypost.svg)](https://badge.fury.io/rb/easypost)
 
+EasyPost, the simple shipping solution. You can sign up for an account at <https://easypost.com>.
 
-EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com.
-
-## Installation
-
-Install the gem:
+## Install
 
 ```bash
 gem install easypost
 ```
 
-Import the EasyPost client in your application:
-
 ```ruby
+# Require the library in your project:
 require 'easypost'
 ```
 
-## Example
+## Usage
+
+A simple create & buy shipment example:
 
 ```ruby
 require 'easypost'
-EasyPost.api_key = 'API_KEY'
-
-to_address = EasyPost::Address.create(
-  :name => 'Dr. Steve Brule',
-  :street1 => '179 N Harbor Dr',
-  :city => 'Redondo Beach',
-  :state => 'CA',
-  :zip => '90277',
-  :country => 'US',
-  :phone => '310-808-5243'
-)
 
-from_address = EasyPost::Address.create(
-  :company => 'EasyPost',
-  :street1 => '118 2nd Street',
-  :street2 => '4th Floor',
-  :city => 'San Francisco',
-  :state => 'CA',
-  :zip => '94105',
-  :phone => '415-456-7890'
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_TEST_API_KEY'])
+
+shipment = client.shipment.create(
+  from_address: {
+    company: 'EasyPost',
+    street1: '118 2nd Street',
+    street2: '4th Floor',
+    city: 'San Francisco',
+    state: 'CA',
+    zip: '94105',
+    phone: '415-456-7890',
+  },
+  to_address: {
+    name: 'Dr. Steve Brule',
+    street1: '179 N Harbor Dr',
+    city: 'Redondo Beach',
+    state: 'CA',
+    zip: '90277',
+    country: 'US',
+    phone: '310-808-5243',
+  },
+  parcel: {
+    width: 15.2,
+    length: 18,
+    height: 9.5,
+    weight: 35.1,
+  },
 )
 
-parcel = EasyPost::Parcel.create(
-  :width => 15.2,
-  :length => 18,
-  :height => 9.5,
-  :weight => 35.1
-)
+bought_shipment = client.shipment.buy(shipment.id, rate: shipment.lowest_rate)
 
-customs_item = EasyPost::CustomsItem.create(
-  :description => 'EasyPost T-shirts',
-  :quantity => 2,
-  :value => 23.56,
-  :weight => 33,
-  :origin_country => 'us',
-  :hs_tariff_number => 123456
-)
+puts bought_shipment
+```
 
-customs_info = EasyPost::CustomsInfo.create(
-  :integrated_form_type => 'form_2976',
-  :customs_certify => true,
-  :customs_signer => 'Dr. Pepper',
-  :contents_type => 'gift',
-  :contents_explanation => '', # only required when contents_type => 'other'
-  :eel_pfc => 'NOEEI 30.37(a)',
-  :non_delivery_option => 'abandon',
-  :restriction_type => 'none',
-  :restriction_comments => '',
-  :customs_items => [customs_item]
-)
+### Custom Connections
+
+Pass in a lambda function as `custom_client_exec` when initializing a client that responds to `call(method, uri, headers, open_timeout, read_timeout, body = nil)` where:
+
+- `uri` is the fully-qualified URL of the EasyPost endpoint, including query parameters (`Uri` object)
+- `method` is the lowercase name of the HTTP method being used for the request (e.g. `:get`, `:post`, `:put`, `:delete`)
+- `headers` is a hash with all headers needed for the request pre-populated, including authorization (`Hash` object)
+- `open_timeout` is the number of seconds to wait for the connection to open (integer)
+- `read_timeout` is the number of seconds to wait for one block to be read (integer)
+- `body` is a string of the body data to be included in the request, or nil (e.g. GET or DELETE request) (string or `nil`)
+
+The lambda function should return an object with `code` and `body` attributes, where:
+
+- `code` is the HTTP response status code (integer)
+- `body` is the response body (string)
+
+#### Faraday
 
-shipment = EasyPost::Shipment.create(
-  :to_address => to_address,
-  :from_address => from_address,
-  :parcel => parcel,
-  :customs_info => customs_info
+```ruby
+require 'faraday'
+
+custom_connection = lambda { |method, uri, headers, _open_timeout, _read_timeout, body = nil|
+  conn = Faraday.new(url: uri.to_s, headers: headers) do |faraday|
+    faraday.adapter Faraday.default_adapter
+  end
+  conn.public_send(method, uri.path) { |request|
+    request.body = body if body
+  }.yield_self do |response|
+    OpenStruct.new(code: response.status, body: response.body)
+  end
+}
+
+my_client = described_class.new(
+  api_key: ENV['EASYPOST_API_KEY'],
+  custom_client_exec: custom_connection,
 )
+```
 
-shipment.buy(
-  :rate => shipment.lowest_rate
+#### Typhoeus
+
+```ruby
+require 'typhoeus'
+
+custom_connection = lambda { |method, uri, headers, _open_timeout, _read_timeout, body = nil|
+  Typhoeus.public_send(
+    method,
+    uri.to_s,
+    headers: headers,
+    body: body,
+  ).yield_self do |response|
+    OpenStruct.new(code: response.code, body: response.body)
+  end
+}
+
+my_client = described_class.new(
+  api_key: ENV['EASYPOST_API_KEY'],
+  custom_client_exec: custom_connection,
 )
+```
 
-shipment.insure(amount: 100)
+### HTTP Hooks
 
-puts shipment.insurance
+Users can audit HTTP requests and responses being made by the library by subscribing to request and response events. To do so, pass a block to the `subscribe_request_hook` and `subscribe_response_hook` methods of an instance of `EasyPost::Client`:
 
-puts shipment.postage_label.label_url
+```ruby
+require 'easypost'
+
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_API_KEY'])
+
+# Returns a randomly-generated symbol which you can use to later unsubscribe the request hook
+client.subscribe_request_hook do |request_data|
+  # Your code goes here
+end
+# Returns a randomly-generated symbol which you can use to later unsubscribe the response hook
+client.subscribe_response_hook do |response_data|
+  # Your code goes here
+end
 ```
 
+You can also name your hook subscriptions by providing an optional parameter to the methods above:
+
+```ruby
+require 'easypost'
+
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_API_KEY'])
+
+request_hook = client.subscribe_request_hook(:my_request_hook) do |request_data|
+  # Your code goes here
+end
+response_hook = client.subscribe_response_hook(:my_response_hook) do |response_data|
+  # Your code goes here
+end
+
+puts request_hook  # :my_request_hook
+puts response_hook # :my_response_hook
+```
+
+Keep in mind that subscribing a hook with the same name of an existing hook will replace the existing hook with the new one. A request hook and a response hook can share the same name.
+
+#### Custom HTTP Connections with HTTP Hooks
+
+If you're using a custom HTTP connection, keep in mind that the `response_data` parameter that a response hook receives *will not be hydrated* with all the response data. You will have to inspect the `client_response_object` property in `response_data` to inspect the response code, response headers and response body.
+
 ## Documentation
 
-Up-to-date documentation at: https://easypost.com/docs
+API documentation can be found at: <https://easypost.com/docs/api>.
+
+Library documentation can be found on the web at: <https://easypost.github.io/easypost-ruby/> or by building them locally via the `make docs` command.
+
+Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md).
+
+## Support
+
+New features and bug fixes are released on the latest major release of this library. If you are on an older major release of this library, we recommend upgrading to the most recent release to take advantage of new features, bug fixes, and security patches. Older versions of this library will continue to work and be available as long as the API version they are tied to remains active; however, they will not receive updates and are considered EOL.
+
+For additional support, see our [org-wide support policy](https://github.com/EasyPost/.github/blob/main/SUPPORT.md).
 
 ## Development
 
 ```bash
-# Run tests
-API_KEY=123... bundle exec rspec
+# Install dependencies
+make install
+
+# Install style guide (Unix only)
+make install-style
+
+# Lint project
+make lint
+make lint-fix
+
+# Run tests (coverage is generated on a successful test suite run)
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
+
+# Run security analysis
+make scan
+
+# Generate library documentation
+make docs
+
+# Update submodules
+make update-examples-submodule
 ```
 
-## Releasing
+### Testing
+
+The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run. If you receive errors about a cassette expiring, delete and re-record the cassette to ensure the data is up-to-date.
+
+**Sensitive Data:** We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.
+
+**Making Changes:** If you make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.
+
+**Test Data:** The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user **with the exception of the USPS carrier account ID** (see [Unit Test API Keys](#unit-test-api-keys) for more information) which has a fallback value of our internal testing user's ID. Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).
+
+#### Unit Test API Keys
+
+The following are required on every test run:
+
+- `EASYPOST_TEST_API_KEY`
+- `EASYPOST_PROD_API_KEY`
+
+Some tests may require an EasyPost user with a particular set of enabled features such as a `Partner` user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
 
-1. Update the version in `VERSION`
-1. Update the `CHANGELOG`
-1. Tag a release on GitHub
-1. Build the Gem `gem build easypost.gemspec`
-1. Publish the Gem `gem push easypost-X.X.X.gem` (replace `X.X.X` with the version being released)
+- `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
+- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral customer)
+- `REFERRAL_CUSTOMER_PROD_API_KEY` (eg: adding a credit card to a referral customer)

data/Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

data/UPGRADE_GUIDE.md

@@ -0,0 +1,181 @@
+# Upgrade Guide
+
+Use the following guide to assist in the upgrade process of the `easypost-ruby` library between major versions.
+
+- [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50)
+- [Upgrading from 3.x to 4.0](#upgrading-from-3x-to-40)
+
+## Upgrading from 4.x to 5.0
+
+### 5.0 High Impact Changes
+
+- [New Client object](#50-thread-safe-with-client-object)
+- [Updated Dependencies](#50-updated-dependencies)
+- [Improved Error Handling](#50-improved-error-handling)
+
+### 5.0 Medium Impact Changes
+
+- [Corrected Naming Conventions](#50-corrected-naming-conventions)
+
+### 5.0 Low Impact Changes
+
+- [Beta Namespace Changed](#50-beta-namespace-changed)
+
+## 5.0 Thread-Safe with Client Object
+
+Likelihood of Impact: High
+
+This library is now thread-safe with the introduction of a new `Client` object. Instead of defining a global API key that all requests use, you now create an `Client` object and pass your API key to it with optional open and read timeout params. You then call your desired functions against a `service` which are called against a `Client` object:
+
+```ruby
+# Old way
+EasyPost.api_key = ENV['EASYPOST_API_KEY']
+shipment = EasyPost::Shipment.retrieve('shp_...')
+
+# New way
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_TEST_API_KEY'])
+shipment = client.shipment.retrieve('shp_...')
+```
+
+All instance methods are now static with the exception of `lowest_rate` as these make API calls and require the Client object(EasyPost objects do not contain an API key to make API calls with).
+
+Previously used `.save()` instance methods are now static `.update()` functions where you specify first the ID of the object you are updating and second, the parameters that need updating.
+
+## 5.0 Updated Dependencies
+
+Likelihood of Impact: High
+
+**Ruby 2.6 Required**
+
+easypost-ruby now requires Ruby 2.6 or greater.
+
+**Dependencies**
+
+All dependencies had minor version bumps.
+
+## 5.0 Improved Error Handling
+
+Likelihood of Impact: High
+
+There are ~2 dozen new error types that extend either `ApiError` or `EasyPostError`.
+
+New ApiErrors (extends EasyPostError):
+
+- `ApiError`
+- `ConnectionError`
+- `ExternalApiError`
+- `ForbiddenError`
+- `GatewayTimeoutError`
+- `InternalServerError`
+- `InvalidRequestError`
+- `MethodNotAllowedError`
+- `NotFoundError`
+- `PaymentError`
+- `ProxyError`
+- `RateLimitError`
+- `RedirectError`
+- `RetryError`
+- `ServiceUnavailableError`
+- `SSLError`
+- `TimeoutError`
+- `UnauthorizedError`
+- `UnknownApiError`
+
+New EasyPostErrors (extends builtin Exception):
+
+- `EasyPostError`
+- `EndOfPaginationError`
+- `FilteringError`
+- `InvalidObjectError`
+- `InvalidParameterError`
+- `MissingParameterError`
+- `SignatureVerificationError`
+
+ApiErrors will behave like the previous Error class did. They will include a `message`, `http_status`, and `http_body`. Additionally, a new `code` and `errors` keys are present and populate when available. This class extends the more generic `EasyPostError` which only contains a message, used for errors thrown directly from this library.
+
+## 5.0 Corrected Naming Conventions
+
+Likelihood of Impact: Medium
+
+Occurances of `referral` are now `referral_customer` and `Referral` are now `ReferralCustomer` to match the documentation and API.
+
+Occurances of `smartrate` are now `smart_rate` and `Smartrate` are now `SmartRate` to match the documentation and API.
+
+Occurances of `scanform` are now `scan_form` and `Scanform` are now `ScanForm` to match the documentation and API.
+
+Rename function `get_smartrates` to `get_smart_rates`
+
+Rename function `get_lowest_smartrate` to `get_lowest_smart_rate`
+
+## 5.0 Beta Namespace Changed
+
+Likelihood of Impact: Low
+
+Previously, the beta namespace was found at `easypost.beta.x` where `x` is the name of your model. Now, the beta namespace is simply prepended to the name of your service: `client.beta_x`. for instance, you can call `client.beta_referral_customer.add_payment_method()`.
+
+## 5.0 Return True For Empty API Response
+
+Likelihood of Impact: Low
+
+Empty API response functions for `delete` return `true` instead of empty object
+
+## Upgrading from 3.x to 4.0
+
+**NOTICE:** v4 is deprecated.
+
+### 4.0 High Impact Changes
+
+* [Updating Dependencies](#40-updating-dependencies)
+
+### 4.0 Medium Impact Changes
+
+* [Removal of `get_rates` Shipment Method](#40-removal-of-getrates-shipment-method)
+
+### 4.0 Low Impact Changes
+
+* [Removal of `Print` and `PrintJob` Objects](#40-removal-of-print-and-printjob-objects)
+* [Removal of `stamp_and_barcode_by_reference` Batch Method](#40-removal-of-stampandbarcodebyreference-batch-method)
+* [Removal of `Address.verify` Parameters](#40-removal-of-addressverify-parameters)
+* [Removal of the `http_status` Property on EasyPost::Error](#40-removal-of-httpstatus-property-on-easyposterror)
+
+## 4.0 Updating Dependencies
+
+Likelihood of Impact: High
+
+**Ruby 2.5 Required**
+
+easypost-ruby now requires Ruby 2.5 or greater.
+
+**Dependencies**
+
+No production dependencies were altered. Development dependencies were all bumped and `simplecov` and `rubocop` were introduced.
+
+## 4.0 Removal of get_rates Shipment Method
+
+Likelihood of Impact: Medium
+
+The HTTP method used for the `get_rates` endpoint at the API level has changed from `POST` to `GET` and will only retrieve rates for a shipment instead of regenerating them. A new `/rerate` endpoint has been introduced to replace this functionality; In this library, you can now call the `Shipment.regenerate_rates` method to regenerate rates. Due to the logic change, the `get_rates` method has been removed since a Shipment inherently already has rates associated.
+
+## 4.0 Removal of Print and PrintJob Objects
+
+Likelihood of Impact: Low
+
+The `Print` and `PrintJob` objects have been removed as they are no longer usable with the current version of the API.
+
+## 4.0 Removal of stamp_and_barcode_by_reference Batch Method
+
+Likelihood of Impact: Low
+
+The `stamp_and_barcode_by_reference` Batch method has been removed as it is no longer usable with the current version of the API.
+
+## 4.0 Removal of Address.verify Parameters
+
+Likelihood of Impact: Low
+
+The parameters for the `Address.verify` method were removed as they were unusable, the current version of the API does not allow you to verify an address by specifying a carrier.
+
+## 4.0 Removal of http_status Property on EasyPost::Error
+
+Likelihood of Impact: Low
+
+The deprecated `http_status` property has been removed in favor of the `status` property on the EasyPost::Error object.

data/VERSION

@@ -1 +1 @@
-3.5.1
+5.2.0

data/bin/easypost-irb

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 
-libs =  " -r irb/completion"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/easypost'}"
-puts "Initializing EasyPost..."
+libs = ' -r irb/completion'
+libs << " -r #{"#{File.dirname(__FILE__)}/../lib/easypost"}"
+puts 'Initializing EasyPost...'
 exec "#{irb} #{libs} --simple-prompt"

data/easypost.gemspec

@@ -1,31 +1,38 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "easypost/version"
+require 'easypost/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "easypost"
+  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.license = 'MIT'
+  spec.summary = 'EasyPost Ruby Client Library'
+  spec.description = 'Client library for accessing the EasyPost shipping API via Ruby.'
+  spec.authors = 'EasyPost Developers'
+  spec.email = 'oss@easypost.com'
+  spec.homepage = 'https://www.easypost.com/docs'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(docs|examples|spec)/})
   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.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6'
 
-  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"
+  spec.add_development_dependency 'brakeman', '~> 5.4'
+  spec.add_development_dependency 'faraday', '~> 2.7.5' # used for integration tests
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'psych', '~> 5.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rdoc', '~> 6.5'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.49'
+  spec.add_development_dependency 'rubocop-rspec', '2.19' # pin to 2.19 because latest version doesn't support Ruby 2.6
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
+  spec.add_development_dependency 'typhoeus', '~> 1.4.0' # used for integration tests
+  spec.add_development_dependency 'vcr', '~> 6.1'
+  spec.add_development_dependency 'webmock', '~> 3.18'
 end