Class: FriendlyShipping::ShipmentOptions

Inherits:

Object

• Object
• FriendlyShipping::ShipmentOptions

Defined in:

lib/friendly_shipping/shipment_options.rb

Overview

Base class for shipment options. Used when serializing API requests.

Direct Known Subclasses

FriendlyShipping::Services::RL::BOLOptions, FriendlyShipping::Services::RL::ShipmentOptions, FriendlyShipping::Services::ShipEngine::LabelOptions, FriendlyShipping::Services::ShipEngine::RateEstimatesOptions, FriendlyShipping::Services::ShipEngine::RatesOptions, FriendlyShipping::Services::ShipEngineLTL::QuoteOptions, FriendlyShipping::Services::ShipEngineLTL::ShipmentOptions, FriendlyShipping::Services::TForceFreight::BOLOptions, FriendlyShipping::Services::TForceFreight::PickupOptions, FriendlyShipping::Services::TForceFreight::RatesOptions, FriendlyShipping::Services::TForceFreight::ShipmentOptions, FriendlyShipping::Services::USPSShip::RateEstimateOptions, FriendlyShipping::Services::Ups::LabelOptions, FriendlyShipping::Services::Ups::RateEstimateOptions, FriendlyShipping::Services::UpsFreight::RatesOptions, FriendlyShipping::Services::UpsFreight::ShipmentOptions, FriendlyShipping::Services::UpsJson::LabelOptions, FriendlyShipping::Services::UpsJson::RatesOptions, FriendlyShipping::Services::Usps::RateEstimateOptions, FriendlyShipping::Services::UspsInternational::RateEstimateOptions

Instance Method Summary

• #initialize(package_options: Set.new, package_options_class: PackageOptions) ⇒ ShipmentOptions constructor

  A new instance of ShipmentOptions.

• #options_for_package(package) ⇒ PackageOptions

  Finds and returns package options for the given item.

Constructor Details

#initialize(package_options: Set.new, package_options_class: PackageOptions) ⇒ ShipmentOptions

Returns a new instance of ShipmentOptions.

Parameters:

• package_options (Array<PackageOptions>) (defaults to: Set.new) —

  the options for packages in this shipment

• package_options_class (Class) (defaults to: PackageOptions) —

  the class to use for package options when none are provided

# File 'lib/friendly_shipping/shipment_options.rb', line 8

def initialize(
  package_options: Set.new,
  package_options_class: PackageOptions
)
  @package_options = package_options
  @package_options_class = package_options_class
end

Instance Method Details

#options_for_package(package) ⇒ PackageOptions

Finds and returns package options for the given item. If options cannot be found, the package_options_class is used to construct new options.

Parameters:

• package (#id) —

  the package for which to get options

Returns:

• (PackageOptions)

# File 'lib/friendly_shipping/shipment_options.rb', line 21

def options_for_package(package)
  package_options.detect do |package_option|
    package_option.package_id == package.id
  end || package_options_class.new(package_id: nil)
end