friendly_shipping 0.10.1 → 0.10.2

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

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    # Option container for rating a shipment via UPS
-    #
-    # Required:
-    #
-    # @option shipper_number [String] The shipper number of the origin of the shipment.
-    #
-    # Optional:
-    #
-    # @option carbon_neutral [Boolean] Ship with UPS' carbon neutral program
-    # @option customer_context [String ] Optional element to identify transactions between client and server
-    # @option customer_classification [Symbol] Which kind of rates to request. See UPS docs for more details. Default: `shipper_number`
-    # @option negotiated_rates [Boolean] if truthy negotiated rates will be requested from ups. Only valid if
-    #   shipper account has negotiated rates. Default: false
-    # @option pickup_type [String] UPS pickup type. See UPS docs for more details. Default: `daily_pickup`
-    # @option pickup_date [Time] UPS pickup date/time. Default: nil
-    # @option saturday_delivery [Boolean] should we request Saturday delivery?. Default: false
-    # @option saturday_pickup [Boolean] should we request Saturday pickup?. Default: false
-    # @option shipping_method [FriendlyShipping::ShippingMethod] Request rates for a particular shipping method only?
-    #   Default is `nil`, which translates to 'All shipping methods' (The "Shop" option in UPS parlance)
-    # @option sub_version [String] The UPS API sub-version to use for requests. Default: 1707
-    # @option with_time_in_transit [Boolean] Whether to request timing information alongside the rates
-    # @option package_options_class [Class] See FriendlyShipping::ShipmentOptions
-    #
-    class Ups
-      class RateEstimateOptions < FriendlyShipping::ShipmentOptions
-        PICKUP_TYPE_CODES = {
-          daily_pickup: "01",
-          customer_counter: "03",
-          one_time_pickup: "06",
-          on_call_air: "07",
-          suggested_retail_rates: "11",
-          letter_center: "19",
-          air_service_center: "20"
-        }.freeze
-
-        CUSTOMER_CLASSIFICATION_CODES = {
-          shipper_number: "00",
-          daily_rates: "01",
-          retail_rates: "04",
-          regional_rates: "05",
-          general_rates: "06",
-          standard_rates: "53"
-        }.freeze
-
-        SUB_VERSIONS = %w[1601 1607 1701 1707 1801 2108 2201 2205].freeze
-
-        attr_reader :carbon_neutral,
-                    :customer_context,
-                    :destination_account,
-                    :negotiated_rates,
-                    :pickup_date,
-                    :saturday_delivery,
-                    :saturday_pickup,
-                    :shipper,
-                    :shipper_number,
-                    :shipping_method,
-                    :sub_version,
-                    :with_time_in_transit
-
-        def initialize(
-          shipper_number:,
-          carbon_neutral: true,
-          customer_context: nil,
-          customer_classification: :daily_rates,
-          destination_account: nil,
-          negotiated_rates: false,
-          pickup_type: :daily_pickup,
-          pickup_date: nil,
-          saturday_delivery: false,
-          saturday_pickup: false,
-          shipper: nil,
-          shipping_method: nil,
-          sub_version: "1707",
-          with_time_in_transit: false,
-          package_options_class: FriendlyShipping::Services::Ups::RateEstimatePackageOptions,
-          **kwargs
-        )
-          raise ArgumentError, "Invalid sub-version: #{sub_version}" unless sub_version.in?(SUB_VERSIONS)
-
-          @carbon_neutral = carbon_neutral
-          @customer_context = customer_context
-          @customer_classification = customer_classification
-          @destination_account = destination_account
-          @negotiated_rates = negotiated_rates
-          @shipper_number = shipper_number
-          @pickup_type = pickup_type
-          @pickup_date = pickup_date
-          @saturday_delivery = saturday_delivery
-          @saturday_pickup = saturday_pickup
-          @shipper = shipper
-          @shipping_method = shipping_method
-          @sub_version = sub_version
-          @with_time_in_transit = with_time_in_transit
-          super(**kwargs.reverse_merge(package_options_class: package_options_class))
-        end
-
-        def pickup_type_code
-          PICKUP_TYPE_CODES[@pickup_type]
-        end
-
-        def customer_classification_code
-          CUSTOMER_CLASSIFICATION_CODES[@customer_classification]
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      # Package properties relevant for quoting a UPS package
-      #
-      # @option transmit_dimensions [Boolean] Whether to transmit the dimensions of this package, or quote only based on weight.
-      class RateEstimatePackageOptions < FriendlyShipping::PackageOptions
-        attr_reader :transmit_dimensions
-
-        def initialize(
-          transmit_dimensions: true,
-          **kwargs
-        )
-          @transmit_dimensions = transmit_dimensions
-          super(**kwargs)
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeAccessRequest
-        def self.call(login:, password:, key:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.AccessRequest do
-              xml.AccessLicenseNumber(key)
-              xml.UserId(login)
-              xml.Password(password)
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeAddressSnippet
-        class << self
-          def call(xml:, location:, international: false)
-            if international
-              name = (location.company_name || location.name)[0..34]
-              attention_name = location.name
-            elsif location.company_name # Is this a business address?
-              name = location.company_name[0..34]
-              attention_name = location.name
-            else
-              name = location.name
-              attention_name = nil
-            end
-
-            # UPS wants a different main Name tag when it's the shipper
-            if xml.parent.name == "Shipper"
-              xml.Name(name)
-            else
-              xml.CompanyName(name)
-            end
-
-            if attention_name
-              xml.AttentionName(attention_name)
-            end
-
-            xml.PhoneNumber(location.phone) if location.phone
-
-            xml.Address do
-              xml.AddressLine1(location.address1) if location.address1
-              xml.AddressLine2(location.address2) if location.address2
-
-              xml.City(location.city) if location.city
-              xml.PostalCode(location.zip) if location.zip
-
-              # StateProvinceCode required for negotiated rates but not otherwise, for some reason
-              xml.StateProvinceCode(location.region.code) if location.region
-              xml.CountryCode(location.country.code) if location.country
-              residential_address_indicator(xml, location)
-            end
-          end
-
-          private
-
-          def residential_address_indicator(xml, location)
-            # Quote residential rates by default. If UPS doesn't know if the address is residential or
-            # commercial, it will quote a residential rate by default. Even with this flag being set,
-            # if UPS knows the address is commercial it will often quote a commercial rate.
-            #
-            xml.ResidentialAddressIndicator unless location.commercial?
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeAddressValidationRequest
-        attr_reader :location
-
-        REQUEST_ACTION = 'XAV'
-        REQUEST_OPTIONS = {
-          validation: 1,
-          classification: 2,
-          both: 3
-        }.freeze
-
-        def self.call(location:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.AddressValidationRequest do
-              xml.Request do
-                xml.RequestAction REQUEST_ACTION
-                xml.RequestOption REQUEST_OPTIONS[:both]
-              end
-
-              xml.AddressKeyFormat do
-                xml.ConsigneeName(location.company_name.presence || location.name)
-                xml.AddressLine location.address1
-                xml.AddressLine location.address2
-                xml.PoliticalDivision2 location.city
-                xml.PoliticalDivision1 location.region.code
-                xml.PostcodePrimaryLow location.zip
-                xml.CountryCode location.country.code
-              end
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeCityStateLookupRequest
-        REQUEST_ACTION = 'AV'
-
-        def self.call(location:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.AddressValidationRequest do
-              xml.Request do
-                xml.RequestAction REQUEST_ACTION
-              end
-              xml.Address do
-                xml.PostalCode location.zip
-                xml.CountryCode location.country.code
-              end
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializePackageNode
-        def self.call(
-          xml:,
-          package:,
-          reference_numbers: {},
-          delivery_confirmation_code: nil,
-          shipper_release: false,
-          transmit_dimensions: true,
-          declared_value: false
-        )
-          xml.Package do
-            xml.PackagingType do
-              xml.Code('02')
-            end
-
-            if package.items.any?(&:description)
-              xml.Description(package.items.map(&:description).compact.join(', '))
-            end
-
-            if transmit_dimensions && package.dimensions.all? { |dim| !dim.value.zero? && !dim.value.infinite? }
-              xml.Dimensions do
-                xml.UnitOfMeasurement do
-                  xml.Code('IN')
-                end
-                xml.Length(package.length.convert_to(:inches).value.to_f.round(3))
-                xml.Width(package.width.convert_to(:inches).value.to_f.round(3))
-                xml.Height(package.height.convert_to(:inches).value.to_f.round(3))
-              end
-            end
-
-            xml.PackageWeight do
-              xml.UnitOfMeasurement do
-                xml.Code('LBS')
-              end
-
-              xml.Weight([package.weight.convert_to(:pounds).value.to_f.round(2).ceil, 1].max)
-            end
-
-            xml.PackageServiceOptions do
-              if shipper_release
-                xml.ShipperReleaseIndicator
-              end
-              if delivery_confirmation_code
-                xml.DeliveryConfirmation do
-                  xml.DCISType(delivery_confirmation_code)
-                end
-              end
-              if declared_value
-                xml.DeclaredValue do
-                  xml.CurrencyCode('USD')
-                  monetary_value = package.items.inject(Money.new(0, 'USD')) do |package_sum, item|
-                    package_sum + (item.cost || Money.new(0, 'USD'))
-                  end
-                  xml.MonetaryValue(monetary_value)
-                end
-              end
-            end
-
-            reference_numbers.each do |reference_code, reference_number|
-              xml.ReferenceNumber do
-                xml.Code(reference_code)
-                xml.Value(reference_number)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeRatingServiceSelectionRequest
-        def self.call(shipment:, options:)
-          shipper = options.shipper || shipment.origin
-
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.RatingServiceSelectionRequest do
-              xml.Request do
-                xml.RequestAction('Rate')
-                # If no shipping method is given, request all of them
-                # I one is given, omit the request option. It then becomes "Rate", the default.
-                xml.RequestOption('Shop') unless options.shipping_method
-                xml.SubVersion(options.sub_version)
-                # Optional element to identify transactions between client and server.
-                if options.customer_context
-                  xml.TransactionReference do
-                    xml.CustomerContext(options.customer_context)
-                  end
-                end
-              end
-
-              xml.PickupType do
-                xml.Code(options.pickup_type_code)
-              end
-              xml.CustomerClassification do
-                xml.Code(options.customer_classification_code)
-              end
-
-              xml.Shipment do
-                # not implemented: Shipment/Description element
-                xml.Shipper do
-                  SerializeAddressSnippet.call(xml: xml, location: shipper)
-
-                  xml.ShipperNumber(options.shipper_number)
-                end
-
-                xml.ShipTo do
-                  SerializeAddressSnippet.call(xml: xml, location: shipment.destination)
-
-                  if options.destination_account
-                    xml.ShipperAssignedIdentificationNumber(options.destination_account)
-                  end
-                end
-
-                if shipper != shipment.origin
-                  xml.ShipFrom do
-                    SerializeAddressSnippet.call(xml: xml, location: shipment.origin)
-                  end
-                end
-
-                if options.pickup_date && options.sub_version.to_i >= 2205
-                  xml.DeliveryTimeInformation do
-                    xml.Pickup do
-                      xml.Date options.pickup_date.strftime('%Y%m%d')
-                      xml.Time options.pickup_date.strftime('%H%M')
-                    end
-                  end
-                end
-
-                shipment.packages.each do |package|
-                  package_options = options.options_for_package(package)
-                  SerializePackageNode.call(
-                    xml: xml,
-                    package: package,
-                    transmit_dimensions: package_options.transmit_dimensions
-                  )
-                end
-
-                if options.shipping_method
-                  xml.Service do
-                    xml.Code options.shipping_method.service_code
-                  end
-                end
-
-                xml.ShipmentServiceOptions do
-                  xml.UPScarbonneutralIndicator if options.carbon_neutral
-                  xml.SaturdayDelivery if options.saturday_delivery
-                  xml.SaturdayPickup if options.saturday_pickup
-                end
-
-                if options.negotiated_rates
-                  xml.RateInformation do
-                    xml.NegotiatedRatesIndicator if options.negotiated_rates
-                  end
-                end
-              end
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeShipmentAcceptRequest
-        def self.call(digest:, options:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.ShipmentAcceptRequest do
-              xml.Request do
-                xml.RequestAction('ShipAccept')
-                xml.SubVersion(options.sub_version)
-                if options.customer_context
-                  xml.TransactionReference do
-                    xml.CustomerContext(options.customer_context)
-                  end
-                end
-              end
-              xml.ShipmentDigest(digest)
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeShipmentAddressSnippet < SerializeAddressSnippet
-        class << self
-          private
-
-          def residential_address_indicator(xml, location)
-            # Shipment creation uses a different element to indicate residential addresses.
-            # Rates use ResidentialAddressIndicator whereas shipments use ResidentialAddress.
-            # Presence indicates residential address. Absence indicates commercial address.
-            #
-            xml.ResidentialAddress unless location.commercial?
-          end
-        end
-      end
-    end
-  end
-end