freight_kit 0.1.21 → 0.1.22

data/lib/freight_kit/carriers/roadrunner_transportation_services.rb

@@ -17,11 +17,7 @@ module FreightKit
 
         def contacts
           [
-            Contact.new(
-              department: 'Dispatch - Mira Loma, CA',
-              id: 'dc14714f-e381-4b8b-97a6-f002c0897409',
-              phone: '+19513615900'
-            ),
+            Contact.new(department: 'Dispatch - Mira Loma, CA', id: 'dc14714f-e381-4b8b-97a6-f002c0897409', phone: '+19513615900'),
             Contact.new(department: 'Main', id: '22203680-060c-41db-ba65-9925e8fa381d', phone: '+14146151696')
           ]
         end
@@ -398,9 +394,7 @@ module FreightKit
       def parse_amount(amount)
         negative = amount.start_with?('-$') || amount.start_with?('-')
 
-        ['$', '-', ','].each do |char|
-          amount = amount.sub(char, '')
-        end
+        ['$', '-', ','].each { |char| amount = amount.sub(char, '') }
 
         return 0 if amount.blank?
 

data/lib/freight_kit/carriers/saia.rb

@@ -265,9 +265,7 @@ module FreightKit
                          end
 
         if declared_value.present?
-          request = request.deep_merge(
-            { request: { DeclaredValue: declared_value, FullValueCoverage: declared_value } }
-          )
+          request = request.deep_merge({ request: { DeclaredValue: declared_value, FullValueCoverage: declared_value } })
         end
 
         save_request(request)
@@ -281,12 +279,7 @@ module FreightKit
       end
 
       def commit(action, request)
-        client_args = {
-          wsdl: request_url(action),
-          convert_request_keys_to: :none,
-          env_namespace: :soap,
-          element_form_default: :qualified
-        }
+        client_args = { wsdl: request_url(action), convert_request_keys_to: :none, env_namespace: :soap, element_form_default: :qualified }
 
         call_args = { message: request_blueprint.deep_merge(request) }
 
@@ -307,11 +300,7 @@ module FreightKit
       end
 
       def parse_api_location(api_event)
-        Location.new(
-          city: api_event[:city]&.titleize,
-          province: api_event[:state]&.upcase,
-          country: ActiveUtils::Country.find('USA')
-        )
+        Location.new(city: api_event[:city]&.titleize, province: api_event[:state]&.upcase, country: ActiveUtils::Country.find('USA'))
       end
 
       def parse_rate_response(shipment:, response:)
@@ -477,11 +466,7 @@ module FreightKit
         api_events = search_result.dig(:history, :history_item)
 
         if api_events.blank?
-          shipment_events << ShipmentEvent.new(
-            date_time: pickup_date,
-            location: shipper_location,
-            type_code: :picked_up
-          )
+          shipment_events << ShipmentEvent.new(date_time: pickup_date, location: shipper_location, type_code: :picked_up)
         else
           api_events = [api_events] if api_events.is_a?(Hash)
 

data/lib/freight_kit/carriers/southeastern_freight_lines.rb

@@ -160,11 +160,7 @@ module FreightKit
         methods: { get_rate: :get, rates: :post },
         use_ssl: false
       }.freeze
-      JSON_HEADERS = {
-        Accept: 'application/json',
-        charset: 'utf-8',
-        'Content-Type' => 'application/x-www-form-urlencoded'
-      }.freeze
+      JSON_HEADERS = { Accept: 'application/json', charset: 'utf-8', 'Content-Type' => 'application/x-www-form-urlencoded' }.freeze
 
       # Documents
 
@@ -296,12 +292,7 @@ module FreightKit
         headers = headers.merge(options[:headers]) if options[:headers].present?
         body = URI.encode_www_form(options[:body]) if options[:body].present?
 
-        request = {
-          url: options[:url].presence || build_url(action),
-          headers:,
-          method: API.dig(:methods, action),
-          body:
-        }
+        request = { url: options[:url].presence || build_url(action), headers:, method: API.dig(:methods, action), body: }
 
         save_request(request)
         request
@@ -317,9 +308,9 @@ module FreightKit
 
         case method
         when :post
-          HTTPClient.post(url, headers:, body:)
+          HTTPClient.post(url, headers:, body:, proxy_url:)
         else
-          HTTPClient.get(url, headers:)
+          HTTPClient.get(url, headers:, proxy_url:)
         end
       end
 

data/lib/freight_kit/carriers/t_force_worldwide.rb

@@ -190,16 +190,7 @@ module FreightKit
         service:,
         shipment:
       )
-        request = build_pickup_request(
-          delivery_from:,
-          delivery_to:,
-          dispatcher:,
-          pickup_from:,
-          pickup_to:,
-          scac:,
-          service:,
-          shipment:
-        )
+        request = build_pickup_request(delivery_from:, delivery_to:, dispatcher:, pickup_from:, pickup_to:, scac:, service:, shipment:)
 
         parse_pickup_response(commit(request))
       end
@@ -399,9 +390,9 @@ module FreightKit
 
         case method
         when :post
-          HTTPClient.post(url, headers:, body:)
+          HTTPClient.post(url, headers:, body:, proxy_url:)
         else
-          HTTPClient.get(url, headers:)
+          HTTPClient.get(url, headers:, proxy_url:)
         end
       end
 
@@ -468,8 +459,7 @@ module FreightKit
         logout_url = 'https://rrd.mercurygate.net/MercuryGate/login/urlRedirect.jsp?Logout=true'
 
         begin
-          browser.element(xpath: '//*[@id="__AppFrameBaseTable"]/tbody/tr[2]/td/div[4]')
-                 .click
+          browser.element(xpath: '//*[@id="__AppFrameBaseTable"]/tbody/tr[2]/td/div[4]').click
         rescue Selenium::WebDriver::Error::UnexpectedAlertOpenError => e
           browser.close
 
@@ -484,8 +474,7 @@ module FreightKit
         browser.iframe(name: 'AppBody').frame(id: 'Header').select(name: 'column').select('Primary Reference')
         browser.iframe(name: 'AppBody').frame(id: 'Header').select(name: 'condition').select('=')
         browser.iframe(name: 'AppBody').frame(id: 'Header').text_field(name: 'filter').set(tracking_number)
-        browser.iframe(name: 'AppBody').frame(id: 'Header').button(value: 'Find')
-               .click
+        browser.iframe(name: 'AppBody').frame(id: 'Header').button(value: 'Find').click
 
         begin
           browser.iframe(name: 'AppBody').frame(id: 'Detail').iframe(id: 'transportsWin')
@@ -505,8 +494,7 @@ module FreightKit
           return document_response
         end
 
-        html = browser.iframe(name: 'AppBody').frame(id: 'Detail').iframes[1].element(xpath: '/html/body/table[3]')
-                      .html
+        html = browser.iframe(name: 'AppBody').frame(id: 'Detail').iframes[1].element(xpath: '/html/body/table[3]').html
         html = Nokogiri::HTML(html)
 
         browser.goto(logout_url)
@@ -529,7 +517,7 @@ module FreightKit
         end
 
         begin
-          response = HTTPClient.get(url)
+          response = HTTPClient.get(url, proxy_url:)
         rescue StandardError => e
           document_response.error = e
           return document_response

data/lib/freight_kit/carriers/total_quality_logistics.rb

@@ -214,7 +214,8 @@ module FreightKit
           request[:url],
           headers: request[:headers].merge(subscription_key_headers),
           query: request[:query],
-          body: request[:body]
+          body: request[:body],
+          proxy_url:
         )
 
         parsed_response = JSON.parse(response.body)

data/lib/freight_kit/carriers/western_regional_delivery_service.rb

@@ -70,9 +70,9 @@ module FreightKit
         url = request_url(action)
 
         response = if API.dig(:methods, action) == :post
-                     options[:params].blank? ? HTTPClient.post(url) : HTTPClient.post(url, query: options[:params])
+                     options[:params].blank? ? HTTPClient.post(url, proxy_url:) : HTTPClient.post(url, proxy_url:, query: options[:params])
                    else
-                     HTTPClient.get(url)
+                     HTTPClient.get(url, proxy_url:)
                    end
 
         response.parsed_response if response&.parsed_response
@@ -81,11 +81,7 @@ module FreightKit
       def parse_api_city_state(str)
         return if str.blank?
 
-        Location.new(
-          city: str[..-3].strip.titleize,
-          province: str[-2..].upcase,
-          country: ActiveUtils::Country.find('USA')
-        )
+        Location.new(city: str[..-3].strip.titleize, province: str[-2..].upcase, country: ActiveUtils::Country.find('USA'))
       end
 
       def parse_api_city_state_zip(str)
@@ -118,7 +114,7 @@ module FreightKit
         document_response = DocumentResponse.new(request: URI.parse(url))
 
         begin
-          response = HTTPClient.get(url)
+          response = HTTPClient.get(url, proxy_url:)
         rescue StandardError => e
           document_response.error = e
           return document_response
@@ -152,9 +148,7 @@ module FreightKit
         image_url = nil
         browser.switch_window.use do
           page_count = browser.element(xpath: '/html/body/form/div[3]/b/span').text.strip.to_i
-          (page_count - 1).times do
-            browser.element(xpath: '/html/body/form/div[3]/input[2]').wait_until(&:present?).click
-          end
+          (page_count - 1).times { browser.element(xpath: '/html/body/form/div[3]/input[2]').wait_until(&:present?).click }
           image_url = browser.element(css: '#cphMain_imgImage').attribute_value('src')
         end
         browser.close

data/lib/freight_kit/carriers/xpo_logistics.rb

@@ -17,11 +17,7 @@ module FreightKit
 
         def contacts
           [
-            Contact.new(
-              department: 'Customer Service - Kingman, AZ',
-              id: '5bb9caaa-ae84-4ee6-90ef-3c14f6d434c6',
-              phone: '+17609228255'
-            )
+            Contact.new(department: 'Customer Service - Kingman, AZ', id: '5bb9caaa-ae84-4ee6-90ef-3c14f6d434c6', phone: '+17609228255')
           ]
         end
 
@@ -159,11 +155,7 @@ module FreightKit
         def website_url = 'https://www.xpo.com'
       end
 
-      API = {
-        domain: 'api.ltl.xpo.com',
-        endpoints: { rates: '/rating/1.0/ratequotes', token: '/token' },
-        use_ssl: true
-      }.freeze
+      API = { domain: 'api.ltl.xpo.com', endpoints: { rates: '/rating/1.0/ratequotes', token: '/token' }, use_ssl: true }.freeze
 
       # Documents
 
@@ -223,11 +215,7 @@ module FreightKit
       def build_bearer_token_request
         api_credentials = fetch_credential(:api)
 
-        body = URI.encode_www_form(
-          grant_type: 'password',
-          password: api_credentials.password,
-          username: api_credentials.username
-        )
+        body = URI.encode_www_form(grant_type: 'password', password: api_credentials.password, username: api_credentials.username)
 
         {
           body:,
@@ -301,9 +289,9 @@ module FreightKit
 
         response = case method
                    when :post
-                     HTTPClient.post(url, headers:, body:)
+                     HTTPClient.post(url, headers:, body:, proxy_url:)
                    else
-                     HTTPClient.get(url, headers:)
+                     HTTPClient.get(url, headers:, proxy_url:)
                    end
 
         begin

data/lib/freight_kit/errors/rate_limit_error.rb

@@ -0,0 +1,12 @@
+module FreightKit
+  # The API refused a request because the caller sent too many. Wait {#retry_after} seconds before the next one.
+  class RateLimitError < HTTPError
+    attr_reader :retry_after
+
+    def initialize(body:, code:, retry_after: nil)
+      @retry_after = retry_after
+
+      super(body:, code:)
+    end
+  end
+end

data/lib/freight_kit/errors/unserviceable_accessorials_error.rb

@@ -9,9 +9,7 @@ module FreightKit
     end
 
     def message
-      @message ||= "Unable to service #{@accessorials.map do |accessorial|
-                                          accessorial.to_s.gsub('_', ' ')
-                                        end.join(', ')}"
+      @message ||= "Unable to service #{@accessorials.map { |accessorial| accessorial.to_s.gsub('_', ' ') }.join(', ')}"
     end
   end
 end

data/lib/freight_kit/helpers/pickupable.rb

@@ -10,16 +10,7 @@ module FreightKit
       service:,
       shipment:
     )
-      request = build_pickup_request(
-        delivery_from:,
-        delivery_to:,
-        dispatcher:,
-        pickup_from:,
-        pickup_to:,
-        scac:,
-        service:,
-        shipment:
-      )
+      request = build_pickup_request(delivery_from:, delivery_to:, dispatcher:, pickup_from:, pickup_to:, scac:, service:, shipment:)
 
       begin
         # For SOAP APIs, the :action parameter is required

data/lib/freight_kit/http_client/httpi_adapter.rb

@@ -0,0 +1,37 @@
+module FreightKit
+  class HTTPClient
+    # HTTPI adapter sending Savon's requests through {HTTPClient}, so SOAP calls get its compression,
+    # connection reuse, retries, cache, logger and User-Agent:
+    #
+    #   Savon.client(adapter: FreightKit::HTTPClient::HTTPIAdapter::NAME, wsdl: url)
+    class HTTPIAdapter < HTTPI::Adapter::Base
+      NAME = :freight_kit
+
+      register NAME
+
+      attr_reader :client
+
+      def initialize(request)
+        super
+        raise HTTPI::NotSupportedError, "#{NAME} does not support #{request.auth.type} authentication" if request.auth.type
+
+        @client = HTTPClient
+        @request = request
+      end
+
+      def request(method)
+        response = client.request(
+          method,
+          @request.url.to_s,
+          body: @request.body,
+          headers: @request.headers.to_h,
+          proxy_url: @request.proxy&.to_s,
+          read_timeout: @request.read_timeout
+        )
+
+        # HTTPX already decoded the body, and HTTPI would gunzip it again
+        HTTPI::Response.new(response.code, response.headers.to_h.except('content-encoding'), response.body)
+      end
+    end
+  end
+end

data/lib/freight_kit/http_client/safe_retries.rb

@@ -6,13 +6,29 @@ module FreightKit
     # The persistent plugin retries any request failing with a connection error, but a POST may
     # already have been processed by then, so only idempotent requests are retried.
     # Streams refused by an HTTP/2 GOAWAY are resent by HTTPX itself, independently of retries.
+    #
+    # A 429 means the server did not process the request, so any request is retried once after its
+    # Retry-After seconds, unless that is longer than {MAX_RETRY_AFTER}.
     module SafeRetries
       IDEMPOTENT_METHODS = ['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PUT'].freeze
+      # Longest wait in seconds. Longer waits return the 429, so callers can reschedule instead of blocking.
+      MAX_RETRY_AFTER = 60
 
       module InstanceMethods
         private
 
-        def retryable_request?(request, *) = super && IDEMPOTENT_METHODS.include?(request.verb)
+        def rate_limited?(response)
+          response.is_a?(HTTPX::Response) && response.status == 429 && retry_after(response)&.between?(0, MAX_RETRY_AFTER)
+        end
+
+        def retry_after(response) = Integer(response.headers['retry-after'], 10, exception: false)
+
+        def retryable_request?(request, response, *)
+          rate_limited?(response) || (super && IDEMPOTENT_METHODS.include?(request.verb))
+        end
+
+        def retryable_response?(response, *) = super || rate_limited?(response)
+        def when_to_retry(request, response, *) = rate_limited?(response) ? retry_after(response) : super
       end
 
       class << self

data/lib/freight_kit/http_client.rb

@@ -2,7 +2,7 @@ module FreightKit
   # Thin wrapper around HTTPX that negotiates Brotli/Zstandard compression, keeps connections
   # open between requests and revalidates cached responses with conditional requests (ETag/Last-Modified).
   #
-  # The cache and logger are hookable; they default to the host Rails/Hanami app's logger:
+  # The cache defaults to {FreightKit.cache}, and the logger to the host Rails/Hanami app's logger. Both are hookable:
   #
   #   FreightKit::HTTPClient.cache = Rails.cache
   #   FreightKit::HTTPClient.logger = Rails.logger
@@ -12,11 +12,11 @@ module FreightKit
     @sessions = Concurrent::Map.new
 
     class << self
-      def cache = @cache ||= ActiveSupport::Cache::MemoryStore.new
+      def cache = @cache || FreightKit.cache
 
       def cache=(store)
         @cache = store
-        @sessions.clear
+        reset
       end
 
       def get(url, **) = request(:get, url, **)
@@ -24,14 +24,15 @@ module FreightKit
 
       def logger=(logger)
         @logger = logger
-        @sessions.clear
+        reset
       end
 
       def post(url, **) = request(:post, url, **)
 
-      def request(verb, url, body: nil, headers: {}, proxy: nil, query: nil)
+      def request(verb, url, body: nil, headers: {}, proxy_url: nil, query: nil, read_timeout: nil)
         options = { headers: }
         options[:params] = query if query.present?
+        options[:timeout] = { read_timeout: } if read_timeout
 
         # Like HTTParty, hashes are form-encoded regardless of the Content-Type header
         if body.is_a?(Hash)
@@ -40,12 +41,15 @@ module FreightKit
           options[:body] = body
         end
 
-        response = session(proxy.presence).request(verb.to_s.upcase, url, **options)
+        response = session(proxy_url.presence).request(verb.to_s.upcase, url, **options)
         raise response.error if response.is_a?(HTTPX::ErrorResponse)
 
         Response.new(response)
       end
 
+      # Rebuilds sessions on their next request, e.g. after the cache or logger changes.
+      def reset = @sessions.clear
+
       private
 
       def framework_logger
@@ -57,8 +61,8 @@ module FreightKit
       end
 
       # Sessions own their connection pool, so they are built once (per proxy) and reused
-      def session(proxy)
-        @sessions.compute_if_absent(proxy) do
+      def session(proxy_url)
+        @sessions.compute_if_absent(proxy_url) do
           session = HTTPX.plugin(:brotli).plugin(Zstd).plugin(:follow_redirects)
                          .plugin(:response_cache, response_cache_store: CacheStore.new(cache))
                          .plugin(Revalidation)
@@ -68,7 +72,7 @@ module FreightKit
           logger = self.logger
           session = session.with(debug: LogDevice.new(logger), debug_level: 2) if logger.level <= ::Logger::DEBUG
 
-          proxy ? session.plugin(:proxy).with(proxy: { uri: proxy }) : session
+          proxy_url ? session.plugin(:proxy).with(proxy: { uri: proxy_url }) : session
         end
       end
     end

data/lib/freight_kit/models/credential.rb

@@ -51,7 +51,7 @@ module FreightKit
                      when :api, :website
                        { password: String }
                      when :api_proxy
-                       { api_key: String, proxy_url: String }
+                       { proxy_url: String }
                      when :oauth2
                        { access_token: String, expires_at: ::DateTime, scope: String }
                      when :selenoid
@@ -96,20 +96,7 @@ module FreightKit
       url.path = '/wd/hub/'
       url = url.to_s
 
-      @watir_args = [
-        browser,
-        {
-          options: {
-            prefs: {
-              download: {
-                directory_upgrade: true,
-                prompt_for_download: false
-              }
-            }
-          },
-          url:
-        }
-      ]
+      @watir_args = [browser, { options: { prefs: { download: { directory_upgrade: true, prompt_for_download: false } } }, url: }]
     end
   end
 end

data/lib/freight_kit/models/shipment.rb

@@ -11,14 +11,7 @@ module FreightKit
   # @!attribute po_number [String] Purchase order number (also known as PO #).
   # @!attribute pickup_at [FreightKit::DateTime] Pickup date/time.
   class Shipment < Model
-    attr_accessor :accessorials,
-                  :declared_value_cents,
-                  :destination,
-                  :origin,
-                  :order_number,
-                  :packages,
-                  :po_number,
-                  :pro
+    attr_accessor :accessorials, :declared_value_cents, :destination, :origin, :order_number, :packages, :po_number, :pro
     attr_reader :pickup_at
 
     def hazmat?

data/lib/freight_kit/package.rb

@@ -64,13 +64,7 @@ module FreightKit # :nodoc:
 
       @quantity = options[:quantity] || 1
 
-      @total_weight = attribute_from_metric_or_imperial(
-        total_grams_or_ounces,
-        Measured::Weight,
-        @weight_unit_system,
-        :grams,
-        :ounces
-      )
+      @total_weight = attribute_from_metric_or_imperial(total_grams_or_ounces, Measured::Weight, @weight_unit_system, :grams, :ounces)
 
       @each_weight = attribute_from_metric_or_imperial(
         total_grams_or_ounces / @quantity.to_f,
@@ -91,9 +85,7 @@ module FreightKit # :nodoc:
         @dimensions = @dimensions.map do |l|
           attribute_from_metric_or_imperial(l, Measured::Length, @dimensions_unit_system, :centimetres, :inches)
         end
-        2.downto(@dimensions.length) do |_n|
-          @dimensions.unshift(@dimensions[0])
-        end
+        2.downto(@dimensions.length) { |_n| @dimensions.unshift(@dimensions[0]) }
       end
 
       @value = Package.cents_from(options[:value])
@@ -274,9 +266,7 @@ module FreightKit # :nodoc:
       # [1,2] => [1,1,2]
       # [5] => [5,5,5]
       # etc..
-      2.downto(@dimensions.length) do |_n|
-        @dimensions.unshift(@dimensions[0])
-      end
+      2.downto(@dimensions.length) { |_n| @dimensions.unshift(@dimensions[0]) }
     end
 
     def sanitized_freight_class(freight_class)

data/lib/freight_kit/packaging.rb

@@ -1,22 +1,7 @@
 module FreightKit
   class Packaging
     PALLET_TYPES = %i[crate drum pallet tote].freeze
-    VALID_TYPES = %i[
-      box
-      bundle
-      container
-      crate
-      cylinder
-      drum
-      luggage
-      pail
-      pallet
-      piece
-      roll
-      tote
-      truckload
-      tote
-    ].freeze
+    VALID_TYPES = %i[box bundle container crate cylinder drum luggage pail pallet piece roll tote truckload tote].freeze
 
     attr_accessor :type
 

data/lib/freight_kit/platforms/carrier_logistics.rb

@@ -114,14 +114,13 @@ module FreightKit
         url = build_url(action, query:)
         save_request(url)
 
-        HTTPClient.get(url)
+        HTTPClient.get(url, proxy_url:)
       end
 
       def map_response_errors(response, not_found_error: DocumentNotFoundError)
         return ResponseError.new('Unknown response') if response.blank?
 
-        webspeed_error = (response.is_a?(String) || response.is_a?(HTTPClient::Response)) &&
-                         response.include?('WebSpeed error')
+        webspeed_error = (response.is_a?(String) || response.is_a?(HTTPClient::Response)) && response.include?('WebSpeed error')
         return ResponseError.new('Temporary error (WebSpeed error)') if webspeed_error
 
         return if response.code == 200
@@ -132,9 +131,7 @@ module FreightKit
       def parse_amount(amount)
         negative = amount.include?('-')
 
-        ['$', ',', '-'].each do |char|
-          amount = amount.sub(char, '')
-        end
+        ['$', ',', '-'].each { |char| amount = amount.sub(char, '') }
 
         return 0 if amount.blank?
 
@@ -220,7 +217,7 @@ module FreightKit
         end
 
         begin
-          response = HTTPClient.get(url)
+          response = HTTPClient.get(url, proxy_url:)
         rescue StandardError => e
           document_response.error = e
           return document_response
@@ -283,9 +280,7 @@ module FreightKit
         if self.class.overlength_fees_require_tariff?
           cents = 0
 
-          shipment.packages.each do |package|
-            cents += overlength_fee(tariff, package)
-          end
+          shipment.packages.each { |package| cents += overlength_fee(tariff, package) }
 
           prices << Price.new(blame: :tariff, cents:, description: 'Overlength fees') if cents.nonzero?
         end