http_log 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HttpLog'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/http_log.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require_tree .
+
+$(function() {
+  $("body#http-logger > .topbar").scrollSpy()
+});

data/app/assets/stylesheets/http_log.css

@@ -0,0 +1,12 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require twitter/bootstrap
+ *= require_tree .
+*/
+
+#http-logger table {
+  table-layout: fixed;
+}

data/app/controllers/http_log/requests_controller.rb

@@ -0,0 +1,10 @@
+module HttpLog
+  class RequestsController < ActionController::Base
+    respond_to :html, :xml, :json
+
+    def show
+      @log = HttpLog::Request.find params[:id]
+      respond_with @log
+    end
+  end
+end

data/app/models/http_log/request.rb

@@ -0,0 +1,35 @@
+module HttpLog
+  class Request
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :http_method, :type => String
+    field :url, :type => String
+    field :raw_post, :type => String
+    field :remote_ip, :type => String
+    field :remote_host, :type => String
+    field :user_agent, :type => String
+    field :content_type, :type => String
+    field :headers, :type => Hash, :default => {}
+    field :params, :type => Hash, :default => {}
+    field :cookies, :type => Hash, :default => {}
+
+    def self.from_request(rack)
+      new do |req|
+        req.http_method = rack.request_method
+        req.url = rack.url
+        req.headers = rack.header_hash
+        req.params = rack.params
+        req.user_agent = rack.user_agent
+        req.content_type = rack.content_type
+        req.raw_post = rack.raw_post
+        req.remote_ip = rack.ip
+        req.cookies = rack.cookies
+      end
+    end
+
+    def accept
+      headers['HTTP_ACCEPT'].present? ? headers['HTTP_ACCEPT'] : nil
+    end
+  end
+end

data/app/views/http_log/requests/show.html.erb

@@ -0,0 +1,59 @@
+<h1>HTTP Request: <%= @log.id %></h1>
+
+<table id="summary" class="bordered-table zebra-striped">
+  <tbody>
+    <tr>
+      <th>URL</th>
+      <td><%= @log.url %></td>
+    </tr>
+    <tr>
+      <th>Method</th>
+      <td><%= @log.http_method.upcase %></td>
+    </tr>
+    <tr>
+      <th>Received</th>
+      <td><%= @log.created_at %></td>
+    </tr>
+    <tr>
+      <th>From</th>
+      <td><%= @log.remote_ip %></td>
+    </tr>
+    <tr>
+      <th>User Agent</th>
+      <td><%= @log.user_agent %></td>
+    </tr>
+    <tr id="content-type">
+      <th>Content-Type</th>
+      <td><%= @log.content_type %></td>
+    </tr>
+    <tr id="accepts">
+      <th>Accept</th>
+      <td><%= @log.accept %></td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Parameters</h2>
+<pre id="parameters" class="pretty-print">
+  <%= @log.params.inspect %>
+</pre>
+
+<h2>Headers</h2>
+<table id="headers" class="bordered-table zebra-striped">
+  <% @log.headers.each do |name, value| %>
+    <tr>
+      <th><%= name %></th>
+      <td><%= value %></th>
+    </tr>
+  <% end %>
+</table>
+
+<h2>Raw Post</h2>
+<pre id="raw-post" class="pretty-print">
+  <%= @log.raw_post %>
+</pre>
+
+<h2>Cookies</h2>
+<pre id="cookies" class="pretty-print">
+  <%= @log.cookies %>
+</pre>

data/app/views/layouts/http_log/requests.html.erb

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>HTTP Logger</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body id="http-logger" style="padding-top: 60px">
+  <div class="topbar" data-scrollspy="scrollspy">
+    <div class="topbar-inner">
+      <div class="container">
+        <h3 class="brand">HTTP Log</h3>
+        <ul class="nav">
+          <li><%= link_to "Summary", "#summary"  %></li>
+          <li><%= link_to "Content-Type", "#content-type"  %></li>
+          <li><%= link_to "Accepts", "#accepts"  %></li>
+          <li><%= link_to "Paramters", "#parameters"  %></li>
+          <li><%= link_to "Headers", "#headers"  %></li>
+          <li><%= link_to "Raw Post", "#raw-post"  %></li>
+          <li><%= link_to "Cookies ", "#cookies"  %></li>
+        </ul>
+      </div>
+    </div>
+  </div>
+  <div class="container">
+    <%= yield %>
+  </div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+HttpLog::Engine.routes.draw do
+  resources :requests, :only => :show, :as => :http_request
+end

data/lib/http_log/http_request.rb

@@ -0,0 +1,30 @@
+module HttpLog
+  class HttpRequest < Rack::Request
+    def accepts
+      Array.wrap(super).map(&:to_s)
+    end
+
+    def header_hash
+      header_keys = env.keys.select {|k| k =~ /HTTP_\w+/ }
+      hash = {}
+      header_keys.each do |key|
+        hash[key] = env[key]
+      end
+      hash
+    end
+
+    def accepts
+      env['HTTP_ACCEPT']
+    end
+
+    def raw_post
+      content = env['rack.input'].read
+      env['rack.input'].rewind
+      content
+    end
+
+    def params
+      super.merge(env['action_dispatch.request.request_parameters'] || {})
+    end
+  end
+end

data/lib/http_log/middleware.rb

@@ -0,0 +1,40 @@
+module HttpLog
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @proxy = HttpRequest.new(env)
+      if passes_filters?
+        request =  HttpLog::Request.from_request(@proxy)
+
+        HttpLog.callbacks.each do |callback|
+          callback.call @proxy, request
+        end
+
+        request.save
+        env['http_log.request_id'] = request.id.to_s
+      end
+
+      @app.call env
+    end
+
+    def passes_filters?
+      HttpLog.filters.each do |filter|
+        matches_filter = if filter.is_a? Symbol
+                   @proxy.path_info =~ /\.#{filter}$/
+                 elsif filter.is_a? Regexp
+                    @proxy.url =~ filter
+                 else
+                   filter.call @proxy
+                 end
+
+        return false if matches_filter
+      end
+
+      true
+    end
+
+  end
+end

data/lib/http_log/railtie.rb

@@ -0,0 +1,37 @@
+module HttpLog
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :include_http_request_log_id, :if => :http_log_request_id
+
+      def include_http_request_log_id
+        logger.info "  HTTP Logger Request ID: #{http_log_request_id}"
+        headers['X-Request-Log-ID'] = http_log_request_id
+      end
+
+      def http_log_request_id
+        request.env['http_log.request_id']
+      end
+    end
+  end
+
+  class Engine < ::Rails::Engine
+    isolate_namespace HttpLog
+
+    initializer "http_log.middlware" do |app|
+      app.middleware.use HttpLog::Middleware
+    end
+
+    initializer "http_log.filters" do |app|
+      regexp = /assets/
+      HttpLog.filters << regexp
+    end
+
+    initializer "http_log.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send :include,  HttpLog::ControllerHelpers
+      end
+    end
+  end
+end

data/lib/http_log/version.rb

@@ -0,0 +1,3 @@
+module HttpLog
+  VERSION = "0.0.1"
+end

data/lib/http_log.rb

@@ -0,0 +1,23 @@
+require 'mongoid'
+require 'http_log/http_request'
+require 'http_log/middleware'
+require 'twitter-bootstrap-rails'
+require "http_log/railtie"
+
+module HttpLog
+  def self.with_request(&block)
+    callbacks << block
+  end
+
+  def self.callbacks
+    @callbacks ||= []
+  end
+
+  def self.filters
+    @filters ||= []
+  end
+
+  def self.filter(&block)
+    filters << block
+  end
+end

data/lib/tasks/http_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :http_log do
+#   # Task goes here
+# end

data/readme.md

@@ -0,0 +1,106 @@
+# HTTP Log
+
+Logs all requests made to your application in a search format to
+MongoDB. This gem includes a middleware to log rack requests to MongodB.
+It also adds a header to every response indicating an `id` that can be
+used to retrieve that request. You can combine this header and the one's
+added by rails to track the conversation applications are having with 
+your application.
+
+## Installation
+
+This gem using Mongoid to store the models. Once you install the gem,
+run the mongoid config generator to setup the connection.
+
+```
+gem 'http_log'
+
+bundle install
+
+bundle exec rails g mongoid:config # if you don't already have one
+```
+
+## Example of What is Logged
+
+```javascript
+{
+  "_id":"4f16c6c4340765d7c5000005",
+  "url":"http://www.example.com/",
+  "http_method":"POST",
+  "accept":["text/html","application/xml","image/png","text/plain","*/*"],
+  "content_type":"application/json",
+  "raw_post":"{\"foo\": \"bar\"}",
+  "params":{
+    "foo":"bar"
+  },
+  "headers":{
+    "HTTP_HOST":"www.example.com",
+    "HTTP_ACCEPT":"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5",
+    "HTTP_COOKIE":""
+  },
+  "created_at":"2012-01-18T15:19:00+02:00",
+  "updated_at":"2012-01-18T15:19:00+02:00"
+}
+```
+
+## Filtering
+
+You may also filter out specific requests. Requests to `/assets` are
+filters by **default**. You can filter requests using three different
+methods:
+
+1. Symbols (treated as file extensions)
+2. Regex (matched aganist the full URL)
+3. Blocks/Procs/Lambda/Things that `respond_to? :call`
+
+Filters are used to exclude requests. So, if a filter returns true then
+that request will **not** be logged.
+
+Here are some examples.
+
+```ruby
+# Using Symbols
+HttpLog.filters << :jpg
+
+# Using Regex
+HttpLog.filters << /private/
+
+# Using Blocks/Procs/Lambdas/Things that resond_to? :call
+# req is ActionDispatch::Request with some sugar
+HttpLog.filter do |req|
+  req.env # perhaps access the rack request stuff
+  true if my_conditions_are_met
+end
+```
+
+## Adding More Log Information
+
+You can add has many callbacks as you'd like. They are executed inside
+the middleware after the initial log is instantiated. Callbacks are ran,
+then the log is persisted. 
+
+Let's say you want to add some more headers of your own:
+
+```ruby
+# config/initializers/http_log.rb
+# req is an ActionDispatch::Request
+# log is the HttpLog::Request instance
+
+HttpLog.with_request |log, req|
+  log.headers['Custom-Foo'] = 'bar'
+end
+```
+
+You may also add your own fields by reopneing the class and using the
+Mongoid APi.
+
+```ruby
+# config/initializers/http_log.rb
+class HttpLog::Request
+  field :developer_api_key, :type => String
+end
+
+HttpLog.with_request |log, req|
+  log.developer_api_key = req.parameters['developer_api_key']
+end
+```