http_logger 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23dfe1231c8bedcaea4968b27d855c5832249e8977f70315738db6f45ca69d65
-  data.tar.gz: 1e39712f106bde111c1fca4825ebb25ba03270e2255d9b47aadac7307a153954
+  metadata.gz: 293c2066dfe071a200633e80d2ab28fa752ffa1f1cc9863fc1577d7544d36734
+  data.tar.gz: 6dfa4fa5c2d60141d5bf35c2f5501170f9cb26e5e63f0a14dc9bc21ed2d53b4b
 SHA512:
-  metadata.gz: 7bded89851f6cc5f5b3207f11e1c765f05cf5ece32b42a2be45fcc1b3a6de2e6cea3de6cba53733611df23a2a8265edcf1b99ab95b8eb7c1741afafcb8a32528
-  data.tar.gz: 7efb4e05af6a5ae4f7f13c0915c9df61b65cba27749786315fcdb7082c3f930b5549e63126c2827f15b9a42673d0f7dd001ae9808661c70e46ffcdcd1f9f0fa0
+  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.1"
+  VERSION = "1.0.3"
 end

data/lib/http_logger.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'uri'
 require 'set'
 require 'http_logger/configuration'
+require 'http_logger/version'
 
 # Usage:
 #
@@ -48,7 +49,7 @@ class HttpLogger
   ensure
     if require_logging?(http, request)
       log_request_url(http, request, start_time)
-      log_request_body(request)
+      log_request_body(request, request_body)
       log_request_headers(request)
       if defined?(response) && response
         log_response_code(response)
@@ -64,10 +65,17 @@ class HttpLogger
     content_type = response['Content-Type']
     return false if content_type.nil?
 
-    !content_type.start_with?('text/', 'application/json', 'application/xml', 'application/javascript', 'application/x-www-form-urlencoded', 'application/xhtml+xml', 'application/rss+xml', 'application/atom+xml', 'application/svg+xml', 'application/yaml')
+    !textual_content_type?(content_type)
 
   end
 
+  def binary_request?(request)
+    content_type = request['Content-Type']
+    return false if content_type.nil?
+
+    !textual_content_type?(content_type)
+  end
+
   def log_request_url(http, request, start_time)
     ofset = Time.now - start_time
     log("HTTP #{request.method} (%0.2fms)" % (ofset * 1000), request_url(http, request))
@@ -86,17 +94,22 @@ 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)
+  def log_request_body(request, request_body = nil)
     if configuration.log_request_body
       if HTTP_METHODS_WITH_BODY.include?(request.method)
-        if (body = request.body) && !body.empty?
-          log("Request body", truncate_body(body))
+        body = request.body || request_body
+        if body && !body.empty?
+          log("Request body", format_request_body_for_log(request, body))
         end
       end
     end
@@ -197,9 +210,85 @@ class HttpLogger
     configuration.collapse_body_limit
   end
 
+  def textual_content_type?(content_type)
+    normalized = content_type.to_s.downcase
+    normalized.start_with?(
+      'text/',
+      'application/json',
+      'application/xml',
+      'application/javascript',
+      'application/x-www-form-urlencoded',
+      'application/xhtml+xml',
+      'application/rss+xml',
+      'application/atom+xml',
+      'application/svg+xml',
+      'application/yaml',
+    )
+  end
+
   def configuration
     self.class.configuration
   end
+
+  def format_request_body_for_log(request, body)
+    content_type = request['Content-Type']
+
+    if multipart_content_type?(content_type)
+      return truncate_body(sanitize_multipart_binary_parts(body, multipart_boundary(content_type)))
+    end
+
+    binary_request?(request) ? "<binary #{body.bytesize} bytes>" : truncate_body(body)
+  end
+
+  def multipart_content_type?(content_type)
+    content_type.to_s.downcase.start_with?('multipart/')
+  end
+
+  def multipart_boundary(content_type)
+    match = content_type.to_s.match(/boundary="?([^";]+)"?/i)
+    match && match[1]
+  end
+
+  def sanitize_multipart_binary_parts(body, boundary)
+    return body unless boundary
+
+    binary_body = body.dup.force_encoding(Encoding::BINARY)
+    delimiter = "--#{boundary}".b
+    segments = binary_body.split(delimiter, -1)
+    return body if segments.size < 2
+
+    segments.each_with_index.map do |segment, index|
+      if index == 0
+        segment
+      elsif segment.start_with?("--")
+        "#{delimiter}#{segment}"
+      else
+        "#{delimiter}#{sanitize_multipart_segment(segment)}"
+      end
+    end.join
+  end
+
+  def sanitize_multipart_segment(segment)
+    separator = if segment.include?("\r\n\r\n")
+      "\r\n\r\n"
+    elsif segment.include?("\n\n")
+      "\n\n"
+    end
+    return segment unless separator
+
+    headers, part_body = segment.split(separator, 2)
+    return segment unless part_body
+
+    content_type = headers.each_line.find { |line| line.downcase.start_with?('content-type:') }
+    return segment unless content_type
+
+    part_content_type = content_type.split(':', 2).last.to_s.strip
+    return segment if textual_content_type?(part_content_type)
+
+    trailing_newline = part_body.end_with?("\r\n") ? "\r\n" : (part_body.end_with?("\n") ? "\n" : "")
+    payload = trailing_newline.empty? ? part_body : part_body[0...-trailing_newline.bytesize]
+    "#{headers}#{separator}<binary #{payload.bytesize} bytes>#{trailing_newline}"
+  end
 end
 
 block = lambda do |a|

data/spec/http_logger_spec.rb

@@ -195,7 +195,96 @@ describe HttpLogger do
     it { should include("<binary 41887 bytes>") }
   end
 
+  context "when binary request" do
+    let(:url) { "http://example.com/upload" }
+    let(:request) do
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.path)
+      request['Content-Type'] = 'image/jpeg'
+      request.body = "\xFF\xD8\xFF\xDBbinarypayload".b
+      http.request(request)
+    end
+
+    it { should include("Request body") }
+    it { should include("<binary 17 bytes>") }
+    it { should_not include("binarypayload") }
+  end
+
+  context "when multipart request has binary and text parts" do
+    let(:url) { "http://example.com/upload" }
+    let(:boundary) { "turing-export-80cd207c6b0b5f0c" }
+    let(:request) do
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.path)
+      request['Content-Type'] = "multipart/related; boundary=#{boundary}"
+      request.body = <<~BODY.chomp
+        --#{boundary}
+        Content-Type: application/json; charset=UTF-8
+
+        {"name":"IMG_20190921_152700.jpg","parents":["1LxERY9t0fCAJXJBvBSIGAVhP4IpD0Iyv"]}
+        --#{boundary}
+        Content-Type: image/jpeg
+
+        \xFF\xD8\xFF\xDBJPEGDATA
+        --#{boundary}--
+      BODY
+      http.request(request)
+    end
+
+    it { should include(%({"name":"IMG_20190921_152700.jpg","parents":["1LxERY9t0fCAJXJBvBSIGAVhP4IpD0Iyv"]})) }
+    it { should include("Content-Type: image/jpeg") }
+    it { should include("<binary 12 bytes>") }
+    it { should_not include("JPEGDATA") }
+  end
+
   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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: http_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Bogdan Gusiev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +65,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +158,6 @@ licenses:
 metadata:
   source_code_uri: https://github.com/railsware/http_logger
   changelog_uri: https://github.com/railsware/http_logger/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Log your http api calls just like SQL queries
 test_files: []