record_auditor 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 409a04c41fa9d61a9867b089b37becc1923a5f69
+  data.tar.gz: 7daaf373ac892322bec67f25ab8fda1043408c19
+SHA512:
+  metadata.gz: 74e3b5a45b33d45e163f35143d0c5af765a2210e727db6e4e3800e9514faa656a15a6702ee52609205b6d5b2601fe023288a431f4acb9ae46d46e2c1279b7bb5
+  data.tar.gz: 0902b23fb71fb688b585a2cb1199728ec58c6d7ce55e0b9626b5cb3954a55a232f6d733e7668a5f1ca39ee7d1e0afd63bd87b83b41be5b02055031bead3b84e9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 ocowchun
+
+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,22 @@
+#RecordAuditor
+> audit ActiveRecord change
+
+heavily inspired by [audited](https://github.com/collectiveidea/audited)
+
+##How To Start
+###1. Add below to `config/initializer/record_auditor.rb`
+
+```rb
+RecordAuditor.handle_audit=Proc.new{|options|puts options} #change to whatever you want to audit active record
+RecordAuditor.current_user_method=:current_rollbar_user #your custom current_user method
+```
+
+###2. add `audit` to the model you want to audit
+```rb
+class User < ::ActiveRecord::Base
+   audit
+   ...
+end
+```
+
+MIT

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RecordAuditor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/record_auditor.rb

@@ -0,0 +1,19 @@
+require 'record_auditor/auditor'
+require 'record_auditor/audit'
+
+
+module RecordAuditor
+  class << self
+    attr_accessor :ignored_attributes,:handle_audit,:current_user_method, :audit_class
+    # , :current_user_method, :audit_class
+    def store
+      Thread.current[:audited_store] ||= {}
+    end
+  end
+
+  @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on password)
+  @current_user_method = :current_user
+end
+
+RecordAuditor.audit_class = RecordAuditor::Audit
+require 'record_auditor/sweeper'

data/lib/record_auditor/audit.rb

@@ -0,0 +1,22 @@
+module RecordAuditor
+  class Audit
+    # include ActiveModel::Observing
+    extend ActiveModel::Callbacks
+    include ActiveModel::Conversion
+    # extend ActiveModel::Translation
+    include ActiveModel::Model
+    define_model_callbacks :create
+
+    attr_accessor :user,:auditable
+
+    def create(attrs={})
+      run_callbacks(:create) do
+        # handle something here
+        if RecordAuditor.handle_audit.present?
+          RecordAuditor.handle_audit.call(attrs.merge(user:user))
+        end
+      end
+    end
+
+  end
+end

data/lib/record_auditor/auditor.rb

@@ -0,0 +1,99 @@
+module RecordAuditor
+  module Auditor
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def get_id
+        1
+      end
+
+      def audit(options = {})
+        include RecordAuditor::Auditor::LocalInstanceMethods
+        class_attribute :non_audited_columns,   instance_writer: false
+        class_attribute :auditable_name,   instance_writer: false
+
+
+        if options[:only]
+          except = column_names - Array(options[:only]).flatten.map(&:to_s)
+        else
+          except = default_ignored_attributes + RecordAuditor.ignored_attributes
+          except |= Array(options[:except]).collect(&:to_s) if options[:except]
+        end
+
+        self.non_audited_columns = except
+        self.auditable_name = options[:auditable_name]
+
+
+        after_create :audit_create
+        after_update :audit_update
+        after_destroy :audit_destroy
+
+        after_commit :handle_audit
+
+      end
+
+      def default_ignored_attributes
+        [primary_key, inheritance_column]
+      end
+
+    end
+
+
+    module LocalInstanceMethods
+      attr_accessor :action,:audited_changes_attrs
+
+      def audited_attributes
+        attributes.except(*non_audited_columns)
+      end
+
+      private
+
+      def audited_changes
+        changed_attributes.except(*non_audited_columns).inject({}) do |changes, (attr, old_value)|
+          changes[attr] = [old_value, self[attr]]
+          changes
+        end
+      end
+
+      def handle_audit()
+        if audited_changes_attrs.present?
+          a=RecordAuditor::Audit.new
+          attrs={action:action,audited_changes:audited_changes_attrs}
+          attrs[:auditable_type]=self.class.to_s
+          attrs[:auditable_id]=self.id
+
+          if auditable_name.present?&&self.respond_to?(*auditable_name)
+            attrs[:auditable_name]=self.send(*auditable_name)
+          end
+
+          a.create(attrs)
+        end
+      end
+
+      def audit_create
+        self.action='create'
+        self.audited_changes_attrs=audited_attributes
+      end
+
+      def audit_update
+        if (changes = audited_changes).empty?
+          self.action=nil
+          self.audited_changes_attrs=nil
+        else
+          self.action='update'
+          self.audited_changes_attrs=changes
+        end
+      end
+
+      def audit_destroy
+        self.action='destroy'
+        self.audited_changes_attrs='destroy'
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, RecordAuditor::Auditor

data/lib/record_auditor/sweeper.rb

@@ -0,0 +1,56 @@
+require "rails/observers/activerecord/active_record"
+require "rails/observers/action_controller/caching"
+
+module RecordAuditor
+  class Sweeper < ActionController::Caching::Sweeper
+    observe RecordAuditor.audit_class
+
+    attr_accessor :controller
+
+    def around(controller)
+      begin
+        self.controller = controller
+        yield
+      ensure
+        self.controller = nil
+      end
+    end
+
+    def before_create(audit)
+      audit.user ||= current_user
+      # audit.remote_address = controller.try(:request).try(:remote_ip)
+    end
+
+    def current_user
+      controller.send(RecordAuditor.current_user_method) if controller.respond_to?(RecordAuditor.current_user_method, true)
+    end
+
+    def add_observer!(klass)
+      # super
+      define_callback(klass)
+    end
+
+    def define_callback(klass)
+      observer = self
+      callback_meth = :_notify_audited_sweeper
+      klass.send(:define_method, callback_meth) do
+        observer.update(:before_create, self)
+      end
+      klass.send(:before_create, callback_meth)
+    end
+
+    def controller
+      ::RecordAuditor.store[:current_controller]
+    end
+
+    def controller=(value)
+      ::RecordAuditor.store[:current_controller] = value
+    end
+  end
+end
+
+if defined?(ActionController) && defined?(ActionController::Base)
+  ActionController::Base.class_eval do
+    around_filter RecordAuditor::Sweeper.instance
+  end
+end

data/lib/record_auditor/version.rb

@@ -0,0 +1,3 @@
+module RecordAuditor
+  VERSION = "0.0.5"
+end

data/lib/tasks/audit_record_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :audit_record do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: record_auditor
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- ocowchun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: rails-observers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: audit ActiveRecord change
+email:
+- ocowchun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/record_auditor.rb
+- lib/record_auditor/audit.rb
+- lib/record_auditor/auditor.rb
+- lib/record_auditor/sweeper.rb
+- lib/record_auditor/version.rb
+- lib/tasks/audit_record_tasks.rake
+homepage: https://github.com/sudo-recruit/record_auditor
+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.8
+signing_key: 
+specification_version: 4
+summary: record_auditor is a gem to audit ActiveRecord change
+test_files: []