rack-requestash 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'rspec', '~> 2.14'
+  gem 'rack-test'
+  gem 'sinatra'
+  gem 'debugger', :platform => :mri_19
+  gem 'debugger-pry', :platform => :mri_19
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 R. Tyler Croy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Rack::Requestash
+
+Simple Rack "middleware" for generating [logstash](http://logstash.net/)
+friendly request access logs for any Rack-based application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-requestash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-requestash
+
+## 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:
+
+
+    require 'rack/requestash'
+
+    class MyServer < Sinatra::Base
+      Rack::Requestash.install
+
+      get '/' do
+       'Yahtzee!'
+      end
+    end
+
+
+You will then get nice, JSON formatted logs:
+
+
+    {"length":"2818","code":"200","version":"HTTP/1.1","method":"GET","duration":0.280802331,"query":"","path":"/","ip":"127.0.0.1","user":null,"timestamp":"2013-08-15T05:49:00Z"}
+    {"length":0,"code":"304","version":"HTTP/1.1","method":"GET","duration":0.035969114,"query":"","path":"/javascripts/vendor.js","ip":"127.0.0.1","user":null,"timestamp":"2013-08-15T05:49:00Z"}
+    {"length":0,"code":"304","version":"HTTP/1.1","method":"GET","duration":0.069988507,"query":"","path":"/javascripts/i18n/en.js","ip":"127.0.0.1","user":null,"timestamp":"2013-08-15T05:49:00Z"}
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/rack/requestash.rb

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

data/rack-requestash.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/requestash'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-requestash"
+  spec.version       = Rack::Requestash::VERSION
+  spec.authors       = ["R. Tyler Croy"]
+  spec.email         = ["rtyler.croy@lookout.com"]
+  spec.description   = "A simple gem for overwriting outputting JSON formatted access logs from Rack apps"
+  spec.summary       = "A simple gem for overwriting outputting JSON formatted access logs from Rack apps"
+  spec.homepage      = "https://github.com/lookout/rack-requestash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+
+  spec.add_dependency 'rack'
+  spec.add_dependency 'json'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rack-requestash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem for overwriting outputting JSON formatted access logs from
+  Rack apps
+email:
+- rtyler.croy@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/requestash.rb
+- rack-requestash.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/lookout/rack-requestash
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 123322180174946479
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 123322180174946479
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A simple gem for overwriting outputting JSON formatted access logs from Rack
+  apps
+test_files:
+- spec/spec_helper.rb