freight_kit 0.1.20 → 0.1.22

data/lib/freight_kit/carriers.rb

@@ -1,49 +1,346 @@
-# frozen_string_literal: true
-
 module FreightKit
   module Carriers
-    extend self
-
-    attr_reader :registered
+    module_function
 
     @registered = []
 
-    def register(class_name)
-      registered << class_name
-    end
-
-    def all
-      FreightKit::Carriers.registered.map { |name| FreightKit.const_get(name) }
-    end
+    def all = registered.map { |name| const_get(name) }
 
     def find(name)
       all.find { |c| c.name.downcase == name.to_s.downcase } or raise NameError, "unknown carrier #{name}"
     end
+
+    def find_by(**attributes)
+      all.find { |carrier| attributes.all? { |key, value| carrier.public_send(key) == value } }
+    end
+
+    def register(class_name) = registered << class_name
+    def registered = @registered
   end
 end
 
-FreightKit::Carriers.register(:ABFS)
-FreightKit::Carriers.register(:BTVP)
-FreightKit::Carriers.register(:CCYQ)
-FreightKit::Carriers.register(:CLNI)
-FreightKit::Carriers.register(:CNWY)
-FreightKit::Carriers.register(:DLDS)
-FreightKit::Carriers.register(:DPHE)
-FreightKit::Carriers.register(:DRRQ)
-FreightKit::Carriers.register(:FWDA)
-FreightKit::Carriers.register(:MTVL)
-FreightKit::Carriers.register(:NUMK)
-FreightKit::Carriers.register(:OTCL)
-FreightKit::Carriers.register(:PENS)
-FreightKit::Carriers.register(:RDFS)
-FreightKit::Carriers.register(:SAIA)
-FreightKit::Carriers.register(:SEFL)
-FreightKit::Carriers.register(:TQYL)
-FreightKit::Carriers.register(:WRDS)
+FreightKit::Carriers.register(:ABFFreightSystem)
+FreightKit::Carriers.register(:BestOverniteExpress)
+FreightKit::Carriers.register(:CrossCountryFreightSolutions)
+FreightKit::Carriers.register(:ClearLaneFreightSystems)
+FreightKit::Carriers.register(:XPOLogistics)
+FreightKit::Carriers.register(:DiamondLineDelivery)
+FreightKit::Carriers.register(:DependableHighwayExpress)
+FreightKit::Carriers.register(:TForceWorldwide)
+FreightKit::Carriers.register(:ForwardAir)
+FreightKit::Carriers.register(:GLSFreight)
+FreightKit::Carriers.register(:NumarkTransportation)
+FreightKit::Carriers.register(:OnTrac)
+FreightKit::Carriers.register(:PeninsulaTruckLines)
+FreightKit::Carriers.register(:RoadrunnerTransportationServices)
+FreightKit::Carriers.register(:Saia)
+FreightKit::Carriers.register(:SoutheasternFreightLines)
+FreightKit::Carriers.register(:TotalQualityLogistics)
+FreightKit::Carriers.register(:WesternRegionalDeliveryService)
 
 # Based on Platform
-FreightKit::Carriers.register(:CTBV)
-FreightKit::Carriers.register(:DCHA)
+FreightKit::Carriers.register(:TheCustomCompanies)
+FreightKit::Carriers.register(:MountainValleyExpress)
 FreightKit::Carriers.register(:JFJTransportation)
-FreightKit::Carriers.register(:FCSY)
-FreightKit::Carriers.register(:TOTL)
+FreightKit::Carriers.register(:STG)
+FreightKit::Carriers.register(:TotalTransportation)
+
+# Without an API
+FreightKit::Carriers.register(:AAAExpeditedServices)
+FreightKit::Carriers.register(:AAACooper)
+FreightKit::Carriers.register(:ABBrothersUSAInc)
+FreightKit::Carriers.register(:AberdeenExpressInc)
+FreightKit::Carriers.register(:A1Express)
+FreightKit::Carriers.register(:ArcherCargo)
+FreightKit::Carriers.register(:AverittExpress)
+FreightKit::Carriers.register(:AccessTransport)
+FreightKit::Carriers.register(:ActionExpress)
+FreightKit::Carriers.register(:AdamsAndCompanies)
+FreightKit::Carriers.register(:AdvanceDistribution)
+FreightKit::Carriers.register(:AlconTransport)
+FreightKit::Carriers.register(:AllFreight)
+FreightKit::Carriers.register(:AllianceTransportationGroup)
+FreightKit::Carriers.register(:AllstateTransport)
+FreightKit::Carriers.register(:AmadoTrucking)
+FreightKit::Carriers.register(:AmericanFastFreight)
+FreightKit::Carriers.register(:AmigosServiceTransportation)
+FreightKit::Carriers.register(:AndersonTowingAndTransport)
+FreightKit::Carriers.register(:ApexTransporting)
+FreightKit::Carriers.register(:ArmstrongTransportGroup)
+FreightKit::Carriers.register(:AutobahnLogistics)
+FreightKit::Carriers.register(:BATransportation)
+FreightKit::Carriers.register(:BenjaminBestFreightInc)
+FreightKit::Carriers.register(:BcFreightways)
+FreightKit::Carriers.register(:BalkinExpress)
+FreightKit::Carriers.register(:BayAreaExpress)
+FreightKit::Carriers.register(:BennettTrucking)
+FreightKit::Carriers.register(:BestTrucking)
+FreightKit::Carriers.register(:BestwayTransport)
+FreightKit::Carriers.register(:BryanSystems)
+FreightKit::Carriers.register(:CAndWExpress)
+FreightKit::Carriers.register(:CDCTransport)
+FreightKit::Carriers.register(:CDOExpressDiversified)
+FreightKit::Carriers.register(:CentralFreightLines)
+FreightKit::Carriers.register(:CustomGlobalLogistics)
+FreightKit::Carriers.register(:CMSDomestic)
+FreightKit::Carriers.register(:CNDLogistics)
+FreightKit::Carriers.register(:CPLExpress)
+FreightKit::Carriers.register(:CSATransportation)
+FreightKit::Carriers.register(:ChicagoSuburbanExpress)
+FreightKit::Carriers.register(:CSXTransportation)
+FreightKit::Carriers.register(:CentralTransport)
+FreightKit::Carriers.register(:CampbellTrucking)
+FreightKit::Carriers.register(:CardeTransportation)
+FreightKit::Carriers.register(:CardinalLogistics)
+FreightKit::Carriers.register(:CedarSupplyTrucking)
+FreightKit::Carriers.register(:CityLogistics)
+FreightKit::Carriers.register(:CleopatraTrucking)
+FreightKit::Carriers.register(:CliffordTransportation)
+FreightKit::Carriers.register(:CoastToCoastTransport)
+FreightKit::Carriers.register(:CountrywideCarriers)
+FreightKit::Carriers.register(:CrosbyTruckingService)
+FreightKit::Carriers.register(:Crowley)
+FreightKit::Carriers.register(:DaytonFreightLines)
+FreightKit::Carriers.register(:DAKTransport)
+FreightKit::Carriers.register(:DAndATransport)
+FreightKit::Carriers.register(:DBRLogistics)
+FreightKit::Carriers.register(:DHL)
+FreightKit::Carriers.register(:DohrnTransferCompany)
+FreightKit::Carriers.register(:DotLineTransportation)
+FreightKit::Carriers.register(:DRTTransportation)
+FreightKit::Carriers.register(:DuganTruckLine)
+FreightKit::Carriers.register(:DaylightTransport)
+FreightKit::Carriers.register(:DashCourierAndLogisticsNorthCarolina)
+FreightKit::Carriers.register(:DeepSouthFreight)
+FreightKit::Carriers.register(:DeltaExpress)
+FreightKit::Carriers.register(:DeltaTransport)
+FreightKit::Carriers.register(:DeltaTruckingLogistics)
+FreightKit::Carriers.register(:DemcoExpress)
+FreightKit::Carriers.register(:DependableGlobalExpress)
+FreightKit::Carriers.register(:DesertCoastalTransport)
+FreightKit::Carriers.register(:DingTaiTrucking)
+FreightKit::Carriers.register(:DiversifiedTransferAndStorage)
+FreightKit::Carriers.register(:Dupont)
+FreightKit::Carriers.register(:Express2000Inc)
+FreightKit::Carriers.register(:ERATransport)
+FreightKit::Carriers.register(:ETransportCarriers)
+FreightKit::Carriers.register(:EWRiversideTrucking)
+FreightKit::Carriers.register(:EstesExpressLines)
+FreightKit::Carriers.register(:EchoGlobalLogistics)
+FreightKit::Carriers.register(:EcklundLogistics)
+FreightKit::Carriers.register(:ElEmplumadoTransport)
+FreightKit::Carriers.register(:EliteCarriers)
+FreightKit::Carriers.register(:EmeraldExpress)
+FreightKit::Carriers.register(:EuroKam)
+FreightKit::Carriers.register(:ExpressServicesInternational)
+FreightKit::Carriers.register(:FAndAExpress)
+FreightKit::Carriers.register(:FedExGround)
+FreightKit::Carriers.register(:FedExExpress)
+FreightKit::Carriers.register(:FortTransportationAndServiceCompanyInc)
+FreightKit::Carriers.register(:FedExLTLPriority)
+FreightKit::Carriers.register(:FedExLTLEconomy)
+FreightKit::Carriers.register(:FairmontLogistics)
+FreightKit::Carriers.register(:FargoCargo)
+FreightKit::Carriers.register(:FastFreightTransportation)
+FreightKit::Carriers.register(:FastLoadTransport)
+FreightKit::Carriers.register(:FirstTruckingExpress)
+FreightKit::Carriers.register(:FlashTrucking)
+FreightKit::Carriers.register(:Frahtex)
+FreightKit::Carriers.register(:FrozenFoodExpress)
+FreightKit::Carriers.register(:GPSTransport)
+FreightKit::Carriers.register(:GSAInternational)
+FreightKit::Carriers.register(:GSPExpress)
+FreightKit::Carriers.register(:GSVTransportation)
+FreightKit::Carriers.register(:GTATransportation)
+FreightKit::Carriers.register(:GholiaBrosTrucking)
+FreightKit::Carriers.register(:GlobalCargo)
+FreightKit::Carriers.register(:GlobalLogisticsAndTransportation)
+FreightKit::Carriers.register(:GoTruckingServices)
+FreightKit::Carriers.register(:GoldEagleTransportation)
+FreightKit::Carriers.register(:GoldenDropTrucking)
+FreightKit::Carriers.register(:GonzalezTransportation)
+FreightKit::Carriers.register(:GreeneEnterprise)
+FreightKit::Carriers.register(:GuamFreightServices)
+FreightKit::Carriers.register(:HERTrucking)
+FreightKit::Carriers.register(:HotLineFreightSystemInc)
+FreightKit::Carriers.register(:USFHolland)
+FreightKit::Carriers.register(:HNTransport)
+FreightKit::Carriers.register(:DependableHawaiianExpress)
+FreightKit::Carriers.register(:RISTTransport)
+FreightKit::Carriers.register(:HarrahTransportation)
+FreightKit::Carriers.register(:HerculesFreight)
+FreightKit::Carriers.register(:HighlanderXpress)
+FreightKit::Carriers.register(:HonoluluFreightService)
+FreightKit::Carriers.register(:HotshotFreightOfTexas)
+FreightKit::Carriers.register(:HouserTransport)
+FreightKit::Carriers.register(:InfinitiFreightLogistics)
+FreightKit::Carriers.register(:InfinityTrucking)
+FreightKit::Carriers.register(:InterstateTMA)
+FreightKit::Carriers.register(:IntradeIndustries)
+FreightKit::Carriers.register(:JBHunt)
+FreightKit::Carriers.register(:JKBExpress)
+FreightKit::Carriers.register(:JLMTransport)
+FreightKit::Carriers.register(:JPLogistics)
+FreightKit::Carriers.register(:JasperTrucking)
+FreightKit::Carriers.register(:JohanssonTransport)
+FreightKit::Carriers.register(:JonesExpress)
+FreightKit::Carriers.register(:JustInTimeCargo)
+FreightKit::Carriers.register(:KLCTransportation)
+FreightKit::Carriers.register(:KMALogistics)
+FreightKit::Carriers.register(:KMTrucking)
+FreightKit::Carriers.register(:KRCLogistics)
+FreightKit::Carriers.register(:KTX)
+FreightKit::Carriers.register(:KengkokTimes)
+FreightKit::Carriers.register(:KingsExpress)
+FreightKit::Carriers.register(:Landstar)
+FreightKit::Carriers.register(:LDTrucking)
+FreightKit::Carriers.register(:LJExpress)
+FreightKit::Carriers.register(:LKPEnterprises)
+FreightKit::Carriers.register(:LanterDistributingLlc)
+FreightKit::Carriers.register(:LTLPros)
+FreightKit::Carriers.register(:LegacyLogisticsSolutions)
+FreightKit::Carriers.register(:LeonardsExpress)
+FreightKit::Carriers.register(:LibertyLinehaulWest)
+FreightKit::Carriers.register(:LibertyTransport)
+FreightKit::Carriers.register(:LightningExpress)
+FreightKit::Carriers.register(:MAndMAndSons)
+FreightKit::Carriers.register(:MCSystems)
+FreightKit::Carriers.register(:MagicMessenger)
+FreightKit::Carriers.register(:MidwestMotorExpress)
+FreightKit::Carriers.register(:MSFreight)
+FreightKit::Carriers.register(:MotoTransportation)
+FreightKit::Carriers.register(:MVGTransport)
+FreightKit::Carriers.register(:MagLinesTransport)
+FreightKit::Carriers.register(:MajorsTransit)
+FreightKit::Carriers.register(:MapGlobalLogistics)
+FreightKit::Carriers.register(:MatthsTrucking)
+FreightKit::Carriers.register(:MavCanadianTransport)
+FreightKit::Carriers.register(:MegaFleet)
+FreightKit::Carriers.register(:MegaTransGroup)
+FreightKit::Carriers.register(:MetaExpress)
+FreightKit::Carriers.register(:MiaTransportation)
+FreightKit::Carriers.register(:MidwestTransportAndTrucking)
+FreightKit::Carriers.register(:MikadeDeliveryService)
+FreightKit::Carriers.register(:MohoffFreightLines)
+FreightKit::Carriers.register(:MontataTravelersExpress)
+FreightKit::Carriers.register(:MorganVanLines)
+FreightKit::Carriers.register(:NAndMTransferCoInc)
+FreightKit::Carriers.register(:NewPennMotorExpress)
+FreightKit::Carriers.register(:NTUSA)
+FreightKit::Carriers.register(:NVKTransport)
+FreightKit::Carriers.register(:NYTransport)
+FreightKit::Carriers.register(:NabotTransportSolutions)
+FreightKit::Carriers.register(:NationalFreightXpress)
+FreightKit::Carriers.register(:NavigationGroup)
+FreightKit::Carriers.register(:NelsonTrucking)
+FreightKit::Carriers.register(:Network1Transportation)
+FreightKit::Carriers.register(:NewCenturyTransport)
+FreightKit::Carriers.register(:NievesTransportation)
+FreightKit::Carriers.register(:NolanTransportationGroup)
+FreightKit::Carriers.register(:NorthlandTrucking)
+FreightKit::Carriers.register(:NorthwestCarrierLogistics)
+FreightKit::Carriers.register(:NuLineTransportation)
+FreightKit::Carriers.register(:OldDominionFreightLine)
+FreightKit::Carriers.register(:OakHarbor)
+FreightKit::Carriers.register(:OaklineTransportation)
+FreightKit::Carriers.register(:OneHundredOneTransport)
+FreightKit::Carriers.register(:OneWayDelivery)
+FreightKit::Carriers.register(:OracleTransportationSolutions)
+FreightKit::Carriers.register(:OrangeCourier)
+FreightKit::Carriers.register(:OrtasTrucking)
+FreightKit::Carriers.register(:PGS360)
+FreightKit::Carriers.register(:PGTransport)
+FreightKit::Carriers.register(:PittOhioExpress)
+FreightKit::Carriers.register(:PKILogistics)
+FreightKit::Carriers.register(:PWCInternational)
+FreightKit::Carriers.register(:ADuiePyle)
+FreightKit::Carriers.register(:PacTruxTransportation)
+FreightKit::Carriers.register(:Pacer)
+FreightKit::Carriers.register(:PacificLogistics)
+FreightKit::Carriers.register(:PacificStatesTruckLines)
+FreightKit::Carriers.register(:ParadiseDistributing)
+FreightKit::Carriers.register(:ParamountFreightSystems)
+FreightKit::Carriers.register(:PilotFreightServices)
+FreightKit::Carriers.register(:PiousTrans)
+FreightKit::Carriers.register(:PlanaTransportation)
+FreightKit::Carriers.register(:Prestige)
+FreightKit::Carriers.register(:ProTransSolutions)
+FreightKit::Carriers.register(:PumaLogistics)
+FreightKit::Carriers.register(:QualityLogistics)
+FreightKit::Carriers.register(:QueenStarTrucking)
+FreightKit::Carriers.register(:RACTransport)
+FreightKit::Carriers.register(:YRCFreight)
+FreightKit::Carriers.register(:RELogistics)
+FreightKit::Carriers.register(:Reddaway)
+FreightKit::Carriers.register(:RAndLCarriers)
+FreightKit::Carriers.register(:RoseTrucking)
+FreightKit::Carriers.register(:RPAndJTransport)
+FreightKit::Carriers.register(:RPMTransportation)
+FreightKit::Carriers.register(:RudeTransportation)
+FreightKit::Carriers.register(:ReeferVanNetwork)
+FreightKit::Carriers.register(:RefrigeratedTruckingAndLTLTransportationServices)
+FreightKit::Carriers.register(:RidgelineExpress)
+FreightKit::Carriers.register(:RiverCityTransport)
+FreightKit::Carriers.register(:Roadtex)
+FreightKit::Carriers.register(:RonaldTransportServices)
+FreightKit::Carriers.register(:SAndSLogistics)
+FreightKit::Carriers.register(:SBTransportation)
+FreightKit::Carriers.register(:SouthwesternMotorTransport)
+FreightKit::Carriers.register(:SNATransportation)
+FreightKit::Carriers.register(:SSIRefrigeratedExpress)
+FreightKit::Carriers.register(:StandardForwardingLlc)
+FreightKit::Carriers.register(:SuttonTransportInc)
+FreightKit::Carriers.register(:SchneiderNational)
+FreightKit::Carriers.register(:SchwarzTrucking)
+FreightKit::Carriers.register(:SewellMotorExpress)
+FreightKit::Carriers.register(:ShawneeTrucking)
+FreightKit::Carriers.register(:ShiLogistics)
+FreightKit::Carriers.register(:SinbadTransport)
+FreightKit::Carriers.register(:Skyway)
+FreightKit::Carriers.register(:SmithCargoTransportationServices)
+FreightKit::Carriers.register(:SolidGroup)
+FreightKit::Carriers.register(:SolutionCarrierExpress)
+FreightKit::Carriers.register(:SpanAlaska)
+FreightKit::Carriers.register(:SpecializeTransportation)
+FreightKit::Carriers.register(:StarAmericanEnterprise)
+FreightKit::Carriers.register(:SterlingTransportation)
+FreightKit::Carriers.register(:SupervanService)
+FreightKit::Carriers.register(:SwiftTransportation)
+FreightKit::Carriers.register(:TaxAirfreightInc)
+FreightKit::Carriers.register(:TforceFreightInc)
+FreightKit::Carriers.register(:THKTrucking)
+FreightKit::Carriers.register(:TILILogistics)
+FreightKit::Carriers.register(:TMTIndustries)
+FreightKit::Carriers.register(:TSIKansas)
+FreightKit::Carriers.register(:AlohaFreightForwarders)
+FreightKit::Carriers.register(:TigerCoolExpress)
+FreightKit::Carriers.register(:TopTenExpress)
+FreightKit::Carriers.register(:TransInternationalTrucking)
+FreightKit::Carriers.register(:TreasureTransportation)
+FreightKit::Carriers.register(:TriStateServices)
+FreightKit::Carriers.register(:TritexFreighters)
+FreightKit::Carriers.register(:Triways)
+FreightKit::Carriers.register(:UAndRTransportation)
+FreightKit::Carriers.register(:UPSFreight)
+FreightKit::Carriers.register(:UPStreamline)
+FreightKit::Carriers.register(:USATruck)
+FreightKit::Carriers.register(:USFreightways)
+FreightKit::Carriers.register(:UnionPacific)
+FreightKit::Carriers.register(:UnitedFreightLogistics)
+FreightKit::Carriers.register(:UnlimitedDistanceTransportation)
+FreightKit::Carriers.register(:ValleyCartage)
+FreightKit::Carriers.register(:VCTransport)
+FreightKit::Carriers.register(:VMGTransportationGroup)
+FreightKit::Carriers.register(:VisionExpress)
+FreightKit::Carriers.register(:VisionLogisticsGroup)
+FreightKit::Carriers.register(:VolpeExpress)
+FreightKit::Carriers.register(:WardTrucking)
+FreightKit::Carriers.register(:WDWB)
+FreightKit::Carriers.register(:WLBTransport)
+FreightKit::Carriers.register(:WesternFlyerExpress)
+FreightKit::Carriers.register(:WesternSpecializedTrucking)
+FreightKit::Carriers.register(:WinDistribution)
+FreightKit::Carriers.register(:XpressGlobalSystems)
+FreightKit::Carriers.register(:XTrux)
+FreightKit::Carriers.register(:XyloTrucking)
+FreightKit::Carriers.register(:ZentnerTransportation)

data/lib/freight_kit/countries.rb

@@ -0,0 +1,22 @@
+module FreightKit
+  module Countries
+    module_function
+
+    def all
+      @all ||= ISO3166::Country
+               .all
+               .map do |iso_country|
+                 Country.new(
+                   iso31661_alpha2: iso_country.alpha2,
+                   iso31661_alpha3: iso_country.alpha3,
+                   name: iso_country.iso_short_name,
+                   un_code: iso_country.number&.to_i
+                 )
+               end
+    end
+
+    def find_by(**attributes)
+      all.find { |country| attributes.all? { |key, value| country.public_send(key) == value } }
+    end
+  end
+end

data/lib/freight_kit/error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class Error < StandardError; end
 end

data/lib/freight_kit/errors/document_not_found_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class DocumentNotFoundError < Error; end
 end

data/lib/freight_kit/errors/expired_credentials_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class ExpiredCredentialsError < InvalidCredentialsError; end
 end

data/lib/freight_kit/errors/http_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class HTTPError < Error
     attr_reader :body, :code

data/lib/freight_kit/errors/invalid_credentials_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class InvalidCredentialsError < Error; end
 end

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class ResponseError < Error
     attr_reader :response

data/lib/freight_kit/errors/shipment_not_found_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class ShipmentNotFoundError < Error; end
 end

data/lib/freight_kit/errors/unserviceable_accessorials_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class UnserviceableAccessorialsError < UnserviceableError
     attr_reader :accessorials
@@ -11,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/errors/unserviceable_error.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class UnserviceableError < Error; end
 end

data/lib/freight_kit/helpers/documentable.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   module Documentable
     def pod(tracking_number)

data/lib/freight_kit/helpers/pickupable.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   module Pickupable
     def create_pickup(
@@ -12,23 +10,14 @@ 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
         response = commit(:pickup, request) if method(:commit).parameters.count == 2
         response ||= commit(request)
-      rescue FreightKit::Error => error
-        response = PickupResponse.new(request:, response: nil, error:)
+      rescue FreightKit::Error => e
+        response = PickupResponse.new(request:, response: nil, error: e)
       end
 
       return response if response.is_a?(PickupResponse)

data/lib/freight_kit/helpers/rateable.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   module Rateable
     def find_rates(shipment:)

data/lib/freight_kit/helpers/trackable.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   module Trackable
     def find_tracking_info(tracking_number, *)

data/lib/freight_kit/http_client/cache_store.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class HTTPClient
     # Adapts an ActiveSupport::Cache::Store-like backend (#read, #write, #delete_matched)
@@ -7,7 +5,7 @@ module FreightKit
     #
     # HTTPX responses hold sockets and options, so only status, headers and body are stored.
     class CacheStore
-      NAMESPACE = 'freight_kit/http_client'
+      NAMESPACE = 'freight_kit/http_client'.freeze
       VALIDATOR_HEADERS = ['if-modified-since', 'if-none-match'].freeze
 
       def initialize(backend) = @backend = backend
@@ -41,7 +39,7 @@ module FreightKit
             headers: response.headers.to_h,
             status: response.status,
             version: response.version
-          },
+          }
         )
       end
 

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class HTTPClient
     # HTTPX writes debug output to an IO-like object (#<<); this forwards it to a logger at debug level.

data/lib/freight_kit/http_client/response.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class HTTPClient
     # Like HTTParty::Response, unknown methods (e.g. #dig, #[]) are delegated to the parsed body.

data/lib/freight_kit/http_client/revalidation.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class HTTPClient
     # HTTPX plugin making revalidated (304 Not Modified) responses look like the cached

data/lib/freight_kit/http_client/safe_retries.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module FreightKit
   class HTTPClient
     # HTTPX plugin keeping connections open (HTTPX's persistent plugin) without risking duplicate
@@ -8,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