cia 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails2" do
+  gem 'activerecord', "2.3.14"
+end
+
+appraise "rails3" do
+  gem 'activerecord', "3.2.3"
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+gem 'rake'
+gem 'rspec', '~>2'
+gem 'appraisal'
+gem 'activerecord'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    cia (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.4)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  appraisal
+  cia!
+  rake
+  rspec (~> 2)
+  sqlite3

data/Rakefile

@@ -0,0 +1,27 @@
+require 'appraisal'
+require 'bundler/gem_tasks'
+
+task :default do
+  sh "bundle exec rake appraisal:install && bundle exec rake appraisal spec"
+end
+
+task :spec do
+  sh "rspec spec/"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/cia/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/Readme.md

@@ -0,0 +1,50 @@
+# Central Intelligent Auditing
+
+Audit model events like update/create/delete + attribute changes.<br/>
+ - very normalized and queryable through table layout
+```
+1 Transaction (actor/ip/time/...)
+ -> has many events (updated subject + message)
+   -> has many attribute changes (changed password from foo to bar on subject)
+```
+ - actors and subjects are polymorphic
+ - events come in different types like `ActiveAuditing::UpdateEvent`
+ - transactions wrap multiple events, a nice place to add debugging info like source/action/ip
+ - works on ActiveRecord 2 and 3
+
+Install
+=======
+    gem install active_auditing
+Or
+
+    rails plugin install git://github.com/grosser/cia.git
+
+
+Usage
+=====
+
+```Ruby
+class User < ActiveRecord::Base
+  audited_attributes :email, :crypted_password
+end
+
+class ApplicationController < ActionController::Base
+  around_filter :scope_auditing
+
+  def scope_auditing
+    Auditing.audit :actor => current_user, :ip_address => request.remote_ip do
+      yield
+    end
+  end
+end
+
+
+```
+
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://secure.travis-ci.org/grosser/cia.png)](http://travis-ci.org/grosser/cia)

data/cia.gemspec

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+name = "cia"
+require "#{name}/version"
+
+Gem::Specification.new name, CIA::VERSION do |s|
+  s.summary = "Audit model events like update/create/delete + attribute changes + grouped them by transaction, in normalized table layout for easy query access."
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
+end

data/gemfiles/rails2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rake"
+gem "rspec", "~>2"
+gem "appraisal"
+gem "sqlite3"
+gem "activerecord", "2.3.14"
+
+gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: /Users/mgrosser/code/tools/cia
+  specs:
+    cia (0.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.14)
+  appraisal
+  cia!
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/rails3.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rake"
+gem "rspec", "~>2"
+gem "appraisal"
+gem "sqlite3"
+gem "activerecord", "3.2.3"
+
+gemspec :path=>"../"

data/gemfiles/rails3.gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: /Users/mgrosser/code/tools/cia
+  specs:
+    cia (0.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.5)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.2.3)
+  appraisal
+  cia!
+  rake
+  rspec (~> 2)
+  sqlite3

data/lib/cia.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+require 'cia/version'
+require 'cia/auditable'
+require 'cia/null_transaction'
+require 'cia/transaction'
+require 'cia/event'
+require 'cia/create_event'
+require 'cia/update_event'
+require 'cia/delete_event'
+require 'cia/attribute_change'
+
+module CIA
+  def self.audit(options = {})
+    Thread.current[:audit_transaction] = Transaction.new(options)
+    yield
+  ensure
+    Thread.current[:audit_transaction] = nil
+  end
+
+  def self.current_transaction
+    Thread.current[:audit_transaction] || NullTransaction
+  end
+
+  def self.record_audit(event_type, object)
+    CIA.current_transaction.record(event_type, object)
+  rescue => e
+    Rails.logger.error("Failed to record audit: #{e}\n#{e.backtrace}")
+    raise e unless Rails.env.production?
+  end
+end

data/lib/cia/attribute_change.rb

@@ -0,0 +1,18 @@
+module CIA
+  class AttributeChange < ActiveRecord::Base
+    self.table_name = "audit_attribute_changes"
+
+    belongs_to :event, :foreign_key => "audit_event_id"
+    belongs_to :source, :polymorphic => true
+
+    validates_presence_of :event, :attribute_name, :source
+
+    if ActiveRecord::VERSION::MAJOR > 2
+      scope :previous, :order => "id desc"
+    else
+      named_scope :previous, :order => "id desc"
+    end
+
+    delegate :created_at, :to => :event
+  end
+end

data/lib/cia/auditable.rb

@@ -0,0 +1,21 @@
+module CIA
+  module Auditable
+    def self.included(base)
+      base.class_attribute :audited_attributes
+      base.send :extend, ClassMethods
+      base.after_create {|record| CIA.record_audit(CIA::CreateEvent, record) }
+      base.after_update {|record| CIA.record_audit(CIA::UpdateEvent, record) }
+      base.after_destroy {|record| CIA.record_audit(CIA::DeleteEvent, record) }
+    end
+
+    module ClassMethods
+      def audit_attribute(*attributes)
+        self.audited_attributes = Set.new unless audited_attributes
+        self.audited_attributes += attributes.map(&:to_s)
+
+        has_many :audit_events, :class_name => "CIA::Event", :as => :source
+        has_many :audit_attribute_changes, :class_name => "CIA::AttributeChange", :as => :source
+      end
+    end
+  end
+end

data/lib/cia/create_event.rb

@@ -0,0 +1,4 @@
+module CIA
+  class CreateEvent < Event
+  end
+end

data/lib/cia/delete_event.rb

@@ -0,0 +1,4 @@
+module CIA
+  class DeleteEvent < Event
+  end
+end

data/lib/cia/event.rb

@@ -0,0 +1,24 @@
+module CIA
+  class Event < ActiveRecord::Base
+    abstract_class
+    self.table_name = "audit_events"
+
+    belongs_to :source, :polymorphic => true
+    belongs_to :transaction, :foreign_key => :audit_transaction_id
+    has_many :attribute_changes, :foreign_key => :audit_event_id
+
+    validates_presence_of :transaction, :source, :type
+
+    # tested via transaction_test.rb
+    def record_attribute_changes!(changes)
+      changes.each do |attribute_name, (old_value, new_value)|
+        attribute_changes.create!(
+          :attribute_name => attribute_name,
+          :old_value => old_value,
+          :new_value => new_value,
+          :source => source
+        )
+      end
+    end
+  end
+end

data/lib/cia/null_transaction.rb

@@ -0,0 +1,6 @@
+module CIA
+  class NullTransaction
+    def self.record(*args)
+    end
+  end
+end

data/lib/cia/transaction.rb

@@ -0,0 +1,23 @@
+module CIA
+  class Transaction < ActiveRecord::Base
+    self.table_name = "audit_transactions"
+
+    belongs_to :actor, :polymorphic => true
+    has_many :events, :foreign_key => :audit_transaction_id
+
+    def record(event_type, source)
+      changes = source.changes.slice(*source.class.audited_attributes)
+      message = source.audit_message if source.respond_to?(:audit_message)
+
+      return if not message and changes.empty? and event_type == CIA::UpdateEvent
+
+      event = event_type.create!(
+        :source => source,
+        :transaction => self,
+        :message => message
+      )
+      event.record_attribute_changes!(changes)
+      event
+    end
+  end
+end

data/lib/cia/update_event.rb

@@ -0,0 +1,4 @@
+module CIA
+  class UpdateEvent < Event
+  end
+end

data/lib/cia/version.rb

@@ -0,0 +1,3 @@
+module CIA
+  VERSION = '0.1.0'
+end

data/spec/cia/attribute_change_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CIA::AttributeChange do
+  it "delegates create_at to event" do
+    t = Time.now
+    event = CIA::Event.new(:created_at => t)
+    change = CIA::AttributeChange.new(:event => event)
+    change.created_at.should == event.created_at
+  end
+
+  describe ".previous" do
+    it "finds by id desc" do
+      a = create_change
+      b = create_change
+      CIA::AttributeChange.previous.should == [b,a]
+    end
+  end
+end

data/spec/cia/event_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe CIA::Event do
+  it "has many attribute_changes" do
+    change = create_change
+    change.event.attribute_changes.should == [change]
+  end
+end

data/spec/cia/transaction_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe CIA::Transaction do
+  it "has many events" do
+    event = create_event
+    event.transaction.events.should == [event]
+  end
+
+  context "#record" do
+    def parse_event_changes(event)
+      event.attribute_changes.map { |c| [c.attribute_name, c.old_value, c.new_value] }
+    end
+
+    let(:transaction){ CIA::Transaction.new(:actor => User.create!) }
+
+    it "records attribute creations" do
+      source = Car.create!
+      source.wheels = 4
+      event = transaction.record(CIA::UpdateEvent, source)
+
+      parse_event_changes(event).should == [["wheels", nil, "4"]]
+    end
+
+    it "records multiple attributes" do
+      source = CarWith3Attributes.create!
+      source.wheels = 4
+      source.drivers = 2
+      source.color = "red"
+      event = transaction.record(CIA::UpdateEvent, source)
+
+      parse_event_changes(event).should =~ [["wheels", nil, "4"], ["drivers", nil, "2"], ["color", nil, "red"]]
+    end
+
+    it "records attribute changes" do
+      source = Car.create!(:wheels => 2)
+      source.wheels = 4
+      event = transaction.record(CIA::UpdateEvent, source)
+      parse_event_changes(event).should == [["wheels", "2", "4"]]
+    end
+
+    it "records attribute deletions" do
+      source = Car.create!(:wheels => 2)
+      source.wheels = nil
+      event = transaction.record(CIA::UpdateEvent, source)
+      parse_event_changes(event).should == [["wheels", "2", nil]]
+    end
+
+    it "does not record unaudited attribute changes" do
+      source = Car.create!
+      source.drivers = 2
+      event = nil
+      expect{
+        event = transaction.record(CIA::UpdateEvent, source)
+      }.to_not change{ CIA::Event.count }
+
+      event.should == nil
+    end
+
+    it "records audit_message as message even if there are no changes" do
+      source = CarWithAMessage.create!
+      source.audit_message = "Foo"
+      event = transaction.record(CIA::UpdateEvent, source)
+
+      event.message.should == "Foo"
+      parse_event_changes(event).should == []
+    end
+
+    it "record non-updates even without changes" do
+      source = Car.create!
+      event = transaction.record(CIA::CreateEvent, source)
+
+      parse_event_changes(event).should == []
+    end
+  end
+end

data/spec/cia_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe CIA do
+  it "has a VERSION" do
+    CIA::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  describe ".audit" do
+    it "has no transaction when it starts" do
+      CIA.current_transaction.should == CIA::NullTransaction
+    end
+
+    it "starts a new transaction" do
+      result = 1
+      CIA.audit({}) do
+        result = CIA.current_transaction
+      end
+      result.class.should == CIA::Transaction
+    end
+
+    it "stops the transaction after the block" do
+      CIA.audit({}){}
+      CIA.current_transaction.should == CIA::NullTransaction
+    end
+
+    it "returns the block content" do
+      CIA.audit({}){ 1 }.should == 1
+    end
+
+    it "is threadsafe" do
+      Thread.new do
+        CIA.audit({}) do
+          sleep 0.04
+        end
+      end
+      sleep 0.01
+      CIA.current_transaction.should == CIA::NullTransaction
+      sleep 0.04 # so next tests dont fail
+    end
+  end
+
+  describe ".record_audit" do
+    let(:object) { Car.new }
+    let(:transaction) { CIA.current_transaction }
+
+    around do |example|
+      CIA.audit :actor => User.create! do
+        example.call
+      end
+    end
+
+    before do
+      Rails.stub(:logger).and_return(mock(:error => ""))
+      Rails.env.stub(:production?).and_return(true)
+    end
+
+    it "tracks create" do
+      expect{
+        object.save!
+      }.to change{ CIA::Event.count }.by(+1)
+      CIA::Event.last.class.should == CIA::CreateEvent
+    end
+
+    it "tracks delete" do
+      object.save!
+      expect{
+        object.destroy
+      }.to change{ CIA::Event.count }.by(+1)
+      CIA::Event.last.class.should == CIA::DeleteEvent
+    end
+
+    it "tracks update" do
+      object.save!
+      expect{
+        object.update_attributes(:wheels => 3)
+      }.to change{ CIA::Event.count }.by(+1)
+      CIA::Event.last.class.should == CIA::UpdateEvent
+    end
+
+    context "exceptions" do
+      before do
+        Rails.stub(:logger).and_return(mock(:error => ""))
+        Rails.env.stub(:production?).and_return(true)
+        transaction.stub(:record).and_raise(StandardError.new("foo"))
+      end
+
+      it "logs exceptions raised by the transaction" do
+        Rails.logger.should_receive(:error).with { |x| x =~ /Failed to record audit: foo/ }
+        object.save! rescue nil
+      end
+
+      it "re-raise exceptions when not in production" do
+        Rails.env.stub(:production?).and_return(false)
+
+        expect {
+          object.save!
+        }.to raise_error(StandardError)
+      end
+
+      it "does not re-raise exceptions when in production" do
+        Rails.env.stub(:production?).and_return(true)
+        object.save!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+$LOAD_PATH.unshift 'lib'
+require 'cia'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :audit_transactions do |t|
+    t.integer :actor_id, :null => false
+    t.string :actor_type, :null => false
+    t.string :ip_address
+    t.timestamp :created_at
+  end
+
+  create_table :audit_events do |t|
+    t.string :type, :source_type, :null => false
+    t.integer :audit_transaction_id, :source_id, :null => false
+    t.string :message
+    t.timestamp :created_at
+  end
+
+  create_table :audit_attribute_changes do |t|
+    t.integer :audit_event_id, :source_id, :null => false
+    t.string :attribute_name, :source_type, :null => false
+    t.string :old_value, :new_value
+  end
+
+  create_table :cars do |t|
+    t.integer :wheels
+    t.integer :drivers
+    t.string :color
+  end
+
+  create_table :users do |t|
+    t.string :email
+  end
+end
+
+class User < ActiveRecord::Base
+end
+
+class Car < ActiveRecord::Base
+  include CIA::Auditable
+  audit_attribute :wheels
+end
+
+class CarWithAMessage < ActiveRecord::Base
+  self.table_name = "cars"
+  include CIA::Auditable
+  audit_attribute :wheels
+  attr_accessor :audit_message
+end
+
+class CarWith3Attributes < ActiveRecord::Base
+  self.table_name = "cars"
+  include CIA::Auditable
+  audit_attribute :wheels, :color
+  audit_attribute :drivers
+end
+
+class CarWithoutObservers < ActiveRecord::Base
+  self.table_name = "cars"
+end
+
+class CarWithoutObservers2 < ActiveRecord::Base
+  self.table_name = "cars"
+end
+
+def create_event
+  transaction = CIA::Transaction.create!(:actor => User.create!)
+  CIA::UpdateEvent.create!(:source => Car.create!, :transaction => transaction)
+end
+
+def create_change
+  event = create_event
+  CIA::AttributeChange.create!(:event => event, :source => event.source, :attribute_name => "bar")
+end
+
+module Rails
+  def self.logger
+    raise "NOT STUBBED"
+  end
+
+  def self.env
+    @@env ||= "NOT STUBBED"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: cia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-21 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- cia.gemspec
+- gemfiles/rails2.gemfile
+- gemfiles/rails2.gemfile.lock
+- gemfiles/rails3.gemfile
+- gemfiles/rails3.gemfile.lock
+- lib/cia.rb
+- lib/cia/attribute_change.rb
+- lib/cia/auditable.rb
+- lib/cia/create_event.rb
+- lib/cia/delete_event.rb
+- lib/cia/event.rb
+- lib/cia/null_transaction.rb
+- lib/cia/transaction.rb
+- lib/cia/update_event.rb
+- lib/cia/version.rb
+- spec/cia/attribute_change_spec.rb
+- spec/cia/event_spec.rb
+- spec/cia/transaction_spec.rb
+- spec/cia_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/cia
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3376077843642118516
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3376077843642118516
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Audit model events like update/create/delete + attribute changes + grouped
+  them by transaction, in normalized table layout for easy query access.
+test_files: []