better-faraday 2.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8f236710b44dc72e1efa535f4750f9cc782bce797be1d771da23d7f2ff3ded1
-  data.tar.gz: 4f9c6d1453f308abb928b234429f68c26345056c6b1ff8df2efc17dafce73bcf
+  metadata.gz: 505a74e2ae063f298dd6b7885d06f6e8d4851e1b566d4f5560be0b1d1e7890d5
+  data.tar.gz: abe6ef33c08df902f55f8d6235ff587707e84e497ec65a2059b2f4bb06c20097
 SHA512:
-  metadata.gz: a3a4bb57f6938d021ebf37e9f854e06b55e4022f2ea983a62de1264085c64807a30d8eeeec72c8913b3dd6229c8777293ab2577b4aabd5cc41dd9e1c0b6d3db4
-  data.tar.gz: c0f632bb82dd8eeb84a071d12b1f957a9542494278eaa297e774ca71ef2c1a8a52bad868bec86410b74e9d9beafcb0f823b9eb64b8d4cefc8da840f47befc07f
+  metadata.gz: 692fd039d299eeb2067441d8dd816634924b826314ddcc3caaf0cb3d0231b82b90e47c9077b337fcaaa721231ece2e865432f9b4f1dbb80c97ebb81940f02338
+  data.tar.gz: ca8287fcd46f4e32a2ea5d9ec217b05d0f0fea61167895a90d7c61d0643dc7704b07ced2894a0e89230a08ad29b957f23cf4428840a164e5c3ce36d98e3e5da0

data/.gitignore

@@ -3,3 +3,5 @@
 pkg/
 tmp/
 /.idea
+repomix-output.xml
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Layout/IndentationWidth:
+  EnforcedStyleAlignWith: relative_to_receiver
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+4.0.7

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in better-faraday.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    better-faraday (3.1.0)
+      faraday (>= 1.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    bigdecimal (4.1.3)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
+    coderay (1.1.3)
+    connection_pool (3.0.2)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.2)
+    faraday (2.14.4)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.2.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
+    faraday-net_http_persistent (2.3.1)
+      faraday (~> 2.5)
+      net-http-persistent (>= 4.0.4, < 5)
+    hashdiff (1.2.1)
+    io-console (0.9.4)
+    json (3.0.2)
+    logger (1.7.0)
+    method_source (1.1.0)
+    multipart-post (2.4.1)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    net-http-persistent (4.0.8)
+      connection_pool (>= 2.2.4, < 4)
+    pry (0.16.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      reline (>= 0.6.0)
+    pry-byebug (3.12.0)
+      byebug (~> 13.0)
+      pry (>= 0.13, < 0.17)
+    public_suffix (7.0.5)
+    rake (13.4.2)
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    uri (1.1.1)
+    webmock (3.26.4)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  better-faraday!
+  bundler (~> 4.0)
+  faraday-multipart (~> 1.2)
+  faraday-net_http_persistent (~> 2.3)
+  pry-byebug (~> 3.12)
+  rake (~> 13.4)
+  rspec (~> 3.13)
+  webmock (~> 3.26)
+
+CHECKSUMS
+  addressable (2.9.0) sha256=7fdf6ac3660f7f4e867a0838be3f6cf722ace541dd97767fa42bc6cfa980c7af
+  better-faraday (3.1.0)
+  bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66
+  bundler (4.0.22) sha256=d8d5ec84c8555e0af71db63ed7aee4d1a8fb839ec46d84212d61979242a5d75a
+  byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
+  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
+  connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
+  crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  faraday (2.14.4) sha256=9bb4408c44621b0dbaaaa39e5dbfc4dbe58cc6751b6eb94d16ae9e1f2f2fab6e
+  faraday-multipart (1.2.0) sha256=7d89a949693714176f612323ca13746a2ded204031a6ba528adee788694ef757
+  faraday-net_http (3.4.4) sha256=0e78af151747ed1b00f33e25973b4bc220d7f16c00c39676817c8b12331eb588
+  faraday-net_http_persistent (2.3.1) sha256=23ffba37d6a27807a10f033d01918ec958aa73fa6ff0fccfbcd5ce2d2e68fca3
+  hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1
+  io-console (0.9.4) sha256=a403304f32928ee85e56d457b4612ca43f2703b561a3258844992bd24085fbb1
+  json (3.0.2) sha256=8e6d7e7b11384c21230430cef90b71f14849a34a1f4452796670f7c981bd19df
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
+  multipart-post (2.4.1) sha256=9872d03a8e552020ca096adadbf5e3cb1cd1cdd6acd3c161136b8a5737cdb4a8
+  net-http (0.9.1) sha256=25ba0b67c63e89df626ed8fac771d0ad24ad151a858af2cc8e6a716ca4336996
+  net-http-persistent (4.0.8) sha256=ef3de8319d691537b329053fae3a33195f8b070bbbfae8bf1a58c796081960e6
+  pry (0.16.0) sha256=d76c69065698ed1f85e717bd33d7942c38a50868f6b0673c636192b3d1b6054e
+  pry-byebug (3.12.0) sha256=594e094ae8a8390a7ad4c7b36ae36e13304ed02664c67417d108dc5f7213d1b7
+  public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  reline (0.7.0) sha256=5b012d8e55dbf9d450f12bde2cf7d15ff546ae80b3f8f3b30e570d431815583d
+  rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
+  webmock (3.26.4) sha256=8d8da206d217ebe6968cfb09c77f4533c23074e1432bad865f3994eacbaad50d
+
+BUNDLED WITH
+  4.0.22

data/README.md

@@ -1,7 +1,114 @@
 # better-faraday
 
-A gem extending Faraday (popular Ruby HTTP client) with useful features without breaking anything.
+A lightweight gem extending Faraday (the popular Ruby HTTP client) with useful features, extensive logging, and smart HTTP exceptions—without breaking the standard API.
 
-## Ruby before 2.5
+## Requirements
 
-Please, add `backport_yield_self` to your dependencies.
+* **Ruby** >= 2.7.0, < 5.0 (Fully compatible with Ruby 3.x and 4.x)
+* **Faraday** >= 1.0, < 3.0
+* **Zero dependencies**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "better-faraday", "~> 3.1"
+```
+
+## Usage & Features
+
+### 1. Advanced Exception Handling
+
+Better Faraday automatically defines semantic HTTP exceptions and allows you to enforce strict status checks directly on the response object.
+
+```ruby
+response = Faraday.get("https://api.example.com/data")
+
+# Raises BetterFaraday::HTTP404 if the status is 404
+# Raises BetterFaraday::HTTP5xx if the status is 500-599
+response.assert_2xx! 
+
+# Or check specific ranges/codes:
+response.assert_status!(200)
+response.assert_status!(200..204)
+```
+
+If an exception is raised, its `.message` and `.inspect` will contain a beautifully formatted payload showing exactly what went wrong.
+
+### 2. Comprehensive Response Inspection
+
+Better Faraday enriches `response.inspect` to output detailed, formatted information about the entire lifecycle of the request. It automatically parses JSON bodies for readability, calculates request duration, and safely truncates huge payloads (over 2048 bytes) to prevent memory bloating in your logs.
+
+```ruby
+begin
+  response.assert_2xx!
+rescue BetterFaraday::HTTPError => e
+  puts e.inspect 
+end
+```
+
+**Output example:**
+```text
+BetterFaraday::HTTP422
+
+-- HTTP 422 UNPROCESSABLE ENTITY --
+
+-- Request URL --
+https://api.example.com/users
+
+-- Request Method --
+POST
+
+-- Request Headers --
+{ "Content-Type": "application/json", "Authorization": "SECRET" }
+
+-- Request Body (48 bytes) --
+{ "email": "user@test.com", "password": "SECRET" }
+
+-- Request Sent At --
+2026-10-03 10:00:00.000 UTC
+
+-- Response Headers --
+{ "Content-Type": "application/json" }
+
+-- Response Body (35 bytes) --
+{ "error": "Email already exists" }
+
+-- Response Received At --
+2026-10-03 10:00:00.125 UTC
+
+-- Response Received In --
+125.0ms
+```
+
+### 3. Smart Sensitive Data Masking
+
+Better Faraday protects your logs by aggressively masking sensitive information in both headers and JSON bodies. Out of the box, it safely masks:
+* 
+* Passwords and passphrases
+* API keys and secrets
+* Tokens (Access, Refresh, Bearer, CSRF, JWT)
+* Authorization headers
+* Credit Card numbers and CVV/CVC codes
+* Crypto mnemonics and seed phrases
+
+The masking algorithm is highly performant and seamlessly handles `snake_case`, `camelCase`, `kebab-case`, and spaced keys.
+
+**Adding Custom Masking Rules:**
+You can easily add your own regex patterns to the masking engine:
+
+```ruby
+BetterFaraday.sensitive_data_signs << /my_custom_secret_key/i.freeze
+```
+
+### 4. Bulletproof Middleware & Adapter Compatibility
+
+Better Faraday securely captures request data regardless of the adapter you use:
+* **Standard Adapters:** Fully supports `Net::HTTP` and `Net::HTTP::Persistent`, capturing the exact wire headers mutated during transport.
+* **Test Adapters:** Perfectly compatible with `Faraday::Adapter::Test` and `WebMock` using an eager-fallback mechanism.
+* **Multipart & IO Streams:** Safely reads and logs `File` or `StringIO` upload payloads, ensuring the stream is automatically rewound back to position `0` so the HTTP adapter doesn't send an empty request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/better-faraday.gemspec

@@ -1,18 +1,31 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 
 Gem::Specification.new do |s|
   s.name                  = "better-faraday"
-  s.version               = "2.0.1"
+  s.version               = "3.1.0"
   s.author                = "Yaroslav Konoplov"
   s.email                 = "eahome00@gmail.com"
-  s.summary               = "Extends Faraday with useful features."
-  s.description           = "A gem extending Faraday (popular Ruby HTTP client) with useful features without breaking anything."
+  s.summary               = "Extends Faraday with useful features"
+  s.description           = "A gem extending Faraday HTTP client with useful features"
   s.homepage              = "https://github.com/yivo/better-faraday"
   s.license               = "MIT"
+
+  # Ruby requirements
+  s.required_ruby_version = [">= 2.7.0", "< 5.0"]
+
   s.files                 = `git ls-files -z`.split("\x0")
   s.test_files            = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
   s.require_paths         = ["lib"]
+
+  # Runtime dependencies
   s.add_dependency "faraday", ">= 1.0", "< 3.0"
-  s.add_dependency "activesupport", ">= 4.0", "< 7.0"
+
+  # Development and test dependencies
+  s.add_development_dependency "bundler", "~> 4.0"
+  s.add_development_dependency "faraday-multipart", "~> 1.2"
+  s.add_development_dependency "faraday-net_http_persistent", "~> 2.3"
+  s.add_development_dependency "pry-byebug", "~> 3.12"
+  s.add_development_dependency "rake", "~> 13.4"
+  s.add_development_dependency "rspec", "~> 3.13"
+  s.add_development_dependency "webmock", "~> 3.26"
 end