http_logger 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a29fc0bc0ae3d05a32edc02ec4e53eb8ac4ff97400d842704aba4f9ff865a98
-  data.tar.gz: bc303ae5878d4755a67814ef9f89970b2a03007421b419d0f834fbab40156960
+  metadata.gz: 293c2066dfe071a200633e80d2ab28fa752ffa1f1cc9863fc1577d7544d36734
+  data.tar.gz: 6dfa4fa5c2d60141d5bf35c2f5501170f9cb26e5e63f0a14dc9bc21ed2d53b4b
 SHA512:
-  metadata.gz: 2761a8a1c86c6be1dfade5b9046a2bf5d8b111271b21d3cb6468e001db480619929ba46b9f9a2a2133958535a698c772bed031f38b3dbe46afbd69f036e880bc
-  data.tar.gz: 0ca796ddd939dfec32218caa017597cc62a368c4e03d1b34085611864471f0b250dccc77b7150d394c6a4aeb49426e020bdb86f995df2b6a5386eaa168a91607
+  metadata.gz: 9e43e1a43adafc86c6c38aca71402340c5370afc74b793c6bff477ce14c1809b8040e0d6c207e0892ce558337eb96203b89a565d67fdd43b071ec6ca687b952e
+  data.tar.gz: e4d751fa35fce92194a0cb1058b989f870c391b12f6bfaf6fb3c0de2495f134edfc29ab779378efd60cd8c86f004e54993d98a5afd1bed072e782096d66bd9fc

data/README.md

@@ -44,6 +44,11 @@ HttpLogger.configure do |c|
 
   # Change default truncate limit. Default: 5000
   c.collapse_body_limit = 5000
+
+  # Header names whose values are logged as <filtered>, case-insensitive.
+  # Default: ["Authorization"]. Setting it replaces the default rather than
+  # adding to it; an empty list logs every header in full.
+  c.filtered_headers = %w[Authorization X-Api-Key]
 end
 ```
 

data/lib/http_logger/configuration.rb

@@ -8,6 +8,7 @@ class HttpLogger
     attr_accessor :colorize
     attr_accessor :ignore
     attr_accessor :level
+    attr_accessor :filtered_headers
 
     def initialize
       reset
@@ -21,6 +22,7 @@ class HttpLogger
       self.collapse_body_limit = 5000
       self.ignore = []
       self.level = :debug
+      self.filtered_headers = ['Authorization']
     end
   end
 end

data/lib/http_logger/version.rb

@@ -1,3 +1,3 @@
 class HttpLogger
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/http_logger.rb

@@ -94,10 +94,14 @@ class HttpLogger
   end
 
   def log_header(type, name, value)
-    value = "<filtered>" if name == AUTHORIZATION_HEADER
+    value = "<filtered>" if filtered_header?(name)
     log("HTTP #{type} header", "#{name}: #{value}")
   end
 
+  def filtered_header?(name)
+    Array(configuration.filtered_headers).any? { |header| header.to_s.casecmp?(name.to_s) }
+  end
+
   HTTP_METHODS_WITH_BODY = Set.new(%w(POST PUT GET PATCH))
 
   def log_request_body(request, request_body = nil)

data/spec/http_logger_spec.rb

@@ -240,4 +240,51 @@ describe HttpLogger do
   after(:each) do
     HttpLogger.configuration.reset
   end
+
+  describe "filtered_headers" do
+    before(:each) do
+      HttpLogger.configuration.log_headers = true
+    end
+
+    let(:request_headers) do
+      {'Authorization' => "Bearer secret", 'X-Api-Key' => "key123"}
+    end
+
+    it "filters Authorization by default and leaves other headers alone" do
+      subject.should include("Authorization: <filtered>")
+      subject.should include("X-Api-Key: key123")
+    end
+
+    context "with a custom list" do
+      before(:each) do
+        HttpLogger.configuration.filtered_headers = %w[x-api-key]
+      end
+
+      it "matches case-insensitively and no longer filters Authorization" do
+        subject.should include("X-Api-Key: <filtered>")
+        subject.should include("Authorization: Bearer secret")
+      end
+    end
+
+    context "with an empty list" do
+      before(:each) do
+        HttpLogger.configuration.filtered_headers = []
+      end
+
+      it "logs every header in full" do
+        subject.should include("Authorization: Bearer secret")
+        subject.should include("X-Api-Key: key123")
+      end
+    end
+
+    context "with response headers" do
+      let(:response_headers) { {'Set-Cookie' => "session=abc"} }
+
+      before(:each) do
+        HttpLogger.configuration.filtered_headers = %w[Authorization Set-Cookie]
+      end
+
+      it { should include("Set-Cookie: <filtered>") }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Bogdan Gusiev
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Log your http api calls just like SQL queries
 test_files: []