friendly_shipping 0.10.1 → 0.10.2

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseAddressValidationResponse
-        extend Dry::Monads::Result::Mixin
-
-        def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(
-            request: request,
-            response: response,
-            expected_root_tag: 'AddressValidationResponse'
-          )
-          parsing_result.bind do |xml|
-            if xml.at('NoCandidatesIndicator')
-              Failure(
-                FriendlyShipping::ApiResult.new(
-                  'Address is probably invalid. No similar valid addresses found.',
-                  original_request: request,
-                  original_response: response
-                )
-              )
-            else
-              Success(
-                FriendlyShipping::ApiResult.new(
-                  build_suggestions(xml),
-                  original_request: request,
-                  original_response: response
-                )
-              )
-            end
-          end
-        end
-
-        def self.build_suggestions(xml)
-          xml.xpath('//AddressKeyFormat').map do |address_fragment|
-            Physical::Location.new(
-              address1: address_fragment.xpath('AddressLine[1]')[0]&.text,
-              address2: address_fragment.xpath('AddressLine[2]')[0]&.text,
-              company_name: address_fragment.at('ConsigneeName')&.text,
-              city: address_fragment.at('PoliticalDivision2')&.text,
-              region: address_fragment.at('PoliticalDivision1')&.text,
-              country: address_fragment.at('CountryCode')&.text,
-              zip: "#{address_fragment.at('PostcodePrimaryLow')&.text}-#{address_fragment.at('PostcodeExtendedLow')&.text}",
-              address_type: address_fragment.at('AddressClassification/Description')&.text&.downcase
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseCityStateLookupResponse
-        extend Dry::Monads::Result::Mixin
-
-        def self.call(request:, response:, location:)
-          parsing_result = ParseXMLResponse.call(
-            request: request,
-            response: response,
-            expected_root_tag: 'AddressValidationResponse'
-          )
-          parsing_result.fmap do |xml|
-            FriendlyShipping::ApiResult.new(
-              [
-                Physical::Location.new(
-                  city: xml.at('AddressValidationResult/Address/City')&.text,
-                  region: xml.at('AddressValidationResult/Address/StateProvinceCode')&.text,
-                  country: location.country,
-                  zip: xml.at('AddressValidationResult/Address/PostcodePrimaryLow')&.text,
-                )
-              ],
-              original_request: request,
-              original_response: response
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseModifierElement
-        # @param [Nokogiri::XML::Element] element The modifier element from the source XML
-        # @param [String] currency_code The currency code for this modifier's amount (i.e. 'USD')
-        # @return [Array<String, Money>]
-        def self.call(element, currency_code:)
-          return unless element
-
-          amount = element.at('Amount').text.to_d
-          return if amount.zero?
-
-          currency = Money::Currency.new(currency_code)
-          amount = Money.new(amount * currency.subunit_to_unit, currency)
-
-          modifier_type = element.at('ModifierType').text
-          modifier_description = element.at('ModifierDesc').text
-
-          label = "#{modifier_type} (#{modifier_description})"
-
-          [label, amount]
-        end
-      end
-    end
-  end
-end

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

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseMoneyElement
-        def self.call(element)
-          return unless element
-
-          monetary_value = element.at('MonetaryValue').text.to_d
-          return if monetary_value.zero?
-
-          currency_code = element.at('CurrencyCode').text
-          currency = Money::Currency.new(currency_code)
-          amount = Money.new(monetary_value * currency.subunit_to_unit, currency)
-
-          surcharge_code = element.at('Code')&.text
-          label = surcharge_code ? UPS_SURCHARGE_CODES[surcharge_code] : element.name
-
-          [label, amount]
-        end
-
-        UPS_SURCHARGE_CODES = {
-          "100" => "ADDITIONAL HANDLING",
-          "110" => "COD",
-          "120" => "DELIVERY CONFIRMATION",
-          "121" => "SHIP DELIVERY CONFIRMATION",
-          "153" => "PKG EMAIL SHIP NOTIFICATION",
-          "154" => "PKG EMAIL RETURN NOTIFICATION",
-          "155" => "PKG EMAIL INBOUND RETURN NOTIFICATION",
-          "156" => "PKG EMAIL QUANTUM VIEW SHIP NOTIFICATION",
-          "157" => "PKG EMAIL QUANTUM VIEW EXCEPTION NOTIFICATION",
-          "158" => "PKG EMAIL QUANTUM VIEW DELIVERY NOTIFICATION",
-          "165" => "PKG FAX INBOUND RETURN NOTIFICATION",
-          "166" => "PKG FAX QUANTUM VIEW SHIP NOTIFICATION",
-          "171" => "SHIP EMAIL ERL NOTIFICATION",
-          "173" => "SHIP EMAIL SHIP NOTIFICATION",
-          "174" => "SHIP EMAIL RETURN NOTIFICATION",
-          "175" => "SHIP EMAIL INBOUND RETURN NOTIFICATION",
-          "176" => "SHIP EMAIL QUANTUM VIEW SHIP NOTIFICATION",
-          "177" => "SHIP EMAIL QUANTUM VIEW EXCEPTION NOTIFICATION",
-          "178" => "SHIP EMAIL QUANTUM VIEW DELIVERY NOTIFICATION",
-          "179" => "SHIP EMAIL QUANTUM VIEW NOTIFY",
-          "187" => "SHIP UPS ACCESS POINT NOTIFICATION",
-          "188" => "SHIP EEI FILING NOTIFICATION",
-          "189" => "SHIP UAP SHIPPER NOTIFICATION",
-          "190" => "EXTENDED AREA",
-          "200" => "DRY ICE",
-          "220" => "HOLD FOR PICKUP",
-          "240" => "ORIGIN CERTIFICATE",
-          "250" => "PRINT RETURN LABEL",
-          "258" => "EXPORT LICENSE VERIFICATION",
-          "260" => "PRINT N MAIL",
-          "270" => "RESIDENTIAL ADDRESS",
-          "280" => "RETURN SERVICE 1ATTEMPT",
-          "290" => "RETURN SERVICE 3ATTEMPT",
-          "300" => "SATURDAY DELIVERY",
-          "310" => "SATURDAY PICKUP",
-          "330" => "PKG VERBAL CONFIRMATION",
-          "350" => "ELECTRONIC RETURN LABEL",
-          "372" => "QUANTUM VIEW NOTIFY DELIVERY",
-          "374" => "UPS PREPARED SED FORM",
-          "375" => "FUEL SURCHARGE",
-          "376" => "DELIVERY AREA",
-          "377" => "LARGE PACKAGE",
-          "378" => "SHIPPER PAYS DUTY TAX",
-          "379" => "SHIPPER PAYS DUTY TAX UNPAID",
-          "400" => "INSURANCE",
-          "401" => "SHIP ADDITIONAL HANDLING",
-          "402" => "SHIPPER RELEASE",
-          "403" => "CHECK TO SHIPPER",
-          "404" => "UPS PROACTIVE RESPONSE",
-          "405" => "GERMAN PICKUP",
-          "406" => "GERMAN ROAD TAX",
-          "407" => "EXTENDED AREA PICKUP",
-          "410" => "RETURN OF DOCUMENT",
-          "430" => "PEAK SEASON",
-          "431" => "LARGE PACKAGE SEASONAL SURCHARGE",
-          "432" => "ADDITIONAL HANDLING SEASONAL SURCHARGE",
-          "440" => "SHIP LARGE PACKAGE",
-          "441" => "CARBON NEUTRAL",
-          "442" => "PKG QV IN TRANSIT NOTIFICATION",
-          "443" => "SHIP QV IN TRANSIT NOTIFICATION",
-          "444" => "IMPORT CONTROL",
-          "445" => "COMMERCIAL INVOICE REMOVAL",
-          "446" => "IMPORT CONTROL ELECTRONIC LABEL",
-          "447" => "IMPORT CONTROL PRINT LABEL",
-          "448" => "IMPORT CONTROL PRINT AND MAIL LABEL",
-          "449" => "IMPORT CONTROL ONE PICK UP ATTEMPT LABEL",
-          "450" => "IMPORT CONTROL THREE PICK UP ATTEMPT LABEL",
-          "452" => "REFRIGERATION",
-          "454" => "PAC 1A BOX1",
-          "455" => "PAC 3A BOX1",
-          "456" => "PAC 1A BOX2",
-          "457" => "PAC 3A BOX2",
-          "458" => "PAC 1A BOX3",
-          "459" => "PAC 3A BOX3",
-          "460" => "PAC 1A BOX4",
-          "461" => "PAC 3A BOX4",
-          "462" => "PAC 1A BOX5",
-          "463" => "PAC 3A BOX5",
-          "464" => "EXCHANGE PRINT RETURN LABEL",
-          "465" => "EXCHANGE FORWARD",
-          "466" => "SHIP PREALERT NOTIFICATION",
-          "470" => "COMMITTED DELIVERY WINDOW",
-          "480" => "SECURITY SURCHARGE",
-          "492" => "CUSTOMER TRANSACTION FEE",
-          "500" => "SHIPMENT COD",
-          "510" => "LIFT GATE FOR PICKUP",
-          "511" => "LIFT GATE FOR DELIVERY",
-          "512" => "DROP OFF AT UPS FACILITY",
-          "515" => "UPS PREMIUM CARE",
-          "520" => "OVERSIZE PALLET",
-          "530" => "FREIGHT DELIVERY SURCHARGE",
-          "531" => "FREIGHT PICKUP SURCHARGE",
-          "540" => "DIRECT TO RETAIL",
-          "541" => "DIRECT DELIVERY ONLY",
-          "542" => "DELIVER TO ADDRESSEE ONLY",
-          "543" => "DIRECT TO RETAIL COD",
-          "544" => "RETAIL ACCESS POINT545 SHIPPING TICKET NOTIFICATION",
-          "546" => "ELECTRONIC PACKAGE RELEASE AUTHENTICATION",
-          "547" => "PAY AT STORE"
-        }.freeze
-        private_constant :UPS_SURCHARGE_CODES
-      end
-    end
-  end
-end

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

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseRateResponse
-        class << self
-          def call(request:, response:, shipment:)
-            parsing_result = ParseXMLResponse.call(
-              request: request,
-              response: response,
-              expected_root_tag: 'RatingServiceSelectionResponse'
-            )
-            parsing_result.fmap do |xml|
-              FriendlyShipping::ApiResult.new(
-                build_rates(xml, shipment),
-                original_request: request,
-                original_response: response
-              )
-            end
-          end
-
-          def build_rates(xml, shipment)
-            xml.root.css('> RatedShipment').map do |rated_shipment|
-              service_code = rated_shipment.at('Service/Code').text
-              shipping_method = CARRIER.shipping_methods.detect do |sm|
-                sm.service_code == service_code && shipment.origin.country.in?(sm.origin_countries)
-              end
-              days_to_delivery = rated_shipment.at('GuaranteedDaysToDelivery').text.to_i
-
-              total = ParseMoneyElement.call(rated_shipment.at('TotalCharges')).last
-              insurance_price = ParseMoneyElement.call(rated_shipment.at('ServiceOptionsCharges'))&.last
-              negotiated_rate = ParseMoneyElement.call(
-                rated_shipment.at('NegotiatedRates/NetSummaryCharges/GrandTotal')
-              )&.last
-              negotiated_charges = extract_charges(rated_shipment.xpath('NegotiatedRates/ItemizedCharges'))
-              itemized_charges = extract_charges(rated_shipment.xpath('ItemizedCharges'))
-
-              rated_shipment_warnings = rated_shipment.css('RatedShipmentWarning').map { |e| e.text.strip }
-              if rated_shipment_warnings.any? { |e| e.match?(/to Residential/) }
-                new_address_type = 'residential'
-              elsif rated_shipment_warnings.any? { |e| e.match?(/to Commercial/) }
-                new_address_type = 'commercial'
-              end
-
-              FriendlyShipping::Rate.new(
-                shipping_method: shipping_method,
-                amounts: { total: total },
-                warnings: rated_shipment_warnings,
-                errors: [],
-                data: {
-                  insurance_price: insurance_price,
-                  negotiated_rate: negotiated_rate,
-                  negotiated_charges: negotiated_charges,
-                  days_to_delivery: days_to_delivery,
-                  new_address_type: new_address_type,
-                  itemized_charges: itemized_charges,
-                  packages: build_packages(rated_shipment)
-                }.compact
-              )
-            end
-          end
-
-          private
-
-          def build_packages(rated_shipment)
-            rated_shipment.css('RatedPackage').map do |rated_package|
-              currency_code = rated_package.at('TotalCharges/CurrencyCode').text
-              {
-                transportation_charges: ParseMoneyElement.call(rated_package.at('TransportationCharges'))&.last,
-                base_service_charge: ParseMoneyElement.call(rated_package.at('BaseServiceCharge'))&.last,
-                service_options_charges: ParseMoneyElement.call(rated_package.at('ServiceOptionsCharges'))&.last,
-                itemized_charges: extract_charges(rated_package.xpath('ItemizedCharges')),
-                total_charges: ParseMoneyElement.call(rated_package.at('TotalCharges'))&.last,
-                negotiated_charges: extract_charges(rated_package.xpath('NegotiatedCharges/ItemizedCharges')),
-                rate_modifiers: extract_modifiers(rated_package.xpath('RateModifier'), currency_code: currency_code),
-                weight: BigDecimal(rated_package.at('Weight').text),
-                billing_weight: BigDecimal(rated_package.at('BillingWeight/Weight').text)
-              }.compact
-            end
-          end
-
-          def extract_charges(node)
-            node.map do |element|
-              ParseMoneyElement.call(element)
-            end.compact.to_h
-          end
-
-          # @param [Nokogiri::XML::NodeSet] node The RateModifier node set from the source XML
-          # @param [String] currency_code The currency code for the modifier amounts (i.e. 'USD')
-          # @return [Array<Hash>]
-          def extract_modifiers(node, currency_code:)
-            node.map do |element|
-              ParseModifierElement.call(element, currency_code: currency_code)
-            end.compact.to_h
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseShipmentAcceptResponse
-        extend Dry::Monads::Result::Mixin
-
-        class << self
-          def call(request:, response:)
-            parsing_result = ParseXMLResponse.call(
-              request: request,
-              response: response,
-              expected_root_tag: 'ShipmentAcceptResponse'
-            )
-            parsing_result.fmap do |xml|
-              FriendlyShipping::ApiResult.new(
-                build_labels(xml),
-                original_request: request,
-                original_response: response
-              )
-            end
-          end
-
-          private
-
-          def build_labels(xml)
-            packages = xml.xpath('//ShipmentAcceptResponse/ShipmentResults/PackageResults')
-            form_format = xml.at('Form/Image/ImageFormat/Code')&.text
-            encoded_form = xml.at('Form/Image/GraphicImage')&.text
-            decoded_form = encoded_form ? Base64.decode64(encoded_form) : nil
-            packages.map do |package|
-              cost_breakdown = build_cost_breakdown(package)
-              package_cost = cost_breakdown.values.any? ? cost_breakdown.values.sum : nil
-              encoded_label_data = package.at('LabelImage/GraphicImage')&.text
-              FriendlyShipping::Services::Ups::Label.new(
-                tracking_number: package.at('TrackingNumber').text,
-                usps_tracking_number: package.at('USPSPICNumber')&.text,
-                label_data: encoded_label_data ? Base64.decode64(encoded_label_data) : nil,
-                label_format: package.at('LabelImage/LabelImageFormat/Code')&.text,
-                cost: package_cost,
-                shipment_cost: get_shipment_cost(xml),
-                data: {
-                  cost_breakdown: cost_breakdown,
-                  negotiated_rate: get_negotiated_rate(xml),
-                  form_format: form_format,
-                  form: decoded_form,
-                  customer_context: xml.xpath('//TransactionReference/CustomerContext')&.text
-                }.compact
-              )
-            end
-          end
-
-          def build_cost_breakdown(package)
-            cost_elements = [
-              package.at('BaseServiceCharge'),
-              package.at('ServiceOptionsCharges'),
-              package.xpath('ItemizedCharges')
-            ].flatten
-
-            cost_elements.map { |element| ParseMoneyElement.call(element) }.compact.to_h
-          end
-
-          def get_shipment_cost(shipment_xml)
-            total_charges_element = shipment_xml.at('ShipmentResults/ShipmentCharges/TotalCharges')
-            ParseMoneyElement.call(total_charges_element)&.last
-          end
-
-          def get_negotiated_rate(shipment_xml)
-            negotiated_total_element = shipment_xml.at('NegotiatedRates/NetSummaryCharges/GrandTotal')
-            ParseMoneyElement.call(negotiated_total_element)&.last
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseShipmentConfirmResponse
-        def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(
-            request: request,
-            response: response,
-            expected_root_tag: 'ShipmentConfirmResponse'
-          )
-          parsing_result.fmap do |xml|
-            FriendlyShipping::ApiResult.new(
-              xml.root.at('ShipmentDigest').text,
-              original_request: request,
-              original_response: response
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseTimeInTransitResponse
-        def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(
-            request: request,
-            response: response,
-            expected_root_tag: 'TimeInTransitResponse'
-          )
-          parsing_result.fmap do |xml|
-            origin_country_code = xml.at('TransitResponse/TransitFrom/AddressArtifactFormat/CountryCode').text
-            timings = xml.root.xpath('//TransitResponse/ServiceSummary').map do |service_summary|
-              # First find the shipping method
-              service_description = service_summary.at('Service/Description').text.gsub(/\s+/, ' ').strip
-              shipping_method = SHIPPING_METHODS.detect do |potential_shipping_method|
-                potential_shipping_method.name.starts_with?(service_description) &&
-                  potential_shipping_method.origin_countries.map(&:code).include?(origin_country_code)
-              end
-
-              # Figure out the dates and times
-              delivery_date = service_summary.at('EstimatedArrival/Date').text
-              delivery_time = service_summary.at('EstimatedArrival/Time').text
-              delivery = Time.parse("#{delivery_date} #{delivery_time}")
-              pickup_date = service_summary.at('EstimatedArrival/PickupDate').text
-              pickup_time = service_summary.at('EstimatedArrival/PickupTime')&.text
-              pickup = Time.parse("#{pickup_date} #{pickup_time}")
-
-              # Some additional data
-              guaranteed = service_summary.at('Guaranteed/Code').text == 'Y'
-              business_transit_days = service_summary.at('EstimatedArrival/BusinessTransitDays').text
-
-              FriendlyShipping::Timing.new(
-                shipping_method: shipping_method,
-                pickup: pickup,
-                delivery: delivery,
-                guaranteed: guaranteed,
-                data: {
-                  business_transit_days: business_transit_days
-                }
-              )
-            end
-
-            FriendlyShipping::ApiResult.new(
-              timings,
-              original_request: request,
-              original_response: response
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseVoidShipmentResponse
-        def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(
-            request: request,
-            response: response,
-            expected_root_tag: 'VoidShipmentResponse'
-          )
-          parsing_result.fmap do |xml|
-            FriendlyShipping::ApiResult.new(
-              xml.root.at('ResponseStatusDescription').text,
-              original_request: request,
-              original_response: response
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class ParseXMLResponse
-        extend Dry::Monads::Result::Mixin
-        SUCCESSFUL_RESPONSE_STATUS_CODE = '1'
-
-        class << self
-          def call(request:, response:, expected_root_tag:)
-            xml = Nokogiri.XML(response.body, &:strict)
-
-            if xml.root.nil? || xml.root.name != expected_root_tag
-              wrap_failure('Invalid document', request, response)
-            elsif request_successful?(xml)
-              Success(xml)
-            else
-              wrap_failure(error_message(xml), request, response)
-            end
-          rescue Nokogiri::XML::SyntaxError => e
-            wrap_failure(e, request, response)
-          end
-
-          private
-
-          def request_successful?(xml)
-            xml.root.at('Response/ResponseStatusCode').text == SUCCESSFUL_RESPONSE_STATUS_CODE
-          end
-
-          def error_message(xml)
-            status = xml.root.at_xpath('Response/ResponseStatusDescription')&.text
-            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::ApiResult.new(
-                failure,
-                original_request: request,
-                original_response: response
-              )
-            )
-          end
-        end
-      end
-    end
-  end
-end