yoon-view_trail 0.2.0

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,49 @@
+# 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
+    end
+
+Takes :except and :only conditions like other controller filters
+    
+    >> Activities.last.whodunnit
+    >> Activities.last.created_at
+    >> Activities.last.controller
+    >> Activities.last.action
+    >> Activities.last.params
+    
+## 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
+
+## TODO
+
+Test!
+
+## Inspiration
+
+* [PaperTrail](http://github.com/airblade/paper_trail/)
+
+## Intellectual Property
+
+Copyright (c) 2009 Mark Yoon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+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
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/generators/view_trail/templates/create_activities.rb

@@ -0,0 +1,17 @@
+class CreateActivities < ActiveRecord::Migration
+  def self.up
+    create_table :activities do |t|
+      t.string   :controller
+      t.string   :action
+      t.text     :params
+      t.string   :whodunnit
+      t.datetime :created_at
+    end
+    # add_index :activities, [:item_type, :item_id]
+  end
+
+  def self.down
+    # remove_index :activities, [:item_type, :item_id]
+    drop_table :activities
+  end
+end

data/generators/view_trail/view_trail_generator.rb

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

data/lib/view_trail/activity.rb

@@ -0,0 +1,3 @@
+class Activity < ActiveRecord::Base
+
+end

data/lib/view_trail.rb

@@ -0,0 +1,53 @@
+require 'view_trail/activity'
+
+module ViewTrail
+  @@whodunnit = nil
+  
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.before_filter :set_whodunnit
+  end
+
+  def self.whodunnit
+    @@whodunnit.respond_to?(:call) ? @@whodunnit.call : @@whodunnit
+  end
+
+  def self.whodunnit=(value)
+    @@whodunnit = value
+  end
+
+  private
+
+  def set_whodunnit
+    @@whodunnit = lambda {
+      self.respond_to?(:current_user) ? self.current_user : nil
+    }
+  end
+
+  module ClassMethods
+    def has_view_trail(&block)
+      before_filter :set_whodunnit
+      after_filter(:record_activity, &block)
+      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 record_activity
+      if self.class.view_trail_active
+        Activity.create(:whodunnit => ViewTrail.whodunnit, :controller => params.delete(:controller), :action => params.delete(:action), :params => params.inspect)
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, ViewTrail

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$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,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{view_trail}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Yoon"]
+  s.date = %q{2009-07-15}
+  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",
+     "generators/view_trail/templates/create_activities.rb",
+     "generators/view_trail/view_trail_generator.rb",
+     "lib/view_trail.rb",
+     "lib/view_trail/activity.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,67 @@
+--- !ruby/object:Gem::Specification 
+name: yoon-view_trail
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mark Yoon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-15 00:00:00 -07: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
+- generators/view_trail/templates/create_activities.rb
+- generators/view_trail/view_trail_generator.rb
+- lib/view_trail.rb
+- lib/view_trail/activity.rb
+- spec/spec_helper.rb
+- spec/view_trail_spec.rb
+- view_trail.gemspec
+has_rdoc: false
+homepage: http://github.com/yoon/view_trail
+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.2.0
+signing_key: 
+specification_version: 3
+summary: View trail tracks controller actions in Rails.
+test_files: 
+- spec/spec_helper.rb
+- spec/view_trail_spec.rb