columbo 0.0.1

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2012, Jerome Touffe-Blin
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of Jerome Touffe-Blin nor the names of its contributors
+  may be used to endorse or promote products derived from this software 
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,48 @@
+# Columbo
+
+The *columbo* gem goal is to include a middleware
+that captures users browsing sessions for Rack applications.
+
+Tribute to [Inspector Columbo](http://www.imdb.com/title/tt1466074/)
+
+## Using with Rack application
+
+*Columbo* can be used with any Rack application,
+for example with a **Sinatra** application.
+If your application includes a rackup file
+or uses *Rack::Builder* to construct the application pipeline, 
+simply require and use as follows:
+
+    require 'rack/capture'
+    use Rack::Capture
+    run app
+
+## Using with Rails 3
+
+In order to use, include the following in a Rails application
+*Gemfile* file:
+
+    gem 'columbo'
+
+*config/application.rb* file:
+
+    require 'rack/capture'
+    config.middleware.insert_before ActionDispatch::ShowExceptions, Columbo::Capture, {capture: Rails.env.production?}
+
+Check the Rack configuration:
+
+    rake middleware
+
+## Disclaimer
+
+This is an alpha release and it is untested with Sinatra, it is tested with Rails 3 only.
+UI to explore sessions will be completed later (ETA: 2013'Q2).
+
+## Author
+
+Jerome Touffe-Blin, [@jtblin](https://twitter.com/jtlbin), [http://www.linkedin.com/in/jtblin](http://www.linkedin.com/in/jtblin)
+
+## License
+
+Columbo is copyright 2012 Jerome Touffe-Blin and contributors. It is licensed under the BSD license. See the include LICENSE file for details.
+

data/lib/columbo/capture.rb

@@ -0,0 +1,67 @@
+require 'columbo'
+require 'rack/utils'
+require 'rack/logger'
+
+module Columbo
+  class Capture
+    include Rack::Utils
+
+    FORMAT = %{[Columbo #{Columbo::VERSION}] %s - [%s] %s "%s%s %s"\n}
+
+    def initialize(app, opts={})
+      @app = app
+      @capture = opts[:capture] || false
+      @bench = (opts[:capture] && opts[:bench]) || false
+      @logger = opts[:logger]
+      @inspector = Columbo::Inspector.new
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      start_processing = Time.now
+      status, headers, response = @app.call(env)
+      stop_processing = Time.now
+
+      start = Time.now if @bench
+
+      headers = HeaderHash.new(headers) # Is it required?
+
+      if !STATUS_WITH_NO_ENTITY_BODY.include?(status) &&
+          !headers['transfer-encoding'] &&
+          headers['content-type'] &&
+          headers['content-type'].include?("text/html")
+
+        Thread.new { @inspector.investigate env, status, headers, response, start_processing, stop_processing if @capture }
+
+      end
+
+      if @bench
+        stop = Time.now
+        log(env, (stop-start).seconds)
+        headers['Columbo'] = "version #{Columbo::VERSION}, time #{(stop-start).seconds}s"
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    def log(env, time)
+      now = Time.now
+      logger = @logger || env['rack.errors']
+
+      logger.write FORMAT % [
+          "Time: #{time}s",
+          now.strftime("%d-%b-%Y %H:%M:%S"),
+          env["REQUEST_METHOD"],
+          env["PATH_INFO"],
+          env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
+          env["HTTP_VERSION"]
+      ]
+    end
+
+  end
+end

data/lib/columbo/db_client.rb

@@ -0,0 +1,39 @@
+require 'mongo'
+
+module Columbo
+  class DbClient
+    include Mongo
+
+    attr_accessor :coll
+
+    def initialize
+      client = Mongo::MongoClient.from_uri(Columbo::MONGO_URI)
+      db     = client[Columbo::MONGO_DB]
+      @coll  = db[Columbo::MONGO_COLLECTION]
+    end
+
+    def insert(*args)
+      coll.insert *args
+    end
+
+    def save(*args)
+      coll.findOne *args
+    end
+
+    def find(*args)
+      coll.find *args
+    end
+
+    def find_one(*args)
+      coll.find_one *args
+    end
+
+    def remove(*args)
+      coll.remove *args
+    end
+
+    def update(*args)
+      coll.update *args
+    end
+  end
+end

data/lib/columbo/inspector.rb

@@ -0,0 +1,71 @@
+require 'rack/request'
+require 'rack/response'
+require 'nokogiri'
+require 'html_mini'
+
+module Columbo
+  class Inspector
+
+    def initialize
+    end
+
+    def investigate(env, status, headers, body, start, stop)
+      # Lazy connection to MongoDB
+      client = Columbo::DbClient.new
+      # Normalise request from env
+      request = Rack::Request.new(env)
+      html = ''
+      body.each { |part| html += part }
+      # Retrieve plain text body for full text search
+      text, title = to_plain_text(html)
+      # Get request headers
+      request_headers = {}
+      request.env.each { |key, value| request_headers[key.sub(/^HTTP_/, '').downcase] = value if key.start_with? 'HTTP_'}
+      # Convert MIME types into String
+      formats = request.env['action_dispatch.request.formats'].collect {|format| format.to_s}
+      data = {
+          request: {
+              params: request.params,
+              remote_ip: request.ip,
+              user_agent: request.user_agent,
+              method: request.env['REQUEST_METHOD'],
+              uri: request.env['REQUEST_URI'],
+              script: request.env['SCRIPT_NAME'],
+              path: request.env['PATH_INFO'],
+              query_string: request.env['QUERY_STRING'],
+              protocol: request.env['rack.url_scheme'],
+              server_name: request.env['SERVER_NAME'],
+              server_port: request.env['SERVER_PORT'],
+              http: request.env['SERVER_PROTOCOL'],
+              session: request.env['rack.session'],
+              cookie: request.env['rack.request.cookie_hash'],
+              formats: formats,
+              path_parameters: request.env['action_dispatch.request.path_parameters'],
+              headers: request_headers
+          },
+          status: status,
+          headers: headers,
+          length: html.length,
+          body: HtmlMini.minify(html),
+          text: text,
+          title: title,
+          start: start,
+          stop: stop,
+          time: stop-start
+      }
+      # Insert data in MongoDB
+      client.insert data
+    end
+
+    def to_plain_text(html)
+      html_doc = Nokogiri::HTML(html)
+      html_doc.xpath('//script').each {|node| node.remove}
+      html_doc.xpath('//style').each {|node| node.remove}
+      text = ""
+      html_doc.xpath('//body').each {|node| text += node.text.gsub(/\s{2,}/, ' ')}
+      title = html_doc.xpath('//title').first.text
+      [text, title]
+    end
+
+  end
+end

data/lib/columbo/version.rb

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

data/lib/columbo/web.rb

@@ -0,0 +1,7 @@
+require 'sinatra/base'
+
+module Columbo
+  class Web < Sinatra::Base
+
+  end
+end

data/lib/columbo.rb

@@ -0,0 +1,9 @@
+require 'columbo/version'
+require 'columbo/db_client'
+require 'columbo/inspector'
+
+module Columbo
+  MONGO_URI = "mongodb://columbo:inspector@linus.mongohq.com:10025/columbo_test".freeze
+  MONGO_DB = "columbo_test".freeze
+  MONGO_COLLECTION = "tests".freeze
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: columbo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jerome Touffe-Blin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+- !ruby/object:Gem::Dependency
+  name: html_mini
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: ! 'A Ruby client library for Columbo: a Customer Experience Management
+  tool'
+email: jtblin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/columbo/capture.rb
+- lib/columbo/db_client.rb
+- lib/columbo/inspector.rb
+- lib/columbo/version.rb
+- lib/columbo/web.rb
+- lib/columbo.rb
+- LICENSE
+- README.md
+homepage: http://github.com/jtblin/columbo-rb
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A Ruby client library for Inspector Columbo
+test_files: []