http_logger 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5e25ba1ebb81a4e187ff3a60481249bd5b9d2795c02ff5470bd635f6b0e4f79
-  data.tar.gz: 99d08eec0c1be45a9db701d2190c7274dbae4ed998d757c7fa83949975d33dcd
+  metadata.gz: 8a29fc0bc0ae3d05a32edc02ec4e53eb8ac4ff97400d842704aba4f9ff865a98
+  data.tar.gz: bc303ae5878d4755a67814ef9f89970b2a03007421b419d0f834fbab40156960
 SHA512:
-  metadata.gz: c5adf4d6151c4b382ab63010be5468638ac4697eacec5ba2872676dca44e1dc6218b4683db11d734e0e5a46e480d78293f7079307bd4e0a26a9f21a38702dd58
-  data.tar.gz: 8437f529565c4e73969dc1ba17f7808b3ccaa03319064057a7254f0d8489cd99e718d832e87e37ca0d2a3052907730bf2a7309bfb2aba3d32be1c65909b9da49
+  metadata.gz: 2761a8a1c86c6be1dfade5b9046a2bf5d8b111271b21d3cb6468e001db480619929ba46b9f9a2a2133958535a698c772bed031f38b3dbe46afbd69f036e880bc
+  data.tar.gz: 0ca796ddd939dfec32218caa017597cc62a368c4e03d1b34085611864471f0b250dccc77b7150d394c6a4aeb49426e020bdb86f995df2b6a5386eaa168a91607

data/lib/http_logger/configuration.rb

@@ -0,0 +1,26 @@
+class HttpLogger
+  class Configuration
+    attr_accessor :collapse_body_limit
+    attr_accessor :log_headers
+    attr_accessor :log_request_body
+    attr_accessor :log_response_body
+    attr_accessor :logger
+    attr_accessor :colorize
+    attr_accessor :ignore
+    attr_accessor :level
+
+    def initialize
+      reset
+    end
+
+    def reset
+      self.log_headers = false
+      self.log_request_body = true
+      self.log_response_body = true
+      self.colorize = true
+      self.collapse_body_limit = 5000
+      self.ignore = []
+      self.level = :debug
+    end
+  end
+end

data/lib/http_logger/version.rb

@@ -0,0 +1,3 @@
+class HttpLogger
+  VERSION = "1.0.2"
+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))
@@ -92,11 +100,12 @@ class HttpLogger
 
   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 +206,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,6 +195,48 @@ 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

metadata

@@ -1,59 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: http_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Bogdan Gusiev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,33 +107,57 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem keep an eye on every Net::HTTP library usage and dump all request
-  and response data to the log file
-email: agresso@gmail.com
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: This gem keeps an eye on every Net::HTTP library usage and dumps all
+  request and response data to the log file.
+email:
+- agresso@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 files:
-- ".document"
-- ".rspec"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- Rakefile
-- Readme.md
-- http_logger.gemspec
+- README.md
 - lib/http_logger.rb
-- screenshots/hoptoad.png
-- screenshots/rails_console.png
-- screenshots/solr.png
+- lib/http_logger/configuration.rb
+- lib/http_logger/version.rb
 - spec/http_logger_spec.rb
+- spec/image.webp
 - spec/spec_helper.rb
-homepage: http://github.com/railsware/http_logger
+homepage: https://github.com/railsware/http_logger
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/railsware/http_logger
+  changelog_uri: https://github.com/railsware/http_logger/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -128,15 +165,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Log your http api calls just like SQL queries
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-gemspec
-

data/Gemfile.lock

@@ -1,71 +0,0 @@
-PATH
-  remote: .
-  specs:
-    http_logger (1.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    bump (0.10.0)
-    crack (0.4.5)
-      rexml
-    date (3.4.1)
-    debug (1.10.0)
-      irb (~> 1.10)
-      reline (>= 0.3.8)
-    diff-lcs (1.6.0)
-    hashdiff (1.0.1)
-    io-console (0.8.0)
-    irb (1.15.1)
-      pp (>= 0.6.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    pp (0.6.2)
-      prettyprint
-    prettyprint (0.2.0)
-    psych (5.2.3)
-      date
-      stringio
-    public_suffix (4.0.6)
-    rake (13.0.6)
-    rdoc (6.12.0)
-      psych (>= 4.0.0)
-    reline (0.6.0)
-      io-console (~> 0.5)
-    rexml (3.2.5)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    stringio (3.1.4)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  arm64-darwin-23
-  x86_64-darwin-19
-
-DEPENDENCIES
-  bump
-  bundler
-  debug
-  http_logger!
-  rake
-  rspec
-  webmock
-
-BUNDLED WITH
-   2.2.22

data/Rakefile

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require 'rake'
-require 'bundler/gem_tasks'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-

data/http_logger.gemspec

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-# encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "http_logger/version"
-
-Gem::Specification.new do |s|
-  s.name = "http_logger".freeze
-  s.version = HttpLogger::VERSION
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["Bogdan Gusiev".freeze]
-  s.date = "2020-01-27"
-  s.description = "This gem keep an eye on every Net::HTTP library usage and dump all request and response data to the log file".freeze
-  s.email = "agresso@gmail.com".freeze
-  s.extra_rdoc_files = [
-    "LICENSE.txt"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "Rakefile",
-    "Readme.md",
-    "http_logger.gemspec",
-    "lib/http_logger.rb",
-    "screenshots/hoptoad.png",
-    "screenshots/rails_console.png",
-    "screenshots/solr.png",
-    "spec/http_logger_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/railsware/http_logger".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.7.8".freeze
-  s.summary = "Log your http api calls just like SQL queries".freeze
-
-  s.add_development_dependency(%q<debug>.freeze, [">= 0"])
-  s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
-  s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-  s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
-  s.add_development_dependency(%q<bump>.freeze, [">= 0"])
-  s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-end
-