http_logger 0.7.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8cd08ba96dbddfa8f11e4bcbebb2cdde1bc99c19a2603eb2253c1f48d173214
-  data.tar.gz: 0c11b8553de5807f784dd14276017a5b8b7bf6d393e296fb246835bcc6fa0b78
+  metadata.gz: 23dfe1231c8bedcaea4968b27d855c5832249e8977f70315738db6f45ca69d65
+  data.tar.gz: 1e39712f106bde111c1fca4825ebb25ba03270e2255d9b47aadac7307a153954
 SHA512:
-  metadata.gz: 3b3bcc69fac4c32215adfa5dac3ba2c0312d67b51a7e6890349bb007a3508f1b91b1b8284c1d835684319e39af6045d2945d8703d43347e130abedffd81bf0fb
-  data.tar.gz: 1a0d722184351705fedb9245f0b74ee2fa315a3df44b956db9561b30bf69b3bce337d179d0f82cb9142239754dd2d2fb363101c1497b85111721079c5b42e1f3
+  metadata.gz: 7bded89851f6cc5f5b3207f11e1c765f05cf5ece32b42a2be45fcc1b3a6de2e6cea3de6cba53733611df23a2a8265edcf1b99ab95b8eb7c1741afafcb8a32528
+  data.tar.gz: 7efb4e05af6a5ae4f7f13c0915c9df61b65cba27749786315fcdb7082c3f930b5549e63126c2827f15b9a42673d0f7dd001ae9808661c70e46ffcdcd1f9f0fa0

data/{Readme.md → README.md}

@@ -20,14 +20,31 @@ gem install http_logger
 ``` ruby
 require 'http_logger'
 
-HttpLogger.logger = Logger.new(...) # defaults to Rails.logger if Rails is defined
-HttpLogger.colorize = true # Default: true
-HttpLogger.ignore = [/newrelic\.com/]
-HttpLogger.log_headers = false  # Default: false
-HttpLogger.log_request_body  = false  # Default: true
-HttpLogger.log_response_body = false  # Default: true
-HttpLogger.level = :info # Desired log level as a symbol. Default: :debug
-HttpLogger.collapse_body_limit # Change default truncate limit. Default: 5000
+HttpLogger.configure do |c|
+  # defaults to Rails.logger if Rails is defined
+  c.logger = Logger.new(LOGFILE)
+
+  # Default: true
+  c.colorize = true
+
+  # Ignore patterns (e.g., URLs to ignore)
+  c.ignore = [/newrelic\.com/]
+
+  # Default: false
+  c.log_headers = false
+
+  # Default: true
+  c.log_request_body = false
+
+  # Default: true
+  c.log_response_body = false
+
+  # Desired log level as a symbol. Default: :debug
+  c.level = :info
+
+  # Change default truncate limit. Default: 5000
+  c.collapse_body_limit = 5000
+end
 ```
 
 ## Alternative

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.1"
+end

data/lib/http_logger.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'uri'
 require 'set'
+require 'http_logger/configuration'
 
 # Usage:
 #
@@ -8,8 +9,8 @@ require 'set'
 #
 # == Setup logger
 #
-#    HttpLogger.logger = Logger.new('/tmp/all.log')
-#    HttpLogger.log_headers = true
+#    HttpLogger.configuration.logger = Logger.new('/tmp/all.log')
+#    HttpLogger.configuration.log_headers = true
 #
 # == Do request
 #
@@ -24,24 +25,14 @@ require 'set'
 class HttpLogger
   AUTHORIZATION_HEADER = 'Authorization'
 
-  class << self
-    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
-  end
-
-  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
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    block.call(configuration)
+  end
+
 
   def self.perform(*args, &block)
     instance.perform(*args, &block)
@@ -51,10 +42,6 @@ class HttpLogger
     @instance ||= HttpLogger.new
   end
 
-  def self.deprecate_config(option)
-    warn "Net::HTTP.#{option} is deprecated. Use HttpLogger.#{option} instead."
-  end
-
   def perform(http, request, request_body)
     start_time = Time.now
     response = yield
@@ -66,13 +53,21 @@ class HttpLogger
       if defined?(response) && response
         log_response_code(response)
         log_response_headers(response)
-        log_response_body(response.body)
+        log_response_body(response.body, binary_response?(response))
       end
     end
   end
 
   protected
 
+  def binary_response?(response)
+    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')
+
+  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))
@@ -83,7 +78,7 @@ class HttpLogger
   end
 
   def log_request_headers(request)
-    if self.class.log_headers
+    if configuration.log_headers
       request.each_capitalized do |k,v|
         log_header(:request, k, v)
       end
@@ -98,7 +93,7 @@ class HttpLogger
   HTTP_METHODS_WITH_BODY = Set.new(%w(POST PUT GET PATCH))
 
   def log_request_body(request)
-    if self.class.log_request_body
+    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))
@@ -112,33 +107,34 @@ class HttpLogger
   end
 
   def log_response_headers(response)
-    if HttpLogger.log_headers
+    if configuration.log_headers
       response.each_capitalized do |k,v|
         log_header(:response, k, v)
       end
     end
   end
 
-  def log_response_body(body)
-    if HttpLogger.log_response_body
+  def log_response_body(body, binary)
+    if configuration.log_response_body
       if body.is_a?(Net::ReadAdapter)
         log("Response body", "<impossible to log>")
       else
         if body && !body.empty?
-          log("Response body", truncate_body(body))
+          log(
+            "Response body",
+            binary ? "<binary #{body.length} bytes>" : truncate_body(body),)
         end
       end
     end
   end
 
   def require_logging?(http, request)
-
     self.logger && !ignored?(http, request) && (http.started? || webmock?(http, request))
   end
 
   def ignored?(http, request)
     url = request_url(http, request)
-    HttpLogger.ignore.any? do |pattern|
+    configuration.ignore.any? do |pattern|
       url =~ pattern
     end
   end
@@ -179,11 +175,11 @@ class HttpLogger
   end
 
   def log(message, dump)
-    self.logger.send(self.class.level, format_log_entry(message, dump))
+    self.logger.send(configuration.level, format_log_entry(message, dump))
   end
 
   def format_log_entry(message, dump = nil)
-    if self.class.colorize
+    if configuration.colorize
       message_color, dump_color = "4;32;1", "0;1"
       log_entry = "  \e[#{message_color}m#{message}\e[0m   "
       log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
@@ -194,16 +190,19 @@ class HttpLogger
   end
 
   def logger
-    self.class.logger
+    configuration.logger
   end
 
   def collapse_body_limit
-    self.class.collapse_body_limit
+    configuration.collapse_body_limit
+  end
+
+  def configuration
+    self.class.configuration
   end
 end
 
 block = lambda do |a|
-  # raise instance_methods.inspect
   alias request_without_net_http_logger request
   def request(request, body = nil, &block)
     HttpLogger.perform(self, request, body) do
@@ -215,7 +214,6 @@ end
 
 if defined?(::WebMock)
   klass = WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP")
-  # raise klass.instance_methods.inspect
   klass.class_eval(&block)
 end
 
@@ -226,7 +224,9 @@ if defined?(Rails)
   if defined?(ActiveSupport) && ActiveSupport.respond_to?(:on_load)
     # Rails3
     ActiveSupport.on_load(:after_initialize) do
-      HttpLogger.logger = Rails.logger unless HttpLogger.logger
+      unless HttpLogger.configuration.logger
+        HttpLogger.configuration.logger = Rails.logger
+      end
     end
   end
 end

data/spec/http_logger_spec.rb

@@ -8,6 +8,7 @@ describe HttpLogger do
     # flush log
     f = File.open(LOGFILE, "w")
     f.close
+
     stub_request(:any, url).to_return(
       body: response_body,
       headers: {"X-Http-logger" => true, **response_headers},
@@ -48,7 +49,7 @@ describe HttpLogger do
   context "when headers logging is on" do
 
     before(:each) do
-      HttpLogger.log_headers = true
+      HttpLogger.configuration.log_headers = true
     end
 
     it { should include("HTTP response header") }
@@ -62,11 +63,6 @@ describe HttpLogger do
       end
       it { should include("Authorization: <filtered>") }
     end
-
-    after(:each) do
-      HttpLogger.log_headers = false
-    end
-
   end
 
   describe "post request" do
@@ -116,7 +112,7 @@ describe HttpLogger do
   context "when request body logging is off" do
 
     before(:each) do
-      HttpLogger.log_request_body = false
+      HttpLogger.configuration.log_request_body = false
     end
 
     let(:request) do
@@ -125,9 +121,6 @@ describe HttpLogger do
 
     it { should_not include("Request body") }
 
-    after(:each) do
-      HttpLogger.log_request_body = true
-    end
   end
 
   context "with long response body" do
@@ -147,7 +140,7 @@ describe HttpLogger do
   context "when response body logging is off" do
 
     before(:each) do
-      HttpLogger.log_response_body = false
+      HttpLogger.configuration.log_response_body = false
     end
 
     let(:response_body) { long_body }
@@ -156,10 +149,6 @@ describe HttpLogger do
     end
 
     it { should_not include("Response body") }
-
-    after(:each) do
-      HttpLogger.log_response_body = true
-    end
   end
 
   context "ignore option is set" do
@@ -169,14 +158,10 @@ describe HttpLogger do
     end
 
     before(:each) do
-      HttpLogger.ignore = [/rpm\.newrelic\.com/]
+      HttpLogger.configuration.ignore = [/rpm\.newrelic\.com/]
     end
 
     it { should be_empty}
-
-    after(:each) do
-      HttpLogger.ignore = []
-    end
   end
 
   context "when level is set" do
@@ -187,13 +172,30 @@ describe HttpLogger do
     end
 
     before(:each) do
-      HttpLogger.level = :info
+      HttpLogger.configuration.level = :info
     end
 
     it { should_not be_empty }
+  end
+
+  context "when binary response" do
+    let(:response_headers) do
+      {
+        'Content-Type' => 'image/webp'
+      }
+    end
+    let(:url) do
+      "http://example.com/image.webp"
+    end
 
-    after(:each) do
-      HttpLogger.level = :debug
+    let(:response_body) do
+      File.read("#{File.dirname(__FILE__)}/image.webp")
     end
+
+    it { should include("<binary 41887 bytes>") }
+  end
+
+  after(:each) do
+    HttpLogger.configuration.reset
   end
 end

data/spec/spec_helper.rb

@@ -15,5 +15,5 @@ LOGFILE = 'http.log'
 RSpec.configure do |config|
   config.expect_with(:rspec) { |c| c.syntax = :should }
   FileUtils.rm_f(LOGFILE)
-  HttpLogger.logger = Logger.new(LOGFILE)
+  HttpLogger.configuration.logger = Logger.new(LOGFILE)
 end

metadata

@@ -1,112 +1,122 @@
 --- !ruby/object:Gem::Specification
 name: http_logger
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: byebug
+  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: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !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
+        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
-- VERSION
-- 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: {}
+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:
@@ -115,14 +125,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.2.22
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: Log your http api calls just like SQL queries

data/.document

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

data/.rspec

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

data/Gemfile

@@ -1,11 +0,0 @@
-source "http://rubygems.org"
-
-group :development do
-  gem "rake"
-  gem "byebug"
-  gem "webmock"
-  gem "rspec"
-  gem "bump", "~> 0.10.0"
-  gem "bundler"
-end
-

data/Gemfile.lock

@@ -1,43 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.4.0)
-    bump (0.10.0)
-    byebug (11.1.3)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    hashdiff (1.0.1)
-    rake (13.0.6)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  x86_64-darwin-19
-
-DEPENDENCIES
-  bump (~> 0.10.0)
-  bundler
-  byebug
-  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/VERSION

@@ -1 +0,0 @@
-0.7.0

data/http_logger.gemspec

@@ -1,66 +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",
-    "VERSION",
-    "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
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<byebug>.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<jeweler>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<byebug>.freeze, [">= 0"])
-      s.add_dependency(%q<webmock>.freeze, [">= 0"])
-      s.add_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<bundler>.freeze, [">= 0"])
-      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<byebug>.freeze, [">= 0"])
-    s.add_dependency(%q<webmock>.freeze, [">= 0"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
-  end
-end
-