friendly_shipping 0.10.1 → 0.10.2

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

@@ -1,285 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeShipmentConfirmRequest
-        class << self
-          # Item options (only necessary for international shipping)
-          # ShipTo CompanyName & AttentionName required for international shipping
-          #
-          # @option description [String] A description of the item for the intl. invoice
-          # @option commodity_code [String] Commodity code for the item. See https://www.tariffnumber.com/
-          # @option value [Money] Price of the item
-          # @option unit_of_item_count [String] What kind of thing is one of this item? Example: Barrel, m3.
-          #   See UPS docs for codes.
-          #
-          def call(
-            shipment:,
-            options:
-          )
-            xml_builder = Nokogiri::XML::Builder.new do |xml|
-              xml.ShipmentConfirmRequest do
-                xml.Request do
-                  xml.RequestAction('ShipConfirm')
-                  # Required element controls level of address validation.
-                  xml.RequestOption(options.validate_address ? 'validate' : 'nonvalidate')
-                  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.Shipment do
-                  xml.Service do
-                    xml.Code(options.shipping_method.service_code)
-                  end
-
-                  xml.ShipTo do
-                    SerializeShipmentAddressSnippet.call(xml: xml, location: shipment.destination, international: international?(shipment))
-                  end
-
-                  # Required element. The company whose account is responsible for the label(s).
-                  xml.Shipper do
-                    SerializeShipmentAddressSnippet.call(xml: xml, location: options.shipper || shipment.origin)
-
-                    xml.ShipperNumber(options.shipper_number)
-                  end
-
-                  if options.shipper || options.return_service_code
-                    origin = options.return_service_code ? shipment.destination : shipment.origin
-                    xml.ShipFrom do
-                      SerializeShipmentAddressSnippet.call(xml: xml, location: origin)
-                    end
-                  end
-
-                  if options.negotiated_rates
-                    xml.RateInformation do
-                      xml.NegotiatedRatesIndicator
-                    end
-                  end
-
-                  # shipment.options.fetch(:reference_numbers, {}).each do |reference_code, reference_value|
-                  #   xml.ReferenceNumber do
-                  #     xml.Code(reference_code)
-                  #     xml.Value(reference_value)
-                  #   end
-                  # end
-
-                  if options.billing_options.prepay
-                    xml.PaymentInformation do
-                      xml.Prepaid do
-                        build_billing_info_node(xml, options)
-                      end
-                    end
-                  else
-                    xml.ItemizedPaymentInformation do
-                      xml.ShipmentCharge do
-                        # Type '01' means 'Transportation'
-                        # This node specifies who will be billed for transportation.
-                        xml.Type('01')
-                        build_billing_info_node(xml, options)
-                      end
-                      if international?(shipment) && options.terms_of_shipment_code == 'DDP'
-                        # The shipper will cover duties and taxes
-                        # Otherwise UPS will charge the receiver
-                        xml.ShipmentCharge do
-                          xml.Type('02') # Type '02' means 'Duties and Taxes'
-                          build_billing_info_node(
-                            xml,
-                            options,
-                            bill_to_consignee: true
-                          )
-                        end
-                      end
-                    end
-                  end
-
-                  if international?(shipment)
-                    unless options.return_service_code
-                      xml.SoldTo do
-                        sold_to_location = options.sold_to || shipment.destination
-                        SerializeShipmentAddressSnippet.call(xml: xml, location: sold_to_location)
-                        xml.AccountNumber(options.sold_to.account_number) if options.sold_to.try(:account_number).present?
-                        xml.TaxIdentificationNumber(options.sold_to.tax_id_number) if options.sold_to.try(:tax_id_number).present?
-                      end
-                    end
-
-                    if shipment.origin.country.code == 'US' && ['CA', 'PR'].include?(shipment.destination.country.code)
-                      # Required for shipments from the US to Puerto Rico or Canada
-                      # We'll assume USD as the origin country is the United States here.
-                      xml.InvoiceLineTotal do
-                        total_value = shipment.packages.inject(Money.new(0, 'USD')) do |shipment_sum, package|
-                          shipment_sum + package.items.inject(Money.new(0, 'USD')) do |package_sum, item|
-                            package_sum + (item.cost || Money.new(0, 'USD'))
-                          end
-                        end
-                        xml.MonetaryValue(total_value.to_f)
-                      end
-                    end
-
-                    contents_description = shipment.packages.flat_map do |package|
-                      package.items.map(&:description)
-                    end.compact.uniq.join(', ').slice(0, 50)
-
-                    unless contents_description.empty?
-                      xml.Description(contents_description)
-                    end
-                  end
-
-                  if options.return_service_code
-                    xml.ReturnService do
-                      xml.Code(options.return_service_code)
-                    end
-                  end
-
-                  xml.ShipmentServiceOptions do
-                    xml.SaturdayDelivery if options.saturday_delivery
-                    xml.UPScarbonneutralIndicator if options.carbon_neutral
-                    if options.delivery_confirmation_code
-                      xml.DeliveryConfirmation do
-                        xml.DCISType(options.delivery_confirmation_code)
-                      end
-                    end
-
-                    if international?(shipment)
-                      build_international_forms(xml, shipment, options)
-                    end
-                  end
-
-                  shipment.packages.each do |package|
-                    package_options = options.options_for_package(package)
-                    reference_numbers = allow_package_level_reference_numbers(shipment) ? package_options.reference_numbers : {}
-                    delivery_confirmation_code = package_level_delivery_confirmation?(shipment) ? package_options.delivery_confirmation_code : nil
-                    SerializePackageNode.call(
-                      xml: xml,
-                      package: package,
-                      reference_numbers: reference_numbers,
-                      delivery_confirmation_code: delivery_confirmation_code,
-                      shipper_release: package_options.shipper_release,
-                      declared_value: package_options.declared_value
-                    )
-                  end
-                end
-
-                xml.LabelSpecification do
-                  xml.LabelStockSize do
-                    xml.Height(options.label_size[0])
-                    xml.Width(options.label_size[1])
-                  end
-
-                  xml.LabelPrintMethod do
-                    xml.Code(options.label_format)
-                  end
-
-                  # API requires these only if returning a GIF formated label
-                  if options.label_format == 'GIF'
-                    xml.HTTPUserAgent('Mozilla/4.5')
-                    xml.LabelImageFormat(options.label_format) do
-                      xml.Code(options.label_format)
-                    end
-                  end
-                end
-              end
-            end
-            xml_builder.to_xml
-          end
-
-          private
-
-          # if the package is US -> US or PR -> PR the only type of reference numbers that are allowed are package-level
-          # Otherwise the only type of reference numbers that are allowed are shipment-level
-          def allow_package_level_reference_numbers(shipment)
-            origin, destination = shipment.origin.country.code, shipment.destination.country.code
-            [['US', 'US'], ['PR', 'PR']].include?([origin, destination])
-          end
-
-          # For certain origin/destination pairs, UPS allows each package in a shipment to have a specified
-          # delivery_confirmation option
-          # otherwise the delivery_confirmation option must be specified on the entire shipment.
-          # See Appendix P of UPS Shipping Package XML Developers Guide for the rules on which the logic below is based.
-          def package_level_delivery_confirmation?(shipment)
-            origin, destination = shipment.origin.country.code, shipment.destination.country.code
-            origin == destination || [['US', 'PR'], ['PR', 'US']].include?([origin, destination])
-          end
-
-          def build_billing_info_node(xml, options, bill_to_consignee: false)
-            billing_options = options.billing_options
-            if billing_options.bill_third_party || bill_to_consignee
-              xml.BillThirdParty do
-                node_type = bill_to_consignee ? :BillThirdPartyConsignee : :BillThirdPartyShipper
-                xml.public_send(node_type) do
-                  xml.AccountNumber(billing_options.billing_account)
-                  xml.ThirdParty do
-                    xml.Address do
-                      xml.PostalCode(billing_options.billing_zip)
-                      xml.CountryCode(billing_options.billing_country)
-                    end
-                  end
-                end
-              end
-            else
-              xml.BillShipper do
-                xml.AccountNumber(options.shipper_number)
-              end
-            end
-          end
-
-          def build_international_forms(xml, shipment, options)
-            return unless options.paperless_invoice
-
-            reason_for_export = options.return_service_code ? "RETURN" : options.reason_for_export
-
-            invoice_date = options.invoice_date || Date.current
-            xml.InternationalForms do
-              xml.FormType('01') # 01 is "Invoice"
-              xml.InvoiceDate(invoice_date.strftime('%Y%m%d'))
-              xml.ReasonForExport(reason_for_export)
-              xml.CurrencyCode(options.billing_options.currency || 'USD')
-              xml.DeclarationStatement(options.declaration_statement) if options.declaration_statement
-
-              if options.terms_of_shipment_code
-                xml.TermsOfShipment(options.terms_of_shipment_code)
-              end
-              all_items = shipment.packages.map(&:items).map(&:to_a).flatten
-              all_item_options = shipment.packages.flat_map do |package|
-                package_options = options.options_for_package(package)
-                package.items.flat_map do |item|
-                  package_options.options_for_item(item)
-                end
-              end
-
-              all_items.group_by(&:description).each do |description, items|
-                # This is a group of identically described items
-                reference_item = items.first
-                # Get the options for this item
-                item_options = all_item_options.detect { |o| o.item_id == reference_item.id } || LabelItemOptions.new(item_id: nil)
-
-                xml.Product do
-                  cost = reference_item.cost || Money.new(0, 'USD')
-                  xml.Description(description&.slice(0, 35))
-                  xml.CommodityCode(item_options.commodity_code)
-                  xml.OriginCountryCode(item_options.country_of_origin || shipment.origin.country.code)
-                  xml.Unit do
-                    xml.Value(cost)
-                    xml.Number(items.length)
-                    xml.UnitOfMeasurement do
-                      xml.Code(item_options.product_unit_of_measure_code)
-                    end
-                  end
-                end
-              end
-            end
-          end
-
-          def international?(shipment)
-            shipment.origin.country != shipment.destination.country
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeTimeInTransitRequest
-        MAX_SHIPMENT_WEIGHT = Measured::Weight.new(150, :pounds)
-
-        def self.call(shipment:, options:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.TimeInTransitRequest do
-              xml.Request do
-                if options.customer_context
-                  xml.TransactionReference do
-                    xml.CustomerContext(options.customer_context)
-                  end
-                end
-                xml.RequestAction('TimeInTransit')
-              end
-              xml.TransitFrom do
-                xml.AddressArtifactFormat do
-                  xml.PoliticalDivision2(shipment.origin.city)
-                  xml.PoliticalDivision1(shipment.origin.region.code)
-                  xml.CountryCode(shipment.origin.country.code)
-                  xml.PostcodePrimaryLow(shipment.origin.zip)
-                end
-              end
-              xml.TransitTo do
-                xml.AddressArtifactFormat do
-                  xml.PoliticalDivision2(shipment.destination.city)
-                  xml.PoliticalDivision1(shipment.destination.region.code)
-                  xml.CountryCode(shipment.destination.country.code)
-                  xml.PostcodePrimaryLow(shipment.destination.zip)
-                end
-              end
-              xml.ShipmentWeight do
-                xml.UnitOfMeasurement do
-                  xml.Code('LBS')
-                end
-                shipment_weight = shipment.packages.map(&:weight).inject(Measured::Weight(0, :pounds), :+)
-                weight_for_ups = [shipment_weight, MAX_SHIPMENT_WEIGHT].min
-                xml.Weight(weight_for_ups.convert_to(:pounds).value.to_f.round(3))
-              end
-              xml.InvoiceLineTotal do
-                xml.CurrencyCode(options.invoice_total.currency.iso_code)
-                xml.MonetaryValue(options.invoice_total.to_f.round(2))
-              end
-              xml.PickupDate(options.pickup.strftime('%Y%m%d'))
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      class SerializeVoidShipmentRequest
-        def self.call(label:)
-          xml_builder = Nokogiri::XML::Builder.new do |xml|
-            xml.VoidShipmentRequest do
-              xml.Request do
-                xml.RequestAction('Void')
-              end
-              xml.ShipmentIdentificationNumber(label.tracking_number)
-            end
-          end
-          xml_builder.to_xml
-        end
-      end
-    end
-  end
-end

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

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      EU_COUNTRIES = %w(
-        AT BE BG CY CZ DE DK EE ES FI FR GB GR HR HU IE IT LT LU LV MT NL PL PT RO SE SI SK
-      ).map { |country_code| Carmen::Country.coded(country_code) }
-
-      class << self
-        private
-
-        def countries_by_code(code)
-          all_countries = Carmen::Country.all
-          covered_countries = EU_COUNTRIES + %w(US PR CA PL MX).map do |country_code|
-            Carmen::Country.coded(country_code)
-          end
-          other_countries = Carmen::Country.all - covered_countries
-          case code
-          when 'EU' then EU_COUNTRIES
-          when 'OTHER' then other_countries
-          when 'ALL' then all_countries
-          else
-            [Carmen::Country.coded(code)]
-          end
-        end
-      end
-
-      SHIPPING_METHODS = [
-        ['US', 'international', 'UPS Standard', '11'],
-        ['US', 'international', 'UPS Worldwide Express', '07'],
-        ['US', 'international', 'UPS Worldwide Expedited', '08'],
-        ['US', 'international', 'UPS Worldwide Express Plus', '54'],
-        ['US', 'international', 'UPS Worldwide Saver', '65'],
-        ['US', 'domestic', 'UPS 2nd Day Air', '02'],
-        ['US', 'domestic', 'UPS 2nd Day Air A.M.', '59'],
-        ['US', 'domestic', 'UPS 3 Day Select', '12'],
-        ['US', 'domestic', 'UPS Ground', '03'],
-        ['US', 'domestic', 'UPS Next Day Air', '01'],
-        ['US', 'domestic', 'UPS Next Day Air Early', '14'],
-        ['US', 'domestic', 'UPS Next Day Air Saver', '13'],
-        ['US', 'domestic', 'UPS SurePost Less than 1LB', '92'],
-        ['US', 'domestic', 'UPS SurePost 1LB or greater', '93'],
-        ['US', 'domestic', 'UPS SurePost BPM', '94'],
-        ['US', 'domestic', 'UPS SurePost Media Mail', '95'],
-        ['CA', 'domestic', 'UPS Expedited Canadian domestic shipments', '02'],
-        ['CA', 'domestic', 'UPS Express Saver Canadian domestic shipments', '13'],
-        ['CA', 'domestic', 'UPS 3 Day Select Shipments originating in Canada to CA and US 48', '12'],
-        ['CA', 'international', 'UPS 3 Day Select Shipments originating in Canada to CA and US 48', '12'],
-        ['CA', 'domestic', 'UPS Access Point Economy Canadian domestic shipments', '70'],
-        ['CA', 'domestic', 'UPS Express Canadian domestic shipments', '01'],
-        ['CA', 'domestic', 'UPS Express Early Canadian domestic shipments', '14'],
-        ['CA', 'international', 'UPS Express Saver International shipments originating in Canada', '65'],
-        ['CA', 'international', 'UPS Standard Shipments originating in Canada (Domestic and Int’l)', '11'],
-        ['CA', 'domestic', 'UPS Standard Shipments originating in Canada (Domestic and Int’l)', '11'],
-        ['CA', 'international', 'UPS Worldwide Expedited International shipments originating in Canada', '08'],
-        ['CA', 'international', 'UPS Worldwide Express International shipments originating in Canada', '07'],
-        ['CA', 'international', 'UPS Worldwide Express Plus International shipments originating in Canada', '54'],
-        ['CA', 'international', 'UPS Express Early Shipments originating in Canada to CA and US 48', '54'],
-        ['CA', 'domestic', 'UPS Express Early Shipments originating in Canada to CA and US 48', '54'],
-        ['EU', 'domestic', 'UPS Access Point Economy Shipments within the European Union', '70'],
-        ['EU', 'international', 'UPS Expedited Shipments originating in the European Union', '08'],
-        ['EU', 'international', 'UPS Express Shipments originating in the European Union', '07'],
-        ['EU', 'international', 'UPS Standard Shipments originating in the European Union', '11'],
-        ['EU', 'international', 'UPS Worldwide Express Plus Shipments originating in the European Union', '54'],
-        ['EU', 'international', 'UPS Worldwide Saver Shipments originating in the European Union', '65'],
-        ['MX', 'domestic', 'UPS Access Point Economy Shipments within Mexico', '70'],
-        ['MX', 'international', 'UPS Expedited Shipments originating in Mexico', '08'],
-        ['MX', 'international', 'UPS Express Shipments originating in Mexico', '07'],
-        ['MX', 'international', 'UPS Standard Shipments originating in Mexico', '11'],
-        ['MX', 'international', 'UPS Worldwide Express Plus Shipments originating in Mexico', '54'],
-        ['MX', 'international', 'UPS Worldwide Saver Shipments originating in Mexico', '65'],
-        ['PL', 'domestic', 'UPS Access Point Economy Polish domestic shipments', '70'],
-        ['PL', 'domestic', 'UPS Today Dedicated Courier Polish domestic shipments', '83'],
-        ['PL', 'domestic', 'UPS Today Express Polish domestic shipments', '85'],
-        ['PL', 'domestic', 'UPS Today Express Saver Polish domestic shipments', '86'],
-        ['PL', 'domestic', 'UPS Today Standard Polish domestic shipments', '82'],
-        ['PL', 'international', 'UPS Expedited Shipments originating in Poland', '08'],
-        ['PL', 'international', 'UPS Express Shipments originating in Poland', '07'],
-        ['PL', 'international', 'UPS Express Plus Shipments originating in Poland', '54'],
-        ['PL', 'international', 'UPS Express Saver Shipments originating in Poland', '65'],
-        ['PL', 'international', 'UPS Standard Shipments originating in Poland', '11'],
-        ['PR', 'domestic', 'UPS 2nd Day Air', '02'],
-        ['PR', 'domestic', 'UPS Ground', '03'],
-        ['PR', 'domestic', 'UPS Next Day Air', '01'],
-        ['PR', 'domestic', 'UPS Next Day Air Early', '14'],
-        ['PR', 'international', 'UPS Worldwide Expedited', '08'],
-        ['PR', 'international', 'UPS Worldwide Express', '07'],
-        ['PR', 'international', 'UPS Worldwide Express Plus', '54'],
-        ['PR', 'international', 'UPS Worldwide Saver', '65'],
-        ['DE', 'domestic', 'UPS Express 12:00 German domestic shipments', '74'],
-        ['OTHER', 'domestic', 'UPS Express', '07'],
-        ['OTHER', 'domestic', 'UPS Standard', '11'],
-        ['OTHER', 'international', 'UPS Worldwide Expedited', '08'],
-        ['OTHER', 'international', 'UPS Worldwide Express Plus', '54'],
-        ['OTHER', 'international', 'UPS Worldwide Saver', '65'],
-        ['ALL', 'international', 'UPS Worldwide Express Freight', '96'],
-        ['ALL', 'international', 'UPS Worldwide Express Freight Midday', '71']
-      ].freeze.map do |origin_country_code, dom_or_intl, name, code|
-        FriendlyShipping::ShippingMethod.new(
-          name: name,
-          service_code: code,
-          domestic: dom_or_intl == 'domestic',
-          international: dom_or_intl == 'international',
-          origin_countries: countries_by_code(origin_country_code),
-          multi_package: true
-        ).freeze
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class Ups
-      # Options for getting timing information from UPS
-      # @attribute [Time] pickup When the shipment will be picked up
-      # @attribute [Money] invoice_total How much the items in the shipment are worth
-      #   As this is not super important for getting timing information, we use a default
-      #   value of 50 USD here.
-      # @attribute [Boolean] documents_only Does the shipment only contain documents?
-      # @attribute [String] customer_context A string to connect request and response in the calling code
-      class TimingOptions
-        attr_reader :pickup,
-                    :invoice_total,
-                    :documents_only,
-                    :customer_context
-
-        def initialize(
-          pickup: Time.now,
-          invoice_total: Money.new(5000, 'USD'),
-          documents_only: false,
-          customer_context: nil
-        )
-          @pickup = pickup
-          @invoice_total = invoice_total
-          @documents_only = documents_only
-          @customer_context = customer_context
-        end
-      end
-    end
-  end
-end