log-me 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9341d345fdaea0e92971d20b2ecb4d339d3040f
-  data.tar.gz: 38aab7a27f126a223968cfde1a6153a21e88f01f
+  metadata.gz: cb5839bd443aebe30a0038d2722d887d4db1a499
+  data.tar.gz: 2814475e21a754d7934eba90fa49a9cb27b47ade
 SHA512:
-  metadata.gz: 44c0f529ec28f735bc7c63aa3293facf587a360f57770f52d3e173fac13eca39cba0df29c0bb8305ccbdd871ec38b3194d1fcd8f0774eb2df083ea06029820ee
-  data.tar.gz: d66794d8cd55d822b9efb9b82e86dc7e8aafc6023c8c2763505f7204659eed943eed55534282f890d69bcef42e6060ec0b712f95235acd2b52eccdcb30cc0db3
+  metadata.gz: 9307159a7b9e4c9b39aa2edcf7e000ba66880d5f662577cd166d1f8d7c0ed147de7b760b3e9eda2ea218a36256d3632d1eccebddaf41d276e21ebe23b0641b96
+  data.tar.gz: fee25615f75c5c540fa26c792e3a268adc1b598e356ab327f66a17611aafdf4f94251716bd2be5902c6a563f911a96b8037c4c56022783abfdd90b3a3753bb5a

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== Version 0.0.6
+- New: Log formatted request and response messages from Net::HTTP.
+
 == Version 0.0.5
 - Warning: Minimal required Ruby version from now is 1.9.3.
 - New: Label to log messages.

data/README.rdoc

@@ -2,7 +2,7 @@
 
 A simple way to configure log in your gem.
 
-LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses.
+LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses (using Net::HTTP).
 
 == Instalation
 
@@ -24,7 +24,7 @@ In your gem:
   module CoolGem
     class SomeClass
       def do_something
-        # do something and log
+        # Do something and log
         CoolGem.log "I am logging something here."
       end
     end
@@ -37,6 +37,34 @@ Using your gem:
 By default will be logged in STDOUT using log level :info:
   I, [2011-08-24T01:22:52.677395 #3026]  INFO -- : [CoolGem] I am logging something here.
 
+Logging Net::HTTP requests and responses:
+  module CoolGem
+    class WebService
+      def do_something
+        url = "http://prodis.blog.br"
+
+        # Some logic to create a Net::HTTP request class.
+        request = create_request
+        CoolGem.log_request request, url
+
+        # Some logic to obtain a Net::HTTP response.
+        response = do_request(request, url)
+        CoolGem.log_response response
+      end
+    end
+  end
+
+  ws = CoolGem::WebService.new
+  ws.do_something
+
+In the log:
+  [CoolGem] Request:
+  POST http://prodis.blog.br/some_resource
+  param1=value1&param2=value2
+
+  [CoolGem] Response:
+  HTTP/1.1 201 Created
+
 Your gem consumer can configure the logger:
   CoolGem.configure do |config|
     config.log_enabled = false     # Disable log
@@ -45,6 +73,7 @@ Your gem consumer can configure the logger:
     config.logger = Rails.logger   # Use the Rails logger
   end
 
+
 == Author
 - {Fernando Hamasaki de Amorim (prodis)}[http://prodis.blog.br]
 

data/lib/log-me.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'logme/configuration'
+require 'logme/net_http_formatter'
 
 module LogMe
   attr_writer :log_enabled
@@ -27,7 +28,21 @@ module LogMe
     logger.send log_level, "[#{log_label}] #{message}\n" if log_enabled?
   end
 
+  def log_request(request, url)
+    log formatter.format_request(request, url)
+  end
+
+  def log_response(response)
+    log formatter.format_response(response)
+  end
+
   def self.extended(base)
     base.send :extend, LogMe::Configuration
   end
+
+  private
+
+  def formatter
+    @formatter ||= LogMe::NetHttpFormatter.new
+  end
 end

data/lib/logme/net_http_formatter.rb

@@ -0,0 +1,28 @@
+module LogMe
+  class NetHttpFormatter
+    def format_request(request, url)
+      message = format_message(request) do
+        message =  with_line_break { "Request:" }
+        message << with_line_break { "#{request.method} #{url}" }
+      end
+    end
+
+    def format_response(response)
+      message = format_message(response) do
+        message =  with_line_break { "Response:" }
+        message << with_line_break { "HTTP/#{response.http_version} #{response.code} #{response.message}" }
+      end
+    end
+
+    private
+
+    def format_message(http)
+      message = yield
+      message << with_line_break { http.body }
+    end
+
+    def with_line_break
+      "#{yield}\n"
+    end
+  end
+end

data/lib/logme/version.rb

@@ -1,3 +1,3 @@
 module LogMe
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/log-me_spec.rb

@@ -129,4 +129,35 @@ describe LogMe do
       end
     end
   end
+
+  describe "#log_request" do
+    let(:log_stream) { StringIO.new }
+    let(:request)    { double "Request" }
+    let(:url)        { "http://prodis.blog.br" }
+
+    before do
+      subject.configure { |config| config.logger = ::Logger.new(log_stream) }
+    end
+
+    it "logs formatted request message" do
+      LogMe::NetHttpFormatter.any_instance.stub(:format_request).with(request, url).and_return("Request message.")
+      subject.log_request(request, url)
+      expect(log_stream.string).to include "[#{subject.name}] Request message.\n"
+    end
+  end
+
+  describe "#log_response" do
+    let(:log_stream) { StringIO.new }
+    let(:response)   { double "Response" }
+
+    before do
+      subject.configure { |config| config.logger = ::Logger.new(log_stream) }
+    end
+
+    it "logs formatted response message" do
+      LogMe::NetHttpFormatter.any_instance.stub(:format_response).with(response).and_return("Response message.")
+      subject.log_response response
+      expect(log_stream.string).to include "[#{subject.name}] Response message.\n"
+    end
+  end
 end

data/spec/logme/net_http_formatter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe LogMe::NetHttpFormatter do
+  describe "#format_request" do
+    let(:request) do
+      double "Net::HTTP::Post", method: "POST", body: "param1=value1&param2=value2"
+    end
+    let(:url) { "http://prodis.blog.br" }
+
+    it "formats request message" do
+      expected_message = "Request:\nPOST #{url}\nparam1=value1&param2=value2\n"
+      expect(subject.format_request(request, url)).to eq expected_message
+    end
+  end
+
+  describe "#format_response" do
+    let(:response) do
+      double "Net::HTTP::OK", http_version: "1.1", code: "200", message: "OK", body: "<xml><fake />"
+    end
+
+    it "formats response message" do
+      expected_message = "Response:\nHTTP/1.1 200 OK\n<xml><fake />\n"
+      expect(subject.format_response(response)).to eq expected_message
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log-me
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Prodis a.k.a. Fernando Hamasaki de Amorim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -69,9 +69,11 @@ files:
 - Rakefile
 - lib/log-me.rb
 - lib/logme/configuration.rb
+- lib/logme/net_http_formatter.rb
 - lib/logme/version.rb
 - log-me.gemspec
 - spec/log-me_spec.rb
+- spec/logme/net_http_formatter_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/prodis/log-me
 licenses:
@@ -99,4 +101,5 @@ specification_version: 4
 summary: A simple way to configure log in your gem.
 test_files:
 - spec/log-me_spec.rb
+- spec/logme/net_http_formatter_spec.rb
 - spec/spec_helper.rb