friendly_shipping 0.8.1 → 0.10.0

data/lib/friendly_shipping/shipping_method.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
+  # Represents a shipping method (UPS Ground, USPS Priority, etc.) that belongs to a {Carrier}.
   class ShippingMethod
-    attr_reader :name, :service_code, :carrier, :origin_countries, :data
-
-    # @param [String] name The shipping method's name
-    # @param [String] service_code The shipping method's service code
-    # @param [Boolean] domestic Whether this is a domestic shipping method
-    # @param [Boolean] international Whether this is an international shipping method
-    # @param [Boolean] multi_package Whether this is a multi-package shipping method
-    # @param [FriendlyShipping::Carrier] carrier This shipping method's carrier
-    # @param [Array] origin_countries Countries this shipping method ships from
-    # @param [Hash] data Additional carrier-specific data for this shipping method
+    # @return [String] the shipping method's name
+    attr_reader :name
+
+    # @return [String] the shipping method's service code
+    attr_reader :service_code
+
+    # @return [Carrier] this shipping method's carrier
+    attr_reader :carrier
+
+    # @return [Array<String>] countries this shipping method ships from
+    attr_reader :origin_countries
+
+    # @return [Hash] additional carrier-specific data for this shipping method
+    attr_reader :data
+
+    # @param name [String] the shipping method's name
+    # @param service_code [String] the shipping method's service code
+    # @param domestic [Boolean] whether this is a domestic shipping method
+    # @param international [Boolean] whether this is an international shipping method
+    # @param multi_package [Boolean] whether this is a multi-package shipping method
+    # @param carrier [Carrier] this shipping method's carrier
+    # @param origin_countries [Array] countries this shipping method ships from
+    # @param data [Hash] additional carrier-specific data for this shipping method
     def initialize(
       name: nil,
       service_code: nil,
@@ -32,20 +46,33 @@ module FriendlyShipping
       @data = data
     end
 
+    # Returns true if this is a domestic shipping method.
+    # @return [Boolean]
     def domestic?
       !!domestic
     end
 
+    # Returns true if this is an international shipping method.
+    # @return [Boolean]
     def international?
       !!international
     end
 
+    # Returns true if this shipping method supports multiple packages.
+    # @return [Boolean]
     def multi_package?
       !!multi_package
     end
 
     private
 
-    attr_reader :domestic, :international, :multi_package
+    # @return [Boolean]
+    attr_reader :domestic
+
+    # @return [Boolean]
+    attr_reader :international
+
+    # @return [Boolean]
+    attr_reader :multi_package
   end
 end

data/lib/friendly_shipping/structure_options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  # Options for structures (pallets, skids, etc) in a shipment.
+  class StructureOptions
+    # @return [Object] unique identifier for this set of options
+    attr_reader :structure_id
+
+    # @param structure_id [Object] unique identifier for this set of options
+    # @param package_options [Array<PackageOptions>] the options for packages in this structure
+    # @param package_options_class [Class] the class to use for package options when none are provided
+    def initialize(
+      structure_id:,
+      package_options: [],
+      package_options_class: PackageOptions
+    )
+      @structure_id = structure_id
+      @package_options = package_options
+      @package_options_class = package_options_class
+    end
+
+    # @param package [#id] the package for which to get options
+    # @return [PackageOptions]
+    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
+
+    private
+
+    # @return [Array<PackageOptions>]
+    attr_reader :package_options
+
+    # @return [Class]
+    attr_reader :package_options_class
+  end
+end

data/lib/friendly_shipping/timing.rb

@@ -1,27 +1,62 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
+  # Base class for a transit timing estimate returned by a carrier API.
   class Timing
-    attr_reader :shipping_method,
-                :pickup,
-                :delivery,
-                :guaranteed,
-                :properties
+    # @return [ShippingMethod] this timing's shipping method
+    attr_reader :shipping_method
 
+    # @return [Time] the pickup estimate
+    attr_reader :pickup
+
+    # @return [Time] the delivery estimate
+    attr_reader :delivery
+
+    # @return [Boolean] whether the delivery estimate is guaranteed
+    attr_reader :guaranteed
+
+    # @return [Array] any warnings that were generated
+    attr_reader :warnings
+
+    # @return [Array] any errors that were generated
+    attr_reader :errors
+
+    # @return [Hash] additional data related to the timing (DEPRECATED: use `data` instead)
+    attr_reader :properties
+
+    # @return [Hash] additional data related to the timing
+    attr_reader :data
+
+    # @param shipping_method [ShippingMethod] this timing's shipping method
+    # @param pickup [Time] the pickup estimate
+    # @param delivery [Time] the delivery estimate
+    # @param guaranteed [Boolean] whether the delivery estimate is guaranteed
+    # @param warnings [Array] any warnings that were generated
+    # @param errors [Array] any errors that were generated
+    # @param properties [Hash] additional data related to the timing
+    # @param data [Hash] additional data related to the timing (DEPRECATED: use `data` instead)
     def initialize(
       shipping_method:,
       pickup:,
       delivery:,
       guaranteed: false,
-      properties: {}
+      warnings: [],
+      errors: [],
+      properties: {},
+      data: {}
     )
       @shipping_method = shipping_method
       @pickup = pickup
       @delivery = delivery
       @guaranteed = guaranteed
-      @properties = properties
+      @warnings = warnings
+      @errors = errors
+      @data = @properties = properties.presence || data
+      warn "[DEPRECATION] `properties` is deprecated.  Please use `data` instead." if properties.present?
     end
 
+    # Calculates and returns the time between pickup and delivery.
+    # @return [Time]
     def time_in_transit
       delivery - pickup
     end

data/lib/friendly_shipping/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
-  VERSION = "0.8.1"
+  VERSION = "0.10.0"
 end

data/lib/friendly_shipping.rb

@@ -2,26 +2,31 @@
 
 require "physical"
 require "money"
+require "dry/monads"
+require "restclient"
 
 # Explicitly configure the default rounding mode to avoid deprecation warnings
 Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
 
-require "friendly_shipping/version"
-require "friendly_shipping/request"
-require "friendly_shipping/response"
-require "friendly_shipping/carrier"
-require "friendly_shipping/shipping_method"
-require "friendly_shipping/label"
-require "friendly_shipping/rate"
-require "friendly_shipping/api_result"
-require "friendly_shipping/api_failure"
+require "zeitwerk"
 
-require "friendly_shipping/services/ship_engine"
-require 'friendly_shipping/services/ship_engine_ltl'
-require "friendly_shipping/services/ups"
-require "friendly_shipping/services/ups_freight"
-require "friendly_shipping/services/usps"
-require "friendly_shipping/services/usps_international"
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "rl" => "RL",
+  "parse_create_bol_response" => "ParseCreateBOLResponse",
+  "parse_print_bol_response" => "ParsePrintBOLResponse",
+  "serialize_create_bol_request" => "SerializeCreateBOLRequest",
+  "bol_structures_serializer" => "BOLStructuresSerializer",
+  "bol_packages_serializer" => "BOLPackagesSerializer",
+  "bol_options" => "BOLOptions",
+  "ship_engine_ltl" => "ShipEngineLTL",
+  "tforce_freight" => "TForceFreight",
+  "generate_create_bol_request_hash" => "GenerateCreateBOLRequestHash",
+  "parse_xml_response" => "ParseXMLResponse",
+  "usps_ship" => "USPSShip",
+  "shipping_methods" => "SHIPPING_METHODS"
+)
+loader.setup
 
 module FriendlyShipping
 end