friendly_shipping 0.5.2 → 0.5.3

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelEmailOptions
+        EMAIL_TYPES = {
+          ship_notification: '001',
+          delivery_notification: '002',
+          exception_notification: '003',
+          bol_labels: '004'
+        }.freeze
+
+        attr_reader :email_type,
+                    :email,
+                    :undeliverable_email,
+                    :subject,
+                    :body
+
+        def initialize(
+          email:,
+          email_type:,
+          undeliverable_email:,
+          subject: nil,
+          body: nil
+        )
+          @email = email
+          @email_type = email_type
+          @undeliverable_email = undeliverable_email
+          @subject = subject
+          @body = body
+        end
+
+        def email_type_code
+          EMAIL_TYPES.fetch(email_type)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelItemOptions < RatesItemOptions
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelOptions < RatesOptions
+        attr_reader :document_options,
+                    :email_options,
+                    :pickup_options,
+                    :delivery_options,
+                    :pickup_instructions,
+                    :delivery_instructions,
+                    :handling_instructions
+
+        def initialize(
+          document_options: [],
+          email_options: [],
+          pickup_options: nil,
+          delivery_options: nil,
+          pickup_instructions: nil,
+          delivery_instructions: nil,
+          handling_instructions: nil,
+          **kwargs
+        )
+          @pickup_options = pickup_options
+          @delivery_options = delivery_options
+          @document_options = document_options
+          @email_options = email_options
+          @pickup_instructions = pickup_instructions
+          @delivery_instructions = delivery_instructions
+          @handling_instructions = handling_instructions
+          super kwargs
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelPackageOptions < RatesPackageOptions
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelPickupOptions
+        attr_reader :holiday_pickup,
+                    :inside_pickup,
+                    :weekend_pickup,
+                    :lift_gate_required,
+                    :limited_access_pickup
+
+        def initialize(
+          holiday_pickup: nil,
+          inside_pickup: nil,
+          weekend_pickup: nil,
+          lift_gate_required: nil,
+          limited_access_pickup: nil
+        )
+          @holiday_pickup = holiday_pickup
+          @inside_pickup = inside_pickup
+          @weekend_pickup = weekend_pickup
+          @lift_gate_required = lift_gate_required
+          @limited_access_pickup = limited_access_pickup
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_freight/parse_shipment_document'
+require 'friendly_shipping/services/ups_freight/shipment_information'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class ParseFreightLabelResponse
+        class << self
+          def call(request:, response:)
+            json = JSON.parse(response.body)
+
+            warnings_json = Array.wrap(json.dig("FreightShipResponse", "Response", "Alert"))
+            warnings = warnings_json.map do |detailed_warning|
+              status = detailed_warning['Code']
+              desc = detailed_warning['Description']
+              [status, desc].compact.join(": ")
+            end.join("\n")
+
+            shipment_results = json.dig("FreightShipResponse", "ShipmentResults")
+
+            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)
+
+            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")
+
+            documents = images_data.map { |image_data| ParseShipmentDocument.call(image_data: image_data) }
+
+            FriendlyShipping::ApiResult.new(
+              ShipmentInformation.new(
+                total: total_money,
+                bol_id: bol_id,
+                number: shipment_number,
+                pickup_request_number: pickup_request_number,
+                shipping_method: shipping_method,
+                warnings: warnings,
+                documents: documents
+              ),
+              original_request: request,
+              original_response: response
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,6 @@
 
 require 'friendly_shipping/rate'
 require 'friendly_shipping/api_result'
-require 'friendly_shipping/services/ups_freight/parse_json_response'
 require 'friendly_shipping/services/ups_freight/shipping_methods'
 
 module FriendlyShipping
@@ -11,40 +10,38 @@ module FriendlyShipping
       class ParseFreightRateResponse
         class << self
           def call(request:, response:)
-            parsed_json = ParseJSONResponse.call(response.body, 'FreightRateResponse')
+            json = JSON.parse(response.body)
 
-            parsed_json.fmap do |json|
-              service_code = json.dig("FreightRateResponse", "Service", "Code")
-              shipping_method = SHIPPING_METHODS.detect { |sm| sm.service_code == service_code }
-              total_shipment_charge = json.dig("FreightRateResponse", "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)
-              data = {
-                customer_context: json.dig("FreightRateResponse", "TransactionReference", "TransactionIdentifier"),
-                commodities: Array.wrap(json.dig("FreightRateResponse", "Commodity")),
-                response_body: json
-              }
+            service_code = json.dig("FreightRateResponse", "Service", "Code")
+            shipping_method = SHIPPING_METHODS.detect { |sm| sm.service_code == service_code }
+            total_shipment_charge = json.dig("FreightRateResponse", "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)
+            data = {
+              customer_context: json.dig("FreightRateResponse", "TransactionReference", "TransactionIdentifier"),
+              commodities: Array.wrap(json.dig("FreightRateResponse", "Commodity")),
+              response_body: json
+            }
 
-              days_in_transit = json.dig("FreightRateResponse", "TimeInTransit", "DaysInTransit")
-              if days_in_transit
-                data[:days_in_transit] = days_in_transit.to_i
-              end
-
-              FriendlyShipping::ApiResult.new(
-                [
-                  FriendlyShipping::Rate.new(
-                    amounts: {
-                      total: total_money
-                    },
-                    shipping_method: shipping_method,
-                    data: data
-                  )
-                ],
-                original_request: request,
-                original_response: response
-              )
+            days_in_transit = json.dig("FreightRateResponse", "TimeInTransit", "DaysInTransit")
+            if days_in_transit
+              data[:days_in_transit] = days_in_transit.to_i
             end
+
+            FriendlyShipping::ApiResult.new(
+              [
+                FriendlyShipping::Rate.new(
+                  amounts: {
+                    total: total_money
+                  },
+                  shipping_method: shipping_method,
+                  data: data
+                )
+              ],
+              original_request: request,
+              original_response: response
+            )
           end
         end
       end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_freight/shipment_document'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class ParseShipmentDocument
+        REVERSE_DOCUMENT_TYPES = LabelDocumentOptions::DOCUMENT_TYPES.map(&:reverse_each).map(&:to_a).to_h
+
+        def self.call(image_data:)
+          format_code = image_data.dig("Type", "Code")
+          graphic_image_b64 = image_data.dig("GraphicImage")
+
+          ShipmentDocument.new(
+            format: image_data.dig("Format", "Code").downcase.to_sym,
+            binary: Base64.decode64(graphic_image_b64),
+            document_type: REVERSE_DOCUMENT_TYPES.fetch(format_code)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class PickupRequestOptions
+        attr_reader :pickup_time_window,
+                    :requester,
+                    :third_party_requester,
+                    :requester_email,
+                    :comments
+
+        def initialize(
+          pickup_time_window:,
+          requester:,
+          requester_email:,
+          comments: nil,
+          third_party_requester: false
+        )
+          @pickup_time_window = pickup_time_window
+          @requester = requester
+          @third_party_requester = third_party_requester
+          @requester_email = requester_email
+          @comments = comments
+        end
+      end
+    end
+  end
+end

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

@@ -31,8 +31,7 @@ module FriendlyShipping
                     :billing_code,
                     :customer_context,
                     :shipping_method,
-                    :pickup_date,
-                    :pickup_comments,
+                    :pickup_request_options,
                     :commodity_information_generator
 
         def initialize(
@@ -41,8 +40,7 @@ module FriendlyShipping
           shipping_method:,
           billing: :prepaid,
           customer_context: nil,
-          pickup_date: nil,
-          pickup_comments: nil,
+          pickup_request_options: nil,
           commodity_information_generator: GenerateCommodityInformation,
           **kwargs
         )
@@ -51,8 +49,7 @@ module FriendlyShipping
           @shipping_method = shipping_method
           @billing_code = BILLING_CODES.fetch(billing)
           @customer_context = customer_context
-          @pickup_date = pickup_date
-          @pickup_comments = pickup_comments
+          @pickup_request_options = pickup_request_options
           @commodity_information_generator = commodity_information_generator
           super(**kwargs.merge(package_options_class: RatesPackageOptions))
         end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class RestfulApiErrorHandler
+        extend Dry::Monads::Result::Mixin
+
+        def self.call(error)
+          parsed_json = JSON.parse(error.response.body)
+          errors = parsed_json.dig('response', 'errors')
+
+          failure_string = errors.map do |err|
+            status = err['code']
+            desc = err['message']
+            [status, desc].compact.join(": ").presence || 'UPS could not process the request.'
+          end.join("\n")
+
+          Failure(failure_string)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class ShipmentDocument
+        attr_reader :format, :document_type, :binary
+
+        def initialize(
+          format:,
+          document_type:,
+          binary:
+        )
+          @format = format
+          @document_type = document_type
+          @binary = binary
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class ShipmentInformation
+        attr_reader :documents,
+                    :number,
+                    :pickup_request_number,
+                    :total,
+                    :bol_id,
+                    :shipping_method,
+                    :warnings
+
+        def initialize(
+          total:,
+          bol_id:,
+          number:,
+          pickup_request_number: nil,
+          documents: [],
+          shipping_method: nil,
+          warnings: nil
+        )
+          @total = total
+          @bol_id = bol_id
+          @number = number
+          @pickup_request_number = pickup_request_number
+          @documents = documents
+          @shipping_method = shipping_method
+          @warnings = warnings
+        end
+      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
@@ -50,22 +61,41 @@ module FriendlyShipping
       #   `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] location 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: {
+            Accept: 'application/json',
+            Username: login,
+            Password: password,
+            AccessLicenseNumber: key
+          },
+          debug: debug
+        )
       end
 
       def base_url

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

@@ -12,7 +12,11 @@ module FriendlyShipping
           # @return [Result<FriendlyShipping::AddressValidationResult>]
           def call(request:, response:)
             # Filter out error responses and directly return a failure
-            parsing_result = ParseXMLResponse.call(response.body, 'AddressValidateResponse')
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'AddressValidateResponse'
+            )
             parsing_result.fmap do |xml|
               address = xml.root.at('Address')
               suggestions = [

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

@@ -12,7 +12,11 @@ module FriendlyShipping
           # @return [Result<FriendlyShipping::AddressValidationResult>]
           def call(request:, response:)
             # Filter out error responses and directly return a failure
-            parsing_result = ParseXMLResponse.call(response.body, 'CityStateLookupResponse')
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'CityStateLookupResponse'
+            )
             parsing_result.fmap do |xml|
               address = xml.root.at('ZipCode')
               suggestions = [

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

@@ -20,8 +20,11 @@ module FriendlyShipping
           # @return [Result<ApiResult<Array<FriendlyShipping::Rate>>>] When successfully parsing, an array of rates in a Success Monad.
           def call(request:, response:, shipment:, options:)
             # Filter out error responses and directly return a failure
-            parsing_result = ParseXMLResponse.call(response.body, 'RateV4Response')
-            rates = []
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'RateV4Response'
+            )
             parsing_result.fmap do |xml|
               # Get all the possible rates for each package
               rates_by_package = rates_from_response_node(xml, shipment, options)

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

@@ -15,7 +15,11 @@ module FriendlyShipping
           # @return [Result<ApiResult<Array<FriendlyShipping::Timing>>>] When successfully parsing, an array of timings in a Success Monad.
           def call(request:, response:)
             # Filter out error responses and directly return a failure
-            parsing_result = ParseXMLResponse.call(response.body, 'SDCGetLocationsResponse')
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'SDCGetLocationsResponse'
+            )
             parsing_result.fmap do |xml|
               expedited_commitments = xml.xpath('//Expedited')
               expedited_timings = parse_expedited_commitment_nodes(expedited_commitments)

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

@@ -8,18 +8,18 @@ module FriendlyShipping
         ERROR_TAG = 'Error'
 
         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? || ![expected_root_tag, 'Error'].include?(xml.root.name)
-              Failure('Invalid document')
+              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
@@ -33,6 +33,16 @@ module FriendlyShipping
             desc = xml.xpath('//Error/Description')&.text
             [number, desc].select(&:present?).join(': ').presence&.strip || 'USPS 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/version.rb

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