shipengine_sdk 1.0.3

data/lib/shipengine/exceptions/error_code.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Exceptions
+    ##
+    ##  This class has the ability to return a specific error code.
+    ##
+    ## @see https://www.shipengine.com/docs/errors/codes/#error-code
+    # #/
+    class ErrorCode
+      # @param [Symbol] key
+      # @return [Symbol] error code
+      def self.get(key)
+        @codes[key]
+      end
+
+      # @param [String] str_key
+      # @return [Symbol] error code
+      def self.get_by_str(str_key)
+        get(str_key.upcase.to_sym)
+      end
+
+      @codes = {
+
+        ###############################
+
+        MINIMUM_POSTAL_CODE_VERIFICATION_FAILED: 'minimum_postal_code_verification_failed',
+
+        ##
+        ## Only certain carriers support pre-paid balances. So you can only add funds
+        ## to those carriers. If you attempt to add funds to a carrier that doesn't
+        ## support it then you'll get this error code.
+        # #/
+        AUTO_FUND_NOT_SUPPORTED: 'auto_fund_not_supported',
+
+        ##
+        ## Once a batch has started processing it cannot be modified. Attempting to
+        ## modify it will cause this error.
+        # #/
+        BATCH_CANNOT_BE_MODIFIED: 'batch_cannot_be_modified',
+
+        ##
+        ## You attempted to perform an operation on multiple shipments from different
+        ## carriers. Try performing separate operations for each carrier instead.
+        # #/
+
+        ##
+        ## This error means that you're trying to use a carrier that hasn't been setup
+        ## yet. You can setup carriers from your ShipEngine dashboard or via the API.
+        # #/
+        CARRIER_NOT_CONNECTED: 'carrier_not_connected',
+
+        ##
+        ## The operation you are performing isn't supported by the specified carrier.
+        # #/
+        CARRIER_NOT_SUPPORTED: 'carrier_not_supported',
+
+        ##
+        ## Some forms of delivery confirmation aren't supported by some carriers.
+        ## This error means that the combination of carrier and delivery confirmation
+        ## are not supported.
+        # #/
+        CONFIRMATION_NOT_SUPPORTED: 'confirmation_not_supported',
+
+        ##
+        ## This error means that two or more fields in your API request are mutually
+        ## exclusive or contain conflicting values. The error will include a fields
+        ## array that lists the conflicting fields.
+        # #/
+        FIELD_CONFLICT: 'field_conflict',
+
+        ##
+        ## A required field is missing or empty. The field_name property indicates
+        ## which field is missing. Note that some fields are conditionally required
+        ## based on the values of other fields or the type of operation being performed.
+        # #/
+        FIELD_VALUE_REQUIRED: 'field_value_required',
+
+        ##
+        ## You attempted to perform an operation that you don't have permissions to do.
+        ## Check your API key to ensure that you're using the correct one. Or contact
+        ## our support team to ensure that your account has the necessary permissions.
+        # #/
+        FORBIDDEN: 'forbidden',
+
+        ##
+        ## A few parts of the ShipEngine API allow you to provide your own ID for resources.
+        ## These IDs must be unique; otherwise you'll get this error code.
+        # #/
+        IDENTIFIER_CONFLICT: 'identifier_conflict',
+
+        ##
+        ## When updating a resource (such as a shipment or warehouse) the ID in the URL
+        ## and in the request body must match.
+        # #/
+        IDENTIFIERS_MUST_MATCH: 'identifiers_must_match',
+
+        ##
+        ## When creating a return label you can optionally pair it to an outbound_label_id.
+        ## The outbound label must be from the same carrier as the return label.
+        # #/
+        INCOMPATIBLE_PAIRED_LABELS: 'incompatible_paired_labels',
+
+        ##
+        ## The mailing address that you provided is invalid. Try using our address
+        ## validation API to verify addresses before using them.
+        # #/
+        INVALID_ADDRESS: 'invalid_address',
+
+        ##
+        ## You attempted to perform an operation that isn't allowed for your billing plan.
+        ## Contact our sales team for assistance.
+        # #/
+        INVALID_BILLING_PLAN: 'invalid_billing_plan',
+
+        ##
+        ## When creating a label or creating a return label if you set the charge_event
+        ## field to a value that isn't offered by the carrier then you will receive this
+        ## error. You can leave the charge_event field unset or set it to carrier_default
+        ## instead.
+        # #/
+        INVALID_CHARGE_EVENT: 'invalid_charge_event',
+
+        ##
+        ## One of the fields in your API request has an invalid value. The field_name
+        ## property indicates which field is invalid.
+        # #/
+        INVALID_FIELD_VALUE: 'invalid_field_value',
+
+        ##
+        ## This error is similar to invalid_field_value but is specifically for ID
+        ## fields such as label_id shipment_id carrier_id etc. The field_name
+        ## property indicates which field is invalid.
+        # #/
+        INVALID_IDENTIFIER: 'invalid_identifier',
+
+        ##
+        ## The operation you're attempting to perform is not allowed because the resource
+        ## is in the wrong status. For example if a label's status is "voided" then
+        ## it cannot be included in a manifest.
+        # #/
+        INVALID_STATUS: 'invalid_status',
+
+        ##
+        ## A string field in your API request is either too short or too long. The
+        ## field_name property indicates which field is invalid and the min_length
+        ## and max_length properties indicate the allowed length.
+        # #/
+        INVALID_STRING_LENGTH: 'invalid_string_length',
+
+        ##
+        ## Not all carriers allow you to add custom images to labels. You can only set
+        ## the label_image_id for supported carriers
+        # #/
+        LABEL_IMAGES_NOT_SUPPORTED: 'label_images_not_supported',
+
+        ##
+        ## This error indicates a problem with your FedEx account. Please contact
+        ## FedEx to resolve the issue.
+        # #/
+        METER_FAILURE: 'meter_failure',
+
+        ##
+        ## The ShipEngine API endpoint that was requested does not exist.
+        # #/
+        NOT_FOUND: 'not_found',
+
+        ##
+        ## You have exceeded a rate limit. Check the the error_source field to determine
+        ## whether the rate limit was imposed by ShipEngine or by a third-party such
+        ## as a carrier. If the rate limit is from ShipEngine then consider using bulk
+        ## operations to reduce the nuber of API calls or contact our support team
+        ## about increasing your rate limit.
+        # #/
+        RATE_LIMIT_EXCEEDED: 'rate_limit_exceeded',
+
+        ##
+        ## The API call requires a JSON request body. See the corresponding documentation
+        ## page for details about the request structure.
+        # #/
+        REQUEST_BODY_REQUIRED: 'request_body_required',
+
+        ##
+        ## You may receive this error if you attempt to schedule a pickup for a return
+        ## label.
+        # #/
+        RETURN_LABEL_NOT_SUPPORTED: 'return_label_not_supported',
+
+        ##
+        ## You may receive this error if you attempt to perform an operation that
+        ## requires a subscription. Please contact our sales department to discuss a
+        ## ShipEngine enterprise contract.
+        # #/
+        SUBSCRIPTION_INACTIVE: 'subscription_inactive',
+
+        ##
+        ## Some carriers require you to accept their terms and conditions before you
+        ## can use them via ShipEngine. If you get this error then please login to
+        ## the ShipEngine dashboard to read and accept the carrier's terms.
+        # #/
+        TERMS_NOT_ACCEPTED: 'terms_not_accepted',
+
+        ##
+        ## An API call timed out because ShipEngine did not respond within the allowed
+        ## timeframe.
+        # #/
+        TIMEOUT: 'timeout',
+
+        ##
+        ## This error will occur if you attempt to track a package for a carrier that
+        ## doesn't offer that service.
+        # #/
+        TRACKING_NOT_SUPPORTED: 'tracking_not_supported',
+
+        ##
+        ## You may receive this error if your free trial period has expired and you
+        ## have not upgraded your account or added billing information.
+        # #/
+        TRIAL_EXPIRED: 'trial_expired',
+
+        ##
+        ## Your API key is incorrect expired or missing. Check our authentication
+        ## guide to learn more about authentication with ShipEngine.
+        # #/
+        UNAUTHORIZED: 'unauthorized',
+
+        ##
+        ## This error has not yet been assigned a code. See the notes above about how
+        ## to handle these.
+        # #/
+        UNSPECIFIED: 'unspecified',
+
+        ##
+        ## When verifying your account (by email SMS phone call etc.) this error
+        ## indicates that the verification code is incorrect. Please re-start the
+        ## verification process to get a new code.
+        # #/
+        VERIFICATION_FAILURE: 'verification_failure',
+
+        ##
+        ## You attempted to perform an operation on multiple shipments from different
+        ## warehouses. Try performing separate operations for each warehouse instead.
+        # #/
+        WAREHOUSE_CONFLICT: 'warehouse_conflict',
+
+        ##
+        ## ShipEngine only allows you to have one webhook of each type. If you would
+        ## like to replace a webhook with a new one please delete the old one fir.
+        #   #/
+        WEBHOOK_EVENT_TYPE_CONFLICT: 'webhook_event_type_conflict'
+      }.freeze
+    end
+  end
+end

data/lib/shipengine/exceptions/error_type.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Exceptions
+    ##
+    ##  This class has the ability to return a specific error type.
+    # #/
+    class ErrorType
+      # @param [Symbol] key
+      # @return [Symbol] error type
+      def self.get(key)
+        @types[key]
+      end
+
+      # @param [String] str_key
+      # @return [Symbol] error type
+      def self.get_by_str(str_key)
+        get(str_key.upcase.to_sym)
+      end
+
+      @types = {
+        # There is a problem with your account. This may be your ShipEngine account
+        # or a third-party account. See the the error source to determine which
+        # account needs your attention.
+        ACCOUNT_STATUS: 'account_status',
+        # A security error will occur if your API key is invalid or expired, or if
+        # you attempt to perform an operation that is not permitted for your account.
+        SECURITY: 'security',
+        # Something is wrong with the input provided, such as missing a required field,
+        # or an illegal value or combinatio of values. This error type always means
+        # that some change needs to be made to the input before retrying.
+        VALIDATION: 'validation',
+        # There was a business rule violation. Business rules are requirements or
+        # limitations of a system. If the error source is ShipEngine, then please
+        # read the relevant documentation to find out what limitations or requirements
+        # apply. Or contact our support for help. If the error source is the carrier
+        # or order source, then ShipEngine support may still be able to help clarify
+        # the problem or propose a solution, or you may need to contact the third-party
+        # for assistance.
+        BUSINESS_RULES: 'business_rules',
+        # An unknown or unexpected error occurred in our system. Or an error occurred
+        # that has not yet been assigned a specific error_type. If you receive
+        # persistent system errors, then please contact our support or check our API
+        # status page to see if there's a known issue.
+        SYSTEM: 'system'
+      }.freeze
+    end
+  end
+end

data/lib/shipengine/exceptions.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative 'exceptions/error_code'
+require_relative 'exceptions/error_type'
+
+module ShipEngine
+  module Exceptions
+    DEFAULT_SOURCE = 'shipengine'
+    # 400 error, or other "user exceptions"
+    class ShipEngineError < StandardError
+      # message is inherited
+      attr_reader :request_id, :source, :type, :code, :url
+
+      def initialize(message:, source:, type:, code:, request_id:, url: nil) # rubocop:todo Metrics/ParameterLists
+        code = Exceptions::ErrorCode.get_by_str(code) if code.is_a?(String)
+        super(message)
+        @request_id = request_id
+        @source = source || DEFAULT_SOURCE
+        @type = type
+        @code = code
+        @url = url
+      end
+    end
+
+    # 400 error, or other "user exceptions"
+    class ValidationError < ShipEngineError
+      def initialize(message:, code:, request_id: nil, source: nil)
+        super(message:, source:, type: Exceptions::ErrorType.get(:VALIDATION), code:, request_id:)
+      end
+    end
+
+    # only create custom errors for error "types" (which encompass codes). Prefer to use generic ShipEngine errors.
+    def self.create_invalid_field_value_error(message, request_id = nil, source = nil)
+      ValidationError.new(message:, code: Exceptions::ErrorCode.get(:INVALID_FIELD_VALUE), request_id:, source:)
+    end
+
+    def self.create_required_error(field_name, request_id = nil, source = nil)
+      ValidationError.new(
+        message: "#{field_name} must be specified.",
+        code: Exceptions::ErrorCode.get(:FIELD_VALUE_REQUIRED),
+        request_id:,
+        source:
+      )
+    end
+
+    def self.create_invariant_error(message, request_id = nil)
+      SystemError.new(
+        message: "INVARIANT ERROR: #{message}",
+        code: Exceptions::ErrorCode.get(:UNSPECIFIED),
+        request_id:
+      )
+    end
+
+    class BusinessRulesError < ShipEngineError
+      def initialize(message:, code:, request_id: nil, source: nil)
+        super(message:, source:, type: Exceptions::ErrorType.get(:BUSINESS_RULES), code:, request_id:)
+      end
+    end
+
+    class AccountStatusError < ShipEngineError
+      def initialize(message:, code:, request_id: nil, source: nil)
+        super(message:, source:, type: Exceptions::ErrorType.get(:ACCOUNT_STATUS), code:, request_id:)
+      end
+    end
+
+    class SecurityError < ShipEngineError
+      def initialize(message:, code:, request_id: nil, source: nil)
+        super(message:, source:, type: Exceptions::ErrorType.get(:SECURITY), code:, request_id:)
+      end
+    end
+
+    class SystemError < ShipEngineError
+      def initialize(message:, code:, request_id: nil, source: nil, url: nil)
+        super(message:, source:, type: Exceptions::ErrorType.get(:SYSTEM), code:, request_id:, url:)
+      end
+    end
+
+    class TimeoutError < SystemError
+      def initialize(message:, source: nil, request_id: nil)
+        super(
+          message:,
+          url: URI('https://www.shipengine.com/docs/rate-limits'),
+          code: ErrorCode.get(:TIMEOUT),
+          request_id:,
+          source: source || DEFAULT_SOURCE
+        )
+      end
+    end
+
+    class RateLimitError < SystemError
+      attr_reader :retries
+
+      def initialize(retries: nil, message: 'You have exceeded the rate limit.', source: nil, request_id: nil)
+        super(
+          message:,
+          code: ErrorCode.get(:RATE_LIMIT_EXCEEDED),
+          request_id:,
+          source:,
+          url: URI('https://www.shipengine.com/docs/rate-limits'),
+        )
+        @retries = retries
+      end
+    end
+
+    def self.create_error_instance(type:, message:, code:, request_id: nil, source: nil, config: nil) # rubocop:todo Metrics/ParameterLists
+      case type
+      when Exceptions::ErrorType.get(:BUSINESS_RULES)
+        BusinessRulesError.new(message:, code:, request_id:, source:)
+      when Exceptions::ErrorType.get(:VALIDATION)
+        ValidationError.new(message:, code:, request_id:, source:)
+      when Exceptions::ErrorType.get(:ACCOUNT_STATUS)
+        AccountStatusError.new(message:, code:, request_id:, source:)
+      when Exceptions::ErrorType.get(:SECURITY)
+        SecurityError.new(message:, code:, request_id:, source:)
+      when Exceptions::ErrorType.get(:SYSTEM)
+        case code
+        when ErrorCode.get(:RATE_LIMIT_EXCEEDED)
+          RateLimitError.new(message:, request_id:, source:, retries: config.retries)
+        when ErrorCode.get(:TIMEOUT)
+          TimeoutError.new(message:, request_id:, source:)
+        else
+          SystemError.new(message:, code:, request_id:, source:)
+        end
+      else
+        ShipEngineError.new(message:, code:, request_id:, source:)
+      end
+    end
+
+    # @param error_type [String] e.g "validation"
+    # @return [BusinessRulesError, AccountStatusError, SecurityError, SystemError, ValidationError]
+  end
+end

data/lib/shipengine/internal_client.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+Dir[File.expand_path('../faraday/*.rb', __dir__)].each { |f| require f }
+require 'shipengine/utils/request_id'
+require 'shipengine/utils/user_agent'
+require 'faraday_middleware'
+require 'json'
+
+# frozen_string_literal: true
+module ShipEngine
+  class InternalClient
+    attr_reader :configuration
+
+    # @param [::ShipEngine::Configuration] configuration
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    # Perform an HTTP GET request
+    def get(path, options = {}, config = {})
+      request(:get, path, options, config)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options = {}, config = {})
+      request(:post, path, options, config)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options = {}, config = {})
+      request(:put, path, options, config)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options = {}, config = {})
+      request(:delete, path, options, config)
+    end
+
+    private
+
+    # @param config [::ShipEngine::Configuration]
+    # @return [::Faraday::Connection]
+    def create_connection(config)
+      retries = config.retries
+      base_url = config.base_url
+      api_key = config.api_key
+      timeout = config.timeout
+
+      Faraday.new(url: base_url) do |conn|
+        conn.headers = {
+          'API-Key' => api_key,
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+          'User-Agent' => Utils::UserAgent.new.to_s
+        }
+
+        conn.options.timeout = timeout / 1000
+        conn.request(:json) # auto-coerce bodies to json
+        conn.request(:retry, {
+                       max: retries,
+                       retry_statuses: [429], # even though this seems self-evident, this field is neccessary for Retry-After to be respected.
+                       methods: Faraday::Request::Retry::IDEMPOTENT_METHODS + [:post], # :post is not a "retry_attempt-able request by default"
+                       exceptions: [ShipEngine::Exceptions::RateLimitError],
+                       retry_block: proc { |env, _opts, _retries, _exception|
+                         env.request_headers['Retries'] = config.retries.to_s
+                       }
+                     })
+
+        conn.use(FaradayMiddleware::RaiseHttpException)
+        # conn.request(:retry_after_header) # should go after :retry_attempt
+        # conn.request(:request_sent, config)
+        conn.response(:json)
+      end
+    end
+
+    # Perform an HTTP request
+    def request(method, path, options, config)
+      config_with_overrides = @configuration.merge(config)
+
+      create_connection(config_with_overrides).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/utils/base58.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2009 - 2018 Douglas F Shearer
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Base58
+# Copyright (c) 2009 - 2018 Douglas F Shearer.
+# http://douglasfshearer.com
+# Distributed under the MIT license as included with this plugin.
+
+# rubocop:disable
+class Base58
+  # See https://en.wikipedia.org/wiki/Base58
+  ALPHABETS = {
+    flickr: '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ', # This is the default
+    bitcoin: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz', # Also used for IPFS
+    ripple: 'rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz'
+  }.freeze
+
+  # NOTE: If adding new alphabets of non-standard length, this should become a method.
+  BASE = ALPHABETS[:flickr].length
+
+  # Converts a base58 string to a base10 integer.
+  def self.base58_to_int(base58_val, alphabet = :flickr)
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
+
+    int_val = 0
+    base58_val.reverse.chars.each_with_index do |char, index|
+      raise ArgumentError, 'Value passed not a valid Base58 String.' if (char_index = ALPHABETS[alphabet].index(char)).nil?
+
+      int_val += char_index * (BASE**index)
+    end
+    int_val
+  end
+
+  # Converts a base10 integer to a base58 string.
+  def self.int_to_base58(int_val, alphabet = :flickr)
+    raise ArgumentError, 'Value passed is not an Integer.' unless int_val.is_a?(Integer)
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
+
+    base58_val = ''
+    while int_val >= BASE
+      mod = int_val % BASE
+      base58_val = ALPHABETS[alphabet][mod, 1] + base58_val
+      int_val = (int_val - mod) / BASE
+    end
+    ALPHABETS[alphabet][int_val, 1] + base58_val
+  end
+
+  # Converts a ASCII-8BIT (binary) encoded string to a base58 string.
+  def self.binary_to_base58(binary_val, alphabet = :flickr, include_leading_zeroes = true)
+    raise ArgumentError, 'Value passed is not a String.' unless binary_val.is_a?(String)
+    raise ArgumentError, 'Value passed is not binary.' unless binary_val.encoding == Encoding::BINARY
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
+    return int_to_base58(0, alphabet) if binary_val.empty?
+
+    if include_leading_zeroes
+      nzeroes = binary_val.bytes.find_index { |b| b != 0 } || binary_val.length - 1
+      prefix = ALPHABETS[alphabet][0] * nzeroes
+    else
+      prefix = ''
+    end
+
+    prefix + int_to_base58(binary_val.unpack1('H*').to_i(16), alphabet)
+  end
+
+  # Converts a base58 string to an ASCII-8BIT (binary) encoded string.
+  # All leading zeroes in the base58 input are preserved and converted to
+  # "\x00" in the output.
+  def self.base58_to_binary(base58_val, alphabet = :flickr)
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
+
+    nzeroes = base58_val.chars.find_index { |c| c != ALPHABETS[alphabet][0] } || base58_val.length - 1
+    prefix = nzeroes.negative? ? '' : '00' * nzeroes
+    [prefix + Private.int_to_hex(base58_to_int(base58_val, alphabet))].pack('H*')
+  end
+
+  module Private
+    def self.int_to_hex(int)
+      hex = int.to_s(16)
+      # The hex string must always consist of an even number of characters,
+      # otherwise the pack() parsing will be misaligned.
+      hex.length.even? ? hex : "0#{hex}"
+    end
+  end
+
+  class << self
+    alias encode int_to_base58
+    alias decode base58_to_int
+  end
+end
+# rubocop:enable

data/lib/shipengine/utils/pretty_print.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ShipEngine
+  module Utils
+    module PrettyPrint
+      # This will be used to add a *to_s* method override
+      # to each class that *includes* the *PrettyPrint* module.
+      # This method returns a *JSON String* so one can easily inspect
+      # the contents of a given object.
+      def to_s
+        JSON.pretty_generate(to_hash)
+      end
+
+      # This will be used to add a *to_hash* method override
+      # to each class that *includes* the *PrettyPrint* module.
+      # This will return the class attributes and their values in
+      # a *Hash*.
+      def to_hash
+        hash = {}
+        instance_variables.each do |n|
+          hash[n.to_s.delete('@')] = instance_variable_get(n)
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/shipengine/utils/request_id.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require_relative 'base58'
+
+module ShipEngine
+  module Utils
+    class RequestId
+      # @return [String] req_abcd123456789
+      def self.create
+        base58_encoded_uuid = Base58.binary_to_base58(SecureRandom.uuid.force_encoding('BINARY'))
+        "req_#{base58_encoded_uuid}"
+      end
+    end
+  end
+end