friendly_shipping 0.7.3 → 0.8.1

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/ups/rate_estimate_package_options'
+
+module FriendlyShipping
+  module Services
+    # Options for one package when rating
+    #
+    # @param [Symbol] box_name The type of box we want to get rates for.
+    # @param [Boolean] commercial_pricing Indicate whether the response should include commercial pricing rates.
+    # @param [Boolean] commercial_plus_pricing Indicate whether the response should include commercial pluse pricing rates.
+    # @param [Symbol] container_code Indicate the type of container of the package.
+    # @param [Symbol] mail_type Indicate the type of mail to estimate rates.
+    # @param [Boolean] rectangular Indicate whether the package is rectangular.
+    # @param [FriendlyShipping::ShippingMethod] shipping_method Describe the requested shipping method.
+    # @param [Symbol] transmit_dimensions Indicate whether the request should include the package dimensionals.
+    class UspsInternational
+      class RateEstimatePackageOptions < FriendlyShipping::PackageOptions
+        attr_reader :box_name,
+                    :commercial_pricing,
+                    :commercial_plus_pricing,
+                    :container,
+                    :mail_type,
+                    :rectangular,
+                    :shipping_method,
+                    :transmit_dimensions
+
+        def initialize(**kwargs)
+          container_code = value_or_default(:container, :variable, kwargs) || :variable
+          mail_type_code = value_or_default(:mail_type, :all, kwargs) || :all
+
+          @box_name = value_or_default(:box_name, :variable, kwargs)
+          @commercial_pricing = value_or_default(:commercial_pricing, false, kwargs) ? 'Y' : 'N'
+          @commercial_plus_pricing = value_or_default(:commercial_plus_pricing, false, kwargs) ? 'Y' : 'N'
+          @container = CONTAINERS.fetch(container_code)
+          @mail_type = MAIL_TYPES.fetch(mail_type_code)
+          @rectangular = @container.eql?("ROLL") ? false : value_or_default(:rectangular, true, kwargs)
+          @shipping_method = kwargs.delete(:shipping_method)
+          @transmit_dimensions = value_or_default(:transmit_dimensions, true, kwargs)
+          super(**kwargs)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/services/usps/machinable_package'
+
+module FriendlyShipping
+  module Services
+    class UspsInternational
+      class SerializeRateRequest
+        class << self
+          # @param [Physical::Shipment] shipment The shipment we want to get rates for
+          #   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::Services::UspsInternational::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|
+              xml.IntlRateV2Request('USERID' => login) do
+                xml.Revision("2")
+                shipment.packages.each_with_index do |package, index|
+                  xml.Package('ID' => index) do
+                    xml.Pounds(pounds_for(package))
+                    xml.Ounces(ounces_for(package))
+                    xml.Machinable(machinable(package))
+                    package_options = options.options_for_package(package)
+                    xml.MailType(package_options.mail_type)
+                    xml.ValueOfContents(package.items_value)
+                    xml.Country(shipment.destination.country)
+                    xml.Container(package_options.container)
+                    if package_options.transmit_dimensions && package_options.container == 'VARIABLE'
+                      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 })
+
+                      # 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
+                      xml.CommercialFlag(package_options.commercial_pricing)
+                      xml.CommercialPlusFlag(package_options.commercial_plus_pricing)
+                    end
+                  end
+                end
+              end
+            end
+            xml_builder.to_xml
+          end
+
+          private
+
+          def machinable(package)
+            FriendlyShipping::Services::Usps::MachinablePackage.new(package).machinable? ? 'true' : 'false'
+          end
+
+          def ounces_for(package)
+            ounces = (package.weight.convert_to(:ounces).value.to_f % 16).round(2).ceil
+            ounces == 16 ? 15.999 : [ounces, 1].max
+          end
+
+          def pounds_for(package)
+            package.weight.convert_to(:pounds).value.to_f.floor
+          end
+
+          def girth(package)
+            width, length = package.dimensions.sort.first(2)
+            (width.scale(2) + length.scale(2)).convert_to(:inches).value.to_f
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class UspsInternational
+      SHIPPING_METHODS = [
+        ["1", "Priority Mail Express International"],
+        ["2", "Priority Mail International"],
+        ["4", "Global Express Guaranteed; (GXG)"],
+        ["5", "Global Express Guaranteed; Document"],
+        ["6", "Global Express Guarantee; Non-Document Rectangular"],
+        ["7", "Global Express Guaranteed; Non-Document Non-Rectangular"],
+        ["8", "Priority Mail International; Flat Rate Envelope"],
+        ["9", "Priority Mail International; Medium Flat Rate Box"],
+        ["10", "Priority Mail Express International; Flat Rate Envelope"],
+        ["11", "Priority Mail International; Large Flat Rate Box"],
+        ["12", "USPS GXG; Envelopes"],
+        ["13", "First-Class Mail; International Letter"],
+        ["14", "First-Class Mail; International Large Envelope"],
+        ["15", "First-Class Package International Service"],
+        ["16", "Priority Mail International; Small Flat Rate Box"],
+        ["17", "Priority Mail Express International; Legal Flat Rate Envelope"],
+        ["18", "Priority Mail International; Gift Card Flat Rate Envelope"],
+        ["19", "Priority Mail International; Window Flat Rate Envelope"],
+        ["20", "Priority Mail International; Small Flat Rate Envelope"],
+        ["28", "Airmail M-Bag"]
+      ].map do |code, name|
+        FriendlyShipping::ShippingMethod.new(
+          origin_countries: [Carmen::Country.coded('US')],
+          name: name,
+          service_code: code,
+          domestic: false,
+          international: true,
+        )
+      end.freeze
+    end
+  end
+end

data/lib/friendly_shipping/services/usps_international.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'friendly_shipping/http_client'
+require 'friendly_shipping/services/usps_international/shipping_methods'
+require 'friendly_shipping/services/usps_international/serialize_rate_request'
+require 'friendly_shipping/services/usps_international/parse_rate_response'
+require 'friendly_shipping/services/usps_international/rate_estimate_options'
+
+module FriendlyShipping
+  module Services
+    class UspsInternational
+      include Dry::Monads[:result]
+
+      attr_reader :test, :login, :client
+
+      CONTAINERS = {
+        rectanglular: 'RECTANGULAR',
+        roll: 'ROLL',
+        variable: 'VARIABLE'
+      }.freeze
+
+      MAIL_TYPES = {
+        all: 'ALL',
+        airmail: 'AIRMAIL MBAG',
+        envelope: 'ENVELOPE',
+        flat_rate: 'FLATRATE',
+        letter: 'LETTER',
+        large_envelope: 'LARGEENVELOPE',
+        package: 'PACKAGE',
+        post_cards: 'POSTCARDS'
+      }.freeze
+
+      TEST_URL = 'https://stg-secure.shippingapis.com/ShippingAPI.dll'
+      LIVE_URL = 'https://secure.shippingapis.com/ShippingAPI.dll'
+
+      RESOURCES = {
+        rates: 'IntlRateV2',
+      }.freeze
+
+      def initialize(login:, test: true, client: HttpClient.new)
+        @login = login
+        @test = test
+        @client = client
+      end
+
+      # Get rate estimates from USPS International
+      #
+      # @param [Physical::Shipment] shipment
+      # @param [FriendlyShipping::Services::UspsInternational::RateEstimateOptions] options What options
+      #    to use for this rate estimate call
+      #
+      # @return [Result<Array<FriendlyShipping::Rate>>] When successfully parsing, an array of rates in a Success Monad.
+      #   When the parsing is not successful or USPS can't give us rates, a Failure monad containing something that
+      #   can be serialized into an error message using `to_s`.
+      def rate_estimates(shipment, options: RateEstimateOptions.new, debug: false)
+        rate_request_xml = SerializeRateRequest.call(shipment: shipment, login: login, options: options)
+        request = build_request(api: :rates, xml: rate_request_xml, debug: debug)
+        client.post(request).bind do |response|
+          ParseRateResponse.call(response: response, request: request, shipment: shipment, options: options)
+        end
+      end
+
+      private
+
+      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
+        )
+      end
+
+      def base_url
+        test ? TEST_URL : LIVE_URL
+      end
+    end
+  end
+end

data/lib/friendly_shipping/version.rb

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

data/lib/friendly_shipping.rb

@@ -17,9 +17,11 @@ require "friendly_shipping/api_result"
 require "friendly_shipping/api_failure"
 
 require "friendly_shipping/services/ship_engine"
+require 'friendly_shipping/services/ship_engine_ltl'
 require "friendly_shipping/services/ups"
 require "friendly_shipping/services/ups_freight"
 require "friendly_shipping/services/usps"
+require "friendly_shipping/services/usps_international"
 
 module FriendlyShipping
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.1
 platform: ruby
 authors:
 - Martin Meyerhoff
+- Matthew Bass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -255,6 +256,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".env.template"
+- ".env.test"
 - ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
@@ -286,6 +288,8 @@ files:
 - lib/friendly_shipping/services/ship_engine.rb
 - lib/friendly_shipping/services/ship_engine/bad_request.rb
 - lib/friendly_shipping/services/ship_engine/bad_request_handler.rb
+- lib/friendly_shipping/services/ship_engine/label_customs_options.rb
+- lib/friendly_shipping/services/ship_engine/label_item_options.rb
 - lib/friendly_shipping/services/ship_engine/label_options.rb
 - lib/friendly_shipping/services/ship_engine/label_package_options.rb
 - lib/friendly_shipping/services/ship_engine/parse_carrier_response.rb
@@ -295,6 +299,16 @@ files:
 - lib/friendly_shipping/services/ship_engine/rate_estimates_options.rb
 - lib/friendly_shipping/services/ship_engine/serialize_label_shipment.rb
 - lib/friendly_shipping/services/ship_engine/serialize_rate_estimate_request.rb
+- lib/friendly_shipping/services/ship_engine_ltl.rb
+- lib/friendly_shipping/services/ship_engine_ltl/bad_request.rb
+- lib/friendly_shipping/services/ship_engine_ltl/bad_request_handler.rb
+- lib/friendly_shipping/services/ship_engine_ltl/item_options.rb
+- lib/friendly_shipping/services/ship_engine_ltl/package_options.rb
+- lib/friendly_shipping/services/ship_engine_ltl/parse_carrier_response.rb
+- lib/friendly_shipping/services/ship_engine_ltl/parse_quote_response.rb
+- lib/friendly_shipping/services/ship_engine_ltl/quote_options.rb
+- lib/friendly_shipping/services/ship_engine_ltl/serialize_packages.rb
+- lib/friendly_shipping/services/ship_engine_ltl/serialize_quote_request.rb
 - lib/friendly_shipping/services/ups.rb
 - lib/friendly_shipping/services/ups/label.rb
 - lib/friendly_shipping/services/ups/label_billing_options.rb
@@ -372,6 +386,13 @@ files:
 - lib/friendly_shipping/services/usps/serialize_time_in_transit_request.rb
 - lib/friendly_shipping/services/usps/shipping_methods.rb
 - lib/friendly_shipping/services/usps/timing_options.rb
+- lib/friendly_shipping/services/usps_international.rb
+- lib/friendly_shipping/services/usps_international/parse_package_rate.rb
+- lib/friendly_shipping/services/usps_international/parse_rate_response.rb
+- lib/friendly_shipping/services/usps_international/rate_estimate_options.rb
+- lib/friendly_shipping/services/usps_international/rate_estimate_package_options.rb
+- lib/friendly_shipping/services/usps_international/serialize_rate_request.rb
+- lib/friendly_shipping/services/usps_international/shipping_methods.rb
 - lib/friendly_shipping/shipment_options.rb
 - lib/friendly_shipping/shipping_method.rb
 - lib/friendly_shipping/timing.rb
@@ -396,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: An integration layer for shipping services