audit_rails 0.0.2 → 0.1.0

data/README.rdoc

@@ -27,22 +27,34 @@ rake audit_rails:install:migrations
 * To add additional attributes to Audit (let's say book_id):
 1. Add attributes to migration generated from above rake task
 2. Inherit from AuditRails::Audit:
-#MyApp/app/models/audit.rb
-class Audit < AuditRails::Audit
-  attr_accessible :action, :controller, :description, :user_name, 
-    :book_id
+    #MyApp/app/models/audit.rb
+    class Audit < AuditRails::Audit
+      attr_accessible :action, :controller, :description, :user_name, 
+      :book_id
 
-  #add associations as usual:
-  belongs_to :book
-end
+      #add associations as usual:
+      belongs_to :book
+    end
 
 * To override controller's add_to_audit method (or the helper method), simply re-implement in application_controller.rb
 
 * To track user login (one per day), override current_user method in application controller, e.g.:
-def current_user
-  add_to_audit('login', 'sessions', "John Smith")
-  super
-end
+    def current_user
+      add_to_audit('login', 'sessions', "John Smith")
+      super
+    end
+
+* To see all audits go to <app-url>/audit_rails/audits
+
+* To download the audit report as xls file:
+  * Add this to initializers/mime_types.rb
+      Mime::Type.register "application/vnd.ms-excel", :xls
+
+  * Use below link in views:
+      link_to audit_rails.audits_path(:format => "xls")
+
+= Changelog
+https://github.com/gouravtiwari/audit_rails/blob/master/README.rdoc
 
 = Contribute
 

data/app/controllers/audit_rails/audits_controller.rb

@@ -1,14 +1,18 @@
 require_dependency "audit_rails/application_controller"
+require 'to_xls' #TODO: need to figure out why this has to be required when it is in dependency
 
 module AuditRails
   class AuditsController < ApplicationController
 
     def index
       @audits = AuditRails::Audit.all
-  
+      
       respond_to do |format|
         format.html # index.html.erb
         format.json { render json: @audits }
+        format.xls { send_data @audits.to_xls(:columns => [:user_name, :action, :description, :created_at], 
+          :headers => ['User name', 'Action', 'Details', 'When?']), filename: 'audits.xls'}
+
       end
     end
 

data/lib/audit_rails/version.rb

@@ -1,3 +1,3 @@
 module AuditRails
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/dummy/log/development.log

@@ -252,3 +252,6 @@ Connecting to database specified by database.yml
    (0.8ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
    (0.1ms)  SELECT version FROM "schema_migrations"
    (0.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121213191242')
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audit_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2012-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.9
+- !ruby/object:Gem::Dependency
+  name: to_xls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +75,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
-description: It is inspired from many great audit gems in rails community that audits
-  model and I was looking for a gem which can audit based on actions as well as can
-  audit link tracking. This gem just serve this purpose.
+description: An action based auditor, which has internal as well as outgoing link
+  tracking.
 email:
 - gouravtiwari21@gmail.com
 executables: []
@@ -185,3 +200,4 @@ test_files:
 - test/dummy/script/rails
 - test/integration/navigation_test.rb
 - test/test_helper.rb
+has_rdoc: