friendly_shipping 0.5 → 0.6.1

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,30 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class RestfulApiErrorHandler
+        extend Dry::Monads::Result::Mixin
+
+        def self.call(error, original_request: nil, original_response: nil)
+          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(
+            ApiFailure.new(
+              failure_string,
+              original_request: original_request,
+              original_response: original_response
+            )
+          )
+        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/usps.rb

@@ -112,6 +112,7 @@ module FriendlyShipping
         FriendlyShipping::Request.new(
           url: base_url,
           body: "API=#{RESOURCES[api]}&XML=#{CGI.escape xml}",
+          readable_body: xml,
           debug: debug
         )
       end

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)