ixtlan-audit 0.1.1 → 0.2.0

data/README.textile

@@ -0,0 +1,4 @@
+h1. Rails Audit Log
+
+p. once you have a logged in user in your system, the usual request log can be improved by added the login name of the user to log output. but since you associate data with a "real" person privacy comes into play. the best privacy protection is not to store data, but in our case the compromise is to just define how long the data shall be stored (define an expiration date for the data).
+

data/lib/ixtlan/audit/audit_rack.rb

@@ -2,16 +2,14 @@ module Ixtlan
   module Audit
     class AuditRack
 
-      def initialize(app)
+      def initialize(app, audit_manager)
         @app = app
-        self.class_eval do
-          include Rails.application.routes.url_helpers
-        end
+        @audit_manager = audit_manager
       end
       
       def call(env)
         result = @app.call(env)
-        ::Rails.application.config.audit_manager.save_all
+        @audit_manager.save_all
         result
       end
       

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

@@ -0,0 +1,36 @@
+module Ixtlan
+  module Audit
+    class LoggingConfigurator
+
+      @logger = Logging::Logger[self]
+    
+      def initialize(filename, options = {}, categories = [])
+        @categories = categories
+        @options = options
+        @options[:filename] = 
+          if filename.is_a? File
+            filename
+          else
+            File.join(Rails.root, "log", filename.to_s)
+          end.expand_path
+        @options[:age] = 'daily'
+        @options[:layout] = Logging.layouts.pattern(:pattern => '%d %m\n') unless @options[:layout]
+      end
+        
+      def call(manager)
+        @options[:keep] = manager.keep_log
+        appender = Logging.appenders.rolling_file("audit", @options)
+        @categories.each do |category|
+          logger = Logging::Logger[category]
+          logger.remove_appenders('audit')
+          logger.add_appenders(audit_appender)
+          @logger.debug("setup logger for #{category}")
+        end
+        Dir["@options[:filename].*.log"][manager.keep_log, 100000].sort.each do |f|
+          FileUtils.rm_f(f)
+        end
+        @logger.info("initialized audit log . . .")
+      end
+    end
+  end
+end

data/lib/ixtlan/audit/manager.rb

@@ -20,9 +20,9 @@ module Ixtlan
 
       def initialize
         @username_method = :login
-        @keep_log = 90
+        @keep_logs = 90
       end
-
+      
       def username_method=(method)
         @username_method = method.to_sym if method
       end
@@ -31,8 +31,10 @@ module Ixtlan
         @model = m if m
       end
 
-      def keep_log=(days)
-        @keep_log = days.to_i
+      def keep_logs=(days)
+        old = @keep_logs
+        @keep_logs = days.to_i
+        daily_cleanup if old != @keep_logs
       end
       
       def push(message, username)
@@ -41,6 +43,7 @@ module Ixtlan
       end
 
       def save_all
+        daily_cleanup
         list.each do |audit|
           begin
             audit.save
@@ -58,22 +61,30 @@ module Ixtlan
       end
 
       def daily_cleanup
-        if @model
-          if(!@last_cleanup.nil? && @last_cleanup < 1.days.ago)
-            @last_cleanup = Date.today
+        if model
+          if(@last_cleanup.nil? || @last_cleanup < 1.days.ago)
+            @last_cleanup = 0.days.ago # to have the right type
             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 !!
+              delete_all
+              logger.info("cleaned audit logs")
+            rescue Exception => e
+              logger.error("cleanup audit logs", e)
             end
           end
         end
       end
+
+      private
+
+      if defined? ::DataMapper
+        def delete_all
+          model.all(:created_at.lte => @keep_logs.days.ago).destroy!
+        end
+      else # ActiveRecord
+        def delete_all
+          model.all(:conditions => ["created_at <= ?", @keep_logs.days.ago]).each(&:delete)
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,69 @@
+require 'slf4r/logger'
+
+module Ixtlan
+  module Audit
+    class Manager
+
+      private
+
+      include ::Slf4r::Logger
+
+      def list
+        Thread.current[:audit] ||= []
+      end
+
+      public
+
+      def initialize
+        @model = ::Audit if defined? ::Audit
+        @username_method = :login
+        @keep_log = 90
+      end
+
+      def username_method=(method)
+        @username_method = method.to_sym if method
+      end
+      
+      def model=(model)
+        @model = model if model
+      end
+
+      def keep_log=(days)
+        @keep_log = days.to_i
+      end
+      
+      def push(message, username)
+        list << @model.new(:date => DateTime.now, :message => message, :login => username) if @model
+      end
+
+      def save_all
+        list.each do |audit|
+          audit.save
+        end
+        Thread.current[:audit] = nil
+      end
+
+      def username_method
+        @username_method
+      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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ixtlan/audit/railtie.rb

@@ -8,32 +8,18 @@ module Ixtlan
     class Railtie < ::Rails::Railtie
 
       config.before_configuration do |app|
-        app.config.class.class_eval do
-          attr_accessor :audit_manager
-        end
         app.config.audit_manager = Manager.new
-        ::ActionController::Base.append_after_filter(Ixtlan::Audit::AuditFilter)
-        ::ActionController::Base.append_before_filter(Ixtlan::Audit::AuditCleanupFilter)
-        app.config.middleware.use Ixtlan::Audit::AuditRack
+        ::ActionController::Base.send(:include, Module)
+        ::ActionController::Base.send(:after_filter, :audit)
+        app.config.middleware.use(AuditRack, app.config.audit_manager)
       end
     end
-
-    class AuditFilter
-
-      def self.logger
-        @logger ||= UserLogger.new(Rails.configuration.audit_manager)
-      end
-
-      def self.filter(controller)
-        logger.log_action(controller)
-      end
-    end
-
     
-    class AuditCleanupFilter
+    module Module
 
-      def self.filter(controller)
-        Rails.application.config.audit_manager.daily_cleanup
+      def audit
+        @audit_logger ||= UserLogger.new(Rails.application.config.audit_manager)
+        @audit_logger.log_action(self)
       end
     end
   end

data/lib/ixtlan/audit/user_logger.rb

@@ -27,11 +27,11 @@ module Ixtlan
         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}")
+            audits = controller.instance_variable_get("@#{controller.params[:controller]}")
             if(audits)
-              "#{controller.params[:controller]}##{controller.params[:action]} #{audits.class.name.to_s.pluralize}[#{audits.size}]#{as_xml}#{message}"
+              "#{controller.params[:controller]}##{controller.params[:action]} #{controller.params[:controller].classify}[#{audits.size}]#{as_xml}#{message}"
             else
-              audit = controller.instance_variable_get("@#{controller.params[:controller].singularize.to_sym}")
+              audit = controller.instance_variable_get("@#{controller.params[:controller].singularize}")
               if(audit)
                 errors = if(audit.respond_to?(:errors) && !audit.errors.empty?)
                            " - errors: " + audit.errors.full_messages.join(", ")

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

@@ -0,0 +1,59 @@
+require 'slf4r/logger'
+
+module Ixtlan
+  module Audit
+    class UserLogger
+
+      include ::Slf4r::Logger
+      
+      def initialize(audit_manager)
+        @manager = audit_manager
+      end
+
+      private
+      
+      def login_from(controller)
+        user = controller.respond_to?(:current_user) ? controller.send(:current_user) : nil
+        user.nil? ? nil: user.send(@manager.username_method)
+      end
+      
+      public
+      
+      def log(controller, message = nil, &block)
+        log_user(login_from(controller), message, &block)
+      end
+      
+      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}"
+            else
+              audit = controller.instance_variable_get("@#{controller.params[:controller].singular.to_sym}")
+              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}"
+              else
+                "#{controller.params[:controller]}##{controller.params[:action]}#{as_xml}#{message}"
+              end
+            end
+          else
+            "params=#{controller.params.inspect}#{message}"
+          end
+        end
+      end
+        
+      def log_user(user, message = nil, &block)
+        user ||= "???"
+        msg = "#{message}#{block.call if block}"
+        @manager.push( msg, user)
+        @logger.debug {"[#{user}] #{msg}" }
+      end
+    end
+  end
+end

data/lib/ixtlan-audit.rb~

@@ -0,0 +1,3 @@
+if defined?(Rails)
+  require 'ixtlan/audit/railtie'
+end

data/spec/audit_manager_spec.rb

@@ -0,0 +1,55 @@
+require 'dm-core'
+require 'dm-migrations'
+require 'slf4r/ruby_logger'
+require 'ixtlan/audit/manager'
+
+class Audit
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :login, String
+  property :message, String
+
+  property :created_at, DateTime
+
+  before :save do
+    self.created_at = DateTime.now
+  end
+end
+
+class Fixnum
+  def days
+    self
+  end
+  def ago
+    DateTime.now - 86000 * self
+  end
+end
+DataMapper.setup(:default, "sqlite3::memory:")
+DataMapper.finalize
+DataMapper.repository.auto_migrate!
+
+describe Ixtlan::Audit::Manager do
+
+  it 'should collect log events and the save them all in one go' do
+    size = Audit.all.size
+    subject.push("msg1", "login1")
+    subject.push("msg2", "login2")
+    subject.push("msg3", "login3")
+    subject.save_all
+
+    Audit.all.size.should == size + 3
+  end
+
+  it "should clean up audit logs" do
+    Audit.create(:message => "msg", :login => "login")
+    Audit.all.size.should > 0
+    subject.keep_logs = 0
+    Audit.all.size.should == 0
+    subject.push("msg", "login")
+    subject.push("msg", "login")
+    subject.save_all
+    Audit.all.size.should == 2
+  end
+end

data/spec/audit_manager_spec.rb~

@@ -0,0 +1,18 @@
+require 'dm-core'
+require 'dm-migrations'
+require 'slf4r/ruby_logger'
+
+class Audit
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :login, String
+  property :message, String
+
+  property :created_at, DateTime
+
+  before :save do
+    self.created_at = DateTime.now
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ixtlan-audit
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-    - 0
-    - 1
-    - 1
-  version: 0.1.1
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
   - mkristian
@@ -14,65 +10,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-30 00:00:00 +05:30
+date: 2011-11-04 00:00:00 +05:30
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
-    name: rails
+    name: slf4r
     prerelease: false
     requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
-        - - "="
+        - - ~>
           - !ruby/object:Gem::Version 
-            segments: 
-              - 3
-              - 0
-              - 1
-            version: 3.0.1
-    type: :development
+            version: 0.4.2
+    type: :runtime
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
     name: rspec
     prerelease: false
     requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 2
-              - 0
-              - 1
-            version: 2.0.1
+            version: 2.6.0
     type: :development
     version_requirements: *id002
   - !ruby/object:Gem::Dependency 
-    name: cucumber
+    name: rake
     prerelease: false
     requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 9
-              - 4
-            version: 0.9.4
+            version: 0.8.7
     type: :development
     version_requirements: *id003
   - !ruby/object:Gem::Dependency 
-    name: rake
+    name: dm-core
     prerelease: false
     requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 8
-              - 7
-            version: 0.8.7
+            version: 1.2.0
     type: :development
     version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: dm-migrations
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 1.2.0
+    type: :development
+    version_requirements: *id005
+  - !ruby/object:Gem::Dependency 
+    name: dm-sqlite-adapter
+    prerelease: false
+    requirement: &id006 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 1.2.0
+    type: :development
+    version_requirements: *id006
 description: audit the controller actions for the current user. log that data into the database and allow to expire this log files (privacy protection) and be able to browse it from the UI
 email: 
   - m.kristian@web.de
@@ -84,14 +90,18 @@ extra_rdoc_files: []
 
 files: 
   - MIT-LICENSE
+  - README.textile
+  - lib/ixtlan-audit.rb~
   - lib/ixtlan-audit.rb
-  - lib/generators/ixtlan/audit_base.rb
-  - lib/generators/ixtlan/audit_scaffold/audit_scaffold_generator.rb
-  - lib/generators/ixtlan/audit_model/audit_model_generator.rb
-  - lib/ixtlan/audit/railtie.rb
+  - lib/ixtlan/audit/logging_configurator.rb~
+  - lib/ixtlan/audit/user_logger.rb
   - lib/ixtlan/audit/manager.rb
   - lib/ixtlan/audit/audit_rack.rb
-  - lib/ixtlan/audit/user_logger.rb
+  - lib/ixtlan/audit/manager.rb~
+  - lib/ixtlan/audit/railtie.rb
+  - lib/ixtlan/audit/user_logger.rb~
+  - spec/audit_manager_spec.rb
+  - spec/audit_manager_spec.rb~
 has_rdoc: true
 homepage: http://github.com/mkristian/ixtlan-audit
 licenses: 
@@ -103,25 +113,23 @@ rdoc_options:
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: audit the controller actions for the current user
-test_files: []
-
+test_files: 
+  - spec/audit_manager_spec.rb

data/lib/generators/ixtlan/audit_base.rb

@@ -1,31 +0,0 @@
-require 'rails/generators/base'
-module Ixtlan
-  module Generators
-    class AuditBase < Rails::Generators::Base
-
-      argument :name, :type => :string, :required => false
-      
-      protected
-      def generator_name
-        raise "please overwrite generator_name"
-      end
-      
-      public
-      def create
-        args = []
-        if name
-          args << ARGV.shift
-        else
-          args << "audit"
-        end
-        
-        args << "created_at:datetime"
-        args << "login:string"
-        args << "message:string"
-        args += ARGV[0, 10000] || []
-        
-        generate generator_name, *args
-      end
-    end
-  end
-end

data/lib/generators/ixtlan/audit_model/audit_model_generator.rb

@@ -1,12 +0,0 @@
-require 'generators/ixtlan/audit_base'
-module Ixtlan
-  module Generators
-    class AuditModelGenerator < AuditBase
-      
-      protected
-      def generator_name
-        "model"
-      end
-    end
-  end
-end

data/lib/generators/ixtlan/audit_scaffold/audit_scaffold_generator.rb

@@ -1,12 +0,0 @@
-require 'generators/ixtlan/audit_base'
-module Ixtlan
-  module Generators
-    class AuditScaffoldGenerator < AuditBase
-      
-      protected
-      def generator_name
-        "scaffold"
-      end
-    end
-  end
-end