rack-requestash 0.0.1 → 0.2.0

data/Gemfile

@@ -11,4 +11,5 @@ group :test do
   gem 'debugger', :platform => :mri_19
   gem 'debugger-pry', :platform => :mri_19
   gem 'pry'
+  gem 'log4r'
 end

data/README.md

@@ -27,7 +27,7 @@ try something like:
     require 'rack/requestash'
 
     class MyServer < Sinatra::Base
-      Rack::Requestash.install
+      use Rack::Requestash::AccessLogger
 
       get '/' do
        'Yahtzee!'

data/lib/rack/requestash.rb

@@ -1,49 +1,5 @@
-require 'rack/commonlogger'
-require 'json'
-
 module Rack
-  class Requestash
-    VERSION = "0.0.1"
-
-    def initialize(app, options={})
-      @app = app
-
-      install if options[:disable_accesslog].nil?
-    end
-
-    def call(env)
-      # Simple pass-through, we don't need to mess with the request
-      @app.call(env)
-    end
-
-    # Install the Rack::CommonLogger monkeypatch
-    def install
-      Rack::CommonLogger.class_eval do
-
-        alias_method :original_log, :log
-
-        def log(env, status, header, began_at)
-          logger = @logger || env['rack.errors']
-
-          blob = {
-            :length => header['Content-Length'] || 0,
-            :code => status.to_s[0 .. 3],
-            :version => env['HTTP_VERSION'],
-            :method => env['REQUEST_METHOD'],
-            :duration => (Time.now - began_at),
-            :query => env["QUERY_STRING"],
-            :path => env['PATH_INFO'],
-            :ip => env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'],
-            :user => env['REMOTE_USER'],
-            :timestamp => Time.now.utc.iso8601
-          }
-
-          if logger
-            logger.write(blob.to_json)
-            logger.write("\n")
-          end
-        end
-      end
-    end
+  module Requestash
+    VERSION = '0.2.0'
   end
 end

data/lib/rack/requestash/accesslogger.rb

@@ -0,0 +1,51 @@
+require 'rack/commonlogger'
+require 'json'
+
+module Rack
+  module Requestash
+    class AccessLogger
+      def initialize(app, options={})
+        @app = app
+
+        install if options[:disable_accesslog].nil?
+      end
+
+      def call(env)
+        # Simple pass-through, we don't need to mess with the request
+        @app.call(env)
+      end
+
+      # Install the Rack::CommonLogger monkeypatch
+      def install
+        Rack::CommonLogger.class_eval do
+
+          alias_method :original_log, :log
+
+          def log(env, status, header, began_at)
+            logger = @logger || env['rack.errors']
+
+            blob = {
+              :length => header['Content-Length'] || 0,
+              :code => status.to_s[0 .. 3],
+              :version => env['HTTP_VERSION'],
+              :method => env['REQUEST_METHOD'],
+              :duration => (Time.now - began_at),
+              :query => env["QUERY_STRING"],
+              :path => env['PATH_INFO'],
+              :ip => env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'],
+              :user => env['REMOTE_USER'],
+              :timestamp => Time.now.utc.iso8601
+            }
+
+            if logger
+              logger.write({:type => 'request',
+                            :event => blob}.to_json)
+              logger.write("\n")
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rack/requestash/log4r.rb

@@ -0,0 +1,28 @@
+require 'log4r'
+require 'json'
+
+module Rack
+  module Requestash
+    module Log4r
+      class Formatter < ::Log4r::Formatter
+        # Generate a JSON formatted log message, e.g.
+        #
+        #   {"type":"log","event":{"level":"WARN","tracer":[stacktrace],
+        #   "message":"logmessage"}}
+        #
+        # @param [Log4::LogEvent] event
+        # @return [String] JSOn encoded output
+        def format(event)
+          {
+            :type => 'log',
+            :event => {
+              :tracer => event.tracer,
+              :level => ::Log4r::LNAMES[event.level],
+              :message => event.data
+            }
+          }.to_json
+        end
+      end
+    end
+  end
+end

data/spec/log4r_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'rack/requestash/log4r'
+require 'json'
+
+describe Rack::Requestash::Log4r::Formatter do
+  subject(:formatter) { described_class.new }
+
+  before :all do
+    # Ensure Log4r::LNAMES gets seeded
+    Log4r::RootLogger.instance
+  end
+
+  describe '#format' do
+    let(:logevent) { ::Log4r::LogEvent.new(level, logger, tracer, data) }
+    let(:logger) do
+      logger = double('RSpec Logger')
+      logger.stub(:name => 'rspec')
+      logger.stub(:fullname => 'rspec fullname')
+      logger
+    end
+    let(:tracer) { [] }
+
+    subject(:log) { formatter.format(logevent) }
+
+    context 'with an WARN log level' do
+      # level 3 is "warn" in log4r
+      let(:level) { 3 }
+      let(:data) { "rspec log data" }
+
+      it { should be_instance_of String }
+
+      it "should be JSON" do
+        expect {
+          JSON.parse(log)
+        }.not_to raise_error
+      end
+
+      context "the JSON log output" do
+        subject(:output) { JSON.parse(log) }
+
+        it { should have_key 'type' }
+        it 'should have "log" as the type' do
+          expect(output['type']).to eql('log')
+        end
+        it { should have_key 'event' }
+
+        context "it's event block" do
+          subject(:event) { output['event'] }
+
+          it { should be_instance_of Hash }
+
+          it 'should have the tracer' do
+            expect(event['tracer']).to eql(tracer)
+          end
+
+          it 'should have the textual log level' do
+            expect(event['level']).to eql('WARN')
+          end
+
+          it 'should have the "data" from the event as a "message"' do
+            expect(event['message']).to eql(data)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-requestash
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,10 @@ files:
 - README.md
 - Rakefile
 - lib/rack/requestash.rb
+- lib/rack/requestash/accesslogger.rb
+- lib/rack/requestash/log4r.rb
 - rack-requestash.gemspec
+- spec/log4r_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/lookout/rack-requestash
 licenses:
@@ -90,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 123322180174946479
+      hash: 2702330830701692411
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 123322180174946479
+      hash: 2702330830701692411
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -108,4 +111,5 @@ specification_version: 3
 summary: A simple gem for overwriting outputting JSON formatted access logs from Rack
   apps
 test_files:
+- spec/log4r_spec.rb
 - spec/spec_helper.rb