view_trail 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Yoon
+
+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,76 @@
+# ViewTrail
+
+ViewTrail lets you track controllers and views that you select for auditing. You can see who look at what (controller/action/params hash) and when.
+
+## Rails Version
+
+Works with Rails 2.3.
+
+## Usage
+
+    class FooController < ActionController::Base
+      has_view_trail :except => :index
+      
+      def index
+      end
+        
+      def search
+        @results = Model.search(params[:query])
+        
+        audit({:results => @results.map(&:id), :flag => "blue"})
+      end
+    end
+
+    Takes :except and :only conditions like other controller filters
+    
+    Also allows you to audit an arbitrary key/value hash
+    
+    For example: when you visit /foo/search?query=pie
+    
+    >> Activities.last.whodiddit      #=> (@controller.current_user)
+    >> Activities.last.created_at     #=> (date/time of activity)
+    >> Activities.last.controller     #=> FooController
+    >> Activities.last.action         #=> "search"
+    >> Activities.last.params         #=> {:query => "pie"}
+    >> Activities.last.activity_items #=> [{:key => :results, :value => [2, 12, 14]}], [{:key => :flag, :value => "blue"}]
+    
+## Installation
+
+1. Install ViewTrail as a gem:
+  
+    `config.gem 'yoon-view_trail', :lib => 'view_trail', :source => 'http://gems.github.com'`
+
+2. Create a migration for the `versions` table
+    
+    `script/generate view_trail`
+  
+3. Run the migration.
+    
+    `rake db:migrate`
+  
+4. Add `has view_trail` to the controllers you want to track
+
+## Issues
+
+Please submit issues via GitHub's [Issue Tracker](http://github.com/yoon/view_trail/issues)
+
+## History
+
+0.3.1
+
+Fixed conflict with paper trail whodunnit. To upgrade:
+
+    `rake db:migrate:down`
+
+remove old migration and re-run
+
+    `script/generate view_trail`
+    `rake db:migrate`
+
+## Inspiration
+
+* [PaperTrail](http://github.com/airblade/paper_trail/)
+
+## Intellectual Property
+
+Copyright (c) 2009 Mark Yoon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "view_trail"
+    gem.summary = %Q{View trail tracks controller actions in Rails.}
+    gem.description = %Q{View trail tracks controller actions in Rails.}
+    gem.email = "yoon@northwestern.edu"
+    gem.homepage = "http://github.com/yoon/view_trail"
+    gem.authors = ["Mark Yoon"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "view_trail #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# $:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/features/step_definitions/view_trail_steps.rb

@@ -0,0 +1,37 @@
+Given /^I current user is (\d*)$/ do |id|
+  ApplicationController.cu = id
+end
+
+Given /^I have 0 activities$/ do
+  Activity.destroy_all
+end
+
+Given /^I ([^ ]*) the ([^ ]*) page$/ do |method, page|
+  visit page, method.to_sym
+end
+
+Then /^I should have (\d*) activities$/ do |number|
+  Activity.count.should == number.to_i
+end
+
+Then /^the last activity should have "([^\"]*)" ([^ ]*)$/ do |value, key|
+  Activity.last.send(key.to_sym).to_s.should == value
+end
+
+Given /^I ([^ ]*) the ([^ ]*) page with params$/ do |method, page|
+    visit(page, method.to_sym, {:check => "yourself"})
+end
+
+Then /^the last activity should have params$/ do
+  HashWithIndifferentAccess.new(Activity.last.params).should == HashWithIndifferentAccess.new({:check => "yourself"})
+end
+
+Then /^the last activity should have data$/ do
+  Activity.last.activity_items.should have(2).activity_items
+  Activity.last.activity_items.first.key.should == "pi"
+  Activity.last.activity_items.first.value.should == [3,1,4,1,5,9]
+  Activity.last.activity_items.last.key.should == "pie"
+  Activity.last.activity_items.last.value.should == ["apple", "blueberry", "pecan", "strawberry"]
+end
+
+

data/features/step_definitions/webrat_steps.rb

@@ -0,0 +1,119 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+Given /^I am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value) 
+end
+
+When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field) 
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time 
+When /^I select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or 
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it. 
+When /^I select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^I select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^I check "([^\"]*)"$/ do |field|
+  check(field) 
+end
+
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field) 
+end
+
+When /^I choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  attach_file(field, path)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  response.should contain(text)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response.should_not contain(text)
+end
+
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should_not =~ /#{value}/
+end
+    
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  field_labeled(label).should be_checked
+end
+
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  field_labeled(label).should_not be_checked
+end
+
+Then /^I should be on (.+)$/ do |page_name|
+  URI.parse(current_url).path.should == path_to(page_name)
+end

data/features/support/env.rb

@@ -0,0 +1,51 @@
+# Sets up the Rails environment for Cucumber
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../../..'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+require 'cucumber/rails/world'
+
+# Sets up webrat
+require 'webrat'
+
+Webrat.configure do |config|
+  config.mode = :rails
+end
+
+require 'cucumber/rails/rspec'
+require 'webrat/core/matchers'
+
+# Sets up controllers
+require 'application_controller'
+require 'view_trail'
+
+class ApplicationController
+  def rescue_action(e)
+    raise e
+  end
+  cattr_accessor :cu
+  # Returns id of hypothetical current user
+  def current_user
+    self.cu
+  end
+end
+
+class FooController < ApplicationController
+  has_view_trail :except => :bar
+  def foo
+    head :ok
+  end
+  def bar
+    head :ok
+  end
+  def baz
+    audit({:pi => [3,1,4,1,5,9], :pie => ["apple", "blueberry", "pecan", "strawberry"]})
+    head :ok
+  end
+end
+
+# Sets up routes
+ActionController::Routing::Routes.draw do |map|
+  map.foo "/foo", :controller => "foo", :action => "foo"
+  map.bar "/bar", :controller => "foo", :action => "bar"
+  map.baz "/baz", :controller => "foo", :action => "baz"
+end

data/features/support/paths.rb

@@ -0,0 +1,27 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in webrat_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+    
+    when /the homepage/
+      default_path
+    
+    # Add more mappings here.
+    # Here is a more fancy example:
+    #
+    #   when /^(.*)'s profile page$/i
+    #     user_profile_path(User.find_by_login($1))
+
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/view_trail.feature

@@ -0,0 +1,49 @@
+Feature: ViewTrail
+  In order to audit requests made to my app
+  I want to record the controller, action, params, and method
+  
+  Background:
+    Given I current user is 312
+    
+  Scenario: GET request
+    Given I have 0 activities
+    When I get the foo page
+    Then I should have 1 activities
+    And the last activity should have "312" whodiddit
+    And the last activity should have "foo" action
+    And the last activity should have "foo" controller
+    And the last activity should have "" params
+    
+  Scenario: POST request
+    When I post the foo page
+    Then I should have 2 activities
+    And the last activity should have "312" whodiddit
+    And the last activity should have "foo" action
+      
+  Scenario: PUT request
+    Given I put the foo page
+    Then I should have 3 activities
+    And the last activity should have "312" whodiddit
+    And the last activity should have "foo" action
+
+  Scenario: DELETE request
+    Given I delete the foo page
+    Then I should have 4 activities
+    And the last activity should have "312" whodiddit
+    And the last activity should have "foo" action
+
+  Scenario: GET request with params
+    Given I get the foo page with params
+    Then I should have 5 activities
+    And the last activity should have params
+
+  Scenario: GET request with params and arbitrary data
+    Given I get the baz page with params
+    Then I should have 6 activities
+    And the last activity should have data
+    And the last activity should have params
+
+  Scenario: GET request on excepted path
+    Given I have 0 activities
+    When I get the bar page
+    Then I should have 0 activities

data/generators/view_trail/templates/create_activities_and_items.rb

@@ -0,0 +1,21 @@
+class CreateActivitiesAndItems < ActiveRecord::Migration
+  def self.up
+    create_table :activities do |t|
+      t.string   :controller
+      t.string   :action
+      t.text     :params
+      t.string   :whodiddit
+      t.datetime :created_at
+    end  
+    create_table :activity_items do |t|
+      t.integer :activity_id
+      t.string  :key
+      t.text    :value
+    end
+  end
+
+  def self.down
+    drop_table :activities
+    drop_table :activity_items
+  end
+end

data/generators/view_trail/view_trail_generator.rb

@@ -0,0 +1,10 @@
+class ViewTrailGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.migration_template 'create_activities_and_items.rb', 'db/migrate', :migration_file_name => 'create_activities_and_items'
+    end
+
+  end
+
+end

data/lib/view_trail/activity.rb

@@ -0,0 +1,4 @@
+class Activity < ActiveRecord::Base
+  serialize :params
+  has_many :activity_items
+end

data/lib/view_trail/activity_item.rb

@@ -0,0 +1,3 @@
+class ActivityItem < ActiveRecord::Base
+  serialize :value
+end

data/lib/view_trail.rb

@@ -0,0 +1,61 @@
+require 'view_trail/activity'
+require 'view_trail/activity_item'
+
+module ViewTrail
+  @@whodiddit = nil
+  
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.before_filter :set_whodiddit
+  end
+
+  def self.whodiddit
+    @@whodiddit.respond_to?(:call) ? @@whodiddit.call : @@whodiddit
+  end
+
+  def self.whodiddit=(value)
+    @@whodiddit = value
+  end
+
+  private
+
+  def set_whodiddit
+    @@whodiddit = lambda {
+      self.respond_to?(:current_user) ? self.current_user : nil
+    }
+  end
+
+  module ClassMethods
+    def has_view_trail(*conditions)
+      before_filter :set_whodiddit
+      after_filter(:record_activity, conditions)
+      cattr_accessor :view_trail_active
+      self.view_trail_active = true
+      send :include, InstanceMethods
+    end
+
+    def view_trail_off
+      self.view_trail_active = false
+    end
+    def view_trail_on
+      self.view_trail_active = true
+    end  
+  end
+  
+  module InstanceMethods
+    def audit(items)
+      @activity_items = items
+    end
+    def record_activity
+      if self.class.view_trail_active
+        a = Activity.create(:whodiddit => ViewTrail.whodiddit, :controller => params.delete(:controller), :action => params.delete(:action), :params => params)
+        (@activity_items || {}).each do |k,v|
+          a.activity_items.create(:key => k.to_s, :value => v)
+        end
+        @activity_items = nil
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, ViewTrail

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'spec'
+
+# load rails
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+# load view_trail
+# $LOAD_PATH.unshift(File.dirname(__FILE__))
+# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+# require 'view_trail'
+
+Spec::Runner.configure do |config|
+end

data/spec/view_trail_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ViewTrail" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/view_trail.gemspec

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{view_trail}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Yoon"]
+  s.date = %q{2009-08-14}
+  s.description = %q{View trail tracks controller actions in Rails.}
+  s.email = %q{yoon@northwestern.edu}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "features/step_definitions/view_trail_steps.rb",
+     "features/step_definitions/webrat_steps.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "features/view_trail.feature",
+     "generators/view_trail/templates/create_activities_and_items.rb",
+     "generators/view_trail/view_trail_generator.rb",
+     "lib/view_trail.rb",
+     "lib/view_trail/activity.rb",
+     "lib/view_trail/activity_item.rb",
+     "spec/spec_helper.rb",
+     "spec/view_trail_spec.rb",
+     "view_trail.gemspec"
+  ]
+  s.homepage = %q{http://github.com/yoon/view_trail}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{View trail tracks controller actions in Rails.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/view_trail_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: view_trail
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Mark Yoon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-14 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: View trail tracks controller actions in Rails.
+email: yoon@northwestern.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- features/step_definitions/view_trail_steps.rb
+- features/step_definitions/webrat_steps.rb
+- features/support/env.rb
+- features/support/paths.rb
+- features/view_trail.feature
+- generators/view_trail/templates/create_activities_and_items.rb
+- generators/view_trail/view_trail_generator.rb
+- lib/view_trail.rb
+- lib/view_trail/activity.rb
+- lib/view_trail/activity_item.rb
+- spec/spec_helper.rb
+- spec/view_trail_spec.rb
+- view_trail.gemspec
+has_rdoc: true
+homepage: http://github.com/yoon/view_trail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.4
+signing_key: 
+specification_version: 3
+summary: View trail tracks controller actions in Rails.
+test_files: 
+- spec/spec_helper.rb
+- spec/view_trail_spec.rb