relational-audit 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dad27440866b5d2d553eda59861d13d830928b11
+  data.tar.gz: 4e1df4796c9ab299185310ed47b5d13dc3d31ff1
+SHA512:
+  metadata.gz: 706c89afb06ab0eb881b153a74701f735e54298c81a4580c84121d6ae2c9a6a186850952418570de62d48b5d6f97ea18b81b138d534910c394dcd44ef7ee46f6
+  data.tar.gz: db7c4ea3ebc1aa6dfb24721c1ef7df8699ef04a3eb713aff4b5c6153a041e3de0a65d5a581dc93c357aa0f4f2949a1d12709aa728be94183b5c1af641ceefccc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in relational-audit.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Manojs
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,32 @@
+# Relational::Audit
+
+Audit for entities not for table.
+Entity consists of information from multiple related tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'relational-audit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relational-audit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/relational-audit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/relational_audit/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+module RelationalAudit
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    class_option :with_changes, :type => :boolean, :default => false, :desc => "Store changeset (diff) with each version"
+    desc 'Generates (but does not run) a migration to add a relational_audits & audit_relations table.'
+    def create_migration_file
+      migration_template 'create_relational_audits.rb', 'db/migrate/create_relational_audits.rb'
+    end
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/relational_audit/templates/create_relational_audits.rb

@@ -0,0 +1,23 @@
+class CreateRelationalAudits < ActiveRecord::Migration
+  def change
+    create_table :audits do |t|
+      t.string :entity_type, :null => false
+      t.integer :entity_id, :null => false
+      t.string :event, :null => false
+      t.string :changes_by
+      t.text :entity_changes
+      t.string :transaction_id
+      t.datetime :created_at
+    end
+
+    create_table :audit_relations do |t|
+      t.integer :audit_id
+      t.string :relation_type
+      t.integer :relation_id
+      t.datetime :created_at
+    end
+
+    add_index :audits, [:entity_type, :entity_id]
+    add_index :audit_relations, [:audit_id, :relation_id]
+  end
+end

data/lib/relational/audit.rb

@@ -0,0 +1,196 @@
+require "relational/audit/version"
+require 'securerandom'
+require 'relational/controller_methods.rb'
+
+module Relational
+  module Audit
+
+    @@audit_changes_by = nil
+
+    def self.audit_changes_by=(user)
+      @@audit_changes_by = user
+    end
+
+    def self.audit_changes_by
+      @@audit_changes_by
+    end
+
+    @@audit_transaction_id = nil
+
+    def self.audit_transaction_id=(user)
+      @@audit_transaction_id = user
+    end
+
+    def self.audit_transaction_id
+      @@audit_transaction_id
+    end
+
+    module Event
+      CREATE = 'C'
+      UPDATE = 'U'
+      DESTROY = 'D'
+    end
+
+    module InstanceMethod
+
+      def raw_audits
+        ::RelationalAudit::Audit.joins('join audit_relations on audits.id = audit_relations.audit_id').where("audit_relations.relation_type = ? and audit_relations.relation_id = ?", self.class.name, self.id)
+      end
+
+      def audits(order='DESC')
+        grouped_audits = {}
+        self.raw_audits.order("id #{order}").each do |audit|
+          grouped_audits[audit.transaction_id] ||= []
+          grouped_audits[audit.transaction_id] << audit
+        end
+
+        entity_audits = grouped_audits.collect do |transaction_id, audits|
+          unless audits.blank?
+            merged_audit = {:changes_by => audits.first.changes_by, :changes => {}}
+            audits.each do |audit|
+              merged_audit[:changes].merge!(audit.changeset)
+            end
+            merged_audit
+          end
+        end.compact
+
+        entity_audits
+      end
+
+      def add_created_relational_audit
+        add_audit(::Relational::Audit::Event::CREATE, [self])
+      end
+
+      def add_updated_relational_audit
+        add_audit(::Relational::Audit::Event::UPDATE, [self])
+      end
+
+      def add_destroyed_relational_audit
+        add_audit(::Relational::Audit::Event::DESTROY, [self])
+      end
+
+      def add_audit event_type, related_to
+
+        hash_changes = self.changes
+
+        options = self.class.audit_options
+
+        unless options[:only].blank?
+          hash_changes.delete_if { |key, value| !options[:only].include?(key.intern) }
+        end
+
+        unless options[:ignore].blank?
+          hash_changes.delete_if { |key, value| options[:ignore].include?(key.intern) }
+        end
+
+        return if hash_changes.blank?
+
+        serialized_changes = YAML::dump hash_changes
+
+        audit = ::RelationalAudit::Audit.new(
+            :entity_type => self.class.name,
+            :entity_id => self.id,
+            :entity_changes => serialized_changes,
+            :changes_by => ::Relational::Audit.audit_changes_by,
+            :event => event_type,
+            :transaction_id => ::Relational::Audit::audit_transaction_id
+        )
+
+        related_to.each do |entity|
+          audit.audit_relations.build(
+              :relation_type => entity.class.name,
+              :relation_id => entity.id
+          )
+        end
+
+        audit.save
+      end
+
+      def add_child_audit(event_type)
+        related_to = self.class.audit_entities.collect do |entity|
+          self.send(entity)
+        end
+        related_to.push(self)
+
+        add_audit(event_type, related_to.compact)
+      end
+
+      def add_created_child_audit
+        self.add_child_audit(::Relational::Audit::Event::CREATE)
+      end
+
+      def add_updated_child_audit
+        self.add_child_audit(::Relational::Audit::Event::UPDATE)
+      end
+
+      def add_destroyed_child_audit
+        self.add_child_audit(::Relational::Audit::Event::DESTROY)
+      end
+
+    end
+
+    module ClassMethod
+
+      def audit_entities
+        self.class_variable_get :@@audit_entities
+      end
+
+      def audit_entities=(audit_entities)
+        self.class_variable_set :@@audit_entities, (audit_entities.is_a?(Array) ? audit_entities : [audit_entities])
+      end
+
+      def audit_options
+        self.class_variable_get :@@audit_options
+      end
+
+      def audit_options=(audit_options)
+        self.class_variable_set :@@audit_options, audit_options
+      end
+
+      def relational_audit audit_options={}
+        self.audit_options = audit_options unless audit_options.blank?
+
+        after_create :add_created_relational_audit
+        after_update :add_updated_relational_audit
+        after_destroy :add_destroyed_relational_audit
+      end
+
+      def belongs_to_audit audit_entities, audit_options={}
+        self.audit_entities = audit_entities
+        self.audit_options = audit_options unless audit_options.blank?
+
+        after_create :add_created_child_audit
+        after_update :add_updated_child_audit
+        after_destroy :add_destroyed_child_audit
+      end
+
+    end
+
+  end
+end
+
+# ================================================
+
+ActiveRecord::Base.send :extend, Relational::Audit::ClassMethod
+ActiveRecord::Base.send :include, Relational::Audit::InstanceMethod
+
+if defined?(::ActionController)
+  ::ActiveSupport.on_load(:action_controller) { include Relational::Audit::ControllerMethods::InstanceMethods }
+end
+
+
+module RelationalAudit
+  class Audit < ActiveRecord::Base
+    has_many :audit_relations
+
+    def changeset
+      YAML::load(self.entity_changes)
+    end
+  end
+
+  class AuditRelation < ActiveRecord::Base
+    belongs_to :audit
+  end
+end
+
+# ================================================

data/lib/relational/audit/version.rb

@@ -0,0 +1,5 @@
+module Relational
+  module Audit
+    VERSION = "1.0.3"
+  end
+end

data/lib/relational/controller_methods.rb

@@ -0,0 +1,20 @@
+module Relational
+  module Audit
+    module ControllerMethods
+
+      module InstanceMethods
+
+        def self.included(base)
+          base.before_filter :audit_set_changes_by
+        end
+
+        def audit_set_changes_by
+          ::Relational::Audit.audit_changes_by = current_user if defined? current_user
+          ::Relational::Audit.audit_transaction_id = SecureRandom.hex(10)
+        end
+
+      end
+
+    end
+  end
+end

data/relational-audit.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relational/audit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "relational-audit"
+  spec.version       = Relational::Audit::VERSION
+  spec.authors       = ["Manojs"]
+  spec.email         = ["manojs.nitt@gmail.com"]
+  spec.summary       = %q{Audit for entities not for table. Entity consists of information from multiple related tables}
+  spec.description   = %q{Audit for entities not for table. Entity consists of information from multiple related tables}
+  spec.homepage      = "https://github.com/bethink/relational-audit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
+  spec.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: relational-audit
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Manojs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Audit for entities not for table. Entity consists of information from
+  multiple related tables
+email:
+- manojs.nitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/relational_audit/install_generator.rb
+- lib/generators/relational_audit/templates/create_relational_audits.rb
+- lib/relational/audit.rb
+- lib/relational/audit/version.rb
+- lib/relational/controller_methods.rb
+- relational-audit.gemspec
+homepage: https://github.com/bethink/relational-audit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Audit for entities not for table. Entity consists of information from multiple
+  related tables
+test_files: []