sequel-bulk-audit 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 969f874c37e5b8cdd0bc74f1e5fb8eff41ddc680
+  data.tar.gz: 899ee7a547d11be1ba2b6bd03c008aa26a307722
+SHA512:
+  metadata.gz: 4d1df05162de7060a17f396e0951c1c584c573cf3cae55baa0cea365242cb2b18409551b498bb48e1dcd35c47323cd3bb44299edea93dfb8b2352164a04d691a
+  data.tar.gz: f755c70544b356c0143dbc0adf7e7a54dc5ca2144575587f8ef610119405cc358d72ce0a45e73f3b99d4298c05fce1d7558c0e8dd25474586cda1309d8d2cb13

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6
+addons:
+  postgresql: "9.6"
+services:
+  - postgresql

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sequel-bulk-audit.gemspec
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+# sequel-bulk-audit [![Build Status](https://travis-ci.org/fiscal-cliff/sequel-bulk-audit.svg?branch=master)](https://travis-ci.org/fiscal-cliff/sequel-bulk-audit)
+
+This gem allows you to track any changes in your tables. This approach not only is suitable for model updates but also enables you to track dataset updates.
+
+You should wrap your updating code as follows:
+
+```ruby
+Model.with_current_user(current_user) do
+  Model.where(...).update(...)
+end
+```
+
+Method #with_current_user expects current_user to be an object (or record) having attributes id and login
+
+You are able setup polymorphic associations between audit records and corresponding records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel-bulk-audit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-bulk-audit
+
+After Installation you should run ```rails g audit_migration``` generator.
+
+You can exdend this migration by attaching the trigger to audited tables.
+
+## Usage
+
+Models, changes in which you plan to audit should contain
+```ruby
+plugin :bulk_audit
+```
+
+Method #with_current_user should wrap all the operations on the table.
+
+```ruby
+Model.with_current_user(current_user) do
+  Model.where(...).update(...)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fiscal-cliff/sequel-bulk-audit.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sequel/bulk/audit"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/generators/audit_migration/USAGE

@@ -0,0 +1,10 @@
+Description:
+    The generator inserts sequel migration
+    This migration contains trigger.
+    You can attach the trigger to tables here.
+
+Example:
+    rails generate audit_migration
+
+    This will create:
+        what/will/it/create

data/lib/generators/audit_migration/audit_migration_generator.rb

@@ -0,0 +1,8 @@
+class AuditMigrationGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_audit_migration_files
+    version = Time.now.utc.strftime('%Y%m%d%H%M%S')
+    copy_file "01_migration.rb", "db/migrate/#{version}_CreateAuditTableAndTrigger.rb"
+  end
+end

data/lib/generators/audit_migration/templates/01_migration.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+Sequel.migration do
+  up do
+    create_table(:audit_logs) do
+      primary_key :id
+      column :model_type,       String
+      column :model_id,         String
+      column :event,            String
+      column :changed,          :jsonb
+      column :user_id,          :int
+      column :username,         String
+      column :user_type,        String, default: "User"
+      column :created_at,       DateTime
+      column :query,            String
+      column :data,             :jsonb, default: Sequel.pg_jsonb({})
+
+      index :created_at
+      index %i[model_type model_id]
+      index :user_id
+    end
+
+    create_function(:audit_changes, <<~SQL, returns: :trigger, language: :plpgsql, replace: true)
+      DECLARE
+        changes jsonb := '{}'::jsonb;
+        ri RECORD;
+        n jsonb;
+        o jsonb;
+        __audit_info RECORD;
+        model_id text;
+        return_record RECORD;
+        trid bigint;
+      BEGIN
+        SELECT txid_current() INTO trid;
+        EXECUTE 'SELECT * FROM __audit_info_' || trid::text INTO __audit_info;
+        FOR ri IN
+          SELECT column_name
+          FROM information_schema.columns
+          WHERE
+              table_schema = quote_ident(TG_TABLE_SCHEMA)
+          AND table_name = quote_ident(TG_TABLE_NAME)
+          ORDER BY ordinal_position
+        LOOP
+          IF (TG_OP = 'UPDATE') THEN
+            EXECUTE 'SELECT to_jsonb(($1).' || ri.column_name || ')' INTO n USING NEW;
+            EXECUTE 'SELECT to_jsonb(($1).' || ri.column_name || ')' INTO o USING OLD;
+            IF (o != n) THEN
+              SELECT changes || jsonb_build_object(ri.column_name, ARRAY[o, n]) INTO changes;
+            END IF;
+          ELSE
+            IF (TG_OP = 'DELETE') THEN
+              EXECUTE 'SELECT to_jsonb(($1).' || ri.column_name || ')' INTO n USING OLD;
+            ELSIF (TG_OP = 'INSERT') THEN
+              EXECUTE 'SELECT to_jsonb(($1).' || ri.column_name || ')' INTO n USING NEW;
+            END IF;
+            SELECT changes || jsonb_build_object(ri.column_name, n) INTO changes;
+          END IF;
+        END LOOP;
+
+        CASE TG_OP
+          WHEN 'UPDATE' THEN
+            model_id := OLD.id;
+            return_record := NEW;
+          WHEN 'DELETE' THEN
+            model_id := OLD.id;
+            return_record := OLD;
+          WHEN 'INSERT' THEN
+            model_id := NEW.id;
+            return_record := NEW;
+          ELSE
+            RAISE WARNING '[AUDIT.IF_MODIFIED_FUNC] - Other action occurred: %, at %',TG_OP,now();
+            RETURN NULL;
+        END CASE;
+        INSERT INTO audit_logs ("model_type", "model_id", "event", "changed",
+                                "created_at", "user_id", "username", "query", "data")
+        VALUES (coalesce((__audit_info.model_map ->> TG_TABLE_NAME::TEXT), TG_TABLE_NAME::TEXT), model_id, TG_OP, changes, NOW(), __audit_info.user_id,
+                __audit_info.username, current_query(), __audit_info.data);
+        RETURN return_record;
+      END;
+    SQL
+
+    ### @TODO: Setup the trigger for all tables changes of you want to audit
+    # execute <<~SQL
+    #   CREATE TRIGGER audit_changes_on_table BEFORE INSERT OR UPDATE OR DELETE ON table
+    #   FOR EACH ROW EXECUTE PROCEDURE audit_changes();
+    # SQL
+  end
+
+  down do
+    drop_function(:audit_changes, cascade: true)
+    drop_table(:audit_logs)
+  end
+end

data/lib/sequel-bulk-audit.rb

@@ -0,0 +1,2 @@
+require "pry"
+require "sequel/plugins/bulk_audit"

data/lib/sequel/plugins/bulk_audit.rb

@@ -0,0 +1,45 @@
+require "sequel/plugins/bulk_audit/version"
+require 'sequel/model'
+
+module Sequel
+  module Plugins
+    module BulkAudit
+      def self.apply(model, opts={})
+        model.instance_eval do
+          @excluded_columns = [*opts[:excluded_columns]]
+        end
+      end
+
+      module SharedMethods
+        def model_to_table_map
+          @@model_to_table_map ||= ObjectSpace.each_object(Class).select do |klazz|
+            next if klazz.name.nil?
+            klazz < Sequel::Model && klazz&.plugins&.include?(Sequel::Plugins::BulkAudit)
+          end.map { |c| [c.to_s, c.table_name] }.to_h.invert
+        end
+
+        def with_current_user(current_user, attributes = nil)
+          self.db.transaction do
+            trid = self.db.select(Sequel.function(:txid_current)).single_value
+            data = self.db.select(Sequel.expr(current_user&.id || 0).as(:user_id),
+                             Sequel.cast(current_user&.login || "unspecified", :text).as(:username),
+                             Sequel.pg_jsonb(model_to_table_map).as(:model_map),
+                             Sequel.pg_jsonb(attributes || {}).as(:data))
+            self.db.create_table!(:"__audit_info_#{trid}", temp: true, as: data)
+            result = yield if block_given?
+            self.db.drop_table?(:"__audit_info_#{trid}")
+            result
+          end
+        end
+      end
+
+      module ClassMethods
+        include SharedMethods
+      end
+
+      module InstanceMethods
+        include SharedMethods
+      end
+    end
+  end
+end

data/lib/sequel/plugins/bulk_audit/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module BulkAudit
+      VERSION = "0.2.0"
+    end
+  end
+end

data/sequel-bulk-audit.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sequel/plugins/bulk_audit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-bulk-audit"
+  spec.version       = Sequel::Plugins::BulkAudit::VERSION
+  spec.authors       = ["Fox"]
+  spec.email         = ["strong.drug@gmail.com"]
+
+  spec.summary       = %q{This gem provides a trigger based solution for auditing table changes}
+  spec.description   = %q{Every update on audited table will be logged. You can update the table in bulk}
+  spec.homepage      = "https://github.com/fiscal-cliff/sequel-bulk-audit/"
+  spec.post_install_message = %q{ Next steps:
+    1. Run rails g audit_migration
+    2. Edit generated migration
+    3. Apply the migration"
+  }
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sequel", ">= 4.0.0"
+  spec.add_dependency "pg", ">= 0.17.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "sequel_polymorphic"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: sequel-bulk-audit
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Fox
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: sequel_polymorphic
+  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: Every update on audited table will be logged. You can update the table
+  in bulk
+email:
+- strong.drug@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/audit_migration/USAGE
+- lib/generators/audit_migration/audit_migration_generator.rb
+- lib/generators/audit_migration/templates/01_migration.rb
+- lib/sequel-bulk-audit.rb
+- lib/sequel/plugins/bulk_audit.rb
+- lib/sequel/plugins/bulk_audit/version.rb
+- sequel-bulk-audit.gemspec
+homepage: https://github.com/fiscal-cliff/sequel-bulk-audit/
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: " Next steps:\n    1. Run rails g audit_migration\n    2. Edit
+  generated migration\n    3. Apply the migration\"\n  "
+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.6.13
+signing_key: 
+specification_version: 4
+summary: This gem provides a trigger based solution for auditing table changes
+test_files: []