rack-analytics 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+webrat.log

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rack-analytics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    rack-analytics (0.0.1)
+      activesupport
+      bson_ext
+      mongo
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    bson (1.2.0)
+    bson_ext (1.2.0)
+    mongo (1.2.0)
+      bson (>= 1.2.0)
+    nokogiri (1.4.4)
+    rack (1.2.1)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    riot (0.12.1)
+      rr
+      term-ansicolor
+    rr (1.0.2)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    term-ansicolor (1.0.5)
+    tilt (1.2.1)
+    webrat (0.7.3)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bson_ext
+  mongo
+  rack
+  rack-analytics!
+  rack-test
+  riot
+  sinatra
+  webrat

data/README.markdown

@@ -0,0 +1,74 @@
+# Rack-Analytics #
+
+**Rack-Analytics** is a rack middleware that creates a log of all user requests to your application and saves them on a MongoDB database.
+
+All requests are created on a separated thread, so it won't add a lot of overhead on each requests.
+
+## Instalation ##
+
+If you're using Bundler (like Rails 3, for example), you can add this line on your `Gemfile`:
+
+		gem 'rack-analytics'
+
+Then, run `bundle` to install the gem. If you don't use Bundler, you will need to install the gem manually with the following command:
+
+		gem install rack-analytics
+
+Either way, with the gem installed, you can add this on your `config.ru`:
+
+		require 'rack/analytics'
+		use Rack::Analytics::RequestLogger
+
+It will do the trick, connecting to MongoDB and start to log all your requests. If you need to change some of the configuration of the database, you can do:
+
+		require 'rack/analytics'
+		
+		# To change the database name only
+		Rack::Analytics.db_name = 'mydb'
+		
+		# To change the database connection completely
+		Rack::Analytics.db = Mongo::Connection.new.db 'mydb'
+		
+		use Rack::Analytics::RequestLogger
+
+**Rack-Analytics** runs on a threaded environment, and just like `db` and `db_name`, you can set the Queue and the Thread for the parallelism with the keys `queue` and `thread`, respectively **(i don't advise doing that, though)**.
+
+You can also change the parser, to remove some of the fields (on the future, you'll be able to create your own fields based on the request headers):
+
+		require 'rack/analytics'
+		
+		parser = Rack::Analytics::RequestParser.new
+		
+		# Will log only the path and time
+		parser.only = ['time', 'path']
+
+		# Won't log the time
+		parser.except = 'time'
+		
+		Rack::Analytics.parser = parser
+
+		use Rack::Analytics::RequestLogger
+
+Be sure to just use one of those, since they are mutually excludent (and `only` has a preference over `except`).
+
+## Notes on Patches/Pull Requests ##
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Licence ##
+
+Copyright (c) 2011, Cainã Costa <cainan.costa@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+## Thanks ##
+
+Those are the people that helped me with this project, both with code and/or with guidance. Put your name here if you create a pull request and think you deserves it!
+
+* Rafael França <rafael.ufs@gmail.com>

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+desc "Run all our tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = false
+  end
+end
+
+task :default => :test

data/lib/rack-analytics.rb

@@ -0,0 +1 @@
+require 'rack/analytics'

data/lib/rack/analytics.rb

@@ -0,0 +1,37 @@
+require 'rack/analytics/request_logger'
+require 'rack/analytics/request_parser'
+
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Rack
+  module Analytics
+    mattr_accessor :queue
+    @@queue = Queue.new
+
+    mattr_accessor :parser
+    @@parser = RequestParser.new
+
+    mattr_accessor :db_name
+    @@db_name = 'rack-analytics'
+
+    mattr_accessor :db
+    @@db = Mongo::Connection.new.db(@@db_name)
+
+    mattr_accessor :thread
+    def self.thread
+      @@thread ||= Thread.new do
+        while env = queue.pop
+          db['views'].insert parser.parse(env).data
+        end
+      end
+    end
+
+    def self.finish!
+      queue << nil
+      thread.join
+      @@thread = nil
+
+      thread
+    end
+  end
+end

data/lib/rack/analytics/request_logger.rb

@@ -0,0 +1,18 @@
+require "thread"
+
+module Rack
+  module Analytics
+    class RequestLogger
+      def initialize app, options = {}
+        @app = app
+        @options = options
+      end
+
+      def call env
+        Rack::Analytics.queue << env if env['REQUEST_METHOD'] == 'GET'
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/analytics/request_parser.rb

@@ -0,0 +1,33 @@
+module Rack
+  module Analytics
+    class RequestParser
+      attr_reader :data
+
+      DEFAULT_KEYS = ['time', 'path', 'user_agent', 'referral']
+
+      def except=(values)
+        @except = values.to_a
+      end
+
+      def only=(values)
+        @only = values.to_a
+      end
+
+      def parse request
+        @data = {}
+
+        @data['time'] = Time.now if to_parse.include? 'time'
+        @data['path'] = request['PATH_INFO'] if to_parse.include? 'path'
+        @data['user_agent'] = request['HTTP_USER_AGENT'] if to_parse.include? 'user_agent'
+        @data['referral'] = request['HTTP_REFERER'] if to_parse.include? 'referral'
+
+        return self
+      end
+
+      private
+      def to_parse
+        @only ? @only.to_a : DEFAULT_KEYS - @except.to_a
+      end
+    end
+  end
+end

data/lib/rack/analytics/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Analytics
+    VERSION = "0.0.1"
+  end
+end

data/rack-analytics.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/analytics/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-analytics"
+  s.version     = Rack::Analytics::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cainã Costa"]
+  s.email       = ["cainan.costa@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/rack-analytics"
+  s.summary     = %q{A rack middleware that collects access statistics}
+  s.description = %q{A rack middleware that collects access statistics and saves them on a MongoDB database.}
+
+  s.rubyforge_project = "rack-analytics"
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+
+  s.add_runtime_dependency('rack')
+  s.add_runtime_dependency('bson_ext')
+  s.add_runtime_dependency('mongo')
+  s.add_runtime_dependency('activesupport')
+
+  s.add_development_dependency('riot')
+  s.add_development_dependency('sinatra')
+  s.add_development_dependency('rack-test')
+end

data/test/request_logger_test.rb

@@ -0,0 +1,107 @@
+require 'teststrap'
+
+context "Rack::Analytics::RequestLogger" do
+  helper(:db) { mongo }
+  teardown { Rack::Analytics.finish! }
+  
+  context "should render a get request correctly" do
+    setup { get '/' }
+
+    asserts('response is ok') { last_response.ok? }
+    asserts('response has correct body') { last_response.body }.equals "homepage"
+  end
+
+  context "should render a get request on a inner path correctly" do
+    setup { get '/inner-page' }
+
+    asserts('response is ok') { last_response.ok? }
+    asserts('response has correct body') { last_response.body }.equals "inner page"
+  end
+
+  context "should render a post request correctly" do
+    setup { post '/' }
+
+    asserts('response is ok') { last_response.ok? }
+    asserts('response has correct body') { last_response.body }.equals "homepage with post"
+  end
+
+  context "should render a put request correctly" do
+    setup { put '/' }
+
+    asserts('response is ok') { last_response.ok? }
+    asserts('response has correct body') { last_response.body }.equals "homepage with put"
+  end
+
+  context "should render a delete request correctly" do
+    setup { delete '/' }
+
+    asserts('response is ok') { last_response.ok? }
+    asserts('response has correct body') { last_response.body }.equals "homepage with delete"
+  end
+
+  context "should create a access document when visiting the page" do
+    setup do
+      db.drop_collection 'views'
+
+      get '/'
+    end
+
+    asserts('counter has incremented') { db['views'].count }.equals 1
+  end
+
+  context "shouldn't create a access document when with post, put and delete" do
+    setup do
+      db.drop_collection 'views'
+
+      post '/'
+      put '/'
+      delete '/'
+    end
+
+    asserts("counter hasn't incremented") { db['views'].count }.equals 0
+  end
+
+  context "should save the path of the access" do
+    setup do
+      db.drop_collection 'views'
+
+      get '/'
+    end
+
+    asserts('it should have a time key') { db['views'].find_one }.includes 'path'
+    asserts('it should have a time set') { db['views'].find_one['path'] }.equals '/'
+  end
+
+  context "should save the time of the access" do
+    setup do
+      db.drop_collection 'views'
+
+      get '/'
+    end
+
+    asserts('it should have a time key') { db['views'].find_one }.includes 'time'
+    asserts('it should have a time set') { db['views'].find_one['time'] }.kind_of Time
+  end
+
+  context "should save the referral information" do
+    setup do
+      db.drop_collection 'views'
+
+      get '/', {}, 'HTTP_REFERER' => 'http://www.google.com'
+    end
+
+    asserts('it should have a referral key') { db['views'].find_one }.includes 'referral'
+    asserts('it should have a correct referral set') { db['views'].find_one['referral'] }.equals 'http://www.google.com'
+  end
+
+  context "should save the user agent information" do
+    setup do
+      db.drop_collection 'views'
+
+      get 'views', {}, 'HTTP_USER_AGENT' => 'Firefox'
+    end
+
+    asserts('it should have a user agent key') { db['views'].find_one }.includes 'user_agent'
+    asserts('it should have a correct user agent set') { db['views'].find_one['user_agent'] }.equals 'Firefox'
+  end
+end

data/test/request_parser_test.rb

@@ -0,0 +1,47 @@
+require 'teststrap'
+
+context 'Rack::Analytics::RequestParser' do
+  helper(:request) { {"HTTP_HOST"=>"example.org", "SERVER_NAME"=>"example.org",
+                      "HTTP_USER_AGENT"=>"Firefox", "CONTENT_LENGTH"=>"0", "HTTPS"=>"off",
+                      "REMOTE_ADDR"=>"127.0.0.1", "PATH_INFO"=>"/",
+                      "SCRIPT_NAME"=>"", "HTTP_COOKIE"=>"", "SERVER_PORT"=>"80",
+                      "REQUEST_METHOD"=>"GET", "QUERY_STRING"=>"",
+                      "HTTP_REFERER"=> "http://www.google.com"} }
+
+  context "should parse the default attributes correctly" do
+    setup { Rack::Analytics::RequestParser.new.parse(request) }
+
+    asserts('it should save the time') { topic.data['time'] }.kind_of Time
+    asserts('it should save the path') { topic.data['path'] }.equals '/'
+    asserts('it should save the user agent') { topic.data['user_agent'] }.equals 'Firefox'
+    asserts('it should save the referral') { topic.data['referral'] }.equals 'http://www.google.com'
+  end
+
+  context "should accept exceptions" do
+    setup { Rack::Analytics::RequestParser.new }
+
+    asserts ('it should accept single arguments') do
+      topic.except = 'time'
+      topic.parse(request).data['time']
+    end.nil
+    
+    asserts ('it should accept multiple values as arguments') do
+      topic.except = ['time']
+      topic.parse(request).data['time']
+    end.nil
+  end
+
+  context "should handle 'only'" do
+    setup { Rack::Analytics::RequestParser.new }
+
+    asserts ('it should accept single arguments') do
+      topic.only = 'time'
+      topic.parse(request).data['path']
+    end.nil
+    
+    asserts ('it should accept multiple values as arguments') do
+      topic.except = ['time', 'path']
+      topic.parse(request).data['user_agent']
+    end.nil
+  end
+end

data/test/support/dummy_app.rb

@@ -0,0 +1,23 @@
+require 'sinatra'
+
+class DummyApp < Sinatra::Application
+  get '/' do
+    'homepage'
+  end
+
+  get '/inner-page' do
+    'inner page'
+  end
+
+  post '/' do
+    'homepage with post'
+  end
+
+  put '/' do
+    'homepage with put'
+  end
+
+  delete '/' do
+    'homepage with delete'
+  end
+end

data/test/support/test_helpers.rb

@@ -0,0 +1,15 @@
+module TestHelpers
+  def app
+    Rack::Builder.new do
+      Rack::Analytics.db = mongo
+
+      use Rack::Analytics::RequestLogger
+      run DummyApp
+    end
+  end
+
+  def mongo
+    connection = Mongo::Connection.new
+    connection.db 'rack-analytics-test'
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rack/test'
+require 'mongo'
+require 'riot'
+
+require 'test/support/dummy_app'
+require 'test/support/test_helpers'
+
+require 'rack/analytics'
+
+include Rack::Test::Methods
+
+include TestHelpers

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification 
+name: rack-analytics
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Cain\xC3\xA3 Costa"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: A rack middleware that collects access statistics and saves them on a MongoDB database.
+email: 
+- cainan.costa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/rack-analytics.rb
+- lib/rack/analytics.rb
+- lib/rack/analytics/request_logger.rb
+- lib/rack/analytics/request_parser.rb
+- lib/rack/analytics/version.rb
+- rack-analytics.gemspec
+- test/request_logger_test.rb
+- test/request_parser_test.rb
+- test/support/dummy_app.rb
+- test/support/test_helpers.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/rack-analytics
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rack-analytics
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A rack middleware that collects access statistics
+test_files: 
+- test/request_logger_test.rb
+- test/request_parser_test.rb
+- test/support/dummy_app.rb
+- test/support/test_helpers.rb
+- test/teststrap.rb