http_logger 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6ee341e7cf002e7155641272ce0e6518d9e42092
-  data.tar.gz: bf7be16847384cfbc8eb935708b70f9d388c19f5
+SHA256:
+  metadata.gz: 2ee612be76637a3fa5e75db03b7fa33a7016d3b4f509c32295580e002df73bd2
+  data.tar.gz: f7ef81b6d4c9d61dfa37626794a6bb725c1e83b36b29d824bf70bd5215bfb4e8
 SHA512:
-  metadata.gz: 5954d2a816a4014eaf113bc438c0be9e69ad95ad1afbe4b06f332aa87f6ce8c108e74b54c63013d0cd6942b070bef12394c0454f7214f3b436cda43b887d7ebc
-  data.tar.gz: 74e882cb119517efb27ae14b554054b09f5e7071e31d1375808d4cf976f29ebb54bcd4d5132edf6da47714ce2ee5f87d042abce22a66be48a8b3fee99b012721
+  metadata.gz: 9d81717a77786fb2bffb89c9cce68bc1f9ef8c6d4f2960a945324db0c53831cd8c78643e3c21779f1250cf862e2dcaa5a3d6610eb5fb934c2a15ed296225c416
+  data.tar.gz: 90132a5f50f91d39542f255680e577bd755254815df1f5332d71c73db76eadc2862a30d9b43dfc04e6cb50ce7aea30dc5143997c41a3c3cff07616eea342b285

data/Gemfile

@@ -1,10 +1,9 @@
 source "http://rubygems.org"
 
-
 group :development do
-  gem "debugger", :platform => "ruby_19"
+  gem "byebug"
+  gem "webmock"
   gem "rspec"
   gem "bundler"
   gem "jeweler"
-  gem "fakeweb"
 end

data/Gemfile.lock

@@ -1,79 +1,86 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.6)
-    atomic (1.1.16)
-    builder (3.2.2)
-    columnize (0.3.6)
-    debugger (1.2.1)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.1.1)
-      debugger-ruby_core_source (~> 1.1.4)
-    debugger-linecache (1.1.2)
-      debugger-ruby_core_source (>= 1.1.1)
-    debugger-ruby_core_source (1.1.4)
+    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.1.3)
-    fakeweb (1.3.0)
-    faraday (0.9.0)
+    diff-lcs (1.3)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    git (1.2.6)
-    github_api (0.11.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
+    git (1.5.0)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
-      oauth2
-    hashie (2.0.5)
-    highline (1.6.21)
-    jeweler (2.0.1)
+      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 (>= 1.0)
+      bundler
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.16.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
+      psych
       rake
       rdoc
-    json (1.8.1)
-    jwt (0.1.11)
-      multi_json (>= 1.5)
-    mini_portile (0.5.3)
-    multi_json (1.9.2)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.1)
-      mini_portile (~> 0.5.0)
-    oauth2 (0.9.3)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 0.1.8)
+      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)
-    rack (1.5.2)
-    rake (10.2.2)
-    rdoc (4.1.1)
-      json (~> 1.4)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    thread_safe (0.3.1)
-      atomic (>= 1.1.7, < 2)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      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)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
-  debugger
-  fakeweb
+  byebug
   jeweler
   rspec
+  webmock
+
+BUNDLED WITH
+   2.0.1

data/Readme.md

@@ -27,6 +27,7 @@ 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
 ```
 
 ## Alternative

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/http_logger.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: http_logger 0.5.1 ruby lib
+# stub: http_logger 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "http_logger"
-  s.version = "0.5.1"
+  s.name = "http_logger".freeze
+  s.version = "0.6.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Bogdan Gusiev"]
-  s.date = "2014-11-07"
-  s.description = "This gem keep an eye on every Net::HTTP library usage and dump all request and response data to the log file"
-  s.email = "agresso@gmail.com"
+  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"
   ]
@@ -34,33 +34,33 @@ Gem::Specification.new do |s|
     "spec/http_logger_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/railsware/http_logger"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "Log your http api calls just like SQL queries"
+  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<debugger>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      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<debugger>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<fakeweb>, [">= 0"])
+      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<debugger>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<fakeweb>, [">= 0"])
+    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
 

data/lib/http_logger.rb

@@ -77,7 +77,7 @@ class HttpLogger
   end
 
   def request_url(http, request)
-    URI.decode("http#{"s" if http.use_ssl?}://#{http.address}:#{http.port}#{request.path}")
+    URI::DEFAULT_PARSER.unescape("http#{"s" if http.use_ssl?}://#{http.address}:#{http.port}#{request.path}")
   end
 
   def log_request_headers(request)
@@ -87,7 +87,7 @@ class HttpLogger
   end
 
   HTTP_METHODS_WITH_BODY = Set.new(%w(POST PUT GET PATCH))
-  
+
   def log_request_body(request)
     if self.class.log_request_body
       if HTTP_METHODS_WITH_BODY.include?(request.method)
@@ -103,13 +103,13 @@ class HttpLogger
   end
 
   def log_response_headers(response)
-    if self.class.log_headers
+    if HttpLogger.log_headers
       response.each_capitalized { |k,v| log("HTTP response header", "#{k}: #{v}") }
     end
   end
 
   def log_response_body(body)
-    if self.class.log_response_body
+    if HttpLogger.log_response_body
       if body.is_a?(Net::ReadAdapter)
         log("Response body", "<impossible to log>")
       else
@@ -126,23 +126,40 @@ class HttpLogger
 
   def ignored?(http, request)
     url = request_url(http, request)
-    self.class.ignore.any? do |pattern|
+    HttpLogger.ignore.any? do |pattern|
       url =~ pattern
     end
   end
 
   def fakeweb?(http, request)
-    return false unless defined?(::FakeWeb)
-    uri = ::FakeWeb::Utility.request_uri_as_string(http, request)
+    return false unless defined?(::WebMock)
+    uri = request_uri_as_string(http, request)
     method = request.method.downcase.to_sym
-    ::FakeWeb.registered_uri?(method, uri)
+    signature = WebMock::RequestSignature.new(method, uri)
+    ::WebMock.registered_request?(signature)
+  end
+
+  def request_uri_as_string(net_http, request)
+    protocol = net_http.use_ssl? ? "https" : "http"
+
+    path = request.path
+    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) + "@"
+    else
+      userinfo = ""
+    end
+
+    "#{protocol}://#{userinfo}#{net_http.address}:#{net_http.port}#{path}"
   end
 
   def truncate_body(body)
     if collapse_body_limit && collapse_body_limit > 0 && body && body.size >= collapse_body_limit
       body_piece_size = collapse_body_limit / 2
-      body[0..body_piece_size] + 
-        "\n\n<some data truncated>\n\n" + 
+      body[0..body_piece_size] +
+        "\n\n<some data truncated>\n\n" +
         body[(body.size - body_piece_size)..body.size]
     else
       body
@@ -173,33 +190,18 @@ class HttpLogger
   end
 end
 
-class Net::HTTP
-
-  def self.log_headers=(value)
-    HttpLogger.deprecate_config("log_headers")
-    HttpLogger.log_headers = value
-  end
-
-  def self.colorize=(value)
-    HttpLogger.deprecate_config("colorize")
-    HttpLogger.colorize = value
-  end
-
-  def self.logger=(value)
-    HttpLogger.deprecate_config("logger")
-    HttpLogger.logger = value
-  end
-
-
-  alias_method :request_without_logging,  :request
-
+module NetHttpLogger
   def request(request, body = nil, &block)
     HttpLogger.perform(self, request, body) do
-      request_without_logging(request, body, &block) 
+      super(request, body, &block)
     end
   end
+end
 
+if defined?(::WebMock)
+  WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get("@webMockNetHTTP").prepend(NetHttpLogger)
 end
+Net::HTTP.prepend(NetHttpLogger)
 
 if defined?(Rails)
 

data/spec/http_logger_spec.rb

@@ -7,8 +7,14 @@ 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},
+    )
   end
 
+  let(:response_body) { "Success" }
+
   let(:url) { "http://google.com/" }
   let(:uri) { URI.parse(url) }
   let(:request) do
@@ -33,7 +39,7 @@ describe HttpLogger do
     let(:url) { "http://google.com?query=a%20b"}
 
     it { subject.should include("query=a b")}
-    
+
   end
 
   context "when headers logging is on" do
@@ -48,7 +54,7 @@ describe HttpLogger do
     after(:each) do
       HttpLogger.log_headers = false
     end
-    
+
   end
 
   describe "post request" do
@@ -60,8 +66,8 @@ describe HttpLogger do
     it {should include("Request body")}
     it {should include("a=hello&b=1")}
     context "with too long body" do
+      let(:response_body) { long_body }
       let(:url) do
-        FakeWeb.register_uri(:post, "http://github.com", :body => long_body)
         "http://github.com/"
       end
       it { should include("12,Dodo case,dodo@case.com,tech@dodcase.com,single elimination\n")}
@@ -82,7 +88,7 @@ describe HttpLogger do
     it {should include("Request body")}
     it {should include("a=hello&b=1")}
   end
-  
+
   describe "generic request" do
     let(:request) do
       http = Net::HTTP.new(uri.host, uri.port)
@@ -114,8 +120,9 @@ describe HttpLogger do
 
   context "with long response body" do
 
+    let(:response_body) { long_body }
     let(:url) do
-      FakeWeb.register_uri(:get, "http://github.com", :body => long_body)
+      stub_request(:get, "http://github.com/").to_return(body: long_body)
       "http://github.com"
     end
 
@@ -131,8 +138,8 @@ describe HttpLogger do
       HttpLogger.log_response_body = false
     end
 
+    let(:response_body) { long_body }
     let(:url) do
-      FakeWeb.register_uri(:get, "http://github.com", :body => long_body)
       "http://github.com"
     end
 
@@ -145,14 +152,16 @@ describe HttpLogger do
 
   context "ignore option is set" do
 
-    let(:url) { "http://rpm.newrelic.com/hello/world"}
+    let(:url) do
+      "http://rpm.newrelic.com/hello/world"
+    end
 
     before(:each) do
       HttpLogger.ignore = [/rpm\.newrelic\.com/]
     end
 
     it { should be_empty}
-    
+
     after(:each) do
       HttpLogger.ignore = []
     end
@@ -160,14 +169,17 @@ describe HttpLogger do
 
   context "when level is set" do
 
-    let(:url) { "http://rpm.newrelic.com/hello/world"}
+    let(:url) do
+      stub_request(:get, "http://rpm.newrelic.com/hello/world").to_return(body: "")
+      "http://rpm.newrelic.com/hello/world"
+    end
 
     before(:each) do
       HttpLogger.level = :info
     end
 
     it { should_not be_empty }
-    
+
     after(:each) do
       HttpLogger.level = :debug
     end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'fakeweb'
+require 'webmock/rspec'
 require 'http_logger'
 require "logger"
 require "fileutils"
@@ -11,10 +11,9 @@ require "fileutils"
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 LOGFILE = 'http.log'
-RSpec.configure do |config|
-
 
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
   FileUtils.rm_f(LOGFILE)
   HttpLogger.logger = Logger.new(LOGFILE)
-  
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: http_logger
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Log your http api calls just like SQL queries