easypost 4.8.1 → 5.1.0

data/lib/easypost/error.rb

@@ -1,32 +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?(Array) ? message.join(', ') : 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
-end

data/lib/easypost/event.rb

@@ -1,11 +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
-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

data/lib/easypost/order.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# The Order object represents a collection of packages and can be used for Multi-Piece Shipments.
-class EasyPost::Order < EasyPost::Resource
-  # Get the rates of an Order.
-  def get_rates(params = {})
-    response = EasyPost.make_request(:get, "#{url}/rates", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Buy an Order.
-  def buy(params = {})
-    if params.instance_of?(EasyPost::Rate)
-      temp = params.clone
-      params = {}
-      params[:carrier] = temp.carrier
-      params[:service] = temp.service
-    end
-
-    response = EasyPost.make_request(:post, "#{url}/buy", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Retrieve a list of Order objects.
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('Order.all not implemented.')
-  end
-
-  # Get the lowest rate of an Order (can exclude by having `'!'` as the first element of your optional filter lists).
-  def lowest_rate(carriers = [], services = [])
-    EasyPost::Util.get_lowest_object_rate(self, carriers, services)
-  end
-end

data/lib/easypost/parcel.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# Parcel objects represent the physical container being shipped.
-class EasyPost::Parcel < EasyPost::Resource
-  # Retrieving all Parcel objects is not supported.
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('Parcel.all not implemented.')
-  end
-end

data/lib/easypost/payment_method.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-# PaymentMethod objects represent a payment method of a user.
-class EasyPost::PaymentMethod < EasyPost::Resource
-  # <b>DEPRECATED:</b> Please use <tt>Billing class</tt> instead.
-  # Deprecated: v4.5.0 - v6.0.0
-  def self.all(_filters = {}, api_key = nil)
-    warn '[DEPRECATION] `all` is deprecated.  Please use `Billing.retrieve_payment_methods` instead.'
-    EasyPost::Billing.retrieve_payment_methods(api_key)
-  end
-end

data/lib/easypost/pickup.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# The Pickup object allows you to schedule a pickup from your carrier from your customer's residence or place of business.
-class EasyPost::Pickup < EasyPost::Resource
-  # Buy a Pickup.
-  def buy(params = {})
-    if params.instance_of?(EasyPost::PickupRate)
-      temp = params.clone
-      params = {}
-      params[:carrier] = temp.carrier
-      params[:service] = temp.service
-    end
-
-    response = EasyPost.make_request(:post, "#{url}/buy", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Cancel a Pickup.
-  def cancel(params = {})
-    response = EasyPost.make_request(:post, "#{url}/cancel", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Retrieve a list of all Pickup objects.
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('Pickup.all not implemented.')
-  end
-
-  # Get the lowest rate of a Pickup (can exclude by having `'!'` as the first element of your optional filter lists).
-  def lowest_rate(carriers = [], services = [])
-    EasyPost::Util.get_lowest_object_rate(self, carriers, services, 'pickup_rates')
-  end
-end

data/lib/easypost/rate.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# A Rate object contains all the details about the rate of a Shipment.
-class EasyPost::Rate < EasyPost::Resource
-  # Retrieving all Rate objects is not supported.
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('Rate.all not implemented.')
-  end
-end

data/lib/easypost/referral.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-# Referral objects are User objects created from a Partner user.
-class EasyPost::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 user. This function requires the Partner User's API key.
-  def self.create(params = {}, api_key = nil)
-    response = EasyPost.make_request(:post, '/v2/referral_customers', api_key, { user: params })
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Update a referral user. This function requires the Partner User's API key.
-  def self.update_email(email, user_id, api_key = nil)
-    wrapped_params = {
-      user: {
-        email: email,
-      },
-    }
-    EasyPost.make_request(:put, "/v2/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 users. This function requires the Partner User's API key.
-  def self.all(params = {}, api_key = nil)
-    response = EasyPost.make_request(:get, '/v2/referral_customers', api_key, params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Add credit card to a referral user. This function requires the Referral User's API key.
-  def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
-    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
-end

data/lib/easypost/report.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# A Report contains a csv that is a log of all the objects created within a certain time frame.
-class EasyPost::Report < EasyPost::Resource
-  # Create a Report.
-  def self.create(params = {}, api_key = nil)
-    url = "#{self.url}/#{params[:type]}"
-
-    wrapped_params = {}
-    wrapped_params[class_name.to_sym] = params
-
-    response = EasyPost.make_request(:post, url, api_key, params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Retrieve a list of Report objects.
-  def self.all(filters = {}, api_key = nil)
-    url = "#{self.url}/#{filters[:type]}"
-
-    response = EasyPost.make_request(:get, url, api_key, filters)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-end

data/lib/easypost/resource.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-# The Resource object is extended by each EasyPost object.
-class EasyPost::Resource < EasyPost::EasyPostObject
-  extend Enumerable
-
-  # The class name of an EasyPost object.
-  def self.class_name
-    camel = name.split('::')[-1]
-    snake = camel[0..0] + camel[1..-1].gsub(/([A-Z])/, '_\1')
-    snake.downcase
-  end
-
-  # The instance url of the Resource.
-  def self.url
-    if class_name == 'resource'
-      raise NotImplementedError.new(
-        'Resource is an abstract class. You should perform actions on its subclasses (Address, Shipment, etc.)',
-      )
-    end
-
-    if class_name[-1..-1] == 's' || class_name[-1..-1] == 'h'
-      "/v2/#{CGI.escape(class_name.downcase)}es"
-    else
-      "/v2/#{CGI.escape(class_name.downcase)}s"
-    end
-  end
-
-  # The url of the Resource.
-  def url
-    unless id
-      raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}")
-    end
-
-    "#{self.class.url}/#{CGI.escape(id)}"
-  end
-
-  # Refresh an object from the API response.
-  def refresh
-    response = EasyPost.make_request(:get, url, @api_key, @retrieve_options)
-    refresh_from(response, api_key)
-    self
-  end
-
-  # Retrieve a list of EasyPost objects.
-  def self.all(filters = {}, api_key = nil)
-    response = EasyPost.make_request(:get, url, api_key, filters)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Filter all results based on criteria.
-  def self.each(filters = {}, api_key = EasyPost.api_key, &block)
-    return to_enum(:each, filters, api_key) unless block_given?
-
-    loop do
-      page, has_more = all(filters, api_key).values
-      last = page.each(&block).last
-      break if page.empty? || !has_more
-
-      filters[:before_id] = last.id
-    end
-  end
-
-  # Retrieve an EasyPost object.
-  def self.retrieve(id, api_key = nil)
-    instance = new(id, api_key)
-    instance.refresh
-    instance
-  end
-
-  # Create an EasyPost object.
-  def self.create(params = {}, api_key = nil)
-    wrapped_params = {}
-    wrapped_params[class_name.to_sym] = params
-    response = EasyPost.make_request(:post, url, api_key, wrapped_params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Delete an EasyPost object.
-  def delete
-    response = EasyPost.make_request(:delete, url, @api_key)
-    refresh_from(response, api_key)
-    self
-  end
-
-  # Save (update) and EasyPost object.
-  def save
-    if @unsaved_values.length.positive?
-      values = {}
-      @unsaved_values.each { |k| values[k] = @values[k] }
-
-      @unsaved_values.each do |key| # rubocop:disable Style/CombinableLoops
-        value = values[key]
-        if value.is_a?(EasyPost::EasyPostObject)
-          values[key] = value.flatten_unsaved
-        end
-      end
-
-      wrapped_params = { self.class.class_name => values }
-
-      response = EasyPost.make_request(:patch, url, @api_key, wrapped_params)
-      refresh_from(response, api_key)
-    end
-    self
-  end
-end

data/lib/easypost/scan_form.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-# A ScanForm can be created to speed up and simplify the carrier pickup process. The ScanForm is one document that can
-# be scanned to mark all included tracking codes as "Accepted for Shipment" by the carrier.
-class EasyPost::ScanForm < EasyPost::Resource
-  # Create a ScanForm.
-  def self.create(params = {}, api_key = nil)
-    response = EasyPost.make_request(:post, url, api_key, params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-end