easypost 4.8.1 → 5.1.0

data/lib/easypost/shipment.rb

@@ -1,155 +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
-
-  # 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(:get, "#{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,12 +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
-end

data/lib/easypost/user.rb

@@ -1,71 +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 ApiKey objects.
-  def self.all_api_keys
-    EasyPost::ApiKey.all
-  end
-
-  # Retrieve a list of ApiKey objects of a child User.
-  def api_keys
-    api_keys = EasyPost::User.all_api_keys
-
-    if api_keys.id == id
-      my_api_keys = api_keys.keys
-    else
-      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

data/lib/easypost/webhook.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-# Each Webhook contains the url which EasyPost will notify whenever an object in our system updates. Several types of objects are processed
-# asynchronously in the EasyPost system, so whenever an object updates, an Event is sent via HTTP POST to each configured webhook URL.
-class EasyPost::Webhook < EasyPost::Resource
-  # Update a Webhook.
-  def update(params = {})
-    # NOTE: This method is redefined here since the "url" method conflicts with the objects field
-    unless id
-      raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}")
-    end
-
-    instance_url = "#{self.class.url}/#{CGI.escape(id)}"
-
-    response = EasyPost.make_request(:patch, instance_url, @api_key, params)
-    refresh_from(response, api_key)
-
-    self
-  end
-
-  # Delete a Webhook.
-  def delete
-    # NOTE: This method is redefined here since the "url" method conflicts with the objects field
-    unless id
-      raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}")
-    end
-
-    instance_url = "#{self.class.url}/#{CGI.escape(id)}"
-
-    response = EasyPost.make_request(:delete, instance_url, @api_key)
-    refresh_from(response, api_key)
-
-    self
-  end
-
-  # Validate a webhook by comparing the HMAC signature header sent from EasyPost to your shared secret.
-  # If the signatures do not match, an error will be raised signifying the webhook either did not originate
-  # from EasyPost or the secrets do not match. If the signatures do match, the `event_body` will be returned
-  # as JSON.
-  def self.validate_webhook(event_body, headers, webhook_secret)
-    easypost_hmac_signature = headers['X-Hmac-Signature']
-
-    if easypost_hmac_signature.nil?
-      raise EasyPost::Error.new('Webhook received does not contain an HMAC signature.')
-    end
-
-    encoded_webhook_secret = webhook_secret.unicode_normalize(:nfkd).encode('utf-8')
-
-    expected_signature = OpenSSL::HMAC.hexdigest('sha256', encoded_webhook_secret, event_body)
-    digest = "hmac-sha256-hex=#{expected_signature}"
-    unless digest == easypost_hmac_signature
-      raise EasyPost::Error.new('Webhook received did not originate from EasyPost or had a webhook secret mismatch.')
-    end
-
-    JSON.parse(event_body)
-  end
-end