appmospheres_audit 0.1.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+log/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,8 @@
+== 0.1.0
+First release.
+
+== 0.1.1
+Also track ID of the changed record on update.
+
+== 0.1.2
+Added configuration options - it can filter out parameters/attributes and actions before logging.

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Appmospheres
+
+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

@@ -0,0 +1,24 @@
+A gem for tracking model changes and controller actions.
+
+USAGE
+Run 'rails generate appmospheres_audit:migration' to generate the migration for the log events.
+Run 'rails sappmospheres_audit:config' to generate a configuration initializer (in config/initializers/appmospheres_audit.rb).
+
+Track models with enable_record_tracking:
+class User < ActiveRecord::Base
+  enable_record_tracking
+  ...
+end
+
+Track actions with enable_action_tracking:
+class MyController < ApplicationController
+  enable_action_tracking
+  ...
+end
+
+The payload of any event log record will be a YAML string. An event log tracking a model will record:
+* on create: ID of the newly created record
+* on update: list of changes (keys and values), excluding those explicitely filtered by setting Rails.application.config.filter_parameters and/or AppmospheresAudit.filter_parameters.
+* on destroy: serialized record, excluding the attributes filtered by setting Rails.application.config.filter_parameters and/or AppmospheresAudit.filter_parameters.
+
+Tracking actions in a controller will create an event log record with the name of the action and the parameters passed to the action, except those filtered by setting Rails.application.config.filter_parameters and/or AppmospheresAudit.filter_parameters.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO

@@ -0,0 +1,3 @@
+* Track the name of the controller, too
+* Add some use cases, with code.
+

data/appmospheres_audit.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "appmospheres_audit/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = "appmospheres_audit"
+  s.version     = AppmospheresAudit::VERSION
+  s.authors     = ["eugen neagoe", "Koen Handekyn"]
+  s.email       = ["eugen.neagoe@appmospheres.com", "koen.handekyn@appmospheres.com"]
+  s.homepage    = "https://github.com/appmospheres/appmospheres_audit"
+  s.summary     = %q{A gem for tracking record changes and controller actions}
+  s.description = %q{A gem for tracking record changes and controller actions}
+
+  s.rubyforge_project = "appmospheres_audit"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.licenses = ['MIT']
+
+  s.add_dependency "rails", ">= 3.0.0"
+
+  s.add_development_dependency "ammeter"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "rails", ">= 3.0.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+
+end

data/lib/appmospheres_audit.rb

@@ -0,0 +1,129 @@
+require "active_record"
+require "action_controller"
+
+require "appmospheres_audit/version"
+require "appmospheres_audit/event_log"
+
+module AppmospheresAudit
+
+  def self.configure
+    yield(self) if block_given?
+  end
+
+  class << self
+
+    # stores a hash of options given to the +configure+ block.
+    def options
+      @options ||= {}
+    end
+
+    # set or get the configuration parameters
+    def method_missing(symbol, *args)
+      if (method = symbol.to_s).sub!(/\=$/, '')
+        options[method.to_sym] = args.first
+      else
+        options[method.to_sym]
+      end
+    end
+
+  end
+
+  module SupportTrail
+
+    def log_exception(ex)
+      begin
+        EventLog.create!(:event_type => ex.class.to_s, :action => "exception", :payload => ex.backtrace.to_yaml)
+      rescue
+        Rails.logger.warn "Could not log event 'exception' for #{ex.class.to_s}:#{ex.backtrace.inspect}" rescue nil
+      end
+    end
+
+  end
+
+  module RecordTrail
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def enable_record_tracking
+        # set up after filters for create/update/destroy
+        after_create :track_create
+        after_update :track_update
+        after_destroy :track_destroy
+      end
+
+    end
+
+    def track_create
+      begin
+        EventLog.create!(:event_type => self.class.to_s, :action => "create", :payload => self.id.to_yaml)
+      rescue
+        Rails.logger.warn "Could not log event 'create' for #{self.class.to_s}:#{self.id}" rescue true
+      end
+    end
+
+    def track_update
+      begin
+        filtered_params = Rails.application.config.filter_parameters + (AppmospheresAudit.filter_parameters || [])
+        EventLog.create!(:event_type => self.class.to_s, :action => "update",
+          :payload => self.changes.merge({:id => self.id}).except(*filtered_params).to_yaml)
+      rescue
+        Rails.logger.warn "Could not log event 'update' for #{self.class.to_s}:#{self.changes.inspect}" rescue true
+      end
+    end
+
+    def track_destroy
+      begin
+        filtered_params = Rails.application.config.filter_parameters + (AppmospheresAudit.filter_parameters || [])
+        EventLog.create!(:event_type => self.class.to_s, :action => "destroy", :payload => self.serializable_hash.except(*filtered_params.map(&:to_s)).to_yaml)
+      rescue
+        Rails.logger.warn "Could not log event 'destroy' for #{self.class.to_s}:#{self.inspect}" rescue true
+      end
+    end
+
+  end
+
+  module ControllerTrail
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, AppmospheresAudit::SupportTrail
+    end
+
+    module ClassMethods
+
+      def enable_action_tracking
+        around_filter do |controller, action|
+          begin
+            begin
+              filtered_actions = AppmospheresAudit.filter_actions || []
+              unless filtered_actions.include?(controller.action_name.to_sym) || filtered_actions.include?(controller.action_name)
+                filtered_params = Rails.application.config.filter_parameters + (AppmospheresAudit.filter_parameters || [])
+                EventLog.create!(:event_type => 'controller', :action => controller.request.parameters[:action],
+                  :payload => controller.request.parameters.except(*filtered_params).to_yaml)
+              end
+            rescue
+              Rails.logger.warn "tracked #{controller.request.parameters.inspect}" rescue nil
+            end
+            action.call
+          rescue Exception => e
+            log_exception(e)
+            raise # again, so the execution continues as intended by the app
+          end
+        end
+      end
+
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.class_eval do
+  include AppmospheresAudit::RecordTrail
+end
+
+ActionController::Base.class_eval do
+  include AppmospheresAudit::ControllerTrail
+end

data/lib/appmospheres_audit/event_log.rb

@@ -0,0 +1,5 @@
+class EventLog < ActiveRecord::Base
+
+  attr_accessible :event_type, :action, :payload
+
+end

data/lib/appmospheres_audit/version.rb

@@ -0,0 +1,3 @@
+module AppmospheresAudit
+  VERSION = "0.1.2"
+end

data/lib/generators/appmospheres_audit/config_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module AppmospheresAudit
+
+  class ConfigGenerator < Rails::Generators::Base
+
+    source_root File.expand_path(File.dirname(__FILE__))
+
+    desc "Adds a config initializer to config/initializers/appmospheres.rb"
+    def copy_files
+      template 'templates/config/appmospheres.rb', 'config/initializers/appmospheres_audit.rb'
+    end
+
+  end
+
+end

data/lib/generators/appmospheres_audit/migration_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module AppmospheresAudit
+
+  class MigrationGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    desc "Generates migration for the EventLog model"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/appmospheres_audit_migration'
+      end
+    end
+
+  end
+
+end
+

data/lib/generators/appmospheres_audit/templates/active_record/migration.rb

@@ -0,0 +1,24 @@
+class AppmospheresAuditMigration < ActiveRecord::Migration
+
+  def self.up
+
+    create_table :event_logs do |t|
+      t.string :event_type
+      t.string :action
+      t.text :payload
+
+      t.datetime :reported_at
+      t.timestamps
+    end
+
+    add_index :event_logs, :event_type
+    add_index :event_logs, :action
+    add_index :event_logs, :reported_at
+
+  end
+
+  def self.down
+    drop_table :event_logs
+  end
+
+end

data/lib/generators/appmospheres_audit/templates/config/appmospheres.rb

@@ -0,0 +1,6 @@
+AppmospheresAudit.configure do |config|
+  # the parameters listed here will not be serialized in the event logs
+  config.filter_parameters = [:password]
+  # the actions listed here will not be recorded in the event logs
+  #config.filter_actions = [:edit, :new]
+end

data/spec/appmospheres_audit/action_tracking_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe AppmospheresAudit::ControllerTrail do
+
+  describe "enable_action_tracking", :type => :request do
+
+    it "should record every controller action when enabled" do
+      expect { get '/users' }.to change(EventLog, :count).by(1)
+    end
+
+    it "should not track filtered actions" do
+      AppmospheresAudit.filter_actions = [:index]
+      expect { get '/users' }.not_to change(EventLog, :count)
+    end
+
+  end
+
+end

data/spec/appmospheres_audit/exception_logger_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AppmospheresAudit::SupportTrail do
+
+  describe 'log_exception' do
+
+    include AppmospheresAudit::SupportTrail
+
+    it "should create an event log record" do
+      expect { log_exception(Exception.new) }.to change(EventLog, :count).by(1)
+    end
+
+  end
+
+end

data/spec/appmospheres_audit/record_tracking_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe AppmospheresAudit::RecordTrail do
+
+  describe "enable_record_tracking" do
+
+    before(:each) { User.create! }
+
+    describe "create" do
+      it "should create an event log when a new record is created" do
+        expect { User.create! }.to change(EventLog, :count).by(1)
+      end
+    end
+
+    describe "update" do
+
+      it "should create an event log when a record is updated" do
+        expect { User.first.update_attribute(:name, "") }.to change(EventLog, :count).by(1)
+      end
+
+      it "should not include filtered parameters in the event log payload" do
+        AppmospheresAudit.filter_parameters = [:name]
+        User.first.update_attribute(:name, "changed")
+        changes = YAML::load(EventLog.where(:event_type => 'User', :action => 'update').last.payload)
+        changes.should_not include(:name)
+      end
+
+    end
+
+    describe "destroy" do
+
+      it "should create an event log when a record is deleted" do
+        expect { User.first.destroy }.to change(EventLog, :count).by(1)
+      end
+
+      it "should not include filtered parameters in the event log payload" do
+        AppmospheresAudit.filter_parameters = [:name]
+        User.first.destroy
+        record = YAML::load(EventLog.where(:event_type => 'User', :action => 'destroy').last.payload)
+        record.should_not include(:name)
+      end
+
+    end
+
+  end
+
+end

data/spec/fake_app.rb

@@ -0,0 +1,65 @@
+require 'active_record'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+# database
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+# config
+app = Class.new(Rails::Application)
+app.config.secret_token = "fada08cee25221c8f94cd4469710c402fc40c4100a2f72f101f18233002f7016fc7004c09e68e201dbcf1bf92d5bfec98638ac239590980352e56b406dc50286"
+app.config.session_store :cookie_store, :key => "_myfakeapp_session"
+app.config.active_support.deprecation = :log
+app.initialize!
+
+# routes
+app.routes.draw do
+  resources :users
+end
+
+# models
+class User < ActiveRecord::Base
+  enable_record_tracking
+end
+
+# controllers
+class ApplicationController < ActionController::Base
+  enable_action_tracking
+end
+class UsersController < ApplicationController
+  def index
+    @users = User.all
+    render :inline => <<-ERB
+<%= @users.map(&:name).join("\n") %>
+ERB
+  end
+end
+
+# helpers
+Object.const_set(:ApplicationHelper, Module.new)
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+
+  def self.up
+
+    create_table(:users) {|t| t.string :name }
+
+    create_table :event_logs do |t|
+      t.string :event_type
+      t.string :action
+      t.text :payload
+
+      t.datetime :reported_at
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :event_logs
+    drop_table :users
+  end
+
+end

data/spec/generators/appmospheres_audit/migration/migration_generator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+# Generators are not automatically loaded by Rails
+require 'generators/appmospheres_audit/migration_generator'
+
+describe AppmospheresAudit::MigrationGenerator do
+
+  # Tell the generator where to put its output (what it thinks of as Rails.root)
+  destination File.expand_path("../../../../../tmp", __FILE__)
+
+  before do
+    prepare_destination
+    Rails::Generators.options[:rails][:orm] = :active_record
+  end
+
+  describe 'no arguments' do
+
+    before { run_generator }
+
+    describe 'db/migrate/appmospheres_audit_migration.rb' do
+      subject { file('db/migrate/appmospheres_audit_migration.rb') }
+      it { should be_a_migration }
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+require 'rails'
+require File.expand_path('../../lib/appmospheres_audit', __FILE__)
+require 'ammeter/init'
+require 'database_cleaner'
+require 'fake_app'
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? :users
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,13 @@
+DatabaseCleaner.strategy = :transaction
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification 
+name: appmospheres_audit
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- eugen neagoe
+- Koen Handekyn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ammeter
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: A gem for tracking record changes and controller actions
+email: 
+- eugen.neagoe@appmospheres.com
+- koen.handekyn@appmospheres.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- TODO
+- appmospheres_audit.gemspec
+- lib/appmospheres_audit.rb
+- lib/appmospheres_audit/event_log.rb
+- lib/appmospheres_audit/version.rb
+- lib/generators/appmospheres_audit/config_generator.rb
+- lib/generators/appmospheres_audit/migration_generator.rb
+- lib/generators/appmospheres_audit/templates/active_record/migration.rb
+- lib/generators/appmospheres_audit/templates/config/appmospheres.rb
+- spec/appmospheres_audit/action_tracking_spec.rb
+- spec/appmospheres_audit/exception_logger_spec.rb
+- spec/appmospheres_audit/record_tracking_spec.rb
+- spec/fake_app.rb
+- spec/generators/appmospheres_audit/migration/migration_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+homepage: https://github.com/appmospheres/appmospheres_audit
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: appmospheres_audit
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A gem for tracking record changes and controller actions
+test_files: 
+- spec/appmospheres_audit/action_tracking_spec.rb
+- spec/appmospheres_audit/exception_logger_spec.rb
+- spec/appmospheres_audit/record_tracking_spec.rb
+- spec/fake_app.rb
+- spec/generators/appmospheres_audit/migration/migration_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+has_rdoc: