friendly_shipping 0.6.5 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 921ae3f517c9fcf14e7932e110b6468d7bf2b78e46864bb50a3272b6257e2bea
-  data.tar.gz: d7cf64cc30bedd17adca882b9365f647498f8c4430f59e0a4fe1a00efe1ac017
+  metadata.gz: 748717bbd3258962363ac3c25a9159cbcf384c91d8f5a356a1c405441bec7bac
+  data.tar.gz: cf66d120169edd0bdc1608a27c0a015da599ca7800e813245cb1af9b2ce7992d
 SHA512:
-  metadata.gz: 9080b93ddde6399677499cb65e6b1a184985af772067548b45c977fd6d8744c9c6a08899c2b27426e3fcd795b13950141d017183c40aa25026d7cb3bf2eeb120
-  data.tar.gz: 413036408bfc7852a141c1b19e557b7533ca3288b371e6f5e09d78da279ef470bd764c9c46de145fbc6a079de9b18b858cb5bff75b972d3bed76ce4a946a2626
+  metadata.gz: f5b2fe10990482d30af429f31bbb48acfafa3dec81adf728a18a29d3de20bafaf329d00c73bb8899ab21469b7068a67bdb848067980d4deee559cdd1cbe511bb
+  data.tar.gz: 483efd68ebd20f3554baa8a239d1372a3fea8805cbcd203e84f7ec2401fd135627c452c2002147b474635806748dffd926ead4f40030ce583fb8a01c6d60ef3a

data/.circleci/config.yml

@@ -2,12 +2,15 @@
 #
 # Check https://circleci.com/docs/2.0/language-ruby/ for more details
 #
-version: 2
+version: 2.1
 jobs:
-  build:
+  test:
+    parameters:
+      ruby-version:
+        type: string
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.5
+       - image: cimg/ruby:<< parameters.ruby-version >>
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -22,7 +25,7 @@ jobs:
       # Download and cache dependencies
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "friendly_shipping.gemspec" }}
+          - v1-dependencies-{{ checksum "friendly_shipping.gemspec" }}-<< parameters.ruby-version >>
           # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
 
@@ -35,7 +38,7 @@ jobs:
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}-<< parameters.ruby-version >>
 
       - run:
           name: run Rubocop
@@ -60,3 +63,13 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
+
+workflows:
+  build_and_test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              # https://github.com/CircleCI-Public/cimg-ruby
+              # only supports the last three ruby versions
+              ruby-version: ["3.1", "3.0", "2.7"]

data/.env.template

@@ -2,7 +2,7 @@
 # NO PASSWORDS OR SENSITIVE INFORMATION SHOULD BE STORED HERE
 # Only pass along how those passwords/info are reference via ENV VARS
 
-SHIPENGINE_API_KEY=Ship Engine API key
+SHIPENGINE_API_KEY=ShipEngine API key
 SHIPENGINE_CARRIER_ID=Carrier ID from your ShipEngine account to run test labels with
 
 UPS_KEY=UPS API access key

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 
 inherit_from:
 - .rubocop-relaxed.yml
@@ -15,3 +15,6 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+Naming/VariableNumber:
+  Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,13 @@ 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.7.1] - 2023-01-20
+- ShipEngine Service: Include package dimensions even if package code given
+
+## [0.7.0] - 2022-12-14
+- Removes dependency on unmaintained data_uri gem
+- Bumps required Ruby to 2.7
+
 ## [0.6.5] - 2022-04-25
 
 ### Added

data/README.md

@@ -1,6 +1,6 @@
 # FriendlyShipping - the friendly shipping provider API wrapper
 
-This gem provides wrappers for popular shipping provider APIs. Currently, there are implementations for rate quoting and address validation, as well as shipping label generation via the `ShipStation` API.
+This gem provides wrappers for popular shipping provider APIs. Currently, there are implementations for rate quoting and address validation, as well as shipping label generation via the `ShipEngine` API.
 
 ## Installation
 

data/friendly_shipping.gemspec

@@ -22,13 +22,12 @@ 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", "< 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"
-  spec.add_runtime_dependency "physical", "~> 0.4", ">= 0.4.4"
+  spec.add_runtime_dependency "physical", "~> 0.4", ">= 0.4.5"
   spec.add_runtime_dependency "rest-client", "~> 2.0"
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.add_development_dependency "bundler", ">= 2.1.4", "< 3"
   spec.add_development_dependency "dotenv", "~> 2.7"
@@ -37,7 +36,7 @@ Gem::Specification.new do |spec|
   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 "rubocop"
   spec.add_development_dependency "simplecov", "~> 0.17"
   spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "webmock", "~> 3.6"

data/lib/friendly_shipping/api_error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  class ApiError < StandardError
+    attr_reader :cause
+
+    # @param [RestClient::Exception] cause
+    # @param [String] msg
+    def initialize(cause, msg = nil)
+      @cause = cause
+      super msg || cause.message
+    end
+  end
+end

data/lib/friendly_shipping/api_error_handler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/api_error'
+
+module FriendlyShipping
+  class ApiErrorHandler
+    include Dry::Monads[:result]
+
+    attr_reader :api_error_class
+
+    # @param [Class] api_error_class
+    def initialize(api_error_class: FriendlyShipping::ApiError)
+      @api_error_class = api_error_class
+    end
+
+    # @param [StandardError] error
+    # @param [FriendlyShipping::Request] original_request
+    # @param [RestClient::Response] original_response
+    # @return [Dry::Monads::Failure<FriendlyShipping::ApiFailure>]
+    def call(error, original_request: nil, original_response: nil)
+      Failure(
+        ApiFailure.new(
+          api_error_class.new(error),
+          original_request: original_request,
+          original_response: Response.new_from_rest_client_response(original_response)
+        )
+      )
+    end
+  end
+end

data/lib/friendly_shipping/http_client.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
-require 'friendly_shipping/api_failure'
+require 'dry/monads'
 require 'rest-client'
 
+require 'friendly_shipping/api_failure'
+require 'friendly_shipping/api_error_handler'
+
 module FriendlyShipping
   class HttpClient
-    include Dry::Monads::Result::Mixin
+    include Dry::Monads[:result]
 
     attr_reader :error_handler
 
     # @param [Proc] error_handler Called to handle an error if one occurs
-    def initialize(error_handler: method(:wrap_in_failure))
+    def initialize(error_handler: FriendlyShipping::ApiErrorHandler.new)
       @error_handler = error_handler
     end
 
@@ -20,7 +22,7 @@ module FriendlyShipping
         request.url, request.headers
       )
 
-      Success(convert_to_friendly_response(http_response))
+      Success(Response.new_from_rest_client_response(http_response))
     rescue ::RestClient::Exception => e
       error_handler.call(e, original_request: request, original_response: e.response)
     end
@@ -32,7 +34,7 @@ module FriendlyShipping
         request.headers
       )
 
-      Success(convert_to_friendly_response(http_response))
+      Success(Response.new_from_rest_client_response(http_response))
     rescue ::RestClient::Exception => e
       error_handler.call(e, original_request: request, original_response: e.response)
     end
@@ -44,29 +46,9 @@ module FriendlyShipping
         request.headers
       )
 
-      Success(convert_to_friendly_response(http_response))
+      Success(Response.new_from_rest_client_response(http_response))
     rescue ::RestClient::Exception => e
       error_handler.call(e, original_request: request, original_response: e.response)
     end
-
-    private
-
-    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)
-      FriendlyShipping::Response.new(
-        status: http_response.code,
-        body: http_response.body,
-        headers: http_response.headers
-      )
-    end
   end
 end

data/lib/friendly_shipping/request.rb

@@ -2,15 +2,17 @@
 
 module FriendlyShipping
   class Request
-    attr_reader :url, :body, :headers, :debug
+    attr_reader :url, :http_method, :body, :headers, :debug
 
     # @param [String] url The HTTP request URL
+    # @param [String] http_method The HTTP request method
     # @param [String] body The HTTP request body
-    # # @param [String] readable_body Human-readable 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, readable_body: nil, headers: {}, debug: false)
+    def initialize(url:, http_method: nil, body: nil, readable_body: nil, headers: {}, debug: false)
       @url = url
+      @http_method = http_method
       @body = body
       @readable_body = readable_body
       @headers = headers

data/lib/friendly_shipping/response.rb

@@ -10,7 +10,33 @@ module FriendlyShipping
     def initialize(status:, body:, headers:)
       @status = status
       @body = body
-      @headers = headers
+      @headers = headers || {}
+    end
+
+    alias_method :code, :status
+
+    # @param [RestClient::Response] response
+    # @return [FriendlyShipping::Response]
+    def self.new_from_rest_client_response(response)
+      new(status: response&.code, body: response&.body, headers: response&.headers)
+    end
+
+    # @param [Object] other
+    def ==(other)
+      other.class == self.class &&
+        other.attributes == attributes
+    end
+
+    alias_method :eql?, :==
+
+    def hash
+      attributes.hash
+    end
+
+    protected
+
+    def attributes
+      [status, body, headers]
     end
   end
 end

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'data_uri'
 
 module FriendlyShipping
   module Services
@@ -14,7 +13,14 @@ module FriendlyShipping
           label_data = nil
           label_url = nil
           if label_uri_string.starts_with?('data')
-            label_data = URI::Data.new(label_uri_string).data
+            # This URI has the following form:
+            # data:application/zpl;base64,XlhBDQpeTEwxMjE4....
+            # We don't know the content type here, but we can assume Base64
+            # encoding.
+            # This next line splits the URI at the first occurrence of ";base64,",
+            # giving us the desired base64 encoded string.
+            _, base64_encoded = label_uri_string.split(";base64,", 2)
+            label_data = Base64.decode64(base64_encoded)
           else
             label_url = label_uri_string
           end

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

@@ -53,16 +53,13 @@ module FriendlyShipping
                 ["reference#{index + 1}".to_sym, message]
               end.to_h
 
-              if package_options.package_code
-                package_hash[:package_code] = package_options.package_code
-              else
-                package_hash[:dimensions] = {
-                  unit: 'inch',
-                  width: package.container.width.convert_to(:inches).value.to_f.round(2),
-                  length: package.container.length.convert_to(:inches).value.to_f.round(2),
-                  height: package.container.height.convert_to(:inches).value.to_f.round(2)
-                }
-              end
+              package_hash[:package_code] = package_options.package_code
+              package_hash[:dimensions] = {
+                unit: 'inch',
+                width: package.container.width.convert_to(:inches).value.to_f.round(2),
+                length: package.container.length.convert_to(:inches).value.to_f.round(2),
+                height: package.container.height.convert_to(:inches).value.to_f.round(2)
+              }
               package_hash
             end
           end

data/lib/friendly_shipping/services/ship_engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 require 'friendly_shipping/http_client'
 require 'friendly_shipping/services/ship_engine/bad_request_handler'
 require 'friendly_shipping/services/ship_engine/parse_carrier_response'
@@ -28,12 +28,13 @@ module FriendlyShipping
         @client = client
       end
 
-      # Get configured carriers from USPS
+      # Get configured carriers from ShipEngine
       #
-      # @return [Result<ApiResult<Array<Carrier>>>] Carriers configured in your shipstation account
+      # @return [Result<ApiResult<Array<Carrier>>>] Carriers configured in your account
       def carriers(debug: false)
         request = FriendlyShipping::Request.new(
           url: API_BASE + API_PATHS[:carriers],
+          http_method: "GET",
           headers: request_headers,
           debug: debug
         )
@@ -53,7 +54,8 @@ module FriendlyShipping
       #   can be serialized into an error message using `to_s`.
       def rate_estimates(shipment, options: FriendlyShipping::Services::ShipEngine::RateEstimatesOptions.new, debug: false)
         request = FriendlyShipping::Request.new(
-          url: API_BASE + 'rates/estimate',
+          url: "#{API_BASE}rates/estimate",
+          http_method: "POST",
           body: SerializeRateEstimateRequest.call(shipment: shipment, options: options).to_json,
           headers: request_headers,
           debug: debug
@@ -68,13 +70,14 @@ module FriendlyShipping
       # @param [Physical::Shipment] shipment The shipment object we're trying to get labels for
       #   Note: Some ShipEngine carriers, notably USPS, only support one package per shipment, and that's
       #   all that the integration supports at this point.
-      # @param [FriendlyShipping::Services::ShipEngine::LabelOptions] The options relevant to estimating rates. See object description.
+      # @param [FriendlyShipping::Services::ShipEngine::LabelOptions] options The options relevant to estimating rates. See object description.
       #
       # @return [Result<ApiResult<Array<FriendlyShipping::Label>>>] The label returned.
       #
       def labels(shipment, options:)
         request = FriendlyShipping::Request.new(
           url: API_BASE + API_PATHS[:labels],
+          http_method: "POST",
           body: SerializeLabelShipment.call(shipment: shipment, options: options, test: test).to_json,
           headers: request_headers
         )
@@ -86,6 +89,7 @@ module FriendlyShipping
       def void(label, debug: false)
         request = FriendlyShipping::Request.new(
           url: "#{API_BASE}labels/#{label.id}/void",
+          http_method: "PUT",
           body: '',
           headers: request_headers,
           debug: debug

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 require 'friendly_shipping/services/ups/parse_money_element'
 
 module FriendlyShipping

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 
 module FriendlyShipping
   module Services

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 
 module FriendlyShipping
   module Services

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

@@ -84,7 +84,7 @@ module FriendlyShipping
           @shipper = shipper
           @shipping_method = shipping_method
           @with_time_in_transit = with_time_in_transit
-          super kwargs.merge(package_options_class: package_options_class)
+          super(**kwargs.merge(package_options_class: package_options_class))
         end
 
         def pickup_type_code

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

@@ -16,7 +16,7 @@ module FriendlyShipping
           **kwargs
         )
           @transmit_dimensions = transmit_dimensions
-          super kwargs
+          super(**kwargs)
         end
       end
     end

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

@@ -39,6 +39,10 @@ module FriendlyShipping
         ['US', 'domestic', 'UPS Next Day Air', '01'],
         ['US', 'domestic', 'UPS Next Day Air Early', '14'],
         ['US', 'domestic', 'UPS Next Day Air Saver', '13'],
+        ['US', 'domestic', 'UPS SurePost Less than 1LB', '92'],
+        ['US', 'domestic', 'UPS SurePost 1LB or greater', '93'],
+        ['US', 'domestic', 'UPS SurePost BPM', '94'],
+        ['US', 'domestic', 'UPS SurePost Media Mail', '95'],
         ['CA', 'domestic', 'UPS Expedited Canadian domestic shipments', '02'],
         ['CA', 'domestic', 'UPS Express Saver Canadian domestic shipments', '13'],
         ['CA', 'domestic', 'UPS 3 Day Select Shipments originating in Canada to CA and US 48', '12'],

data/lib/friendly_shipping/services/ups.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 require 'friendly_shipping/http_client'
 require 'friendly_shipping/services/ups/serialize_access_request'
 require 'friendly_shipping/services/ups/serialize_city_state_lookup_request'
@@ -26,7 +26,7 @@ require 'friendly_shipping/services/ups/timing_options'
 module FriendlyShipping
   module Services
     class Ups
-      include Dry::Monads::Result::Mixin
+      include Dry::Monads[:result]
 
       attr_reader :test, :key, :login, :password, :client
 
@@ -73,6 +73,7 @@ module FriendlyShipping
         url = base_url + RESOURCES[:rates]
         request = FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: access_request_xml + rate_request_xml,
           readable_body: rate_request_xml,
           debug: debug
@@ -95,6 +96,7 @@ module FriendlyShipping
 
         request = FriendlyShipping::Request.new(
           url: time_in_transit_url,
+          http_method: "POST",
           body: access_request_xml + time_in_transit_request_xml,
           readable_body: time_in_transit_request_xml,
           debug: debug
@@ -115,6 +117,7 @@ module FriendlyShipping
 
         ship_confirm_request = FriendlyShipping::Request.new(
           url: ship_confirm_url,
+          http_method: "POST",
           body: access_request_xml + ship_confirm_request_xml,
           readable_body: ship_confirm_request_xml,
           debug: debug
@@ -134,6 +137,7 @@ module FriendlyShipping
 
           ship_accept_request = FriendlyShipping::Request.new(
             url: ship_accept_url,
+            http_method: "POST",
             body: access_request_xml + ship_accept_request_xml,
             readable_body: ship_accept_request_xml,
             debug: debug
@@ -156,6 +160,7 @@ module FriendlyShipping
         url = base_url + RESOURCES[:address_validation]
         request = FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: access_request_xml + address_validation_request_xml,
           readable_body: address_validation_request_xml,
           debug: debug
@@ -174,6 +179,7 @@ module FriendlyShipping
         url = base_url + RESOURCES[:address_validation]
         request = FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: access_request_xml + address_validation_request_xml,
           readable_body: address_validation_request_xml,
           debug: debug
@@ -193,6 +199,7 @@ module FriendlyShipping
         url = base_url + RESOURCES[:city_state_lookup]
         request = FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: access_request_xml + city_state_lookup_request_xml,
           readable_body: city_state_lookup_request_xml,
           debug: debug
@@ -208,6 +215,7 @@ module FriendlyShipping
         void_request_xml = SerializeVoidShipmentRequest.call(label: label)
         request = FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: access_request_xml + void_request_xml,
           readable_body: void_request_xml,
           debug: debug

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/api_error'
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class ApiError < FriendlyShipping::ApiError
+        # @param [RestClient::Exception] cause
+        def initialize(cause)
+          super cause, parse_message(cause)
+        end
+
+        private
+
+        # @param [RestClient::Exception] cause
+        def parse_message(cause)
+          parsed_json = JSON.parse(cause.response.body)
+
+          if parsed_json['httpCode'].present?
+            status = [parsed_json['httpCode'], parsed_json['httpMessage']].compact.join(" ")
+            desc = parsed_json['moreInformation']
+            [status, desc].compact.join(": ")
+          else
+            errors = parsed_json.dig('response', 'errors') || []
+            errors.map do |err|
+              status = err['code']
+              desc = err['message']
+              [status, desc].compact.join(": ").presence || "UPS Freight could not process the request."
+            end.join("\n")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,13 @@ module FriendlyShipping
         def self.call(delivery_options:)
           {
             DeliveryOptions: {
+              CallBeforeDeliveryIndicator: delivery_options.call_before_delivery ? "" : nil,
+              HolidayDeliveryIndicator: delivery_options.holiday_delivery ? "" : nil,
+              InsideDeliveryIndicator: delivery_options.inside_delivery ? "" : nil,
+              ResidentialDeliveryIndicator: delivery_options.residential_delivery ? "" : nil,
+              WeekendDeliveryIndicator: delivery_options.weekend_delivery ? "" : nil,
               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
+              LimitedAccessDeliveryIndicator: delivery_options.limited_access_delivery ? "" : nil
             }.compact.presence
           }.compact.presence
         end

data/lib/friendly_shipping/services/ups_freight/generate_freight_ship_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_reference_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'
@@ -30,8 +31,10 @@ module FriendlyShipping
                   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)
+                  PickupRequest: GeneratePickupRequestHash.call(pickup_request_options: options.pickup_request_options),
+                }.compact.
+                  merge(handling_units(shipment, options).reduce(&:merge).to_h).
+                  merge(GenerateReferenceHash.call(reference_numbers: options.reference_numbers))
               }
             }
           end

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

@@ -6,16 +6,14 @@ module FriendlyShipping
       class GenerateLocationHash
         class << self
           def call(location:)
-            # We ship freight here, which will mostly be used for businesses.
-            # If a personal name is given, treat is as the contact person ("AttentionName")
             {
-              Name: location.company_name,
+              Name: location.company_name.presence || location.name,
               Address: {
                 AddressLine: address_line(location),
                 City: location.city,
-                StateProvinceCode: location.region.code,
+                StateProvinceCode: location.region&.code,
                 PostalCode: location.zip,
-                CountryCode: location.country.code
+                CountryCode: location.country&.code
               },
               AttentionName: location.name,
               Phone: {
@@ -27,13 +25,12 @@ module FriendlyShipping
           private
 
           def address_line(location)
-            [
+            address_lines = [
               location.address1,
               location.address2,
               location.address3
-            ].compact.
-              reject(&:empty?).
-              join(", ")
+            ].compact.reject(&:empty?)
+            address_lines.size > 1 ? address_lines : address_lines.first
           end
         end
       end

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

@@ -7,10 +7,11 @@ module FriendlyShipping
         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,
+              InsidePickupIndicator: pickup_options.inside_pickup ? "" : nil,
+              ResidentialPickupIndicator: pickup_options.residential_pickup ? "" : nil,
+              WeekendPickupIndicator: pickup_options.weekend_pickup ? "" : nil,
+              LiftGateRequiredIndicator: pickup_options.lift_gate_required ? "" : nil,
               LimitedAccessPickupIndicator: pickup_options.limited_access_pickup ? "" : nil
             }.compact.presence
           }.compact.presence

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UpsFreight
+      class GenerateReferenceHash
+        class << self
+          # @param [Array] reference_numbers Reference numbers for the Bill of Lading
+          # @return [Hash] Reference hash suitable for JSON request
+          def call(reference_numbers:)
+            return {} unless reference_numbers
+
+            references = reference_numbers.map do |reference_number|
+              {
+                Number: {
+                  Code: reference_number[:code],
+                  Value: reference_number[:value]
+                }
+              }
+            end
+            references.any? ? { Reference: references } : {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,21 +4,27 @@ module FriendlyShipping
   module Services
     class UpsFreight
       class LabelDeliveryOptions
-        attr_reader :holiday_delivery,
+        attr_reader :call_before_delivery,
+                    :holiday_delivery,
                     :inside_delivery,
+                    :residential_delivery,
                     :weekend_delivery,
                     :lift_gate_required,
                     :limited_access_delivery
 
         def initialize(
+          call_before_delivery: nil,
           holiday_delivery: nil,
           inside_delivery: nil,
+          residential_delivery: nil,
           weekend_delivery: nil,
           lift_gate_required: nil,
           limited_access_delivery: nil
         )
+          @call_before_delivery = call_before_delivery
           @holiday_delivery = holiday_delivery
           @inside_delivery = inside_delivery
+          @residential_delivery = residential_delivery
           @weekend_delivery = weekend_delivery
           @lift_gate_required = lift_gate_required
           @limited_access_delivery = limited_access_delivery

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

@@ -4,14 +4,30 @@ module FriendlyShipping
   module Services
     class UpsFreight
       class LabelOptions < RatesOptions
+        REFERENCE_NUMBER_CODES = {
+          bill_of_lading_number: "57",
+          purchase_order_number: "28",
+          shipper_reference: "SH",
+          consignee_reference: "CO",
+          pm: "PM",
+          proj: "PROJ",
+          quote: "QUOTE",
+          sid: "SID",
+          task: "TASK",
+          vprc: "VPRC",
+          other: "OTHER"
+        }.freeze
+
         attr_reader :document_options,
                     :email_options,
                     :pickup_options,
                     :delivery_options,
                     :pickup_instructions,
                     :delivery_instructions,
-                    :handling_instructions
+                    :handling_instructions,
+                    :reference_numbers
 
+        # @param [Array] reference_numbers Reference numbers for the Bill of Lading
         def initialize(
           document_options: [],
           email_options: [],
@@ -20,6 +36,7 @@ module FriendlyShipping
           pickup_instructions: nil,
           delivery_instructions: nil,
           handling_instructions: nil,
+          reference_numbers: [],
           **kwargs
         )
           @pickup_options = pickup_options
@@ -29,7 +46,16 @@ module FriendlyShipping
           @pickup_instructions = pickup_instructions
           @delivery_instructions = delivery_instructions
           @handling_instructions = handling_instructions
-          super kwargs
+          @reference_numbers = fill_codes(reference_numbers)
+          super(**kwargs)
+        end
+
+        private
+
+        def fill_codes(reference_numbers)
+          reference_numbers.each do |reference_number|
+            reference_number[:code] = REFERENCE_NUMBER_CODES.fetch(reference_number[:code])
+          end
         end
       end
     end

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

@@ -6,6 +6,7 @@ module FriendlyShipping
       class LabelPickupOptions
         attr_reader :holiday_pickup,
                     :inside_pickup,
+                    :residential_pickup,
                     :weekend_pickup,
                     :lift_gate_required,
                     :limited_access_pickup
@@ -13,12 +14,14 @@ module FriendlyShipping
         def initialize(
           holiday_pickup: nil,
           inside_pickup: nil,
+          residential_pickup: nil,
           weekend_pickup: nil,
           lift_gate_required: nil,
           limited_access_pickup: nil
         )
           @holiday_pickup = holiday_pickup
           @inside_pickup = inside_pickup
+          @residential_pickup = residential_pickup
           @weekend_pickup = weekend_pickup
           @lift_gate_required = lift_gate_required
           @limited_access_pickup = limited_access_pickup

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

@@ -23,19 +23,23 @@ module FriendlyShipping
             service_code = shipment_results.dig("Service", "Code")
             shipping_method = SHIPPING_METHODS.detect { |sm| sm.service_code == service_code }
 
-            total_shipment_charge = shipment_results.dig("TotalShipmentCharge")
-            currency = Money::Currency.new(total_shipment_charge['CurrencyCode'])
-            amount = total_shipment_charge['MonetaryValue'].to_f
-            total_money = Money.new(amount * currency.subunit_to_unit, currency)
+            total_shipment_charge = shipment_results["TotalShipmentCharge"]
+            if total_shipment_charge
+              currency = Money::Currency.new(total_shipment_charge['CurrencyCode'])
+              amount = total_shipment_charge['MonetaryValue'].to_f
+              total_money = Money.new(amount * currency.subunit_to_unit, currency)
+            end
 
             images_data = Array.wrap(shipment_results.dig("Documents", "Image"))
 
-            bol_id = shipment_results.dig("BOLID")
-            shipment_number = shipment_results.dig("ShipmentNumber")
-            pickup_request_number = shipment_results.dig("PickupRequestConfirmationNumber")
+            bol_id = shipment_results["BOLID"]
+            shipment_number = shipment_results["ShipmentNumber"]
+            pickup_request_number = shipment_results["PickupRequestConfirmationNumber"]
 
             documents = images_data.map { |image_data| ParseShipmentDocument.call(image_data: image_data) }
 
+            cost_breakdown = build_cost_breakdown(shipment_results)
+
             FriendlyShipping::ApiResult.new(
               ShipmentInformation.new(
                 total: total_money,
@@ -44,12 +48,27 @@ module FriendlyShipping
                 pickup_request_number: pickup_request_number,
                 shipping_method: shipping_method,
                 warnings: warnings,
-                documents: documents
+                documents: documents,
+                data: {
+                  cost_breakdown: cost_breakdown
+                }
               ),
               original_request: request,
               original_response: response
             )
           end
+
+          private
+
+          def build_cost_breakdown(shipment_results)
+            {
+              "Rates" => shipment_results.fetch("Rate", []).each_with_object({}) do |rate, hash|
+                hash[rate.dig("Type", "Code")] = rate.dig("Factor", "Value")
+              end,
+              "TotalShipmentCharge" => shipment_results.dig("TotalShipmentCharge", "MonetaryValue"),
+              "BillableShipmentWeight" => shipment_results.dig("BillableShipmentWeight", "Value")
+            }.compact
+          end
         end
       end
     end

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

@@ -10,7 +10,7 @@ module FriendlyShipping
 
         def self.call(image_data:)
           format_code = image_data.dig("Type", "Code")
-          graphic_image_b64 = image_data.dig("GraphicImage")
+          graphic_image_b64 = image_data["GraphicImage"]
 
           ShipmentDocument.new(
             format: image_data.dig("Format", "Code").downcase.to_sym,

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

@@ -10,7 +10,8 @@ module FriendlyShipping
                     :total,
                     :bol_id,
                     :shipping_method,
-                    :warnings
+                    :warnings,
+                    :data
 
         def initialize(
           total:,
@@ -19,7 +20,8 @@ module FriendlyShipping
           pickup_request_number: nil,
           documents: [],
           shipping_method: nil,
-          warnings: nil
+          warnings: nil,
+          data: {}
         )
           @total = total
           @bol_id = bol_id
@@ -28,6 +30,7 @@ module FriendlyShipping
           @documents = documents
           @shipping_method = shipping_method
           @warnings = warnings
+          @data = data
         end
       end
     end

data/lib/friendly_shipping/services/ups_freight.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require 'dry/monads'
 require 'friendly_shipping/http_client'
 require 'friendly_shipping/services/ups_freight/shipping_methods'
 require 'friendly_shipping/services/ups_freight/rates_options'
@@ -18,12 +18,12 @@ 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_freight_ship_request_hash'
-require 'friendly_shipping/services/ups_freight/restful_api_error_handler'
+require 'friendly_shipping/services/ups_freight/api_error'
 
 module FriendlyShipping
   module Services
     class UpsFreight
-      include Dry::Monads::Result::Mixin
+      include Dry::Monads[:result]
 
       attr_reader :test, :key, :login, :password, :client
 
@@ -42,12 +42,14 @@ module FriendlyShipping
         labels: '/ship/v1607/freight/shipments/Ground'
       }.freeze
 
-      def initialize(key:, login:, password:, test: true, client: HttpClient.new(error_handler: RestfulApiErrorHandler))
+      def initialize(key:, login:, password:, test: true, client: nil)
         @key = key
         @login = login
         @password = password
         @test = test
-        @client = client
+
+        error_handler = ApiErrorHandler.new(api_error_class: UpsFreight::ApiError)
+        @client = client || HttpClient.new(error_handler: error_handler)
       end
 
       def carriers
@@ -87,6 +89,7 @@ module FriendlyShipping
         url = base_url + RESOURCES[action]
         FriendlyShipping::Request.new(
           url: url,
+          http_method: "POST",
           body: payload.to_json,
           headers: {
             Content_Type: 'application/json',

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

@@ -20,7 +20,7 @@ module FriendlyShipping
           package_options_class: FriendlyShipping::Services::Usps::RateEstimatePackageOptions,
           **kwargs
         )
-          super kwargs.merge(package_options_class: package_options_class)
+          super(**kwargs.merge(package_options_class: package_options_class))
         end
       end
     end

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

@@ -22,28 +22,18 @@ module FriendlyShipping
                     :return_dimensional_weight,
                     :return_fees
 
-        def initialize(
-          box_name: :variable,
-          commercial_pricing: false,
-          first_class_mail_type: nil,
-          hold_for_pickup: false,
-          shipping_method: nil,
-          transmit_dimensions: true,
-          rectangular: true,
-          return_dimensional_weight: true,
-          return_fees: false,
-          **kwargs
-        )
+        def initialize(**kwargs)
+          box_name = value_or_default(:box_name, :variable, kwargs)
           @box_name = CONTAINERS.key?(box_name) ? box_name : :variable
-          @commercial_pricing = commercial_pricing
-          @first_class_mail_type = first_class_mail_type
-          @hold_for_pickup = hold_for_pickup
-          @shipping_method = shipping_method
-          @transmit_dimensions = transmit_dimensions
-          @rectangular = rectangular
-          @return_dimensional_weight = return_dimensional_weight
-          @return_fees = return_fees
-          super kwargs
+          @commercial_pricing = value_or_default(:commercial_pricing, false, kwargs)
+          @first_class_mail_type = kwargs.delete(:first_class_mail_type)
+          @hold_for_pickup = value_or_default(:hold_for_pickup, false, kwargs)
+          @shipping_method = kwargs.delete(:shipping_method)
+          @transmit_dimensions = value_or_default(:transmit_dimensions, true, kwargs)
+          @rectangular = value_or_default(:rectangular, true, kwargs)
+          @return_dimensional_weight = value_or_default(:return_dimensional_weight, true, kwargs)
+          @return_fees = value_or_default(:return_fees, false, kwargs)
+          super(**kwargs)
         end
 
         def container_code
@@ -65,6 +55,12 @@ module FriendlyShipping
           service_code << 'COMMERCIAL' if commercial_pricing
           service_code.join(' ')
         end
+
+        private
+
+        def value_or_default(key, default, kwargs)
+          kwargs.key?(key) ? kwargs.delete(key) : default
+        end
       end
     end
   end

data/lib/friendly_shipping/services/usps.rb

@@ -16,7 +16,7 @@ require 'friendly_shipping/services/usps/rate_estimate_options'
 module FriendlyShipping
   module Services
     class Usps
-      include Dry::Monads::Result::Mixin
+      include Dry::Monads[:result]
 
       attr_reader :test, :login, :client
 
@@ -111,6 +111,7 @@ module FriendlyShipping
       def build_request(api:, xml:, debug:)
         FriendlyShipping::Request.new(
           url: base_url,
+          http_method: "POST",
           body: "API=#{RESOURCES[api]}&XML=#{CGI.escape xml}",
           readable_body: xml,
           debug: debug

data/lib/friendly_shipping/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
-  VERSION = "0.6.5"
+  VERSION = "0.7.1"
 end

data/lib/friendly_shipping.rb

@@ -18,6 +18,7 @@ require "friendly_shipping/api_failure"
 
 require "friendly_shipping/services/ship_engine"
 require "friendly_shipping/services/ups"
+require "friendly_shipping/services/ups_freight"
 require "friendly_shipping/services/usps"
 
 module FriendlyShipping

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.1
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2023-01-20 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
@@ -81,7 +61,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +71,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -216,20 +196,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.80'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.80'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -297,6 +271,8 @@ files:
 - bin/setup
 - friendly_shipping.gemspec
 - lib/friendly_shipping.rb
+- lib/friendly_shipping/api_error.rb
+- lib/friendly_shipping/api_error_handler.rb
 - lib/friendly_shipping/api_failure.rb
 - lib/friendly_shipping/api_result.rb
 - lib/friendly_shipping/carrier.rb
@@ -350,6 +326,7 @@ files:
 - lib/friendly_shipping/services/ups/shipping_methods.rb
 - lib/friendly_shipping/services/ups/timing_options.rb
 - lib/friendly_shipping/services/ups_freight.rb
+- lib/friendly_shipping/services/ups_freight/api_error.rb
 - lib/friendly_shipping/services/ups_freight/generate_commodity_information.rb
 - lib/friendly_shipping/services/ups_freight/generate_delivery_options_hash.rb
 - lib/friendly_shipping/services/ups_freight/generate_document_options_hash.rb
@@ -359,6 +336,7 @@ files:
 - lib/friendly_shipping/services/ups_freight/generate_location_hash.rb
 - lib/friendly_shipping/services/ups_freight/generate_pickup_options_hash.rb
 - lib/friendly_shipping/services/ups_freight/generate_pickup_request_hash.rb
+- lib/friendly_shipping/services/ups_freight/generate_reference_hash.rb
 - lib/friendly_shipping/services/ups_freight/label_delivery_options.rb
 - lib/friendly_shipping/services/ups_freight/label_document_options.rb
 - lib/friendly_shipping/services/ups_freight/label_email_options.rb
@@ -373,7 +351,6 @@ files:
 - lib/friendly_shipping/services/ups_freight/rates_item_options.rb
 - lib/friendly_shipping/services/ups_freight/rates_options.rb
 - lib/friendly_shipping/services/ups_freight/rates_package_options.rb
-- lib/friendly_shipping/services/ups_freight/restful_api_error_handler.rb
 - lib/friendly_shipping/services/ups_freight/shipment_document.rb
 - lib/friendly_shipping/services/ups_freight/shipment_information.rb
 - lib/friendly_shipping/services/ups_freight/shipping_methods.rb
@@ -411,14 +388,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: An integration layer for shipping services

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class UpsFreight
-      class RestfulApiErrorHandler
-        extend Dry::Monads::Result::Mixin
-
-        def self.call(error, original_request: nil, original_response: nil)
-          parsed_json = JSON.parse(error.response.body)
-          errors = parsed_json.dig('response', 'errors')
-
-          failure_string = errors.map do |err|
-            status = err['code']
-            desc = err['message']
-            [status, desc].compact.join(": ").presence || 'UPS could not process the request.'
-          end.join("\n")
-
-          Failure(
-            ApiFailure.new(
-              failure_string,
-              original_request: original_request,
-              original_response: original_response
-            )
-          )
-        end
-      end
-    end
-  end
-end