http_logger 0.2.5 → 0.3.0

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 
 group :development do
+  gem "debugger", :platform => "ruby_19"
   gem "rspec"
   gem "bundler"
   gem "jeweler"

data/Gemfile.lock

@@ -1,6 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    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)
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
     git (1.2.5)
@@ -27,6 +35,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  debugger
   fakeweb
   jeweler
   rspec

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.0

data/http_logger.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "http_logger"
-  s.version = "0.2.5"
+  s.name = %q{http_logger}
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-01-21"
-  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.date = %q{2013-02-12}
+  s.description = %q{This gem keep an eye on every Net::HTTP library usage and dump all request and response data to the log file}
+  s.email = %q{agresso@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt"
   ]
@@ -32,27 +32,30 @@ Gem::Specification.new do |s|
     "spec/http_logger_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/bogdan/http_logger"
+  s.homepage = %q{http://github.com/bogdan/http_logger}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "Log your http api calls just like SQL queries"
+  s.rubygems_version = %q{1.6.0}
+  s.summary = %q{Log your http api calls just like SQL queries}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     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"])
     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"])
     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"])

data/lib/http_logger.rb

@@ -7,8 +7,8 @@ require "uri"
 #
 # == Setup logger
 #
-#    Net::HTTP.logger = Logger.new('/tmp/all.log')
-#    Net::HTTP.log_headers = true
+#    HttpLogger.logger = Logger.new('/tmp/all.log')
+#    HttpLogger.log_headers = true
 #
 # == Do request
 #
@@ -16,10 +16,13 @@ require "uri"
 #       http.request(req)
 #     }
 #     ...
-
-class Net::HTTP
-
+#
+# == View the log
+#
+#     cat /tmp/all.log
+class HttpLogger
   class << self
+    attr_accessor :collapse_body_limit
     attr_accessor :log_headers
     attr_accessor :logger
     attr_accessor :colorize
@@ -27,17 +30,26 @@ class Net::HTTP
 
   self.log_headers = false
   self.colorize = true
+  self.collapse_body_limit = 5000
 
+  def self.perform(*args, &block)
+    instance.perform(*args, &block)
+  end
 
-  alias_method :request_without_logging,  :request
+  def self.instance
+    @instance ||= HttpLogger.new
+  end
 
-  def request(request, body = nil, &block)
+  def self.deprecate_config(option)
+    warn "Net::HTTP.#{option} is deprecated. Use HttpLogger.#{option} instead."
+  end
+
+  def perform(http, request, request_body)
     time = Time.now
-    response = request_without_logging(request, body, &block)
-    response
+    response = yield
   ensure
-    if self.require_logging?(request)
-      url = "http#{"s" if self.use_ssl?}://#{self.address}:#{self.port}#{request.path}"
+    if self.require_logging?(http, request)
+      url = "http#{"s" if http.use_ssl?}://#{http.address}:#{http.port}#{request.path}"
       ofset = Time.now - time
       log("HTTP #{request.method} (%0.2fms)" % (ofset * 1000), URI.decode(url))
       request.each_capitalized { |k,v| log("HTTP request header", "#{k}: #{v}") } if self.class.log_headers
@@ -48,24 +60,31 @@ class Net::HTTP
         log("Response status", "#{response.class} (#{response.code})")
         response.each_capitalized { |k,v| log("HTTP response header", "#{k}: #{v}") } if self.class.log_headers
         body = response.body
-        log("Response body", body) unless body.is_a?(Net::ReadAdapter)
+        unless body.is_a?(Net::ReadAdapter)
+          if collapse_body_limit && collapse_body_limit > 0 && body.size >= collapse_body_limit
+            body = body[0..1000] + "\n\n<some data truncated>\n\n" + body[(body.size - 1000)..body.size]
+          end
+          log("Response body", body)
+        else
+          log("response body", "<impossible to log>")
+        end
       end
     end
   end
 
-  def require_logging?(request)
+  protected
+  def require_logging?(http, request)
     fakeweb = if defined?(::FakeWeb)
-                uri = ::FakeWeb::Utility.request_uri_as_string(self, request)
+                uri = ::FakeWeb::Utility.request_uri_as_string(http, request)
                 method = request.method.downcase.to_sym
                 ::FakeWeb.registered_uri?(method, uri)
               else
                 false
               end
-    self.logger && (self.started? || fakeweb)
+    self.logger && (http.started? || fakeweb)
   end
 
 
-  protected
   def log(message, dump)
     self.logger.debug(format_log_entry(message, dump))
   end
@@ -85,20 +104,50 @@ class Net::HTTP
     self.class.logger
   end
 
+  def collapse_body_limit
+    self.class.collapse_body_limit
+  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
+
+  def request(request, body = nil, &block)
+    HttpLogger.perform(self, request, body) do
+      request_without_logging(request, body, &block) 
+    end
+  end
+
+end
 
 if defined?(Rails)
 
   if !Rails.respond_to?(:application) || (Rails.application && Rails.application.config)
     # Rails2
     Rails.configuration.after_initialize do
-      Net::HTTP.logger = Rails.logger
+      HttpLogger.logger = Rails.logger
     end
   elsif defined?(ActiveSupport) && ActiveSupport.respond_to?(:on_load)
     # Rails3
     ActiveSupport.on_load(:after_initialize) do
-      Net::HTTP.logger = Rails.logger
+      HttpLogger.logger = Rails.logger
     end
   end
 end

data/spec/http_logger_spec.rb

@@ -1,8 +1,7 @@
 require 'spec_helper'
-require 'fakeweb'
 require "uri"
 
-describe "HttpLogger" do
+describe HttpLogger do
 
   before do
     # flush log
@@ -17,6 +16,7 @@ describe "HttpLogger" do
   end
 
   subject do
+    _context if defined?(_context)
     request
     File.read(LOGFILE)
   end
@@ -34,14 +34,14 @@ describe "HttpLogger" do
   context "when headers logging is on" do
 
     before(:each) do
-      Net::HTTP.log_headers = true
+      HttpLogger.log_headers = true
     end
 
     it { should include("HTTP response header") }
     it { should include("HTTP request header") }
 
     after(:each) do
-      Net::HTTP.log_headers = false
+      HttpLogger.log_headers = false
     end
     
   end
@@ -65,4 +65,22 @@ describe "HttpLogger" do
     it {should include("a=hello&b=1")}
     it {should include("PUT params")}
   end
+
+  context "with long response body" do
+
+    let(:body) do
+      "12,Dodo case,dodo@case.com,tech@dodcase.com,single elimination\n" * 50 +
+        "12,Bonobos,bono@bos.com,tech@bonobos.com,double elimination\n" * 50
+    end
+
+    let(:url) do
+      FakeWeb.register_uri(:get, "http://github.com", :body => body)
+      "http://github.com"
+    end
+
+    it { should include("12,Dodo case,dodo@case.com,tech@dodcase.com,single elimination\n")}
+    it { should include("<some data truncated>") }
+    it { should include("12,Bonobos,bono@bos.com,tech@bonobos.com,double elimination\n")}
+
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'fakeweb'
 require 'http_logger'
 require "logger"
 require "fileutils"
@@ -14,6 +15,6 @@ RSpec.configure do |config|
 
 
   FileUtils.rm_f(LOGFILE)
-  Net::HTTP.logger = Logger.new(LOGFILE)
+  HttpLogger.logger = Logger.new(LOGFILE)
   
 end

metadata

@@ -1,88 +1,102 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: http_logger
-version: !ruby/object:Gem::Version
-  version: 0.2.5
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
-authors:
+authors: 
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-02-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  prerelease: false
+  name: debugger
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  prerelease: false
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  prerelease: false
   name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  prerelease: false
   name: fakeweb
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    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
+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
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
-files:
+files: 
 - .document
 - .rspec
 - Gemfile
@@ -98,32 +112,39 @@ files:
 - screenshots/solr.png
 - spec/http_logger_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/bogdan/http_logger
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 544667989649191470
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: Log your http api calls just like SQL queries
 test_files: []
+