columbo 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
-# Columbo
+# columbo-rb
 
-The *columbo* gem goal is to include a middleware
+The *columbo* gem includes a middleware
 that captures users browsing sessions for Rack applications.
 
 Tribute to [Inspector Columbo](http://www.imdb.com/title/tt1466074/)
@@ -13,8 +13,8 @@ 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
+    require 'columbo/capture'
+    use Columbo::Capture
     run app
 
 ## Using with Rails 3
@@ -26,8 +26,12 @@ In order to use, include the following in a Rails application
 
 *config/application.rb* file:
 
-    require 'rack/capture'
-    config.middleware.insert_before ActionDispatch::ShowExceptions, Columbo::Capture, {capture: Rails.env.production?}
+    require 'columbo/capture'
+    config.middleware.insert_before ActionDispatch::ShowExceptions, Columbo::Capture, {
+      capture: Rails.env.production?,
+      bench: true,
+      mongo_uri: 'mongodb://user:password@mongodb_host:port/database'
+    }
 
 Check the Rack configuration:
 

data/lib/columbo/capture.rb

@@ -10,10 +10,14 @@ module Columbo
 
     def initialize(app, opts={})
       @app = app
-      @capture = opts[:capture] || false
-      @bench = (opts[:capture] && opts[:bench]) || false
-      @logger = opts[:logger]
-      @inspector = Columbo::Inspector.new
+      @capture    = opts[:capture] || false
+      @bench      = (opts[:capture] && opts[:bench]) || false
+      @logger     = opts[:logger]
+      @mongo_uri  = opts[:mongo_uri]
+
+      raise ArgumentError, 'mongo URI missing.' if @mongo_uri.nil?
+
+      @inspector = Columbo::Inspector.new @mongo_uri
     end
 
     def call(env)

data/lib/columbo/db_client.rb

@@ -6,9 +6,9 @@ module Columbo
 
     attr_accessor :coll
 
-    def initialize
-      client = Mongo::MongoClient.from_uri(Columbo::MONGO_URI)
-      db     = client[Columbo::MONGO_DB]
+    def initialize(uri)
+      client = Mongo::MongoClient.from_uri(uri)
+      db = client[uri.split('/').last]
       @coll  = db[Columbo::MONGO_COLLECTION]
     end
 

data/lib/columbo/inspector.rb

@@ -6,12 +6,13 @@ require 'html_mini'
 module Columbo
   class Inspector
 
-    def initialize
+    def initialize(mongo_uri)
+      @mongo_uri = mongo_uri
     end
 
     def investigate(env, status, headers, body, start, stop)
       # Lazy connection to MongoDB
-      client = Columbo::DbClient.new
+      client = Columbo::DbClient.new @mongo_uri
       # Normalise request from env
       request = Rack::Request.new(env)
       html = ''
@@ -45,7 +46,7 @@ module Columbo
           },
           status: status,
           headers: headers,
-          length: html.length,
+          size: html.length,
           body: HtmlMini.minify(html),
           text: text,
           title: title,
@@ -54,18 +55,35 @@ module Columbo
           time: stop-start
       }
       # Insert data in MongoDB
-      client.insert data
+      # TODO: error logging
+      client.insert sanitize(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 = ""
+      text = ''
       html_doc.xpath('//body').each {|node| text += node.text.gsub(/\s{2,}/, ' ')}
       title = html_doc.xpath('//title').first.text
       [text, title]
     end
+    
+    private
+
+    def sanitize(data)
+      Hash[
+        data.map do |key, value|
+          value = sanitize(value) if value.is_a? Hash
+          # replace $ and . in keys by Unicode full width equivalent
+          # http://docs.mongodb.org/manual/faq/developers/#faq-dollar-sign-escaping
+          key = key.gsub('.', 'U+FF0E').gsub('$', 'U+FF04') if key.is_a? String
+          # transform symbol into string to avoid auto transformation into $symbol
+          value = value.to_s if value.is_a? Symbol
+          [key, value]
+        end
+      ]
+    end
 
   end
 end

data/lib/columbo/version.rb

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

data/lib/columbo.rb

@@ -3,7 +3,5 @@ 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
+  MONGO_COLLECTION = "hits".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: columbo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack