cia 0.5.10 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0103b7461c217ca96f7c037fee25c83448ff0c6
-  data.tar.gz: f625ccbc4959663c19c2e0807a5ac24dc9e29720
+  metadata.gz: 721b3ddd4c0d65f03c32681de80e18d7dc2709c9
+  data.tar.gz: 634c7289d85d4f7a8768e97abaec2a3acade6175
 SHA512:
-  metadata.gz: 6d120a22bf343b9e16a41f76fdc42142d7ca0151c6251fb0f78f465457216a9a206da0c2f50424e6240902a95505906c28ddc7d2c124d6c2578a823e947bc306
-  data.tar.gz: 856f0d74b7aea9793c507dabe68d9c03c78292e7cb0237bc601be75ebd8afe7160dd5dd5ee30d27db183a88ff4edcf4ca78f21bb80b98a9774441c0995708634
+  metadata.gz: 3757ab4bf222f509a11d10a084985eb7beffc34681a5076f26ad9471220bdf1f4283ccb6b999f2ba9a834ae09441b81f91bd1d7a59aacfd56be3ef9a72b4ca5e
+  data.tar.gz: 95b73f3e943191df350c9765716332638aa0cdd2975ec31465014f2bd1ba3a6007bcd7b2625b2620a9fb721d8be5650d6a3ecc5a3812b1e463b4c8df08f26f95

data/Readme.md

@@ -0,0 +1,104 @@
+Central Internal Auditing
+============================
+
+Audit model actions like update/create/destroy/<custom> + attribute changes.
+
+ - normalized and queryable through table layout
+ - actors and subjects are polymorphic
+ - works on ActiveRecord 3.2, 4.0 and 4.1
+
+Table layout:
+
+   Event (actor/ip/time/updated subject + message)
+    -> has many attribute changes (changed password from foo to bar on subject)
+
+
+Install
+=======
+
+```Bash
+gem install cia
+```
+
+`rails g migration add_cia` + paste [Migration](https://raw.github.com/grosser/cia/master/MIGRATION.rb)
+
+
+Usage
+=====
+
+```Ruby
+class User < ActiveRecord::Base
+  include CIA::Auditable
+  audited_attributes :email, :crypted_password
+end
+
+class ApplicationController < ActionController::Base
+  around_action :scope_auditing
+
+  def scope_auditing(&block)
+    CIA.audit actor: current_user, ip_address: request.remote_ip, &block
+  end
+end
+
+# quick access
+User.last.cia_events
+changes = User.last.cia_attribute_changes
+last_passwords = changes.where(attribute_name: "crypted_password").map(&:new_value)
+
+# exceptions (raised by default)
+CIA.exception_handler = -> (e) { raise e unless Rails.env.production? }
+
+# conditional auditing
+class User < ActiveRecord::Base
+  audited_attributes :email, if: :interesting?
+
+  def interesting?
+    ...
+  end
+end
+
+# adding an actor e.g. for user creation
+CIA.current_actor = @user
+
+# custom changes
+class User < ActiveRecord::Base
+  def cia_changes
+    changes.merge("this" => ["always", "changes"])
+  end
+end
+
+# using after_commit, useful if the CIA::Event is stored in a different database then the audited class
+class User < ActiveRecord::Base
+  include CIA::Auditable
+  audited_attributes :email, :crypted_password, callback: :after_commit
+end
+
+# passing arbitrary attributes into the .audit method
+CIA.non_recordable_attributes = [:my_pretty_audit_property]
+CIA.audit(actor: current_user, my_pretty_audit_property: "12345") do
+  ...
+end
+
+# storing complex objects in old/new and reducing it's size if it's to big (serialized via json)
+value = CIA::AttributeChange.serialize_for_storage(["some", "complex"*1000, "object"]){|too_big| too_big.delete_at(1); too_big }
+CIA::AttributeChange.create!(old_value: value)
+
+# add something to current transaction or start a new audit
+CIA.audit bar: :baz, foo: :bang do
+  CIA.amend_audit foo: :bar do
+    puts CIA.current_transaction
+  end
+end
+-> {foo: :bar, bar: :baz}
+```
+
+
+# TODO
+ - reuse AR3+ previous_changes in a nice way
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://travis-ci.org/grosser/cia.png)](https://travis-ci.org/grosser/cia)

data/lib/cia.rb

@@ -55,9 +55,9 @@ module CIA
     return if not message and changes.empty? and action.to_s == "update"
 
     transaction_attributes = current_transaction.dup
-    transaction_attributes.reject! { |k, v| non_recordable_attributes.include?(k) } if non_recordable_attributes
+    transaction_attributes.reject! { |k, _v| non_recordable_attributes.include?(k) } if non_recordable_attributes
 
-    event = CIA::Event.new(transaction_attributes.merge(
+    event = CIA::Event.new(transaction_attributes.reverse_merge(
       action: action.to_s,
       source: source,
       message: message
@@ -65,11 +65,11 @@ module CIA
     event.add_attribute_changes(changes)
     event.save!
     event
-  rescue Object => e
+  rescue StandardError
     if exception_handler
-      exception_handler.call e
+      exception_handler.call $!
     else
-      raise e
+      raise
     end
   end
 end

data/lib/cia/version.rb

@@ -1,3 +1,3 @@
 module CIA
-  VERSION = '0.5.10'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cia
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: wwtd
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Readme.md
 - lib/cia.rb
 - lib/cia/attribute_change.rb
 - lib/cia/auditable.rb