active_record_auditor 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7448dcd39e1068e8685129db81fe83e0ca8cb1d3
-  data.tar.gz: 6afbb930c058037f64ea140abeff9b7fd54addb6
+  metadata.gz: 360ef6227ae90c2c3a7c946a8a2771e9b0e74bbf
+  data.tar.gz: c4be644dd730b8a06f03a0daa8cf591d71409014
 SHA512:
-  metadata.gz: 0768ac80f12d66592c0f3370621417c3f957e7efcfae563550258aa3c3f203aa852e2ffb92ebf57ee873c3aab14682c940417e5c54f27744c05fb12ced01729f
-  data.tar.gz: 03277d8cc9f6d7b6df4777a442934c84635b300352bee3b8cb8ee3ad955a9dec23dd23295ed051269d94b6d118141610596ad387b0c8e58b4d42cb83eec872c9
+  metadata.gz: 8b80818323f391d152c5e6c211320703bc1145797744cf6d21751c9cd84778dcd6867cd7556943e7453b024f83426ca93f6942394b3c0d2fbc66334c27f8b9b0
+  data.tar.gz: 964dfa183be96df422f0c71ea3da3016d21ec5b4d4ebf0b312d41e6eb8d756f27e9b0a05851218a19eb4e7d1e6ebd563c0efa0c3112463cba1d74aacd75b6cae

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem "activerecord", require: "active_record"
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
+    rake (10.4.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  rake

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nic Wilson
+
+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/Rakefile

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

data/active_record_auditor.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_auditor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_auditor"
+  spec.version       = ActiveRecordAuditor::VERSION
+  spec.authors       = ["Nic Wilson"]
+  spec.email         = ["wilsonic89@yahoo.com"]
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.summary       = "Framework for auditing user actions in ActiveRecord"
+  spec.description   = "I should really do this at some point"
+  spec.homepage      = "https://github.com/nbwilson/active_record_auditor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths  = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_auditor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record_auditor/extensions/active_record.rb

@@ -0,0 +1,15 @@
+require "active_record_auditor/extensions/active_record_auditor_persistence"
+require "active_record_auditor/extensions/active_record_auditor_relation"
+
+module ActiveRecord
+  module Persistence
+    prepend ActiveRecordAuditorPersistence
+  end
+
+  class Relation
+    prepend ActiveRecordAuditorRelation
+  end
+
+  class NoAuditUser < ActiveRecordError
+  end
+end

data/lib/active_record_auditor/extensions/active_record_auditor_persistence.rb

@@ -0,0 +1,133 @@
+require 'active_record'
+require 'active_record_auditor/extensions/array'
+
+module ActiveRecord
+
+  module ActiveRecordAuditorPersistence
+
+    extend ActiveRecord::Persistence
+
+    def _update_relation_record
+      connection.execute(audit_update_sql) if should_audit?
+    end
+
+    def _delete_relation_record
+      connection.execute(audit_delete_sql) if should_audit?
+    end
+
+    private
+
+    def _create_record(attribute_names = self.attribute_names)
+      transaction do 
+        super(attribute_names)
+        connection.execute(new_record_sql) if should_audit?
+      end
+    end
+
+    def _update_record(attribute_names = self.attribute_names)
+      transaction do
+        connection.execute(audit_update_sql) if should_audit?
+        super(attribute_names)
+      end
+    end
+
+    def existing_row
+      connection.execute(existing_row_sql).first
+    end
+
+    def audit_create_sql
+      "INSERT INTO `#{ensure_audit_table}` (#{required_audit_attribute_names.to_sql_columns}) VALUES (#{required_audit_attributes.to_sql_values})"
+    end
+
+    def audit_update_sql
+      "INSERT INTO `#{ensure_audit_table}` (#{attribute_names.drop(1).to_sql_columns}, #{required_audit_attribute_names.to_sql_columns}) VALUES (#{existing_row.drop(1).to_sql_values}, #{required_audit_attributes.to_sql_values})"
+    end
+
+    def audit_delete_sql
+      "INSERT INTO `#{ensure_audit_table}` (#{attribute_names.drop(1).to_sql_columns}, #{required_audit_attribute_names.push('__deleted').to_sql_columns}) VALUES (#{existing_row.drop(1).to_sql_values}, #{required_audit_attributes.push(1).to_sql_values})"
+    end
+
+    def existing_row_sql
+      "SELECT * FROM `#{model.table_name}` where id = #{id} limit 1"
+    end
+
+    def version_lookup_sql(audit_date = datetime)
+      "SELECT * FROM #{audit_table_name(audit_date)} where __canonical_id=#{id} ORDER BY __created_at DESC"
+    end
+
+    def required_audit_attribute_names
+      ['__username', '__canonical_id', '__version', '__created_at']
+    end
+
+    def required_audit_attributes
+      [__username, "#{id}", "#{next_version}", "#{datetime.to_s}"]
+    end
+
+    def next_version
+      latest_version + 1
+    end
+
+    def latest_version
+      ensure_audit_table
+      latest_update = connection.execute(version_lookup_sql).first
+      latest_revision = latest_update[latest_update.length-2] if latest_update
+      table_date = datetime - 1.month
+      misses = 0
+      while latest_revision.nil? && misses < 12
+        table_date = table_date - 1.month
+        if audit_table_exists?(table_date)
+          latest_update = connection.execute(version_lookup_sql(table_date)).first
+          latest_revision = latest_update[latest_update.length-2] if latest_update
+          misses = 0
+        else
+          misses += 1
+        end
+      end
+      latest_revision.nil? ? -1 : latest_revision
+    end
+
+    def audit_table_name(audit_date = datetime)
+      "#{model.table_name}_#{audit_date.month}_#{audit_date.year}"
+    end
+
+    def ensure_audit_table
+      unless audit_table_exists?
+        ActiveRecordAuditor.build_audit_table(model.table_name)
+      end
+      audit_table_name
+    end
+
+    def audit_table_exists?(audit_date = datetime)
+      connection.table_exists? audit_table_name(audit_date)
+    end
+
+    def datetime
+      Time.now
+    end
+
+    def should_audit?
+      raise NoAuditUser, "Writes are currently disabled without a specified user" if __username.nil? && __user_required
+      __username || __log_userless_actions
+    end
+
+    def __username
+      $__username
+    end
+
+    def __log_userless_actions
+      model.try(:log_userless_actions) || model.try(:__log_userless_actions)
+    end
+
+    def __user_required
+      model.try(:user_required) || model.try(:__user_required)
+    end
+
+    def model
+      self.class
+    end
+
+    def connection
+      model.connection
+    end
+  end
+end

data/lib/active_record_auditor/extensions/active_record_auditor_relation.rb

@@ -0,0 +1,22 @@
+module ActiveRecord
+  module ActiveRecordAuditorRelation
+
+    def delete_all(conditions = nil)
+      if conditions
+        super
+      else
+        transaction do
+          to_a.each {|object| object._delete_relation_record}
+          super
+        end
+      end
+    end
+
+    def update_all(updates)
+      transaction do
+        to_a.each {|object| object._update_relation_record}
+        super
+      end
+    end
+  end
+end

data/lib/active_record_auditor/extensions/array.rb

@@ -0,0 +1,16 @@
+class Array
+  def to_sql_values
+    tmp = self.map do |elem|
+      if elem.nil?
+        'NULL'
+      else
+        "'#{elem}'"
+      end
+    end
+    "#{tmp.join(', ')}"
+  end
+
+  def to_sql_columns
+    "`#{self.join('`, `')}`"
+  end
+end

data/lib/active_record_auditor/tasks/setup.rake

@@ -0,0 +1,13 @@
+require 'active_record'
+
+#Can't wrap these requests in a ActiveRecord Transaction, because DDL commands can not be rolled back per MySQL documentation
+namespace :db do
+  namespace :audit do
+    task :create_audit_tables do
+      ActiveRecord::Base.connection.tables.each do |table|
+        next if table == "schema_migrations"
+        ActiveRecordAuditor.build_audit_table(table)
+      end
+    end
+  end
+end

data/lib/active_record_auditor/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordAuditor
+  VERSION = "0.1.6"
+end

data/lib/active_record_auditor.rb

@@ -0,0 +1,27 @@
+require "active_record_auditor/version"
+require "active_record_auditor/extensions/active_record"
+require 'active_record'
+
+module ActiveRecordAuditor
+  def self.build_audit_table(table)
+    time = Time.now
+    new_table_name = "#{table}_#{time.month}_#{time.year}"
+    ActiveRecord::Base.connection.execute("CREATE TABLE #{new_table_name} like #{table}")
+    ActiveRecord::Base.connection.execute("SHOW INDEX FROM #{new_table_name}").to_a.uniq{|index| index[2]}.each do |index|
+      ActiveRecord::Base.connection.execute("ALTER TABLE #{new_table_name} DROP INDEX #{index[2]};") unless index[2] == 'PRIMARY'
+    end
+    ActiveRecord::Base.connection.execute("DESCRIBE #{new_table_name}").to_a.uniq{|index| index[0]}.each do |col|
+      ActiveRecord::Base.connection.execute("ALTER TABLE #{new_table_name} MODIFY COLUMN #{col[0]} #{col[1]};") if col[2] == "YES"
+    end
+    ActiveRecord::Migration.add_column new_table_name.to_sym, :__username, :string
+    ActiveRecord::Migration.add_column new_table_name.to_sym, :__deleted, :boolean, default: false
+    ActiveRecord::Migration.add_column new_table_name.to_sym, :__canonical_id, :integer, null: false
+    ActiveRecord::Migration.add_column new_table_name.to_sym, :__version, :integer, null: false
+    ActiveRecord::Migration.add_column new_table_name.to_sym, :__created_at, :datetime, null: false
+    ActiveRecord::Migration.add_index new_table_name.to_sym, [:__canonical_id, :__version], unique: true
+  end
+
+  def self.load_tasks
+    load "active_record_auditor/tasks/setup.rake"
+  end
+end

data/spec/active_record_auditor_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ActiveRecordAuditor do
+  it 'has a version number' do
+    expect(ActiveRecordAuditor::VERSION).not_to be nil
+  end
+
+  it 'builds the appropriate audit table' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_record_auditor'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_auditor
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Nic Wilson
@@ -31,7 +31,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- active_record_auditor.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_auditor.rb
+- lib/active_record_auditor/extensions/active_record.rb
+- lib/active_record_auditor/extensions/active_record_auditor_persistence.rb
+- lib/active_record_auditor/extensions/active_record_auditor_relation.rb
+- lib/active_record_auditor/extensions/array.rb
+- lib/active_record_auditor/tasks/setup.rake
+- lib/active_record_auditor/version.rb
+- spec/active_record_auditor_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/nbwilson/active_record_auditor
 licenses:
 - MIT
@@ -44,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="