models_auditor 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 267bcb8f116da48b04983ca8ebd0f383a645ae63
-  data.tar.gz: 8925843248724eb62269f2d7f9f1dd558e4170d2
+  metadata.gz: 48a7e08268e6af1064f7f77660ede51f8f5dca9d
+  data.tar.gz: 4fc60442b137cb0b2020791bd071b53db36c5213
 SHA512:
-  metadata.gz: 1c70a5409a656494595045a74ca5a6b517586a427ea59b3ad8629f1c45c9b10c4cfbd9219552faa70a9537a8af02526eda2dbae49e960fd87cfd75d9ea69a5f3
-  data.tar.gz: 7a3fd44fa43106b2281d4488104c1aa99090bf6c6cbea5ce6ba73d393410aa79646e873284d1116281166edd90890baba2f5124a8d445758b5f91de6d5e7b3d0
+  metadata.gz: 7d862f438b570336df4796b99cecf60f4d3136633c5cc33239c15ff4bcf62ef36425df3915940e5f37d9cdb14209f50c97482f8b846f80e765dcb318ee1187f4
+  data.tar.gz: b8bfbc137c0f5ac1cbf136c81d2a45643149c44aa7339db40647ec6d2fdd7a2df2a1bb0ed559a46f0ce561d92fd2294aa3ff1d1acb0694a96d38edbca3b1aad9

data/README.md

@@ -0,0 +1,112 @@
+# ModelsAuditor
+
+## Installation
+
+1. **Add ModelsAuditor to your Gemfile**
+
+    `gem 'models_auditor'`
+    
+    Then execute `$ bundle install`
+
+2. **Add the gem settings to your project**
+
+    `rails g models_auditor:install`
+
+    It added _models_auditor_ initializer. Make necessary settings in this file.
+
+3. **Generate the audit database config**
+
+    `rails g models_auditor:db_config`
+
+    It appended separate sections to config/database.yml. Edit them.
+
+4. **Create the audit database**
+
+    `rake db:audit:create`
+
+5. **Generate models_auditor migrations for audit_database**
+
+    `rails g models_auditor:migrations`
+
+    Migration files will be putted into db/audit_migrate.
+
+6. **Apply migrations to the audit database**
+
+    `rake db:audit:migrate`
+
+## Usages
+
+1. Mount the route for read logs json api
+
+    ```ruby
+    Rails.application.routes.draw do
+    
+        mount ModelsAuditor::Engine => '/audit'
+        
+    end    
+    ```
+    
+    To looking at routes list do
+     
+     `$ rake routes`
+     
+        models_auditor_requests GET  (/index)(/page/:page)(.:format) models_auditor/audit#index {:page=>/\d+/}
+                           root GET  /                               models_auditor/audit#index
+
+2. To enable audit you have to add into each logged models
+
+    `enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON`
+    
+        AUDIT_MODE_JSON         - Serialization by #as_json
+        AUDIT_MODE_SERIALIZER   - Serialization by using a ActiveModel Serializer, specifyied by :serializer option
+        AUDIT_MODE_METHOD       - Serialization by a method, specifyied by :method option
+        AUDIT_MODE_CHANGES_ONLY - Serialization ActiveRecord changes of model only
+        
+    ```ruby
+    class Post < ActiveRecord::Base
+      enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON
+    end
+    ```    
+        
+    ```ruby
+    class Author < ActiveRecord::Base
+      enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON
+    end
+    ```    
+    
+3. Add to each association models
+    
+    `enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON, bridge: {Author.name => :author_id, Post.name => :post_id}`
+    
+    ```ruby
+    class AuthorsPost < ActiveRecord::Base
+      enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON, bridge: {Author.name => :author_id, Post.name => :post_id}
+    end
+    ``` 
+
+## Audit database management
+
+**Creation of the audit database**
+
+`rake db:audit:create`
+
+**Dropping of the audit database**
+
+`rake db:audit:drop`
+
+**Apply migrations to the audit database**
+
+`rake db:audit:migrate`
+
+**Rollback migrations to the audit database**
+
+`rake db:audit:rollback`
+
+---
+
+If you want to use a database prefix not from config. You may specify it as an argument in square brackets.
+
+`rake db:audit:create[audit_shmaudit]`
+
+
+This project rocks and uses MIT-LICENSE.

data/lib/models_auditor/version.rb

@@ -1,3 +1,3 @@
 module ModelsAuditor
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/tasks/models_auditor_tasks.rake

@@ -9,7 +9,7 @@ namespace :db do
       raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
 
       connection_params =
-        ActiveRecord::Base.configurations[db].merge(
+        ActiveRecord::Base.configurations[db.to_s].merge(
           'database'           => 'postgres',
           'schema_search_path' => 'public'
         )
@@ -20,7 +20,7 @@ namespace :db do
       db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
       raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
 
-      connection_params = ActiveRecord::Base.configurations[db]
+      connection_params = ActiveRecord::Base.configurations[db.to_s]
       ActiveRecord::Base.establish_connection(connection_params)
     end
 
@@ -28,7 +28,7 @@ namespace :db do
     task :create, [:database] => [:connect_without_db, :environment] do |t, args|
       db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
       raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
-      database_name = ActiveRecord::Base.configurations[db]['database']
+      database_name = ActiveRecord::Base.configurations[db.to_s]['database']
 
       puts "Applying create on #{db}"
       ActiveRecord::Base.connection.create_database(database_name)
@@ -38,7 +38,7 @@ namespace :db do
     task :drop, [:database] => [:connect_without_db, :environment] do |t, args|
       db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
       raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
-      database_name = ActiveRecord::Base.configurations[db]['database']
+      database_name = ActiveRecord::Base.configurations[db.to_s]['database']
 
       # Дропаем существующие подключения
       # и запрещаем новые на время пересоздания базы

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: models_auditor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander Gorbunov
@@ -118,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/models_auditor/application.js
 - app/assets/stylesheets/models_auditor/application.css
@@ -185,7 +186,7 @@ files:
 - test/integration/navigation_test.rb
 - test/models_auditor_test.rb
 - test/test_helper.rb
-homepage: https://github.com/lexgorbunov/models_auditor
+homepage: https://github.com/Go-Promo/models_auditor
 licenses:
 - MIT
 metadata: {}