easypost 4.13.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c71d319c7e56e6787ce3e63fa8afaa634d8eeeb57ba77fd754f86e284a66dff9
-  data.tar.gz: 90e4523dc2a2dd2ff8af06ad0cdd95a24ff3fa93c098d81458deeb3d9cd7f60a
+  metadata.gz: b93e828aba22bcf673243120c7d51ab0d5bc813828204c5045ee7cbf4526bad2
+  data.tar.gz: 904d0537ad8f78924dee006329b59a1b07ce3496c33d07149684ec4219547978
 SHA512:
-  metadata.gz: 99646c67e4f7264adb2a3bbf48dcd2224623a88c69ce4650a9066a79ee7e7a1203816f5b39b9d2086840ea47a512de0184f7547cb92a741e6669fcb68f7618f9
-  data.tar.gz: bbd168c93b623642b947955088d0baf089027c1d19335bca4ff41ae0ca39e770019953934c23b5a7d30194cdfecc6d5e29717ed37b1525bb90525825b3a8b937
+  metadata.gz: 64bbae9d00138cfc8634bb12a2d07b96dbfc951a93c2c983fa4a7da77e49bfc3d5ae2471ebca3ec84a5cb7c74fa88a1b851998c799119c071200bc37cd0645eb
+  data.tar.gz: 1d6910376670da796ee8daf8ed7c54e54591cd7f0770b7d363a38bd9d406a229e1df364fa7c16aa0f688830e171be82cb0ddb2f2331dd125a980158fad8d23c1

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
+        rubyversion: ['2.6', '2.7', '3.0', '3.1', '3.2']
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
@@ -48,3 +48,24 @@ jobs:
         run: make lint
       - name: Run security analysis
         run: make scan
+  docs:
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          rubygems: '3.0.0'
+          bundler-cache: true
+      - name: Install Dependencies
+        run: make install
+      - name: Generate Docs
+        run: make docs
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs

data/.gitignore

@@ -1,11 +1,20 @@
+._*
+.AppleDouble
 .bundle
 .config
+.DS_Store
+.env
 .idea/
+.LSOverride
+.Spotlight-V100
+.Trashes
 *.gem
 *.rbc
 coverage
 dist
+docs
 Gemfile.lock
+Icon
 InstalledFiles
 lib/bundler/man
 pkg
@@ -14,15 +23,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
-
-# macOS
-._*
-.AppleDouble
-.DS_Store
-.env
-.LSOverride
-.Spotlight-V100
-.Trashes
-Icon
 vendor/

data/.rubocop.yml

@@ -2,10 +2,15 @@ inherit_from: easycop.yml
 
 AllCops:
   SuggestExtensions: false
+  Exclude:
+    - bin/**/*
+    - docs/**/*
+    - examples/**/*
+    - vendor/bundle/**/*
 # We are ignoring RSpec/FilePath because Simplecov doesn't play nice with nested spec files
 RSpec/FilePath:
   Enabled: false
 # TODO: Remove this once we start using keyword arguments
 Style/OptionalBooleanParameter:
   Exclude:
-    - 'lib/easypost/shipment.rb'
+    - 'lib/easypost/services/*.rb'

data/CHANGELOG.md

@@ -1,8 +1,25 @@
 # CHANGELOG
 
-## v4.13.1 (2023-04-18)
-
+## v5.0.0 (2023-06-06)
+
+See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-4x-to-50) for more details.
+
+- Library is now thread-safe. Closes GitHub Issue ([#183](https://github.com/EasyPost/easypost-ruby/issues/183))
+  - Initialize a `Client` object with an API key. Optionally set open and read timeout params
+  - Previous classes have been diverted into `Services` and `Models`
+    - All methods (i.e. `create`, `retrieve`, `all`) exist in services, accessed via property of the client (eg: `client.shipment.create()`)
+      - E.g. `bought_shipment = client.shipment.buy(shipment_id, rate)`
+- Beta namespace changed from `easypost.beta.x` to `client.beta_x`
+- References to `Referral` are now `ReferralCustomer` and `referral_customer` to match the API and docs
+- References to `smartrate` are now `SmartRate` and `smart_rate` to match the API and docs
+  - Rename function `get_smartrates` to `get_smart_rates`
+  - Rename function `get_lowest_smartrate` to `get_lowest_smart_rate`
+- Empty API response functions for `delete` return `true` instead of empty object
+- Drops support for Ruby 2.5
+- Bumps all dev dependencies
 - Improves Error Deserialization to dynamically handle edge cases that have a bad format
+- Adds `retrieve_estimated_delivery_date` function in Shipment
+- Removes deprecated `endshipper` beta class, please use the GA one `EasyPost::Services::EndShipper`
 
 ## v4.13.0 (2023-04-04)
 

data/Makefile

@@ -22,7 +22,7 @@ docs:
 
 ## fix - Fix Rubocop errors
 fix:
-	bundle exec rubocop -A
+	bundle exec rubocop -a
 
 ## install - Install globally from source
 install:

data/README.md

@@ -24,9 +24,9 @@ A simple create & buy shipment example:
 ```ruby
 require 'easypost'
 
-EasyPost.api_key = ENV['EASYPOST_API_KEY']
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_TEST_API_KEY'])
 
-shipment = EasyPost::Shipment.create(
+shipment = client.shipment.create(
   from_address: {
     company: 'EasyPost',
     street1: '118 2nd Street',
@@ -53,39 +53,45 @@ shipment = EasyPost::Shipment.create(
   },
 )
 
-shipment.buy(rate: shipment.lowest_rate)
+bought_shipment = client.shipment.buy(shipment.id, rate: shipment.lowest_rate)
 
-puts shipment
+puts bought_shipment
 ```
 
 ### Custom Connections
 
-Set `EasyPost.default_connection` to an object that responds to `call(method, path, api_key = nil, body = nil)`
+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
 
 ```ruby
 require 'faraday'
-require 'faraday/response/logger'
-require 'logger'
-
-EasyPost.default_connection = lambda do |method, path, api_key = nil, body = nil|
-  Faraday
-    .new(url: EasyPost.api_base, headers: EasyPost.default_headers) { |builder|
-      builder.use Faraday::Response::Logger, Logger.new(STDOUT), {bodies: true, headers: true}
-      builder.adapter :net_http
-    }
-    .public_send(method, path) { |request|
-      request.headers['Authorization'] = EasyPost.authorization(api_key)
-      request.body = JSON.dump(EasyPost::Util.objects_to_ids(body)) if body
-    }.yield_self { |response|
-      EasyPost.parse_response(
-        status: response.status,
-        body: response.body,
-        json: response.headers['Content-Type'].start_with?('application/json'),
-      )
-    }
-end
+
+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,
+)
 ```
 
 #### Typhoeus
@@ -93,27 +99,28 @@ end
 ```ruby
 require 'typhoeus'
 
-EasyPost.default_connection = lambda do |method, path, api_key = nil, body = nil|
+custom_connection = lambda { |method, uri, headers, _open_timeout, _read_timeout, body = nil|
   Typhoeus.public_send(
     method,
-    File.join(EasyPost.api_base, path),
-    headers: EasyPost.default_headers.merge('Authorization' => EasyPost.authorization(api_key)),
-    body: body.nil? ? nil : JSON.dump(EasyPost::Util.objects_to_ids(body)),
-  ).yield_self { |response|
-    EasyPost.parse_response(
-      status: response.code,
-      body: response.body,
-      json: response.headers['Content-Type'].start_with?('application/json'),
-    )
-  }
-end
+    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,
+)
 ```
 
 ## Documentation
 
 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 locally in the `docs` directory.
+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).
 

data/UPGRADE_GUIDE.md

@@ -2,8 +2,127 @@
 
 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)

data/VERSION

@@ -1 +1 @@
-4.13.1
+5.0.0

data/easycop.yml

@@ -5,7 +5,7 @@
 require:
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   NewCops: disable
 Layout/BlockAlignment:
   Enabled: true
@@ -41,7 +41,7 @@ Layout/FirstMethodArgumentLineBreak:
   Enabled: true
 Layout/LineLength:
   Max: 120
-  IgnoredPatterns: # deprecated in 1.28
+  AllowedPatterns:
     - "(\\A|\\s)#"
 Layout/LineEndStringConcatenationIndentation: # new in 1.18
   Enabled: true
@@ -104,7 +104,7 @@ Metrics/ParameterLists:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
-Gemspec/DateAssignment: # new in 1.10
+Gemspec/DeprecatedAttributeAssignment:
   Enabled: true
 Lint/AmbiguousAssignment: # new in 1.7
   Enabled: true

data/easypost.gemspec

@@ -19,18 +19,20 @@ Gem::Specification.new do |spec|
   end
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_development_dependency 'brakeman', '~> 5.2'
+  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', '~> 4.0' # TODO: pinned because rdoc has an optimistic pin of this dep and 5.0 breaks on CI
+  spec.add_development_dependency 'psych', '~> 5.1'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rdoc', '~> 6.4'
-  spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '= 1.27' # rubocop 1.28 requires Ruby 2.6+
-  spec.add_development_dependency 'rubocop-rspec', '= 2.10' # rubocop-rspec 2.11 requires Ruby 2.6+
-  spec.add_development_dependency 'simplecov', '~> 0.21'
+  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 'vcr', '= 6.0' # VCR 6.1 requires Ruby 2.6+
-  spec.add_development_dependency 'webmock', '~> 3.14'
+  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

data/lib/easypost/client.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative 'services'
+require_relative 'http_client'
+require_relative 'internal_utilities'
+require 'json'
+
+class EasyPost::Client
+  attr_reader :open_timeout, :read_timeout, :api_base
+
+  # Initialize a new Client object
+  # @param api_key [String] the API key to be used for requests
+  # @param read_timeout [Integer] (60) the number of seconds to wait for a response before timing out
+  # @param open_timeout [Integer] (30) the number of seconds to wait for the connection to open before timing out
+  # @param api_base [String] ('https://api.easypost.com') the base URL for the API
+  # @param custom_client_exec [Proc] (nil) a custom client execution block to be used for requests instead of the default HTTP client (function signature: method, uri, headers, open_timeout, read_timeout, body = nil)
+  # @return [EasyPost::Client] the client object
+  def initialize(api_key:, read_timeout: 60, open_timeout: 30, api_base: 'https://api.easypost.com',
+                 custom_client_exec: nil)
+    raise EasyPost::Errors::MissingParameterError.new('api_key') if api_key.nil?
+
+    @api_key = api_key
+    @api_base = api_base
+    @api_version = 'v2'
+    @read_timeout = read_timeout
+    @open_timeout = open_timeout
+    @lib_version = File.open(File.expand_path('../../VERSION', __dir__)).read.strip
+
+    # Make an HTTP client once, reuse it for all requests made by this client
+    # Configuration is immutable, so this is safe
+    @http_client = EasyPost::HttpClient.new(api_base, http_config, custom_client_exec)
+  end
+
+  SERVICE_CLASSES = [
+    EasyPost::Services::Address,
+    EasyPost::Services::ApiKey,
+    EasyPost::Services::Batch,
+    EasyPost::Services::BetaRate,
+    EasyPost::Services::BetaReferralCustomer,
+    EasyPost::Services::Billing,
+    EasyPost::Services::CarrierAccount,
+    EasyPost::Services::CarrierMetadata,
+    EasyPost::Services::CustomsInfo,
+    EasyPost::Services::CustomsItem,
+    EasyPost::Services::EndShipper,
+    EasyPost::Services::Event,
+    EasyPost::Services::Insurance,
+    EasyPost::Services::Order,
+    EasyPost::Services::Parcel,
+    EasyPost::Services::Pickup,
+    EasyPost::Services::Rate,
+    EasyPost::Services::ReferralCustomer,
+    EasyPost::Services::Refund,
+    EasyPost::Services::Report,
+    EasyPost::Services::ScanForm,
+    EasyPost::Services::Shipment,
+    EasyPost::Services::Tracker,
+    EasyPost::Services::User,
+    EasyPost::Services::Webhook,
+  ].freeze
+
+  # Loop over the SERVICE_CLASSES to automatically define the method and instance variable instead of manually define it
+  SERVICE_CLASSES.each do |cls|
+    define_method(EasyPost::InternalUtilities.to_snake_case(cls.name.split('::').last)) do
+      instance_variable_set("@#{EasyPost::InternalUtilities.to_snake_case(cls.name.split('::').last)}", cls.new(self))
+    end
+  end
+
+  # Make an HTTP request
+  #
+  # @param method [Symbol] the HTTP Verb (get, method, put, post, etc.)
+  # @param endpoint [String] URI path of the resource
+  # @param cls [Class] the class to deserialize to
+  # @param body [Object] (nil) object to be dumped to JSON
+  # @param api_version [String] the version of API to hit
+  # @raise [EasyPost::Error] if the response has a non-2xx status code
+  # @return [Hash] JSON object parsed from the response body
+  def make_request(
+    method,
+    endpoint,
+    cls = EasyPost::Models::EasyPostObject,
+    body = nil,
+    api_version = EasyPost::InternalUtilities::Constants::API_VERSION
+  )
+    response = @http_client.request(method, endpoint, nil, body, api_version)
+
+    potential_error = EasyPost::Errors::ApiError.handle_api_error(response)
+    raise potential_error unless potential_error.nil?
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response.body, cls)
+  end
+
+  private
+
+  def http_config
+    http_config = {
+      read_timeout: @read_timeout,
+      open_timeout: @open_timeout,
+      headers: default_headers,
+    }
+
+    http_config[:min_version] = OpenSSL::SSL::TLS1_2_VERSION
+    http_config
+  end
+
+  def default_headers
+    {
+      'Content-Type' => 'application/json',
+      'User-Agent' => user_agent,
+      'Authorization' => authorization,
+    }
+  end
+
+  def user_agent
+    ruby_version = EasyPost::InternalUtilities::System.ruby_version
+    ruby_patchlevel = EasyPost::InternalUtilities::System.ruby_patchlevel
+
+    "EasyPost/#{@api_version} " \
+      "RubyClient/#{@lib_version} " \
+      "Ruby/#{ruby_version}-p#{ruby_patchlevel} " \
+      "OS/#{EasyPost::InternalUtilities::System.os_name} " \
+      "OSVersion/#{EasyPost::InternalUtilities::System.os_version} " \
+      "OSArch/#{EasyPost::InternalUtilities::System.os_arch}"
+  end
+
+  def authorization
+    "Bearer #{@api_key}"
+  end
+end

data/lib/easypost/connection.rb

@@ -10,9 +10,7 @@ EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
   # @raise [EasyPost::Error] if the response has a non-2xx status code
   # @return [Hash] JSON object parsed from the response body
   def call(method, path, api_key = nil, body = nil)
-    if api_key.nil?
-      raise EasyPost::Error, 'No API key provided.'
-    end
+    raise EasyPost::Errors::MissingParameterError.new('api_key') if api_key.nil?
 
     connection =
       if config[:proxy]
@@ -49,7 +47,7 @@ EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
     end
 
     request = Net::HTTP.const_get(method.capitalize).new(path)
-    request.body = JSON.dump(EasyPost::Util.objects_to_ids(body)) if body
+    request.body = JSON.dump(EasyPost::InternalUtilities.objects_to_ids(body)) if body
 
     EasyPost.default_headers.each_pair { |h, v| request[h] = v }
     request['Authorization'] = EasyPost.authorization(api_key)

data/lib/easypost/constants.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class EasyPost::Constants
+  API_ERROR_DETAILS_PARSING_ERROR = 'API error details could not be parsed.'
+  INVALID_PARAMETER = '%s is not a valid parameter.'
+  INVALID_PAYMENT_METHOD = 'The chosen payment method is not valid. Please try again.'
+  MISSING_REQUIRED_PARAMETER = 'Required parameter %s is missing.'
+  NO_MATCHING_RATES = 'No matching rates found.'
+  NO_MORE_PAGES = 'There are no more pages to retrieve.'
+  NO_PAYMENT_METHODS = 'Billing has not been setup for this user. Please add a payment method.'
+  STRIPE_CARD_CREATE_FAILED = 'Could not send card details to Stripe, please try again later.'
+  UNEXPECTED_HTTP_STATUS_CODE = 'Unexpected HTTP status code received: %s'
+  WEBHOOK_MISSING_SIGNATURE = 'Webhook received does not contain an HMAC signature.'
+  WEBHOOK_SIGNATURE_MISMATCH = 'Webhook received did not originate from EasyPost or had a webhook secret mismatch.'
+end