alfuken-simple_audit 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.

data/Manifest

@@ -0,0 +1,23 @@
+MIT-LICENSE
+README
+Rakefile
+app/controllers/audits_controller.rb
+app/helpers/layout_helper.rb
+app/models/audit.rb
+app/views/audits/_form.html.erb
+app/views/audits/edit.html.erb
+app/views/audits/index.html.erb
+app/views/audits/new.html.erb
+app/views/audits/show.html.erb
+generators/simple_audit/USAGE
+generators/simple_audit/simple_audit_generator.rb
+generators/simple_audit/templates/migration.rb
+init.rb
+install.rb
+lib/db/migrate/20090908101900_create_audits.rb
+lib/simple_audit.rb
+tasks/simple_audit_tasks.rake
+test/simple_audit_test.rb
+test/test_helper.rb
+uninstall.rb
+Manifest

data/README

@@ -0,0 +1,16 @@
+SimpleAudit
+===========
+
+Simple auditing plugin, just testing some stuff.
+Not for production use! 
+
+
+Example
+=======
+
+./script/generate simple_audit install
+rake db:migrate
+url localhost:3000/audits
+
+
+Copyright (c) 2009 Alfuken, released under the MIT license

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('simple_audit', '0.0.1') do |p|
+  p.description    = "Simple auditing plugin."
+  p.url            = "http://github.com/alfuken/"
+  p.author         = "Alfuken"
+  p.email          = "alfuken@gmail.com"
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+# ---------------------------------------------
+# require 'rubygems'
+# require 'rake'
+# 
+# PKG_FILES = FileList[
+#   '[a-zA-Z]*',
+#   'app/**/*',
+#   'app/**/**/*',
+#   'generators/**/*',
+#   'generators/**/**/*',
+#   'lib/*',
+#   'lib/**/*',
+#   'lib/**/**/*',
+#   # 'rails/**/*',
+#   'tasks/**/*',
+#   # 'test/**/*'
+# ]
+# 
+# spec = Gem::Specification.new do |s|
+#   s.name = "alfuken-simple_audit"
+#   s.version = "0.0.1"
+#   s.author = "Alfuken"
+#   s.email = "alfuken@gmail.com"
+#   s.homepage = "http://github.com/alfuken/"
+#   s.platform = Gem::Platform::RUBY
+#   s.summary = "Simple auditing plugin."
+#   s.files = PKG_FILES.to_a
+#   s.require_path = "lib"
+#   s.has_rdoc = false
+#   s.extra_rdoc_files = ["README"]
+# end
+# 
+# desc 'Turn this plugin into a gem.'
+# Rake::GemPackageTask.new(spec) do |pkg|
+#   pkg.gem_spec = spec
+# end

data/app/controllers/audits_controller.rb

@@ -0,0 +1,99 @@
+class AuditsController < ApplicationController
+  unloadable
+  def index    
+    # проверяем, сущевствует ли заданная column, по которой юзер хочет делать сортировку
+    @columns = ActiveRecord::Base.connection.columns('audits').map {|c| c.name}
+    @order_by = @columns.include?(params[:order_by]) ? params[:order_by] : "created_at"
+    
+    # выбираем сортировку, опять же чтобы не подсунули "order_by foobar fesc" вместо "desc"
+    @sort_order = ['asc', 'desc'].include?(params[:sort_order]) ? params[:sort_order] : 'desc'
+
+    # Привычка объявлять переменные в некоторых случаях
+    conditions = {}
+    filter_texts = []
+    
+    # Запрос фильтрации по ресурсу
+    if params[:resource]
+      filter_texts << "resource &ldquo;#{params[:resource]}&rdquo;"
+      conditions.merge!({:resource => params[:resource] })
+    end
+
+    # Запрос фильтрации по пользователю
+    if params[:user_id]
+      filter_texts << "user &ldquo;#{User.find(params[:user_id]).login}&rdquo;"
+      conditions.merge!({:user_id => params[:user_id] })
+    end
+    
+    # Сообщаем, что включен фильтр
+    @mssg = "Filtered by #{filter_texts.to_sentence}" unless filter_texts.empty?
+    
+    # hady thingie: выводим список ресурсов, которые мы можем пофильтровать
+    @resources_to_filter_on = Audit.all(:group => 'resource').map {|r| r.resource}
+    
+    # просто фикс для более приятной сортировки (по запрошеному полю + по времени)
+    fix = params[:order_by] == "created_at" ? "" : ", created_at desc"
+    @audits = Audit.find(:all, :conditions => conditions, :order => "#{@order_by} #{@sort_order}#{fix}", :include => :user).paginate :page => params[:page], :per_page => 10
+    
+    # тут и далее объяснения излишни
+    respond_to do |format|
+      format.html
+      format.xml { render :xml => @audits }
+      format.js { render :json => @audits }
+    end
+    
+  end
+  
+  def show
+    @audit = Audit.find(params[:id])
+    respond_to do |format|
+      format.html
+      format.xml { render :xml => @audit }
+      format.js { render :json => @audit }
+    end
+  end
+  
+  #   @resource_actions = Audit.find_all_by_resource(params[:show_only], :group_by => 'resource').map {|r| r.action}
+  #   conds = ["'#{params[:filter_by]}' = ? AND 'action' IN (?)", params[:show_only], @resource_actions ]
+  
+  # def new
+  #   @audit = Audit.new
+  # end
+  
+  # def create
+  #   @audit = Audit.new(params[:audit])
+  #   if @audit.save
+  #     flash[:notice] = "Successfully created audit."
+  #     redirect_to @audit
+  #   else
+  #     render :action => 'new'
+  #   end
+  # end
+  
+  # def edit
+  #   @audit = Audit.find(params[:id])
+  # end
+  
+  # def update
+  #   @audit = Audit.find(params[:id])
+  #   if @audit.update_attributes(params[:audit])
+  #     flash[:notice] = "Successfully updated audit."
+  #     redirect_to @audit
+  #   else
+  #     render :action => 'edit'
+  #   end
+  # end
+  
+  def destroy
+    @audit = Audit.find(params[:id])
+    @audit.destroy
+    respond_to do |format|
+      format.html {
+        flash[:notice] = "Successfully destroyed audit."
+        redirect_to audits_url
+      }
+      format.xml { head :ok }
+      format.js  { head :ok }
+    end
+  end
+  
+end

data/app/helpers/layout_helper.rb

@@ -0,0 +1,22 @@
+# These helper methods can be called in your template to set variables to be used in the layout
+# This module should be included in all views globally,
+# to do so you may need to add this line to your ApplicationController
+#   helper :layout
+module LayoutHelper
+  def title(page_title, show_title = true)
+    @content_for_title = page_title.to_s
+    @show_title = show_title
+  end
+  
+  def show_title?
+    @show_title
+  end
+  
+  def stylesheet(*args)
+    content_for(:head) { stylesheet_link_tag(*args) }
+  end
+  
+  def javascript(*args)
+    content_for(:head) { javascript_include_tag(*args) }
+  end
+end

data/app/models/audit.rb

@@ -0,0 +1,3 @@
+class Audit < ActiveRecord::Base
+  belongs_to :user
+end

data/app/views/audits/_form.html.erb

@@ -0,0 +1,20 @@
+<% form_for @audit do |f| %>
+  <%= f.error_messages %>
+  <p>
+    <%= f.label :user_id %><br />
+    <%= f.text_field :user_id %>
+  </p>
+  <p>
+    <%= f.label :resource %><br />
+    <%= f.text_field :resource %>
+  </p>
+  <p>
+    <%= f.label :action %><br />
+    <%= f.text_field :action %>
+  </p>
+  <p>
+    <%= f.label :extra %><br />
+    <%= f.text_area :extra %>
+  </p>
+  <p><%= f.submit "Submit" %></p>
+<% end %>

data/app/views/audits/edit.html.erb

@@ -0,0 +1,8 @@
+<% @show_title = true; @content_for_title = "Edit Audit" %>
+
+<%= render :partial => 'form' %>
+
+<p>
+  <%= link_to "Show", @audit %> |
+  <%= link_to "View All", audits_path %>
+</p>

data/app/views/audits/index.html.erb

@@ -0,0 +1,44 @@
+<% @show_title = true; @content_for_title = "Audits" %>
+
+Resources to filter on: <br />
+<% for res in @resources_to_filter_on %>
+  <%= link_to res, audits_path(:user_id => params[:user_id], :resource => res) %>
+<% end %>
+<br />
+<br />
+<% if @mssg %>
+<%= @mssg %> <span style="font-size:smaller">(<%= link_to "remove filter", audits_path %>)</span><br /><br />
+<% end %>
+
+<% sort_icon = params[:sort_order] == "desc" ? " &darr;" : " &uarr;" %>
+<table id="audits">
+  <tr>
+    <th><%= link_to "Created#{sort_icon if params[:order_by] == "created_at"}", audits_path(:user_id => params[:user_id], :resource => params[:resource], :order_by => "created_at", :sort_order => ((params[:sort_order] == "asc" && params[:order_by] == "created_at") ? "desc" : "asc") ) %></th>
+    <th><%= link_to "User#{sort_icon if params[:order_by] == "user_id"}", audits_path(:user_id => params[:user_id], :resource => params[:resource], :order_by => "user_id", :sort_order => ((params[:sort_order] == "asc" && params[:order_by] == "user_id") ? "desc" : "asc") ) %></th>
+    <th><%= link_to "Resource#{sort_icon if params[:order_by] == "resource"}", audits_path(:user_id => params[:user_id], :resource => params[:resource], :order_by => "resource", :sort_order => ((params[:sort_order] == "asc" && params[:order_by] == "resource") ? "desc" : "asc") ) %></th>
+    <th>Action</th>
+    <th>Extra</th>
+    <th>&nbsp;</th>
+  </tr>
+  <% for audit in @audits %>
+    <tr id="<%= audit.id %>">
+      <td><%= audit.created_at.strftime("%m/%d/%Y %H:%M:%S") %></td>
+      <td><%= link_to audit.user.login, audits_path(:user_id => audit.user_id, :resource => params[:resource]) %></td>
+      <td><%= link_to audit.resource, audits_path(:user_id => params[:user_id], :resource => audit.resource) %></td>
+      <td><%= audit.action %></td>
+      <td><%= audit.extra %></td>
+      <td class="actions"><span><%= link_to "[destroy]", audit, :confirm => 'Are you sure?', :method => :delete, :style=>"font-size:smaller" %> <%= link_to "[show]", audit, :style=>"font-size:smaller" %></span></td>
+    </tr>
+  <% end %>
+</table>
+<br />
+<%= will_paginate @audits %><br />
+<span style='font-size:smaller'><%= page_entries_info @audits, :entry_name => 'item' %></span>
+
+<script type="text/javascript" charset="utf-8">
+$("#audits tr").mouseover(function(){
+  $("#"+this.id+" td.actions span").css('visibility','visible');
+}).mouseout(function(){
+  $("#"+this.id+" td.actions span").css('visibility','hidden');
+});
+</script>

data/app/views/audits/new.html.erb

@@ -0,0 +1,5 @@
+<% @show_title = true; @content_for_title = "New Audit" %>
+
+<%= render :partial => 'form' %>
+
+<p><%= link_to "Back to List", audits_path %></p>

data/app/views/audits/show.html.erb

@@ -0,0 +1,27 @@
+<% @show_title = true; @content_for_title = "Audit" %>
+
+<p>
+  <strong>User:</strong>
+  <%= User.find(@audit.user_id).login %>
+</p>
+<p>
+  <strong>Resource:</strong>
+  <%= @audit.resource %>
+</p>
+<p>
+  <strong>Action:</strong>
+  <%= @audit.action %>
+</p>
+<p>
+  <strong>Extra:</strong>
+  <%= @audit.extra %>
+</p>
+
+<p>
+  <% if request.env["HTTP_REFERER"] %>
+    <%= link_to "<< Back", request.env["HTTP_REFERER"] %> |
+  <% end %>
+  <%= link_to "Destroy", @audit, :confirm => 'Are you sure?', :method => :delete %> |
+  <%= link_to "View All", audits_path %>
+</p>
+

data/generators/simple_audit/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explaining the generator.
+
+Example:
+    ./script/generate simple_audit install
+
+    This will create:
+        Files, routes and migrations required by SimpleAudit plugin to work.

data/generators/simple_audit/simple_audit_generator.rb

@@ -0,0 +1,25 @@
+class SimpleAuditGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+
+      m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+        :migration_name => "CreateAudits"
+      }, :migration_file_name => "create_audits"
+
+      sentinel = 'ActionController::Routing::Routes.draw do |map|'
+      logger.route "map.resources :audits"
+
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resources :audits\n  map.resources :users, :has_many => 'audits'\n"
+      end
+
+    end
+  end
+
+  def gsub_file(relative_destination, regexp, *args, &block)
+    path = destination_path(relative_destination)
+    content = File.read(path).gsub(regexp, *args, &block)
+    File.open(path, 'wb') { |file| file.write(content) }
+  end
+
+end

data/generators/simple_audit/templates/migration.rb

@@ -0,0 +1,16 @@
+class CreateAudits < ActiveRecord::Migration
+  def self.up
+    create_table "audits", :force => true do |t|
+      t.integer  "user_id", :default => 0
+      t.string   "resource"
+      t.string   "action"
+      t.text     "extra"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+  end
+
+  def self.down
+    drop_table "audits"
+  end
+end

data/init.rb

@@ -0,0 +1,8 @@
+require 'simple_audit'
+
+class ActionController::Base   
+  include SimpleAudit
+  extend SimpleAudit   
+end
+
+ActionController::Base.send(:include, SimpleAudit::ControllerMethods::Application)

data/install.rb

@@ -0,0 +1,4 @@
+# Install hook code here
+Dir.glob(File.join(File.dirname(__FILE__), "db", "migrate", "*")).each do |file|
+  require file
+end

data/lib/db/migrate/20090908101900_create_audits.rb

@@ -0,0 +1,16 @@
+class CreateAudits < ActiveRecord::Migration
+  def self.up
+    create_table "audits", :force => true do |t|
+      t.integer  "user_id", :default => 0
+      t.string   "resource"
+      t.string   "action"
+      t.text     "extra"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+  end
+
+  def self.down
+    drop_table "audits"
+  end
+end

data/lib/simple_audit.rb

@@ -0,0 +1,67 @@
+module SimpleAudit
+  
+  # Сделать запись в аудит-лог из контроллера
+  # записи автоматически присваевается user_id и прочие параметры
+  # для дополнительной информации есть поле 'extra'
+  def audit(extra='')
+    return false unless current_user
+    Audit.create(:user_id => current_user.id, :resource => params[:controller], :action => params[:action], :extra => extra)
+    # logger.warn "Eeeei, it works!"
+  end
+
+    module ControllerMethods
+      module Application
+        def self.included(controller)
+          controller.extend ClassMethods
+          controller.class_inheritable_accessor :auditables
+          controller.auditables = []
+          controller.before_filter :audit_actions
+        end
+
+      private
+
+        # подсмотрено у simple_authorization, кажется
+        def audit_actions
+          return if !current_user
+
+          self.class.auditables.each do |actions|
+            options = actions.last.is_a?(Hash) ? actions.last : {}
+
+            next if options[:if] && !options[:if].call(self)
+            next if options[:unless] && options[:unless].call(self)
+            next if options[:only] && !auditable_actions(options[:only]).include?(action_name)
+            next if options[:except] && auditable_actions(options[:except]).include?(action_name)
+
+            audit()
+          end
+        end
+        
+        def auditable_actions(actions)
+          actions = [actions] unless actions.is_a?(Array)
+          actions.map(&:to_s)
+        end
+
+
+        module ClassMethods
+          
+          # before_filter для контроллеров
+          def audit_this(*actions)
+            auditables << actions
+          end
+        end
+        
+      end
+    end
+end
+
+%w{ models controllers helpers views views/audits }.each do |dir|
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.load_paths << path
+  ActiveSupport::Dependencies.load_once_paths.delete(path)
+end
+
+# optionally:
+# Dir.glob(File.join(File.dirname(__FILE__), "db", "migrate", "*")).each do |file|
+#   require file
+# end

data/simple_audit.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_audit}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alfuken"]
+  s.date = %q{2009-09-11}
+  s.description = %q{Simple auditing plugin.}
+  s.email = %q{alfuken@gmail.com}
+  s.extra_rdoc_files = ["README", "lib/db/migrate/20090908101900_create_audits.rb", "lib/simple_audit.rb", "tasks/simple_audit_tasks.rake"]
+  s.files = ["MIT-LICENSE", "README", "Rakefile", "app/controllers/audits_controller.rb", "app/helpers/layout_helper.rb", "app/models/audit.rb", "app/views/audits/_form.html.erb", "app/views/audits/edit.html.erb", "app/views/audits/index.html.erb", "app/views/audits/new.html.erb", "app/views/audits/show.html.erb", "generators/simple_audit/USAGE", "generators/simple_audit/simple_audit_generator.rb", "generators/simple_audit/templates/migration.rb", "init.rb", "install.rb", "lib/db/migrate/20090908101900_create_audits.rb", "lib/simple_audit.rb", "tasks/simple_audit_tasks.rake", "test/simple_audit_test.rb", "test/test_helper.rb", "uninstall.rb", "Manifest", "simple_audit.gemspec"]
+  s.homepage = %q{http://github.com/alfuken/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Simple_audit", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{simple_audit}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Simple auditing plugin.}
+  s.test_files = ["test/simple_audit_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/tasks/simple_audit_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simple_audit do
+#   # Task goes here
+# end

data/test/simple_audit_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SimpleAuditTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: alfuken-simple_audit
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alfuken
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple auditing plugin.
+email: alfuken@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- lib/db/migrate/20090908101900_create_audits.rb
+- lib/simple_audit.rb
+- tasks/simple_audit_tasks.rake
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- app/controllers/audits_controller.rb
+- app/helpers/layout_helper.rb
+- app/models/audit.rb
+- app/views/audits/_form.html.erb
+- app/views/audits/edit.html.erb
+- app/views/audits/index.html.erb
+- app/views/audits/new.html.erb
+- app/views/audits/show.html.erb
+- generators/simple_audit/USAGE
+- generators/simple_audit/simple_audit_generator.rb
+- generators/simple_audit/templates/migration.rb
+- init.rb
+- install.rb
+- lib/db/migrate/20090908101900_create_audits.rb
+- lib/simple_audit.rb
+- tasks/simple_audit_tasks.rake
+- test/simple_audit_test.rb
+- test/test_helper.rb
+- uninstall.rb
+- Manifest
+- simple_audit.gemspec
+has_rdoc: false
+homepage: http://github.com/alfuken/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Simple_audit
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: simple_audit
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Simple auditing plugin.
+test_files: 
+- test/simple_audit_test.rb
+- test/test_helper.rb