models_auditor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 267bcb8f116da48b04983ca8ebd0f383a645ae63
+  data.tar.gz: 8925843248724eb62269f2d7f9f1dd558e4170d2
+SHA512:
+  metadata.gz: 1c70a5409a656494595045a74ca5a6b517586a427ea59b3ad8629f1c45c9b10c4cfbd9219552faa70a9537a8af02526eda2dbae49e960fd87cfd75d9ea69a5f3
+  data.tar.gz: 7a3fd44fa43106b2281d4488104c1aa99090bf6c6cbea5ce6ba73d393410aa79646e873284d1116281166edd90890baba2f5124a8d445758b5f91de6d5e7b3d0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Alexander Gorbunov
+
+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,37 @@
+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    = 'ModelsAuditor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+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/app/assets/javascripts/models_auditor/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/models_auditor/application.css

@@ -0,0 +1,64 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+.full-width {
+    width: 100%;
+}
+
+.models-auditor-flex {
+    display: flex;
+}
+
+.models-auditor-column {
+    flex-direction: column;
+}
+
+.models-auditor-list {
+    display: flex;
+}
+
+.models-auditor-list .models-auditor-item {
+    display: flex;
+}
+
+.models-auditor-form-group {
+    display: flex;
+    flex-wrap: wrap;
+}
+
+.models-auditor-label {
+    flex-basis: 10%;
+    font-weight: 700;
+}
+
+.models-auditor-val {
+    flex-basis: 90%;
+    padding-left: 25px;
+    box-sizing: border-box;
+}
+
+.models-auditor-parameter {
+    display: flex;
+
+}
+
+.models-auditor-parameter .models-auditor-form-group {
+    padding-left: 25px;
+}
+
+.models-auditor-audit-record {
+    border-bottom: 1px solid #ccc;
+}

data/app/controllers/models_auditor/audit_base_controller.rb

@@ -0,0 +1,5 @@
+module ModelsAuditor
+  class AuditBaseController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/models_auditor/audit_controller.rb

@@ -0,0 +1,121 @@
+module ModelsAuditor
+  class AuditController < ModelsAuditor.config.audit_controller_base.classify.constantize
+    layout 'models_auditor/application'
+
+    # GET /pages.json
+    def index
+      page          = params.fetch(:page, 1).to_i
+      per_page      = ModelsAuditor.config.records_per_page
+      paginate_info = {page: page, per_page: per_page}.tap do |info|
+        info.merge!(total_entries: (page * per_page + per_page * 10)) if ModelsAuditor.config.fake_total_count
+      end
+
+      @collection =
+        ModelsAuditor::AuditRequest.includes(:records).all
+          .order(created_at: :desc)
+          .paginate(paginate_info)
+
+      @collection = apply_filters(@collection, params[:filters])
+
+      respond_to do |f|
+        if ModelsAuditor.config.respond_to_json_enabled
+          f.json {
+            render json: {
+              ModelsAuditor.config.json_response_data_key => structure_requests_data(@collection),
+              ModelsAuditor.config.json_response_meta_key => {
+                per_page: @collection.per_page,
+                total: @collection.total_entries,
+                sort_by: @collection.order_info
+              }
+            }
+          }
+        end
+        if ModelsAuditor.config.respond_to_html_enabled
+          f.html
+        end
+      end
+    end
+
+    private
+
+    def apply_filters(collection, filters)
+      return collection if filters.blank? || collection.nil?
+      if filters[:since_at].present? && (time = (Time.parse(filters[:since_at]) rescue nil)).present?
+        collection =
+          collection
+            .where(ModelsAuditor::AuditRecord.arel_table[:created_at].gteq(time))
+            .references(ModelsAuditor::AuditRecord.table_name.to_sym)
+      end
+      if filters[:before_at].present? && (time = (Time.parse(filters[:before_at]) rescue nil)).present?
+        collection =
+          collection
+            .where(ModelsAuditor::AuditRecord.arel_table[:created_at].lteq(time))
+            .references(ModelsAuditor::AuditRecord.table_name.to_sym)
+      end
+      if filters[:action].present?
+        collection = collection.where(ModelsAuditor::AuditRecord.arel_table[:action].eq(ModelsAuditor::AuditRecord.actions[filters[:action]])).references(ModelsAuditor::AuditRecord.table_name.to_sym)
+
+      end
+      if filters[:user_id].present?
+        collection = collection.where(user_id: filters[:user_id])
+      end
+      if filters[:object].present?
+        cond = {}
+        if (object_id = filters[:object][:id].to_i) > 0
+          cond[:object_id] = object_id
+        end
+        if (object_type = filters[:object][:type]).present?
+          cond[:object_type] = object_type
+        end
+
+        filtered_requests = collection.where(ModelsAuditor::AuditRecord.table_name.to_sym => cond).pluck(:id)
+        collection        = collection.where(id: filtered_requests)
+      end
+
+      collection
+    end
+
+    def get_relations(record, records)
+      rel_records = records.select { |r| !r.bridge.nil? && r.bridge.keys.include?(record.object_type) }
+      rel_records.map do |i|
+        target_class = i.bridge.except(record.object_type).keys.first
+        next unless target_class
+        i.attributes.slice('id', 'object_type', 'object_id').merge(target: {target_class => i.bridge[target_class].values.first})
+      end.compact
+    end
+
+    # @param [ActiveRecord::Relation|ModelsAuditor::AuditRequest|Array] data
+    def structure_requests_data(data)
+      requests =
+        case data
+          when ActiveRecord::Relation
+            data.to_a
+          when ModelsAuditor::AuditRequest
+            [data]
+          when Array
+            data
+          else
+            raise ArgumentError('Incorrect type of argument `requests`')
+        end
+
+      requests.map do |request|
+        records = request.records
+        {}.tap do |result|
+          changed_models_collection =
+            records
+              .select { |record| record.bridge.nil? }
+              .map do |record|
+              {
+                data:          record.attributes.slice('id', 'object_type', 'object_id'),
+                relationships: get_relations(record, records)
+              }
+            end
+
+          result[:request]   = request.as_json
+          result[:changes_struct] = changed_models_collection.group_by { |i| i[:data]['object_type'] }
+          result[:all_changes]    = records.map(&:as_json)
+        end
+      end
+    end
+  end
+end

data/app/helpers/models_auditor/application_helper.rb

@@ -0,0 +1,4 @@
+module ModelsAuditor
+  module ApplicationHelper
+  end
+end

data/app/models/models_auditor/audit_record.rb

@@ -0,0 +1,17 @@
+module ModelsAuditor
+  class AuditRecord < ActiveRecord::Base
+    ACTION_CREATE  = 0
+    ACTION_UPDATE  = 1
+    ACTION_DESTROY = 2
+
+    establish_connection [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
+    self.table_name = ModelsAuditor.config.audit_records_table_name
+
+    belongs_to :request, class_name: ModelsAuditor::AuditRequest.name, foreign_key: :request_id
+    belongs_to :auditable, polymorphic: true, foreign_key: :object_id, foreign_type: :object_type
+
+    enum action: {action_create: ACTION_CREATE, action_update: ACTION_UPDATE, action_destroy: ACTION_DESTROY}
+
+    validates :object_type, :object_id, presence: true
+  end
+end

data/app/models/models_auditor/audit_request.rb

@@ -0,0 +1,12 @@
+module ModelsAuditor
+  class AuditRequest < ActiveRecord::Base
+    establish_connection [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
+    self.table_name = ModelsAuditor.config.audit_requests_table_name
+
+    has_many :records, class_name: ModelsAuditor::AuditRecord.name, foreign_key: :request_id, inverse_of: :request
+
+    # def as_json(options = nil)
+    #   super({include: :records }.merge(options || {}))
+    # end
+  end
+end

data/app/views/layouts/models_auditor/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ModelsAuditor</title>
+  <%= stylesheet_link_tag 'models_auditor/application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+<%= javascript_include_tag 'models_auditor/application' %>
+</body>
+</html>

data/app/views/models_auditor/audit/_record.html.erb

@@ -0,0 +1,39 @@
+<div class="models-auditor-item full-width models-auditor-column models-auditor-audit-record">
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">Модель:</div>
+    <div class="models-auditor-form-group models-auditor-val"><%= entry.object_type %></div>
+  </div>
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">ID:</div>
+    <div class="models-auditor-form-group models-auditor-val"><%= entry.object_id %></div>
+  </div>
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">Request:</div>
+    <div class="models-auditor-form-group models-auditor-val"><a href="<%= models_auditor_request_path(id: entry.request_id) %>">#<%= entry.request_id %></a></div>
+  </div>
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">Действие:</div>
+    <div class="models-auditor-form-group models-auditor-val">
+      <% case entry.read_attribute(:action) %>
+        <% when ModelsAuditor::AuditRecord::ACTION_CREATE %>
+          Создание
+        <% when ModelsAuditor::AuditRecord::ACTION_UPDATE %>
+          Внесение изменений
+        <% when ModelsAuditor::AuditRecord::ACTION_DESTROY %>
+          Удаление
+      <% end %>
+    </div>
+  </div>
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">Изменения:</div>
+    <div class="models-auditor-form-group models-auditor-val models-auditor-column">
+      <% (entry.content || {}).each do |key, val| %>
+        <div class="models-auditor-form-group">
+          <div class="models-auditor-label"><%= key %></div>
+          <div class="models-auditor-val"><%= val %></div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+
+</div>

data/app/views/models_auditor/audit/_request.html.erb

@@ -0,0 +1,25 @@
+<div class="models-auditor-item full-width models-auditor-column">
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">Параметры запроса:</div>
+    <% (entry.request_info || {}).each do |key, val| %>
+      <div class="models-auditor-form-group">
+        <div class="models-auditor-label"><%= key %></div>
+        <div class="models-auditor-val"><%= val %></div>
+      </div>
+    <% end %>
+  </div>
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">ID Ответственного:</div>
+    <div class="models-auditor-form-group"><%= entry.user_id %></div>
+  </div>
+  <div class="models-auditor-parameter full-width models-auditor-column">
+    <div class="models-auditor-label">Модели:</div>
+    <div class="models-auditor-form-group">
+      <div class="models-auditor-list models-auditor-column full-width">
+        <% (entry.records || []).each do |record| %>
+          <%= render partial: 'record', object: record, as: :entry %>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/models_auditor/audit/index.html.erb

@@ -0,0 +1,3 @@
+<div class="models-auditor-list full-width models-auditor-column">
+  <%= render partial: 'request', collection: @collection, as: :entry %>
+</div>

data/config/config_option_descriptions.yml

@@ -0,0 +1,23 @@
+audit_enabled:                Включение/Отключение аудита всех моделей
+connection_namespace:         Namespace для конфига базы данных
+audit_migrations_dir:         Папка для хранения миграций аудитора
+audit_records_table_name:     Название таблицы для хрянения логов
+audit_requests_table_name:    Название таблицы для хранения информации о запросах, приведших к изменению данных
+audit_request_changes_only:   |-
+                              true:   Логировать только изменения, производимые через Request
+                              false:  Логировать любые изменения
+logger:                       |-
+                              Может принимать объект класса Logger или false
+                              Пример:
+                                config.logger = false
+                                или
+                                config.logger = Logger.new(Rails.root.join('log', 'models_auditor.log'))
+records_per_page:             Количество залогированных записей об изменениях в моделях на страницу
+fake_total_count:             Не настоящее значение total_count записей в логах
+audit_controller_base:        |-
+                              Базовый класс audit контроллера
+                              Пример: config.audit_controller_base = '::ApplicationController'
+respond_to_json_enabled:      Доступ к логам через json api
+respond_to_html_enabled:      Доступ к логам через html
+json_response_data_key:       Ключ с залогированными данными в json ответе
+json_response_meta_key:       Ключ с meta информацией в json ответе

data/config/routes.rb

@@ -0,0 +1,5 @@
+ModelsAuditor::Engine.routes.draw do
+  get '(/index)(/page/:page)', to: 'audit#index', as: :models_auditor_requests, page: /\d+/, format: [:json, :html]
+
+  root to: 'audit#index'
+end

data/lib/generators/models_auditor/db_config/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Append audit database config
+
+Example:
+    rails generate models_auditor:db_config
+
+    This will append audit database config to database.yml