easypost 4.13.1 → 5.0.0

data/lib/easypost/pickup.rb

@@ -1,47 +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
-
-  # 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
-
-  # Get the next page of pickups.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.pickups, 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/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,117 +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 customer. 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 customer. 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 customers. 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
-
-  # Get the next page of referral customers.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.referral_customers, 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
-
-  # Add credit card to a referral customer. This function requires the Referral Customer'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/refund.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# The Refund object contains details about the Refund of a Shipment.
-class EasyPost::Refund < EasyPost::Resource
-  # Get the next page of refunds.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.refunds, 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/report.rb

@@ -1,44 +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)
-    collection = EasyPost::Util.convert_to_easypost_object(response, api_key)
-
-    # Store the filters used to retrieve the collection.
-    collection.refresh_from({ type: filters[:type] }, api_key)
-
-    collection
-  end
-
-  # Get the next page of addresses.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.reports, 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[:type] = collection.type
-    params
-  end
-end

data/lib/easypost/resource.rb

@@ -1,124 +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
-
-  # Build the next page parameters and call the next page function.
-  def self.get_next_page_exec(api_func, collection, current_page_items, page_size = nil)
-    has_more = collection.has_more || false
-    unless !has_more || current_page_items.nil? || current_page_items.empty?
-      # if no issues, then we can get the next page
-      params = build_next_page_params(collection, current_page_items, page_size)
-      return api_func.call(params)
-    end
-
-    # issue with getting the next page
-    raise EasyPost::Error.new('There are no more pages to retrieve.')
-  end
-
-  # Build the next page parameters. This is a stub method that should be overridden by the child class.
-  def self.build_next_page_params(_collection, _current_page_items, _page_size = nil)
-    {}
-  end
-end

data/lib/easypost/scan_form.rb

@@ -1,26 +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
-
-  # Get the next page of scan forms.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.scan_forms, 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/shipment.rb

@@ -1,186 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-# The workhorse of the EasyPost API, a Shipment is made up of a "to" and "from" Address, the Parcel
-# being shipped, and any customs forms required for international deliveries.
-class EasyPost::Shipment < EasyPost::Resource
-  # Create a Shipment.
-  def self.create(params = {}, api_key = nil, with_carbon_offset = false)
-    wrapped_params = {
-      shipment: params,
-      carbon_offset: with_carbon_offset,
-    }
-
-    response = EasyPost.make_request(:post, url, api_key, wrapped_params)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Regenerate the rates of a Shipment.
-  def regenerate_rates(with_carbon_offset = false)
-    params = {}
-    params[:carbon_offset] = with_carbon_offset
-
-    response = EasyPost.make_request(:post, "#{url}/rerate", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Get the SmartRates of a Shipment.
-  def get_smartrates # rubocop:disable Naming/AccessorMethodName
-    response = EasyPost.make_request(:get, "#{url}/smartrate", @api_key)
-
-    response.fetch('result', [])
-  end
-
-  # Retrieve a list of Shipment objects.
-  def self.all(filters = {}, api_key = nil)
-    collection = super(filters, api_key)
-
-    # Store the filters used to retrieve the collection.
-    collection.refresh_from({ include_children: filters[:include_children], purchased: filters[:purchased] }, api_key)
-
-    collection
-  end
-
-  # Get the next page of shipments.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.shipments, 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
-    unless collection.include_children.nil?
-      params[:include_children] = collection.include_children
-    end
-    unless collection.purchased.nil?
-      params[:purchased] = collection.purchased
-    end
-    params
-  end
-
-  # Buy a Shipment.
-  def buy(params = {}, with_carbon_offset = false, end_shipper_id = nil)
-    if params.instance_of?(EasyPost::Rate)
-      temp = params.clone
-      params = {}
-      params[:rate] = temp
-    end
-
-    if params[:with_carbon_offset]
-      params[:carbon_offset] = params[:with_carbon_offset]
-      params.delete(:with_carbon_offset)
-    else
-      params[:carbon_offset] = with_carbon_offset
-    end
-
-    if end_shipper_id
-      params[:end_shipper_id] = end_shipper_id
-    end
-
-    response = EasyPost.make_request(:post, "#{url}/buy", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Insure a Shipment.
-  def insure(params = {})
-    if params.is_a?(Integer) || params.is_a?(Float)
-      temp = params.clone
-      params = {}
-      params[:amount] = temp
-    end
-
-    response = EasyPost.make_request(:post, "#{url}/insure", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Refund a Shipment.
-  def refund(params = {})
-    response = EasyPost.make_request(:post, "#{url}/refund", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Convert the label format of a Shipment.
-  def label(params = {})
-    if params.is_a?(String)
-      temp = params.clone
-      params = {}
-      params[:file_format] = temp
-    end
-
-    response = EasyPost.make_request(:get, "#{url}/label", @api_key, params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-
-  # Get the lowest rate of a Shipment (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
-
-  # Get the lowest smartrate of a Shipment.
-  def lowest_smartrate(delivery_days, delivery_accuracy)
-    smartrates = get_smartrates
-    EasyPost::Shipment.get_lowest_smartrate(smartrates, delivery_days, delivery_accuracy)
-  end
-
-  # Get the lowest smartrate from a list of smartrates.
-  def self.get_lowest_smartrate(smartrates, delivery_days, delivery_accuracy)
-    valid_delivery_accuracy_values = Set[
-      'percentile_50',
-      'percentile_75',
-      'percentile_85',
-      'percentile_90',
-      'percentile_95',
-      'percentile_97',
-      'percentile_99',
-    ]
-    lowest_smartrate = nil
-
-    unless valid_delivery_accuracy_values.include?(delivery_accuracy.downcase)
-      raise EasyPost::Error.new("Invalid delivery accuracy value, must be one of: #{valid_delivery_accuracy_values}")
-    end
-
-    smartrates.each do |rate|
-      next if rate['time_in_transit'][delivery_accuracy] > delivery_days.to_i
-
-      if lowest_smartrate.nil? || rate['rate'].to_f < lowest_smartrate['rate'].to_f
-        lowest_smartrate = rate
-      end
-    end
-
-    if lowest_smartrate.nil?
-      raise EasyPost::Error.new('No rates found.')
-    end
-
-    lowest_smartrate
-  end
-
-  # Generate a form for a Shipment.
-  def generate_form(form_type, form_options = {})
-    params = {}
-    params[:type] = form_type
-    merged_params = params.merge(form_options)
-    wrapped_params = {
-      form: merged_params,
-    }
-
-    response = EasyPost.make_request(:post, "#{url}/forms", @api_key, wrapped_params)
-    refresh_from(response, @api_key)
-
-    self
-  end
-end

data/lib/easypost/tracker.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-# A Tracker object contains all of the tracking information for a package.
-class EasyPost::Tracker < EasyPost::Resource
-  # Create multiple Tracker objects in bulk.
-  def self.create_list(params = {}, api_key = nil)
-    url = "#{self.url}/create_list"
-    new_params = { 'trackers' => params }
-    EasyPost.make_request(:post, url, api_key, new_params)
-    true # This endpoint does not return a response so we return true here instead
-  end
-
-  # Retrieve a list of Tracker objects.
-  def self.all(filters = {}, api_key = nil)
-    collection = super(filters, api_key)
-
-    # Store the filters used to retrieve the collection.
-    collection.refresh_from({ tracking_code: filters[:tracking_code], carrier: filters[:carrier] }, api_key)
-
-    collection
-  end
-
-  # Get the next page of trackers.
-  def self.get_next_page(collection, page_size = nil)
-    get_next_page_exec(method(:all), collection, collection.trackers, 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
-    unless collection.tracking_code.nil?
-      params[:tracking_code] = collection.tracking_code
-    end
-    unless collection.carrier.nil?
-      params[:carrier] = collection.carrier
-    end
-    params
-  end
-end

data/lib/easypost/user.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-# The User object can be used to manage your own account and to create child accounts.
-class EasyPost::User < EasyPost::Resource
-  # Create a child User.
-  def self.create(params = {}, api_key = nil)
-    response = EasyPost.make_request(:post, url, api_key, { class_name.to_sym => params })
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
-
-  # Save (update) a User.
-  def save
-    if @unsaved_values.length.positive?
-      values = {}
-      @unsaved_values.each { |k| values[k] = @values[k] }
-
-      wrapped_params = { user: values }
-
-      response = EasyPost.make_request(:patch, url, @api_key, wrapped_params)
-      refresh_from(response, api_key)
-    end
-    self
-  end
-
-  # Delete a User.
-  def delete
-    EasyPost.make_request(:delete, url, @api_key)
-    self
-  end
-
-  # Retrieve the authenticated User.
-  def self.retrieve_me
-    all
-  end
-
-  # Retrieve a list of all ApiKey objects.
-  def self.all_api_keys
-    EasyPost::ApiKey.all
-  end
-
-  # Retrieve a list of ApiKey objects (works for the authenticated user or a child user).
-  def api_keys
-    api_keys = EasyPost::User.all_api_keys
-
-    if api_keys.id == id
-      # This function was called on the authenticated user
-      my_api_keys = api_keys.keys
-    else
-      # This function was called on a child user (authenticated as parent, only return this child user's details).
-      my_api_keys = []
-      api_keys.children.each do |child|
-        if child.id == id
-          my_api_keys = child.keys
-          break
-        end
-      end
-    end
-
-    my_api_keys
-  end
-
-  # Update the Brand of a User.
-  def update_brand(**attrs)
-    brand = EasyPost::Brand.new
-    data = { object: 'Brand', user_id: id, **attrs }
-    # Add accessors manually because there's no API to retrieve a brand
-    brand.add_accessors(data.keys)
-    # Assigning values with accessors defined above
-    data.each do |key, val|
-      brand.send("#{key}=", val)
-    end
-    brand.save
-  end
-end