friendly_shipping 0.6.2 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c625d1ee6c38d9d51bbcadd7280f6b0b415cecb5256d5d884c1da53b6a2afd38
-  data.tar.gz: 4ce888754298c7a7b5bddb724bb518fb2a0e8993f497188756a70cf72965f5cb
+  metadata.gz: 921ae3f517c9fcf14e7932e110b6468d7bf2b78e46864bb50a3272b6257e2bea
+  data.tar.gz: d7cf64cc30bedd17adca882b9365f647498f8c4430f59e0a4fe1a00efe1ac017
 SHA512:
-  metadata.gz: c20df19636bdc7ace8658ada396f7d094da5f7ea776e6b555af0aa875e893a0d5d6bb5143e1ee9ac89922c8924478caf08afd6527859d539318d7971c054112a
-  data.tar.gz: b5ba5a4fc4b5c66861c4d04743f30ce0a3d5ad3452dad0646bc9a8683a666d76ef41b4eec9bb583713d9a500ae5632341cc92e331acdd71c89d42c21c221b190
+  metadata.gz: 9080b93ddde6399677499cb65e6b1a184985af772067548b45c977fd6d8744c9c6a08899c2b27426e3fcd795b13950141d017183c40aa25026d7cb3bf2eeb120
+  data.tar.gz: 413036408bfc7852a141c1b19e557b7533ca3288b371e6f5e09d78da279ef470bd764c9c46de145fbc6a079de9b18b858cb5bff75b972d3bed76ce4a946a2626

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.gitignore

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

data/CHANGELOG.md

@@ -4,6 +4,33 @@ 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.5] - 2022-04-25
+
+### Added
+- USPS Service: Add support for returned dimensional weight (#128)
+- USPS Service: Add support for returned fees (#127)
+
+### Changed
+- ShipEngine Service: Prevent exceptions when no rates are returned (#125)
+- Misc dependency updates (#116, #120, #121, #124)
+
+## [0.6.4] - 2021-01-27
+
+### Added
+- UPS Service: Include negotiated charges for UPS (#119)
+- UPS Service: Include shipment-level itemized charges (#117)
+
+## [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/friendly_shipping.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "data_uri", "~> 0.0.3"
+  spec.add_runtime_dependency "data_uri", ">= 0.0.3", "< 0.2.0"
   spec.add_runtime_dependency "dry-monads", "~> 1.0"
   spec.add_runtime_dependency "money", "~> 6.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.6"
@@ -30,15 +30,15 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rest-client", "~> 2.0"
   spec.required_ruby_version = '>= 2.5'
 
-  spec.add_development_dependency "bundler", ">= 1.17", "< 3"
+  spec.add_development_dependency "bundler", ">= 2.1.4", "< 3"
   spec.add_development_dependency "dotenv", "~> 2.7"
-  spec.add_development_dependency "factory_bot", "~> 5.0"
+  spec.add_development_dependency "factory_bot", "~> 6.2"
   spec.add_development_dependency "pry", "~> 0.12"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
   spec.add_development_dependency "rubocop", ">= 0.80", "< 1"
   spec.add_development_dependency "simplecov", "~> 0.17"
-  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "webmock", "~> 3.6"
 end

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

@@ -10,8 +10,14 @@ module FriendlyShipping
 
         class << self
           def call(response:, request:, options:)
+            error_messages = []
             parsed_json = JSON.parse(response.body)
             rates = parsed_json.map do |rate|
+              if rate['validation_status'] == 'invalid'
+                error_messages.concat rate['error_messages']
+                next
+              end
+
               carrier = options.carriers.detect { |c| c.id == rate['carrier_id'] }
               next unless carrier
 
@@ -31,17 +37,33 @@ module FriendlyShipping
               )
             end.compact
 
-            Success(
-              ApiResult.new(
-                rates,
-                original_request: request,
-                original_response: response
+            if valid_rates(parsed_json)
+              Success(
+                ApiResult.new(
+                  rates,
+                  original_request: request,
+                  original_response: response
+                )
+              )
+            else
+              Failure(
+                ApiFailure.new(
+                  error_messages,
+                  original_request: request,
+                  original_response: response
+                )
               )
-            )
+            end
           end
 
           private
 
+          def valid_rates(parsed_json)
+            parsed_json.map do |rate|
+              ["valid", "has_warnings", "unknown"].include? rate['validation_status']
+            end.any?
+          end
+
           def get_amounts(rate_hash)
             [:shipping, :other, :insurance, :confirmation].map do |name|
               currency = Money::Currency.new(rate_hash["#{name}_amount"]["currency"])

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/ups/parse_rate_response.rb

@@ -36,6 +36,8 @@ module FriendlyShipping
               negotiated_rate = ParseMoneyElement.call(
                 rated_shipment.at('NegotiatedRates/NetSummaryCharges/GrandTotal')
               )&.last
+              negotiated_charges = extract_charges(rated_shipment.xpath('NegotiatedRates/ItemizedCharges'))
+              itemized_charges = extract_charges(rated_shipment.xpath('ItemizedCharges'))
 
               rated_shipment_warnings = rated_shipment.css('RatedShipmentWarning').map { |e| e.text.strip }
               if rated_shipment_warnings.any? { |e| e.match?(/to Residential/) }
@@ -52,8 +54,10 @@ module FriendlyShipping
                 data: {
                   insurance_price: insurance_price,
                   negotiated_rate: negotiated_rate,
+                  negotiated_charges: negotiated_charges,
                   days_to_delivery: days_to_delivery,
                   new_address_type: new_address_type,
+                  itemized_charges: itemized_charges,
                   packages: build_packages(rated_shipment)
                 }.compact
               )
@@ -64,20 +68,24 @@ module FriendlyShipping
 
           def build_packages(rated_shipment)
             rated_shipment.css('RatedPackage').map do |rated_package|
-              itemized_charges = rated_package.xpath('ItemizedCharges').map do |element|
-                ParseMoneyElement.call(element)
-              end.compact.to_h
               {
                 transportation_charges: ParseMoneyElement.call(rated_package.at('TransportationCharges')).last,
                 base_service_charge: ParseMoneyElement.call(rated_package.at('BaseServiceCharge')).last,
                 service_options_charges: ParseMoneyElement.call(rated_package.at('ServiceOptionsCharges'))&.last,
-                itemized_charges: itemized_charges,
+                itemized_charges: extract_charges(rated_package.xpath('ItemizedCharges')),
                 total_charges: ParseMoneyElement.call(rated_package.at('TotalCharges')).last,
+                negotiated_charges: extract_charges(rated_package.xpath('NegotiatedCharges/ItemizedCharges')),
                 weight: BigDecimal(rated_package.at('Weight').text),
                 billing_weight: BigDecimal(rated_package.at('BillingWeight/Weight').text)
               }.compact
             end
           end
+
+          def extract_charges(node)
+            node.map do |element|
+              ParseMoneyElement.call(element)
+            end.compact.to_h
+          end
         end
       end
     end

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

@@ -54,6 +54,9 @@ module FriendlyShipping
         SERVICE_NAME_TAG = 'MailService'
         RATE_TAG = 'Rate'
         COMMERCIAL_RATE_TAG = 'CommercialRate'
+        COMMERCIAL_PLUS_RATE_TAG = 'CommercialPlusRate'
+        DIMENSIONAL_WEIGHT_RATE = 'DimensionalWeightRate'
+        FEES = './/Fees/Fee'
         CURRENCY = Money::Currency.new('USD').freeze
 
         class << self
@@ -82,33 +85,53 @@ 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.
             box_name_match = service_name.match(/#{BOX_REGEX}/)
             box_name = box_name_match ? box_name_match.named_captures.compact.keys.last.to_sym : :variable
 
+            dimensional_weight_rate = rate_node.at(DIMENSIONAL_WEIGHT_RATE)&.text&.to_i
+
+            fees = rate_node.xpath(FEES).map do |fee_node|
+              type = fee_node.at('FeeType').text
+              price = fee_node.at('FeePrice').text.to_d
+              {
+                type: type,
+                price: Money.new(price * CURRENCY.subunit_to_unit, CURRENCY)
+              }
+            end
+
             # 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
             # rates per package for the different shipping method/box/hold for pickup combinations.
@@ -122,7 +145,9 @@ module FriendlyShipping
                 days_to_delivery: days_to_delivery,
                 military: military,
                 full_mail_service: service_name,
-                service_code: service_code
+                service_code: service_code,
+                dimensional_weight_rate: dimensional_weight_rate,
+                fees: fees
               }
             )
           end

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

@@ -8,6 +8,8 @@ module FriendlyShipping
     #
     # @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.
+    # @param [Symbol] return_dimensional_weight Boolean indicating whether the response should include dimensional weight.
+    # @param [Symbol] return_fees Boolean indicating whether the response should include fees.
     class Usps
       class RateEstimatePackageOptions < FriendlyShipping::PackageOptions
         attr_reader :box_name,
@@ -16,7 +18,9 @@ module FriendlyShipping
                     :hold_for_pickup,
                     :shipping_method,
                     :transmit_dimensions,
-                    :rectangular
+                    :rectangular,
+                    :return_dimensional_weight,
+                    :return_fees
 
         def initialize(
           box_name: :variable,
@@ -26,6 +30,8 @@ module FriendlyShipping
           shipping_method: nil,
           transmit_dimensions: true,
           rectangular: true,
+          return_dimensional_weight: true,
+          return_fees: false,
           **kwargs
         )
           @box_name = CONTAINERS.key?(box_name) ? box_name : :variable
@@ -35,6 +41,8 @@ module FriendlyShipping
           @shipping_method = shipping_method
           @transmit_dimensions = transmit_dimensions
           @rectangular = rectangular
+          @return_dimensional_weight = return_dimensional_weight
+          @return_fees = return_fees
           super kwargs
         end
 
@@ -49,11 +57,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/serialize_rate_request.rb

@@ -46,6 +46,8 @@ module FriendlyShipping
                       end
                     end
                     xml.Machinable(machinable(package))
+                    xml.ReturnDimensionalWeight(true) if package_options.return_dimensional_weight
+                    xml.ReturnFees(true) if package_options.return_fees
                   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.5"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.5
 platform: ruby
 authors:
 - Martin Meyerhoff
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +112,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -116,7 +122,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -140,14 +146,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -244,14 +250,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +281,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".env.template"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop-relaxed.yml"
@@ -396,7 +403,7 @@ homepage: https://github.com/friendlycart/friendly_shipping
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -411,8 +418,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: An integration layer for shipping services
 test_files: []