friendly_shipping 0.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7033f8bf845a41a0cefa6899a465fd78a85077ff565c7c30f67d04f20708ff6
-  data.tar.gz: 2c5207e0139608d78b7c65b6f273b9dc222bc750bc47e587147e8f486c908b43
+  metadata.gz: 774450d05e80ad658e9ab8d29ea372b142dca9b712bdf37f3baf4b5faa68d4c0
+  data.tar.gz: 1fc8c87b5812e0b31d2f74ff57e24887e0b4ec7b916b3f34371631bac8b897c9
 SHA512:
-  metadata.gz: 00d7ce8fe1d737b482d71a6ff96195a82dc70b94c7784291c9cc18eb2f71ca529dadf33900a7f5aef223a4f89a3b1297403d7bc352dd9e8255c139b11b7351c1
-  data.tar.gz: 7a7746f0c59dfcd03d2a330142f106cfe3c0fc7b82628859691d28c0dbd27e3d7584670c44f3509780271aaaf44fbd83551d0e1415ac14807d9ec2578891ab95
+  metadata.gz: 1d9f8099888cebd49a1c7fcfec69ddeb4170e04bea8d0a3ed0b0c5dcce9d413606b0386ae2034784563dfa628dd5d3b927f9250ef40a6431e28462238476a9e7
+  data.tar.gz: 6cac63b02a0f637f68fca0948bb8fa59361b8d13a3752d9de0a9a2cb55ec6aaf9654d89ee9530c0b11e2b81b44b928097defe17acfabe1a92c4635c9f9ab0ad2

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,35 @@ 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.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
+- USPS Service: Added rectangular boolean to rate options class (#89)
+- USPS Service: Added readable body to request class (#88)
+
+### Removed
+- USPS Service: Drop deprecated rectangular container (#89)
+
+## [0.5.1] - 2020-01-28
+
+### Changed
+- USPS Service: Rename "Package Services" shipping method (#85)
+- Documentation updates (#86)
+
 ## [0.5] - 2020-01-24
 
 ### Removed

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/request.rb

@@ -6,13 +6,19 @@ module FriendlyShipping
 
     # @param [String] url The HTTP request URL
     # @param [String] body The HTTP request body
+    # # @param [String] readable_body Human-readable HTTP request body
     # @param [Hash] headers The HTTP request headers
     # @param [Boolean] debug Whether to debug the request
-    def initialize(url:, body: nil, headers: {}, debug: false)
+    def initialize(url:, body: nil, readable_body: nil, headers: {}, debug: false)
       @url = url
       @body = body
+      @readable_body = readable_body
       @headers = headers
       @debug = debug
     end
+
+    def readable_body
+      @readable_body.presence || @body
+    end
   end
 end

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

@@ -74,6 +74,7 @@ module FriendlyShipping
         request = FriendlyShipping::Request.new(
           url: url,
           body: access_request_xml + rate_request_xml,
+          readable_body: rate_request_xml,
           debug: debug
         )
 
@@ -84,7 +85,7 @@ module FriendlyShipping
 
       # Get timing information for a shipment
       # @param [Physical::Shipment] shipment The shipment we want to estimate timings for
-      # @param [FriendlyShipping::Services::Ups::TimingOptions] Options for this call
+      # @param [FriendlyShipping::Services::Ups::TimingOptions] options Options for this call
       def timings(shipment, options:, debug: false)
         time_in_transit_request_xml = SerializeTimeInTransitRequest.call(
           shipment: shipment,
@@ -95,6 +96,7 @@ module FriendlyShipping
         request = FriendlyShipping::Request.new(
           url: time_in_transit_url,
           body: access_request_xml + time_in_transit_request_xml,
+          readable_body: time_in_transit_request_xml,
           debug: debug
         )
 
@@ -114,6 +116,7 @@ module FriendlyShipping
         ship_confirm_request = FriendlyShipping::Request.new(
           url: ship_confirm_url,
           body: access_request_xml + ship_confirm_request_xml,
+          readable_body: ship_confirm_request_xml,
           debug: debug
         )
 
@@ -132,6 +135,7 @@ module FriendlyShipping
           ship_accept_request = FriendlyShipping::Request.new(
             url: ship_accept_url,
             body: access_request_xml + ship_accept_request_xml,
+            readable_body: ship_accept_request_xml,
             debug: debug
           )
 
@@ -153,6 +157,7 @@ module FriendlyShipping
         request = FriendlyShipping::Request.new(
           url: url,
           body: access_request_xml + address_validation_request_xml,
+          readable_body: address_validation_request_xml,
           debug: debug
         )
 
@@ -170,6 +175,7 @@ module FriendlyShipping
         request = FriendlyShipping::Request.new(
           url: url,
           body: access_request_xml + address_validation_request_xml,
+          readable_body: address_validation_request_xml,
           debug: debug
         )
 
@@ -188,6 +194,7 @@ module FriendlyShipping
         request = FriendlyShipping::Request.new(
           url: url,
           body: access_request_xml + city_state_lookup_request_xml,
+          readable_body: city_state_lookup_request_xml,
           debug: debug
         )
 
@@ -202,6 +209,7 @@ module FriendlyShipping
         request = FriendlyShipping::Request.new(
           url: url,
           body: access_request_xml + void_request_xml,
+          readable_body: void_request_xml,
           debug: debug
         )
         client.post(request).bind do |response|

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_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|

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