footrest 0.5.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e1edaefd5d1a604cc0bce710c44e6a8cd7757b31f32950a5de5b637755c2f31
-  data.tar.gz: 61022350f362ef8cc04f1a8ec83c9e21645d314bac12b67984b234cd6b53570c
+  metadata.gz: 9ad26005a54e3b2f0b36f04bc5e23e9f1f67b8415d8a81357b6cf71f66c96c42
+  data.tar.gz: f78c68fbe3d73d34f0074979c027e77c50ba97b1e0631240b90e5cca5d0a695c
 SHA512:
-  metadata.gz: d589575e6b52848baf5af15e0027111826343f6bbd596d7e1b142a0f5108618a09ad422e5720e23950f7d9743e1d6d511a551ef4d8e519cf03ec5332b8590c85
-  data.tar.gz: 605dec8ec1e209bc6d685a70a8f18f0be7ca2baf202aa11ff7f867e7ec45a0f440b1549271a61d18629a2de0f99eedd188d8ea622a99cc134293fdb27d702b15
+  metadata.gz: 6558af15c808864590d8fe5e58ea63bb2112bd6dcda9ec705f8d29f03827b552227561c3a49d951b884169756c3eb5646c614af44795e037459925ba6933de99
+  data.tar.gz: a3cfdc52cda17871d48afbe8e2d467ca18e363d327d7eb203ef2a13c29f80957509805b5d96f892d3cd8401f246c2442ac10589da65b36f80d3465ea1e0f838e

data/footrest.gemspec

@@ -25,9 +25,11 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "byebug"
-  gem.add_development_dependency "faraday", ">1.0.0", "< 2"
+  gem.add_development_dependency "appraisal", "~> 2.5"
+  gem.add_development_dependency "faraday", ">= 1.0", "< 3"
 
-  gem.add_dependency "faraday", ">= 0.9.0", "< 2"
+  gem.add_dependency "faraday", ">= 1.0", "< 3"
+  gem.add_dependency "faraday-multipart", "~> 1.0"
   gem.add_dependency "activesupport", ">= 3.0.0"
 
   # Parses Link headers formatted according to RFC 5988 draft spec

data/lib/footrest/connection.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'faraday/multipart'
 require 'footrest/http_error'
 require 'footrest/pagination'
 require 'footrest/follow_redirects'
@@ -14,10 +15,14 @@ module Footrest
       @connection = Faraday.new(url: config[:prefix]) do |faraday|
         faraday.request                     :multipart
         faraday.request                     :url_encoded
-        if config[:logger] == true
-          faraday.response :logger
-        elsif config[:logger]
-          faraday.use Faraday::Response::Logger, config[:logger]
+        if config[:logger]
+          logger = config[:logger] == true ? nil : config[:logger]
+          faraday.response :logger, logger do |formatter|
+            # Keep bearer tokens out of the logs. Faraday logs request headers
+            # by default, and dump_headers lives on the formatter in both 1.x
+            # and 2.x, so filter here rather than monkeypatching the logger.
+            formatter.filter(/(Authorization:\s*).*/i, '\1[FILTERED]')
+          end
         end
         faraday.use                         Footrest::FollowRedirects
         faraday.use                         Footrest::ParseJson, :content_type => /\bjson$/

data/lib/footrest/http_error.rb

@@ -70,7 +70,7 @@ module Footrest
     end
   end
 
-  class RaiseFootrestErrors < Faraday::Response::Middleware
+  class RaiseFootrestErrors < Faraday::Middleware
     ERROR_MAP = {
       400 => Footrest::HttpError::BadRequest,
       401 => Footrest::HttpError::Unauthorized,

data/lib/footrest/pagination.rb

@@ -1,7 +1,10 @@
+require 'faraday'
 require 'link_header'
 
 module Footrest
-  class Pagination < Faraday::Response::Middleware
+  # Faraday 2.x removed Faraday::Response::Middleware; the on_complete hook now
+  # lives on the unified Faraday::Middleware base (also present in 1.x).
+  class Pagination < Faraday::Middleware
     Links = Struct.new(:first, :prev, :current, :next, :last) do
       alias_method :previous, :prev
       alias_method :prevous=, :prev=

data/lib/footrest/parse_json.rb

@@ -1,12 +1,10 @@
 require 'footrest/response_middleware'
 
+require 'json'
+
 module Footrest
   # Public: Parse response bodies as JSON.
   class ParseJson < ResponseMiddleware
-    dependency do
-      require 'json' unless defined?(::JSON)
-    end
-
     define_parser do |body|
       ::JSON.parse body unless body.strip.empty?
     end

data/lib/footrest/version.rb

@@ -1,3 +1,3 @@
 module Footrest
-  VERSION = '0.5.8' unless defined?(Footrest::VERSION)
+  VERSION = '0.6.0' unless defined?(Footrest::VERSION)
 end

data/lib/footrest.rb

@@ -4,18 +4,3 @@ require 'footrest/version'
 
 module Footrest
 end
-
-module Faraday
-  class Response::Logger < Response::Middleware
-    private
-
-    SENSITIVE_HEADERS = %w{Authorization}
-    def dump_headers(headers)
-      return "empty headers" unless headers
-      headers.map { |k, v|
-        message = "#{k}: "
-        message << (SENSITIVE_HEADERS.include?(k) ? "[filtered]" : v.inspect)
-      }.join("\n")
-    end
-  end
-end

data/spec/footrest/logger_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../spec_helper'
+require 'logger'
+require 'stringio'
+
+describe "Footrest request logging" do
+  let(:io) { StringIO.new }
+  let(:client) do
+    Footrest::Client.new(
+      prefix: "http://domain.test",
+      token: "s3cr3t~deadbeef",
+      logger: ::Logger.new(io)
+    )
+  end
+
+  before do
+    stub_request(:get, "http://domain.test/page").
+      to_return(status: 200, body: "{}", headers: { content_type: "application/json" })
+  end
+
+  it "redacts the Authorization bearer token from the logs" do
+    client.get("/page")
+
+    expect(io.string).to include("Authorization: [FILTERED]")
+    expect(io.string).not_to include("s3cr3t~deadbeef")
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: footrest
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.6.0
 platform: ruby
 authors:
 - Duane Johnson
 - Nathan Mills
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -95,46 +94,74 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +212,7 @@ files:
 - lib/footrest/version.rb
 - spec/footrest/client_spec.rb
 - spec/footrest/http_error_spec.rb
+- spec/footrest/logger_spec.rb
 - spec/footrest/pagination_spec.rb
 - spec/footrest/request_spec.rb
 - spec/spec_helper.rb
@@ -192,7 +220,6 @@ homepage: https://github.com/instructure/footrest
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,13 +234,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: REST APIs
 test_files:
 - spec/footrest/client_spec.rb
 - spec/footrest/http_error_spec.rb
+- spec/footrest/logger_spec.rb
 - spec/footrest/pagination_spec.rb
 - spec/footrest/request_spec.rb
 - spec/spec_helper.rb