friendly_shipping 0.10.1 → 0.10.2

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

@@ -1,240 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      class ParseTimeInTransitResponse
-        class << self
-          # Parse a response from USPS' time in transit API
-          #
-          # @param [FriendlyShipping::Request] request The request that was used to obtain this Response
-          # @param [FriendlyShipping::Response] response The response that USPS returned
-          # @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(
-              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)
-
-              non_expedited_commitments = xml.xpath('//NonExpedited')
-              non_expedited_timings = parse_non_expedited_commitment_nodes(non_expedited_commitments)
-
-              ApiResult.new(
-                expedited_timings + non_expedited_timings,
-                original_request: request,
-                original_response: response
-              )
-            end
-          end
-
-          private
-
-          def parse_expedited_commitment_nodes(expedited_commitment_nodes)
-            return [] if expedited_commitment_nodes.empty?
-
-            # All Expedited Commitments have the same acceptance date
-            # However, sometimes that date is invalid.
-            effective_acceptance_date = [
-              Time.parse(expedited_commitment_nodes.at('EAD').text),
-              Time.parse(expedited_commitment_nodes.document.at('AcceptDate').text)
-            ].max
-            expedited_commitment_nodes.xpath('Commitment').map do |commitment_node|
-              shipping_method = SHIPPING_METHODS.detect do |potential_shipping_method|
-                potential_shipping_method.name == MAIL_CLASSES[commitment_node.at('MailClass').text]
-              end
-              commitment_sequence = commitment_node.at('CommitmentSeq').text
-              data = COMMITMENT_SEQUENCES[commitment_sequence]
-              next unless data # Sometimes USPS returns an invalid CommitmentSeq
-
-              scheduled_delivery_time = data.delete(:commitment_time)
-              scheduled_delivery_date = commitment_node.at('SDD').text
-              parsed_delivery_time = Time.parse("#{scheduled_delivery_date} #{scheduled_delivery_time}")
-              guaranteed = commitment_node.at('IsGuaranteed').text == '1'
-
-              FriendlyShipping::Timing.new(
-                shipping_method: shipping_method,
-                pickup: effective_acceptance_date,
-                delivery: parsed_delivery_time,
-                guaranteed: guaranteed,
-                data: data
-              )
-            end.compact
-          end
-
-          def parse_non_expedited_commitment_nodes(non_expedited_commitment_nodes)
-            non_expedited_commitment_nodes.map do |commitment_node|
-              shipping_method = SHIPPING_METHODS.detect do |potential_shipping_method|
-                potential_shipping_method.name == MAIL_CLASSES[commitment_node.at('MailClass').text]
-              end
-              # We cannot find a shipping method for Mail Classes 4 and 5 because USPS' docs are not clear
-              next unless shipping_method
-
-              warning_text = commitment_node.xpath('HFPU//NonExpeditedTransMsg/Msg')&.text
-              warning = warning_text unless warning_text.empty?
-
-              data = {
-                commitment: commitment_node.at('SvcStdMsg')&.text,
-                destination_type: NON_EXPEDITED_DESTINATION_TYPES[commitment_node.at('NonExpeditedDestType').text],
-                warning: warning
-              }.compact
-
-              scheduled_delivery_date = commitment_node.at('SchedDlvryDate')&.text
-              parsed_delivery_time = Time.parse(scheduled_delivery_date) if scheduled_delivery_date
-              effective_acceptance_date = Time.parse(commitment_node.at('EAD').text)
-
-              FriendlyShipping::Timing.new(
-                shipping_method: shipping_method,
-                pickup: effective_acceptance_date,
-                delivery: parsed_delivery_time,
-                guaranteed: false,
-                data: data
-              )
-            end.compact
-          end
-
-          # The USPS docs say the following:
-          #
-          # Valid Values:
-          # “0” = All Mail Classes
-          # “1” = Priority Mail Express
-          # “2” = Priority Mail
-          # “3” = First-Class - replaced by Ground Advantage (up to 15.999 oz)
-          # “4” = Marketing Mail
-          # “5” = Periodicals
-          # “6” = Package Services
-          # “7” = Parcel Select Ground - replaced by Ground Advantage (1-70 lbs)
-          # “9” = Ground Advantage (1-70 lbs)
-          #
-          # However, no shipping methods really map to "Marketing Mail" or "Periodicals".
-          # This will likely be somewhat more work in the future.
-          MAIL_CLASSES = {
-            '1' => 'Priority Mail Express',
-            '2' => 'Priority Mail',
-            '3' => 'First-Class',
-            '6' => 'Package Services',
-            '7' => 'Parcel Select Ground',
-            '9' => 'Ground Advantage'
-          }.freeze
-
-          # This code carries a few details about the shipment:
-          # - What USPS commits to (1-Day, 2-Day or 3-Day delivery)
-          # - what time the package should arrive
-          # - Whether the package is sent from post office to post office ('Hold For Pickup')
-          # A0110 1-Day at 10:30 AM
-          # B0110 1-Day at 10:30 AM HFPU
-          # A0112 1-Day at 12:00 PM
-          # A0115 1-Day at 3:00 PM
-          # B0115 1-Day at 3:00 PM HFPU
-          # A0210 2-Day at 10:30 AM
-          # A0212 2-Day at 12:00 PM
-          # A0215 2-Day at 3:00 PM
-          # B0210 2-Day at 10:30 AM HFPU
-          # B0215 2-Day at 3:00 PM HFPU
-          # C0100 1-Day Street
-          # C0200 2-Day Street
-          # C0300 3-Day Street
-          # D0100 1-Day PO Box
-          # D0200 2-Day PO Box
-          # D0300 3-Day PO Box
-          # E0100 1-Day HFPU
-          # E0200 2-Day HFPU
-          # E0300 3-Day HFPU
-          COMMITMENT_SEQUENCES = {
-            'A0110' => {
-              commitment: '1-Day',
-              commitment_time: '10:30 AM',
-            },
-            'B0110' => {
-              commitment: '1-Day',
-              commitment_time: '10:30 AM',
-              destination_type: :hold_for_pickup
-            },
-            'A0112' => {
-              commitment: '1-Day',
-              commitment_time: '12:00 PM',
-            },
-            'A0115' => {
-              commitment: '1-Day',
-              commitment_time: '3:00 PM',
-            },
-            'B0115' => {
-              commitment: '1-Day',
-              commitment_time: '3:00 PM',
-              destination_type: :hold_for_pickup
-            },
-            'A0210' => {
-              commitment: '2-Day',
-              commitment_time: '10:30 AM',
-            },
-            'A0212' => {
-              commitment: '2-Day',
-              commitment_time: '12:00 PM',
-            },
-            'A0215' => {
-              commitment: '2-Day',
-              commitment_time: '3:00 PM',
-            },
-            'B0210' => {
-              commitment: '2-Day',
-              commitment_time: '10:30 AM',
-              destination_type: :hold_for_pickup
-            },
-            'B0215' => {
-              commitment: '2-Day',
-              commitment_time: '3:00 PM',
-              destination_type: :hold_for_pickup
-            },
-            'C0100' => {
-              commitment: '1-Day',
-              destination_type: :street
-            },
-            'C0200' => {
-              commitment: '2-Day',
-              destination_type: :street
-            },
-            'C0300' => {
-              commitment: '3-Day',
-              destination_type: :street
-            },
-            'D0100' => {
-              commitment: '1-Day',
-              destination_type: :po_box
-            },
-            'D0200' => {
-              commitment: '2-Day',
-              destination_type: :po_box
-            },
-            'D0300' => {
-              commitment: '3-Day',
-              destination_type: :po_box
-            },
-            'E0100' => {
-              commitment: '1-Day',
-              destination_type: :hold_for_pickup
-            },
-            'E0200' => {
-              commitment: '2-Day',
-              destination_type: :hold_for_pickup
-            },
-            'E0300' => {
-              commitment: '3-Day',
-              destination_type: :hold_for_pickup
-            },
-          }.freeze
-
-          # Things are different for non-expedited shipping methods.
-          NON_EXPEDITED_DESTINATION_TYPES = {
-            '1' => :street,
-            '2' => :po_box,
-            '3' => :hold_for_pickup
-          }.freeze
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    # Option container for rating a shipment via USPS
-    #
-    # Context: The shipment object we're trying to get results for
-    # USPS returns rates on a package-by-package basis, so the options for obtaining rates are
-    # set on the [FriendlyShipping/RateEstimateObject] hash. The possible options are:
-
-    # @param [Physical::ShippingMethod] shipping_method The shipping method ("service" in USPS parlance) we want
-    #   to get rates for.
-    # @param [Boolean] commercial_pricing Whether we prefer commercial pricing results or retail results
-    # @param [Boolean] hold_for_pickup Whether we want a rate with Hold For Pickup Service
-    class Usps
-      class RateEstimateOptions < FriendlyShipping::ShipmentOptions
-        def initialize(
-          package_options_class: FriendlyShipping::Services::Usps::RateEstimatePackageOptions,
-          **kwargs
-        )
-          super(**kwargs.reverse_merge(package_options_class: package_options_class))
-        end
-      end
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    # Options for one package when rating
-    #
-    # @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 [Boolean] transmit_dimensions Indicate whether the reuqest should include the package dimensionals.
-    # @param [Boolean] rectangular Indicate whether the package is rectangular.
-    # @param [Boolean] return_dimensional_weight Indicate whether the response should include dimensional weight.
-    # @param [Boolean] return_fees Indicate whether the response should include fees.
-    class Usps
-      class RateEstimatePackageOptions < FriendlyShipping::PackageOptions
-        attr_reader :box_name,
-                    :commercial_pricing,
-                    :first_class_mail_type,
-                    :hold_for_pickup,
-                    :shipping_method,
-                    :transmit_dimensions,
-                    :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 = 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
-          CONTAINERS.fetch(box_name)
-        end
-
-        # @return [String, nil]
-        def first_class_mail_type_code
-          if %i[parcel package_service package_service_retail].include?(first_class_mail_type)
-            warn "[DEPRECATION] First Class `:#{first_class_mail_type}` has been replaced by Ground Advantage."
-          else
-            FIRST_CLASS_MAIL_TYPES[first_class_mail_type]
-          end
-        end
-
-        def service_code
-          return 'ALL' unless shipping_method
-
-          # Cubic shipping methods don't have HFP or COMMERCIAL modifiers
-          return shipping_method.service_code if shipping_method.service_code =~ /CUBIC/
-
-          service_code = [shipping_method.service_code]
-          service_code << 'HFP' if hold_for_pickup
-          service_code << 'COMMERCIAL' if commercial_pricing
-          service_code.join(' ')
-        end
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      class SerializeAddressValidationRequest
-        def self.call(location:, login:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.AddressValidateRequest USERID: login do
-              xml.Address do
-                xml.Address1 location.address2 # USPS swaps Address1 and Address2 in the request
-                xml.Address2 location.address1
-                xml.City location.city
-                xml.State location.region.code
-                xml.Zip5 location.zip
-                xml.Zip4
-              end
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      class SerializeCityStateLookupRequest
-        def self.call(location:, login:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.CityStateLookupRequest(USERID: login) do
-              xml.ZipCode do
-                xml.Zip5 location.zip
-              end
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      class SerializeRateRequest
-        MAX_REGULAR_PACKAGE_SIDE = Measured::Length(12, :inches)
-
-        class << self
-          # @param [Physical::Shipment] shipment The shipment we want to get rates for
-          #   shipment.packages[0].properties[:box_name] Can be :variable or a
-          #     flat rate container defined in CONTAINERS.
-          # @param [String] login The USPS login code
-          # @param [FriendlyShipping::Services::Usps::RateEstimateOptions] options The options
-          #   object to use with this request.
-          # @return [Array<FriendlyShipping::Rate>] A set of Rates that this package may be sent with
-          def call(shipment:, login:, options:)
-            xml_builder = Nokogiri::XML::Builder.new do |xml|
-              xml.RateV4Request('USERID' => login) do
-                shipment.packages.each_with_index do |package, index|
-                  package_options = options.options_for_package(package)
-                  xml.Package('ID' => index) do
-                    xml.Service(package_options.service_code)
-                    if package_options.first_class_mail_type && package_options.first_class_mail_type_code
-                      xml.FirstClassMailType(package_options.first_class_mail_type_code)
-                    end
-                    xml.ZipOrigination(shipment.origin.zip)
-                    xml.ZipDestination(shipment.destination.zip)
-                    xml.Pounds(0)
-                    xml.Ounces(ounces_for(package))
-                    size_code = size_code_for(package)
-                    xml.Container(package_options.container_code)
-                    xml.Size(size_code)
-                    if package_options.transmit_dimensions && package_options.container_code == 'VARIABLE'
-                      xml.Width("%<width>0.2f" % { width: package.width.convert_to(:inches).value.to_f })
-                      xml.Length("%<length>0.2f" % { length: package.length.convert_to(:inches).value.to_f })
-                      xml.Height("%<height>0.2f" % { height: package.height.convert_to(:inches).value.to_f })
-
-                      # When girth is present, the package is treated as non-rectangular
-                      # when calculating dimensional weight. This results in a smaller
-                      # dimensional weight than a rectangular package would have.
-                      unless package_options.rectangular
-                        xml.Girth("%<girth>0.2f" % { girth: girth(package) })
-                      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
-            end
-            xml_builder.to_xml
-          end
-
-          private
-
-          def machinable(package)
-            MachinablePackage.new(package).machinable? ? 'TRUE' : 'FALSE'
-          end
-
-          def size_code_for(package)
-            if package.dimensions.max <= MAX_REGULAR_PACKAGE_SIDE
-              'REGULAR'
-            else
-              'LARGE'
-            end
-          end
-
-          def ounces_for(package)
-            ounces = package.weight.convert_to(:ounces).value.to_f.round(2).ceil
-            ounces == 16 ? 15.999 : [ounces, 1].max
-          end
-
-          def girth(package)
-            width, length = package.dimensions.sort.first(2)
-            (width.scale(2) + length.scale(2)).convert_to(:inches).value.to_f
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      class SerializeTimeInTransitRequest
-        def self.call(shipment:, options:, login:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.SDCGetLocationsRequest(USERID: login) do
-              xml.MailClass 0 # all mail classes
-              xml.OriginZIP shipment.origin.zip
-              xml.DestinationZIP shipment.destination.zip
-              xml.AcceptDate options.pickup.strftime('%d-%b-%Y')
-              xml.NonEMDetail true
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      CONTAINERS = {
-        variable: 'VARIABLE',
-        large_flat_rate_box: 'LG FLAT RATE BOX',
-        medium_flat_rate_box: 'MD FLAT RATE BOX',
-        small_flat_rate_box: 'SM FLAT RATE BOX',
-        regional_rate_box_a: 'REGIONALRATEBOXA',
-        regional_rate_box_b: 'REGIONALRATEBOXB',
-        flat_rate_envelope: 'FLAT RATE ENVELOPE',
-        legal_flat_rate_envelope: 'LEGAL FLAT RATE ENVELOPE',
-        padded_flat_rate_envelope: 'PADDED FLAT RATE ENVELOPE',
-        gift_card_flat_rate_envelope: 'GIFT CARD FLAT RATE ENVELOPE',
-        window_flat_rate_envelope: 'WINDOW FLAT RATE ENVELOPE',
-        small_flat_rate_envelope: 'SM FLAT RATE ENVELOPE',
-        cubic_soft_pack: 'CUBIC SOFT PACK',
-        cubic_parcels: 'CUBIC PARCELS'
-      }.freeze
-
-      FIRST_CLASS_MAIL_TYPES = {
-        letter: 'LETTER',
-        flat: 'FLAT',
-        parcel: 'PARCEL', # @deprecated
-        post_card: 'POSTCARD',
-        large_post_card: 'LARGE POSTCARD',
-        package_service: 'PACKAGE SERVICE', # @deprecated
-        package_service_retail: 'PACKAGE SERVICE RETAIL' # @deprecated
-      }.freeze
-
-      CLASS_IDS = {
-        priority_mail_express: {
-          standard: '3',
-          hold_for_pickup: '2',
-          sunday_holiday_delivery: '23'
-        },
-        priority_mail_cubic: '999',
-        ground_advantage: '1058'
-      }.freeze
-
-      SHIPPING_METHODS = [
-        ['FIRST CLASS', 'First-Class'],
-        ['GROUND ADVANTAGE', 'Ground Advantage', CLASS_IDS[:ground_advantage]],
-        ['PACKAGE SERVICES', 'Package Services'],
-        ['PRIORITY', 'Priority Mail'],
-        ['PRIORITY MAIL EXPRESS', 'Priority Mail Express', CLASS_IDS[:priority_mail_express].values],
-        ['PRIORITY MAIL CUBIC', 'Priority Mail Cubic', CLASS_IDS[:priority_mail_cubic]],
-        ['STANDARD POST', 'Standard Post'],
-        ['RETAIL GROUND', 'Retail Ground'],
-        ['MEDIA MAIL', 'Media Mail'],
-        ['LIBRARY MAIL', 'Library Mail'],
-      ].map do |code, name, class_ids|
-        FriendlyShipping::ShippingMethod.new(
-          origin_countries: [Carmen::Country.coded('US')],
-          name: name,
-          service_code: code,
-          domestic: true,
-          international: false,
-          data: { class_ids: Array(class_ids) }
-        )
-      end.freeze
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Usps
-      class TimingOptions
-        attr_reader :pickup, :shipping_method
-
-        def initialize(
-          pickup: Time.now,
-          shipping_method: nil
-        )
-          @pickup = pickup
-          @shipping_method = shipping_method
-        end
-      end
-    end
-  end
-end