audit_logger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 334deb3b809257d3acf6fb467126e262e035853c
-  data.tar.gz: 689a1e77c79bf0fd3215033174cad210fef69753
+  metadata.gz: 464f54d48725e3da79fbf9d83dda1397eaac1a68
+  data.tar.gz: 42f2675fa6dd5ff6edd94d1cbc0fca5214b2af84
 SHA512:
-  metadata.gz: fbf998d080d063c7b7e256cc1895b1e7a58310b710fbf4b48d5b76d46285623379099b7733424afbb4a85f70ef3b84be46965c865b3a78cd0979067059755e0c
-  data.tar.gz: 52191f2949b3ae96fd0817ed10fa3e7b9305d28818fd6b1dbb72e156770143f272c60a46fc97423a730ef03b65ccb27dab5e40f27f21c70f38a901fc0b3728ae
+  metadata.gz: 2df1dd6d58866b78b675a28c0257d56b1852ba564bb38bbb9d1efdc5f7977ab0231aa19adb1ebe082d06b0c887198942a38fa3070c0d5cd8bab4ab28f2d96cc5
+  data.tar.gz: efd6d228c92f85f76e94d8e8678da6056541a0d1ee6914e7cda43d7b7028dadeecc709d4669e194d74d38eadc3f563895122818ff71e236bfaa7c8b2fed88d3e

data/README.md

@@ -24,35 +24,41 @@ After running bundle install, run the generator:
 
   ```ruby
 unless Rails.env.test?
-  log_path_with_env = "#{Rails.root}/log/audit/#{Rails.env}"
+  ::ERROR_LOG = AuditLogger::Audit.new('error', timestamp: true, pid: true, severity: true, thread: true)
 
-  ::ERROR_LOG = Audit::AuditLogger.new("#{log_path_with_env}_error.log", timestamp: true, pid: true, severity: true, thread: true)
-
-  # ::AUDIT_NULL   = Audit::AuditLogger.new(File::NULL)
-  # ::AUDIT_STDOUT = Audit::AuditLogger.new(STDOUT)
-  # ::PRODUCT_LOG  = AuditLogger::Audit.new("#{log_path_with_env}_product.log")
+  # ::AUDIT_NULL   = AuditLogger::Audit.new(File::NULL)
+  # ::AUDIT_STDOUT = AuditLogger::Audit.new(STDOUT)
+  # ::PRODUCT_LOG  = AuditLogger::Audit.new('product')
 end
   ```
 
-  By default all files will be generated in `log/audit/` ( which is created by generator too ) folder, if you want to change this behavior just change `#{Rails.root}/log/audit/#{Rails.env}` and reload server.
-  All exception which will be rescued will be inserted into `ERROR_LOG`
+  By default all files will be generated in `Rails.root/log/audit/` folder ( which is created by generator too ).
+
+  If you want to change folder name you should redefine `AuditLogger::Audit#folder_name` method.
+  All exception which will be rescued will be inserted into `ERROR_LOG`.
 
 ## Setup own logger
   To create new logger you need instantiate `AuditLogger::Audit`
   First argument is name of the logger file.
 
   ```ruby
-::PRODUCT_LOG  = AuditLogger::Audit.new("#{log_path_with_env}_product.log")
+::PRODUCT_LOG  = AuditLogger::Audit.new('product')
   ```
   Also if you want, you can insert `File::NULL` or `STDOUT` as first argument for sent output into `/dev/null/` or into console accordingly.
 
-  Additional arguments in initialization:
+  Additional arguments of initialization:
 
-    # by default
-    timestamp: true
-    thread: false
-    pid: false
-    severity: false
+  ```ruby
+options_hash = {timestamp: true, thread: false, pid: false, severity: false}
+::PRODUCT_LOG = AuditLogger::Audit.new('#{file_path}', options_hash)
+  ```
+
+  where:
+
+    timestamp: true - by default, options which shows date and time
+    severity: false - by default, options which shows severity ( +WARN+, +ERROR+, +FATAL+, or +UNKNOWN+ )
+    pid: false - by default, options which shows PID of a proces +$$+
+    thread: false - by default, options which shows Thread.current.object_id
 
   This option influence on otput which will be showed in the log file.
 
@@ -61,7 +67,7 @@ end
   Lets add products logger into `config/initializers/audit.rb` and enable all available parametrs:
 
   ```ruby
-::PRODUCT_LOG = Audit::AuditLogger.new("#{log_path_with_env}_product.log", timestamp: true, pid: true, severity: true, thread: true)
+::PRODUCT_LOG = AuditLogger::Audit.new('product', timestamp: true, pid: true, severity: true, thread: true)
   ```
 
   and use logger inside the rake task: `lib/tasks/products.rake`
@@ -83,12 +89,27 @@ end
 
   Logger output:
 
-    # log/audit/development_product.log
+    # log/audit/development/product.log
     [ 2015-05-25 15:05:07 | INFO | pid: 3443 | thread: 70101873590780 | <start_of>: This is rake task ]
     [ 2015-05-25 15:05:07 | INFO | pid: 3443 | thread: 70101873590780 | Output some information ]
     [ 2015-05-25 15:05:07 | INFO | pid: 3443 | thread: 70101873590780 | </end_of>: This is rake task ]
 
 
+  You can use this logger in migrations, models, ets:
+
+  ```ruby
+class AddAdditionalFieldsToUser < ActiveRecord::Migration
+  def up
+    DB_MIGRATION_LOG.log_block "#{self.class.name}: create some additional fields" do
+  ```
+
+  ```ruby
+def replace_active_cart(current_cart)
+  if self.cart.present?
+    PAYMENT_LOG.info "Cart assigned to Order##{self.cart.order.id}. Current cart##{current_cart.id}"
+      # do something
+  ```
+
 ## Error Handling:
   Method audit can accept second argument: `log_exception_only`
 
@@ -122,18 +143,18 @@ end
 
   relaunch rake task and you will see next log:
 
-    # log/audit/development_product.log
+    # log/audit/development/product.log
     [ 2015-05-25 15:06:45 | INFO | pid: 3710 | thread: 70177429783040 | <start_of>: This is rake task ]
     [ 2015-05-25 15:06:45 | ERROR | pid: 3710 | thread: 70177429783040 | ERROR OCCURRED. See details in the Error Log. ]
     [ 2015-05-25 15:06:45 | INFO | pid: 3710 | thread: 70177429783040 | </end_of>: This is rake task ]
 
-    # log/audit/development_error.log
-    [ 2015-05-25 15:06:45 | INFO | pid: 3710 | thread: 70177429783040 | <start_of>: This is rake task // development_product.log ]
+    # log/audit/development/error.log
+    [ 2015-05-25 15:06:45 | INFO | pid: 3710 | thread: 70177429783040 | <start_of>: This is rake task // product.log ]
     [ 2015-05-25 15:06:45 | ERROR | pid: 3710 | thread: 70177429783040 | RuntimeError: Error B. Cause exception: ]
     [ 2015-05-25 15:06:45 | ERROR | pid: 3710 | thread: 70177429783040 | NotOurError: Error A. Call stack: ]
     [ 2015-05-25 15:06:45 | ERROR | pid: 3710 | thread: 70177429783040 | -> ../lib/tasks/products.rake:44:in `block (3 levels) in <top (required)>' ]
     [ 2015-05-25 15:06:45 | ERROR | pid: 3710 | thread: 70177429783040 | -> ../lib/tasks/products.rake:41:in `block (2 levels) in <top (required)>' ]
-    [ 2015-05-25 15:06:45 | INFO | pid: 3710 | thread: 70177429783040 | </end_of>: This is rake task // development_product.log ]
+    [ 2015-05-25 15:06:45 | INFO | pid: 3710 | thread: 70177429783040 | </end_of>: This is rake task // product.log ]
 
 
 ## Exception resque:
@@ -146,7 +167,7 @@ PRODUCT_LOG.audit 'This is rake task', do_raise: false do
   ```
 
   If you set `do_raise` option into `false` state you will have same log as in previous example ( fully logged ),
-  but in terminal output you will see nothin. This option needed when you iterate something and don't want to stop full loop if one case fall with exception
+  but in terminal output you will see nothin. This option is needed when you iterate something and don't want to stop full loop if one case fail with exception
 
   Also you can use `LOGGER#audit_with_resque` method for such purpose instead of `LOGGER#audit`.
 
@@ -192,18 +213,18 @@ end
 
   relaunch rake task and you will see next log:
 
-    # log/audit/development_product.log
+    # log/audit/development/product.log
     [ 2015-05-25 15:17:00 | INFO | pid: 6013 | thread: 70285626049020 | <start_of>: Product creation ]
     [ 2015-05-25 15:17:00 | ERROR | pid: 6013 | thread: 70285626049020 | ERROR OCCURRED. See details in the Error Log. ]
     [ 2015-05-25 15:17:00 | INFO | pid: 6013 | thread: 70285626049020 | </end_of>: Product creation ]
 
-    # log/audit/development_error.log
-    [ 2015-05-25 15:17:00 | INFO | pid: 6013 | thread: 70285626049020 | <start_of>: Product creation // development_product.log ]
+    # log/audit/development/error.log
+    [ 2015-05-25 15:17:00 | INFO | pid: 6013 | thread: 70285626049020 | <start_of>: Product creation // product.log ]
     [ 2015-05-25 15:17:00 | ERROR | pid: 6013 | thread: 70285626049020 | ActiveRecord::StatementInvalid: PG::NotNullViolation: ERROR: null value in column "title" violates not-null constraint DETAIL: Failing row contains (1, null, 2015-05-25 12:17:00.852781, 2015-05-25 12:17:00.852781, null). : INSERT INTO "products" ("created_at", "updated_at") VALUES ($1, $2) RETURNING "id". Cause exception: ]
     [ 2015-05-25 15:17:00 | ERROR | pid: 6013 | thread: 70285626049020 | PG::NotNullViolation: ERROR: null value in column "title" violates not-null constraint DETAIL: Failing row contains (1, null, 2015-05-25 12:17:00.852781, 2015-05-25 12:17:00.852781, null).. Call stack: ]
     [ 2015-05-25 15:17:00 | ERROR | pid: 6013 | thread: 70285626049020 | -> ../lib/tasks/products.rake:77:in `block (3 levels) in <top (required)>' ]
     [ 2015-05-25 15:17:00 | ERROR | pid: 6013 | thread: 70285626049020 | -> ../lib/tasks/products.rake:75:in `block (2 levels) in <top (required)>' ]
-    [ 2015-05-25 15:17:00 | INFO | pid: 6013 | thread: 70285626049020 | </end_of>: Product creation // development_product.log ]
+    [ 2015-05-25 15:17:00 | INFO | pid: 6013 | thread: 70285626049020 | </end_of>: Product creation // product.log ]
 
   What about walidation errors?
   Lets add some validation on to `Product` model:
@@ -215,18 +236,18 @@ end
   ```
 
   And change `Product.create!` to `Product.create!(title: 'Small title')` and relaunch the rake task.
-  `log/audit/development_product.log` will be the same as previous, but `development_error.log` will have more detailed information about error exception:
+  `log/audit/development/product.log` will be the same as previous, but `error.log` will have more detailed information about error exception:
 
-    # log/audit/development_error.log
-    [ 2015-05-25 15:19:58 | INFO | pid: 6729 | thread: 70207020597760 | <start_of>: Product creation // development_product.log ]
+    # log/audit/development/error.log
+    [ 2015-05-25 15:19:58 | INFO | pid: 6729 | thread: 70207020597760 | <start_of>: Product creation // product.log ]
     [ 2015-05-25 15:19:58 | ERROR | pid: 6729 | thread: 70207020597760 | ActiveRecord::RecordInvalid: Validation failed: Title is too short (minimum is 50 characters). Call stack: ]
     [ 2015-05-25 15:19:58 | ERROR | pid: 6729 | thread: 70207020597760 | -> ../lib/tasks/products.rake:77:in `block (3 levels) in <top (required)>' ]
     [ 2015-05-25 15:19:58 | ERROR | pid: 6729 | thread: 70207020597760 | -> ../lib/tasks/products.rake:75:in `block (2 levels) in <top (required)>' ]
-    [ 2015-05-25 15:19:58 | INFO | pid: 6729 | thread: 70207020597760 | </end_of>: Product creation // development_product.log ]
+    [ 2015-05-25 15:19:58 | INFO | pid: 6729 | thread: 70207020597760 | </end_of>: Product creation // product.log ]
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/audit_logger/fork )
+1. Fork it ( https://github.com/DmytroVasin/audit_logger/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/audit_logger.rb

@@ -16,7 +16,7 @@ module AuditLogger
                 :al_shift_size,
                 :al_thread
 
-    def initialize(file_path=STDOUT, opts = {})
+    def initialize(file_name=STDOUT, opts = {})
       @al_timestamp  = opts[:timestamp] || true
       @al_pid        = opts[:pid] || false
       @al_severity   = opts[:severity] || false
@@ -25,7 +25,7 @@ module AuditLogger
       @al_shift_size = opts[:shift_size] || 2*1024*1024
 
 
-      log_file = init_log_file(file_path)
+      log_file = init_log_file(file_name)
 
       super(log_file, al_shift_age, al_shift_size)
     end
@@ -52,14 +52,14 @@ module AuditLogger
       end
     end
 
-    def init_log_file(path)
-      if path == File::NULL || path == STDOUT
+    def init_log_file(file_name)
+      if file_name == File::NULL || file_name == STDOUT
         @log_file_name = 'IO'
-        path
+        file_name
       else
-        File.open(path, 'a').tap {|file|
+        @log_file_name = "#{file_name}.log"
+        File.open("#{default_audit_path}/#{log_file_name}", 'a').tap {|file|
           file.sync = true
-          @log_file_name = File.basename(file.path)
         }
       end
     end
@@ -106,5 +106,13 @@ module AuditLogger
     def rails_root
       @rails_root ||= Rails.root.to_s
     end
+
+    def default_audit_path
+      "#{rails_root}/log/#{folder_name}/#{Rails.env}"
+    end
+
+    def folder_name
+      'audit'
+    end
   end
 end

data/lib/audit_logger/version.rb

@@ -1,4 +1,4 @@
 module AuditLogger
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
   RAILS_VERSION = "3.1.12"
 end

data/lib/generators/audit_logger/templates/audit.rb

@@ -1,9 +1,7 @@
 unless Rails.env.test?
-  log_path_with_env = "#{Rails.root}/log/audit/#{Rails.env}"
-
-  ::ERROR_LOG = AuditLogger::Audit.new("#{log_path_with_env}_error.log", timestamp: true, pid: true, severity: true, thread: true)
+  ::ERROR_LOG = AuditLogger::Audit.new('error', timestamp: true, pid: true, severity: true, thread: true)
 
   # ::AUDIT_NULL   = AuditLogger::Audit.new(File::NULL)
   # ::AUDIT_STDOUT = AuditLogger::Audit.new(STDOUT)
-  # ::PRODUCT_LOG  = AuditLogger::Audit.new("#{log_path_with_env}_product.log")
+  # ::PRODUCT_LOG  = AuditLogger::Audit.new('product')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audit_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vasin Dmitriy
@@ -81,6 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- audit_logger-1.0.0.gem
 - audit_logger.gemspec
 - bin/console
 - bin/setup