friendly_shipping 0.5.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 752559509e8e61f905718631a73a9df4944367d3c3c24c292a49d8536eded1cd
-  data.tar.gz: 0ece2fb1fae5a77c20ddde481bc6995f143bdd02ead0cf1d82f718c649864010
+  metadata.gz: ff4df4b78d4b922cd7f2c08ad8256c828783be946fdbd1ba551a5ec562f3176f
+  data.tar.gz: 472c8ef33c9e0b581fe582f630daf04033719c5c90ba2f7ac0a2194a6aed1f20
 SHA512:
-  metadata.gz: c64b6cf5cc60a948b64cc30b889c88874f6aa5cd1d448f5e9168e8cf98771e3e25d8c710322c0b6752fa7932fac2eefe720d322eea6cd60ea74fe4b606136f4a
-  data.tar.gz: 18ee11e1c30eecb0a5e41ad81edda69081a7100bd40d05ce715dc2e8761f9961a12f21d54f63151b90cb6134fc6beb2d703256792caa3647a8396a5713902d02
+  metadata.gz: 89fd85041a4800344354421548d197e642a4812e0e9af04d9bcc45f663e704506bff9b9901708a1ff452309e991a83134b84d88e945e5f8627dc5e776bdd5910
+  data.tar.gz: 872f43aea4c769fde901b47fa67e39e90b089cd5d10e3fccf28317b81dab234bb56c10590b00c930e7c50de358baa903c7ce3e383f52c4dbe867af54a42c18ae

data/.gitignore

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

data/.rubocop-relaxed.yml

@@ -133,6 +133,9 @@ Style/WordArray:
   Enabled: false
   StyleGuide: https://relaxed.ruby.style/#stylewordarray
 
+Layout/LineLength:
+  Enabled: false
+
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
   StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
@@ -156,9 +159,6 @@ Metrics/ModuleLength:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -167,4 +167,3 @@ Metrics/ParameterLists:
 
 Metrics/PerceivedComplexity:
   Enabled: false
-

data/.rubocop.yml

@@ -6,3 +6,12 @@ inherit_from:
 
 Metrics/BlockLength:
   Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/CHANGELOG.md

@@ -4,6 +4,37 @@ 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
+
+## [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 (#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
 
 ### Added
@@ -17,7 +48,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - USPS Service: Rename "Package Services" shipping method (#85)
-- Documentation updates (#86) 
+- Documentation updates (#86)
 
 ## [0.5] - 2020-01-24
 

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|
@@ -24,21 +24,21 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "data_uri", "~> 0.0.3"
   spec.add_runtime_dependency "dry-monads", "~> 1.0"
-  spec.add_runtime_dependency "money", ">= 6.0.0"
-  spec.add_runtime_dependency "nokogiri", ">= 1.6"
-  spec.add_runtime_dependency "physical", ">= 0.4.4"
+  spec.add_runtime_dependency "money", "~> 6.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+  spec.add_runtime_dependency "physical", "~> 0.4", ">= 0.4.4"
   spec.add_runtime_dependency "rest-client", "~> 2.0"
   spec.required_ruby_version = '>= 2.5'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "bundler", ">= 1.17", "< 3"
+  spec.add_development_dependency "dotenv", "~> 2.7"
   spec.add_development_dependency "factory_bot", "~> 5.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  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 "webmock", "~> 3.6"
 end

data/lib/friendly_shipping/api_failure.rb

@@ -1,21 +1,8 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
-  class ApiFailure
-    attr_reader :failure, :original_request, :original_response
-
-    # @param [Object] failure The API failure
-    # @param [FriendlyShipping::Request] original_request The HTTP request (when debugging is enabled)
-    # @param [FriendlyShipping::Response] original_response The HTTP response (when debugging is enabled)
-    def initialize(failure, original_request:, original_response:)
-      @failure = failure
-
-      # We do not want to attach debugging information in every single response to save memory in production
-      return unless original_request&.debug
-
-      @original_request = original_request
-      @original_response = original_response
-    end
+  class ApiFailure < ApiResult
+    alias_method :failure, :data
 
     def to_s
       failure.to_s

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_address_classification_response.rb

@@ -7,8 +7,11 @@ module FriendlyShipping
         extend Dry::Monads::Result::Mixin
 
         def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(response.body, 'AddressValidationResponse')
-
+          parsing_result = ParseXMLResponse.call(
+            request: request,
+            response: response,
+            expected_root_tag: 'AddressValidationResponse'
+          )
           parsing_result.bind do |xml|
             address_type = xml.at('AddressClassification/Description')&.text&.downcase
             Success(

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

@@ -7,8 +7,11 @@ module FriendlyShipping
         extend Dry::Monads::Result::Mixin
 
         def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(response.body, 'AddressValidationResponse')
-
+          parsing_result = ParseXMLResponse.call(
+            request: request,
+            response: response,
+            expected_root_tag: 'AddressValidationResponse'
+          )
           parsing_result.bind do |xml|
             if xml.at('NoCandidatesIndicator')
               Failure(

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

@@ -7,8 +7,11 @@ module FriendlyShipping
         extend Dry::Monads::Result::Mixin
 
         def self.call(request:, response:, location:)
-          parsing_result = ParseXMLResponse.call(response.body, 'AddressValidationResponse')
-
+          parsing_result = ParseXMLResponse.call(
+            request: request,
+            response: response,
+            expected_root_tag: 'AddressValidationResponse'
+          )
           parsing_result.fmap do |xml|
             FriendlyShipping::ApiResult.new(
               [

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

@@ -9,7 +9,11 @@ module FriendlyShipping
       class ParseRateResponse
         class << self
           def call(request:, response:, shipment:)
-            parsing_result = ParseXMLResponse.call(response.body, 'RatingServiceSelectionResponse')
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'RatingServiceSelectionResponse'
+            )
             parsing_result.fmap do |xml|
               FriendlyShipping::ApiResult.new(
                 build_rates(xml, shipment),

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

@@ -11,7 +11,11 @@ module FriendlyShipping
 
         class << self
           def call(request:, response:)
-            parsing_result = ParseXMLResponse.call(response.body, 'ShipmentAcceptResponse')
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'ShipmentAcceptResponse'
+            )
             parsing_result.fmap do |xml|
               FriendlyShipping::ApiResult.new(
                 build_labels(xml),

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

@@ -7,7 +7,11 @@ module FriendlyShipping
     class Ups
       class ParseShipmentConfirmResponse
         def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(response.body, 'ShipmentConfirmResponse')
+          parsing_result = ParseXMLResponse.call(
+            request: request,
+            response: response,
+            expected_root_tag: 'ShipmentConfirmResponse'
+          )
           parsing_result.fmap do |xml|
             FriendlyShipping::ApiResult.new(
               xml.root.at('ShipmentDigest').text,

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

@@ -5,7 +5,11 @@ module FriendlyShipping
     class Ups
       class ParseTimeInTransitResponse
         def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(response.body, 'TimeInTransitResponse')
+          parsing_result = ParseXMLResponse.call(
+            request: request,
+            response: response,
+            expected_root_tag: 'TimeInTransitResponse'
+          )
           parsing_result.fmap do |xml|
             origin_country_code = xml.at('TransitResponse/TransitFrom/AddressArtifactFormat/CountryCode').text
             timings = xml.root.xpath('//TransitResponse/ServiceSummary').map do |service_summary|
@@ -21,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/parse_void_shipment_response.rb

@@ -7,7 +7,11 @@ module FriendlyShipping
     class Ups
       class ParseVoidShipmentResponse
         def self.call(request:, response:)
-          parsing_result = ParseXMLResponse.call(response.body, 'VoidShipmentResponse')
+          parsing_result = ParseXMLResponse.call(
+            request: request,
+            response: response,
+            expected_root_tag: 'VoidShipmentResponse'
+          )
           parsing_result.fmap do |xml|
             FriendlyShipping::ApiResult.new(
               xml.root.at('ResponseStatusDescription').text,

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

@@ -8,19 +8,18 @@ module FriendlyShipping
         SUCCESSFUL_RESPONSE_STATUS_CODE = '1'
 
         class << self
-          def call(response_body, expected_root_tag)
-            xml = Nokogiri.XML(response_body, &:strict)
+          def call(request:, response:, expected_root_tag:)
+            xml = Nokogiri.XML(response.body, &:strict)
 
             if xml.root.nil? || xml.root.name != expected_root_tag
-              Failure('Invalid document')
-            end
-            if request_successful?(xml)
+              wrap_failure('Invalid document', request, response)
+            elsif request_successful?(xml)
               Success(xml)
             else
-              Failure(error_message(xml))
+              wrap_failure(error_message(xml), request, response)
             end
           rescue Nokogiri::XML::SyntaxError => e
-            Failure(e)
+            wrap_failure(e, request, response)
           end
 
           private
@@ -34,6 +33,16 @@ module FriendlyShipping
             desc = xml.root.at_xpath('Response/Error/ErrorDescription')&.text
             [status, desc].compact.join(": ").presence || 'UPS could not process the request.'
           end
+
+          def wrap_failure(failure, request, response)
+            Failure(
+              FriendlyShipping::ApiFailure.new(
+                failure,
+                original_request: request,
+                original_response: response
+              )
+            )
+          end
         end
       end
     end

data/lib/friendly_shipping/services/ups_freight.rb

@@ -4,11 +4,21 @@ require 'dry/monads/result'
 require 'friendly_shipping/http_client'
 require 'friendly_shipping/services/ups_freight/shipping_methods'
 require 'friendly_shipping/services/ups_freight/rates_options'
+require 'friendly_shipping/services/ups_freight/label_options'
 require 'friendly_shipping/services/ups_freight/rates_package_options'
 require 'friendly_shipping/services/ups_freight/rates_item_options'
+require 'friendly_shipping/services/ups_freight/label_package_options'
+require 'friendly_shipping/services/ups_freight/label_item_options'
+require 'friendly_shipping/services/ups_freight/label_document_options'
+require 'friendly_shipping/services/ups_freight/label_email_options'
+require 'friendly_shipping/services/ups_freight/label_pickup_options'
+require 'friendly_shipping/services/ups_freight/label_delivery_options'
+require 'friendly_shipping/services/ups_freight/pickup_request_options'
+require 'friendly_shipping/services/ups_freight/parse_freight_label_response'
 require 'friendly_shipping/services/ups_freight/parse_freight_rate_response'
 require 'friendly_shipping/services/ups_freight/generate_freight_rate_request_hash'
-require 'friendly_shipping/services/ups_freight/generate_ups_security_hash'
+require 'friendly_shipping/services/ups_freight/generate_freight_ship_request_hash'
+require 'friendly_shipping/services/ups_freight/restful_api_error_handler'
 
 module FriendlyShipping
   module Services
@@ -28,10 +38,11 @@ module FriendlyShipping
       LIVE_URL = 'https://onlinetools.ups.com'
 
       RESOURCES = {
-        rates: '/rest/FreightRate'
+        rates: '/ship/v1801/freight/rating/ground',
+        labels: '/ship/v1607/freight/shipments/Ground'
       }.freeze
 
-      def initialize(key:, login:, password:, test: true, client: HttpClient.new)
+      def initialize(key:, login:, password:, test: true, client: HttpClient.new(error_handler: RestfulApiErrorHandler))
         @key = key
         @login = login
         @password = password
@@ -44,28 +55,48 @@ 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.
       def rate_estimates(shipment, options:, debug: false)
         freight_rate_request_hash = GenerateFreightRateRequestHash.call(shipment: shipment, options: options)
-        url = base_url + RESOURCES[:rates]
-        request = FriendlyShipping::Request.new(
-          url: url,
-          body: authentication_hash.merge(freight_rate_request_hash).to_json,
-          debug: debug
-        )
+        request = build_request(:rates, freight_rate_request_hash, debug)
 
-        client.post(request).bind do |response|
+        client.post(request).fmap do |response|
           ParseFreightRateResponse.call(response: response, request: request)
         end
       end
 
+      # Get labels for a shipment
+      # @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)
+        freight_ship_request_hash = GenerateFreightShipRequestHash.call(shipment: shipment, options: options)
+        request = build_request(:labels, freight_ship_request_hash, debug)
+
+        client.post(request).fmap do |response|
+          ParseFreightLabelResponse.call(response: response, request: request)
+        end
+      end
+
       private
 
-      def authentication_hash
-        GenerateUpsSecurityHash.call(key: key, login: login, password: password)
+      def build_request(action, payload, debug)
+        url = base_url + RESOURCES[action]
+        FriendlyShipping::Request.new(
+          url: url,
+          body: payload.to_json,
+          headers: {
+            Content_Type: 'application/json',
+            Accept: 'application/json',
+            Username: login,
+            Password: password,
+            AccessLicenseNumber: key
+          },
+          debug: debug
+        )
       end
 
       def base_url