friendly_shipping 0.8.1 → 0.9.0

data/lib/friendly_shipping/services/ups_freight/parse_freight_label_response.rb

@@ -33,7 +33,7 @@ module FriendlyShipping
             images_data = Array.wrap(shipment_results.dig("Documents", "Image"))
 
             bol_id = shipment_results["BOLID"]
-            shipment_number = shipment_results["ShipmentNumber"]
+            pro_number = shipment_results["ShipmentNumber"]
             pickup_request_number = shipment_results["PickupRequestConfirmationNumber"]
 
             documents = images_data.map { |image_data| ParseShipmentDocument.call(image_data: image_data) }
@@ -44,7 +44,7 @@ module FriendlyShipping
               ShipmentInformation.new(
                 total: total_money,
                 bol_id: bol_id,
-                number: shipment_number,
+                pro_number: pro_number,
                 pickup_request_number: pickup_request_number,
                 shipping_method: shipping_method,
                 warnings: warnings,

data/lib/friendly_shipping/services/ups_freight/parse_shipment_document.rb

@@ -6,7 +6,7 @@ module FriendlyShipping
   module Services
     class UpsFreight
       class ParseShipmentDocument
-        REVERSE_DOCUMENT_TYPES = LabelDocumentOptions::DOCUMENT_TYPES.map(&:reverse_each).map(&:to_a).to_h
+        REVERSE_DOCUMENT_TYPES = LabelDocumentOptions::DOCUMENT_TYPES.map(&:reverse_each).to_h(&:to_a)
 
         def self.call(image_data:)
           format_code = image_data.dig("Type", "Code")

data/lib/friendly_shipping/services/ups_freight/rates_item_options.rb

@@ -3,12 +3,9 @@
 module FriendlyShipping
   module Services
     class UpsFreight
-      # Options for Items in a UPS Freight shipment
-      #
-      # @attribute [Symbol] packaging How the item is packaged, one of the keys of `PACKAGING_TYPES`
-      # @attribute [String] freight_class The freight class of this item, for example '55' or '92.5'
-      # @attribute [String] nmfc_code The national motor freight corporation code for this item. Something like '13050 sub 4'
+      # Options for Items in a UPS Freight shipment.
       class RatesItemOptions < FriendlyShipping::ItemOptions
+        # Maps friendly names to packaging types.
         PACKAGING_TYPES = {
           bag: { code: "BAG", description: "Bag" },
           bale: { code: "BAL", description: "Bale" },
@@ -49,11 +46,23 @@ module FriendlyShipping
           wrapped: { code: "WRP", description: "Wrapped" }
         }.freeze
 
-        attr_reader :packaging_code,
-                    :packaging_description,
-                    :freight_class,
-                    :nmfc_code
+        # @return [String]
+        attr_reader :packaging_code
 
+        # @return [String]
+        attr_reader :packaging_description
+
+        # @return [String]
+        attr_reader :freight_class
+
+        # @return [String]
+        attr_reader :nmfc_code
+
+        # @param packaging [Symbol] how the item is packaged (see {PACKAGING_TYPES})
+        # @param freight_class [String] the freight class of this item, for example '55' or '92.5'
+        # @param nmfc_code [String] the national motor freight corporation code for this item, for example '13050 sub 4'
+        # @param kwargs [Hash]
+        # @options kwargs [String] :item_id the ID for the item that belongs to these options
         def initialize(
           packaging: :carton,
           freight_class: nil,

data/lib/friendly_shipping/services/ups_freight/rates_options.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'friendly_shipping/services/ups_freight/shipment_options'
 require 'friendly_shipping/services/ups_freight/rates_package_options'
 require 'friendly_shipping/services/ups_freight/generate_commodity_information'
 
@@ -7,33 +8,42 @@ module FriendlyShipping
   module Services
     class UpsFreight
       # Options for generating UPS Freight rates for a shipment
-      #
-      # @attribute [Physical::Location] billing_address The billing address
-      # @attribute [String] shipper_number The shipper number associated with the shipper
-      # @attribute [String] customer_context A reference to match this request with an order or shipment
-      # @attribute [FriendlyShipping::ShippingMethod] shipping_method The shipping method to use
-      # @attribute [Callable] commodity_information_generator A callable that takes a shipment
-      #     and an options object to create an Array of commodity fields as per the UPS docs.
-      # @attribute [Symbol] billing One of the keys in the `BILLING_CODES` constant. How the shipment
-      #     would be billed.
-      # @attribute [Date] pickup_date Date of the Pickup
-      # @attribute [String] pickup_comments Additional pickup instructions
-      # @attribute [RatesPackageOptions] package_options Options for each of the packages/pallets in this shipment
-      class RatesOptions < FriendlyShipping::ShipmentOptions
+      class RatesOptions < ShipmentOptions
         BILLING_CODES = {
           prepaid: '10',
           third_party: '30',
           freight_collect: '40'
         }.freeze
 
-        attr_reader :shipper_number,
-                    :billing_address,
-                    :billing_code,
-                    :customer_context,
-                    :shipping_method,
-                    :pickup_request_options,
-                    :commodity_information_generator
+        # @return [String]
+        attr_reader :shipper_number
 
+        # @return [Physical::Location]
+        attr_reader :billing_address
+
+        # @return [Symbol]
+        attr_reader :billing_code
+
+        # @return [String]
+        attr_reader :customer_context
+
+        # @return [FriendlyShipping::ShippingMethod]
+        attr_reader :shipping_method
+
+        # @return [PickupRequestOptions]
+        attr_reader :pickup_request_options
+
+        # @return [Callable]
+        attr_reader :commodity_information_generator
+
+        # @param shipper_number [String] the shipper number associated with the shipper
+        # @param billing_address [Physical::Location] the billing address
+        # @param shipping_method [FriendlyShipping::ShippingMethod] the shipping method to use
+        # @param billing [Symbol] how the shipment is billed (see {BILLING_CODES})
+        # @param customer_context [String] a reference to match this request with an order or shipment
+        # @param pickup_request_options [PickupRequestOptions] options for the pickup request
+        # @param commodity_information_generator [Callable] a callable that takes a shipment
+        #     and an options object to create an Array of commodity fields as per the UPS docs
         def initialize(
           shipper_number:,
           billing_address:,
@@ -51,7 +61,7 @@ module FriendlyShipping
           @customer_context = customer_context
           @pickup_request_options = pickup_request_options
           @commodity_information_generator = commodity_information_generator
-          super(**kwargs.merge(package_options_class: RatesPackageOptions))
+          super(**kwargs.reverse_merge(package_options_class: RatesPackageOptions))
         end
       end
     end

data/lib/friendly_shipping/services/ups_freight/rates_package_options.rb

@@ -5,11 +5,50 @@ require 'friendly_shipping/services/ups_freight/rates_item_options'
 module FriendlyShipping
   module Services
     class UpsFreight
-      # Options for packages/pallets within a UPS Freight shipment
-      #
-      # @attribute [Symbol] handling _unit How this shipment is divided. Any of the keys in `HANDLING_UNIT_TYPES`
-      # @attribute [RatesItemOptions] item_options Options for each of the items on the pallet/in the carboy/etc.
+      # Options for packages/pallets within a UPS Freight shipment.
       class RatesPackageOptions < FriendlyShipping::PackageOptions
+        # Maps friendly names to packaging types.
+        PACKAGING_TYPES = {
+          bag: { code: "BAG", description: "Bag" },
+          bale: { code: "BAL", description: "Bale" },
+          barrel: { code: "BAR", description: "Barrel" },
+          bundle: { code: "BDL", description: "Bundle" },
+          bin: { code: "BIN", description: "Bin" },
+          box: { code: "BOX", description: "Box" },
+          basket: { code: "BSK", description: "Basket" },
+          bunch: { code: "BUN", description: "Bunch" },
+          cabinet: { code: "CAB", description: "Cabinet" },
+          can: { code: "CAN", description: "Can" },
+          carrier: { code: "CAR", description: "Carrier" },
+          case: { code: "CAS", description: "Case" },
+          carboy: { code: "CBY", description: "Carboy" },
+          container: { code: "CON", description: "Container" },
+          crate: { code: "CRT", description: "Crate" },
+          cask: { code: "CSK", description: "Cask" },
+          carton: { code: "CTN", description: "Carton" },
+          cylinder: { code: "CYL", description: "Cylinder" },
+          drum: { code: "DRM", description: "Drum" },
+          loose: { code: "LOO", description: "Loose" },
+          other: { code: "OTH", description: "Other" },
+          pail: { code: "PAL", description: "Pail" },
+          pieces: { code: "PCS", description: "Pieces" },
+          package: { code: "PKG", description: "Package" },
+          pipe_line: { code: "PLN", description: "Pipe Line" },
+          pallet: { code: "PLT", description: "Pallet" },
+          rack: { code: "RCK", description: "Rack" },
+          reel: { code: "REL", description: "Reel" },
+          roll: { code: "ROL", description: "Roll" },
+          skid: { code: "SKD", description: "Skid" },
+          spool: { code: "SPL", description: "Spool" },
+          tube: { code: "TBE", description: "Tube" },
+          tank: { code: "TNK", description: "Tank" },
+          totes: { code: "TOT", description: "Totes" },
+          unit: { code: "UNT", description: "Unit" },
+          van_pack: { code: "VPK", description: "Van Pack" },
+          wrapped: { code: "WRP", description: "Wrapped" }
+        }.freeze
+
+        # Maps friendly names to handling unit types.
         HANDLING_UNIT_TYPES = {
           pallet: { code: "PLT", description: "Pallet", handling_unit_tag: 'One' },
           skid: { code: "SKD", description: "Skid", handling_unit_tag: 'One' },
@@ -19,18 +58,50 @@ module FriendlyShipping
           loose: { code: "LOO", description: "Loose", handling_unit_tag: 'Two' }
         }.freeze
 
-        attr_reader :handling_unit_description,
-                    :handling_unit_tag,
-                    :handling_unit_code
+        # @return [String]
+        attr_reader :packaging_code
+
+        # @return [String]
+        attr_reader :packaging_description
+
+        # @return [String]
+        attr_reader :freight_class
+
+        # @return [String]
+        attr_reader :nmfc_code
+
+        # @return [String]
+        attr_reader :handling_unit_description
+
+        # @return [String]
+        attr_reader :handling_unit_tag
+
+        # @return [String]
+        attr_reader :handling_unit_code
 
+        # @param packaging [Symbol] how this shipment is packaged (see {PACKAGING_TYPES})
+        # @param freight_class [String] the freight class
+        # @param nmfc_code [String] the NMFC code
+        # @param handling_unit [Symbol] how this shipment is divided (see {HANDLING_UNIT_TYPES})
+        # @param kwargs [Hash]
+        # @option kwargs [String] :package_id the ID for the package  that belongs to these options
+        # @option kwargs [Array<ItemOptions>] :item_options the options for items in this package
+        # @option kwargs [Class] :item_options_class the class to use for item options when none are provided
         def initialize(
+          packaging: :carton,
+          freight_class: nil,
+          nmfc_code: nil,
           handling_unit: :pallet,
           **kwargs
         )
+          @packaging_code = PACKAGING_TYPES.fetch(packaging).fetch(:code)
+          @packaging_description = PACKAGING_TYPES.fetch(packaging).fetch(:description)
+          @freight_class = freight_class
+          @nmfc_code = nmfc_code
           @handling_unit_code = HANDLING_UNIT_TYPES.fetch(handling_unit).fetch(:code)
           @handling_unit_description = HANDLING_UNIT_TYPES.fetch(handling_unit).fetch(:description)
           @handling_unit_tag = "HandlingUnit#{HANDLING_UNIT_TYPES.fetch(handling_unit).fetch(:handling_unit_tag)}"
-          super(**kwargs.merge(item_options_class: RatesItemOptions))
+          super(**kwargs.reverse_merge(item_options_class: RatesItemOptions))
         end
       end
     end

data/lib/friendly_shipping/services/ups_freight/rates_structure_options.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_freight/rates_package_options'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      # Options for structures/pallets within a UPS Freight shipment.
+      class RatesStructureOptions < FriendlyShipping::StructureOptions
+        # Maps friendly names to handling unit types.
+        HANDLING_UNIT_TYPES = {
+          pallet: { code: "PLT", description: "Pallet", handling_unit_tag: 'One' },
+          skid: { code: "SKD", description: "Skid", handling_unit_tag: 'One' },
+          carboy: { code: "CBY", description: "Carboy", handling_unit_tag: 'One' },
+          totes: { code: "TOT", description: "Totes", handling_unit_tag: 'One' },
+          other: { code: "OTH", description: "Other", handling_unit_tag: 'Two' },
+          loose: { code: "LOO", description: "Loose", handling_unit_tag: 'Two' }
+        }.freeze
+
+        # @return [String]
+        attr_reader :handling_unit_description
+
+        # @return [String]
+        attr_reader :handling_unit_tag
+
+        # @return [String]
+        attr_reader :handling_unit_code
+
+        # @param handling_unit [Symbol] how this shipment is divided (see {HANDLING_UNIT_TYPES})
+        # @param kwargs [Hash]
+        # @options kwargs [Object] :structure_id unique identifier for this set of options
+        # @options kwargs [Array<PackageOptions>] :package_options the options for packages in this structure
+        # @options kwargs [Class] :package_options_class the class to use for package options when none are provided
+        def initialize(
+          handling_unit: :pallet,
+          **kwargs
+        )
+          @handling_unit_code = HANDLING_UNIT_TYPES.fetch(handling_unit).fetch(:code)
+          @handling_unit_description = HANDLING_UNIT_TYPES.fetch(handling_unit).fetch(:description)
+          @handling_unit_tag = "HandlingUnit#{HANDLING_UNIT_TYPES.fetch(handling_unit).fetch(:handling_unit_tag)}"
+          super(**kwargs.reverse_merge(package_options_class: RatesPackageOptions))
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_freight/shipment_information.rb

@@ -5,7 +5,7 @@ module FriendlyShipping
     class UpsFreight
       class ShipmentInformation
         attr_reader :documents,
-                    :number,
+                    :pro_number,
                     :pickup_request_number,
                     :total,
                     :bol_id,
@@ -13,10 +13,14 @@ module FriendlyShipping
                     :warnings,
                     :data
 
+        # Backwards compatibility after renaming this attribute
+        alias_method :number, :pro_number
+
         def initialize(
           total:,
           bol_id:,
-          number:,
+          number: nil,
+          pro_number: nil,
           pickup_request_number: nil,
           documents: [],
           shipping_method: nil,
@@ -25,7 +29,7 @@ module FriendlyShipping
         )
           @total = total
           @bol_id = bol_id
-          @number = number
+          @pro_number = pro_number || number
           @pickup_request_number = pickup_request_number
           @documents = documents
           @shipping_method = shipping_method

data/lib/friendly_shipping/services/ups_freight/shipment_options.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/shipment_options'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class ShipmentOptions < FriendlyShipping::ShipmentOptions
+        # @param structure_options [Array<StructureOptions>]
+        # @param structure_options_class [Class]
+        # @param kwargs [Hash]
+        # @option kwargs [Array<PackageOptions>] :package_options
+        # @option kwargs [Class] :package_options_class
+        def initialize(
+          structure_options: Set.new,
+          structure_options_class: RatesStructureOptions,
+          **kwargs
+        )
+          @structure_options = structure_options
+          @structure_options_class = structure_options_class
+          super(**kwargs)
+        end
+
+        # @param structure [#id]
+        # @return [StructureOptions]
+        def options_for_structure(structure)
+          structure_options.detect do |structure_option|
+            structure_option.structure_id == structure.id
+          end || structure_options_class.new(structure_id: nil)
+        end
+
+        private
+
+        # @return [Array<StructureOptions>]
+        attr_reader :structure_options
+
+        # @return [Class]
+        attr_reader :structure_options_class
+
+        # @return [Array<PackageOptions>]
+        # @deprecated Use {#structure_options} instead.
+        def package_options
+          warn "[DEPRECATION] `package_options` is deprecated.  Please use `structure_options` instead."
+          @package_options
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_freight.rb

@@ -5,8 +5,10 @@ require 'friendly_shipping/http_client'
 require 'friendly_shipping/services/ups_freight/shipping_methods'
 require 'friendly_shipping/services/ups_freight/rates_options'
 require 'friendly_shipping/services/ups_freight/label_options'
+require 'friendly_shipping/services/ups_freight/rates_structure_options'
 require 'friendly_shipping/services/ups_freight/rates_package_options'
 require 'friendly_shipping/services/ups_freight/rates_item_options'
+require 'friendly_shipping/services/ups_freight/label_structure_options'
 require 'friendly_shipping/services/ups_freight/label_package_options'
 require 'friendly_shipping/services/ups_freight/label_item_options'
 require 'friendly_shipping/services/ups_freight/label_document_options'
@@ -23,7 +25,7 @@ require 'friendly_shipping/services/ups_freight/api_error'
 module FriendlyShipping
   module Services
     class UpsFreight
-      include Dry::Monads[:result]
+      include Dry::Monads::Result::Mixin
 
       attr_reader :test, :key, :login, :password, :client
 

data/lib/friendly_shipping/services/ups_json/access_token.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      # Represents an access token returned by UPS. The access token can be used to make API requests.
+      # Once it expires, a new token must be created.
+      class AccessToken
+        # @return [Integer] the token's expiration
+        attr_reader :expires_in
+
+        # @return [Integer] the epoch time in ms when the token was issued
+        attr_reader :issued_at
+
+        # @return [String] the raw JWT token
+        attr_reader :raw_token
+
+        # @param expires_in [Integer] the token's expiration
+        # @param issued_at [Integer] the time the token was issued at
+        # @param raw_token [String] the raw JWT token
+        def initialize(expires_in:, issued_at:, raw_token:)
+          @expires_in = expires_in
+          @issued_at = issued_at
+          @raw_token = raw_token
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/api_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/api_error'
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class ApiError < FriendlyShipping::ApiError
+        # @param [RestClient::Exception] cause
+        def initialize(cause)
+          super(cause, parse_message(cause))
+        end
+
+        private
+
+        # @param [RestClient::Exception] error
+        # @return [String]
+        def parse_message(error)
+          return error.message unless error.response
+
+          parsed_json = JSON.parse(error.response.body)
+          parsed_json.dig("response", "errors")&.map { |response_error| response_error["message"] }&.join(", ")
+        rescue JSON::ParserError, KeyError => _e
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/generate_address_classification_payload.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class GenerateAddressClassificationPayload
+        def self.call(location:)
+          {
+            XAVRequest: {
+              Request: {
+                RequestOption: '2', # Address Classification, duplicated in the url path
+              },
+              AddressKeyFormat: [
+                {
+                  AddressLine: [location.address1, location.address2, location.address3].compact,
+                  ConsigneeName: location.company_name || location.name,
+                  CountryCode: location.country.code,
+                  PoliticalDivision1: location.region.name,
+                  PoliticalDivision2: location.city,
+                  PostcodePrimaryLow: location.zip
+                }
+              ]
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_json/generate_address_hash.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsJson
+      class GenerateAddressHash
+        class << self
+          def call(location:, international: false, shipper_number: nil)
+            snippet = {}
+
+            attention_name = location.name if international || location.company_name
+            snippet[:AttentionName] = attention_name if attention_name
+            snippet[:Name] = (location.company_name || location.name)&.slice(0..34)
+            snippet[:ShipperNumber] = shipper_number if shipper_number.present?
+            snippet[:Phone] = { Number: location.phone } if location.phone
+            snippet[:Address] = {
+              AddressLine: [location.address1, location.address2, location.address3].compact,
+              City: location.city,
+              PostalCode: location.zip,
+              StateProvinceCode: location.region&.code,
+              CountryCode: location.country&.code,
+              ResidentialAddressIndicator: location.commercial? ? nil : 'X'
+            }.compact
+            snippet.compact
+          end
+        end
+      end
+    end
+  end
+end