friendly_shipping 0.5.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b1c8a12304b7f798f0df9210f6e52027bd588b9d612f5f05bf5d102e8db0e8
-  data.tar.gz: 7813b10233d7364d836d5cd50bb281b9ef43c37d936009f8f400a164d4a30fb1
+  metadata.gz: 107fa27ec95b49342549dbf24c53cc483cd05bdfbb64871940036aaac6567eb6
+  data.tar.gz: 7dd9c281178e513482ae0cb93787eb551b09e5f697f10d4db50dc2aef21dd4a8
 SHA512:
-  metadata.gz: dc7eb250872e158e3ba105168bda09f47328bd2077f758a5e7e746416aa5af071686b992609c1b62d50d399085164999970119ba2d801cbe7d5f99803d675132
-  data.tar.gz: 4ccb36047bfc9f612af55014b35fb3d72e629277776a65d4c7b4363c056d28d7de16d77564bf371a17ef01002cf04322047b93526f7aa35cc648b6acbfc33567
+  metadata.gz: 30c37297f77dc6be490cf9719211780b81b0d91cdc49311b349fc3844a6cbcb5755265e663b80e24a67cda9847e19d328808cec786cf7172d6986ccb75bbf6eb
+  data.tar.gz: 022c69680c07d9fed0b2b9afa8093e40b20bb7b441b332acd743078f74db70f3de03227953952de8b08048aa40eb902895529c781b6332036cf4e38ba653804e

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,9 +4,43 @@ 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.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
+
+## [0.6.1] - 2020-03-11
+
+- Add Content-Type header to UPS Freight API requests, fixing "Name too long" 500 error responses
+
+## [0.6.0] - 2020-03-11
+
+- Changelog additions missed in previous release
+
 ## [0.5.3] - 2020-03-11
 
-- UPS Service: Add support for shipping labels / bills of lading
+- UPS Service: Add support for shipping labels / bills of lading (#92)
+- UPS/USPS Services: Return ApiFailure instead of a string for failed API responses (#95)
+- UPS/USPS Services: Refactor ApiFailure to subclass ApiResponse (#96)
 
 ## [0.5.2] - 2020-01-31
 

data/friendly_shipping.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "An integration layer for shipping services"
   spec.description   = "Allows you to quote or ship a Physical::Shipment object"
-  spec.homepage      = "https://github.com/friendly_cart/friendly_shipping"
+  spec.homepage      = "https://github.com/friendlycart/friendly_shipping"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "dotenv", "~> 2.7"
   spec.add_development_dependency "factory_bot", "~> 5.0"
   spec.add_development_dependency "pry", "~> 0.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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"

data/lib/friendly_shipping/http_client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/monads/result'
+require 'friendly_shipping/api_failure'
 require 'rest-client'
 
 module FriendlyShipping
@@ -21,19 +22,19 @@ module FriendlyShipping
 
       Success(convert_to_friendly_response(http_response))
     rescue ::RestClient::Exception => e
-      error_handler.call(e)
+      error_handler.call(e, original_request: request, original_response: e.response)
     end
 
-    def post(friendly_shipping_request)
+    def post(request)
       http_response = ::RestClient.post(
-        friendly_shipping_request.url,
-        friendly_shipping_request.body,
-        friendly_shipping_request.headers
+        request.url,
+        request.body,
+        request.headers
       )
 
       Success(convert_to_friendly_response(http_response))
     rescue ::RestClient::Exception => e
-      error_handler.call(e)
+      error_handler.call(e, original_request: request, original_response: e.response)
     end
 
     def put(request)
@@ -45,13 +46,19 @@ module FriendlyShipping
 
       Success(convert_to_friendly_response(http_response))
     rescue ::RestClient::Exception => e
-      error_handler.call(e)
+      error_handler.call(e, original_request: request, original_response: e.response)
     end
 
     private
 
-    def wrap_in_failure(error)
-      Failure(error)
+    def wrap_in_failure(error, original_request: nil, original_response: nil)
+      Failure(
+        ApiFailure.new(
+          error,
+          original_request: original_request,
+          original_response: original_response
+        )
+      )
     end
 
     def convert_to_friendly_response(http_response)

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

@@ -8,11 +8,23 @@ module FriendlyShipping
       class BadRequestHandler
         extend Dry::Monads::Result::Mixin
 
-        def self.call(error)
+        def self.call(error, original_request: nil, original_response: nil)
           if error.http_code == 400
-            Failure(BadRequest.new(error))
+            Failure(
+              ApiFailure.new(
+                BadRequest.new(error),
+                original_request: original_request,
+                original_response: original_response
+              )
+            )
           else
-            Failure(error)
+            Failure(
+              ApiFailure.new(
+                error,
+                original_request: original_request,
+                original_response: original_response
+              )
+            )
           end
         end
       end

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

@@ -25,7 +25,7 @@ module FriendlyShipping
               delivery_time = service_summary.at('EstimatedArrival/Time').text
               delivery = Time.parse("#{delivery_date} #{delivery_time}")
               pickup_date = service_summary.at('EstimatedArrival/PickupDate').text
-              pickup_time = service_summary.at('EstimatedArrival/PickupTime').text
+              pickup_time = service_summary.at('EstimatedArrival/PickupTime')&.text
               pickup = Time.parse("#{pickup_date} #{pickup_time}")
 
               # Some additional data

data/lib/friendly_shipping/services/ups_freight.rb

@@ -55,7 +55,7 @@ module FriendlyShipping
       end
 
       # Get rates for a shipment
-      # @param [Physical::Shipment] location The shipment we want to get rates for
+      # @param [Physical::Shipment] shipment The shipment we want to get rates for
       # @param [FriendlyShipping::Services::UpsFreight::RatesOptions] options Options for obtaining rates for this shipment.
       # @return [Result<ApiResult<Array<Rate>>>] The rates returned from UPS encoded in a
       #   `FriendlyShipping::ApiResult` object.
@@ -69,7 +69,7 @@ module FriendlyShipping
       end
 
       # Get labels for a shipment
-      # @param [Physical::Shipment] location The shipment we want to get rates for
+      # @param [Physical::Shipment] shipment The shipment we want to get rates for
       # @param [FriendlyShipping::Services::UpsFreight::LabelOptions] options Options for shipping this shipment.
       # @return [Result<ApiResult<ShipmentInformation>] The information that you need for shipping this shipment.
       def labels(shipment, options:, debug: false)
@@ -89,6 +89,7 @@ module FriendlyShipping
           url: url,
           body: payload.to_json,
           headers: {
+            Content_Type: 'application/json',
             Accept: 'application/json',
             Username: login,
             Password: password,

data/lib/friendly_shipping/services/ups_freight/restful_api_error_handler.rb

@@ -6,7 +6,7 @@ module FriendlyShipping
       class RestfulApiErrorHandler
         extend Dry::Monads::Result::Mixin
 
-        def self.call(error)
+        def self.call(error, original_request: nil, original_response: nil)
           parsed_json = JSON.parse(error.response.body)
           errors = parsed_json.dig('response', 'errors')
 
@@ -16,7 +16,13 @@ module FriendlyShipping
             [status, desc].compact.join(": ").presence || 'UPS could not process the request.'
           end.join("\n")
 
-          Failure(failure_string)
+          Failure(
+            ApiFailure.new(
+              failure_string,
+              original_request: original_request,
+              original_response: original_response
+            )
+          )
         end
       end
     end

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.5.3"
+  VERSION = "0.6.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Martin Meyerhoff
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
@@ -166,16 +166,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +275,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".env.template"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop-relaxed.yml"
@@ -392,11 +393,11 @@ files:
 - lib/friendly_shipping/timing.rb
 - lib/friendly_shipping/types.rb
 - lib/friendly_shipping/version.rb
-homepage: https://github.com/friendly_cart/friendly_shipping
+homepage: https://github.com/friendlycart/friendly_shipping
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -412,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: An integration layer for shipping services
 test_files: []