models_auditor 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3cc83c5ea9096c99e6455aaaf01e7a58c016f16
-  data.tar.gz: a462f33b2f8bf243c2cd1dcaefa9983da0a71f18
+  metadata.gz: 99a387e69efd7a90352cdf2ef193a8ac885d2f58
+  data.tar.gz: d45f0de4510f98035c96635760bb5a654621b874
 SHA512:
-  metadata.gz: caa26da0c5eb6ceb89d71f392788428f5e024ab345ec8a33c489aee240bdd7dc3bdf6496042661dd30721e1ee4ec9466eae7af63479ea6dc53e534293e995eb8
-  data.tar.gz: c9131493861ee112b1654e8ad441a9ccaa485baa37f620ac62ba34c987690997b360460075a5218ff1f96a76a5095907ed79700d34867ea19be38a266ccae25d
+  metadata.gz: 0d501e1c682daae07a70054ab5b23638a00ea71f6dd7c1b05ce7a9af4eaa9f17386b140bc88f5689bfb5b1df214f211c0b84ed60665790ee059a59c97835bf2b
+  data.tar.gz: 48c6ab3335b1b4325a10ffca829b6338cbed273e33410d2da85d22d133a1532e223c5879555ced53e6f5d2d62c973ffd698038e38110ca9ec65c19da41d11354

data/README.md

@@ -33,6 +33,15 @@
 6. **Apply migrations to the audit database**
 
     `rake db:audit:migrate`
+    
+7. **Add to sidekiq config config/sidekiq.yml**
+    
+    ```yaml
+    ...
+    :queues:
+      ...
+      - models_auditor
+    ```
 
 ## Usages
 

data/app/controllers/models_auditor/audit_controller.rb

@@ -19,9 +19,11 @@ module ModelsAuditor
 
       respond_to do |f|
         if ModelsAuditor.config.respond_to_json_enabled
+          formatter = ModelsAuditor.config.log_output_formatter.constantize.new(@collection)
+
           f.json {
             render json: {
-              ModelsAuditor.config.json_response_data_key => structure_requests_data(@collection),
+              ModelsAuditor.config.json_response_data_key => formatter.as_json,
               ModelsAuditor.config.json_response_meta_key => {
                 per_page: @collection.per_page,
                 total: @collection.total_entries,
@@ -77,67 +79,5 @@ module ModelsAuditor
       original.where(id: filtered_requests)
     end
 
-    def get_relations(record, records)
-      rel_records = records.select do |r|
-        !r.bridge.nil? && r.bridge.any? do |_, v|
-          v_type, v_id = v.to_a[0]
-          v_type.to_s == record.object_type && v_id.to_i == record.object_id.to_i
-        end
-      end
-      rel_records.map do |i|
-        target_info = except_target_class(i.bridge, record.object_type, record.object_id)
-        next if target_info.empty?
-        t_key, klass_with_id = target_info.to_a[0]
-        target_klass, target_id = klass_with_id.to_a[0]
-        i.attributes.slice('id', 'object_type', 'object_id').merge(target: {
-          class: target_klass,
-          foreign_key: t_key,
-          foreign_id: target_id,
-        })
-      end.compact
-    end
-
-    # @return [Array]
-    def except_target_class(bridge, target_class, target_id)
-      target_id = target_id.to_i
-      bridge.select do |_, v|
-        klass, id = v.to_a[0]
-        !(klass.to_s == target_class.to_s && id.to_i == target_id.to_i)
-      end
-    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/models/models_auditor/audit_request.rb

@@ -8,6 +8,7 @@ module ModelsAuditor
     self.table_name = ModelsAuditor.config.audit_requests_table_name
 
     has_many :records, class_name: ModelsAuditor::AuditRecord.name, foreign_key: :request_id, inverse_of: :request
+    accepts_nested_attributes_for :records
 
     # def as_json(options = nil)
     #   super({include: :records }.merge(options || {}))

data/app/workers/models_auditor/models_auditor_worker.rb

@@ -0,0 +1,23 @@
+require 'sidekiq'
+
+module ModelsAuditor
+  class ModelsAuditorWorker
+    include Sidekiq::Worker
+
+    sidekiq_options queue: 'models_auditor', retry: 2, backtrace: true
+
+    def perform(request_data_json)
+      return unless ModelsAuditor.config.audit_enabled
+
+      ModelsAuditor::AuditRecord.connection.pool.with_connection do
+        request_data = JSON.parse(request_data_json)
+        request = ModelsAuditor::AuditRequest.new(request_data)
+        unless request.save
+          ModelsAuditor.log_error("Couldn't save request record")
+          ModelsAuditor.log_error(request.errors.full_messages)
+        end
+      end
+    end
+
+  end
+end

data/config/config_option_descriptions.yml

@@ -3,9 +3,6 @@ connection_namespace:         Namespace для конфига базы данн
 audit_migrations_dir:         Папка для хранения миграций аудитора
 audit_records_table_name:     Название таблицы для хрянения логов
 audit_requests_table_name:    Название таблицы для хранения информации о запросах, приведших к изменению данных
-audit_request_changes_only:   |-
-                              true:   Логировать только изменения, производимые через Request
-                              false:  Логировать любые изменения
 logger:                       |-
                               Может принимать объект класса Logger или false
                               Пример:
@@ -21,3 +18,4 @@ respond_to_json_enabled:      Доступ к логам через json api
 respond_to_html_enabled:      Доступ к логам через html
 json_response_data_key:       Ключ с залогированными данными в json ответе
 json_response_meta_key:       Ключ с meta информацией в json ответе
+log_output_formatter:         Класс форматирующий данные логов перед выдачей

data/lib/models_auditor/audit.rb

@@ -84,46 +84,30 @@ module ModelsAuditor
             options[:bridge].each_with_object({}) { |(key, model_name), o| o[key] = {model_name => __send__(key)} }
           end
 
-        Thread.new do
-          begin
-            log_anyway = !ModelsAuditor.config.audit_request_changes_only
-            if store[:audit_request] || log_anyway
-              (store[:audit_mutex] ||= Mutex.new).synchronize do
-                request = store[:audit_request]
-                body =
-                  case
-                    when AUDIT_SNAPSHOT_MODES.include?(mode)
-                      ma_eliminate_not_changed_keys(initial_data, current_data)
-                    when AUDIT_CHANGES_MODES.include?(mode)
-                      current_data
-                    else
-                      raise ArgumentError.new('Incorrect value of argument audit_type')
-                  end
-
-                if request.try(:new_record?) && !request.save
-                  ModelsAuditor.log_error("Couldn't save request record")
-                  ModelsAuditor.log_error(request.errors.full_messages)
-                  return
-                end
-                record =
-                  ModelsAuditor::AuditRecord.new(
-                    request:   request,
-                    auditable: self,
-                    content:   body,
-                    action:    action,
-                    bridge:    bridge
-                  )
-                unless record.save
-                  ModelsAuditor.log_error("Couldn't logged changes of #{self.class.name} id: #{self.try(:id)}")
-                  ModelsAuditor.log_error(record.errors.full_messages)
-                end
+        begin
+          if (request_data = store[:audit_request_data]).present?
+            body =
+              case
+                when AUDIT_SNAPSHOT_MODES.include?(mode)
+                  ma_eliminate_not_changed_keys(initial_data, current_data)
+                when AUDIT_CHANGES_MODES.include?(mode)
+                  current_data
+                else
+                  raise ArgumentError.new('Incorrect value of argument audit_type')
               end
-            end
-          rescue StandardError => e
-            ModelsAuditor.log_error("Couldn't logged changes of #{self.class.name} id: #{self.try(:id)}")
-            ModelsAuditor.log_error(e.message)
-            ModelsAuditor.log_error(e.backtrace.take(100).join("\n"))
+
+            request_data[:records_attributes] << {
+              object_id:    self.id,
+              object_type:  self.class.name,
+              content:      body,
+              action:       action,
+              bridge:       bridge
+            }
           end
+        rescue StandardError => e
+          ModelsAuditor.log_error("Couldn't generate log changes of #{self.class.name} id: #{self.try(:id)}")
+          ModelsAuditor.log_error(e.message)
+          ModelsAuditor.log_error(e.backtrace.take(100).join("\n"))
         end
       end
 

data/lib/models_auditor/config.rb

@@ -6,7 +6,6 @@ module ModelsAuditor
       audit_records_table_name
       audit_requests_table_name
       audit_migrations_dir
-      audit_request_changes_only
       logger
       records_per_page
       fake_total_count
@@ -15,6 +14,7 @@ module ModelsAuditor
       respond_to_html_enabled
       json_response_data_key
       json_response_meta_key
+      log_output_formatter
     )
 
     def initialize
@@ -47,10 +47,6 @@ module ModelsAuditor
           config: "Logger.new(Rails.root.join('log', 'models_auditor.log'))",
           val:    Logger.new(Rails.root.join('log', 'models_auditor.log'))
         },
-        audit_request_changes_only: {
-          config: 'true',
-          val:    true
-        },
         records_per_page:           {
           config: '10',
           val:    10
@@ -79,6 +75,10 @@ module ModelsAuditor
           config: "'meta'",
           val:    'meta'
         },
+        log_output_formatter:     {
+          config: "'ModelsAuditor::DefaultFormatter'",
+          val:    'ModelsAuditor::DefaultFormatter'
+        },
       }
     end
 

data/lib/models_auditor/controller.rb

@@ -1,19 +1,32 @@
 module ModelsAuditor
   module Controller
     def self.included(base)
-      base.before_action :set_models_auditor_request_params
+      base.around_action :set_models_auditor_request_params
     end
 
     protected
 
     def set_models_auditor_request_params
-      ModelsAuditor.store[:audit_request] =
-        ModelsAuditor::AuditRequest.new(
+      if ModelsAuditor.config.audit_enabled
+        ModelsAuditor.store[:audit_request_data] = {
           user_id:      user_for_models_auditor,
-          request_info: info_for_models_auditor
-        )
-    rescue StandardError
-      # ignored
+          request_info: info_for_models_auditor,
+          records_attributes: []
+        }
+
+        yield
+
+        if ModelsAuditor.store[:audit_request_data][:records_attributes].present?
+          begin
+            ModelsAuditor::ModelsAuditorWorker.perform_async(ModelsAuditor.store[:audit_request_data].to_json)
+          rescue StandardError => e
+            ModelsAuditor.log_error(e.message)
+            ModelsAuditor.log_error(e.backtrace.take(100).join("\n"))
+          end
+        end
+      else
+        yield
+      end
     end
 
     # Returns the user who is responsible for any changes that occur.

data/lib/models_auditor/default_formatter.rb

@@ -0,0 +1,72 @@
+module ModelsAuditor
+  class DefaultFormatter
+    def initialize(collection)
+      @collection = collection
+    end
+
+    # @param [ActiveRecord::Relation|ModelsAuditor::AuditRequest|Array] data
+    def as_json
+      requests =
+        case @collection
+          when ActiveRecord::Relation
+            @collection.to_a
+          when ModelsAuditor::AuditRequest
+            [@collection]
+          when Array
+            @collection
+          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
+
+    private
+
+    # @return [Array]
+    def except_target_class(bridge, target_class, target_id)
+      target_id = target_id.to_i
+      bridge.select do |_, v|
+        klass, id = v.to_a[0]
+        !(klass.to_s == target_class.to_s && id.to_i == target_id.to_i)
+      end
+    end
+
+    def get_relations(record, records)
+      rel_records = records.select do |r|
+        !r.bridge.nil? && r.bridge.any? do |_, v|
+          v_type, v_id = v.to_a[0]
+          v_type.to_s == record.object_type && v_id.to_i == record.object_id.to_i
+        end
+      end
+      rel_records.map do |i|
+        target_info = except_target_class(i.bridge, record.object_type, record.object_id)
+        next if target_info.empty?
+        t_key, klass_with_id = target_info.to_a[0]
+        target_klass, target_id = klass_with_id.to_a[0]
+        i.attributes.slice('id', 'object_type', 'object_id').merge(target: {
+          class: target_klass,
+          foreign_key: t_key,
+          foreign_id: target_id,
+        })
+      end.compact
+    end
+  end
+end

data/lib/models_auditor/version.rb

@@ -1,3 +1,3 @@
 module ModelsAuditor
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/models_auditor.rb

@@ -1,6 +1,7 @@
 require 'request_store'
 require 'models_auditor/engine'
 require 'models_auditor/config'
+require 'models_auditor/default_formatter'
 require 'models_auditor/audit'
 require 'models_auditor/controller'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: models_auditor
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexander Gorbunov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.17.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.17.7
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +145,7 @@ files:
 - app/views/models_auditor/audit/_record.html.erb
 - app/views/models_auditor/audit/_request.html.erb
 - app/views/models_auditor/audit/index.html.erb
+- app/workers/models_auditor/models_auditor_worker.rb
 - config/config_option_descriptions.yml
 - config/routes.rb
 - lib/generators/models_auditor/db_config/USAGE
@@ -149,6 +164,7 @@ files:
 - lib/models_auditor/capistrano/tasks/audit_migrations.rake
 - lib/models_auditor/config.rb
 - lib/models_auditor/controller.rb
+- lib/models_auditor/default_formatter.rb
 - lib/models_auditor/engine.rb
 - lib/models_auditor/version.rb
 - lib/tasks/models_auditor_tasks.rake