samuel 0.3.2 → 0.3.3

data/.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 .yardoc
+Gemfile.lock
 /coverage
 /doc
 /pkg

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+gemspec
+
+platforms :jruby do
+  gem "jruby-openssl"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2009–2010 Chris Kampmeier
+Copyright 2009–2011 Chris Kampmeier
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -12,13 +12,12 @@ automatically loading the correct logger for the HTTP client you're using.
 
 == Usage
 
-When Rails is loaded, Samuel configures a few things automatically. So all you
-need to do is this:
+If you're using Bundler, just add this to your Gemfile:
 
-  # config/environment.rb
-  config.gem "samuel"
+  gem "samuel", "~> 0.3"
 
-And Samuel will automatically use Rails's logger and an ActiveRecord-like format.
+When Rails is loaded, Samuel configures itself to use Rails's logger and an
+ActiveRecord-like format automatically, so you don't need to do anything else.
 
 For non-Rails projects, you'll have to manually configure logging, like this:
 
@@ -76,9 +75,9 @@ Right now, there are three configuration changes you can make in either style:
   these patterns as a substring by replacing the value with
   <tt>[FILTERED]</tt> in your logs. By default, no filtering is enabled.
 
-Samuel logs successful HTTP requests at the +INFO+ level; Failed requests log at
-the +WARN+ level. This isn't currently configurable, but it's on the list.
+Samuel logs successful HTTP requests at the +INFO+ level; Failed requests log
+at the +WARN+ level. This isn't currently configurable, but it's on the list.
 
 == License
 
-Copyright 2009–2010 Chris Kampmeier. See +LICENSE+ for details.
+Copyright 2009–2011 Chris Kampmeier. See +LICENSE+ for details.

data/Rakefile

@@ -1,6 +1,15 @@
 require 'rubygems'
 require 'rake'
 
+task :check_dependencies do
+  begin
+    require "bundler"
+  rescue LoadError
+    abort "Samuel uses Bundler to manage development dependencies. Install it with `gem install bundler`."
+  end
+  system("bundle check") || abort
+end
+
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -9,27 +18,7 @@ Rake::TestTask.new(:test) do |test|
   test.warning = true
 end
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "samuel"
-    gem.version = "0.3.2"
-    gem.summary = %Q{An automatic logger for HTTP requests in Ruby}
-    gem.description = %Q{An automatic logger for HTTP requests in Ruby, supporting the Net::HTTP and HTTPClient client libraries.}
-    gem.email = "chris@kampers.net"
-    gem.homepage = "http://github.com/chrisk/samuel"
-    gem.authors = ["Chris Kampmeier"]
-    gem.rubyforge_project = "samuel"
-    gem.add_development_dependency "shoulda"
-    gem.add_development_dependency "mocha"
-    gem.add_development_dependency "httpclient"
-    gem.add_development_dependency "fakeweb"
-  end
-
-  task :test => :check_dependencies
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+task :default => [:check_dependencies, :test]
 
 begin
   require 'rcov/rcovtask'
@@ -42,18 +31,10 @@ begin
     test.warning = true
   end
 rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: gem install rcov"
-  end
 end
 
-task :default => :test
-
 begin
   require 'yard'
   YARD::Rake::YardocTask.new
 rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: gem install yard"
-  end
 end

data/lib/samuel.rb

@@ -13,7 +13,7 @@ require "samuel/log_entries/net_http"
 module Samuel
   extend self
 
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 
   attr_writer :logger, :config
 
@@ -21,8 +21,8 @@ module Samuel
     @logger = nil if !defined?(@logger)
     return @logger if !@logger.nil?
 
-    if defined?(RAILS_DEFAULT_LOGGER)
-      @logger = RAILS_DEFAULT_LOGGER
+    if defined?(Rails) && Rails.respond_to?(:logger)
+      @logger = Rails.logger
     else
       @logger = Logger.new(STDOUT)
     end

data/lib/samuel/diary.rb

@@ -2,18 +2,22 @@ module Samuel
   module Diary
     extend self
 
-    def record_request(http, request, time_requested)
+    def record_request(http, request, time_requested = current_time)
       @requests ||= []
       @requests.push({:request => request, :time_requested => time_requested})
     end
 
-    def record_response(http, request, response, time_responded)
+    def record_response(http, request, response, time_responded = current_time)
       time_requested = @requests.detect { |r| r[:request] == request }[:time_requested]
       @requests.reject! { |r| r[:request] == request }
       log_request_and_response(http, request, response, time_requested, time_responded)
     end
 
-    private
+    def current_time
+      Time.now
+    end
+
+  private
 
     def log_request_and_response(http, request, response, time_started, time_ended)
       log_entry_class = case http.class.to_s
@@ -24,6 +28,5 @@ module Samuel
       log_entry = log_entry_class.new(http, request, response, time_started, time_ended)
       log_entry.log!
     end
-
   end
 end

data/lib/samuel/driver_patches/http_client.rb

@@ -1,6 +1,5 @@
 module Samuel
   module DriverPatches
-
     module HTTPClient
       def self.included(klass)
         methods_to_wrap = %w(initialize do_get_block do_get_stream)
@@ -19,7 +18,7 @@ module Samuel
         begin
           do_get_block_without_samuel(req, proxy, conn, &block)
         rescue Exception => e
-          Samuel::Diary.record_response(self, req, e, Time.now)
+          Samuel::Diary.record_response(self, req, e)
           raise
         end
       end
@@ -28,7 +27,7 @@ module Samuel
         begin
           do_get_stream_without_samuel(req, proxy, conn)
         rescue Exception => e
-          Samuel::Diary.record_response(self, req, e, Time.now)
+          Samuel::Diary.record_response(self, req, e)
           raise
         end
       end
@@ -39,16 +38,14 @@ module Samuel
         end
 
         def filter_request(request)
-          Samuel::Diary.record_request(@http_client_instance, request, Time.now)
+          Samuel::Diary.record_request(@http_client_instance, request)
         end
 
         def filter_response(request, response)
-          Samuel::Diary.record_response(@http_client_instance, request, response, Time.now)
+          Samuel::Diary.record_response(@http_client_instance, request, response)
           nil # this returns command symbols like :retry, etc.
         end
       end
     end
-
   end
 end
-

data/lib/samuel/driver_patches/net_http.rb

@@ -1,6 +1,5 @@
 module Samuel
   module DriverPatches
-
     module NetHTTP
       def self.included(klass)
         methods_to_wrap = %w(request connect)
@@ -11,16 +10,17 @@ module Samuel
       end
 
       def request_with_samuel(request, body = nil, &block)
-        Samuel::Diary.record_request(self, request, Time.now)
-
         response, exception_raised = nil, false
+        request_time = Samuel::Diary.current_time
+
         begin
           response = request_without_samuel(request, body, &block)
         rescue Exception => response
           exception_raised = true
         end
 
-        Samuel::Diary.record_response(self, request, response, Time.now)
+        Samuel::Diary.record_request(self, request, request_time)
+        Samuel::Diary.record_response(self, request, response)
 
         raise response if exception_raised
         response
@@ -32,11 +32,10 @@ module Samuel
         fake_request = Object.new
         def fake_request.path; ""; end
         def fake_request.method; "CONNECT"; end
-        Samuel::Diary.record_request(self, fake_request, Time.now)
-        Samuel::Diary.record_response(self, fake_request, response, Time.now)
+        Samuel::Diary.record_request(self, fake_request)
+        Samuel::Diary.record_response(self, fake_request, response)
         raise
       end
     end
-
   end
 end

data/lib/samuel/loader.rb

@@ -14,6 +14,5 @@ module Samuel
         apply_driver_patches
       end
     end
-
   end
-end
+end

data/lib/samuel/log_entries/base.rb

@@ -1,6 +1,5 @@
 module Samuel
   module LogEntries
-
     class Base
       def initialize(http, request, response, time_requested, time_responded)
         @http, @request, @response = http, request, response
@@ -11,8 +10,7 @@ module Samuel
         Samuel.logger.add(log_level, log_message)
       end
 
-
-      protected
+    protected
 
       def log_message
         bold      = "\e[1m"
@@ -73,6 +71,5 @@ module Samuel
         end
       end
     end
-
   end
-end
+end

data/lib/samuel/log_entries/http_client.rb

@@ -1,6 +1,5 @@
 module Samuel
   module LogEntries
-
     class HttpClient < Base
       extend Forwardable
 
@@ -23,6 +22,5 @@ module Samuel
         @response.is_a?(Exception) || @response.status.to_s =~ /^(4|5)/
       end
     end
-
   end
 end

data/lib/samuel/log_entries/net_http.rb

@@ -1,6 +1,5 @@
 module Samuel
   module LogEntries
-
     class NetHttp < Base
       def host
         @http.address
@@ -40,6 +39,5 @@ module Samuel
         (error_classes & response_ancestors).any?
       end
     end
-  
   end
 end

data/samuel.gemspec

@@ -1,15 +1,12 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 Gem::Specification.new do |s|
   s.name = %q{samuel}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Kampmeier"]
-  s.date = %q{2010-01-12}
+  s.date = %q{2011-11-10}
   s.description = %q{An automatic logger for HTTP requests in Ruby, supporting the Net::HTTP and HTTPClient client libraries.}
   s.email = %q{chris@kampers.net}
   s.extra_rdoc_files = [
@@ -19,6 +16,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "Gemfile",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -52,27 +50,13 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "test/thread_test.rb"
   ]
+  s.specification_version = 3
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-      s.add_development_dependency(%q<httpclient>, [">= 0"])
-      s.add_development_dependency(%q<fakeweb>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<httpclient>, [">= 0"])
-      s.add_dependency(%q<fakeweb>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<httpclient>, [">= 0"])
-    s.add_dependency(%q<fakeweb>, [">= 0"])
-  end
+  s.add_development_dependency("shoulda", ["2.11.3"])
+  s.add_development_dependency("mocha", ["0.10.0"])
+  s.add_development_dependency("httpclient", ["2.2.3"])
+  s.add_development_dependency("fakeweb", ["~> 1.3"])
+  s.add_development_dependency("rcov", ["0.9.11"])
+  s.add_development_dependency("yard", ["0.7.3"])
+  s.add_development_dependency("rake", ["0.9.2.2"])
 end
-

data/test/http_client_test.rb

@@ -10,7 +10,7 @@ class HttpClientTest < Test::Unit::TestCase
     context "to GET http://localhost:8000/, responding with a 200 in 53ms" do
       setup do
         now = Time.now
-        Time.stubs(:now).returns(now, now + 0.053)
+        Samuel::Diary.stubs(:current_time).returns(now, now + 0.053)
         HTTPClient.get("http://localhost:8000/")
       end
 
@@ -63,6 +63,7 @@ class HttpClientTest < Test::Unit::TestCase
           client = HTTPClient.new
           connection = client.get_async("http://localhost:8001/")
           sleep 0.1 until connection.finished?
+          connection.pop
         rescue Errno::ECONNREFUSED => @exception
         end
       end
@@ -93,5 +94,4 @@ class HttpClientTest < Test::Unit::TestCase
       should_log_including "[500 Internal Server Error]"
     end
   end
-
 end

data/test/loader_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class LoaderTest < Test::Unit::TestCase
-
   def capture_output(code = "")
     requires = @requires.map { |lib| "require '#{lib}';" }.join(' ')
     samuel_dir = "#{File.dirname(__FILE__)}/../lib"
@@ -59,5 +58,4 @@ class LoaderTest < Test::Unit::TestCase
       end
     end
   end
-
 end

data/test/net_http_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class RequestTest < Test::Unit::TestCase
-
   context "making an HTTP request" do
     setup    { setup_test_logger
                FakeWeb.clean_registry
@@ -12,7 +11,7 @@ class RequestTest < Test::Unit::TestCase
       setup do
         FakeWeb.register_uri(:get, "http://example.com/test", :status => [200, "OK"])
         now = Time.now
-        Time.stubs(:now).returns(now, now + 0.053)
+        Samuel::Diary.stubs(:current_time).returns(now, now + 0.053)
         open "http://example.com/test"
       end
 
@@ -221,5 +220,4 @@ class RequestTest < Test::Unit::TestCase
       should_log_including "HTTP request"
     end
   end
-
 end

data/test/samuel_test.rb

@@ -1,13 +1,10 @@
 require 'test_helper'
 
 class SamuelTest < Test::Unit::TestCase
-
   context "logger configuration" do
     setup do
       Samuel.logger = nil
-      if Object.const_defined?(:RAILS_DEFAULT_LOGGER)
-        Object.send(:remove_const, :RAILS_DEFAULT_LOGGER)
-      end
+      Object.send(:remove_const, :Rails) if Object.const_defined?(:Rails)
     end
 
     teardown do
@@ -15,7 +12,7 @@ class SamuelTest < Test::Unit::TestCase
     end
 
     context "when Rails's logger is available" do
-      setup { Object.const_set(:RAILS_DEFAULT_LOGGER, :mock_logger) }
+      setup { Object.const_set(:Rails, stub(:logger => :mock_logger)) }
 
       should "use the same logger" do
         assert_equal :mock_logger, Samuel.logger
@@ -30,7 +27,6 @@ class SamuelTest < Test::Unit::TestCase
     end
   end
 
-
   context ".reset_config" do
     should "reset the config to default vaules" do
       Samuel.config = {:foo => "bar"}
@@ -38,5 +34,4 @@ class SamuelTest < Test::Unit::TestCase
       assert_equal({:label => nil, :labels => {}, :filtered_params => []}, Samuel.config)
     end
   end
-
 end

data/test/test_helper.rb

@@ -1,11 +1,11 @@
 require 'rubygems'
+require 'bundler'
+Bundler.setup
 
 require 'shoulda'
 require 'mocha'
-
 require 'net/http'
 require 'httpclient'
-
 require 'open-uri'
 require 'fakeweb'
 require 'webrick'
@@ -45,6 +45,7 @@ class Test::Unit::TestCase
 
   def self.should_raise_exception(klass)
     should "raise an #{klass} exception" do
+      @exception = nil if !defined?(@exception)
       assert @exception.is_a?(klass)
     end
   end

data/test/thread_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class ThreadTest < Test::Unit::TestCase
-
   context "when logging multiple requests at once" do
     setup do
       @log = StringIO.new
@@ -28,5 +27,4 @@ class ThreadTest < Test::Unit::TestCase
       end
     end
   end
-
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: samuel
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Chris Kampmeier
@@ -9,49 +15,121 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-12 00:00:00 -08:00
+date: 2011-11-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: httpclient
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 0
+        - 9
+        - 11
+        version: 0.9.11
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        - 3
+        version: 0.7.3
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id007
 description: An automatic logger for HTTP requests in Ruby, supporting the Net::HTTP and HTTPClient client libraries.
 email: chris@kampers.net
 executables: []
@@ -64,6 +142,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -92,21 +171,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: samuel
-rubygems_version: 1.3.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: An automatic logger for HTTP requests in Ruby