log-me 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: d6aab3c875f451d0b556d137f6cc4488db5a4301
-  data.tar.gz: 6924159042c08331818012de069b0fb0de150a82
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2FiMTg0YjYzM2M5NmVjNzBjYTc1NTNiMTQ2ZDg5MzM5ZGQzZDc3YQ==
+  data.tar.gz: !binary |-
+    MWZhOWRlMzJhNjg2MmUyYjE1NzIxOTU2OGQzMDNhMjI2ZjBlZjMyYQ==
 SHA512:
-  metadata.gz: ec348785adadcbe37d4bf5019d72b5bff11c3d54dd99beac56a02ad92b42155314ab1d88d4cd10faca4b58bdf9eefcf524102e225c1d3bf0b5027dc90785741f
-  data.tar.gz: d2a0f9c5ba60e6dffd276f4971b29af46015cbb8cfb8ed9c4632466c01c357307cfa1cf4d70f2b91c4a1ff1fef647a0f67a176b803b44de203d740a4e42c84b0
+  metadata.gz: !binary |-
+    ZmYyM2Q0NWQzNTZhY2QzZTFlNTNkM2Q2MDAzNWQ3MWFlMThkMDZlYjYwMmQx
+    OWZmY2Q4MWY1MDMxZTE3ZmU3ZTM3NGY5YmZjYWNlZTExMTY2YTAyMjNmYWY2
+    MWUxYjAyMzZlNmFkMzI4NDA1NjVhM2E4OTE1YzU1ZWU2MDA5NmU=
+  data.tar.gz: !binary |-
+    MjdiMmFiOTczNmVkOTc2NWM3ZjAwMTY1Yjg2YmEwOTVkMGZjZjNlYWZhMWIz
+    ZGUxZjhlZTg0MWEwZTU0NTI2ZWExNGUzNjBkYzhlNzM4NzkwODI1Zjg3NTA4
+    YTg2ZDM1YjA0MGE3YTRlZjAxY2YzM2M1NmFmYWZhMWMzZDMwNDU=

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.2
 script: bundle exec rspec

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== Version 0.0.9
+- New: Support to log RestClient requests and responses.
+
 == Version 0.0.8
 - Update: Adjust in log formatting.
 

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 (using Net::HTTP).
+LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses, using Net::HTTP or RestClient.
 
 {<img src="https://badge.fury.io/rb/log-me.png" alt="Gem Version" />}[http://badge.fury.io/rb/log-me]
 {<img src="https://travis-ci.org/prodis/log-me.png?branch=master" alt="Build Status" />}[https://travis-ci.org/prodis/log-me]
@@ -57,6 +57,30 @@ Logging Net::HTTP requests and responses:
         # Some logic to obtain a Net::HTTP response.
         response = do_request(request, url)
         CoolGem.log_response response
+
+        response
+      end
+    end
+  end
+
+  ws = CoolGem::WebService.new
+  ws.do_something
+
+Logging RestClient requests and responses:
+  module CoolGem
+    class WebService
+      def do_something
+        args = {
+          method: :post,
+          url: "http://prodis.blog.br",
+          payload: 'param1=value1&param2=value2'
+        }
+
+        RestClient::Request.execute(args) do |response, request, result|
+          CoolGem.log_request request, args[:url]
+          CoolGem.log_response result
+          response
+        end
       end
     end
   end

data/lib/log-me.rb

@@ -1,6 +1,7 @@
+# encoding: utf-8
 require 'logger'
 require 'logme/configuration'
-require 'logme/net_http_formatter'
+require 'logme/http_formatter'
 
 module LogMe
   attr_writer :log_enabled
@@ -21,11 +22,11 @@ module LogMe
   end
 
   def logger
-    @logger ||= ::Logger.new STDOUT
+    @logger ||= ::Logger.new(STDOUT)
   end
 
   def log(message)
-    logger.send log_level, "[#{log_label}] #{message}\n" if log_enabled?
+    logger.send(log_level, "[#{log_label}] #{message}") if log_enabled?
   end
 
   def log_request(request, url)
@@ -37,12 +38,12 @@ module LogMe
   end
 
   def self.extended(base)
-    base.send :extend, LogMe::Configuration
+    base.send(:extend, LogMe::Configuration)
   end
 
   private
 
   def formatter
-    @formatter ||= LogMe::NetHttpFormatter.new
+    @formatter ||= LogMe::HttpFormatter.new
   end
 end

data/lib/logme/configuration.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module LogMe
   module Configuration
     def configure

data/lib/logme/http_formatter.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module LogMe
+  class HttpFormatter
+    def format_request(request, url)
+      message = format_message(request) do
+        message =  with_line_break { 'Request:' }
+        message << with_line_break { "#{request.method.to_s.upcase} #{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
+      body = extract_body_from(http)
+      message << with_line_break { body } unless blank?(body)
+      message
+    end
+
+    def with_line_break
+      "#{yield}\n"
+    end
+
+    def extract_body_from(http)
+      return http.body if http.respond_to?(:body)
+      return http.args[:payload] if http.respond_to?(:args)
+      return nil
+    end
+
+    def blank?(text)
+      text.to_s.strip.empty?
+    end
+  end
+end

data/lib/logme/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module LogMe
-  VERSION = "0.0.8"
+  VERSION = '0.0.9'
 end

data/log-me.gemspec

@@ -2,26 +2,26 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'logme/version'
 
-Gem::Specification.new do |gem|
-  gem.name        = "log-me"
-  gem.version     = LogMe::VERSION
-  gem.authors     = ["Prodis a.k.a. Fernando Hamasaki de Amorim"]
-  gem.email       = ["prodis@gmail.com"]
-  gem.summary     = "A simple way to configure log in your gem."
-  gem.description = "LogMe is a simple way to configure log in your gem. It's especially useful when you need to log Web Service calls or HTTP requests and responses."
-  gem.homepage    = "http://github.com/prodis/log-me"
-  gem.licenses    = ["MIT"]
+Gem::Specification.new do |spec|
+  spec.name        = 'log-me'
+  spec.version     = LogMe::VERSION
+  spec.authors     = ['Prodis a.k.a. Fernando Hamasaki de Amorim']
+  spec.email       = ['prodis@gmail.com']
+  spec.summary     = 'A simple way to configure log in your spec.'
+  spec.description = 'LogMe is a simple way to configure log in your spec. It is especially useful when you need to log Web Service calls or HTTP requests and responses.'
+  spec.homepage    = 'http://github.com/prodis/log-me'
+  spec.licenses    = ['MIT']
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($\)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
-  gem.platform              = Gem::Platform::RUBY
-  gem.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = Gem::Requirement.new('>= 1.9.3')
 
-  gem.add_development_dependency "coveralls"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
 end

data/spec/log-me_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 module FakeModule
@@ -7,49 +8,49 @@ end
 describe LogMe do
   let(:subject) { FakeModule }
 
-  describe "#log_enabled?" do
-    it "default is true" do
+  describe '#log_enabled?' do
+    it 'default is true' do
       expect(subject).to be_log_enabled
     end
 
-    context "when log is disabled" do
+    context 'when log is disabled' do
       around do |example|
         subject.configure { |config| config.log_enabled = false }
         example.run
         subject.configure { |config| config.log_enabled = true }
       end
 
-      it "returns false" do
+      it 'returns false' do
         expect(subject).to_not be_log_enabled
       end
     end
   end
 
-  describe "#log_level" do
-    it "default is info" do
+  describe '#log_level' do
+    it 'default is info' do
       expect(subject.log_level).to eq :info
     end
 
-    context "when log level is set" do
+    context 'when log level is set' do
       around do |example|
         subject.configure { |config| config.log_level = :debug }
         example.run
         subject.configure { |config| config.log_level = :info }
       end
 
-      it "returns set level" do
+      it 'returns set level' do
         expect(subject.log_level).to eq :debug
       end
     end
   end
 
-  describe "#log_label" do
-    it "default is current module name" do
+  describe '#log_label' do
+    it 'default is current module name' do
       expect(subject.log_label).to eq subject.name
     end
 
-    context "when set label" do
-      let(:label) { "Prodis #15" }
+    context 'when set label' do
+      let(:label) { 'Prodis #15' }
 
       around do |example|
         subject.configure { |config| config.log_label = label }
@@ -57,19 +58,19 @@ describe LogMe do
         subject.configure { |config| config.log_label = subject.name }
       end
 
-      it "returns label" do
+      it 'returns label' do
         expect(subject.log_label).to eq label
       end
     end
   end
 
-  describe "#logger" do
-    it "default is Logger" do
+  describe '#logger' do
+    it 'default is Logger' do
       expect(subject.logger).to be_a(::Logger)
     end
 
-    context "when set logger" do
-      it "returns set logger" do
+    context 'when set logger' do
+      it 'returns set logger' do
         fake_logger = Class.new
         subject.configure { |config| config.logger = fake_logger }
         expect(subject.logger).to eq fake_logger
@@ -77,9 +78,9 @@ describe LogMe do
     end
   end
 
-  describe "#log" do
+  describe '#log' do
     let(:log_stream) { StringIO.new }
-    let(:label)      { "Cool Label" }
+    let(:label)      { 'Cool Label' }
 
     before do
       subject.configure { |config| config.logger = ::Logger.new(log_stream) }
@@ -91,71 +92,71 @@ describe LogMe do
       subject.configure { |config| config.log_label = subject.name }
     end
 
-    context "when log is enabled" do
-      it "logs the message" do
-        subject.log "Some message to log."
-        expect(log_stream.string).to include "[#{label}] Some message to log.\n"
+    context 'when log is enabled' do
+      it 'logs the message' do
+        subject.log 'Some message to log.'
+        expect(log_stream.string).to include "[#{label}] Some message to log."
       end
 
-      it "calls log level method" do
-        expect(subject.logger).to receive(:info).with("[#{label}] Some message to log.\n")
-        subject.log "Some message to log."
+      it 'calls log level method' do
+        expect(subject.logger).to receive(:info).with("[#{label}] Some message to log.")
+        subject.log 'Some message to log.'
       end
     end
 
-    context "when log is disabled" do
+    context 'when log is disabled' do
       around do |example|
         subject.configure { |config| config.log_enabled = false }
         example.run
         subject.configure { |config| config.log_enabled = true }
       end
 
-      it "does not log the message" do
-        subject.log "Some message to log."
+      it 'does not log the message' do
+        subject.log 'Some message to log.'
         expect(log_stream.string).to be_empty
       end
     end
 
-    context "when log level is set" do
+    context 'when log level is set' do
       around do |example|
         subject.configure { |config| config.log_level = :debug }
         example.run
         subject.configure { |config| config.log_level = :info }
       end
 
-      it "calls log level set method" do
-        expect(subject.logger).to receive(:debug).with("[#{label}] Some message to log.\n")
-        subject.log "Some message to log."
+      it 'calls log level set method' do
+        expect(subject.logger).to receive(:debug).with("[#{label}] Some message to log.")
+        subject.log 'Some message to log.'
       end
     end
   end
 
-  describe "#log_request" do
+  describe '#log_request' do
     let(:log_stream) { StringIO.new }
-    let(:request)    { double "Request" }
-    let(:url)        { "http://prodis.blog.br" }
+    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
-      allow_any_instance_of(LogMe::NetHttpFormatter).to receive(:format_request).with(request, url).and_return("Request message.")
+    it 'logs formatted request message' do
+      allow_any_instance_of(LogMe::HttpFormatter).to receive(: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
+  describe '#log_response' do
     let(:log_stream) { StringIO.new }
-    let(:response)   { double "Response" }
+    let(:response)   { double('Response') }
 
     before do
       subject.configure { |config| config.logger = ::Logger.new(log_stream) }
     end
 
-    it "logs formatted response message" do
-      allow_any_instance_of(LogMe::NetHttpFormatter).to receive(:format_response).with(response).and_return("Response message.")
+    it 'logs formatted response message' do
+      allow_any_instance_of(LogMe::HttpFormatter).to receive(:format_response).with(response).and_return('Response message.')
       subject.log_response response
       expect(log_stream.string).to include "[#{subject.name}] Response message.\n"
     end

data/spec/logme/http_formatter_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe LogMe::HttpFormatter do
+  describe '#format_request' do
+    context 'when request has body' do
+      let(:url) { 'http://prodis.blog.br' }
+
+      context 'and responds to body method' do
+        let(:request) do
+          double('Net::HTTP::Post', method: 'POST', body: 'param1=value1&param2=value2')
+        end
+
+        it 'formats request message including body' do
+          expected_message = "Request:\nPOST #{url}\nparam1=value1&param2=value2\n"
+          expect(subject.format_request(request, url)).to eq expected_message
+        end
+      end
+
+      context 'and responds to args method' do
+        let(:request) do
+          double('RestClient::Request', method: :post, args: { payload: 'param1=value1&param2=value2' })
+        end
+
+        it 'formats request message including body' do
+          expected_message = "Request:\nPOST #{url}\nparam1=value1&param2=value2\n"
+          expect(subject.format_request(request, url)).to eq expected_message
+        end
+      end
+    end
+
+    context 'when request does not have body' do
+      let(:url) { 'http://prodis.blog.br?s=logme+gem' }
+
+      context 'and responds to body method' do
+        let(:request) do
+          double('Net::HTTP::Get', method: 'GET', body: nil)
+        end
+
+        it 'formats request message without body' do
+          expected_message = "Request:\nGET #{url}\n"
+          expect(subject.format_request(request, url)).to eq expected_message
+        end
+      end
+
+      context 'and responds to args method' do
+        let(:request) do
+          double('RestClient::Request', method: :get, args: {})
+        end
+
+        it 'formats request message without body' do
+          expected_message = "Request:\nGET #{url}\n"
+          expect(subject.format_request(request, url)).to eq expected_message
+        end
+      end
+    end
+  end
+
+  describe '#format_response' do
+    context 'when response has body' 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
+
+    context 'when response does not have body' do
+      let(:response) do
+        double('Net::HTTP::OK', http_version: '1.1', code: '200', message: 'OK', body: nil)
+      end
+
+      it 'formats response message' do
+        expected_message = "Response:\nHTTP/1.1 200 OK\n"
+        expect(subject.format_response(response)).to eq expected_message
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'coveralls'
 require 'log-me'
 
@@ -7,5 +8,5 @@ Coveralls.wear!
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-  config.order = "random"
+  config.order = 'random'
 end

metadata

@@ -1,93 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: log-me
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Prodis a.k.a. Fernando Hamasaki de Amorim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: LogMe is a simple way to configure log in your gem. It's especially useful
-  when you need to log Web Service calls or HTTP requests and responses.
+        version: 3.1.0
+description: LogMe is a simple way to configure log in your spec. It is especially
+  useful when you need to log Web Service calls or HTTP requests and responses.
 email:
 - prodis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - README.rdoc
 - Rakefile
 - lib/log-me.rb
 - lib/logme/configuration.rb
-- lib/logme/net_http_formatter.rb
+- lib/logme/http_formatter.rb
 - lib/logme/version.rb
 - log-me.gemspec
 - spec/log-me_spec.rb
-- spec/logme/net_http_formatter_spec.rb
+- spec/logme/http_formatter_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/prodis/log-me
 licenses:
@@ -99,12 +99,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -112,8 +112,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A simple way to configure log in your gem.
+summary: A simple way to configure log in your spec.
 test_files:
 - spec/log-me_spec.rb
-- spec/logme/net_http_formatter_spec.rb
+- spec/logme/http_formatter_spec.rb
 - spec/spec_helper.rb

data/lib/logme/net_http_formatter.rb

@@ -1,33 +0,0 @@
-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 } if has_body?(http)
-      message
-    end
-
-    def with_line_break
-      "#{yield}\n"
-    end
-
-    def has_body?(http)
-      http.body && !http.body.strip.empty?
-    end
-  end
-end

data/spec/logme/net_http_formatter_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe LogMe::NetHttpFormatter do
-  describe "#format_request" do
-    context "when request has body" 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 including body" do
-        expected_message = "Request:\nPOST #{url}\nparam1=value1&param2=value2\n"
-        expect(subject.format_request(request, url)).to eq expected_message
-      end
-    end
-
-    context "when request does not have body" do
-      let(:request) do
-        double "Net::HTTP::Get", method: "GET", body: nil
-      end
-      let(:url) { "http://prodis.blog.br?s=logme+gem" }
-
-      it "formats request message without body" do
-        expected_message = "Request:\nGET #{url}\n"
-        expect(subject.format_request(request, url)).to eq expected_message
-      end
-    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