freight_kit 0.1.19 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07a406cb84bd27793e12873104e9651751eeae80b471f4f9f3f03253e6a87608
-  data.tar.gz: 32e26ef8e56aceb725c241d360826eaec666f780b0dd48b587b25979d6848fb8
+  metadata.gz: 543816b71edfd222f466c27be9e96722cb616ebb33768e3985379aea350b36d8
+  data.tar.gz: 9aba35e8079b412e35cf2a868ac3b7f0b7c7d47ac2a1b595bc2bcb06ba4e920d
 SHA512:
-  metadata.gz: 42b08cceb7e17d62591c6bfd1f9c03150ac7c314787daabe563ca509ce87aba3382567c97f069d6dc96927de1b06d075c7925a2eb9c510ccfc675b7769fb26b2
-  data.tar.gz: 9ce954dd5948deb22a460910264e99cabb06f3b810f254a7aea32af79273bb7d4f4919ac60ddbe1ce76c299c2048a44bf8ccada188864e093ceacea59593e1a0
+  metadata.gz: 363cd6ebe87b53b68dc5a8a715657ed62069e9bc55a81fdef7c4ad6d056913f1d33651787fd726167337c1ffb38194c9b2c1af84a6501002f62af6aba050ab8c
+  data.tar.gz: eda608438300dd2581bef08ea6b8c4bb6ab0166d7f98cc1027c034da683e84a49a51b9c31d8681c6481c92c625a09c7fe673820ff63fee5b9e0f9a0e267b497a

data/Gemfile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    freight_kit (0.1.17)
+    freight_kit (0.1.19)
       active_utils (>= 3.3.1, < 3.7.0)
-      activemodel (>= 7.1, < 8.1.4)
-      activesupport (>= 7.1, < 8.1.4)
+      activemodel (>= 7.1, < 8.1.5)
+      activesupport (>= 7.1, < 8.1.5)
       benchmark (~> 0.5.0)
       business_time (~> 0.13.0)
       httparty (~> 0.10)
@@ -12,11 +12,10 @@ PATH
       mimemagic (~> 0.4.3)
       nokogiri (>= 1.6, < 1.20)
       place_kit (~> 0.0.6)
-      rmagick (>= 4.2.5, < 7.1.0)
       savon (>= 2.17, < 2.18)
       tzinfo-data (~> 1.2023, >= 1.2023.3)
       watir (>= 7.0, < 7.4)
-      zeitwerk (>= 2.6.0, < 2.8.3)
+      zeitwerk (>= 2.6.0, < 2.8.4)
 
 GEM
   remote: https://rubygems.org/
@@ -39,20 +38,21 @@ GEM
       mutex_m
       securerandom (>= 0.3)
       tzinfo (~> 2.0)
-    addressable (2.8.5)
-      public_suffix (>= 2.0.2, < 6.0)
-    akami (1.3.1)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    akami (1.3.3)
+      base64
       gyoku (>= 0.4.0)
       nokogiri
-    ast (2.4.3)
+    ast (2.4.2)
     base64 (0.3.0)
     benchmark (0.5.0)
-    bigdecimal (4.1.2)
-    builder (3.2.4)
+    bigdecimal (3.3.1)
+    builder (3.3.0)
     business_time (0.13.0)
       activesupport (>= 3.2.0)
       tzinfo
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.6)
     connection_pool (3.0.2)
     csv (3.3.5)
     date (3.5.1)
@@ -60,7 +60,7 @@ GEM
     drb (2.2.3)
     faker (3.8.0)
       i18n (>= 1.8.11, < 2)
-    faraday (2.14.3)
+    faraday (2.14.2)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -77,12 +77,12 @@ GEM
       mutex_m
       nkf
       rack (>= 2.0, < 4)
-    i18n (1.14.1)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.21.1)
-    language_server-protocol (3.17.0.6)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
     logger (1.7.0)
-    mail (2.9.1)
+    mail (2.9.0)
       logger
       mini_mime (>= 0.1.1)
       net-imap
@@ -94,13 +94,15 @@ GEM
       nokogiri (~> 1)
       rake
     mini_mime (1.1.5)
-    mini_portile2 (2.8.4)
-    minitest (5.15.0)
-    multi_xml (0.6.0)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    multi_xml (0.7.1)
+      bigdecimal (~> 3.1)
     mutex_m (0.3.0)
     net-http (0.9.1)
       uri (>= 0.11.1)
-    net-imap (0.6.4.1)
+    net-imap (0.6.4)
       date
       net-protocol
     net-pop (0.1.2)
@@ -109,32 +111,27 @@ GEM
       timeout
     net-smtp (0.5.1)
       net-protocol
-    nkf (0.3.0)
-    nokogiri (1.13.10)
-      mini_portile2 (~> 2.8.0)
+    nkf (0.2.0)
+    nokogiri (1.19.3-arm64-darwin)
       racc (~> 1.4)
-    nori (2.6.0)
-    observer (0.1.2)
-    parallel (1.28.0)
-    parser (3.3.12.0)
+    nori (2.7.1)
+      bigdecimal
+    parallel (1.25.1)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
-    pkg-config (1.6.5)
     place_kit (0.0.6)
       activesupport (>= 7.1, < 8.1.4)
       csv (~> 3.3)
     prism (1.9.0)
-    public_suffix (5.0.3)
-    racc (1.7.1)
-    rack (3.0.8)
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rack (3.2.6)
     rainbow (3.1.1)
     rake (13.4.2)
     redcarpet (3.6.0)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rmagick (7.0.5)
-      observer (~> 0.1)
-      pkg-config (~> 1.4)
+    regexp_parser (2.9.0)
+    rexml (3.4.4)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -159,11 +156,10 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.50.0)
-      parser (>= 3.3.7.2)
-      prism (~> 1.7)
-    rubocop-graphql (1.5.4)
-      rubocop (>= 1.50, < 2)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-graphql (1.5.2)
+      rubocop (>= 0.90, < 2)
     rubocop-next (1.0.7)
       rubocop (>= 1.56, < 1.65)
       rubocop-graphql (>= 1.4, < 1.6)
@@ -171,14 +167,14 @@ GEM
       rubocop-rake (~> 0.6.0)
       rubocop-rspec (>= 2.23.2, < 3.1.0)
       rubocop-shopify (>= 2.14, < 2.16)
-    rubocop-rails (2.25.1)
+    rubocop-rails (2.25.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (3.0.5)
+    rubocop-rspec (3.0.1)
       rubocop (~> 1.61)
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
@@ -194,31 +190,34 @@ GEM
       nori (~> 2.4)
       wasabi (>= 5.1.0, < 6)
     securerandom (0.4.1)
-    selenium-webdriver (4.12.0)
+    selenium-webdriver (4.16.0)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
     timeout (0.6.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    tzinfo-data (1.2023.4)
+    tzinfo-data (1.2023.3)
       tzinfo (>= 1.0.0)
-    unicode-display_width (2.6.0)
+    unicode-display_width (2.5.0)
     uri (1.1.1)
     wasabi (5.1.0)
       addressable
       faraday (>= 1.9, < 3)
       nokogiri (>= 1.13.9)
-    watir (7.1.0)
+    watir (7.3.0)
       regexp_parser (>= 1.2, < 3)
-      selenium-webdriver (~> 4.0)
-    websocket (1.2.9)
+      selenium-webdriver (~> 4.2)
+    websocket (1.2.10)
     yard (0.9.34)
-    zeitwerk (2.8.2)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
+  arm64-darwin-24
   arm64-darwin-25
+  arm64-darwin-27
 
 DEPENDENCIES
   faker (~> 3.8.0)
@@ -230,4 +229,4 @@ DEPENDENCIES
   yard (~> 0.9.28)
 
 BUNDLED WITH
-   2.4.19
+  4.0.23

data/README.md

@@ -26,7 +26,6 @@ __Note:__ `Carrier`s may extend `Platform`s and override them when their behavio
 ## Supported Platforms
 
 * [Carrier Logistics](https://carrierlogistics.com)
-* [Next TMS](https://next-tms.com)
 * [The Great Information Factory](https://www.tgifsoftware.com)
 
 ## Supported Carriers
@@ -65,6 +64,42 @@ Or standalone:
 $ gem install freight_kit
 ```
 
+## HTTP Client
+
+FreightKit sends HTTP requests through `FreightKit::HTTPClient`, a wrapper around HTTPX. The client keeps connections open between requests, and it reuses HTTP/2 connections. If a connection fails, the client retries only idempotent requests, such as GET. It never retries a POST, because the carrier can already have processed it. The client asks carriers for Brotli, Zstandard, gzip, and deflate compression.
+
+### Logging
+
+The client writes request and response details at the debug level. By default it uses `Rails.logger`, or the Hanami app logger. Outside Rails and Hanami, it logs to standard output at the level in the `LOG_LEVEL` environment variable. The default level is `info`.
+
+To use a different logger, set it at boot:
+
+```ruby
+FreightKit::HTTPClient.logger = Logger.new($stdout, level: :debug)
+```
+
+Debug output contains request headers and bodies, which include carrier credentials. Do not use the debug level in production.
+
+### Cache
+
+The client uses conditional requests: it sends `If-None-Match` and `If-Modified-Since` and reuses the cached body when the carrier replies `304 Not Modified`.
+
+By default, the client keeps cached responses in an in-process `ActiveSupport::Cache::MemoryStore`. To share the cache between processes, set your own backend at boot. The backend must respond to `read`, `write`, and `delete_matched`, like `ActiveSupport::Cache::Store`.
+
+In Rails, add this line to an initializer:
+
+```ruby
+FreightKit::HTTPClient.cache = Rails.cache
+```
+
+In Hanami or plain Ruby, give any compatible store:
+
+```ruby
+FreightKit::HTTPClient.cache = ActiveSupport::Cache::RedisCacheStore.new(url: ENV.fetch('REDIS_URL'))
+```
+
+Cache entries contain carrier response bodies. Use a backend that you trust with that data. Keys are SHA-256 digests of the method, the URL, and all request headers. Requests with different credentials thus never share an entry. To turn off the cache, set `ActiveSupport::Cache::NullStore.new`.
+
 ## Standard Usage
 
 Start off by initializing a `Carrier`:
@@ -99,7 +134,7 @@ credentials = [
   )
 ]
 
-carrier = FreightKit::SCAC.new(credentials)
+carrier = FreightKit::Carriers::Saia.new(credentials)
 ```
 
 ### Documents

data/Rakefile

@@ -0,0 +1,6 @@
+desc 'Load FreightKit'
+task(:environment) do
+  require_relative 'lib/freight_kit'
+end
+
+Dir[File.expand_path('tasks/*.rake', __dir__)].each { |task| import(task) }

data/VERSION

@@ -1 +1 @@
-0.1.19
+0.1.21