friendly_shipping 0.4.14 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d43e668240fd5d6edb702b48b28e7a886abf53843f3963feb44fcff17a7f498a
-  data.tar.gz: 84e4efa1108768940d25493ba816197879c5dd9ad51ce64d5c1f5be8d2f5c92f
+  metadata.gz: a7033f8bf845a41a0cefa6899a465fd78a85077ff565c7c30f67d04f20708ff6
+  data.tar.gz: 2c5207e0139608d78b7c65b6f273b9dc222bc750bc47e587147e8f486c908b43
 SHA512:
-  metadata.gz: d0f0c826feea1c9f9396785049f07c7635f7be2386619d3b3c217339da7f363e43842a2b3eceef2204556868be082b01f76cc96dc36b4849649cd09baa924a79
-  data.tar.gz: 0c56d00886b43ac1d4a272c36d7dd90b3eb791315dcedcd689fe95450a6f23e0c76fb9d1e7c2c26f7a146bb418e27296c5911bcee6e698de287b53427926c05c
+  metadata.gz: 00d7ce8fe1d737b482d71a6ff96195a82dc70b94c7784291c9cc18eb2f71ca529dadf33900a7f5aef223a4f89a3b1297403d7bc352dd9e8255c139b11b7351c1
+  data.tar.gz: 7a7746f0c59dfcd03d2a330142f106cfe3c0fc7b82628859691d28c0dbd27e3d7584670c44f3509780271aaaf44fbd83551d0e1415ac14807d9ec2578891ab95

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.4
+       - image: circleci/ruby:2.5
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 inherit_from:
 - .rubocop-relaxed.yml

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5] - 2020-01-24
+
+### Removed
+- Drop support for Ruby 2.4 (#83)
+
+### Changed
+- UPS/USPS Services: Use options classes for rate estimates (#82)
+
 ## [0.4.14] - 2020-01-21
 
 ### Changed

data/friendly_shipping.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "nokogiri", ">= 1.6"
   spec.add_runtime_dependency "physical", ">= 0.4.4"
   spec.add_runtime_dependency "rest-client", "~> 2.0"
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "dotenv"

data/lib/friendly_shipping/services/ups.rb

@@ -20,6 +20,7 @@ require 'friendly_shipping/services/ups/parse_time_in_transit_response'
 require 'friendly_shipping/services/ups/parse_void_shipment_response'
 require 'friendly_shipping/services/ups/shipping_methods'
 require 'friendly_shipping/services/ups/label_options'
+require 'friendly_shipping/services/ups/rate_estimate_options'
 require 'friendly_shipping/services/ups/timing_options'
 
 module FriendlyShipping
@@ -63,10 +64,12 @@ module FriendlyShipping
 
       # Get rates for a shipment
       # @param [Physical::Shipment] shipment The shipment we want to get rates for
+      # @param [FriendlyShipping::Services::Ups::RateEstimateOptions] options What options
+      #    to use for this rate estimate call
       # @return [Result<ApiResult<Array<Rate>>>] The rates returned from UPS encoded in a
       #   `FriendlyShipping::ApiResult` object.
-      def rate_estimates(shipment, debug: false)
-        rate_request_xml = SerializeRatingServiceSelectionRequest.call(shipment: shipment)
+      def rate_estimates(shipment, options:, debug: false)
+        rate_request_xml = SerializeRatingServiceSelectionRequest.call(shipment: shipment, options: options)
         url = base_url + RESOURCES[:rates]
         request = FriendlyShipping::Request.new(
           url: url,

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups/rate_estimate_package_options'
+
+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 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 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
+
+        attr_reader :carbon_neutral,
+                    :customer_context,
+                    :destination_account,
+                    :negotiated_rates,
+                    :saturday_delivery,
+                    :saturday_pickup,
+                    :shipper,
+                    :shipper_number,
+                    :shipping_method,
+                    :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,
+          saturday_delivery: false,
+          saturday_pickup: false,
+          shipper: nil,
+          shipping_method: nil,
+          with_time_in_transit: false,
+          package_options_class: FriendlyShipping::Services::Ups::RateEstimatePackageOptions,
+          **kwargs
+        )
+          @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
+          @saturday_delivery = saturday_delivery
+          @saturday_pickup = saturday_pickup
+          @shipper = shipper
+          @shipping_method = shipping_method
+          @with_time_in_transit = with_time_in_transit
+          super kwargs.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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups/label_item_options'
+
+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_package_node.rb

@@ -9,7 +9,8 @@ module FriendlyShipping
           package:,
           reference_numbers: {},
           delivery_confirmation_code: nil,
-          shipper_release: false
+          shipper_release: false,
+          transmit_dimensions: true
         )
           xml.Package do
             xml.PackagingType do
@@ -20,7 +21,7 @@ module FriendlyShipping
               xml.Description(package.items.map(&:description).compact.join(', '))
             end
 
-            if package.dimensions.all? { |dim| !dim.value.zero? && !dim.value.infinite? }
+            if transmit_dimensions && package.dimensions.all? { |dim| !dim.value.zero? && !dim.value.infinite? }
               xml.Dimensions do
                 xml.UnitOfMeasurement do
                   xml.Code('IN')

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

@@ -8,47 +8,30 @@ module FriendlyShipping
   module Services
     class Ups
       class SerializeRatingServiceSelectionRequest
-        PICKUP_CODES = HashWithIndifferentAccess.new(
-          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"
-        )
-
-        CUSTOMER_CLASSIFICATIONS = HashWithIndifferentAccess.new(
-          shipper_number: "00",
-          daily_rates: "01",
-          retail_rates: "04",
-          regional_rates: "05",
-          general_rates: "06",
-          standard_rates: "53"
-        )
-
-        def self.call(shipment:)
-          shipper = shipment.options[:shipper] || shipment.origin
-          pickup_type = PICKUP_CODES[shipment.options[:pickup_type] || :daily_pickup]
-          customer_classification = CUSTOMER_CLASSIFICATIONS[
-            shipment.options[:customer_classification] || :daily_rates
-          ]
-          origin_account = shipment.options[:origin_account]
-          destination_account = shipment.options[:destination_account]
+        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')
-                xml.RequestOption('Shop')
+                # 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('1707')
+                # 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(pickup_type)
+                xml.Code(options.pickup_type_code)
               end
               xml.CustomerClassification do
-                xml.Code(customer_classification)
+                xml.Code(options.customer_classification_code)
               end
 
               xml.Shipment do
@@ -56,14 +39,14 @@ module FriendlyShipping
                 xml.Shipper do
                   SerializeAddressSnippet.call(xml: xml, location: shipper)
 
-                  xml.ShipperNumber(origin_account)
+                  xml.ShipperNumber(options.shipper_number)
                 end
 
                 xml.ShipTo do
                   SerializeAddressSnippet.call(xml: xml, location: shipment.destination)
 
-                  if destination_account
-                    xml.ShipperAssignedIdentificationNumber(destination_account)
+                  if options.destination_account
+                    xml.ShipperAssignedIdentificationNumber(options.destination_account)
                   end
                 end
 
@@ -74,7 +57,30 @@ module FriendlyShipping
                 end
 
                 shipment.packages.each do |package|
-                  SerializePackageNode.call(xml: xml, package: 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

data/lib/friendly_shipping/services/usps.rb

@@ -11,6 +11,7 @@ require 'friendly_shipping/services/usps/parse_city_state_lookup_response'
 require 'friendly_shipping/services/usps/parse_rate_response'
 require 'friendly_shipping/services/usps/parse_time_in_transit_response'
 require 'friendly_shipping/services/usps/timing_options'
+require 'friendly_shipping/services/usps/rate_estimate_options'
 
 module FriendlyShipping
   module Services
@@ -48,25 +49,19 @@ module FriendlyShipping
 
       # Get rate estimates from USPS
       #
-      # @param [Physical::Shipment] shipment 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 [Physical::Package.container.properties] hash. The possible options are:
-      #   @property [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.
-      #   @property [Boolean] commercial_pricing Whether we prefer commercial pricing results or retail results
-      #   @property [Boolean] hold_for_pickup Whether we want a rate with Hold For Pickup Service
-      # @param [Physical::ShippingMethod] shipping_method The shipping method ("service" in USPS parlance) we want
-      #   to get rates for.
+      # @param [Physical::Shipment] shipment
+      # @param [FriendlyShipping::Services::Usps::RateEstimateOptions] options What options
+      #    to use for this rate estimate call
       #
       # @return [Result<Array<FriendlyShipping::Rate>>] When successfully parsing, an array of rates in a Success Monad.
       #   When the parsing is not successful or USPS can't give us rates, a Failure monad containing something that
       #   can be serialized into an error message using `to_s`.
-      def rate_estimates(shipment, shipping_method: nil, debug: false)
-        rate_request_xml = SerializeRateRequest.call(shipment: shipment, login: login, shipping_method: shipping_method)
+      def rate_estimates(shipment, options: RateEstimateOptions.new, debug: false)
+        rate_request_xml = SerializeRateRequest.call(shipment: shipment, login: login, options: options)
         request = build_request(api: :rates, xml: rate_request_xml, debug: debug)
 
         client.post(request).bind do |response|
-          ParseRateResponse.call(response: response, request: request, shipment: shipment)
+          ParseRateResponse.call(response: response, request: request, shipment: shipment, options: options)
         end
       end
 

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

@@ -16,19 +16,18 @@ module FriendlyShipping
         # @param [Array<FriendlyShipping::Rate>] The rates we select from
         #
         # @return [FriendlyShipping::Rate] The rate that most closely matches our package
-        def self.call(shipping_method, package, rates)
+        def self.call(shipping_method, rates, package_options)
           # Keep all rates with the requested shipping method
           rates_with_this_shipping_method = rates.select { |r| r.shipping_method == shipping_method }
 
           # Keep only rates with the package type of this package
           rates_with_this_package_type = rates_with_this_shipping_method.select do |r|
-            r.data[:box_name] == package.properties[:box_name] ||
-              r.data[:box_name] == :flat_rate_boxes && package.properties[:box_name]&.match?(FLAT_RATE_BOX)
+            r.data[:box_name] == package_options.box_name
           end
 
           # Filter by our package's `hold_for_pickup` option
           rates_with_this_hold_for_pickup_option = rates_with_this_package_type.select do |r|
-            r.data[:hold_for_pickup] == !!package.properties[:hold_for_pickup]
+            r.data[:hold_for_pickup] == package_options.hold_for_pickup
           end
 
           # At this point, we have one or two rates left, and they're similar enough.

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

@@ -57,7 +57,7 @@ module FriendlyShipping
         CURRENCY = Money::Currency.new('USD').freeze
 
         class << self
-          def call(rate_node, package)
+          def call(rate_node, package, package_options)
             # "A mail class identifier for the postage returned. Not necessarily unique within a <Package/>."
             # (from the USPS docs). We save this on the data Hash, but do not use it for identifying shipping methods.
             service_code = rate_node.attributes[SERVICE_CODE_TAG].value
@@ -84,7 +84,7 @@ module FriendlyShipping
             # In these cases, return the commercial rate instead of the normal rate.
             # Some rates are available in both commercial and retail pricing - if we want the commercial pricing here,
             # we need to specify the commercial_pricing property on the `Physical::Package`.
-            rate_value = if (package.properties[:commercial_pricing] || rate_node.at(RATE_TAG).text.to_d.zero?) && rate_node.at(COMMERCIAL_RATE_TAG)
+            rate_value = if (package_options.commercial_pricing || rate_node.at(RATE_TAG).text.to_d.zero?) && rate_node.at(COMMERCIAL_RATE_TAG)
                            rate_node.at(COMMERCIAL_RATE_TAG).text.to_d
                          else
                            rate_node.at(RATE_TAG).text.to_d
@@ -107,9 +107,7 @@ module FriendlyShipping
             # We find out the box name using a bit of Regex magic using named captures. See the `BOX_REGEX`
             # constant above.
             box_name_match = service_name.match(/#{BOX_REGEX}/)
-            box_name = if box_name_match
-                         box_name_match.named_captures.compact.keys.last.to_sym
-                       end
+            box_name = box_name_match ? box_name_match.named_captures.compact.keys.last.to_sym : :variable
 
             # Combine all the gathered information in a FriendlyShipping::Rate object.
             # Careful: This rate is only for one package within the shipment, and we get multiple

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

@@ -16,20 +16,24 @@ module FriendlyShipping
           # @param [FriendlyShipping::Request] request The request that was used to obtain this Response
           # @param [FriendlyShipping::Response] response The response that USPS returned
           # @param [Physical::Shipment] shipment The shipment object we're trying to get results for
+          # @param [FriendlyShipping::Services::Usps::RateEstimateOptions] options The options we sent with this request
           # @return [Result<ApiResult<Array<FriendlyShipping::Rate>>>] When successfully parsing, an array of rates in a Success Monad.
-          def call(request:, response:, shipment:)
+          def call(request:, response:, shipment:, options:)
             # Filter out error responses and directly return a failure
             parsing_result = ParseXMLResponse.call(response.body, 'RateV4Response')
             rates = []
             parsing_result.fmap do |xml|
               # Get all the possible rates for each package
-              rates_by_package = rates_from_response_node(xml, shipment)
+              rates_by_package = rates_from_response_node(xml, shipment, options)
 
               rates = SHIPPING_METHODS.map do |shipping_method|
                 # For every package ...
                 matching_rates = rates_by_package.map do |package, package_rates|
                   # ... choose the rate that fits this package best.
-                  ChoosePackageRate.call(shipping_method, package, package_rates)
+
+                  package_options = options.options_for_package(package)
+
+                  ChoosePackageRate.call(shipping_method, package_rates, package_options)
                 end.compact # Some shipping rates are not available for every shipping method.
 
                 # in this case, go to the next shipping method.
@@ -62,17 +66,17 @@ module FriendlyShipping
           # @param [Physical::Shipment] shipment The shipment we're trying to get rates for
           #
           # @return [Hash<Physical::Package => Array<FriendlyShipping::Rate>>]
-          def rates_from_response_node(xml, shipment)
+          def rates_from_response_node(xml, shipment, options)
             xml.xpath(PACKAGE_NODE_XPATH).each_with_object({}) do |package_node, result|
               package_id = package_node['ID']
               corresponding_package = shipment.packages[package_id.to_i]
-
+              package_options = options.options_for_package(corresponding_package)
               # There should always be a package in the original shipment that corresponds to the package ID
               # in the USPS response.
               raise BoxNotFoundError if corresponding_package.nil?
 
               result[corresponding_package] = package_node.xpath(SERVICE_NODE_NAME).map do |service_node|
-                ParsePackageRate.call(service_node, corresponding_package)
+                ParsePackageRate.call(service_node, corresponding_package, package_options)
               end
             end
           end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/usps/rate_estimate_package_options'
+
+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/RateEstimateobect] 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.merge(package_options_class: package_options_class)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups/rate_estimate_package_options'
+
+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.
+    class Usps
+      class RateEstimatePackageOptions < FriendlyShipping::PackageOptions
+        attr_reader :box_name,
+                    :commercial_pricing,
+                    :first_class_mail_type,
+                    :hold_for_pickup,
+                    :shipping_method,
+                    :transmit_dimensions
+
+        def initialize(
+          box_name: :variable,
+          commercial_pricing: false,
+          first_class_mail_type: nil,
+          hold_for_pickup: false,
+          shipping_method: nil,
+          transmit_dimensions: true,
+          **kwargs
+        )
+          @box_name = CONTAINERS.key?(box_name) ? box_name : :variable
+          @commercial_pricing = commercial_pricing
+          @first_class_mail_type = first_class_mail_type
+          @hold_for_pickup = hold_for_pickup
+          @shipping_method = shipping_method
+          @transmit_dimensions = transmit_dimensions
+          super kwargs
+        end
+
+        def container_code
+          CONTAINERS.fetch(box_name)
+        end
+
+        def first_class_mail_type_code
+          FIRST_CLASS_MAIL_TYPES[first_class_mail_type]
+        end
+
+        def service_code
+          return 'ALL' unless shipping_method
+
+          if commercial_pricing
+            "#{shipping_method.service_code} COMMERCIAL"
+          else
+            shipping_method.service_code
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,24 +16,24 @@ module FriendlyShipping
           # @param [FriendlyShipping::ShippingMethod] shipping_method The shipping method we want to get rates
           #   for. If empty, we get all of them
           # @return Array<[FriendlyShipping::Rate]> A set of Rates that this package may be sent with
-          def call(shipment:, login:, shipping_method: nil)
+          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(service_code_by(shipping_method, package))
-                    if package.properties[:first_class_mail_type]
-                      xml.FirstClassMailType(FIRST_CLASS_MAIL_TYPES[package.properties[:first_class_mail_type]])
+                    xml.Service(package_options.service_code)
+                    if package_options.first_class_mail_type
+                      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)
-                    container = CONTAINERS[package.properties[:box_name] || :rectangular]
-                    xml.Container(container)
+                    xml.Container(package_options.container_code)
                     xml.Size(size_code)
-                    if ['RECTANGULAR', 'VARIABLE'].include?(container)
+                    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 })
@@ -61,16 +61,6 @@ module FriendlyShipping
             end
           end
 
-          def service_code_by(shipping_method, package)
-            return 'ALL' unless shipping_method
-
-            if package.properties[:commercial_pricing]
-              "#{shipping_method.service_code} COMMERCIAL"
-            else
-              shipping_method.service_code
-            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

data/lib/friendly_shipping/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
-  VERSION = "0.4.14"
+  VERSION = "0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: '0.5'
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
@@ -309,6 +309,8 @@ files:
 - lib/friendly_shipping/services/ups/parse_time_in_transit_response.rb
 - lib/friendly_shipping/services/ups/parse_void_shipment_response.rb
 - lib/friendly_shipping/services/ups/parse_xml_response.rb
+- lib/friendly_shipping/services/ups/rate_estimate_options.rb
+- lib/friendly_shipping/services/ups/rate_estimate_package_options.rb
 - lib/friendly_shipping/services/ups/serialize_access_request.rb
 - lib/friendly_shipping/services/ups/serialize_address_snippet.rb
 - lib/friendly_shipping/services/ups/serialize_address_validation_request.rb
@@ -342,6 +344,8 @@ files:
 - lib/friendly_shipping/services/usps/parse_rate_response.rb
 - lib/friendly_shipping/services/usps/parse_time_in_transit_response.rb
 - lib/friendly_shipping/services/usps/parse_xml_response.rb
+- lib/friendly_shipping/services/usps/rate_estimate_options.rb
+- lib/friendly_shipping/services/usps/rate_estimate_package_options.rb
 - lib/friendly_shipping/services/usps/serialize_address_validation_request.rb
 - lib/friendly_shipping/services/usps/serialize_city_state_lookup_request.rb
 - lib/friendly_shipping/services/usps/serialize_rate_request.rb
@@ -365,7 +369,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="