friendly_shipping 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 752559509e8e61f905718631a73a9df4944367d3c3c24c292a49d8536eded1cd
-  data.tar.gz: 0ece2fb1fae5a77c20ddde481bc6995f143bdd02ead0cf1d82f718c649864010
+  metadata.gz: b2b1c8a12304b7f798f0df9210f6e52027bd588b9d612f5f05bf5d102e8db0e8
+  data.tar.gz: 7813b10233d7364d836d5cd50bb281b9ef43c37d936009f8f400a164d4a30fb1
 SHA512:
-  metadata.gz: c64b6cf5cc60a948b64cc30b889c88874f6aa5cd1d448f5e9168e8cf98771e3e25d8c710322c0b6752fa7932fac2eefe720d322eea6cd60ea74fe4b606136f4a
-  data.tar.gz: 18ee11e1c30eecb0a5e41ad81edda69081a7100bd40d05ce715dc2e8761f9961a12f21d54f63151b90cb6134fc6beb2d703256792caa3647a8396a5713902d02
+  metadata.gz: dc7eb250872e158e3ba105168bda09f47328bd2077f758a5e7e746416aa5af071686b992609c1b62d50d399085164999970119ba2d801cbe7d5f99803d675132
+  data.tar.gz: 4ccb36047bfc9f612af55014b35fb3d72e629277776a65d4c7b4363c056d28d7de16d77564bf371a17ef01002cf04322047b93526f7aa35cc648b6acbfc33567

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,10 @@ 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.5.3] - 2020-03-11
+
+- UPS Service: Add support for shipping labels / bills of lading
+
 ## [0.5.2] - 2020-01-31
 
 ### Added
@@ -17,7 +21,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

@@ -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 "pry", "~> 0.12"
   spec.add_development_dependency "rake", "~> 10.0"
   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/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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateDeliveryOptionsHash
+        def self.call(delivery_options:)
+          {
+            DeliveryOptions: {
+              LiftGateRequiredIndicator: delivery_options.lift_gate_required ? "" : nil,
+              WeekendPickupIndicator: delivery_options.weekend_delivery ? "" : nil,
+              InsidePickupIndicator: delivery_options.inside_delivery ? "" : nil,
+              HolidayPickupIndicator: delivery_options.holiday_delivery ? "" : nil,
+              LimitedAccessPickupIndicator: delivery_options.limited_access_delivery ? "" : nil
+            }.compact.presence
+          }.compact.presence
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateDocumentOptionsHash
+        def self.call(document_options:)
+          {
+            Type: {
+              Code: document_options.document_type_code
+            },
+            LabelsPerPage: document_options.labels_per_page,
+            Format: {
+              Code: document_options.format_code
+            },
+            PrintFormat: {
+              Code: document_options.thermal_code,
+            },
+            PrintSize: {
+              Length: document_options.length,
+              Width: document_options.width,
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateEmailOptionsHash
+        def self.call(email_options:)
+          {
+            EMailInformation: {
+              EMailType: {
+                Code: email_options.email_type_code,
+              },
+              EMail: {
+                EMailAddress: email_options.email,
+                UndeliverableEMailAddress: email_options.undeliverable_email,
+                EMailText: email_options.body,
+                Subject: email_options.subject
+              }.compact
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'friendly_shipping/services/ups_freight/generate_location_hash'
+require 'friendly_shipping/services/ups_freight/generate_pickup_request_hash'
 
 module FriendlyShipping
   module Services
@@ -20,22 +21,13 @@ module FriendlyShipping
                 },
                 Commodity: options.commodity_information_generator.call(shipment: shipment, options: options),
                 TimeInTransitIndicator: 'true',
-                PickupRequest: pickup_request(options)
+                PickupRequest: GeneratePickupRequestHash.call(pickup_request_options: options.pickup_request_options),
               }.compact.merge(handling_units(shipment, options).reduce(&:merge).to_h)
             }
           end
 
           private
 
-          def pickup_request(options)
-            return unless options.pickup_date
-
-            {
-              PickupDate: options.pickup_date.strftime('%Y%m%d'),
-              AdditionalComments: options.pickup_comments
-            }
-          end
-
           def handling_units(shipment, options)
             all_package_options = shipment.packages.map { |package| options.options_for_package(package) }
             all_package_options.group_by(&:handling_unit_code).map do |_handling_unit_code, options_group|

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups_freight/generate_location_hash'
+require 'friendly_shipping/services/ups_freight/generate_document_options_hash'
+require 'friendly_shipping/services/ups_freight/generate_email_options_hash'
+require 'friendly_shipping/services/ups_freight/generate_pickup_options_hash'
+require 'friendly_shipping/services/ups_freight/generate_delivery_options_hash'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateFreightShipRequestHash
+        class << self
+          def call(shipment:, options:)
+            {
+              FreightShipRequest: {
+                Shipment: {
+                  ShipperNumber: options.shipper_number,
+                  ShipFrom: GenerateLocationHash.call(location: shipment.origin),
+                  ShipTo: GenerateLocationHash.call(location: shipment.destination),
+                  PaymentInformation: payment_information(options),
+                  Service: {
+                    Code: options.shipping_method.service_code
+                  },
+                  Commodity: options.commodity_information_generator.call(shipment: shipment, options: options),
+                  Documents: {
+                    Image: options.document_options.map { |doc_opts| GenerateDocumentOptionsHash.call(document_options: doc_opts) }
+                  },
+                  ShipmentServiceOptions: shipment_service_options(options),
+                  HandlingInstructions: options.handling_instructions,
+                  PickupInstructions: options.pickup_instructions,
+                  DeliveryInstructions: options.delivery_instructions,
+                  PickupRequest: GeneratePickupRequestHash.call(pickup_request_options: options.pickup_request_options)
+                }.compact.merge(handling_units(shipment, options).reduce(&:merge).to_h)
+              }
+            }
+          end
+
+          private
+
+          def shipment_service_options(options)
+            email_options = options.email_options.map { |email_opts| GenerateEmailOptionsHash.call(email_options: email_opts) }.presence
+            pickup_options = options.pickup_options ? GeneratePickupOptionsHash.call(pickup_options: options.pickup_options) : nil
+            delivery_options = options.delivery_options ? GenerateDeliveryOptionsHash.call(delivery_options: options.delivery_options) : nil
+            [email_options, pickup_options, delivery_options].compact.presence
+          end
+
+          def handling_units(shipment, options)
+            all_package_options = shipment.packages.map { |package| options.options_for_package(package) }
+            all_package_options.group_by(&:handling_unit_code).map do |_handling_unit_code, options_group|
+              [options_group.first, options_group.length]
+            end.map { |package_options, quantity| handling_unit_hash(package_options, quantity) }
+          end
+
+          def handling_unit_hash(package_options, quantity)
+            {
+              package_options.handling_unit_tag => {
+                Quantity: quantity.to_s,
+                Type: {
+                  Code: package_options.handling_unit_code,
+                  Description: package_options.handling_unit_description
+                }
+              }
+            }
+          end
+
+          def payment_information(options)
+            payer_address = GenerateLocationHash.call(location: options.billing_address).
+                            merge(ShipperNumber: options.shipper_number)
+            {
+              Payer: payer_address,
+              ShipmentBillingOption: {
+                Code: options.billing_code
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,8 +17,11 @@ module FriendlyShipping
                 PostalCode: location.zip,
                 CountryCode: location.country.code
               },
-              AttentionName: location.name
-            }
+              AttentionName: location.name,
+              Phone: {
+                Number: location.phone
+              }.compact.presence
+            }.compact
           end
 
           private

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GeneratePickupOptionsHash
+        def self.call(pickup_options:)
+          {
+            PickupOptions: {
+              LiftGateRequiredIndicator: pickup_options.lift_gate_required ? "" : nil,
+              WeekendPickupIndicator: pickup_options.weekend_pickup ? "" : nil,
+              InsidePickupIndicator: pickup_options.inside_pickup ? "" : nil,
+              HolidayPickupIndicator: pickup_options.holiday_pickup ? "" : nil,
+              LimitedAccessPickupIndicator: pickup_options.limited_access_pickup ? "" : nil
+            }.compact.presence
+          }.compact.presence
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GeneratePickupRequestHash
+        class << self
+          def call(pickup_request_options:)
+            return unless pickup_request_options
+
+            {
+              AdditionalComments: pickup_request_options.comments,
+              Requester: {
+                ThirdPartyRequester: pickup_request_options.third_party_requester ? '' : nil,
+                AttentionName: pickup_request_options.requester.name,
+                EMailAddress: pickup_request_options.requester_email,
+                Name: pickup_request_options.requester.company_name,
+                Phone: {
+                  Number: pickup_request_options.requester.phone
+                }.compact
+              }.compact,
+              PickupDate: pickup_request_options.pickup_time_window.begin.strftime('%Y%m%d'),
+              EarliestTimeReady: pickup_request_options.pickup_time_window.begin.strftime('%H%M'),
+              LatestTimeReady: pickup_request_options.pickup_time_window.end.strftime('%H%M'),
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelDeliveryOptions
+        attr_reader :holiday_delivery,
+                    :inside_delivery,
+                    :weekend_delivery,
+                    :lift_gate_required,
+                    :limited_access_delivery
+
+        def initialize(
+          holiday_delivery: nil,
+          inside_delivery: nil,
+          weekend_delivery: nil,
+          lift_gate_required: nil,
+          limited_access_delivery: nil
+        )
+          @holiday_delivery = holiday_delivery
+          @inside_delivery = inside_delivery
+          @weekend_delivery = weekend_delivery
+          @lift_gate_required = lift_gate_required
+          @limited_access_delivery = limited_access_delivery
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class LabelDocumentOptions
+        attr_reader :format, :type, :length, :width, :thermal
+
+        DOCUMENT_TYPES = {
+          label: "30",
+          ups_bol: "20",
+          vics_bol: "21"
+        }.freeze
+
+        DOCUMENT_FORMATS = {
+          pdf: "01"
+        }.freeze
+
+        THERMAL_CODE = {
+          false => "01",
+          true => "02"
+        }.freeze
+
+        def initialize(
+          format: :pdf,
+          type: :label,
+          size: "4x6",
+          thermal: false,
+          labels_per_page: 1
+        )
+          @format = format
+          @type = type
+          @length, @width = size.split('x').sort
+          @thermal = thermal
+          @labels_per_page = labels_per_page
+        end
+
+        def format_code
+          DOCUMENT_FORMATS.fetch(format)
+        end
+
+        def document_type_code
+          DOCUMENT_TYPES.fetch(type)
+        end
+
+        def thermal_code
+          THERMAL_CODE.fetch(thermal)
+        end
+
+        def labels_per_page
+          @labels_per_page.to_s
+        end
+      end
+    end
+  end
+end