friendly_shipping 0.5.2 → 0.6.3

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

@@ -8,18 +8,18 @@ module FriendlyShipping
         ERROR_TAG = 'Error'
 
         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? || ![expected_root_tag, 'Error'].include?(xml.root.name)
-              Failure('Invalid document')
+              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
@@ -33,6 +33,16 @@ module FriendlyShipping
             desc = xml.xpath('//Error/Description')&.text
             [number, desc].select(&:present?).join(': ').presence&.strip || 'USPS 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/usps/rate_estimate_package_options.rb

@@ -49,11 +49,13 @@ module FriendlyShipping
         def service_code
           return 'ALL' unless shipping_method
 
-          if commercial_pricing
-            "#{shipping_method.service_code} COMMERCIAL"
-          else
-            shipping_method.service_code
-          end
+          # Cubic shipping methods don't have HFP or COMMERCIAL modifiers
+          return shipping_method.service_code if shipping_method.service_code =~ /CUBIC/
+
+          service_code = [shipping_method.service_code]
+          service_code << 'HFP' if hold_for_pickup
+          service_code << 'COMMERCIAL' if commercial_pricing
+          service_code.join(' ')
         end
       end
     end

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

@@ -29,22 +29,33 @@ module FriendlyShipping
         package_service_retail: 'PACKAGE SERVICE RETAIL'
       }.freeze
 
+      CLASS_IDS = {
+        priority_mail_express: {
+          standard: '3',
+          hold_for_pickup: '2',
+          sunday_holiday_delivery: '23'
+        },
+        priority_mail_cubic: '999'
+      }.freeze
+
       SHIPPING_METHODS = [
-        'First-Class',
-        'Package Services',
-        'Priority',
-        'Priority Mail Express',
-        'Standard Post',
-        'Retail Ground',
-        'Media Mail',
-        'Library Mail',
-      ].map do |shipping_method_name|
+        ['FIRST CLASS', 'First-Class'],
+        ['PACKAGE SERVICES', 'Package Services'],
+        ['PRIORITY', 'Priority Mail'],
+        ['PRIORITY MAIL EXPRESS', 'Priority Mail Express', CLASS_IDS[:priority_mail_express].values],
+        ['PRIORITY MAIL CUBIC', 'Priority Mail Cubic', CLASS_IDS[:priority_mail_cubic]],
+        ['STANDARD POST', 'Standard Post'],
+        ['RETAIL GROUND', 'Retail Ground'],
+        ['MEDIA MAIL', 'Media Mail'],
+        ['LIBRARY MAIL', 'Library Mail'],
+      ].map do |code, name, class_ids|
         FriendlyShipping::ShippingMethod.new(
           origin_countries: [Carmen::Country.coded('US')],
-          name: shipping_method_name,
-          service_code: shipping_method_name.tr('-', ' ').upcase,
+          name: name,
+          service_code: code,
           domestic: true,
-          international: false
+          international: false,
+          data: { class_ids: class_ids }
         )
       end.freeze
     end

data/lib/friendly_shipping/shipping_method.rb

@@ -2,7 +2,7 @@
 
 module FriendlyShipping
   class ShippingMethod
-    attr_reader :name, :service_code, :carrier, :origin_countries
+    attr_reader :name, :service_code, :carrier, :origin_countries, :data
 
     # @param [String] name The shipping method's name
     # @param [String] service_code The shipping method's service code
@@ -11,6 +11,7 @@ module FriendlyShipping
     # @param [Boolean] multi_package Whether this is a multi-package shipping method
     # @param [FriendlyShipping::Carrier] carrier This shipping method's carrier
     # @param [Array] origin_countries Countries this shipping method ships from
+    # @param [Hash] data Additional carrier-specific data for this shipping method
     def initialize(
       name: nil,
       service_code: nil,
@@ -18,7 +19,8 @@ module FriendlyShipping
       international: nil,
       multi_package: nil,
       carrier: nil,
-      origin_countries: []
+      origin_countries: [],
+      data: {}
     )
       @name = name
       @service_code = service_code
@@ -27,6 +29,7 @@ module FriendlyShipping
       @multi_package = multi_package
       @carrier = carrier
       @origin_countries = origin_countries
+      @data = data
     end
 
     def domestic?

data/lib/friendly_shipping/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
@@ -42,34 +42,37 @@ dependencies:
   name: money
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: physical
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4
@@ -77,6 +80,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4
@@ -100,28 +106,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -140,30 +152,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -198,56 +210,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.80'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.80'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
 description: Allows you to quote or ship a Physical::Shipment object
 email:
 - mamhoff@gmail.com
@@ -326,14 +344,31 @@ files:
 - lib/friendly_shipping/services/ups/timing_options.rb
 - lib/friendly_shipping/services/ups_freight.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
+- lib/friendly_shipping/services/ups_freight/generate_email_options_hash.rb
 - lib/friendly_shipping/services/ups_freight/generate_freight_rate_request_hash.rb
+- lib/friendly_shipping/services/ups_freight/generate_freight_ship_request_hash.rb
 - lib/friendly_shipping/services/ups_freight/generate_location_hash.rb
-- lib/friendly_shipping/services/ups_freight/generate_ups_security_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/label_delivery_options.rb
+- lib/friendly_shipping/services/ups_freight/label_document_options.rb
+- lib/friendly_shipping/services/ups_freight/label_email_options.rb
+- lib/friendly_shipping/services/ups_freight/label_item_options.rb
+- lib/friendly_shipping/services/ups_freight/label_options.rb
+- lib/friendly_shipping/services/ups_freight/label_package_options.rb
+- lib/friendly_shipping/services/ups_freight/label_pickup_options.rb
+- lib/friendly_shipping/services/ups_freight/parse_freight_label_response.rb
 - lib/friendly_shipping/services/ups_freight/parse_freight_rate_response.rb
-- lib/friendly_shipping/services/ups_freight/parse_json_response.rb
+- lib/friendly_shipping/services/ups_freight/parse_shipment_document.rb
+- lib/friendly_shipping/services/ups_freight/pickup_request_options.rb
 - 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
 - lib/friendly_shipping/services/usps.rb
 - lib/friendly_shipping/services/usps/choose_package_rate.rb
@@ -357,7 +392,7 @@ files:
 - lib/friendly_shipping/timing.rb
 - lib/friendly_shipping/types.rb
 - lib/friendly_shipping/version.rb
-homepage: https://github.com/friendly_cart/friendly_shipping
+homepage: https://github.com/friendlycart/friendly_shipping
 licenses:
 - MIT
 metadata: {}
@@ -376,7 +411,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An integration layer for shipping services

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class UpsFreight
-      class GenerateUpsSecurityHash
-        def self.call(login:, password:, key:)
-          {
-            UPSSecurity: {
-              UsernameToken: {
-                Username: login,
-                Password: password
-              },
-              ServiceAccessToken: {
-                AccessLicenseNumber: key
-              }
-            }
-          }
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module FriendlyShipping
-  module Services
-    class UpsFreight
-      class ParseJSONResponse
-        extend Dry::Monads::Result::Mixin
-
-        class << self
-          def call(response_body, expected_root_tag)
-            json = JSON.parse(response_body)
-
-            if request_successful?(json, expected_root_tag)
-              Success(json)
-            else
-              Failure(error_message(json))
-            end
-          rescue JSON::ParserError => e
-            Failure(e)
-          end
-
-          private
-
-          def request_successful?(json, expected_root_tag)
-            json[expected_root_tag].present?
-          end
-
-          def error_message(json)
-            detailed_error = json.dig('Fault', 'detail', 'Errors', 'ErrorDetail', 'PrimaryErrorCode')
-            status = detailed_error['Code']
-            desc = detailed_error['Description']
-            [status, desc].compact.join(": ").presence || 'UPS could not process the request.'
-          end
-        end
-      end
-    end
-  end
-end