friendly_shipping 0.5 → 0.6.1

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

@@ -15,7 +15,11 @@ module FriendlyShipping
           # @return [Result<ApiResult<Array<FriendlyShipping::Timing>>>] When successfully parsing, an array of timings in a Success Monad.
           def call(request:, response:)
             # Filter out error responses and directly return a failure
-            parsing_result = ParseXMLResponse.call(response.body, 'SDCGetLocationsResponse')
+            parsing_result = ParseXMLResponse.call(
+              request: request,
+              response: response,
+              expected_root_tag: 'SDCGetLocationsResponse'
+            )
             parsing_result.fmap do |xml|
               expedited_commitments = xml.xpath('//Expedited')
               expedited_timings = parse_expedited_commitment_nodes(expedited_commitments)
@@ -113,7 +117,7 @@ module FriendlyShipping
             '1' => 'Priority Mail Express',
             '2' => 'Priority',
             '3' => 'First-Class',
-            '6' => 'First-Class Package Service'
+            '6' => 'Package Services'
           }.freeze
 
           # This code carries a few details about the shipment:

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

@@ -8,7 +8,7 @@ module FriendlyShipping
     #
     # Context: The shipment object we're trying to get results for
     # USPS returns rates on a package-by-package basis, so the options for obtaining rates are
-    # set on the [FriendlyShipping/RateEstimateobect] hash. The possible options are:
+    # set on the [FriendlyShipping/RateEstimateObject] hash. The possible options are:
 
     # @param [Physical::ShippingMethod] shipping_method The shipping method ("service" in USPS parlance) we want
     #   to get rates for.

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

@@ -15,7 +15,8 @@ module FriendlyShipping
                     :first_class_mail_type,
                     :hold_for_pickup,
                     :shipping_method,
-                    :transmit_dimensions
+                    :transmit_dimensions,
+                    :rectangular
 
         def initialize(
           box_name: :variable,
@@ -24,6 +25,7 @@ module FriendlyShipping
           hold_for_pickup: false,
           shipping_method: nil,
           transmit_dimensions: true,
+          rectangular: true,
           **kwargs
         )
           @box_name = CONTAINERS.key?(box_name) ? box_name : :variable
@@ -32,6 +34,7 @@ module FriendlyShipping
           @hold_for_pickup = hold_for_pickup
           @shipping_method = shipping_method
           @transmit_dimensions = transmit_dimensions
+          @rectangular = rectangular
           super kwargs
         end
 

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

@@ -10,11 +10,11 @@ module FriendlyShipping
 
         class << self
           # @param [Physical::Shipment] shipment The shipment we want to get rates for
-          #   shipment.packages[0].properties[:box_name] Can be :rectangular, :variable,
-          #     or a flat rate container defined in CONTAINERS.
+          #   shipment.packages[0].properties[:box_name] Can be :variable or a
+          #     flat rate container defined in CONTAINERS.
           # @param [String] login The USPS login code
-          # @param [FriendlyShipping::ShippingMethod] shipping_method The shipping method we want to get rates
-          #   for. If empty, we get all of them
+          # @param [FriendlyShipping::Services::Usps::RateEstimateOptions] options The options
+          #   object to use with this request.
           # @return Array<[FriendlyShipping::Rate]> A set of Rates that this package may be sent with
           def call(shipment:, login:, options:)
             xml_builder = Nokogiri::XML::Builder.new do |xml|
@@ -37,7 +37,13 @@ module FriendlyShipping
                       xml.Width("%<width>0.2f" % { width: package.width.convert_to(:inches).value.to_f })
                       xml.Length("%<length>0.2f" % { length: package.length.convert_to(:inches).value.to_f })
                       xml.Height("%<height>0.2f" % { height: package.height.convert_to(:inches).value.to_f })
-                      xml.Girth("%<girth>0.2f" % { girth: girth(package) })
+
+                      # When girth is present, the package is treated as non-rectangular
+                      # when calculating dimensional weight. This results in a smaller
+                      # dimensional weight than a rectangular package would have.
+                      unless package_options.rectangular
+                        xml.Girth("%<girth>0.2f" % { girth: girth(package) })
+                      end
                     end
                     xml.Machinable(machinable(package))
                   end

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

@@ -5,7 +5,6 @@ module FriendlyShipping
     class Usps
       CONTAINERS = {
         variable: 'VARIABLE',
-        rectangular: 'RECTANGULAR',
         large_flat_rate_box: 'LG FLAT RATE BOX',
         medium_flat_rate_box: 'MD FLAT RATE BOX',
         small_flat_rate_box: 'SM FLAT RATE BOX',
@@ -18,7 +17,7 @@ module FriendlyShipping
         window_flat_rate_envelope: 'WINDOW FLAT RATE ENVELOPE',
         small_flat_rate_envelope: 'SM FLAT RATE ENVELOPE',
         cubic_soft_pack: 'CUBIC SOFT PACK',
-        cubic_parcels: 'CUBIC_PARCELS'
+        cubic_parcels: 'CUBIC PARCELS'
       }.freeze
 
       FIRST_CLASS_MAIL_TYPES = {
@@ -26,12 +25,13 @@ module FriendlyShipping
         flat: 'FLAT',
         parcel: 'PARCEL',
         post_card: 'POSTCARD',
-        package_service: 'PACKAGESERVICE'
+        package_service: 'PACKAGE SERVICE',
+        package_service_retail: 'PACKAGE SERVICE RETAIL'
       }.freeze
 
       SHIPPING_METHODS = [
         'First-Class',
-        'First-Class Package Service',
+        'Package Services',
         'Priority',
         'Priority Mail Express',
         'Standard Post',

data/lib/friendly_shipping/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.6.1
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-06-04 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: {}

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