cia 0.2.3 → 0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cia (0.2.3)
+    cia (0.3.0)
 
 GEM
   remote: http://rubygems.org/

data/MIGRATION.rb

@@ -1,15 +1,11 @@
-create_table :cia_transactions do |t|
+create_table :cia_events do |t|
   t.integer :actor_id
   t.string :actor_type
+  t.string :source_type, :action, :null => false
+  t.integer :source_id, :null => false
   t.string :ip_address
-  t.timestamp :created_at
-end
-
-create_table :cia_events do |t|
-  t.string :type, :source_type, :null => false
-  t.integer :cia_transaction_id, :source_id, :null => false
   t.string :message
-  t.timestamp :created_at
+  t.timestamp :created_at#, :null => false
 end
 
 create_table :cia_attribute_changes do |t|
@@ -19,6 +15,5 @@ create_table :cia_attribute_changes do |t|
 end
 
 # DOWN
-# drop_table :cia_transactions
 # drop_table :cia_events
 # drop_table :cia_attribute_changes

data/Readme.md

@@ -1,19 +1,16 @@
 Central Internal Auditing
 ============================
 
-Audit model events like update/create/delete + attribute changes.
+Audit model actions like update/create/destroy/<custom> + attribute changes.
 
- - very normalized and queryable through table layout
+ - normalized and queryable through table layout
  - actors and subjects are polymorphic
- - events come in different types like `CIA::UpdateEvent`
- - transactions wrap multiple events, a nice place to add debugging info like source/action/ip
  - works on ActiveRecord 2 and 3
 
 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)
+   Event (actor/ip/time/updated subject + message)
+    -> has many attribute changes (changed password from foo to bar on subject)
 
 
 Install

data/gemfiles/rails2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/cia
   specs:
-    cia (0.2.2)
+    cia (0.2.3)
 
 GEM
   remote: http://rubygems.org/

data/gemfiles/rails3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/cia
   specs:
-    cia (0.2.2)
+    cia (0.2.3)
 
 GEM
   remote: http://rubygems.org/

data/lib/cia.rb

@@ -1,12 +1,7 @@
 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
@@ -15,18 +10,31 @@ module CIA
   end
 
   def self.audit(options = {})
-    Thread.current[:cia_transaction] = Transaction.new(options)
+    Thread.current[:cia_transaction] = options
     yield
   ensure
     Thread.current[:cia_transaction] = nil
   end
 
   def self.current_transaction
-    Thread.current[:cia_transaction] || NullTransaction
+    Thread.current[:cia_transaction]
   end
 
-  def self.record_audit(event_type, object)
-    CIA.current_transaction.record(event_type, object)
+  def self.record(action, source)
+    return unless current_transaction
+
+    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 action.to_s == "update"
+
+    event = CIA::Event.create!(
+      :action => action.to_s,
+      :source => source,
+      :message => message
+    )
+    event.record_attribute_changes!(changes)
+    event
   rescue Object => e
     if exception_handler
       exception_handler.call e

data/lib/cia/auditable.rb

@@ -3,9 +3,9 @@ module CIA
     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) }
+      base.after_create {|record| CIA.record(:create, record) }
+      base.after_update {|record| CIA.record(:update, record) }
+      base.after_destroy {|record| CIA.record(:destroy, record) }
     end
 
     module ClassMethods

data/lib/cia/event.rb

@@ -1,13 +1,12 @@
 module CIA
   class Event < ActiveRecord::Base
-    abstract_class
     self.table_name = "cia_events"
 
+    belongs_to :actor, :polymorphic => true
     belongs_to :source, :polymorphic => true
-    belongs_to :transaction, :foreign_key => :cia_transaction_id
     has_many :attribute_changes, :foreign_key => :cia_event_id
 
-    validates_presence_of :transaction, :source, :type
+    validates_presence_of :source, :action
 
     def self.previous
       scoped(:order => "id desc")

data/lib/cia/version.rb

@@ -1,3 +1,3 @@
 module CIA
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/spec/cia_spec.rb

@@ -7,20 +7,20 @@ describe CIA do
 
   describe ".audit" do
     it "has no transaction when it starts" do
-      CIA.current_transaction.should == CIA::NullTransaction
+      CIA.current_transaction.should == nil
     end
 
     it "starts a new transaction" do
       result = 1
-      CIA.audit({}) do
+      CIA.audit({:a => 1}) do
         result = CIA.current_transaction
       end
-      result.class.should == CIA::Transaction
+      result.should == {:a => 1}
     end
 
     it "stops the transaction after the block" do
       CIA.audit({}){}
-      CIA.current_transaction.should == CIA::NullTransaction
+      CIA.current_transaction.should == nil
     end
 
     it "returns the block content" do
@@ -34,14 +34,13 @@ describe CIA do
         end
       end
       sleep 0.01
-      CIA.current_transaction.should == CIA::NullTransaction
+      CIA.current_transaction.should == nil
       sleep 0.04 # so next tests dont fail
     end
   end
 
-  describe ".record_audit" do
+  describe ".record" do
     let(:object) { Car.new }
-    let(:transaction) { CIA.current_transaction }
 
     around do |example|
       CIA.audit :actor => User.create! do
@@ -53,7 +52,7 @@ describe CIA do
       expect{
         object.save!
       }.to change{ CIA::Event.count }.by(+1)
-      CIA::Event.last.class.should == CIA::CreateEvent
+      CIA::Event.last.action.should == "create"
     end
 
     it "tracks delete" do
@@ -61,7 +60,7 @@ describe CIA do
       expect{
         object.destroy
       }.to change{ CIA::Event.count }.by(+1)
-      CIA::Event.last.class.should == CIA::DeleteEvent
+      CIA::Event.last.action.should == "destroy"
     end
 
     it "tracks update" do
@@ -69,13 +68,78 @@ describe CIA do
       expect{
         object.update_attributes(:wheels => 3)
       }.to change{ CIA::Event.count }.by(+1)
-      CIA::Event.last.class.should == CIA::UpdateEvent
+      CIA::Event.last.action.should == "update"
+    end
+
+    context "events" do
+      def parse_event_changes(event)
+        event.attribute_changes.map { |c| [c.attribute_name, c.old_value, c.new_value] }
+      end
+
+      it "records attribute creations" do
+        source = Car.create!
+        source.wheels = 4
+        event = CIA.record(:update, 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 = CIA.record(:update, 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 = CIA.record(:update, source)
+        parse_event_changes(event).should == [["wheels", "2", "4"]]
+      end
+
+      it "records attribute deletions" do
+        source = Car.create!(:wheels => 2)
+        source.wheels = nil
+        event = CIA.record(:update, 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 = CIA.record(:update, 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 = CIA.record(:update, source)
+
+        event.message.should == "Foo"
+        parse_event_changes(event).should == []
+      end
+
+      it "record non-updates even without changes" do
+        source = Car.create!
+        event = CIA.record(:create, source)
+
+        parse_event_changes(event).should == []
+      end
     end
 
     context "exception_handler" do
       before do
         $stderr.stub(:puts)
-        transaction.stub(:record).and_raise(StandardError.new("foo"))
+        CIA.stub(:current_transaction).and_raise(StandardError.new("foo"))
       end
 
       def capture_exception

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require 'cia'
 
 RSpec.configure do |config|
   config.before do
-    CIA::Transaction.delete_all
     CIA::Event.delete_all
     CIA::AttributeChange.delete_all
   end
@@ -50,17 +49,8 @@ class CarWith3Attributes < ActiveRecord::Base
   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)
+  CIA::Event.create!(:source => Car.create!, :actor => User.create!, :action => "update")
 end
 
 def create_change(options={})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cia
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-22 00:00:00.000000000 Z
+date: 2012-06-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: michael@grosser.it
@@ -32,16 +32,10 @@ files:
 - 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
@@ -59,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3661699799177729927
+      hash: -1846204307001126824
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -68,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3661699799177729927
+      hash: -1846204307001126824
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/cia/create_event.rb

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

data/lib/cia/delete_event.rb

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

data/lib/cia/null_transaction.rb

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

data/lib/cia/transaction.rb

@@ -1,23 +0,0 @@
-module CIA
-  class Transaction < ActiveRecord::Base
-    self.table_name = "cia_transactions"
-
-    belongs_to :actor, :polymorphic => true
-    has_many :events, :foreign_key => :cia_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

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

data/spec/cia/transaction_spec.rb

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