rack-requestash 0.2.1 → 0.3.0

data/README.md

@@ -19,21 +19,17 @@ Or install it yourself as:
 
 ## Usage
 
-Rack::Requestash will monkey-patch the `Rack::CommonLogger` class which
-provides Apache-style access logs. In order to enable in in your application,
-try something like:
+For rails, add the rack extension in the environment file to enable access logging. Do something like this in the environment.rb: 
 
+require 'rack/requestash'
+config.middleware.use Rack::Requestash::CommonJsonLogger, Rails.logger
 
-    require 'rack/requestash'
+You can pass a different logger. For more information, check `Rack::CommonLogger` class.
 
-    class MyServer < Sinatra::Base
-      use Rack::Requestash::AccessLogger
-
-      get '/' do
-       'Yahtzee!'
-      end
-    end
+For rack applications, add the below snippet in the config.ru file:
 
+require 'rack/requestash'
+use Rack::Requestash::CommonJsonLogger, logger
 
 You will then get nice, JSON formatted logs:
 

data/lib/rack/requestash.rb

@@ -1,5 +1,7 @@
+require 'rack/requestash/commonjsonlogger'
+
 module Rack
   module Requestash
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/rack/requestash/commonjsonlogger.rb

@@ -0,0 +1,41 @@
+require 'rack/commonlogger'
+require 'json'
+
+module Rack
+  module Requestash
+    class CommonJsonLogger < Rack::CommonLogger
+      def initialize(app, logger=nil)
+        super(app, logger)
+      end
+
+      def log(env, status, header, began_at)
+        #Access the base class variables with caution; they may not exist
+        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'],
+          :remote_addr => env['REMOTE_ADDR'],
+          :user => env['REMOTE_USER'],
+          :user_agent => env['HTTP_USER_AGENT'],
+          :timestamp => Time.now.utc.iso8601
+        }
+
+        # If there's an X-Forwarded-For header split it up into a
+        # list of machine-readable IPs.
+        blob[:forwarded_for] = env['HTTP_X_FORWARDED_FOR'].split(',') if env['HTTP_X_FORWARDED_FOR']
+
+        if logger
+          logger.write({:type => 'request',
+                        :event => blob}.to_json)
+          logger.write("\n")
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-requestash
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,7 @@ files:
 - README.md
 - Rakefile
 - lib/rack/requestash.rb
-- lib/rack/requestash/accesslogger.rb
+- lib/rack/requestash/commonjsonlogger.rb
 - lib/rack/requestash/log4r.rb
 - rack-requestash.gemspec
 - spec/log4r_spec.rb
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3277517091328956834
+      hash: -407596688446818320
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3277517091328956834
+      hash: -407596688446818320
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/rack/requestash/accesslogger.rb

@@ -1,51 +0,0 @@
-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
-