ixtlan-audit 0.1.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/features/generators.feature

@@ -0,0 +1,5 @@
+Feature: Generators for Ixtlan Audit
+
+  Scenario: The slf4r rails template creates a rails application which uses slf4r-wrapper
+    Given I create new rails application with template "simple.template"
+    Then the output should contain "setup slf4r logger wrapper with ActiveSupport::BufferedLogger"

data/features/step_definitions/simple_steps.rb

@@ -0,0 +1,22 @@
+require 'fileutils'
+Given /^I create new rails application with template "(.*)"$/ do |template|
+  name = template.sub(/.template$/, '')
+  directory = File.join('target', name)
+  rails_version = ENV['RAILS_VERSION'] || '3.0.1'
+
+  ruby = defined?(JRUBY_VERSION) ? "jruby" : "ruby"
+  rails_command = "#{ENV['GEM_HOME']}/bin/rails"
+  rails_command = "-S rails" unless File.exists?(rails_command)
+  command = "#{rails_command} _#{rails_version}_ new #{directory} -f -m templates/#{template}"
+  FileUtils.rm_rf(directory)
+
+  system "#{ruby} #{command}"
+  
+  @result = File.read("target/#{name}/log/development.log")
+  puts @result
+end
+
+Then /^the output should contain \"(.*)\"$/ do |expected|
+  (@result =~ /.*#{expected}.*/).should_not be_nil
+end
+

data/lib/generators/ixtlan/audit_base.rb

@@ -0,0 +1,31 @@
+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

@@ -0,0 +1,12 @@
+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

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

data/lib/ixtlan/audit/audit_rack.rb

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

data/lib/ixtlan/audit/manager.rb

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

@@ -0,0 +1,40 @@
+require 'ixtlan/audit/manager'
+require 'ixtlan/audit/audit_rack'
+require 'ixtlan/audit/user_logger'
+
+
+module Ixtlan
+  module Audit
+    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
+      end
+    end
+
+    class AuditFilter
+
+      def self.logger
+        @logger ||= UserLogger.new(Rails.application.config.audit_manager)
+      end
+
+      def self.filter(controller)
+        logger.log_action(controller)
+      end
+    end
+
+    
+    class AuditCleanupFilter
+
+      def self.filter(controller)
+        Rails.application.config.audit_manager.daily_cleanup
+      end
+    end
+  end
+end

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.class.name.to_s.pluralize}[#{audits.size}]#{as_xml}#{message}"
+            else
+              audit = controller.instance_variable_get("@#{controller.params[:controller].singularize.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.class.name}(#{audit.id})"
+                "#{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

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: ixtlan-audit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 1
+    - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+  - mkristian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +05:30
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 0
+              - 1
+            version: 3.0.1
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 1
+            version: 2.0.1
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: cucumber
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 9
+              - 4
+            version: 0.9.4
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 8
+              - 7
+            version: 0.8.7
+    type: :development
+    version_requirements: *id004
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README.textile
+  - features/step_definitions/simple_steps.rb
+  - features/generators.feature
+  - 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/manager.rb
+  - lib/ixtlan/audit/audit_rack.rb
+  - lib/ixtlan/audit/user_logger.rb
+has_rdoc: true
+homepage: http://github.com/mkristian/ixtlan-audit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.textile
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: audit the controller actions for the current user
+test_files: []
+