samuel 0.2.0 → 0.2.1

data/README.rdoc

@@ -29,7 +29,7 @@ If you don't assign a logger, Samuel will configure a default logger on +STDOUT+
 There are two ways to specify configuration options for Samuel: global and
 inline. Global configs look like this:
 
-  Samuel.config[:label]           = "Twitter API"
+  Samuel.config[:labels]          = {"example.com" => "Example API"}
   Samuel.config[:filtered_params] = :password
 
 You should put global configuration somewhere early-on in your program. If
@@ -42,12 +42,20 @@ configuration for a set of HTTP requests:
     Net::HTTP.start("twitter.com") { |http| http.get("/help/test") }
   end
 
-Right now, there are two configuration changes you can make in either style:
-
-* +:label+ - This is the very first part of each log entry, and it gets
-  <tt>"Request"</tt> appended to it. By default, it's <tt>"HTTP"</tt> -- but if
-  you want your log to say +Twitter API Request+ instead of the default +HTTP
-  Request+, set this to <tt>"Twitter API"</tt>.
+Right now, there are three configuration changes you can make in either style:
+
+* +:labels+ - This is a hash with domain substrings as keys and log labels as
+  values. If a request domain includes one of the domain substrings, the
+  corresponding label will be used for the first part of that log entry. By
+  default this is set to <tt>\{"" => "HTTP"}</tt>, so that all requests are
+  labeled with <tt>"HTTP Request"</tt>.
+* +:label+ - As an alternative to the +:labels+ hash, this is simply a string.
+  If set, it takes precedence over any +:labels+ (by default, it's not set). It
+  gets <tt>"Request"</tt> appended to it as well -- so if you want your log to
+  always say +Twitter API Request+ instead of the default +HTTP Request+, you
+  can set this to <tt>"Twitter API"</tt>. I'd recommend using this setting
+  globally if you're only making requests to one service, or inline if you just
+  need to temporarily override the global +:labels+.
 * +:filtered_params+ - This works just like Rails's +filter_parameter_logging+
   method. Set it to a symbol, string, or array of them, and Samuel will filter
   the value of query parameters that have any of these patterns as a substring

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/samuel.rb

@@ -29,7 +29,7 @@ module Samuel
 
   def log_request(http, request, &block)
     request = Request.new(http, request, block)
-    request.execute_and_log!
+    request.perform_and_log!
     request.response
   end
 
@@ -44,7 +44,7 @@ module Samuel
 
   def reset_config
     Thread.current[:__samuel_config] = nil
-    @config = {:label => "HTTP", :filtered_params => []}
+    @config = {:label => nil, :labels => {"" => "HTTP"}, :filtered_params => []}
   end
 
 end

data/lib/samuel/request.rb

@@ -7,7 +7,7 @@ module Samuel
       @http, @request, @proc = http, request, proc
     end
 
-    def execute_and_log!
+    def perform_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.
@@ -25,7 +25,6 @@ module Samuel
       blue      = "\e[34m"
       underline = "\e[4m"
       reset     = "\e[0m"
-      label     = Samuel.config[:label]
       "  #{bold}#{blue}#{underline}#{label} request (#{milliseconds}ms) " +
       "#{response_summary}#{reset}  #{method} #{uri}"
     end
@@ -69,6 +68,13 @@ module Samuel
       @request.method.to_s.upcase
     end
 
+    def label
+      return Samuel.config[:label] if Samuel.config[:label]
+
+      pair = Samuel.config[:labels].detect { |domain, label| @http.address.include?(domain) }
+      pair[1] if pair
+    end
+
     def response_summary
       if response.is_a?(Exception)
         response.class

data/samuel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{samuel}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Kampmeier"]
-  s.date = %q{2009-09-13}
+  s.date = %q{2009-09-15}
   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 = [

data/test/request_test.rb

@@ -96,7 +96,8 @@ class RequestTest < Test::Unit::TestCase
       end
 
       should_log_including "Example request"
-      should_have_config_afterwards_including :label => "HTTP"
+      should_have_config_afterwards_including :labels => {"" => "HTTP"},
+                                              :label  => nil
     end
 
     context "inside a configuration block with :filter_params" do
@@ -111,7 +112,7 @@ class RequestTest < Test::Unit::TestCase
         should_log_including "http://example.com/test?password=[FILTERED]&username=chrisk"
       end
 
-      context "=> :ass" do
+      context "=> :as" do
         setup { Samuel.with_config(:filtered_params => :ass) { open @uri } }
         should_log_including "http://example.com/test?password=[FILTERED]&username=chrisk"
       end
@@ -130,7 +131,8 @@ class RequestTest < Test::Unit::TestCase
       end
 
       should_log_including "Example request"
-      should_have_config_afterwards_including :label => "Example"
+      should_have_config_afterwards_including :labels => {"" => "HTTP"},
+                                              :label  => "Example"
     end
 
     context "with a global config including :label => 'Example' but inside config block that changes it to 'Example 2'" do
@@ -141,7 +143,8 @@ class RequestTest < Test::Unit::TestCase
       end
 
       should_log_including "Example 2 request"
-      should_have_config_afterwards_including :label => "Example"
+      should_have_config_afterwards_including :labels => {"" => "HTTP"},
+                                              :label  => "Example"
     end
 
     context "inside a config block of :label => 'Example 2' nested inside a config block of :label => 'Example'" do
@@ -155,13 +158,14 @@ class RequestTest < Test::Unit::TestCase
       end
 
       should_log_including "Example 2 request"
-      should_have_config_afterwards_including :label => "HTTP"
+      should_have_config_afterwards_including :labels => {"" => "HTTP"},
+                                              :label => nil
     end
 
-    context "wth a global config including :label => 'Example' but inside a config block of :label => 'Example 3' nested inside a config block of :label => 'Example 2'" do
+    context "wth a global config including :labels => {'example.com' => 'Example'} but inside a config block of :label => 'Example 3' nested inside a config block of :label => 'Example 2'" do
       setup do
         FakeWeb.register_uri(:get, "http://example.com/test", :status => [200, "OK"])
-        Samuel.config[:label] = "Example"
+        Samuel.config[:labels] = {'example.com' => 'Example'}
         Samuel.with_config :label => "Example 2" do
           Samuel.with_config :label => "Example 3" do
             open "http://example.com/test"
@@ -170,7 +174,18 @@ class RequestTest < Test::Unit::TestCase
       end
 
       should_log_including "Example 3 request"
-      should_have_config_afterwards_including :label => "Example"
+      should_have_config_afterwards_including :labels => {'example.com' => 'Example'},
+                                              :label  => nil
+    end
+
+    context "with a global config including :labels => {'example.com' => 'Example API'}" do
+      setup do
+        FakeWeb.register_uri(:get, "http://example.com/test", :status => [200, "OK"])
+        Samuel.config[:labels] = {'example.com' => 'Example API'}
+        open "http://example.com/test"
+      end
+
+      should_log_including "Example API request"
     end
 
   end

data/test/samuel_test.rb

@@ -35,7 +35,7 @@ class SamuelTest < Test::Unit::TestCase
     should "reset the config to default vaules" do
       Samuel.config = {:foo => "bar"}
       Samuel.reset_config
-      assert_equal({:label => "HTTP", :filtered_params => []}, Samuel.config)
+      assert_equal({:label => nil, :labels => {"" => "HTTP"}, :filtered_params => []}, Samuel.config)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: samuel
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Chris Kampmeier
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-13 00:00:00 -07:00
+date: 2009-09-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency