http_logger 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ee612be76637a3fa5e75db03b7fa33a7016d3b4f509c32295580e002df73bd2
-  data.tar.gz: f7ef81b6d4c9d61dfa37626794a6bb725c1e83b36b29d824bf70bd5215bfb4e8
+  metadata.gz: e8cd08ba96dbddfa8f11e4bcbebb2cdde1bc99c19a2603eb2253c1f48d173214
+  data.tar.gz: 0c11b8553de5807f784dd14276017a5b8b7bf6d393e296fb246835bcc6fa0b78
 SHA512:
-  metadata.gz: 9d81717a77786fb2bffb89c9cce68bc1f9ef8c6d4f2960a945324db0c53831cd8c78643e3c21779f1250cf862e2dcaa5a3d6610eb5fb934c2a15ed296225c416
-  data.tar.gz: 90132a5f50f91d39542f255680e577bd755254815df1f5332d71c73db76eadc2862a30d9b43dfc04e6cb50ce7aea30dc5143997c41a3c3cff07616eea342b285
+  metadata.gz: 3b3bcc69fac4c32215adfa5dac3ba2c0312d67b51a7e6890349bb007a3508f1b91b1b8284c1d835684319e39af6045d2945d8703d43347e130abedffd81bf0fb
+  data.tar.gz: 1a0d722184351705fedb9245f0b74ee2fa315a3df44b956db9561b30bf69b3bce337d179d0f82cb9142239754dd2d2fb363101c1497b85111721079c5b42e1f3

data/Gemfile

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

data/Gemfile.lock

@@ -2,85 +2,42 @@ GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.4.0)
-    builder (3.2.4)
-    byebug (11.1.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.5.0)
-    github_api (0.16.0)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      mime-types (>= 1.16, < 3.0)
-      oauth2 (~> 1.0)
-    hashdiff (1.0.0)
-    hashie (4.0.0)
-    highline (2.0.3)
-    jeweler (2.3.9)
-      builder
-      bundler
-      git (>= 1.2.5)
-      github_api (~> 0.16.0)
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      psych
-      rake
-      rdoc
-      semver2
-    jwt (2.2.1)
-    mime-types (2.99.3)
-    mini_portile2 (2.4.0)
-    multi_json (1.14.1)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    nokogiri (1.10.7)
-      mini_portile2 (~> 2.4.0)
-    oauth2 (1.4.2)
-      faraday (>= 0.8, < 2.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    psych (3.1.0)
-    rack (2.1.1)
-    rake (13.0.1)
-    rdoc (6.2.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.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.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    safe_yaml (1.0.5)
-    semver2 (3.4.2)
-    thread_safe (0.3.6)
-    webmock (3.8.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
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
+  bump (~> 0.10.0)
   bundler
   byebug
-  jeweler
+  rake
   rspec
   webmock
 
 BUNDLED WITH
-   2.0.1
+   2.2.22

data/Rakefile

@@ -9,24 +9,13 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "http_logger"
-  gem.homepage = "http://github.com/railsware/http_logger"
-  gem.license = "MIT"
-  gem.summary = %Q{Log your http api calls just like SQL queries}
-  gem.description = %Q{This gem keep an eye on every Net::HTTP library usage and dump all request and response data to the log file}
-  gem.email = "agresso@gmail.com"
-  gem.authors = ["Bogdan Gusiev"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
+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

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/http_logger.gemspec

@@ -1,12 +1,12 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: http_logger 0.6.0 ruby lib
+# 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 = "0.6.0"
+  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]

data/lib/http_logger.rb

@@ -22,6 +22,8 @@ require 'set'
 #
 #     cat /tmp/all.log
 class HttpLogger
+  AUTHORIZATION_HEADER = 'Authorization'
+
   class << self
     attr_accessor :collapse_body_limit
     attr_accessor :log_headers
@@ -82,10 +84,17 @@ class HttpLogger
 
   def log_request_headers(request)
     if self.class.log_headers
-      request.each_capitalized { |k,v| log("HTTP request header", "#{k}: #{v}") }
+      request.each_capitalized do |k,v|
+        log_header(:request, k, v)
+      end
     end
   end
 
+  def log_header(type, name, value)
+    value = "<filtered>" if name == AUTHORIZATION_HEADER
+    log("HTTP #{type} header", "#{name}: #{value}")
+  end
+
   HTTP_METHODS_WITH_BODY = Set.new(%w(POST PUT GET PATCH))
 
   def log_request_body(request)
@@ -104,7 +113,9 @@ class HttpLogger
 
   def log_response_headers(response)
     if HttpLogger.log_headers
-      response.each_capitalized { |k,v| log("HTTP response header", "#{k}: #{v}") }
+      response.each_capitalized do |k,v|
+        log_header(:response, k, v)
+      end
     end
   end
 
@@ -121,7 +132,8 @@ class HttpLogger
   end
 
   def require_logging?(http, request)
-    self.logger && !ignored?(http, request) && (http.started? || fakeweb?(http, request))
+
+    self.logger && !ignored?(http, request) && (http.started? || webmock?(http, request))
   end
 
   def ignored?(http, request)
@@ -131,7 +143,7 @@ class HttpLogger
     end
   end
 
-  def fakeweb?(http, request)
+  def webmock?(http, request)
     return false unless defined?(::WebMock)
     uri = request_uri_as_string(http, request)
     method = request.method.downcase.to_sym
@@ -146,8 +158,8 @@ class HttpLogger
     path = URI.parse(request.path).request_uri if request.path =~ /^http/
 
     if request["authorization"] =~ /^Basic /
-      userinfo = FakeWeb::Utility.decode_userinfo_from_header(request["authorization"])
-      userinfo = FakeWeb::Utility.encode_unsafe_chars_in_userinfo(userinfo) + "@"
+      userinfo = WebMock::Utility.decode_userinfo_from_header(request["authorization"])
+      userinfo = WebMock::Utility.encode_unsafe_chars_in_userinfo(userinfo) + "@"
     else
       userinfo = ""
     end
@@ -190,27 +202,28 @@ class HttpLogger
   end
 end
 
-module NetHttpLogger
+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
-      super(request, body, &block)
+      request_without_net_http_logger(request, body, &block)
     end
+
   end
 end
 
 if defined?(::WebMock)
-  WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").prepend(NetHttpLogger)
+  klass = WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP")
+  # raise klass.instance_methods.inspect
+  klass.class_eval(&block)
 end
-Net::HTTP.prepend(NetHttpLogger)
 
-if defined?(Rails)
 
-  if !Rails.respond_to?(:application) || (Rails.application && Rails.application.config)
-    # Rails2
-    Rails.configuration.after_initialize do
-      HttpLogger.logger = Rails.logger unless HttpLogger.logger
-    end
-  elsif defined?(ActiveSupport) && ActiveSupport.respond_to?(:on_load)
+Net::HTTP.class_eval(&block)
+
+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

data/spec/http_logger_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require "uri"
+require "base64"
 
 describe HttpLogger do
 
@@ -9,16 +10,18 @@ describe HttpLogger do
     f.close
     stub_request(:any, url).to_return(
       body: response_body,
-      headers: {"X-Http-logger" => true},
+      headers: {"X-Http-logger" => true, **response_headers},
     )
   end
 
   let(:response_body) { "Success" }
+  let(:response_headers) { {} }
+  let(:request_headers) { {} }
 
   let(:url) { "http://google.com/" }
   let(:uri) { URI.parse(url) }
   let(:request) do
-    Net::HTTP.get_response(uri)
+    Net::HTTP.get_response(uri, **request_headers)
   end
 
   let(:long_body) do
@@ -51,6 +54,15 @@ describe HttpLogger do
     it { should include("HTTP response header") }
     it { should include("HTTP request header") }
 
+
+    context "authorization header" do
+
+      let(:request_headers) do
+        {'Authorization' => "Basic #{Base64.encode64('hello:world')}".strip}
+      end
+      it { should include("Authorization: <filtered>") }
+    end
+
     after(:each) do
       HttpLogger.log_headers = false
     end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: http_logger
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Bogdan Gusiev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-01-27 00:00:00.000000000 Z
@@ -107,7 +107,7 @@ homepage: http://github.com/railsware/http_logger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Log your http api calls just like SQL queries
 test_files: []