friendly_shipping 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 107fa27ec95b49342549dbf24c53cc483cd05bdfbb64871940036aaac6567eb6
-  data.tar.gz: 7dd9c281178e513482ae0cb93787eb551b09e5f697f10d4db50dc2aef21dd4a8
+  metadata.gz: 4e5444887ead0f957efaa619fc49bf737c34513f8a2480504beaabdbdab0eb2d
+  data.tar.gz: c52c103c53e9be10cef0d6288c1713de54441e536f8691cf0685c2bb0a4859ff
 SHA512:
-  metadata.gz: 30c37297f77dc6be490cf9719211780b81b0d91cdc49311b349fc3844a6cbcb5755265e663b80e24a67cda9847e19d328808cec786cf7172d6986ccb75bbf6eb
-  data.tar.gz: 022c69680c07d9fed0b2b9afa8093e40b20bb7b441b332acd743078f74db70f3de03227953952de8b08048aa40eb902895529c781b6332036cf4e38ba653804e
+  metadata.gz: eff139906b09356f48bbb34e39587f41f3802cba25abb87921b7e2883865d399d4b043b793c5e0ca40fddf9fe9ca00b326be39722466a9c59c83020a67d6674e
+  data.tar.gz: 396fe842544a93357d601d383a27d116b5b6f4e2947fec39703e7bd70a57b8fe30a63f68eb7312761db56e3533d59fbf70a3c87bb673ac3d497912c84b5a703b

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,22 +4,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.6.4] - 2021-01-27
+## [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
+- USPS Service: Add support for returned dimensional weight (#128)
+- USPS Service: Add support for returned fees (#127)
 
+### Changed
+- ShipEngine Service: Prevent exceptions when no rates are returned (#125)
+- Misc dependency updates (#116, #120, #121, #124)
+
+## [0.6.4] - 2021-01-27
+
+### Added
 - UPS Service: Include negotiated charges for UPS (#119)
 - UPS Service: Include shipment-level itemized charges (#117)
 
 ## [0.6.3] - 2020-10-30
 
 ### Added
-
 - USPS Service: Append HFP (Hold For Pickup) to service code when necessary (#110)
 - USPS Service: Add Priority Cubic shipping method (#113)
 
 ### Changed
-
 - USPS Service: Refactor to use explicit service codes (#111)
 - USPS Service: Match Priority Express by CLASSID instead of service name (#112)
 - UPS Service: Rename peak surcharge keys to match UPS docs (#114)

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,23 +22,22 @@ 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"
   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", ">= 1.17", "< 3"
+  spec.add_development_dependency "bundler", ">= 2.1.4", "< 3"
   spec.add_development_dependency "dotenv", "~> 2.7"
-  spec.add_development_dependency "factory_bot", "~> 5.0"
+  spec.add_development_dependency "factory_bot", "~> 6.2"
   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", ">= 0.80", "< 1"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "simplecov", "~> 0.17"
-  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "webmock", "~> 3.6"
 end

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

@@ -10,8 +10,14 @@ module FriendlyShipping
 
         class << self
           def call(response:, request:, options:)
+            error_messages = []
             parsed_json = JSON.parse(response.body)
             rates = parsed_json.map do |rate|
+              if rate['validation_status'] == 'invalid'
+                error_messages.concat rate['error_messages']
+                next
+              end
+
               carrier = options.carriers.detect { |c| c.id == rate['carrier_id'] }
               next unless carrier
 
@@ -31,17 +37,33 @@ module FriendlyShipping
               )
             end.compact
 
-            Success(
-              ApiResult.new(
-                rates,
-                original_request: request,
-                original_response: response
+            if valid_rates(parsed_json)
+              Success(
+                ApiResult.new(
+                  rates,
+                  original_request: request,
+                  original_response: response
+                )
+              )
+            else
+              Failure(
+                ApiFailure.new(
+                  error_messages,
+                  original_request: request,
+                  original_response: response
+                )
               )
-            )
+            end
           end
 
           private
 
+          def valid_rates(parsed_json)
+            parsed_json.map do |rate|
+              ["valid", "has_warnings", "unknown"].include? rate['validation_status']
+            end.any?
+          end
+
           def get_amounts(rate_hash)
             [:shipping, :other, :insurance, :confirmation].map do |name|
               currency = Money::Currency.new(rate_hash["#{name}_amount"]["currency"])

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