easypost 4.13.1 → 5.0.1

data/lib/easypost/beta/end_shipper.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-# EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon creation.
-class EasyPost::Beta::EndShipper < EasyPost::Resource
-  # Create an EndShipper object.
-  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
-  def self.create(params = {}, api_key = nil)
-    warn '[DEPRECATION] Please use `EndShipper.create` in the main namespace instead.'
-    response = EasyPost.make_request(:post, '/beta/end_shippers', api_key, { address: params })
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Retrieves an EndShipper object.
-  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
-  def self.retrieve(id, params = {}, api_key = nil)
-    warn '[DEPRECATION] Please use `EndShipper.retrieve` in the main namespace instead.'
-    response = EasyPost.make_request(:get, "/beta/end_shippers/#{id}", api_key, params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Retrieves a list of EndShipper objects.
-  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
-  def self.all(params = {}, api_key = nil)
-    warn '[DEPRECATION] Please use `EndShipper.all` in the main namespace instead.'
-    response = EasyPost.make_request(:get, '/beta/end_shippers', api_key, params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Updates (saves) an EndShipper object. This requires all parameters to be set.
-  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
-  def save
-    warn '[DEPRECATION] Please use `endShipper.save` in the main namespace instead.'
-    if @unsaved_values.length.positive?
-      values = {}
-      @unsaved_values.each { |k| values[k] = @values[k] }
-
-      wrapped_params = { address: values }
-
-      response = EasyPost.make_request(:put, "/beta/end_shippers/#{id}", @api_key, wrapped_params)
-      refresh_from(response, api_key)
-    end
-    self
-  end
-end

data/lib/easypost/beta/payment_refund.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-# PaymentRefund objects represent a refund of a payment.
-class EasyPost::Beta::PaymentRefund < EasyPost::Resource
-end

data/lib/easypost/beta/rate.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# A Rate object contains all the details about the rate of a Shipment.
-class EasyPost::Beta::Rate < EasyPost::Resource
-  # Retrieve a list of stateless rates.
-  def self.retrieve_stateless_rates(params = {}, api_key = nil)
-    wrapped_params = {
-      shipment: params,
-    }
-
-    response = EasyPost.make_request(:post, '/beta/rates', api_key, wrapped_params)
-    EasyPost::Util.convert_to_easypost_object(response['rates'], api_key)
-  end
-end

data/lib/easypost/beta/referral.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-# Referral objects are User objects created from a Partner user.
-class EasyPost::Beta::Referral < EasyPost::Resource
-  class << self
-    protected
-
-    # Retrieve EasyPost's Stripe public API key.
-    def retrieve_easypost_stripe_api_key
-      response = EasyPost.make_request(:get, '/beta/partners/stripe_public_key', @api_key)
-      response['public_key']
-    end
-
-    # Get credit card token from Stripe.
-    def create_stripe_token(number, expiration_month, expiration_year,
-                            cvc, easypost_stripe_token)
-      headers = {
-        # This Stripe endpoint only accepts URL form encoded bodies.
-        Authorization: "Bearer #{easypost_stripe_token}",
-        'Content-type': 'application/x-www-form-urlencoded',
-      }
-
-      credit_card_hash = {
-        card: {
-          number: number,
-          exp_month: expiration_month,
-          exp_year: expiration_year,
-          cvc: cvc,
-        },
-      }
-
-      form_encoded_params = EasyPost::Util.form_encode_params(credit_card_hash)
-
-      uri = URI.parse('https://api.stripe.com/v1/tokens')
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      request = Net::HTTP::Post.new(uri.request_uri, headers)
-      query = URI.encode_www_form(form_encoded_params)
-
-      response = http.request(request, query)
-      response_json = JSON.parse(response.body)
-      response_json['id']
-    end
-
-    # Submit Stripe credit card token to EasyPost.
-    def create_easypost_credit_card(referral_api_key, stripe_object_id, priority = 'primary')
-      wrapped_params = {
-        credit_card: {
-          stripe_object_id: stripe_object_id,
-          priority: priority,
-        },
-      }
-      response = EasyPost.make_request(:post, '/beta/credit_cards', referral_api_key, wrapped_params)
-      EasyPost::Util.convert_to_easypost_object(response, referral_api_key)
-    end
-  end
-
-  # Create a referral customer. This function requires the Partner User's API key.
-  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
-  def self.create(params = {}, api_key = nil)
-    warn '[DEPRECATION] Please use `Referral.create` in the main namespace instead.'
-    response = EasyPost.make_request(:post, '/beta/referral_customers', api_key, { user: params })
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Update a referral customer. This function requires the Partner User's API key.
-  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
-  def self.update_email(email, user_id, api_key = nil)
-    warn '[DEPRECATION] Please use `Referral.update_email` in the main namespace instead.'
-    wrapped_params = {
-      user: {
-        email: email,
-      },
-    }
-    EasyPost.make_request(:put, "/beta/referral_customers/#{user_id}", api_key, wrapped_params)
-
-    # return true if API succeeds, else an error is throw if it fails.
-    true
-  end
-
-  # Retrieve a list of referral customers. This function requires the Partner User's API key.
-  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
-  def self.all(params = {}, api_key = nil)
-    warn '[DEPRECATION] Please use `Referral.all` in the main namespace instead.'
-    response = EasyPost.make_request(:get, '/beta/referral_customers', api_key, params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Add credit card to a referral customer. This function requires the Referral Customer's API key.
-  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
-  def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
-    warn '[DEPRECATION] Please use `Referral.add_credit_card` in the main namespace instead.'
-    easypost_stripe_api_key = retrieve_easypost_stripe_api_key
-
-    begin
-      stripe_credit_card_token = create_stripe_token(
-        number,
-        expiration_month,
-        expiration_year,
-        cvc,
-        easypost_stripe_api_key,
-      )
-    rescue StandardError
-      raise EasyPost::Error.new('Could not send card details to Stripe, please try again later.')
-    end
-
-    response = create_easypost_credit_card(referral_api_key, stripe_credit_card_token, priority)
-    EasyPost::Util.convert_to_easypost_object(response, referral_api_key)
-  end
-
-  # Add a Stripe payment method to a Referral Customer. This function requires the Referral Customer's API key.
-  # @param [String] stripe_customer_id Unique customer ID provided by Stripe.
-  # @param [String] payment_method_reference ID of the card or bank account provided by Stripe.
-  # @param [String] payment_method_type Which priority to save this payment method as on EasyPost, either 'primary' or 'secondary'.
-  # @param [String] api_key Override the API key used for this request.
-  # @return [EasyPost::PaymentMethod] The newly-added payment method.
-  # noinspection RubyParameterNamingConvention
-  def self.add_payment_method(stripe_customer_id, payment_method_reference, priority = 'primary', api_key = nil)
-    wrapped_params = {
-      payment_method: {
-        stripe_customer_id: stripe_customer_id,
-        payment_method_reference: payment_method_reference,
-        priority: priority.downcase,
-      },
-    }
-    response = EasyPost.make_request(:post, '/beta/referral_customers/payment_method', api_key, wrapped_params)
-    # noinspection RubyMismatchedReturnType
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Refund a Referral Customer's wallet by a specified amount. Refund will be issued to the user's original payment method.
-  # This function requires the Referral Customer's API key.
-  # @param [Integer] amount The amount to refund, in cents.
-  # @param [String] api_key Override the API key used for this request.
-  # @return [EasyPost::Beta::PaymentRefund] The newly-created refund.
-  def self.refund_by_amount(amount, api_key = nil)
-    params = {
-      refund_amount: amount,
-    }
-    response = EasyPost.make_request(:post, '/beta/referral_customers/refunds', api_key, params)
-    # noinspection RubyMismatchedReturnType
-    EasyPost::Util.convert_to_easypost_object(response, api_key) # TODO: Needs "object" or ID prefix to determine object class.
-  end
-
-  # Refund a Referral Customer's wallet for a specified payment log entry. Refund will be issued to the user's original payment method.
-  # This function requires the Referral Customer's API key.
-  # @param [String] payment_log_id Payment log ID to refund.
-  # @param [String] api_key Override the API key used for this request.
-  # @return [EasyPost::Beta::PaymentRefund] The newly-created refund.
-  def self.refund_by_payment_log(payment_log_id, api_key = nil)
-    params = {
-      payment_log_id: payment_log_id,
-    }
-    response = EasyPost.make_request(:post, '/beta/referral_customers/refunds', api_key, params)
-    # noinspection RubyMismatchedReturnType
-    EasyPost::Util.convert_to_easypost_object(response, api_key) # TODO: Needs "object" or ID prefix to determine object class.
-  end
-end

data/lib/easypost/beta.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module EasyPost::Beta
-end
-
-require_relative 'beta/end_shipper'
-require_relative 'beta/referral'
-require_relative 'beta/rate'

data/lib/easypost/billing.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-# Billing class that users can manage their payment and fund
-class EasyPost::Billing < EasyPost::Resource
-  class << self
-    protected
-
-    # Get payment method info (type of the payment method and ID of the payment method)
-    def get_payment_method_info(priority)
-      payment_methods = EasyPost::Billing.retrieve_payment_methods
-      payment_method_map = {
-        'primary' => 'primary_payment_method',
-        'secondary' => 'secondary_payment_method',
-      }
-
-      payment_method_to_use = payment_method_map[priority]
-
-      error_string = 'The chosen payment method is not valid. Please try again.'
-      raise EasyPost::Error.new(error_string) if payment_methods[payment_method_to_use].nil?
-
-      payment_method_id = payment_methods[payment_method_to_use]['id']
-
-      unless payment_method_id.nil?
-        if payment_method_id.start_with?('card_')
-          endpoint = '/v2/credit_cards'
-        elsif payment_method_id.start_with?('bank_')
-          endpoint = '/v2/bank_accounts'
-        else
-          raise EasyPost::Error.new(error_string)
-        end
-      end
-
-      [endpoint, payment_method_id]
-    end
-  end
-
-  # Fund your EasyPost wallet by charging your primary or secondary card on file.
-  def self.fund_wallet(amount, priority = 'primary', api_key = nil)
-    payment_info = get_payment_method_info(priority.downcase)
-    endpoint = payment_info[0]
-    payment_id = payment_info[1]
-
-    wrapped_params = { amount: amount }
-    EasyPost.make_request(:post, "#{endpoint}/#{payment_id}/charges", api_key, wrapped_params)
-
-    # Return true if succeeds, an error will be thrown if it fails
-    true
-  end
-
-  # Delete a payment method.
-  def self.delete_payment_method(priority, api_key = nil)
-    payment_info = get_payment_method_info(priority.downcase)
-    endpoint = payment_info[0]
-    payment_id = payment_info[1]
-
-    EasyPost.make_request(:delete, "#{endpoint}/#{payment_id}", api_key)
-
-    # Return true if succeeds, an error will be thrown if it fails
-    true
-  end
-
-  # Retrieve all payment methods.
-  def self.retrieve_payment_methods(api_key = nil)
-    response = EasyPost.make_request(:get, '/v2/payment_methods', api_key)
-
-    if response['id'].nil?
-      raise EasyPost::Error.new('Billing has not been setup for this user. Please add a payment method.')
-    end
-
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-end

data/lib/easypost/brand.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# The Brand object allows you to customize the publicly-accessible html page that shows tracking details for every EasyPost tracker.
-class EasyPost::Brand < EasyPost::Resource
-  # The url of the Brand object.
-  def url
-    if user_id.nil? || user_id.empty?
-      raise EasyPost::Error, "Missing user_id: #{self.class} instance is missing user_id"
-    end
-
-    "#{::EasyPost::User.url}/#{CGI.escape(user_id)}/brand"
-  end
-end

data/lib/easypost/carrier_account.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# A CarrierAccount encapsulates your credentials with the carrier.
-class EasyPost::CarrierAccount < EasyPost::Resource
-  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[UpsAccount FedexAccount].freeze
-
-  # Retrieve a list of available CarrierAccount types for the authenticated User.
-  def self.types
-    EasyPost::CarrierType.all
-  end
-
-  def self.create(params = {}, api_key = nil)
-    wrapped_params = {}
-    wrapped_params[class_name.to_sym] = params
-
-    # For Ups and Fedex the endpoint is different
-    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(params[:type])
-                   "#{url}/register"
-                 else
-                   url
-                 end
-
-    response = EasyPost.make_request(:post, create_url, api_key, wrapped_params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-end

data/lib/easypost/carrier_type.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-# The CarrierType object provides an interface for determining the valid fields of a CarrierAccount.
-class EasyPost::CarrierType < EasyPost::Resource
-end

data/lib/easypost/customs_info.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs forms required for international shipping.
-class EasyPost::CustomsInfo < EasyPost::Resource
-  # Retrieve a list of CustomsInfo objects
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('CustomsInfo.all not implemented.')
-  end
-end

data/lib/easypost/customs_item.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# A CustomsItem object describes goods for international shipment and should be created then included in a CustomsInfo object.
-class EasyPost::CustomsItem < EasyPost::Resource
-  # Retrieve a list of CustomsItem objects
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('CustomsItem.all not implemented.')
-  end
-end

data/lib/easypost/end_shipper.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon creation.
-class EasyPost::EndShipper < EasyPost::Resource
-  # Create an EndShipper object.
-  def self.create(params = {}, api_key = nil)
-    response = EasyPost.make_request(:post, url, api_key, { address: params })
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Updates (saves) an EndShipper object. This requires all parameters to be set.
-  def save
-    if @unsaved_values.length.positive?
-      values = {}
-      @unsaved_values.each { |k| values[k] = @values[k] }
-
-      wrapped_params = { address: values }
-
-      response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
-      refresh_from(response, api_key)
-    end
-    self
-  end
-
-  # TODO: Add support for getting the next page of end shippers when the API supports it.
-end

data/lib/easypost/error.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-# EasyPost Error object.
-class EasyPost::Error < StandardError
-  attr_reader :message, :status, :http_body, :code, :errors
-
-  # Initialize a new EasyPost Error
-  def initialize(message = nil, status = nil, code = nil, errors = nil, http_body = nil)
-    # message should be a string but can sometimes incorrectly come back as an array
-    @message = message.is_a?(String) ? message : EasyPost::Error.traverse_json_element(message, [])
-    @status = status
-    @code = code
-    @errors = errors
-    @http_body = http_body
-
-    super(message)
-  end
-
-  # Convert an error to a string.
-  def to_s
-    "#{code} (#{status}): #{message} #{errors}".strip
-  end
-
-  # Compare error properties.
-  def ==(other)
-    other.is_a?(EasyPost::Error) &&
-      message == other.message &&
-      status == other.status &&
-      code == other.code &&
-      errors == other.errors
-  end
-
-  # Recursively traverses a JSON element to extract error messages and returns them as a comma-separated string.
-  def self.traverse_json_element(error_message, messages_list)
-    case error_message
-    when Hash
-      error_message.each_value { |value| traverse_json_element(value, messages_list) }
-    when Array
-      error_message.each { |value| traverse_json_element(value, messages_list) }
-    else
-      messages_list.push(error_message.to_s)
-    end
-
-    messages_list.join(', ')
-  end
-end

data/lib/easypost/event.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-# Webhook Events are triggered by changes in objects you've created via the API.
-class EasyPost::Event < EasyPost::Resource
-  # Converts a raw webhook event into an EasyPost object.
-  def self.receive(values)
-    EasyPost::Util.convert_to_easypost_object(JSON.parse(values), nil)
-  end
-
-  # Retrieve all payloads for an event.
-  def retrieve_all_payloads(api_key = nil)
-    response = EasyPost.make_request(:get, "#{url}/payloads", api_key)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Retrieve a specific payload for an event.
-  def retrieve_payload(payload_id, api_key = nil)
-    response = EasyPost.make_request(:get, "#{url}/payloads/#{payload_id}", api_key)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Get the next page of events.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.events, page_size)
-  end
-
-  # Build the next page parameters.
-  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
-    params = {}
-    params[:before_id] = current_page_items.last.id
-    unless page_size.nil?
-      params[:page_size] = page_size
-    end
-    params
-  end
-end

data/lib/easypost/insurance.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# An Insurance object represents insurance for packages purchased both via the EasyPost API as well
-# as shipments purchased through third parties and later registered with EasyPost.
-class EasyPost::Insurance < EasyPost::Resource
-  # Get the next page of insurances.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.insurances, page_size)
-  end
-
-  # Build the next page parameters.
-  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
-    params = {}
-    params[:before_id] = current_page_items.last.id
-    unless page_size.nil?
-      params[:page_size] = page_size
-    end
-    params
-  end
-end

data/lib/easypost/object.rb

@@ -1,171 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-# The EasyPostObject is extended by the EasyPost Resource object.
-class EasyPost::EasyPostObject
-  include Enumerable
-
-  attr_accessor :parent, :name, :api_key, :unsaved_values
-
-  @@immutable_values = Set.new([:api_key, :id]) # rubocop:disable Style/ClassVars
-
-  # Initialize an EasyPostObject.
-  def initialize(id = nil, api_key = nil, parent = nil, name = nil)
-    @api_key = api_key
-    @values = {}
-    @unsaved_values = Set.new
-    @transient_values = Set.new
-    @parent = parent
-    @name = name
-    self.id = id if id
-  end
-
-  # Construct an object from values.
-  def self.construct_from(values, api_key = nil, parent = nil, name = nil)
-    obj = new(values[:id], api_key, parent, name)
-    obj.refresh_from(values, api_key)
-    obj
-  end
-
-  # Convert to a string.
-  def to_s(*_args)
-    JSON.dump(@values)
-  end
-
-  # Inspect JSON.
-  def inspect
-    id_string = respond_to?(:id) && !id.nil? ? " id=#{id}" : ''
-    "#<#{self.class}:#{id_string}> JSON: " + to_json
-  end
-
-  # Refresh an object from the API.
-  def refresh_from(values, api_key)
-    @api_key = api_key
-
-    added = Set.new(values.keys - @values.keys)
-
-    instance_eval do
-      add_accessors(added)
-    end
-
-    # IDs should never change. But to be safe, only delete if they are different.
-    @values.delete(:id) if values[:id] != @values[:id]
-
-    values.each do |k, v|
-      @values[k.to_s] = EasyPost::Util.convert_to_easypost_object(v, api_key, self, k)
-      @transient_values.delete(k)
-      @unsaved_values.delete(k)
-    end
-
-    return if @values[:id] || (values[:id].nil? && values['id'].nil?)
-
-    @values[:id] = values[:id] || values['id']
-  end
-
-  # Get element of an array.
-  def [](key)
-    @values[key.to_s]
-  end
-
-  # Set the element of an array.
-  def []=(key, value)
-    send(:"#{key}=", value)
-  end
-
-  # Keys of an object.
-  def keys
-    @values.keys
-  end
-
-  # Values of an object.
-  def values
-    @values.values
-  end
-
-  # Make values JSON.
-  def to_json(_options = {})
-    JSON.dump(@values)
-  end
-
-  # Get values as JSON.
-  def as_json(_options = {})
-    @values.as_json
-  end
-
-  # Make values a hash.
-  def to_hash
-    @values
-  end
-
-  # Deconstruct the keys of an object.
-  def deconstruct_keys(_keys)
-    @values.transform_keys(&:to_sym)
-  end
-
-  # Get each element of values.
-  def each(&blk)
-    @values.each(&blk)
-  end
-
-  # Set the ID of an object.
-  def id=(id)
-    @values[:id] = id
-  end
-
-  # Get the ID of an object.
-  def id
-    @values[:id]
-  end
-
-  protected
-
-  # Flatten the unsaved values of an object.
-  def flatten_unsaved
-    values = {}
-    @unsaved_values.each do |key|
-      value = @values[key]
-
-      values[key] = value
-
-      if value.is_a?(EasyPost::EasyPostObject)
-        values[key] = flatten_unsaved(value)
-      end
-    end
-
-    values
-  end
-
-  # The metaclass of an object.
-  def metaclass
-    class << self; self; end
-  end
-
-  # Add accessors of an object.
-  def add_accessors(keys)
-    metaclass.instance_eval do
-      keys.each do |k|
-        next if @@immutable_values.include?(k)
-
-        k = k.to_s
-        k_eq = :"#{k}="
-        define_method(k) { @values[k] }
-        define_method(k_eq) do |v|
-          @values[k] = v
-          @unsaved_values.add(k)
-
-          cur = self
-          cur_parent = parent
-          while cur_parent
-            if cur.name
-              cur_parent.unsaved_values.add(cur.name)
-            end
-
-            cur = cur_parent
-            cur_parent = cur.parent
-          end
-        end
-      end
-    end
-  end
-end