friendly_shipping 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c625d1ee6c38d9d51bbcadd7280f6b0b415cecb5256d5d884c1da53b6a2afd38
-  data.tar.gz: 4ce888754298c7a7b5bddb724bb518fb2a0e8993f497188756a70cf72965f5cb
+  metadata.gz: ff4df4b78d4b922cd7f2c08ad8256c828783be946fdbd1ba551a5ec562f3176f
+  data.tar.gz: 472c8ef33c9e0b581fe582f630daf04033719c5c90ba2f7ac0a2194a6aed1f20
 SHA512:
-  metadata.gz: c20df19636bdc7ace8658ada396f7d094da5f7ea776e6b555af0aa875e893a0d5d6bb5143e1ee9ac89922c8924478caf08afd6527859d539318d7971c054112a
-  data.tar.gz: b5ba5a4fc4b5c66861c4d04743f30ce0a3d5ad3452dad0646bc9a8683a666d76ef41b4eec9bb583713d9a500ae5632341cc92e331acdd71c89d42c21c221b190
+  metadata.gz: 89fd85041a4800344354421548d197e642a4812e0e9af04d9bcc45f663e704506bff9b9901708a1ff452309e991a83134b84d88e945e5f8627dc5e776bdd5910
+  data.tar.gz: 872f43aea4c769fde901b47fa67e39e90b089cd5d10e3fccf28317b81dab234bb56c10590b00c930e7c50de358baa903c7ce3e383f52c4dbe867af54a42c18ae

data/.gitignore

@@ -4,6 +4,7 @@
 /coverage/
 /doc/
 /.idea/
+/.vscode/
 /pkg/
 /spec/reports/
 /tmp/

data/CHANGELOG.md

@@ -4,6 +4,19 @@ 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.6.3] - 2020-10-30
+
+### Added
+
+- USPS Service: Append HFP (Hold For Pickup) to service code when necessary (#110)
+- USPS Service: Add Priority Cubic shipping method (#113)
+
+### Changed
+
+- USPS Service: Refactor to use explicit service codes (#111)
+- USPS Service: Match Priority Express by CLASSID instead of service name (#112)
+- UPS Service: Rename peak surcharge keys to match UPS docs (#114)
+
 ## [0.6.2] - 2020-08-12
 
 - UPS Service: Be more resilient when UPS does not send a PickupTime element

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

@@ -75,8 +75,8 @@ module FriendlyShipping
           "407" => "EXTENDED AREA PICKUP",
           "410" => "RETURN OF DOCUMENT",
           "430" => "PEAK SEASON",
-          "431" => "PEAK SEASON SURCHARGE - LARGE PACK",
-          "432" => "PEAK SEASON SURCHARGE - ADDITIONAL HANDLING",
+          "431" => "LARGE PACKAGE SEASONAL SURCHARGE",
+          "432" => "ADDITIONAL HANDLING SEASONAL SURCHARGE",
           "440" => "SHIP LARGE PACKAGE",
           "441" => "CARBON NEUTRAL",
           "442" => "PKG QV IN TRANSIT NOTIFICATION",

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

@@ -54,6 +54,7 @@ module FriendlyShipping
         SERVICE_NAME_TAG = 'MailService'
         RATE_TAG = 'Rate'
         COMMERCIAL_RATE_TAG = 'CommercialRate'
+        COMMERCIAL_PLUS_RATE_TAG = 'CommercialPlusRate'
         CURRENCY = Money::Currency.new('USD').freeze
 
         class << self
@@ -82,27 +83,36 @@ module FriendlyShipping
 
             # Some USPS services only offer commercial pricing. Unfortunately, USPS then returns a retail rate of 0.
             # 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_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
-                         end
+            #
+            commercial_rate_requested_or_rate_is_zero = package_options.commercial_pricing || rate_node.at(RATE_TAG).text.to_d.zero?
+            commercial_rate_available = rate_node.at(COMMERCIAL_RATE_TAG) || rate_node.at(COMMERCIAL_PLUS_RATE_TAG)
+
+            rate_value =
+              if commercial_rate_requested_or_rate_is_zero && commercial_rate_available
+                rate_node.at(COMMERCIAL_RATE_TAG)&.text&.to_d || rate_node.at(COMMERCIAL_PLUS_RATE_TAG).text.to_d
+              else
+                rate_node.at(RATE_TAG).text.to_d
+              end
 
             # The rate expressed as a RubyMoney objext
             rate = Money.new(rate_value * CURRENCY.subunit_to_unit, CURRENCY)
 
-            # Which shipping method does this rate belong to? This is trickier than it sounds, because we match
-            # strings here, and we have a `Priority Mail` and `Priority Mail Express` shipping method.
-            # If we have multiple matches, we take the longest matching shipping method name so `Express` rates
-            # do not accidentally get marked as `Priority` only.
-            possible_shipping_methods = SHIPPING_METHODS.select do |sm|
-              service_name.tr('-', ' ').upcase.starts_with?(sm.service_code)
-            end.sort_by do |shipping_method|
-              shipping_method.name.length
-            end
-            shipping_method = possible_shipping_methods.last
+            # Which shipping method does this rate belong to? We first try to match a rate to a shipping method
+            # by class ID (the CLASSID attribute in the USPS API rate response). Not every shipping method
+            # has a class ID defined, and a shipping method can have multiple class IDs (for example, Priority
+            # Express has different class IDs for standard, hold for pickup, and Sunday/Holiday delivery).
+            #
+            # If we don't find a match for class ID, we next try to match a rate to a shipping method using the
+            # shipping method's service code. The USPS API rate response includes a name for each rate in the
+            # MailService element. We match to see if the name starts with the given value. For example:
+            #   `Priority Mail Express 2-day™`
+            #
+            shipping_method =
+              SHIPPING_METHODS.detect { |sm| sm.data[:class_ids]&.include?(service_code) } ||
+              SHIPPING_METHODS.detect { |sm| service_name.tr('-', ' ').upcase.starts_with?(sm.service_code) }
 
             # We find out the box name using a bit of Regex magic using named captures. See the `BOX_REGEX`
             # constant above.

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

@@ -115,7 +115,7 @@ module FriendlyShipping
           # This will likely be somewhat more work in the future.
           MAIL_CLASSES = {
             '1' => 'Priority Mail Express',
-            '2' => 'Priority',
+            '2' => 'Priority Mail',
             '3' => 'First-Class',
             '6' => 'Package Services'
           }.freeze

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

@@ -49,11 +49,13 @@ module FriendlyShipping
         def service_code
           return 'ALL' unless shipping_method
 
-          if commercial_pricing
-            "#{shipping_method.service_code} COMMERCIAL"
-          else
-            shipping_method.service_code
-          end
+          # Cubic shipping methods don't have HFP or COMMERCIAL modifiers
+          return shipping_method.service_code if shipping_method.service_code =~ /CUBIC/
+
+          service_code = [shipping_method.service_code]
+          service_code << 'HFP' if hold_for_pickup
+          service_code << 'COMMERCIAL' if commercial_pricing
+          service_code.join(' ')
         end
       end
     end

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

@@ -29,22 +29,33 @@ module FriendlyShipping
         package_service_retail: 'PACKAGE SERVICE RETAIL'
       }.freeze
 
+      CLASS_IDS = {
+        priority_mail_express: {
+          standard: '3',
+          hold_for_pickup: '2',
+          sunday_holiday_delivery: '23'
+        },
+        priority_mail_cubic: '999'
+      }.freeze
+
       SHIPPING_METHODS = [
-        'First-Class',
-        'Package Services',
-        'Priority',
-        'Priority Mail Express',
-        'Standard Post',
-        'Retail Ground',
-        'Media Mail',
-        'Library Mail',
-      ].map do |shipping_method_name|
+        ['FIRST CLASS', 'First-Class'],
+        ['PACKAGE SERVICES', 'Package Services'],
+        ['PRIORITY', 'Priority Mail'],
+        ['PRIORITY MAIL EXPRESS', 'Priority Mail Express', CLASS_IDS[:priority_mail_express].values],
+        ['PRIORITY MAIL CUBIC', 'Priority Mail Cubic', CLASS_IDS[:priority_mail_cubic]],
+        ['STANDARD POST', 'Standard Post'],
+        ['RETAIL GROUND', 'Retail Ground'],
+        ['MEDIA MAIL', 'Media Mail'],
+        ['LIBRARY MAIL', 'Library Mail'],
+      ].map do |code, name, class_ids|
         FriendlyShipping::ShippingMethod.new(
           origin_countries: [Carmen::Country.coded('US')],
-          name: shipping_method_name,
-          service_code: shipping_method_name.tr('-', ' ').upcase,
+          name: name,
+          service_code: code,
           domestic: true,
-          international: false
+          international: false,
+          data: { class_ids: class_ids }
         )
       end.freeze
     end

data/lib/friendly_shipping/shipping_method.rb

@@ -2,7 +2,7 @@
 
 module FriendlyShipping
   class ShippingMethod
-    attr_reader :name, :service_code, :carrier, :origin_countries
+    attr_reader :name, :service_code, :carrier, :origin_countries, :data
 
     # @param [String] name The shipping method's name
     # @param [String] service_code The shipping method's service code
@@ -11,6 +11,7 @@ module FriendlyShipping
     # @param [Boolean] multi_package Whether this is a multi-package shipping method
     # @param [FriendlyShipping::Carrier] carrier This shipping method's carrier
     # @param [Array] origin_countries Countries this shipping method ships from
+    # @param [Hash] data Additional carrier-specific data for this shipping method
     def initialize(
       name: nil,
       service_code: nil,
@@ -18,7 +19,8 @@ module FriendlyShipping
       international: nil,
       multi_package: nil,
       carrier: nil,
-      origin_countries: []
+      origin_countries: [],
+      data: {}
     )
       @name = name
       @service_code = service_code
@@ -27,6 +29,7 @@ module FriendlyShipping
       @multi_package = multi_package
       @carrier = carrier
       @origin_countries = origin_countries
+      @data = data
     end
 
     def domestic?

data/lib/friendly_shipping/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri