tpitale-mongolytics 0.1.0

data/README.md

@@ -0,0 +1,102 @@
+# Mongolytics
+
+## Description
+
+Simple analytics tracking for Rails using the awesomest: MongoDB
+
+## Dependencies
+
+    Rails
+    MongoDB
+    MongoMapper
+
+## Installation
+
+    sudo gem install mongolytics
+
+## Setup
+
+  Just be sure to setup MongoMapper to connect to MongoDB in environment.rb:
+  
+    Rails::Initializer.run do |config|
+      config.gem 'mongomapper', :version => '>= 0.2.1'
+    end
+    
+    MongoMapper.database = "databasename-#{Rails.env}"
+  
+  [More Information](http://railstips.org/2009/7/23/getting-started-with-mongomapper-and-rails)
+
+## Usage
+
+    class ApplicationController < ActionController::Base
+      include Mongolytics::Tracker
+    end
+
+  In your controllers call any of these (creates an after_filter):
+
+    track_all_stats                               # tracks all actions
+    track_view_stats                              # tracks index, show
+    track_change_stats                            # tracks create, update, destroy
+    track_stats_for :new, :edit, :show, :destroy  # track any action mix, other actions
+
+  If you want to track a custom session variable:
+
+    track_session_key :username           # tracks session[:username] as a String
+    track_session_key :user_id, Integer   # tracks session[:user_id] as an Integer
+
+  Later, retrieve stats via (given UsersController is our controller):
+
+    # by path, useful for getting per-id stats e.g., /users/1
+    Mongolytics.stats_for_path user_path(@user)               # using the path helper (not url helper)
+    
+    # by controller and action keys, useful if you want all views of users/show page
+    Mongolytics.stats_for_keys :users, :show                  # using the controller and action
+
+    # by controller/action and session key/value hash
+    Mongolytics.stats_for_keys :users, :show, :user_id => 1   # note: session keys, not request params
+
+  You can always query the Statistics:
+
+    Mongolytics::Statistic.count({:user_id => 1})
+
+## Motivation
+
+### Why use MongoDB?
+
+  It's cool, I wanted to learn it, it's unbelievably fast, and they're working
+  on a restful API which might do cool things (pooled analytics tracking)
+
+### This is lame!
+
+  I know I'm only taking hit counts, and not really doing much to track unique
+  views, or user tracking, or determining user environments. The reason being:
+  that's not what I wanted to do!
+
+  If you want that stuff, and great reporting, and cool graphs: use Google Analytics.
+  It's perfect for that stuff! I just wanted counts on certain pages that weren't
+  trackable by GA because of their lack of unique url, or view (e.g., create/update/destroy).
+
+## License
+
+Copyright (c) 2009 Tony Pitale
+
+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,49 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/mongolytics/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'mongolytics'
+  s.version          = Mongolytics::Version.to_s
+  s.has_rdoc         = false
+  s.summary          = "Provide basic analytics tracking, server-side, using mongodb"
+  s.author           = 'Tony Pitale'
+  s.email            = 'tpitale@gmail.com'
+  s.homepage         = 'http://t.pitale.com'
+  s.files            = %w(README.md Rakefile) + Dir.glob("{lib,test}/**/*")
+
+  s.add_dependency('mongomapper', '>= 0.3.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+begin
+  require 'rcov/rcovtask'
+  
+  desc "Generate RCov coverage report"
+  Rcov::RcovTask.new(:rcov) do |t|
+    t.test_files = FileList['test/**/*_test.rb']
+    t.rcov_opts << "-x lib/mongolytics/version.rb"
+  end
+rescue LoadError
+  nil
+end

data/lib/mongolytics.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'mongolytics/statistic'
+require 'mongolytics/tracker'
+
+module Mongolytics
+  def self.stats_for_path(path)
+    Statistic.stats_for_path(path)
+  end
+
+  def self.stats_for_keys(controller, action, session_key_hash = {})
+    Statistic.stats_for_keys(controller, action, session_key_hash)
+  end
+end

data/lib/mongolytics/statistic.rb

@@ -0,0 +1,23 @@
+module Mongolytics
+  class Statistic
+    include MongoMapper::Document
+
+    key :controller, String, :required => true
+    key :action, String, :required => true
+    key :path, String
+
+    BASE_KEYS = ["updated_at", "action", "_id", "controller", "path", "created_at"]
+
+    def self.session_keys
+      keys.map{|k,v| k} - BASE_KEYS
+    end
+
+    def self.stats_for_path(path)
+      count({:path => path})
+    end
+
+    def self.stats_for_keys(controller, action, session_key_hash = {})
+      count({:controller => controller.to_s, :action => action.to_s}.merge(session_key_hash))
+    end
+  end
+end

data/lib/mongolytics/tracker.rb

@@ -0,0 +1,44 @@
+module Mongolytics
+  module Tracker
+    def self.included(controller)
+      controller.extend(ClassMethods)
+    end
+
+    def track_stat
+      options = {
+        :controller => params[:controller].to_s,
+        :action => params[:action].to_s,
+        :path => request.path
+      }
+
+      session_options = Statistic.session_keys.inject({}) do |hash, key|
+        hash[key.to_sym] = session[key.to_sym] if session.has_key?(key.to_sym)
+        hash
+      end
+
+      Statistic.create(options.merge(session_options))
+    end
+
+    module ClassMethods
+      def track_stats_for(*actions)
+        after_filter :track_stat, :only => actions
+      end
+
+      def track_all_stats
+        after_filter :track_stat
+      end
+
+      def track_view_stats
+        track_stats_for :index, :show
+      end
+
+      def track_change_stats
+        track_stats_for :create, :update, :destroy
+      end
+
+      def track_session_key(key, type = String)
+        Statistic.key(key, type)
+      end
+    end
+  end
+end

data/lib/mongolytics/version.rb

@@ -0,0 +1,12 @@
+module Mongolytics
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
+require 'mocha'
+require 'mongomapper'
+
+require File.dirname(__FILE__) + '/../lib/mongolytics'
+
+# connect to mongodb?

data/test/unit/mongolytics/statistic_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module Mongolytics
+  class StatisticTest < Test::Unit::TestCase
+    context 'The Statistic class' do
+      should "find count of stats for a given path" do
+        Statistic.expects(:count).with({:path => '/users/1'}).returns(10201)
+        Statistic.stats_for_path('/users/1').should == 10201
+      end
+
+      should "find count of stats for a given controller and action" do
+        Statistic.expects(:count).with({:controller => 'users', :action => 'show'}).returns(11211)
+        Statistic.stats_for_keys(:users, :show).should == 11211
+      end
+
+      should "find count of stats for a given controller/action and session key hash" do
+        Statistic.expects(:count).with({:controller => 'users', :action => 'show', :user_id => 1}).returns(13131)
+        Statistic.stats_for_keys(:users, :show, :user_id => 1).should == 13131
+      end
+
+      should "know of any session keys" do
+        Statistic.key(:extra_key, String)
+        assert_equal ["extra_key"], Statistic.session_keys
+      end
+    end
+  end
+end

data/test/unit/mongolytics/tracker_test.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class FauxController
+  include Mongolytics::Tracker
+end
+
+module Mongolytics
+  class TrackerTest < Test::Unit::TestCase
+    context "A Controller with Tracker mixed-in" do
+      should "create an after_filter for the specified actions" do
+        FauxController.expects(:after_filter).with(:track_stat, :only => [:new, :edit])
+        FauxController.track_stats_for :new, :edit
+      end
+
+      should "create an after_filter for all actions" do
+        FauxController.expects(:after_filter).with(:track_stat)
+        FauxController.track_all_stats
+      end
+
+      should "create an after_filter for index, show" do
+        FauxController.expects(:after_filter).with(:track_stat, :only => [:index, :show])
+        FauxController.track_view_stats
+      end
+
+      should "create an after_filter for create, update, destroy" do
+        FauxController.expects(:after_filter).with(:track_stat, :only => [:create, :update, :destroy])
+        FauxController.track_change_stats
+      end
+
+      should "add a session key to Statistic" do
+        Statistic.expects(:key).with(:username, String)
+        FauxController.track_session_key :username
+      end
+
+      should "allow override of class type for key added to Statistic" do
+        Statistic.expects(:key).with(:user_id, Integer)
+        FauxController.track_session_key :user_id, Integer        
+      end
+    end
+
+    context "An instance of a Controller with Tracker mixed-in" do
+      should "create a statistic with controller, action, and path" do
+        controller = FauxController.new
+        
+        controller.stubs(:request).returns(stub(:path => '/users/1'))
+        controller.stubs(:params).returns({:controller => 'faux', :action => 'show'})
+        controller.stubs(:session).returns({})
+
+        Statistic.expects(:create).with(:controller => 'faux', :action => 'show', :path => '/users/1').returns(true)
+        assert controller.track_stat
+      end
+
+      should "create a statistic with controller, action, path, and user_id" do
+        FauxController.track_session_key :user_id, Integer
+        controller = FauxController.new
+
+        controller.stubs(:request).returns(stub(:path => '/users/1'))
+        controller.stubs(:params).returns({:controller => 'faux', :action => 'show'})
+        controller.stubs(:session).returns({:user_id => 1})
+
+        Statistic.expects(:create).with(:controller => 'faux', :action => 'show', :path => '/users/1', :user_id => 1).returns(true)
+        assert controller.track_stat
+      end
+    end
+  end
+end

data/test/unit/mongolytics_test.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MongolyticsTest < Test::Unit::TestCase
+  context "The Mongolytics module" do
+    should "delegate stats_for_path to Statistic" do
+      Mongolytics::Statistic.expects(:stats_for_path).with('/users/1')
+      Mongolytics.stats_for_path('/users/1')
+    end
+
+    should "delegate stats_for_keys to Statistic" do
+      Mongolytics::Statistic.expects(:stats_for_keys).with(:users, :show, {})
+      Mongolytics.stats_for_keys(:users, :show)
+    end
+
+    should "delegate stats_for_keys with session options to Statistic" do
+      Mongolytics::Statistic.expects(:stats_for_keys).with(:users, :show, :user_id => 1)
+      Mongolytics.stats_for_keys(:users, :show, :user_id => 1)
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: tpitale-mongolytics
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tony Pitale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongomapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+description: 
+email: tpitale@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/mongolytics
+- lib/mongolytics/statistic.rb
+- lib/mongolytics/tracker.rb
+- lib/mongolytics/version.rb
+- lib/mongolytics.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/mongolytics
+- test/unit/mongolytics/statistic_test.rb
+- test/unit/mongolytics/tracker_test.rb
+- test/unit/mongolytics_test.rb
+has_rdoc: false
+homepage: http://t.pitale.com
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provide basic analytics tracking, server-side, using mongodb
+test_files: []
+