ixtlan-audit 0.3.2 → 0.3.3

data/lib/ixtlan/audit/manager.rb

@@ -89,10 +89,11 @@ module Ixtlan
         list.each do |audit|
           begin
             audit.save
+            warn audit.errors.inspect unless audit.valid?
           rescue => e
             warn "unexpected error - skip entry"
             warn e.message
-            warn audit
+            warn audit.inspect
           end
         end
         list.clear

data/lib/ixtlan/audit/manager.rb~

@@ -1,12 +1,37 @@
-require 'slf4r/logger'
-
+#
+# Copyright (C) 2012 Christian Meier
+#
+# 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.
+#
 module Ixtlan
   module Audit
     class Manager
 
       private
 
-      include ::Slf4r::Logger
+      if defined? ::Slf4r
+        include ::Slf4r::Logger
+      else
+        require 'logger'
+        def logger
+          @logger ||= Logger.new( STDOUT )
+        end
+      end
 
       def list
         Thread.current[:audit] ||= []
@@ -14,56 +39,90 @@ module Ixtlan
 
       public
 
-      def initialize
-        @model = ::Audit if defined? ::Audit
-        @username_method = :login
-        @keep_log = 90
+      attr_accessor :model, :block, :keep_logs
+
+      def initialize( model = nil, &block )
+        @model = model
+        @keep_logs = 90
+        block.call( self ) if block
+        @block = block
       end
 
-      def username_method=(method)
-        @username_method = method.to_sym if method
+      def model
+        @model ||= (Ixtlan::Audit::Audit rescue nil)
       end
-      
-      def model=(model)
-        @model = model if model
+
+      def keep_logs=( keep )
+        old = @keep_logs
+        @keep_logs = keep
+        daily_cleanup if old != @keep_logs
       end
 
-      def keep_log=(days)
-        @keep_log = days.to_i
+      def keep_logs
+        if block
+          block.call( self )
+        end
+        @keep_logs
       end
       
-      def push(message, username)
-        list << @model.new(:date => DateTime.now, :message => message, :login => username) if @model
+      def push( username, path, obj )
+        if model
+          message = 
+            if !obj.is_a?( String ) && obj.respond_to?( :collect )
+              if o = obj.first
+                "#{o.class}[ #{obj.size} ]"
+              else
+                "[ 0 ] - <EMPTY ARRAY>"
+              end
+            else
+              obj.to_s
+            end
+          list << model.new( :path => path, 
+                             :message => message, 
+                             :login => username || '???' )
+        end
+        list.last
       end
 
       def save_all
+        daily_cleanup
         list.each do |audit|
-          audit.save
+          begin
+            audit.save
+          rescue => e
+            warn "unexpected error - skip entry"
+            warn e.message
+            warn audit
+          end
         end
-        Thread.current[:audit] = nil
-      end
-
-      def username_method
-        @username_method
+        list.clear
       end
 
       def daily_cleanup
-        if @model
-          if(!@last_cleanup.nil? && @last_cleanup < 1.days.ago)
-            @last_cleanup = Date.today
-            begin
-              if defined? ::DataMapper
-                @model.all(:date.lt => @keep_log.days.ago).destroy!
-              else # ActiveRecord
-                @model.all(:conditions => ["date < ?", @keep_log.days.ago]).each(&:delete)
-              end
-              @logger.info("cleaned audit logs")
-            rescue Error
-              # TODO log this !!
-            end
+        return unless model
+        now = DateTime.now
+        if(@last_cleanup.nil? || @last_cleanup < (now - 1))
+          @last_cleanup = now
+          begin
+            delete_all( now - keep_logs )
+            logger.info "cleaned audit logs"
+          rescue Exception => e
+            logger.warn "error cleaning up audit logs: #{e.message}" 
           end
         end
       end
+  
+      private
+
+      if defined? ::DataMapper
+        def delete_all( expired )
+          model.all( :created_at.lte => expired ).destroy!
+        end
+      else # ActiveRecord
+        def delete_all( expired )
+          model.all( :conditions => ["created_at <= ?", expired] ).each(&:delete)
+        end
+      end
     end
   end
 end

data/lib/ixtlan/audit/user_logger.rb

@@ -18,14 +18,19 @@
 # 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.
 #
-require 'slf4r/logger'
-
 module Ixtlan
   module Audit
     class UserLogger
 
-      include ::Slf4r::Logger
-      
+      if defined? ::Slf4r
+        include ::Slf4r::Logger
+      else
+        require 'logger'
+        def logger
+          @logger ||= Logger.new( STDOUT )
+        end
+      end
+
       def initialize(audit_manager)
         @manager = audit_manager
       end
@@ -80,9 +85,9 @@ module Ixtlan
       def log_user(user, message = nil, &block)
         user ||= "???"
         msg = "#{message}#{block.call if block}"
-        @manager.push( user, msg.sub(/\ .*$/, ''), msg )
+        @manager.push( user, msg.sub(/\ .*$/, ''), msg.sub(/^[^\ ]*\ /, '') )
         logger.debug {"[#{user}] #{msg}" }
       end
     end
   end
-end
+end

data/lib/ixtlan/audit/user_logger.rb~

@@ -1,3 +1,23 @@
+#
+# Copyright (C) 2012 Christian Meier
+#
+# 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.
+#
 require 'slf4r/logger'
 
 module Ixtlan
@@ -14,7 +34,7 @@ module Ixtlan
       
       def login_from(controller)
         user = controller.respond_to?(:current_user) ? controller.send(:current_user) : nil
-        user.nil? ? nil: user.send(@manager.username_method)
+        user.nil? ? nil: (user.respond_to?(:login) ? user.login : user.username)
       end
       
       public
@@ -25,21 +45,30 @@ module Ixtlan
       
       def log_action(controller, message = nil)
         log_user(login_from(controller)) do
-          as_xml = controller.response.content_type == 'application/xml' ? " - xml" : ""
           if controller.params[:controller]
-            audits = controller.instance_variable_get("@#{controller.params[:controller].to_sym}")
-            if(audits)
-              "#{controller.params[:controller]}##{controller.params[:action]} #{audits.model.to_s.plural}[#{audits.size}]#{as_xml}#{message}"
+            clname = controller.params[:controller]
+            cname = clname.sub(/^.*\//, '')
+            audits = controller.instance_variable_get("@#{cname}")
+            if(audits && audits.respond_to?(:collect))
+              "#{clname}##{controller.params[:action]} #{cname.classify}[#{audits.size}]#{message}"
             else
-              audit = controller.instance_variable_get("@#{controller.params[:controller].singular.to_sym}")
+              audit = audits || controller.instance_variable_get("@#{cname.singularize}")
               if(audit)
                 errors = if(audit.respond_to?(:errors) && !audit.errors.empty?)
                            " - errors: " + audit.errors.full_messages.join(", ")
                          end
-                audit_log = audit.respond_to?(:to_log) ? audit.to_log : "#{audit.model}(#{audit.key})"
-                "#{controller.params[:controller]}##{controller.params[:action]} #{audit_log}#{as_xml}#{message}#{errors}"
+                audit_log = if audit.respond_to?(:to_log)
+                              audit.to_log
+                            elsif audit.is_a? String
+                              audit
+                            elsif audit.respond_to?(:model)
+                              "#{audit.model}(#{audit.id})"
+                            else
+                              "#{audit.class.name}(#{audit.id})"
+                            end
+                "#{clname}##{controller.params[:action]} #{audit_log}#{message}#{errors}"
               else
-                "#{controller.params[:controller]}##{controller.params[:action]}#{as_xml}#{message}"
+                "#{clname}##{controller.params[:action]}#{message}"
               end
             end
           else
@@ -51,9 +80,9 @@ module Ixtlan
       def log_user(user, message = nil, &block)
         user ||= "???"
         msg = "#{message}#{block.call if block}"
-        @manager.push( msg, user)
-        @logger.debug {"[#{user}] #{msg}" }
+        @manager.push( user, msg.sub(/\ .*$/, ''), msg )
+        logger.debug {"[#{user}] #{msg}" }
       end
     end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ixtlan-audit
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Christian Meier
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-30 00:00:00 Z
+date: 2013-01-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: slf4r