action_audit 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7a69b6b0b1590ea99b587a0d5a377b51164ca32
+  data.tar.gz: bcbbea403d691b56aca6b4659eee6c88c6d7081f
+SHA512:
+  metadata.gz: c54b20f26179f5a30ac772078f82e959b351542d2c65fec5075cb9c28ded58d51171730417ac8636f42ad75f392190b90c1d3ec0683805daf564248d510eafed
+  data.tar.gz: 0b396cd1900045a94fe5e30d9783bff26bdd6e5a25d1f61221cacbd74130244295e6e0e54d313421b3b37a25e478335826b8547e56efd1a3a0144184b497d64a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action_auditor.gemspec
+gemspec
+
+gem 'rspec'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 d.kirichenko
+
+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,66 @@
+# ActionAuditor
+
+Allows to record models changes. It can be ActiveRecord models or any other.
+Observer for ActiveRecord are included, for other models you should write your own code.
+You should also take care where to store this changes.
+
+We split all changes into actions. Action can be rails controller action or resque/sidekiq/rake task.
+Every action can have unlimited number af attributes. For controller action it can be current user id, response status and anything else.
+
+There are thee main items in action_auditor structure:
+
+* ActionObserver
+* ModelsObserver
+* Store
+
+We offer some default implementation for each of them, but your are free to write your own.
+
+ActionsObserver is a class or module, often mixin. It starts ActionAuditor at the beginning of action and stop at the end.
+No changes will be stored if ActionAuditor isn't started.
+It also stores action attributes related to the action. Action attributes can be stored from any place of code
+
+```ruby
+ActionAudit.add_params(user_id: user.id)
+```
+
+You can use ActionAuditor::Controller for Rails controllers and RescueConcern for resque tasks or write your own.
+
+```ruby
+require 'action_auditor/controller_concern'
+class ApplicationController < ActionController::Base
+  include ActionAuditor::ControllerConcern
+end
+```
+
+ModelsObserver observe model changes and trigger ActionAuditor to to store them.
+To observe ActiveRecord changes your should add to config/application.rb
+
+```ruby
+config.after_initialize do
+  require 'action_auditor/ar'
+  ActionAuditor::Ar.observe [MyModel1, MyModel2]
+end
+```
+
+You can add this code for correct work after code reloading in development into config/environment/development.rb
+
+```ruby
+ActionDispatch::Reloader.to_prepare do
+  ActionAuditor::Ar.observe [MyModel1, MyModel2]
+end
+```
+
+You could write you own observer for non-ActiveRecord models.
+
+The last part of the system is Store. We provide default store that save data to log file,
+but this gem were invented to store data to Postgres database. We don't privide such
+store becase it depends on how do your want to analize this data. You can set up the store in initializer with
+
+```ruby
+ActionAuditor.store = YourStore.new
+```
+
+If you want to see some info logs from this gem you should also configure the logger
+```ruby
+ActionAuditor.logger = Rails.logger
+```

data/Rakefile

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

data/action_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 'action_audit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_audit"
+  spec.version       = ActionAudit::VERSION
+  spec.authors       = ["denis.kirichenko"]
+  spec.email         = ["denis.kirichenko@gmail.com"]
+  spec.description   = %q{Allows to record models changes}
+  spec.summary       = %q{Allows to record models changes. It can be ActiveRecord models or any other. Observer for ActiveRecord are included, for other models you should write your own code. You should also take care where to store this changes.}
+  spec.homepage      = "https://github.com/netDalek/action_audit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'micromachine', '~> 1.1'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/action_audit.rb

@@ -0,0 +1,34 @@
+require "active_support/core_ext/module/delegation.rb"
+require 'micromachine'
+
+require "action_audit/version"
+require "action_audit/factory"
+require "action_audit/event_processor"
+require "action_audit/log_store"
+
+module ActionAudit
+  class << self
+    delegate :add_change, :add_params, :with_auditor, to: ActionAudit::Factory
+
+    def store
+      @store ||= LogStore.new
+    end
+    attr_writer :store
+
+    attr_accessor :logger
+
+    def info(message)
+      logger.info(message) if logger
+    end
+
+    def error(message)
+      return unless logger
+      if message.respond_to?(:backtrace)
+        bt = Rails.backtrace_cleaner.clean(message.backtrace)
+        logger.error("[action_audit] #{message}: #{bt}")
+      else
+        logger.error("[action_audit] #{message}")
+      end
+    end
+  end
+end

data/lib/action_audit/ar.rb

@@ -0,0 +1,44 @@
+module ActionAudit
+  module Ar
+    class UpdateObserver
+      include Singleton
+      def after_commit(record)
+        changes = record.previous_changes
+        if changes.present?
+          was = Hash[changes.map{|key, value| [key, value.first]}]
+          become = Hash[changes.map{|key, value| [key, value.last]}]
+          ActionAudit.add_change(record, was, become)
+        end
+      rescue Exception => e
+        ActionAudit.error(e)
+      end
+    end
+
+    class DestroyObserver
+      include Singleton
+      def after_commit(record)
+        ActionAudit.add_change(record, record.attributes, {})
+      rescue Exception => e
+        ActionAudit.error(e)
+      end
+    end
+
+    class CreateObserver
+      include Singleton
+      def after_commit(record)
+        ActionAudit.add_change(record, {}, record.attributes)
+      rescue Exception => e
+        ActionAudit.error(e)
+      end
+    end
+
+    def self.observe(*models)
+      models.flatten.each do |e|
+        cl = e.to_s.camelize.constantize
+        cl.after_commit CreateObserver.instance, on: :create
+        cl.after_commit UpdateObserver.instance, on: :update
+        cl.after_commit DestroyObserver.instance, on: :destroy
+      end
+    end
+  end
+end

data/lib/action_audit/controller_concern.rb

@@ -0,0 +1,25 @@
+require 'active_support/concern'
+require 'ostruct'
+
+module ActionAudit::ControllerConcern
+  extend ActiveSupport::Concern
+
+  included do
+    around_filter :audit
+  end
+
+  def audit
+    ActionAudit.info("start audit controller")
+    ActionAudit.with_auditor do
+      ActionAudit.add_params(params.slice("action", "controller"))
+      ActionAudit.add_params(user_id: current_user.id) if current_user
+      begin
+        yield
+      ensure
+        ActionAudit.add_params(status: response.status)
+        ActionAudit.info("add params audit controller #{response.status}")
+        ActionAudit.info("finish audit controller")
+      end
+    end
+  end
+end

data/lib/action_audit/event_processor.rb

@@ -0,0 +1,31 @@
+class ActionAudit::EventProcessor
+  delegate :info, to: ActionAudit
+
+  def initialize(store)
+    @store = store
+    @params = {}
+  end
+
+  def add_change(entity, was, become)
+    info "adding changeset for entity #{entity}"
+    changes_state.trigger(:entity_changed)
+    @store.save_change(@action_id, entity, was, become)
+  end
+
+  def add_params(params)
+    @params.merge!(params)
+    changes_state.trigger(:params_added)
+  end
+
+  private
+
+  def changes_state
+    @changes_state ||= MicroMachine.new(:nothing).tap do |m|
+      m.when(:entity_changed, :nothing => :changed)
+      m.when(:params_added, :changed => :changed)
+      m.on(:changed) do
+        @action_id = @store.upsert_action(@params, @action_id)
+      end
+    end
+  end
+end

data/lib/action_audit/factory.rb

@@ -0,0 +1,31 @@
+class ActionAudit::Factory
+  class << self
+    def current
+      Thread.current[:action_auditor]
+    end
+
+    def start
+      Thread.current[:action_auditor] = ActionAudit::EventProcessor.new(ActionAudit.store)
+    end
+
+    def flush
+      Thread.current[:action_auditor] = nil
+    end
+
+    def with_auditor(params = {})
+      start
+      add_params(params)
+      yield
+    ensure
+      flush
+    end
+
+    def add_params(*args)
+      current.add_params(*args) if current
+    end
+
+    def add_change(*args)
+      current.add_change(*args) if current
+    end
+  end
+end

data/lib/action_audit/log_store.rb

@@ -0,0 +1,19 @@
+class LogStore
+  delegate :info, to: ActionAudit
+
+  def upsert_action(params, id)
+    id ||= SecureRandom.uuid
+    info "[action_audit] [#{id}] #{params}"
+    id
+  end
+
+  def save_change(action_id, entity, was, become)
+    params = {
+      entity_id: entity.id,
+      entity_type: entity.class.name,
+      was: was,
+      become: become
+    }
+    info "[audit_changeset] [#{action_id}] #{params}"
+  end
+end

data/lib/action_audit/resque_concern.rb

@@ -0,0 +1,21 @@
+module ActionAudit::ResqueConcern
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def around_perform_auditor(*args)
+      logger_info "audit job with args #{args}"
+      Auditor.start
+      Auditor.add_params(args: args, job_name: self.name)
+      yield
+    ensure
+      Auditor.flush
+    end
+
+    private
+
+    def logger_info(str)
+      Rails.logger.info "[Audit] [#{name}] #{str}"
+    end
+  end
+
+end

data/lib/action_audit/version.rb

@@ -0,0 +1,3 @@
+module ActionAudit
+  VERSION = "0.0.2"
+end

data/spec/action_audit_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe ActionAudit do
+  let(:params1) { {a: 1} }
+  let(:params2) { {b: 1} }
+
+  let(:entity) { {b: 1} }
+  let(:was) { {c: 1} }
+  let(:become) { {d: 1} }
+
+  let(:store) { spy(:store) }
+
+  it "saves changes when auditor started" do
+    ActionAudit.store = store
+    expect(store).to receive(:upsert_action).with(params1, nil).and_return(1)
+    expect(store).to receive(:save_change).with(1, entity, was, become)
+
+    ActionAudit.with_auditor do
+      ActionAudit.add_params(params1)
+      ActionAudit.add_change(entity, was, become)
+    end
+  end
+end

data/spec/controller_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require 'action_audit/controller_concern'
+require 'active_support/core_ext/hash/slice'
+
+RSpec.describe ActionAudit::ControllerConcern do
+  class TestController
+    def self.around_filter(_smth)
+    end
+
+    def response
+      OpenStruct.new(status: 200)
+    end
+
+    include ActionAudit::ControllerConcern
+  end
+
+  let(:params) { {"action" => "create", "controller" => "my_controller"} }
+  let(:controller) { TestController.new }
+  let(:response) { OpenStruct.new(status: 200) }
+
+  let(:store) { spy(:store) }
+
+  before do
+    ActionAudit.store = store
+    expect(store).to receive(:upsert_action).with(params, nil).and_return(1).ordered
+    expect(store).to receive(:save_change).with(1, :a, :b, :c)
+    expect(store).to receive(:upsert_action).with(params.merge(status: 200), 1).and_return(1).ordered
+  end
+
+  it "store change while controller action" do
+    expect(controller).to receive_messages(current_user: nil, params: params, response: response)
+    controller.audit do 
+      ActionAudit.add_change(:a, :b, :c)
+    end
+  end
+end

data/spec/event_processor_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe ActionAudit::EventProcessor do
+  let(:params1) { {a: 1} }
+  let(:params2) { {b: 1} }
+
+  let(:entity) { {b: 1} }
+  let(:was) { {c: 1} }
+  let(:become) { {d: 1} }
+
+  let(:store) { spy(:store) }
+
+  subject { described_class.new(store) }
+
+  it "doesn't save action without changes" do
+    subject.add_params(params1)
+    subject.add_params(params2)
+  end
+
+  it "saves action with params after first change" do
+    expect(store).to receive(:upsert_action).with(params1.merge(params2), nil).and_return(1)
+    expect(store).to receive(:save_change).with(1, entity, was, become)
+
+    subject.add_params(params1)
+    subject.add_params(params2)
+    subject.add_change(entity, was, become)
+  end
+
+  it "after change added saves action params every time" do
+    expect(store).to receive(:upsert_action).with(params1, nil).ordered.and_return(1)
+    expect(store).to receive(:save_change).with(1, entity, was, become).ordered
+    expect(store).to receive(:upsert_action).with(params1.merge(params2), 1).ordered.and_return(1)
+
+    subject.add_params(params1)
+    subject.add_change(entity, was, become)
+    subject.add_params(params2)
+  end
+end

data/spec/factory_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe ActionAudit::Factory do
+  let(:params1) { {a: 1} }
+  let(:params2) { {b: 1} }
+
+  let(:entity) { {b: 1} }
+  let(:was) { {c: 1} }
+  let(:become) { {d: 1} }
+
+  let(:store) { spy(:store) }
+
+  it "saves changes when auditor started" do
+    ActionAudit.store = store
+    expect(store).to receive(:upsert_action).with(params1, nil).and_return(1)
+    expect(store).to receive(:save_change).with(1, entity, was, become)
+
+    ActionAudit::Factory.with_auditor do
+      described_class.add_params(params1)
+      described_class.add_change(entity, was, become)
+    end
+  end
+
+  it "doesn't saves changes when auditor doesn't started" do
+    described_class.add_params(params1)
+    described_class.add_change(entity, was, become)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+require 'action_audit'
+require 'rspec'
+require "rspec/expectations"
+require 'pry'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: action_audit
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- denis.kirichenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: micromachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: Allows to record models changes
+email:
+- denis.kirichenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_audit.gemspec
+- lib/action_audit.rb
+- lib/action_audit/ar.rb
+- lib/action_audit/controller_concern.rb
+- lib/action_audit/event_processor.rb
+- lib/action_audit/factory.rb
+- lib/action_audit/log_store.rb
+- lib/action_audit/resque_concern.rb
+- lib/action_audit/version.rb
+- spec/action_audit_spec.rb
+- spec/controller_spec.rb
+- spec/event_processor_spec.rb
+- spec/factory_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/netDalek/action_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.2.2
+signing_key: 
+specification_version: 4
+summary: Allows to record models changes. It can be ActiveRecord models or any other.
+  Observer for ActiveRecord are included, for other models you should write your own
+  code. You should also take care where to store this changes.
+test_files:
+- spec/action_audit_spec.rb
+- spec/controller_spec.rb
+- spec/event_processor_spec.rb
+- spec/factory_spec.rb
+- spec/spec_helper.rb