friendly_shipping 0.5.1 → 0.6.2

data/lib/friendly_shipping/services/ups/parse_xml_response.rb

@@ -8,19 +8,18 @@ module FriendlyShipping
         SUCCESSFUL_RESPONSE_STATUS_CODE = '1'
 
         class << self
-          def call(response_body, expected_root_tag)
-            xml = Nokogiri.XML(response_body, &:strict)
+          def call(request:, response:, expected_root_tag:)
+            xml = Nokogiri.XML(response.body, &:strict)
 
             if xml.root.nil? || xml.root.name != expected_root_tag
-              Failure('Invalid document')
-            end
-            if request_successful?(xml)
+              wrap_failure('Invalid document', request, response)
+            elsif request_successful?(xml)
               Success(xml)
             else
-              Failure(error_message(xml))
+              wrap_failure(error_message(xml), request, response)
             end
           rescue Nokogiri::XML::SyntaxError => e
-            Failure(e)
+            wrap_failure(e, request, response)
           end
 
           private
@@ -34,6 +33,16 @@ module FriendlyShipping
             desc = xml.root.at_xpath('Response/Error/ErrorDescription')&.text
             [status, desc].compact.join(": ").presence || 'UPS could not process the request.'
           end
+
+          def wrap_failure(failure, request, response)
+            Failure(
+              FriendlyShipping::ApiFailure.new(
+                failure,
+                original_request: request,
+                original_response: response
+              )
+            )
+          end
         end
       end
     end

data/lib/friendly_shipping/services/ups_freight.rb

@@ -4,11 +4,21 @@ require 'dry/monads/result'
 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_package_options'
 require 'friendly_shipping/services/ups_freight/rates_item_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'
+require 'friendly_shipping/services/ups_freight/label_email_options'
+require 'friendly_shipping/services/ups_freight/label_pickup_options'
+require 'friendly_shipping/services/ups_freight/label_delivery_options'
+require 'friendly_shipping/services/ups_freight/pickup_request_options'
+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_ups_security_hash'
+require 'friendly_shipping/services/ups_freight/generate_freight_ship_request_hash'
+require 'friendly_shipping/services/ups_freight/restful_api_error_handler'
 
 module FriendlyShipping
   module Services
@@ -28,10 +38,11 @@ module FriendlyShipping
       LIVE_URL = 'https://onlinetools.ups.com'
 
       RESOURCES = {
-        rates: '/rest/FreightRate'
+        rates: '/ship/v1801/freight/rating/ground',
+        labels: '/ship/v1607/freight/shipments/Ground'
       }.freeze
 
-      def initialize(key:, login:, password:, test: true, client: HttpClient.new)
+      def initialize(key:, login:, password:, test: true, client: HttpClient.new(error_handler: RestfulApiErrorHandler))
         @key = key
         @login = login
         @password = password
@@ -44,28 +55,48 @@ module FriendlyShipping
       end
 
       # Get rates for a shipment
-      # @param [Physical::Shipment] location The shipment we want to get rates for
+      # @param [Physical::Shipment] shipment The shipment we want to get rates for
       # @param [FriendlyShipping::Services::UpsFreight::RatesOptions] options Options for obtaining rates for this shipment.
       # @return [Result<ApiResult<Array<Rate>>>] The rates returned from UPS encoded in a
       #   `FriendlyShipping::ApiResult` object.
       def rate_estimates(shipment, options:, debug: false)
         freight_rate_request_hash = GenerateFreightRateRequestHash.call(shipment: shipment, options: options)
-        url = base_url + RESOURCES[:rates]
-        request = FriendlyShipping::Request.new(
-          url: url,
-          body: authentication_hash.merge(freight_rate_request_hash).to_json,
-          debug: debug
-        )
+        request = build_request(:rates, freight_rate_request_hash, debug)
 
-        client.post(request).bind do |response|
+        client.post(request).fmap do |response|
           ParseFreightRateResponse.call(response: response, request: request)
         end
       end
 
+      # Get labels for a shipment
+      # @param [Physical::Shipment] shipment The shipment we want to get rates for
+      # @param [FriendlyShipping::Services::UpsFreight::LabelOptions] options Options for shipping this shipment.
+      # @return [Result<ApiResult<ShipmentInformation>] The information that you need for shipping this shipment.
+      def labels(shipment, options:, debug: false)
+        freight_ship_request_hash = GenerateFreightShipRequestHash.call(shipment: shipment, options: options)
+        request = build_request(:labels, freight_ship_request_hash, debug)
+
+        client.post(request).fmap do |response|
+          ParseFreightLabelResponse.call(response: response, request: request)
+        end
+      end
+
       private
 
-      def authentication_hash
-        GenerateUpsSecurityHash.call(key: key, login: login, password: password)
+      def build_request(action, payload, debug)
+        url = base_url + RESOURCES[action]
+        FriendlyShipping::Request.new(
+          url: url,
+          body: payload.to_json,
+          headers: {
+            Content_Type: 'application/json',
+            Accept: 'application/json',
+            Username: login,
+            Password: password,
+            AccessLicenseNumber: key
+          },
+          debug: debug
+        )
       end
 
       def base_url

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateDeliveryOptionsHash
+        def self.call(delivery_options:)
+          {
+            DeliveryOptions: {
+              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
+            }.compact.presence
+          }.compact.presence
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateDocumentOptionsHash
+        def self.call(document_options:)
+          {
+            Type: {
+              Code: document_options.document_type_code
+            },
+            LabelsPerPage: document_options.labels_per_page,
+            Format: {
+              Code: document_options.format_code
+            },
+            PrintFormat: {
+              Code: document_options.thermal_code,
+            },
+            PrintSize: {
+              Length: document_options.length,
+              Width: document_options.width,
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateEmailOptionsHash
+        def self.call(email_options:)
+          {
+            EMailInformation: {
+              EMailType: {
+                Code: email_options.email_type_code,
+              },
+              EMail: {
+                EMailAddress: email_options.email,
+                UndeliverableEMailAddress: email_options.undeliverable_email,
+                EMailText: email_options.body,
+                Subject: email_options.subject
+              }.compact
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups_freight/generate_freight_rate_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_pickup_request_hash'
 
 module FriendlyShipping
   module Services
@@ -20,22 +21,13 @@ module FriendlyShipping
                 },
                 Commodity: options.commodity_information_generator.call(shipment: shipment, options: options),
                 TimeInTransitIndicator: 'true',
-                PickupRequest: pickup_request(options)
+                PickupRequest: GeneratePickupRequestHash.call(pickup_request_options: options.pickup_request_options),
               }.compact.merge(handling_units(shipment, options).reduce(&:merge).to_h)
             }
           end
 
           private
 
-          def pickup_request(options)
-            return unless options.pickup_date
-
-            {
-              PickupDate: options.pickup_date.strftime('%Y%m%d'),
-              AdditionalComments: options.pickup_comments
-            }
-          end
-
           def handling_units(shipment, options)
             all_package_options = shipment.packages.map { |package| options.options_for_package(package) }
             all_package_options.group_by(&:handling_unit_code).map do |_handling_unit_code, options_group|

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_freight/generate_location_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'
+require 'friendly_shipping/services/ups_freight/generate_delivery_options_hash'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateFreightShipRequestHash
+        class << self
+          def call(shipment:, options:)
+            {
+              FreightShipRequest: {
+                Shipment: {
+                  ShipperNumber: options.shipper_number,
+                  ShipFrom: GenerateLocationHash.call(location: shipment.origin),
+                  ShipTo: GenerateLocationHash.call(location: shipment.destination),
+                  PaymentInformation: payment_information(options),
+                  Service: {
+                    Code: options.shipping_method.service_code
+                  },
+                  Commodity: options.commodity_information_generator.call(shipment: shipment, options: options),
+                  Documents: {
+                    Image: options.document_options.map { |doc_opts| GenerateDocumentOptionsHash.call(document_options: doc_opts) }
+                  },
+                  ShipmentServiceOptions: shipment_service_options(options),
+                  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)
+              }
+            }
+          end
+
+          private
+
+          def shipment_service_options(options)
+            email_options = options.email_options.map { |email_opts| GenerateEmailOptionsHash.call(email_options: email_opts) }.presence
+            pickup_options = options.pickup_options ? GeneratePickupOptionsHash.call(pickup_options: options.pickup_options) : nil
+            delivery_options = options.delivery_options ? GenerateDeliveryOptionsHash.call(delivery_options: options.delivery_options) : nil
+            [email_options, pickup_options, delivery_options].compact.presence
+          end
+
+          def handling_units(shipment, options)
+            all_package_options = shipment.packages.map { |package| options.options_for_package(package) }
+            all_package_options.group_by(&:handling_unit_code).map do |_handling_unit_code, options_group|
+              [options_group.first, options_group.length]
+            end.map { |package_options, quantity| handling_unit_hash(package_options, quantity) }
+          end
+
+          def handling_unit_hash(package_options, quantity)
+            {
+              package_options.handling_unit_tag => {
+                Quantity: quantity.to_s,
+                Type: {
+                  Code: package_options.handling_unit_code,
+                  Description: package_options.handling_unit_description
+                }
+              }
+            }
+          end
+
+          def payment_information(options)
+            payer_address = GenerateLocationHash.call(location: options.billing_address).
+                            merge(ShipperNumber: options.shipper_number)
+            {
+              Payer: payer_address,
+              ShipmentBillingOption: {
+                Code: options.billing_code
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,8 +17,11 @@ module FriendlyShipping
                 PostalCode: location.zip,
                 CountryCode: location.country.code
               },
-              AttentionName: location.name
-            }
+              AttentionName: location.name,
+              Phone: {
+                Number: location.phone
+              }.compact.presence
+            }.compact
           end
 
           private

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GeneratePickupOptionsHash
+        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,
+              LimitedAccessPickupIndicator: pickup_options.limited_access_pickup ? "" : nil
+            }.compact.presence
+          }.compact.presence
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GeneratePickupRequestHash
+        class << self
+          def call(pickup_request_options:)
+            return unless pickup_request_options
+
+            {
+              AdditionalComments: pickup_request_options.comments,
+              Requester: {
+                ThirdPartyRequester: pickup_request_options.third_party_requester ? '' : nil,
+                AttentionName: pickup_request_options.requester.name,
+                EMailAddress: pickup_request_options.requester_email,
+                Name: pickup_request_options.requester.company_name,
+                Phone: {
+                  Number: pickup_request_options.requester.phone
+                }.compact
+              }.compact,
+              PickupDate: pickup_request_options.pickup_time_window.begin.strftime('%Y%m%d'),
+              EarliestTimeReady: pickup_request_options.pickup_time_window.begin.strftime('%H%M'),
+              LatestTimeReady: pickup_request_options.pickup_time_window.end.strftime('%H%M'),
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelDeliveryOptions
+        attr_reader :holiday_delivery,
+                    :inside_delivery,
+                    :weekend_delivery,
+                    :lift_gate_required,
+                    :limited_access_delivery
+
+        def initialize(
+          holiday_delivery: nil,
+          inside_delivery: nil,
+          weekend_delivery: nil,
+          lift_gate_required: nil,
+          limited_access_delivery: nil
+        )
+          @holiday_delivery = holiday_delivery
+          @inside_delivery = inside_delivery
+          @weekend_delivery = weekend_delivery
+          @lift_gate_required = lift_gate_required
+          @limited_access_delivery = limited_access_delivery
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelDocumentOptions
+        attr_reader :format, :type, :length, :width, :thermal
+
+        DOCUMENT_TYPES = {
+          label: "30",
+          ups_bol: "20",
+          vics_bol: "21"
+        }.freeze
+
+        DOCUMENT_FORMATS = {
+          pdf: "01"
+        }.freeze
+
+        THERMAL_CODE = {
+          false => "01",
+          true => "02"
+        }.freeze
+
+        def initialize(
+          format: :pdf,
+          type: :label,
+          size: "4x6",
+          thermal: false,
+          labels_per_page: 1
+        )
+          @format = format
+          @type = type
+          @length, @width = size.split('x').sort
+          @thermal = thermal
+          @labels_per_page = labels_per_page
+        end
+
+        def format_code
+          DOCUMENT_FORMATS.fetch(format)
+        end
+
+        def document_type_code
+          DOCUMENT_TYPES.fetch(type)
+        end
+
+        def thermal_code
+          THERMAL_CODE.fetch(thermal)
+        end
+
+        def labels_per_page
+          @labels_per_page.to_s
+        end
+      end
+    end
+  end
+end