little_brother 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in little_brother.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Roger
+
+MIT License
+
+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/README.md

@@ -0,0 +1,96 @@
+# LittleBrother
+
+Tracks and stores every action (controler:action pair) passed through the controller. 
+
+The gem also supports user oriented tracking for more detailed/focus analysis.
+
+Disclaimer: Little Brother this IS NOT Big Brother. :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'little_brother'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install little_brother
+
+Run the generation
+
+    $ rails generation little_brother_setup
+
+This will create the migration`timestamp_create_watchers.rb` so you can create the table `watchers`
+Run the migration
+
+    $ rake db:migrate
+
+## Usage
+
+Require the module
+
+    $ require 'little_brother'
+
+
+Just grab the controller you want to keep track of the actions executed and include the module `include LittleBrother::Record` to start recording.
+
+```erb
+class ApplicationController < ApplicationController
+
+	include LittleBrother::Record
+
+	...
+
+end
+```
+
+### User oriented recording
+If you want to keep track of the user that triggers the actions, you have to supply a `watch_user` method in the controller.
+
+```erb
+class ApplicationController < ApplicationController
+
+  include LittleBrother::Record
+
+  def watch_user
+    @watch_user = "John Doe"
+  end
+  ...
+
+end
+```
+
+## Helpers
+Some managment and statistics utils are provided to retrive the stored data
+
+### Utils provided by `LittleBrother::Utils` module:
+
+
+LittleBrother::Utils.truncate_watchers
+
+LittleBrother::Utils.keep_only_last_months
+
+LittleBrother::Utils.user_actions_in_timeframe
+
+
+### Statistics provided by `LittleBrother::Statistics` module:
+
+LittleBrother::Statistics.most_active_users
+
+LittleBrother::Statistics.least_active_users
+
+LittleBrother::Statistics.most_active_users_this_month
+
+LittleBrother::Statistics.least_active_users_this_month
+
+LittleBrother::Statistics.most_used_action
+
+LittleBrother::Statistics.least_used_action
+
+LittleBrother::Statistics.most_used_controller_action
+
+LittleBrother::Statistics.least_used_controller_action

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/db/migrate/create_watchers.rb

@@ -0,0 +1,19 @@
+class CreateWatchers < ActiveRecord::Migration
+  def self.up
+    create_table(:watchers) do |t|
+      t.string :user
+      t.string :controller
+      t.string :action
+      t.string :controller_action
+      t.string :user_ip
+      t.string :additional_info
+      t.string :params
+      t.timestamps  
+    end      
+  end
+
+  def self.down
+    drop_table :watchers
+  end  
+  
+end

data/lib/generators/little_brother_setup/little_brother_setup_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class LittleBrotherSetupGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+  source_root File.expand_path('../../../../', __FILE__)
+  
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end  
+  
+  def migration
+    unless watchers_table_exists? # SOURCE -> DESTINATION
+      puts "* watchers table creation migration was created!"
+      puts "* run rake db:migrate"
+      migration_template "db/migrate/create_watchers.rb", "db/migrate/create_watchers.rb"
+    end
+  end  
+  
+  def watchers_table_exists?
+    ActiveRecord::Base.connection.table_exists?(:watchers)
+  end  
+end

data/lib/little_brother/record.rb

@@ -0,0 +1,19 @@
+module LittleBrother
+  module Record
+    def self.included(base)
+      base.send :before_filter, :record
+    end
+
+    def record
+      unless request.nil?
+        w_user = defined?(watch_user) ? watch_user : ""
+        Watcher.create(:user_ip => request.remote_ip,
+                       :user => w_user,
+                       :params => params,
+                       :controller => controller_name,
+                       :action => action_name,
+                       :controller_action => controller_name+":"+action_name)            
+      end
+    end
+  end  
+end

data/lib/little_brother/statistics.rb

@@ -0,0 +1,42 @@
+module LittleBrother
+  class Statistics
+
+  	RECORD_LIMIT=10
+
+  	# User Statistics
+		def self.most_active_users limit=RECORD_LIMIT
+			Watcher.count(:all, :conditions => ['user IS NOT NULL'], :group => 'user', :order => "count_all desc", :limit => limit)
+  	end
+  
+  	def self.least_active_users limit=RECORD_LIMIT
+			Watcher.count(:all, :conditions => ['user IS NOT NULL'], :group => 'user', :order => "count_all asc", :limit => limit)
+  	end 
+
+  	def self.most_active_users_this_month limit=RECORD_LIMIT
+  		Watcher.count(:all, :conditions => ["user IS NOT NULL and created_at BETWEEN ? AND ?", Time.now.beginning_of_month, Time.now.end_of_month], :group => 'user', :order => "count_all desc", :limit => limit)
+	  end
+  
+  	def self.least_active_users_this_month limit=RECORD_LIMIT
+    	Watcher.count(:all, :conditions => ["user IS NOT NULL and created_at BETWEEN ? AND ?", Time.now.beginning_of_month, Time.now.end_of_month], :group => 'user', :order => "count_all asc", :limit => limit)
+  	end    	
+
+  	# Action Statistics
+		def self.most_used_action limit=RECORD_LIMIT
+    	Watcher.count(:all, :group => 'action', :order => "count_all desc", :limit => limit)
+  	end
+  
+  	def self.least_used_action limit=RECORD_LIMIT
+    	Watcher.count(:all, :group => 'action', :order => "count_all asc", :limit => limit)	
+  	end 
+
+  	# Controller Action Statistics
+		def self.most_used_controller_action limit=RECORD_LIMIT
+    	Watcher.count(:all, :group => 'controller_action', :order => "count_all desc", :limit => limit)
+  	end
+  
+  	def self.least_used_controller_action limit=RECORD_LIMIT
+    	Watcher.count(:all, :group => 'controller_action', :order => "count_all asc", :limit => limit)	
+  	end
+
+  end
+end

data/lib/little_brother/utils.rb

@@ -0,0 +1,22 @@
+module LittleBrother
+  class Utils
+    module ClassMethods
+
+      def truncate_watchers
+        ActiveRecord::Base.connection.execute("truncate table watchers") 
+      end
+
+      # TODO: Validate number_of_months
+      def keep_only_last_months(number_of_months)
+        Watcher.find(:all, :conditions => ['created_at < ?', Time.now-number_of_months.months])
+      end
+  
+      def user_actions_in_timeframe(user, start_date, end_date)
+        unless user.nil? || start_date.nil? || end_date.nil?
+          where(:user => user, :created_at => start_date..end_date)
+        end
+      end
+   
+    end
+  end
+end

data/lib/little_brother/version.rb

@@ -0,0 +1,3 @@
+module LittleBrother
+  VERSION = "0.0.2"
+end

data/lib/little_brother/watcher.rb

@@ -0,0 +1,9 @@
+module LittleBrother
+  class Watcher < ActiveRecord::Base
+
+  	 def params_as_hash
+    	eval(params)
+  	end
+  	
+  end  
+end

data/lib/little_brother.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+require 'little_brother/version'
+require 'little_brother/record'
+require 'little_brother/watcher'
+require 'little_brother/utils'
+require 'little_brother/statistics'

data/little_brother.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/little_brother/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Roger Correia"]
+  gem.email         = ["rogerpcorreia@gmail.com"]
+  gem.description   = %q{Controller request/action monitor}
+  gem.summary       = %q{Monitors/Stores every action passed through the controller. The data is stored for conveniently for later analysis and statistics.}
+  gem.homepage      = "https://github.com/rpc/little_brother"
+
+  gem.add_dependency('activerecord','>= 3.0.0')
+  gem.add_dependency('activesupport','>= 3.0.0')
+  gem.add_development_dependency  'rspec-rails'
+  gem.add_development_dependency  'rake'  
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "little_brother"
+  gem.require_paths = ["lib"]
+  gem.date          = '2012-08-30'
+  gem.version       = LittleBrother::VERSION
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'active_record'
+require 'active_support'
+#require 'rspec/rails'
+
+
+class TestApplicationController < ApplicationController
+
+	include LittleBrother::Record
+
+	#instance variable for watch_user
+  def watch_user
+    @watch_user = "John Doe"
+  end
+  helper_method :current_user
+
+  def index
+  	render :text => "OK"
+  end
+
+end

data/spec/watcher_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'TestApplication' do
+
+	it "should get index" do
+    # Note, rails 3.x scaffolding may add lines like get :index, {}, valid_session
+    # the valid_session overrides the devise login. Remove the valid_session from your specs
+    get 'index'
+    response.should be_success
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: little_brother
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Roger Correia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Controller request/action monitor
+email:
+- rogerpcorreia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- db/migrate/create_watchers.rb
+- lib/generators/little_brother_setup/little_brother_setup_generator.rb
+- lib/little_brother.rb
+- lib/little_brother/record.rb
+- lib/little_brother/statistics.rb
+- lib/little_brother/utils.rb
+- lib/little_brother/version.rb
+- lib/little_brother/watcher.rb
+- little_brother.gemspec
+- spec/spec_helper.rb
+- spec/watcher_spec.rb
+homepage: https://github.com/rpc/little_brother
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Monitors/Stores every action passed through the controller. The data is stored
+  for conveniently for later analysis and statistics.
+test_files:
+- spec/spec_helper.rb
+- spec/watcher_spec.rb