tpitale-mongolytics 0.1.0 → 0.2.0

data/README.md

@@ -39,11 +39,16 @@ Simple analytics tracking for Rails using the awesomest: MongoDB
     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:
+  If you want to track a 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
 
+  If you want to track a params variable:
+
+    track_params_key :username            # tracks params[:username] as a String
+    track_params_key :user_id, Integer    # tracks params[: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
@@ -52,12 +57,10 @@ Simple analytics tracking for Rails using the awesomest: MongoDB
     # 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})
+    Mongolytics::Statistic.count(:session => {:user_id => 1})
+    Mongolytics::Statistic.count(:param => {:user_id => 1})
 
 ## Motivation
 

data/lib/mongolytics/param.rb

@@ -0,0 +1,5 @@
+module Mongolytics
+  class Param
+    include MongoMapper::EmbeddedDocument
+  end
+end

data/lib/mongolytics/session.rb

@@ -0,0 +1,5 @@
+module Mongolytics
+  class Session
+    include MongoMapper::EmbeddedDocument
+  end
+end

data/lib/mongolytics/statistic.rb

@@ -6,18 +6,15 @@ module Mongolytics
     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
+    many :sessions
+    many :params
 
     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))
+    def self.stats_for_keys(controller, action)
+      count({:controller => controller.to_s, :action => action.to_s})
     end
   end
 end

data/lib/mongolytics/tracker.rb

@@ -11,12 +11,7 @@ module Mongolytics
         :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))
+      Statistic.create(options.merge(:sessions => [session], :params => [params]))
     end
 
     module ClassMethods
@@ -37,7 +32,11 @@ module Mongolytics
       end
 
       def track_session_key(key, type = String)
-        Statistic.key(key, type)
+        Session.key(key, type)
+      end
+
+      def track_params_key(key, type = String)
+        Param.key(key, type)
       end
     end
   end

data/lib/mongolytics/version.rb

@@ -2,7 +2,7 @@ module Mongolytics
   module Version
     
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     
     def self.to_s # :nodoc:

data/lib/mongolytics.rb

@@ -1,6 +1,8 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'mongolytics/statistic'
+require 'mongolytics/session'
+require 'mongolytics/param'
 require 'mongolytics/tracker'
 
 module Mongolytics
@@ -8,7 +10,7 @@ module Mongolytics
     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)
+  def self.stats_for_keys(controller, action)
+    Statistic.stats_for_keys(controller, action)
   end
 end

data/test/unit/mongolytics/statistic_test.rb

@@ -12,16 +12,6 @@ module Mongolytics
         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

@@ -27,38 +27,46 @@ module Mongolytics
         FauxController.track_change_stats
       end
 
-      should "add a session key to Statistic" do
-        Statistic.expects(:key).with(:username, String)
+      should "add a session key to Session" do
+        Session.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)
+      should "allow override of class type for a session key added to Session" do
+        Session.expects(:key).with(:user_id, Integer)
         FauxController.track_session_key :user_id, Integer        
       end
+
+      should "add a params key to Session" do
+        Param.expects(:key).with(:username, String)
+        FauxController.track_params_key :username
+      end
+
+      should "allow override of class type for a params key added to Session" do
+        Param.expects(:key).with(:user_id, Integer)
+        FauxController.track_params_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
+        params = {:controller => 'faux', :action => 'show'}
+        session = {}
 
         controller.stubs(:request).returns(stub(:path => '/users/1'))
-        controller.stubs(:params).returns({:controller => 'faux', :action => 'show'})
-        controller.stubs(:session).returns({:user_id => 1})
+        controller.stubs(:params).returns(params)
+        controller.stubs(:session).returns(session)
+
+        Statistic.expects(:create).with({
+          :controller => 'faux',
+          :action => 'show',
+          :path => '/users/1',
+          :params => [params],
+          :sessions => [session]
+        }).returns(true)
 
-        Statistic.expects(:create).with(:controller => 'faux', :action => 'show', :path => '/users/1', :user_id => 1).returns(true)
         assert controller.track_stat
       end
     end

data/test/unit/mongolytics_test.rb

@@ -8,13 +8,8 @@ class MongolyticsTest < Test::Unit::TestCase
     end
 
     should "delegate stats_for_keys to Statistic" do
-      Mongolytics::Statistic.expects(:stats_for_keys).with(:users, :show, {})
+      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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tpitale-mongolytics
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tony Pitale
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-12 00:00:00 -07:00
+date: 2009-08-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +34,8 @@ files:
 - README.md
 - Rakefile
 - lib/mongolytics
+- lib/mongolytics/param.rb
+- lib/mongolytics/session.rb
 - lib/mongolytics/statistic.rb
 - lib/mongolytics/tracker.rb
 - lib/mongolytics/version.rb
@@ -46,7 +48,6 @@ files:
 - test/unit/mongolytics_test.rb
 has_rdoc: false
 homepage: http://t.pitale.com
-licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Provide basic analytics tracking, server-side, using mongodb