rack-http-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 642e14eefadc39818c60f0a90a509d19ef658b14
+  data.tar.gz: b716b5ea8311d70c64ff05687f3698f7ff8dac59
+SHA512:
+  metadata.gz: a28ea9211e98c4224641f02da06cae9ed9eacfd494dc95e761908229690046fb8f590a51f772abb934a24c2a6a89ac9aaa546862c167c12e64ff04d8165c7bf1
+  data.tar.gz: 1bf1c05284c5241642b7d16646bb775b84c1333d8182bc33a5234246ccb7acd32147e91203f3afa4471b011b2cae60363ac21abc42b62de1b2d688fa29517a5e

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    rack-http-logger (0.1.0)
+      rack (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rack (1.5.2)
+    rake (10.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-http-logger!
+  rake

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Mattt Thompson (http://mattt.me/)
+
+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,43 @@
+# Rack::HTTPLogger
+
+`Rack::HTTPLogger` is Rack middleware that provides a logging endpoint for your application. HTTP request parameters are automatically formatted according to [l2met](https://github.com/ryandotsmith/l2met) and logged to a specified stream, such as `STDOUT`.
+
+This is designed for anyone using Heroku, which uses [Logplex](https://devcenter.heroku.com/articles/logplex) to aggregate messages for further monitoring and analytics. With `Rack::HTTPLogger` remote events such as mobile device registrations can be collected and processed into your common log stream.
+
+## Installation
+
+```
+$ gem install rack-http-logger
+```
+
+## Options
+
+- `stream`: Stream to which lines are logged. _Defaults to `$stdout`_.
+- `sync`: Print log lines to stream synchronously (not recommended for applications with high throughput). _Defaults to `true`_
+- `method`: Matched HTTP Method. _Defaults to `LOG`_
+- `path`: Matched URL path. _Defaults to `/`_
+- `source`: Source attribute in log line. _Defaults to `rack-http-logger`_
+
+## Usage
+
+Rack::HTTPLogger can be run as Rack middleware.
+
+### config.ru
+
+```ruby
+require 'rack/http-logger'
+
+use Rack::HTTPLogger
+```
+
+## Contact
+
+Mattt Thompson
+
+- http://github.com/mattt
+- http://twitter.com/mattt
+- m@mattt.me
+
+## License
+
+Rack::HTTPLogger is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.setup
+
+gemspec = eval(File.read("rack-http-logger.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-http-logger.gemspec"] do
+  system "gem build rack-http-logger.gemspec"
+end

data/lib/rack/http-logger.rb

@@ -0,0 +1,45 @@
+module Rack #:nodoc:
+  class HTTPLogger
+    VERSION = '0.1.0'
+
+    def initialize(app, options = {})
+      @app = app
+
+      @stream = options[:stream] || $stdout
+      @stream.sync = true unless options.fetch(:sync, true)
+      @source = options[:source] || "rack-http-logger"
+
+      @method = options[:method] ? "#{options[:method]}".upcase : "LOG"
+      @path = options[:path] || "/"
+    end
+
+    def call(env)
+      return @app.call(env) unless env["REQUEST_METHOD"] == @method and env["REQUEST_PATH"] == @path
+
+      request = Rack::Request.new(env)
+
+      if request.media_type == "application/json" and (body = env[POST_BODY].read).length.nonzero?
+        log JSON.parse(body)
+      else
+        log request.params
+      end
+
+      [201, {"Content-Type" => "text/plain"}, []]
+    end
+
+    private
+
+    def log(parameters)
+      return if parameters.nil? or parameters.empty?
+
+      measures = flatten(parameters).collect{|keys, value| "#{keys.collect(&:to_s).join('.')}=#{value}"}
+
+      @stream.puts ["source=#{@source}", *measures].join(" ")
+    end
+
+    def flatten(hash, k = [])
+      return {Array(k) => hash} unless hash.is_a?(Hash)
+      hash.inject({}){ |h, v| h.merge! flatten(v[-1], k + [v[0]]) }
+    end
+  end
+end

data/rack-http-logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/http-logger"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-http-logger"
+  s.authors     = ["Mattt Thompson"]
+  s.email       = "m@mattt.me"
+  s.homepage    = "http://mattt.me"
+  s.version     = Rack::HTTPLogger::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rack::HTTPLogger"
+  s.description = "Log arbitrary metrics from HTTP request parameters according to l2met conventions."
+
+  s.add_dependency "rack", "~> 1.5"
+
+  s.add_development_dependency "rake"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rack-http-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Log arbitrary metrics from HTTP request parameters according to l2met
+  conventions.
+email: m@mattt.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/rack/http-logger.rb
+- ./LICENSE
+- ./rack-http-logger-0.0.1.gem
+- ./rack-http-logger.gemspec
+- ./Rakefile
+- ./README.md
+homepage: http://mattt.me
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rack::HTTPLogger
+test_files: []