friendly_shipping 0.3.4 → 0.4.0

data/lib/friendly_shipping/services/ship_engine/parse_label_response.rb

@@ -19,6 +19,10 @@ module FriendlyShipping
             label_url = label_uri_string
           end
 
+          currency = parsed_json.dig('shipment_cost', 'currency')
+          cents = parsed_json.dig('shipment_cost', 'amount') * 100
+          shipment_cost = Money.new(cents, currency)
+
           label = FriendlyShipping::Label.new(
             id: parsed_json['label_id'],
             shipment_id: parsed_json['shipment_id'],
@@ -27,7 +31,8 @@ module FriendlyShipping
             label_href: label_url,
             label_data: label_data,
             label_format: parsed_json['label_format'].to_sym,
-            shipment_cost: parsed_json['shipment_cost']['amount'],
+            shipment_cost: shipment_cost,
+            cost: shipment_cost,
             data: parsed_json
           )
 

data/lib/friendly_shipping/services/ship_engine/parse_rate_estimate_response.rb

@@ -10,14 +10,16 @@ module FriendlyShipping
         extend Dry::Monads::Result::Mixin
 
         class << self
-          def call(response:, carriers:, request:)
+          def call(response:, request:, options:)
             parsed_json = JSON.parse(response.body)
             rates = parsed_json.map do |rate|
-              carrier = carriers.detect { |c| c.id == rate['carrier_id'] }
+              carrier = options.carriers.detect { |c| c.id == rate['carrier_id'] }
               next unless carrier
 
-              shipping_method = carrier.shipping_methods.detect { |sm| sm.service_code == rate['service_code'] }
-              next unless shipping_method
+              shipping_method = FriendlyShipping::ShippingMethod.new(
+                carrier: carrier,
+                service_code: rate['service_code']
+              )
 
               amounts = get_amounts(rate)
               FriendlyShipping::Rate.new(
@@ -26,9 +28,7 @@ module FriendlyShipping
                 remote_service_id: rate['rate_id'],
                 delivery_date: Time.parse(rate['estimated_delivery_date']),
                 warnings: rate['warning_messages'],
-                errors: rate['error_messages'],
-                original_request: request,
-                original_response: response
+                errors: rate['error_messages']
               )
             end.compact
 

data/lib/friendly_shipping/services/ship_engine/rate_estimates_options.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/shipment_options'
+
+module FriendlyShipping
+  module Services
+    class ShipEngine
+      # options for the rate estimates call
+      #
+      # @attribute carriers [Array<FriendlyShipping::Carrier] a list of the carriers we want to get IDs from.
+      class RateEstimatesOptions < ShipmentOptions
+        attr_reader :carriers
+
+        def initialize(carriers:, **kwargs)
+          @carriers = carriers
+          super kwargs
+        end
+
+        def carrier_ids
+          carriers.map(&:id)
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ship_engine/serialize_label_shipment.rb

@@ -5,20 +5,20 @@ module FriendlyShipping
     class ShipEngine
       class SerializeLabelShipment
         class << self
-          def call(shipment:, shipping_method:, test:)
+          def call(shipment:, options:, test:)
             shipment_hash = {
-              label_format: shipment.options[:label_format].presence || "pdf",
-              label_download_type: shipment.options[:label_download_type].presence || "url",
+              label_format: options.label_format,
+              label_download_type: options.label_download_type,
               shipment: {
-                service_code: shipping_method.service_code,
+                service_code: options.shipping_method.service_code,
                 ship_to: serialize_address(shipment.destination),
                 ship_from: serialize_address(shipment.origin),
-                packages: serialize_packages(shipment.packages)
+                packages: serialize_packages(shipment.packages, options)
               }
             }
             # A carrier might not be necessary if the service code is unique within ShipEngine.
-            if shipping_method.carrier
-              shipment_hash[:shipment][:carrier_id] = shipping_method.carrier.id
+            if options.shipping_method.carrier
+              shipment_hash[:shipment][:carrier_id] = options.shipping_method.carrier.id
             end
 
             if test
@@ -45,15 +45,16 @@ module FriendlyShipping
             }
           end
 
-          def serialize_packages(packages)
+          def serialize_packages(packages, options)
             packages.map do |package|
+              package_options = options.options_for_package(package)
               package_hash = serialize_weight(package.weight)
-              if package.container.properties[:usps_label_messages]
-                package_hash[:label_messages] = package.container.properties[:usps_label_messages]
-              end
-              package_code = package.container.properties[:usps_package_code]
-              if package_code
-                package_hash[:package_code] = package_code
+              package_hash[:label_messages] = package_options.messages.map.with_index do |message, index|
+                ["reference#{index + 1}".to_sym, message]
+              end.to_h
+
+              if package_options.package_code
+                package_hash[:package_code] = package_options.package_code
               else
                 package_hash[:dimensions] = {
                   unit: 'inch',

data/lib/friendly_shipping/services/ship_engine/serialize_rate_estimate_request.rb

@@ -4,9 +4,9 @@ module FriendlyShipping
   module Services
     class ShipEngine
       class SerializeRateEstimateRequest
-        def self.call(shipment:, carriers:)
+        def self.call(shipment:, options:)
           {
-            carrier_ids: carriers.map(&:id),
+            carrier_ids: options.carrier_ids,
             from_country_code: shipment.origin.country.alpha_2_code,
             from_postal_code: shipment.origin.zip,
             to_country_code: shipment.destination.country.alpha_2_code,

data/lib/friendly_shipping/services/ups.rb

@@ -6,11 +6,16 @@ require 'friendly_shipping/services/ups/serialize_access_request'
 require 'friendly_shipping/services/ups/serialize_city_state_lookup_request'
 require 'friendly_shipping/services/ups/serialize_address_validation_request'
 require 'friendly_shipping/services/ups/serialize_rating_service_selection_request'
-require 'friendly_shipping/services/ups/parse_address_classification_response'
+require 'friendly_shipping/services/ups/serialize_shipment_accept_request'
+require 'friendly_shipping/services/ups/serialize_shipment_confirm_request'
 require 'friendly_shipping/services/ups/parse_address_validation_response'
+require 'friendly_shipping/services/ups/parse_address_classification_response'
 require 'friendly_shipping/services/ups/parse_city_state_lookup_response'
 require 'friendly_shipping/services/ups/parse_rate_response'
+require 'friendly_shipping/services/ups/parse_shipment_confirm_response'
+require 'friendly_shipping/services/ups/parse_shipment_accept_response'
 require 'friendly_shipping/services/ups/shipping_methods'
+require 'friendly_shipping/services/ups/label_options'
 
 module FriendlyShipping
   module Services
@@ -32,7 +37,9 @@ module FriendlyShipping
       RESOURCES = {
         address_validation: '/ups.app/xml/XAV',
         city_state_lookup: '/ups.app/xml/AV',
-        rates: '/ups.app/xml/Rate'
+        rates: '/ups.app/xml/Rate',
+        ship_confirm: '/ups.app/xml/ShipConfirm',
+        ship_accept: '/ups.app/xml/ShipAccept',
       }.freeze
 
       def initialize(key:, login:, password:, test: true, client: HttpClient.new)
@@ -65,6 +72,44 @@ module FriendlyShipping
         end
       end
 
+      def labels(shipment, options:, debug: false)
+        ## Method body starts
+        ship_confirm_request_xml = SerializeShipmentConfirmRequest.call(
+          shipment: shipment,
+          options: options
+        )
+        ship_confirm_url = base_url + RESOURCES[:ship_confirm]
+
+        ship_confirm_request = FriendlyShipping::Request.new(
+          url: ship_confirm_url,
+          body: access_request_xml + ship_confirm_request_xml,
+          debug: debug
+        )
+
+        client.post(ship_confirm_request).bind do |ship_confirm_response|
+          ParseShipmentConfirmResponse.call(
+            request: ship_confirm_request,
+            response: ship_confirm_response
+          )
+        end.bind do |ship_confirm_result|
+          ship_accept_url = base_url + RESOURCES[:ship_accept]
+          ship_accept_request_xml = SerializeShipmentAcceptRequest.call(
+            digest: ship_confirm_result.data,
+            options: options
+          )
+
+          ship_accept_request = FriendlyShipping::Request.new(
+            url: ship_accept_url,
+            body: access_request_xml + ship_accept_request_xml,
+            debug: debug
+          )
+
+          client.post(ship_accept_request).bind do |ship_accept_response|
+            ParseShipmentAcceptResponse.call(request: ship_accept_request, response: ship_accept_response)
+          end
+        end
+      end
+
       # Validate an address.
       # @param [Physical::Location] location The address we want to verify
       # @return [Result<ApiResult<Array<Physical::Location>>>] The response data from UPS encoded in a

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class Ups
+      # Represents billing-related options for obtaining shipment labels.
+      # @option bill_third_party [Boolean] When truthy, bill an account other than the shipper's.
+      #  Specified by billing_(account, zip and country)
+      # @option bill_to_consignee [Boolean] If billing a third party, bill the consignee instead of the 3rd party shipper
+      # @option prepay [Boolean] If truthy the shipper will be bill immediately. Otherwise the shipper is billed
+      #   when the label is used. Default: false
+      class LabelBillingOptions
+        attr_reader :bill_third_party,
+                    :bill_to_consignee,
+                    :prepay,
+                    :billing_account,
+                    :billing_zip,
+                    :billing_country,
+                    :currency
+
+        def initialize(
+          bill_third_party: false,
+          bill_to_consignee: false,
+          prepay: false,
+          billing_account: nil,
+          billing_zip: nil,
+          billing_country: nil,
+          currency: nil
+        )
+          @bill_third_party = bill_third_party
+          @bill_to_consignee = bill_to_consignee
+          @prepay = prepay
+          @billing_account = billing_account
+          @billing_zip = billing_zip
+          @billing_country = billing_country
+          @currency = currency
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/item_options'
+
+module FriendlyShipping
+  module Services
+    class Ups
+      class LabelItemOptions < FriendlyShipping::ItemOptions
+        PRODUCT_UNIT_OF_MEASURE_CODES = {
+          barrel: 'BA',
+          bundle: 'BE',
+          bag: 'BG',
+          bunch: 'BH',
+          box: 'BOX',
+          bolt: 'BT',
+          butt: 'BU',
+          canister: 'CI',
+          centimeter: 'CM',
+          container: 'CON',
+          crate: 'CR',
+          case: 'CS',
+          carton: 'CT',
+          cylinder: 'CY',
+          dozen: 'DOZ',
+          each: 'EA',
+          envelope: 'EN',
+          feet: 'FT',
+          kilogram: 'KG',
+          kilograms: 'KGS',
+          pound: 'LB',
+          pounds: 'LBS',
+          liter: 'L',
+          meter: 'M',
+          number: 'NMB',
+          packet: 'PA',
+          pallet: 'PAL',
+          piece: 'PC',
+          pieces: 'PCS',
+          proof_liters: 'PF',
+          package: 'PKG',
+          pair: 'PR',
+          pairs: 'PRS',
+          roll: 'RL',
+          set: 'SET',
+          square_meters: 'SME',
+          square_yards: 'SYD',
+          tube: 'TU',
+          yard: 'YD',
+          other: 'OTH'
+        }.freeze
+
+        attr_reader :commodity_code
+
+        def initialize(
+          commodity_code: nil,
+          product_unit_of_measure: :number,
+          **kwargs
+        )
+          @commodity_code = commodity_code
+          @product_unit_of_measure = product_unit_of_measure
+          super kwargs
+        end
+
+        def product_unit_of_measure_code
+          PRODUCT_UNIT_OF_MEASURE_CODES[product_unit_of_measure]
+        end
+
+        private
+
+        attr_reader :product_unit_of_measure
+      end
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups/label_package_options'
+require 'friendly_shipping/services/ups/label_billing_options'
+
+module FriendlyShipping
+  module Services
+    # Option container for a generating UPS labels for a shipment
+    #
+    # Required:
+    #
+    # @param shipping_method [FriendlyShipping::ShippingMethod] The shipping method to use. We only need the
+    #   service_code to be set.
+    # @param shipper_number [String] account number for the shipper
+    #
+    # Optional:
+    #
+    # @param shipper [Physical::Location] The company sending the shipment. Defaults to the shipment's origin.
+    # @param customer_context [String ] Optional element to identify transactions between client and server
+    # @param validate_address [Boolean] Validate the city field with ZIP code and state. If false, only ZIP code
+    #   and state are validated. Default: true
+    # @param negotiated_rates [Boolean] if truthy negotiated rates will be requested from ups. Only valid if
+    #   shipper account has negotiated rates. Default: false
+    # @option sold_to [Physical::Location] The person or company who imports and pays any duties due on the
+    #   current shipment. Default: The shipment's destination
+    # @option saturday_delivery [Boolean] should we request Saturday delivery?. Default: false
+    # @option label_format [String] GIF, EPL, ZPL, STARPL and SPL
+    # @option label_size [Array<Integer>] Dimensions of the label. Default: [4, 6]
+    # @option delivery_confirmation [Symbol] Can be set to any key from SHIPMENT_DELIVERY_CONFIRMATION_CODES.
+    #   Only possible for international shipments that are not between the US and Puerto Rico.
+    # @option carbon_neutral [Boolean] Ship with UPS' carbon neutral program
+    # @option return_service_code [Symbol] If present, marks this a return label. The kind
+    #   of return label is specified by the symbol, one of the keys in RETURN_SERVICE_CODES. Default: nil
+    #
+    # Shipment options for international shipping:
+    #
+    # @option paperless_invoice [Boolean] set to truthy if using paperless invoice to ship internationally. Default false
+    # @option terms_of_shipment [Symbol] used with paperless invoice to specify who pays duties and taxes.
+    #   See TERMS_OF_SHIPMENT constant for possible options.
+    # @option reason_for_export [String] A reason to export the current shipment. Possible values: 'SALE', 'GIFT', 'SAMPLE',
+    #   'RETURN', 'REPAIR', 'INTERCOMPANYDATA', Any other reason. Default: 'SALE'.
+    # @option invoice_date [Date] The invoice date for the shipment
+    #
+    class Ups
+      class LabelOptions < FriendlyShipping::ShipmentOptions
+        SHIPMENT_DELIVERY_CONFIRMATION_CODES = {
+          delivery_confirmation_signature_required: 1,
+          delivery_confirmation_adult_signature_required: 2
+        }.freeze
+
+        TERMS_OF_SHIPMENT_CODES = {
+          cost_and_freight: 'CFR',
+          cost_insurance_and_freight: 'CIF',
+          carriage_and_insurance_paid: 'CIP',
+          carriage_paid_to: 'CPT',
+          delivered_at_frontier: 'DAF',
+          delivery_duty_paid: 'DDP',
+          delivery_duty_unpaid: 'DDU',
+          delivered_ex_quay: 'DEQ',
+          delivered_ex_ship: 'DES',
+          ex_works: 'EXW',
+          free_alongside_ship: 'FAS',
+          free_carrier: 'FCA',
+          free_on_board: 'FOB'
+        }.freeze
+
+        RETURN_SERVICE_CODES = {
+          ups_print_and_mail: 2, # UPS Print and Mail (PNM)
+          ups_return_1_attempt: 3, # UPS Return Service 1-Attempt
+          ups_return_3_attempt: 5, # UPS Return Service 3-Attempt (RS3)
+          ups_electronic_return_label: 8, # UPS Electronic Return Label (ERL)
+          ups_print_return_label: 9, # UPS Print Return Label (PRL)
+          ups_exchange_print_return: 10, # UPS Exchange Print Return Label
+          ups_pack_collect_1_attemt_box_1: 11, # UPS Pack & Collect Service 1-Attempt Box 1
+          ups_pack_collect_1_attemt_box_2: 12, # UPS Pack & Collect Service 1-Attempt Box 2
+          ups_pack_collect_1_attemt_box_3: 13, # UPS Pack & Collect Service 1-Attempt Box 3
+          ups_pack_collect_1_attemt_box_4: 14, # UPS Pack & Collect Service 1-Attempt Box 4
+          ups_pack_collect_1_attemt_box_5: 15, # UPS Pack & Collect Service 1-Attempt Box 5
+          ups_pack_collect_3_attemt_box_1: 16, # UPS Pack & Collect Service 1-Attempt Box 1
+          ups_pack_collect_3_attemt_box_2: 17, # UPS Pack & Collect Service 1-Attempt Box 2
+          ups_pack_collect_3_attemt_box_3: 18, # UPS Pack & Collect Service 1-Attempt Box 3
+          ups_pack_collect_3_attemt_box_4: 19, # UPS Pack & Collect Service 1-Attempt Box 4
+          ups_pack_collect_3_attemt_box_5: 20 # UPS Pack & Collect Service 1-Attempt Box 5
+        }.freeze
+
+        attr_reader :shipping_method,
+                    :shipper_number,
+                    :shipper,
+                    :customer_context,
+                    :validate_address,
+                    :negotiated_rates,
+                    :billing_options,
+                    :sold_to,
+                    :saturday_delivery,
+                    :label_format,
+                    :label_size,
+                    :carbon_neutral,
+                    :paperless_invoice,
+                    :reason_for_export,
+                    :invoice_date
+
+        def initialize(
+          shipping_method:,
+          shipper_number:,
+          shipper: nil,
+          customer_context: nil,
+          validate_address: true,
+          negotiated_rates: false,
+          billing_options: LabelBillingOptions.new,
+          sold_to: nil,
+          saturday_delivery: false,
+          label_format: 'GIF',
+          label_size: [4, 6],
+          delivery_confirmation: nil,
+          carbon_neutral: true,
+          return_service: nil,
+          paperless_invoice: false,
+          terms_of_shipment: nil,
+          reason_for_export: 'SALE',
+          invoice_date: nil,
+          package_options_class: LabelPackageOptions,
+          **kwargs
+        )
+          @shipping_method = shipping_method
+          @shipper_number = shipper_number
+          @shipper = shipper
+          @customer_context = customer_context
+          @validate_address = validate_address
+          @negotiated_rates = negotiated_rates
+          @billing_options = billing_options
+          @sold_to = sold_to
+          @saturday_delivery = saturday_delivery
+          @label_format = label_format
+          @label_size = label_size
+          @delivery_confirmation = delivery_confirmation
+          @carbon_neutral = carbon_neutral
+          @return_service = return_service
+          @paperless_invoice = paperless_invoice
+          @terms_of_shipment = terms_of_shipment
+          @reason_for_export = reason_for_export
+          @invoice_date = invoice_date
+          super kwargs.merge(package_options_class: package_options_class)
+        end
+
+        def delivery_confirmation_code
+          SHIPMENT_DELIVERY_CONFIRMATION_CODES[delivery_confirmation]
+        end
+
+        def terms_of_shipment_code
+          TERMS_OF_SHIPMENT_CODES[terms_of_shipment]
+        end
+
+        def return_service_code
+          RETURN_SERVICE_CODES[return_service]
+        end
+
+        private
+
+        attr_reader :terms_of_shipment,
+                    :return_service,
+                    :delivery_confirmation
+      end
+    end
+  end
+end