easypost 4.8.1 → 5.1.0

data/lib/easypost/utilities/static_mapper.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative '../models'
+
+module EasyPost::InternalUtilities::StaticMapper
+  BY_PREFIX = {
+    'adr' => EasyPost::Models::Address,
+    'ak' => EasyPost::Models::ApiKey,
+    'bank' => EasyPost::Models::PaymentMethod,
+    'batch' => EasyPost::Models::Batch,
+    'brd' => EasyPost::Models::Brand,
+    'ca' => EasyPost::Models::CarrierAccount,
+    'card' => EasyPost::Models::PaymentMethod,
+    'cstinfo' => EasyPost::Models::CustomsInfo,
+    'cstitem' => EasyPost::Models::CustomsItem,
+    'es' => EasyPost::Models::EndShipper,
+    'evt' => EasyPost::Models::Event,
+    'hook' => EasyPost::Models::Webhook,
+    'ins' => EasyPost::Models::Insurance,
+    'order' => EasyPost::Models::Order,
+    'payload' => EasyPost::Models::Payload,
+    'pickup' => EasyPost::Models::Pickup,
+    'pickuprate' => EasyPost::Models::PickupRate,
+    'pl' => EasyPost::Models::PostageLabel,
+    'plrep' => EasyPost::Models::Report,
+    'prcl' => EasyPost::Models::Parcel,
+    'rate' => EasyPost::Models::Rate,
+    'refrep' => EasyPost::Models::Report,
+    'rfnd' => EasyPost::Models::Refund,
+    'sf' => EasyPost::Models::ScanForm,
+    'shp' => EasyPost::Models::Shipment,
+    'shpinvrep' => EasyPost::Models::Report,
+    'shprep' => EasyPost::Models::Report,
+    'trk' => EasyPost::Models::Tracker,
+    'trkrep' => EasyPost::Models::Report,
+    'user' => EasyPost::Models::User,
+  }.freeze
+
+  BY_TYPE = {
+    'Address' => EasyPost::Models::Address,
+    'ApiKey' => EasyPost::Models::ApiKey,
+    'BankAccount' => EasyPost::Models::PaymentMethod,
+    'Batch' => EasyPost::Models::Batch,
+    'Brand' => EasyPost::Models::Brand,
+    'CarbonOffset' => EasyPost::Models::CarbonOffset,
+    'CarrierAccount' => EasyPost::Models::CarrierAccount,
+    'CreditCard' => EasyPost::Models::PaymentMethod,
+    'CustomsInfo' => EasyPost::Models::CustomsInfo,
+    'CustomsItem' => EasyPost::Models::CustomsItem,
+    'EndShipper' => EasyPost::Models::EndShipper,
+    'Event' => EasyPost::Models::Event,
+    'Insurance' => EasyPost::Models::Insurance,
+    'Order' => EasyPost::Models::Order,
+    'Parcel' => EasyPost::Models::Parcel,
+    'PaymentLogReport' => EasyPost::Models::Report,
+    'Pickup' => EasyPost::Models::Pickup,
+    'PickupRate' => EasyPost::Models::PickupRate,
+    'PostageLabel' => EasyPost::Models::PostageLabel,
+    'Rate' => EasyPost::Models::Rate,
+    'Refund' => EasyPost::Models::Refund,
+    'RefundReport' => EasyPost::Models::Report,
+    'Report' => EasyPost::Models::Report,
+    'ScanForm' => EasyPost::Models::ScanForm,
+    'Shipment' => EasyPost::Models::Shipment,
+    'ShipmentInvoiceReport' => EasyPost::Models::Report,
+    'ShipmentReport' => EasyPost::Models::Report,
+    'TaxIdentifier' => EasyPost::Models::TaxIdentifier,
+    'Tracker' => EasyPost::Models::Tracker,
+    'TrackerReport' => EasyPost::Models::Report,
+    'User' => EasyPost::Models::User,
+    'Webhook' => EasyPost::Models::Webhook,
+  }.freeze
+end

data/lib/easypost/utilities/system.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module EasyPost::InternalUtilities::System
+  def self.os_name
+    case RUBY_PLATFORM
+    when /linux/i
+      'Linux'
+    when /darwin/i
+      'Darwin'
+    when /cygwin|mswin|mingw|bccwin|wince|emx/i
+      'Windows'
+    else
+      'Unknown'
+    end
+  end
+
+  def self.os_version
+    Gem::Platform.local.version
+  end
+
+  def self.os_arch
+    Gem::Platform.local.cpu
+  end
+
+  def self.ruby_version
+    RUBY_VERSION
+  end
+
+  def self.ruby_patchlevel
+    RUBY_PATCHLEVEL
+  end
+
+  def self.lib_version
+    File.open(File.expand_path('../../VERSION', __dir__)).read.strip
+  end
+end

data/lib/easypost.rb

@@ -5,149 +5,27 @@ require 'cgi'
 require 'net/http'
 
 require 'easypost/version'
-require 'easypost/object'
-require 'easypost/resource'
-require 'easypost/error'
 require 'easypost/connection'
-
-# Resources
-require 'easypost/address'
-require 'easypost/api_key'
-require 'easypost/batch'
-require 'easypost/billing'
-require 'easypost/brand'
-require 'easypost/carbon_offset'
-require 'easypost/carrier_account'
-require 'easypost/carrier_type'
-require 'easypost/customs_info'
-require 'easypost/customs_item'
-require 'easypost/end_shipper'
-require 'easypost/event'
-require 'easypost/insurance'
-require 'easypost/order'
-require 'easypost/parcel'
-require 'easypost/payment_method' # deprecated
-require 'easypost/pickup_rate'
-require 'easypost/pickup'
-require 'easypost/postage_label'
-require 'easypost/rate'
-require 'easypost/referral'
-require 'easypost/refund'
-require 'easypost/report'
-require 'easypost/scan_form'
-require 'easypost/shipment'
-require 'easypost/tax_identifier'
-require 'easypost/tracker'
-require 'easypost/user'
-require 'easypost/webhook'
-require 'easypost/beta'
-
 require 'easypost/util'
 
-module EasyPost
-  DEFAULT_API_BASE = 'https://api.easypost.com'
-
-  class << self
-    attr_accessor :api_key, :api_base
-    attr_writer :default_connection
-  end
-
-  self.api_base = DEFAULT_API_BASE
-
-  def self.user_agent
-    @user_agent ||=
-      "EasyPost/v2 RubyClient/#{EasyPost::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} " \
-      "OS/#{EasyPost::Util.os_name} OSVersion/#{EasyPost::Util.os_version} " \
-      "OSArch/#{EasyPost::Util.os_arch}"
-  end
-
-  def self.default_headers
-    @default_headers ||= {
-      'Content-Type' => 'application/json',
-      'User-Agent' => user_agent,
-    }
-  end
-
-  def self.default_connection
-    @default_connection ||= EasyPost::Connection.new(
-      uri: URI(api_base),
-      config: http_config,
-    )
-  end
+# Client
+require 'easypost/client'
+require 'easypost/http_client'
 
-  def self.authorization(key)
-    "Basic #{Base64.strict_encode64("#{key}:")}"
-  end
+# Services
+require 'easypost/services'
 
-  # Reset the HTTP config.
-  def self.reset_http_config
-    http_config.clear
-    self.default_connection = nil
-  end
+# Models
+require 'easypost/models'
 
-  def self.default_http_config
-    http_config = {
-      timeout: 60,
-      open_timeout: 30,
-      verify_ssl: OpenSSL::SSL::VERIFY_PEER,
-    }
+# Exceptions
+require 'easypost/errors'
 
-    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 # rubocop:disable Naming/VariableNumber
-    end
+# Internal Utilities
+require 'easypost/internal_utilities'
 
-    http_config
-  end
+# Hooks
+require 'easypost/hooks'
 
-  # Get the HTTP config.
-  def self.http_config
-    @http_config ||= default_http_config
-  end
-
-  # Set the HTTP config.
-  def self.http_config=(http_config_params)
-    http_config.merge!(http_config_params)
-
-    self.default_connection = nil
-  end
-
-  # Create an EasyPost Client.
-  #
-  # @deprecated
-  def self.make_client(url)
-    EasyPost::Connection.new(uri: URI(url), config: http_config).create
-  end
-
-  # Make an HTTP request against the {default_connection}
-  #
-  # @param method [Symbol] the HTTP Verb (get, method, put, post, etc.)
-  # @param path [String] URI path of the resource
-  # @param requested_api_key [String] ({EasyPost.api_key}) key set Authorization header.
-  # @param body [Object] (nil) object to be dumped to JSON
-  # @raise [EasyPost::Error] if the response has a non-2xx status code
-  # @return [Hash] JSON object parsed from the response body
-  def self.make_request(method, path, api_key = nil, body = nil)
-    default_connection.call(method, path, api_key || EasyPost.api_key, body)
-  end
-
-  def self.parse_response(status:, body:, json:)
-    if status < 200 || status >= 300
-      error = JSON.parse(body)['error']
-
-      raise EasyPost::Error.new(
-        error['message'],
-        status,
-        error['code'],
-        error['errors'],
-        body,
-      )
-    end
-
-    json || !body.nil? && !body.match(/\A\s+\z/) ? JSON.parse(body) : body
-  rescue JSON::ParserError
-    raise "Invalid response object from API, unable to decode.\n#{body}"
-  end
+module EasyPost
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 5.1.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,62 +80,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '1.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '1.49'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.19'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -122,34 +164,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.18'
 description: Client library for accessing the EasyPost shipping API via Ruby.
 email: oss@easypost.com
 executables:
@@ -165,61 +221,117 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".gitmodules"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - Makefile
 - README.md
 - Rakefile
-- SECURITY.md
-- SUPPORT.md
 - UPGRADE_GUIDE.md
 - VERSION
 - bin/easypost-irb
-- easycop.yml
 - easypost.gemspec
 - lib/easypost.rb
-- lib/easypost/address.rb
-- lib/easypost/api_key.rb
-- lib/easypost/batch.rb
-- lib/easypost/beta.rb
-- lib/easypost/beta/end_shipper.rb
-- lib/easypost/beta/referral.rb
-- lib/easypost/billing.rb
-- lib/easypost/brand.rb
-- lib/easypost/carbon_offset.rb
-- lib/easypost/carrier_account.rb
-- lib/easypost/carrier_type.rb
+- lib/easypost/client.rb
 - lib/easypost/connection.rb
-- lib/easypost/customs_info.rb
-- lib/easypost/customs_item.rb
-- lib/easypost/end_shipper.rb
-- lib/easypost/error.rb
-- lib/easypost/event.rb
-- lib/easypost/insurance.rb
-- lib/easypost/object.rb
-- lib/easypost/order.rb
-- lib/easypost/parcel.rb
-- lib/easypost/payment_method.rb
-- lib/easypost/pickup.rb
-- lib/easypost/pickup_rate.rb
-- lib/easypost/postage_label.rb
-- lib/easypost/rate.rb
-- lib/easypost/referral.rb
-- lib/easypost/refund.rb
-- lib/easypost/report.rb
-- lib/easypost/resource.rb
-- lib/easypost/scan_form.rb
-- lib/easypost/shipment.rb
-- lib/easypost/tax_identifier.rb
-- lib/easypost/tracker.rb
-- lib/easypost/user.rb
+- lib/easypost/constants.rb
+- lib/easypost/errors.rb
+- lib/easypost/errors/api/api_error.rb
+- lib/easypost/errors/api/bad_request_error.rb
+- lib/easypost/errors/api/connection_error.rb
+- lib/easypost/errors/api/external_api_error.rb
+- lib/easypost/errors/api/forbidden_error.rb
+- lib/easypost/errors/api/gateway_timeout_error.rb
+- lib/easypost/errors/api/internal_server_error.rb
+- lib/easypost/errors/api/invalid_request_error.rb
+- lib/easypost/errors/api/method_not_allowed_error.rb
+- lib/easypost/errors/api/not_found_error.rb
+- lib/easypost/errors/api/payment_error.rb
+- lib/easypost/errors/api/proxy_error.rb
+- lib/easypost/errors/api/rate_limit_error.rb
+- lib/easypost/errors/api/redirect_error.rb
+- lib/easypost/errors/api/retry_error.rb
+- lib/easypost/errors/api/service_unavailable_error.rb
+- lib/easypost/errors/api/ssl_error.rb
+- lib/easypost/errors/api/timeout_error.rb
+- lib/easypost/errors/api/unauthorized_error.rb
+- lib/easypost/errors/api/unknown_api_error.rb
+- lib/easypost/errors/easy_post_error.rb
+- lib/easypost/errors/end_of_pagination_error.rb
+- lib/easypost/errors/filtering_error.rb
+- lib/easypost/errors/invalid_object_error.rb
+- lib/easypost/errors/invalid_parameter_error.rb
+- lib/easypost/errors/missing_parameter_error.rb
+- lib/easypost/errors/signature_verification_error.rb
+- lib/easypost/hooks.rb
+- lib/easypost/hooks/request_context.rb
+- lib/easypost/hooks/response_context.rb
+- lib/easypost/http_client.rb
+- lib/easypost/internal_utilities.rb
+- lib/easypost/models.rb
+- lib/easypost/models/address.rb
+- lib/easypost/models/api_key.rb
+- lib/easypost/models/base.rb
+- lib/easypost/models/batch.rb
+- lib/easypost/models/brand.rb
+- lib/easypost/models/carbon_offset.rb
+- lib/easypost/models/carrier_account.rb
+- lib/easypost/models/customs_info.rb
+- lib/easypost/models/customs_item.rb
+- lib/easypost/models/end_shipper.rb
+- lib/easypost/models/error.rb
+- lib/easypost/models/event.rb
+- lib/easypost/models/insurance.rb
+- lib/easypost/models/order.rb
+- lib/easypost/models/parcel.rb
+- lib/easypost/models/payload.rb
+- lib/easypost/models/payment_method.rb
+- lib/easypost/models/pickup.rb
+- lib/easypost/models/pickup_rate.rb
+- lib/easypost/models/postage_label.rb
+- lib/easypost/models/rate.rb
+- lib/easypost/models/referral.rb
+- lib/easypost/models/refund.rb
+- lib/easypost/models/report.rb
+- lib/easypost/models/scan_form.rb
+- lib/easypost/models/shipment.rb
+- lib/easypost/models/tax_identifier.rb
+- lib/easypost/models/tracker.rb
+- lib/easypost/models/user.rb
+- lib/easypost/models/webhook.rb
+- lib/easypost/services.rb
+- lib/easypost/services/address.rb
+- lib/easypost/services/api_key.rb
+- lib/easypost/services/base.rb
+- lib/easypost/services/batch.rb
+- lib/easypost/services/beta_rate.rb
+- lib/easypost/services/beta_referral_customer.rb
+- lib/easypost/services/billing.rb
+- lib/easypost/services/carrier_account.rb
+- lib/easypost/services/carrier_metadata.rb
+- lib/easypost/services/customs_info.rb
+- lib/easypost/services/customs_item.rb
+- lib/easypost/services/end_shipper.rb
+- lib/easypost/services/event.rb
+- lib/easypost/services/insurance.rb
+- lib/easypost/services/order.rb
+- lib/easypost/services/parcel.rb
+- lib/easypost/services/pickup.rb
+- lib/easypost/services/rate.rb
+- lib/easypost/services/referral_customer.rb
+- lib/easypost/services/refund.rb
+- lib/easypost/services/report.rb
+- lib/easypost/services/scan_form.rb
+- lib/easypost/services/shipment.rb
+- lib/easypost/services/tracker.rb
+- lib/easypost/services/user.rb
+- lib/easypost/services/webhook.rb
 - lib/easypost/util.rb
+- lib/easypost/utilities/constants.rb
+- lib/easypost/utilities/json.rb
+- lib/easypost/utilities/static_mapper.rb
+- lib/easypost/utilities/system.rb
 - lib/easypost/version.rb
-- lib/easypost/webhook.rb
 homepage: https://www.easypost.com/docs
 licenses:
 - MIT
@@ -232,14 +344,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library

data/.rubocop.yml

@@ -1,11 +0,0 @@
-inherit_from: easycop.yml
-
-AllCops:
-  SuggestExtensions: false
-# 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'

data/CODE_OF_CONDUCT.md

@@ -1,16 +0,0 @@
-# Code of Conduct
-
-> Remember the golden rule? Treat others as you'd like to be treated
-
-## Standards
-
-- Create a welcoming and safe community for `everyone`
-- Demonstrate empathy towards others, realize that everyone has a different `level of experience`
-- Be respectful of others opinions, viewpoints, and experiences
-- Give and receive respectful constructive feedback
-- Accept responsibility and apologize when necessary
-- Focus on what is best for the overall community
-
-## Failure to Follow Standards
-
-If there is a failure to follow the standards laid out above, the user will first be warned. If the offending behavior continues, the user may be blocked entirely.