request-auditor 0.0.1

data/README.rdoc

@@ -0,0 +1,22 @@
+== Overview
+
+Provides audit logging features for controllers. Audit logging is written to a database table with the request URI, requestor IP address, date/time stamp, and user ID (provided by the application). 
+
+== Installation
+
+First, install the gem:
+
+* gem install auditor
+
+Second, generate the model for recording audit log entries:
+
+* rails generate auditor
+
+Third, run the model migration:
+
+* rake db:migrate
+
+Fourth, add the following line to any controller you want audited (or to application_controller to have it apply globally): 
+
+* is_audited
+

data/app/models/auditor/auditor_log.rb

@@ -0,0 +1,6 @@
+module Auditor
+  class AuditorLog < ActiveRecord::Base
+    set_table_name "auditor_logs"
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do 
+
+  mount_at = Auditor::Engine.config.mount_at
+
+  match mount_at => 'auditor/widgets#index'
+
+  resources :widgets, :only => [ :index, :show ],
+                          :controller => "auditor/widgets",
+                          :path_prefix => mount_at,
+                          :as => "auditor_"
+
+end

data/lib/acts_as_widget/base.rb

@@ -0,0 +1,36 @@
+module Auditor
+  module ActsAsWidget
+
+    ## Define ModelMethods
+    module Base
+      def self.included(klass)
+        klass.class_eval do
+          extend Config
+        end
+      end
+      
+      module Config
+        def acts_as_widget
+        
+          # This is where arbitrary code goes that you want to 
+          # add to the class that declared "acts_as_widget"
+          
+          has_many :widgets,  :class_name => 'Auditor::Widget'
+
+          include Auditor::ActsAsWidget::Base::InstanceMethods
+        end
+      end
+      
+      module InstanceMethods
+        
+        def factory_name
+          "this is an example instance method"
+        end
+                
+      end # InstanceMethods      
+    end
+
+  end
+end
+
+::ActiveRecord::Base.send :include, Auditor::ActsAsWidget::Base

data/lib/application_controller.rb

@@ -0,0 +1,28 @@
+module Auditor
+  ## Define ControllerMethods
+  module Controller
+  	## this one manages the usual self.included, klass_eval stuff
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :test_controller_instance_method
+    end
+
+    module InstanceMethods
+      def test_controller_instance_method
+        puts "###### This text is coming from an application_controller before_filter that is being declared and triggered from inside the engine. This before_filter is automatically integrated in when the engine is installed into an app. Look inside lib/application_controller.rb to find it. ######"
+      end
+
+      # This method is available inside application_controller but it is not being
+      # automatically executed. Notice the before_filter line above that is automatically
+      # executing the first method.
+      def second_controller_instance_method
+        puts "###### This method is not automatically run inside application_controller, but it is available inside application_controller. To see this example add 'before_filter :second_controller_instance_method' at the top of your app's application_controller.rb ######"
+      end
+    end
+  end
+end
+
+::ActionController::Base.send :include, Auditor::Controller
+
+

data/lib/application_helper.rb

@@ -0,0 +1,7 @@
+module ApplicationHelper
+  
+  def app_wide_helper_method
+    "this output is from an app-wide helper method that is declared within the gem"
+  end
+  
+end

data/lib/auditor.rb

@@ -0,0 +1,32 @@
+module Auditor
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'application_controller'
+end
+
+module ActionController
+	module Auditor
+		def self.included(base)
+			base.extend(ClassMethods)
+		end
+    
+		module ClassMethods
+			def is_audited
+				include ActionController::Auditor::InstanceMethods
+				before_filter :audit_request
+			end
+		end
+
+		module InstanceMethods
+			def audit_request
+				a = ::Auditor::AuditorLog.new
+				a.request_uri = request.url
+				a.request_parameters = request.filtered_parameters.inspect
+				a.remote_address = request.remote_ip
+				a.user_id = ::Auditor::Engine::config.user_id.call(request)
+				a.save!
+			end
+		end
+	end
+end
+
+ActionController::Base.send(:include, ActionController::Auditor)

data/lib/engine.rb

@@ -0,0 +1,30 @@
+require 'auditor'
+require 'rails'
+require 'action_controller'
+require 'application_helper'
+
+module Auditor
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.widget_factory_name = "default factory name"
+    config.mount_at = '/'
+    
+    # Load rake tasks
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), 'rails/railties/tasks.rake')
+    end
+    
+    # Check the gem config
+    initializer "check config" do |app|
+
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+    
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+    
+  end
+end

data/lib/rails/generators/auditor/auditor_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AuditorGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+   
+  def self.next_migration_number(dirname) #:nodoc:
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+
+  # Every method that is declared below will be automatically executed when the generator is run
+  
+  def create_migration_file
+    f = File.open File.join(File.dirname(__FILE__), 'templates', 'schema.rb')
+    schema = f.read; f.close
+    
+    schema.gsub!(/ActiveRecord::Schema.*\n/, '')
+    schema.gsub!(/^end\n*$/, '')
+
+    f = File.open File.join(File.dirname(__FILE__), 'templates', 'migration.rb')
+    migration = f.read; f.close
+    migration.gsub!(/SCHEMA_AUTO_INSERTED_HERE/, schema)
+    
+    tmp = File.open "tmp/~migration_ready.rb", "w"
+    tmp.write migration
+    tmp.close
+
+    migration_template  '../../../tmp/~migration_ready.rb',
+                        'db/migrate/create_auditor_tables.rb'
+    remove_file 'tmp/~migration_ready.rb'
+  end
+
+  def copy_initializer_file
+    copy_file 'initializer.rb', 'config/initializers/auditor.rb'
+  end
+
+  def update_application_template
+  
+  end
+  
+end

data/lib/rails/generators/auditor/templates/initializer.rb

@@ -0,0 +1,8 @@
+module Auditor
+  class Engine < Rails::Engine
+
+    config.mount_at = '/auditor'
+    config.widget_factory_name = 'Factory Name'
+        
+  end
+end

data/lib/rails/generators/auditor/templates/migration.rb

@@ -0,0 +1,9 @@
+class CreateAuditorTables < ActiveRecord::Migration
+  def self.up
+    SCHEMA_AUTO_INSERTED_HERE
+  end
+
+  def self.down
+    drop_table :auditor_logs
+  end
+end

data/lib/rails/generators/auditor/templates/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+    create_table :auditor_logs, :force => true do |t|
+      t.string    :request_uri
+	  t.string    :request_paramaters
+      t.string    :remote_address
+      t.string    :user_id
+      t.datetime  :created_at
+    end
+
+end

data/lib/rails/railties/tasks.rake

@@ -0,0 +1,8 @@
+namespace :auditor do
+  
+  desc "example gem rake task"
+  task :report => :environment do
+    puts "you just ran the example gem rake task"
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: request-auditor
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Hart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-10 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: hartct@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- app/models/auditor/auditor_log.rb
+- config/routes.rb
+- lib/acts_as_widget/base.rb
+- lib/application_controller.rb
+- lib/application_helper.rb
+- lib/auditor.rb
+- lib/engine.rb
+- lib/rails/generators/auditor/auditor_generator.rb
+- lib/rails/generators/auditor/templates/initializer.rb
+- lib/rails/generators/auditor/templates/migration.rb
+- lib/rails/generators/auditor/templates/schema.rb
+- lib/rails/railties/tasks.rake
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Provides audit logging to a database of controller requests.
+test_files: []
+