friendly_shipping 0.6.4 → 0.7.0

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

@@ -7,11 +7,13 @@ module FriendlyShipping
         def self.call(delivery_options:)
           {
             DeliveryOptions: {
+              CallBeforeDeliveryIndicator: delivery_options.call_before_delivery ? "" : nil,
+              HolidayDeliveryIndicator: delivery_options.holiday_delivery ? "" : nil,
+              InsideDeliveryIndicator: delivery_options.inside_delivery ? "" : nil,
+              ResidentialDeliveryIndicator: delivery_options.residential_delivery ? "" : nil,
+              WeekendDeliveryIndicator: delivery_options.weekend_delivery ? "" : nil,
               LiftGateRequiredIndicator: delivery_options.lift_gate_required ? "" : nil,
-              WeekendPickupIndicator: delivery_options.weekend_delivery ? "" : nil,
-              InsidePickupIndicator: delivery_options.inside_delivery ? "" : nil,
-              HolidayPickupIndicator: delivery_options.holiday_delivery ? "" : nil,
-              LimitedAccessPickupIndicator: delivery_options.limited_access_delivery ? "" : nil
+              LimitedAccessDeliveryIndicator: delivery_options.limited_access_delivery ? "" : nil
             }.compact.presence
           }.compact.presence
         end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'friendly_shipping/services/ups_freight/generate_location_hash'
+require 'friendly_shipping/services/ups_freight/generate_reference_hash'
 require 'friendly_shipping/services/ups_freight/generate_document_options_hash'
 require 'friendly_shipping/services/ups_freight/generate_email_options_hash'
 require 'friendly_shipping/services/ups_freight/generate_pickup_options_hash'
@@ -30,8 +31,10 @@ module FriendlyShipping
                   HandlingInstructions: options.handling_instructions,
                   PickupInstructions: options.pickup_instructions,
                   DeliveryInstructions: options.delivery_instructions,
-                  PickupRequest: GeneratePickupRequestHash.call(pickup_request_options: options.pickup_request_options)
-                }.compact.merge(handling_units(shipment, options).reduce(&:merge).to_h)
+                  PickupRequest: GeneratePickupRequestHash.call(pickup_request_options: options.pickup_request_options),
+                }.compact.
+                  merge(handling_units(shipment, options).reduce(&:merge).to_h).
+                  merge(GenerateReferenceHash.call(reference_numbers: options.reference_numbers))
               }
             }
           end

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

@@ -6,16 +6,14 @@ module FriendlyShipping
       class GenerateLocationHash
         class << self
           def call(location:)
-            # We ship freight here, which will mostly be used for businesses.
-            # If a personal name is given, treat is as the contact person ("AttentionName")
             {
-              Name: location.company_name,
+              Name: location.company_name.presence || location.name,
               Address: {
                 AddressLine: address_line(location),
                 City: location.city,
-                StateProvinceCode: location.region.code,
+                StateProvinceCode: location.region&.code,
                 PostalCode: location.zip,
-                CountryCode: location.country.code
+                CountryCode: location.country&.code
               },
               AttentionName: location.name,
               Phone: {
@@ -27,13 +25,12 @@ module FriendlyShipping
           private
 
           def address_line(location)
-            [
+            address_lines = [
               location.address1,
               location.address2,
               location.address3
-            ].compact.
-              reject(&:empty?).
-              join(", ")
+            ].compact.reject(&:empty?)
+            address_lines.size > 1 ? address_lines : address_lines.first
           end
         end
       end

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

@@ -7,10 +7,11 @@ module FriendlyShipping
         def self.call(pickup_options:)
           {
             PickupOptions: {
-              LiftGateRequiredIndicator: pickup_options.lift_gate_required ? "" : nil,
-              WeekendPickupIndicator: pickup_options.weekend_pickup ? "" : nil,
-              InsidePickupIndicator: pickup_options.inside_pickup ? "" : nil,
               HolidayPickupIndicator: pickup_options.holiday_pickup ? "" : nil,
+              InsidePickupIndicator: pickup_options.inside_pickup ? "" : nil,
+              ResidentialPickupIndicator: pickup_options.residential_pickup ? "" : nil,
+              WeekendPickupIndicator: pickup_options.weekend_pickup ? "" : nil,
+              LiftGateRequiredIndicator: pickup_options.lift_gate_required ? "" : nil,
               LimitedAccessPickupIndicator: pickup_options.limited_access_pickup ? "" : nil
             }.compact.presence
           }.compact.presence

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateReferenceHash
+        class << self
+          # @param [Array] reference_numbers Reference numbers for the Bill of Lading
+          # @return [Hash] Reference hash suitable for JSON request
+          def call(reference_numbers:)
+            return {} unless reference_numbers
+
+            references = reference_numbers.map do |reference_number|
+              {
+                Number: {
+                  Code: reference_number[:code],
+                  Value: reference_number[:value]
+                }
+              }
+            end
+            references.any? ? { Reference: references } : {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,21 +4,27 @@ module FriendlyShipping
   module Services
     class UpsFreight
       class LabelDeliveryOptions
-        attr_reader :holiday_delivery,
+        attr_reader :call_before_delivery,
+                    :holiday_delivery,
                     :inside_delivery,
+                    :residential_delivery,
                     :weekend_delivery,
                     :lift_gate_required,
                     :limited_access_delivery
 
         def initialize(
+          call_before_delivery: nil,
           holiday_delivery: nil,
           inside_delivery: nil,
+          residential_delivery: nil,
           weekend_delivery: nil,
           lift_gate_required: nil,
           limited_access_delivery: nil
         )
+          @call_before_delivery = call_before_delivery
           @holiday_delivery = holiday_delivery
           @inside_delivery = inside_delivery
+          @residential_delivery = residential_delivery
           @weekend_delivery = weekend_delivery
           @lift_gate_required = lift_gate_required
           @limited_access_delivery = limited_access_delivery

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

@@ -4,14 +4,30 @@ module FriendlyShipping
   module Services
     class UpsFreight
       class LabelOptions < RatesOptions
+        REFERENCE_NUMBER_CODES = {
+          bill_of_lading_number: "57",
+          purchase_order_number: "28",
+          shipper_reference: "SH",
+          consignee_reference: "CO",
+          pm: "PM",
+          proj: "PROJ",
+          quote: "QUOTE",
+          sid: "SID",
+          task: "TASK",
+          vprc: "VPRC",
+          other: "OTHER"
+        }.freeze
+
         attr_reader :document_options,
                     :email_options,
                     :pickup_options,
                     :delivery_options,
                     :pickup_instructions,
                     :delivery_instructions,
-                    :handling_instructions
+                    :handling_instructions,
+                    :reference_numbers
 
+        # @param [Array] reference_numbers Reference numbers for the Bill of Lading
         def initialize(
           document_options: [],
           email_options: [],
@@ -20,6 +36,7 @@ module FriendlyShipping
           pickup_instructions: nil,
           delivery_instructions: nil,
           handling_instructions: nil,
+          reference_numbers: [],
           **kwargs
         )
           @pickup_options = pickup_options
@@ -29,7 +46,16 @@ module FriendlyShipping
           @pickup_instructions = pickup_instructions
           @delivery_instructions = delivery_instructions
           @handling_instructions = handling_instructions
-          super kwargs
+          @reference_numbers = fill_codes(reference_numbers)
+          super(**kwargs)
+        end
+
+        private
+
+        def fill_codes(reference_numbers)
+          reference_numbers.each do |reference_number|
+            reference_number[:code] = REFERENCE_NUMBER_CODES.fetch(reference_number[:code])
+          end
         end
       end
     end

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

@@ -6,6 +6,7 @@ module FriendlyShipping
       class LabelPickupOptions
         attr_reader :holiday_pickup,
                     :inside_pickup,
+                    :residential_pickup,
                     :weekend_pickup,
                     :lift_gate_required,
                     :limited_access_pickup
@@ -13,12 +14,14 @@ module FriendlyShipping
         def initialize(
           holiday_pickup: nil,
           inside_pickup: nil,
+          residential_pickup: nil,
           weekend_pickup: nil,
           lift_gate_required: nil,
           limited_access_pickup: nil
         )
           @holiday_pickup = holiday_pickup
           @inside_pickup = inside_pickup
+          @residential_pickup = residential_pickup
           @weekend_pickup = weekend_pickup
           @lift_gate_required = lift_gate_required
           @limited_access_pickup = limited_access_pickup

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

@@ -23,19 +23,23 @@ module FriendlyShipping
             service_code = shipment_results.dig("Service", "Code")
             shipping_method = SHIPPING_METHODS.detect { |sm| sm.service_code == service_code }
 
-            total_shipment_charge = shipment_results.dig("TotalShipmentCharge")
-            currency = Money::Currency.new(total_shipment_charge['CurrencyCode'])
-            amount = total_shipment_charge['MonetaryValue'].to_f
-            total_money = Money.new(amount * currency.subunit_to_unit, currency)
+            total_shipment_charge = shipment_results["TotalShipmentCharge"]
+            if total_shipment_charge
+              currency = Money::Currency.new(total_shipment_charge['CurrencyCode'])
+              amount = total_shipment_charge['MonetaryValue'].to_f
+              total_money = Money.new(amount * currency.subunit_to_unit, currency)
+            end
 
             images_data = Array.wrap(shipment_results.dig("Documents", "Image"))
 
-            bol_id = shipment_results.dig("BOLID")
-            shipment_number = shipment_results.dig("ShipmentNumber")
-            pickup_request_number = shipment_results.dig("PickupRequestConfirmationNumber")
+            bol_id = shipment_results["BOLID"]
+            shipment_number = shipment_results["ShipmentNumber"]
+            pickup_request_number = shipment_results["PickupRequestConfirmationNumber"]
 
             documents = images_data.map { |image_data| ParseShipmentDocument.call(image_data: image_data) }
 
+            cost_breakdown = build_cost_breakdown(shipment_results)
+
             FriendlyShipping::ApiResult.new(
               ShipmentInformation.new(
                 total: total_money,
@@ -44,12 +48,27 @@ module FriendlyShipping
                 pickup_request_number: pickup_request_number,
                 shipping_method: shipping_method,
                 warnings: warnings,
-                documents: documents
+                documents: documents,
+                data: {
+                  cost_breakdown: cost_breakdown
+                }
               ),
               original_request: request,
               original_response: response
             )
           end
+
+          private
+
+          def build_cost_breakdown(shipment_results)
+            {
+              "Rates" => shipment_results.fetch("Rate", []).each_with_object({}) do |rate, hash|
+                hash[rate.dig("Type", "Code")] = rate.dig("Factor", "Value")
+              end,
+              "TotalShipmentCharge" => shipment_results.dig("TotalShipmentCharge", "MonetaryValue"),
+              "BillableShipmentWeight" => shipment_results.dig("BillableShipmentWeight", "Value")
+            }.compact
+          end
         end
       end
     end

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

@@ -10,7 +10,7 @@ module FriendlyShipping
 
         def self.call(image_data:)
           format_code = image_data.dig("Type", "Code")
-          graphic_image_b64 = image_data.dig("GraphicImage")
+          graphic_image_b64 = image_data["GraphicImage"]
 
           ShipmentDocument.new(
             format: image_data.dig("Format", "Code").downcase.to_sym,

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

@@ -10,7 +10,8 @@ module FriendlyShipping
                     :total,
                     :bol_id,
                     :shipping_method,
-                    :warnings
+                    :warnings,
+                    :data
 
         def initialize(
           total:,
@@ -19,7 +20,8 @@ module FriendlyShipping
           pickup_request_number: nil,
           documents: [],
           shipping_method: nil,
-          warnings: nil
+          warnings: nil,
+          data: {}
         )
           @total = total
           @bol_id = bol_id
@@ -28,6 +30,7 @@ module FriendlyShipping
           @documents = documents
           @shipping_method = shipping_method
           @warnings = warnings
+          @data = data
         end
       end
     end

data/lib/friendly_shipping/services/ups_freight.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 require 'friendly_shipping/http_client'
 require 'friendly_shipping/services/ups_freight/shipping_methods'
 require 'friendly_shipping/services/ups_freight/rates_options'
@@ -18,12 +18,12 @@ require 'friendly_shipping/services/ups_freight/parse_freight_label_response'
 require 'friendly_shipping/services/ups_freight/parse_freight_rate_response'
 require 'friendly_shipping/services/ups_freight/generate_freight_rate_request_hash'
 require 'friendly_shipping/services/ups_freight/generate_freight_ship_request_hash'
-require 'friendly_shipping/services/ups_freight/restful_api_error_handler'
+require 'friendly_shipping/services/ups_freight/api_error'
 
 module FriendlyShipping
   module Services
     class UpsFreight
-      include Dry::Monads::Result::Mixin
+      include Dry::Monads[:result]
 
       attr_reader :test, :key, :login, :password, :client
 
@@ -42,12 +42,14 @@ module FriendlyShipping
         labels: '/ship/v1607/freight/shipments/Ground'
       }.freeze
 
-      def initialize(key:, login:, password:, test: true, client: HttpClient.new(error_handler: RestfulApiErrorHandler))
+      def initialize(key:, login:, password:, test: true, client: nil)
         @key = key
         @login = login
         @password = password
         @test = test
-        @client = client
+
+        error_handler = ApiErrorHandler.new(api_error_class: UpsFreight::ApiError)
+        @client = client || HttpClient.new(error_handler: error_handler)
       end
 
       def carriers
@@ -87,6 +89,7 @@ module FriendlyShipping
         url = base_url + RESOURCES[action]
         FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: payload.to_json,
           headers: {
             Content_Type: 'application/json',

data/lib/friendly_shipping/services/usps/parse_package_rate.rb

@@ -55,6 +55,8 @@ module FriendlyShipping
         RATE_TAG = 'Rate'
         COMMERCIAL_RATE_TAG = 'CommercialRate'
         COMMERCIAL_PLUS_RATE_TAG = 'CommercialPlusRate'
+        DIMENSIONAL_WEIGHT_RATE = 'DimensionalWeightRate'
+        FEES = './/Fees/Fee'
         CURRENCY = Money::Currency.new('USD').freeze
 
         class << self
@@ -119,6 +121,17 @@ module FriendlyShipping
             box_name_match = service_name.match(/#{BOX_REGEX}/)
             box_name = box_name_match ? box_name_match.named_captures.compact.keys.last.to_sym : :variable
 
+            dimensional_weight_rate = rate_node.at(DIMENSIONAL_WEIGHT_RATE)&.text&.to_i
+
+            fees = rate_node.xpath(FEES).map do |fee_node|
+              type = fee_node.at('FeeType').text
+              price = fee_node.at('FeePrice').text.to_d
+              {
+                type: type,
+                price: Money.new(price * CURRENCY.subunit_to_unit, CURRENCY)
+              }
+            end
+
             # Combine all the gathered information in a FriendlyShipping::Rate object.
             # Careful: This rate is only for one package within the shipment, and we get multiple
             # rates per package for the different shipping method/box/hold for pickup combinations.
@@ -132,7 +145,9 @@ module FriendlyShipping
                 days_to_delivery: days_to_delivery,
                 military: military,
                 full_mail_service: service_name,
-                service_code: service_code
+                service_code: service_code,
+                dimensional_weight_rate: dimensional_weight_rate,
+                fees: fees
               }
             )
           end

data/lib/friendly_shipping/services/usps/rate_estimate_options.rb

@@ -20,7 +20,7 @@ module FriendlyShipping
           package_options_class: FriendlyShipping::Services::Usps::RateEstimatePackageOptions,
           **kwargs
         )
-          super kwargs.merge(package_options_class: package_options_class)
+          super(**kwargs.merge(package_options_class: package_options_class))
         end
       end
     end

data/lib/friendly_shipping/services/usps/rate_estimate_package_options.rb

@@ -8,6 +8,8 @@ module FriendlyShipping
     #
     # @param [Symbol] box_name The type of box we want to get rates for. Has to be one of the keys
     #  of FriendlyShipping::Services::Usps::CONTAINERS.
+    # @param [Symbol] return_dimensional_weight Boolean indicating whether the response should include dimensional weight.
+    # @param [Symbol] return_fees Boolean indicating whether the response should include fees.
     class Usps
       class RateEstimatePackageOptions < FriendlyShipping::PackageOptions
         attr_reader :box_name,
@@ -16,26 +18,22 @@ module FriendlyShipping
                     :hold_for_pickup,
                     :shipping_method,
                     :transmit_dimensions,
-                    :rectangular
-
-        def initialize(
-          box_name: :variable,
-          commercial_pricing: false,
-          first_class_mail_type: nil,
-          hold_for_pickup: false,
-          shipping_method: nil,
-          transmit_dimensions: true,
-          rectangular: true,
-          **kwargs
-        )
+                    :rectangular,
+                    :return_dimensional_weight,
+                    :return_fees
+
+        def initialize(**kwargs)
+          box_name = value_or_default(:box_name, :variable, kwargs)
           @box_name = CONTAINERS.key?(box_name) ? box_name : :variable
-          @commercial_pricing = commercial_pricing
-          @first_class_mail_type = first_class_mail_type
-          @hold_for_pickup = hold_for_pickup
-          @shipping_method = shipping_method
-          @transmit_dimensions = transmit_dimensions
-          @rectangular = rectangular
-          super kwargs
+          @commercial_pricing = value_or_default(:commercial_pricing, false, kwargs)
+          @first_class_mail_type = kwargs.delete(:first_class_mail_type)
+          @hold_for_pickup = value_or_default(:hold_for_pickup, false, kwargs)
+          @shipping_method = kwargs.delete(:shipping_method)
+          @transmit_dimensions = value_or_default(:transmit_dimensions, true, kwargs)
+          @rectangular = value_or_default(:rectangular, true, kwargs)
+          @return_dimensional_weight = value_or_default(:return_dimensional_weight, true, kwargs)
+          @return_fees = value_or_default(:return_fees, false, kwargs)
+          super(**kwargs)
         end
 
         def container_code
@@ -57,6 +55,12 @@ module FriendlyShipping
           service_code << 'COMMERCIAL' if commercial_pricing
           service_code.join(' ')
         end
+
+        private
+
+        def value_or_default(key, default, kwargs)
+          kwargs.key?(key) ? kwargs.delete(key) : default
+        end
       end
     end
   end

data/lib/friendly_shipping/services/usps/serialize_rate_request.rb

@@ -46,6 +46,8 @@ module FriendlyShipping
                       end
                     end
                     xml.Machinable(machinable(package))
+                    xml.ReturnDimensionalWeight(true) if package_options.return_dimensional_weight
+                    xml.ReturnFees(true) if package_options.return_fees
                   end
                 end
               end

data/lib/friendly_shipping/services/usps.rb

@@ -16,7 +16,7 @@ require 'friendly_shipping/services/usps/rate_estimate_options'
 module FriendlyShipping
   module Services
     class Usps
-      include Dry::Monads::Result::Mixin
+      include Dry::Monads[:result]
 
       attr_reader :test, :login, :client
 
@@ -111,6 +111,7 @@ module FriendlyShipping
       def build_request(api:, xml:, debug:)
         FriendlyShipping::Request.new(
           url: base_url,
+          http_method: "POST",
           body: "API=#{RESOURCES[api]}&XML=#{CGI.escape xml}",
           readable_body: xml,
           debug: debug

data/lib/friendly_shipping/version.rb

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

data/lib/friendly_shipping.rb

@@ -18,6 +18,7 @@ require "friendly_shipping/api_failure"
 
 require "friendly_shipping/services/ship_engine"
 require "friendly_shipping/services/ups"
+require "friendly_shipping/services/ups_freight"
 require "friendly_shipping/services/usps"
 
 module FriendlyShipping