samuel 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.yardoc
+/coverage
+/doc
+/pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009 Chris Kampmeier
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= Samuel
+
+Samuel is a gem for automatic logging of your Net::HTTP requests. It's named for
+the serial diarist Mr. Pepys, who was known to reliably record events both
+quotidian and remarkable.
+
+Should a Great Plague, Fire, or Whale befall an important external web service
+you use, you'll be sure to have a tidy record of it.
+
+== Usage in Rails:
+
+  # config/environment.rb
+  config.gem "samuel"
+
+That's about it! For now, Samuel automatically uses Rails' logger, and logs at
+the +INFO+ level using an ActiveRecord-like format. Failed requests log at the
++WARN+ level.
+
+== Usage in general:
+
+When Rails isn't loaded, you'll have to manually configure logging, like this:
+
+  require 'samuel'
+  Samuel.logger = Logger.new('http_requests.log')
+
+If you don't assign a logger, Samuel will configure a default logger on +STDOUT+.
+
+== License
+
+Copyright 2009 Chris Kampmeier. See +LICENSE+ for details.

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "samuel"
+    gem.summary = %Q{An automatic logger for HTTP requests in Ruby}
+    gem.description = %Q{An automatic logger for HTTP requests in Ruby. Adds Net::HTTP request logging to your Rails logs, and more.}
+    gem.email = "chris@kampers.net"
+    gem.homepage = "http://github.com/chrisk/samuel"
+    gem.authors = ["Chris Kampmeier"]
+    gem.rubyforge_project = "samuel"
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "yard"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "fakeweb"
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "yardoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+  test.warning = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.rcov_opts << "--sort coverage"
+    test.rcov_opts << "--exclude gems"
+    test.verbose = false
+    test.warning = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+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: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/samuel.rb

@@ -0,0 +1,33 @@
+require "logger"
+require "net/http"
+require "net/https"
+require "benchmark"
+
+require "samuel/net_http"
+require "samuel/request"
+
+
+module Samuel
+  extend self
+
+  def logger=(new_logger)
+    @logger = new_logger
+  end
+
+  def logger
+    return @logger if !@logger.nil?
+
+    if defined?(RAILS_DEFAULT_LOGGER)
+      @logger = RAILS_DEFAULT_LOGGER
+    else
+      @logger = Logger.new(STDOUT)
+    end
+  end
+
+  def log_request(http, request, &block)
+    request = Request.new(http, request, block)
+    request.execute_and_log!
+    request.response
+  end
+
+end

data/lib/samuel/net_http.rb

@@ -0,0 +1,10 @@
+class Net::HTTP
+
+  alias request_without_samuel request
+  def request(req, body = nil, &block)
+    Samuel.log_request(self, req) do
+      request_without_samuel(req, body, &block)
+    end
+  end
+
+end

data/lib/samuel/request.rb

@@ -0,0 +1,75 @@
+module Samuel
+  class Request
+
+    attr_accessor :response
+
+    def initialize(http, request, proc)
+      @http, @request, @proc = http, request, proc
+    end
+
+    def execute_and_log!
+      # If an exception is raised in the Benchmark block, it'll interrupt the
+      # benchmark. Instead, use an inner block to record it as the "response"
+      # for raising after the benchmark (and logging) is done.
+      @seconds = Benchmark.realtime do
+        begin; @response = @proc.call; rescue Exception => @response; end
+      end
+      Samuel.logger.add(log_level, log_message)
+      raise @response if @response.is_a?(Exception)
+    end
+
+    private
+
+    def log_message
+      bold      = "\e[1m"
+      blue      = "\e[34m"
+      underline = "\e[4m"
+      reset     = "\e[0m"
+      "  #{bold}#{blue}#{underline}HTTP request (#{milliseconds}ms) " +
+      "#{response_summary}#{reset}  #{method} #{uri}"
+    end
+
+    def milliseconds
+      (@seconds * 1000).round
+    end
+
+    def uri
+      "#{scheme}://#{@http.address}#{port_if_not_default}#{@request.path}"
+    end
+
+    def scheme
+      @http.use_ssl? ? "https" : "http"
+    end
+
+    def port_if_not_default
+      ssl, port = @http.use_ssl?, @http.port
+      if (!ssl && port == 80) || (ssl && port == 443)
+        ""
+      else
+        ":#{port}"
+      end
+    end
+
+    def method
+      @request.method.to_s.upcase
+    end
+
+    def response_summary
+      if response.is_a?(Exception)
+        response.class
+      else
+        "[#{response.code} #{response.message}]"
+      end
+    end
+
+    def log_level
+      error_classes = [Exception, Net::HTTPClientError, Net::HTTPServerError]
+      if error_classes.any? { |klass| response.is_a?(klass) }
+        level = Logger::WARN
+      else
+        level = Logger::INFO
+      end
+    end
+
+  end
+end

data/samuel.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{samuel}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kampmeier"]
+  s.date = %q{2009-09-11}
+  s.description = %q{An automatic logger for HTTP requests in Ruby. Adds Net::HTTP request logging to your Rails logs, and more.}
+  s.email = %q{chris@kampers.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/samuel.rb",
+     "lib/samuel/net_http.rb",
+     "lib/samuel/request.rb",
+     "samuel.gemspec",
+     "test/samuel_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/chrisk/samuel}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{samuel}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An automatic logger for HTTP requests in Ruby}
+  s.test_files = [
+    "test/samuel_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  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<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end

data/test/samuel_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class SamuelTest < Test::Unit::TestCase
+
+  context "making an HTTP request" do
+    setup    { setup_test_logger
+               FakeWeb.clean_registry }
+    teardown { teardown_test_logger }
+
+    context "to GET http://example.com/test, responding with a 200 in 53ms" do
+      setup do
+        FakeWeb.register_uri(:get, "http://example.com/test", :status => [200, "OK"])
+        Benchmark.stubs(:realtime).yields.returns(0.053)
+        open "http://example.com/test"
+      end
+
+      should_log_lines     1
+      should_log_at_level :info
+      should_log_including "HTTP request"
+      should_log_including "(53ms)"
+      should_log_including "[200 OK]"
+      should_log_including "GET http://example.com/test"
+    end
+
+    context "on a non-standard port" do
+      setup do
+        FakeWeb.register_uri(:get, "http://example.com:8080/test", :status => [200, "OK"])
+        open "http://example.com:8080/test"
+      end
+
+      should_log_including "GET http://example.com:8080/test"
+    end
+
+    context "with SSL" do
+      setup do
+        FakeWeb.register_uri(:get, "https://example.com/test", :status => [200, "OK"])
+        open "https://example.com/test"
+      end
+
+      should_log_including "HTTP request"
+      should_log_including "GET https://example.com/test"
+    end
+
+    context "with SSL on a non-standard port" do
+      setup do
+        FakeWeb.register_uri(:get, "https://example.com:80/test", :status => [200, "OK"])
+        open "https://example.com:80/test"
+      end
+
+      should_log_including "HTTP request"
+      should_log_including "GET https://example.com:80/test"
+    end
+
+    context "that raises" do
+      setup do
+        FakeWeb.register_uri(:get, "http://example.com/test", :exception => Errno::ECONNREFUSED)
+        begin
+          Net::HTTP.start("example.com") { |http| http.get("/test") }
+        rescue Errno::ECONNREFUSED => @exception
+        end
+      end
+
+      should_log_at_level    :warn
+      should_log_including   "HTTP request"
+      should_log_including   "GET http://example.com/test"
+      should_log_including   "Errno::ECONNREFUSED"
+      should_log_including   %r|\d+ms|
+      should_raise_exception Errno::ECONNREFUSED
+    end
+
+    context "that responds with a 500-level code" do
+      setup do
+        FakeWeb.register_uri(:get, "http://example.com/test", :status => [502, "Bad Gateway"])
+        Net::HTTP.start("example.com") { |http| http.get("/test") }
+      end
+
+      should_log_at_level :warn
+    end
+
+    context "that responds with a 400-level code" do
+      setup do
+        FakeWeb.register_uri(:get, "http://example.com/test", :status => [404, "Not Found"])
+        Net::HTTP.start("example.com") { |http| http.get("/test") }
+      end
+
+      should_log_at_level :warn
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'open-uri'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'samuel'
+
+class Test::Unit::TestCase
+  TEST_LOG_PATH = File.join(File.dirname(__FILE__), 'test.log')
+
+  def self.should_log_lines(expected_count)
+    should "log #{expected_count} line#{'s' unless expected_count == 1}" do
+      lines = File.readlines(TEST_LOG_PATH)
+      assert_equal expected_count, lines.length
+    end
+  end
+
+  def self.should_log_including(what)
+    should "log a line including #{what.inspect}" do
+      contents = File.read(TEST_LOG_PATH)
+      if what.is_a?(Regexp)
+        assert_match what, contents
+      else
+        assert contents.include?(what)
+      end
+    end
+  end
+
+  def self.should_log_at_level(level)
+    level = level.to_s.upcase
+    should "log at the #{level} level" do
+      assert File.read(TEST_LOG_PATH).include?("  #{level} -- :")
+    end
+  end
+
+  def self.should_raise_exception(klass)
+    should "raise an #{klass} exception" do
+      assert @exception.is_a?(klass)
+    end
+  end
+
+  def setup_test_logger
+    FileUtils.rm_rf TEST_LOG_PATH
+    FileUtils.touch TEST_LOG_PATH
+    Samuel.logger = Logger.new(TEST_LOG_PATH)
+  end
+
+  def teardown_test_logger
+    FileUtils.rm_rf TEST_LOG_PATH
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: samuel
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Kampmeier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An automatic logger for HTTP requests in Ruby. Adds Net::HTTP request logging to your Rails logs, and more.
+email: chris@kampers.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/samuel.rb
+- lib/samuel/net_http.rb
+- lib/samuel/request.rb
+- samuel.gemspec
+- test/samuel_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/chrisk/samuel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: samuel
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An automatic logger for HTTP requests in Ruby
+test_files: 
+- test/samuel_test.rb
+- test/test_helper.rb