audited_controller 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in audited_controller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Siwei
+
+MIT License
+
+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/README.md

@@ -0,0 +1,60 @@
+# AuditedController
+
+This gem is extracted from the real working code. the requirements is also from the real requirements:
+
+1. the users want to track the user's actions.
+2. should log into database.
+3. there're not so many requests in a second.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'audited_controller'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install audited_controller
+
+Then create a file : config/audits.yml, and (TODO: make this a task )
+
+## Usage
+
+1. assuming you want to track the actions of your 'users_controller'. add 'before_filter :add_to_audit' to the target controller.
+
+class UsersController < ApplicationController
+  before_filter :add_to_audit
+  def index
+    # ...
+  end
+  def create
+    # ...
+  end
+end
+
+
+2. make sure the actions appear in the config/audits.yml file
+
+    # this line determines if the get request should be audited.
+    audit_get_request: false
+
+    # the lines below is used for i18n translations
+    # format:
+    # <controller>
+    #   <action>: <comments>
+    users:
+      index: open the index page of messages
+      create: create an message
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/application_controller.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+class ApplicationController < ActionController::Base
+
+  helper_method :add_to_audit
+  def add_to_audit
+    audit_config = HashWithIndifferentAccess.new(YAML.load(File.read(
+      File.expand_path("#{Rails.root}/config/audits.yml", __FILE__))))
+    controller = params[:controller]
+    action = params[:action]
+    request_type = restful_method(params)
+    return if !audit_get_request?(audit_config) && request_type == 'get'
+    Audit.create!(action: action, controller: controller, user_name: current_user.login,
+      description: audit_config[controller][action],
+      :params => params.inspect,
+      remote_ip: request.remote_ip, restful_method: restful_method(params) )
+  end
+  private
+  def audit_get_request?(audit_config)
+    audit_config["audit_get_request"]
+  end
+  # return: get, post, put or delete
+  def restful_method(params)
+    params[:authenticity_token].blank? ? 'get' : ((params[:_method]) || 'post')
+  end
+
+end

data/audited_controller.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'audited_controller/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "audited_controller"
+  gem.version       = AuditedController::VERSION
+  gem.authors       = ["Siwei Shen"]
+  gem.email         = ["sg552sg552@gmail.com"]
+  gem.description   = %q{a rubygem to audit the actions in controllers of Rails}
+  gem.summary       = %q{a rubygem to audit the actions in controllers, such as 'update', 'create'. very lightweight and simple.
+    basically it uses a 'before_filter' to achieve this. }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # it need rails and related gems.
+end

data/lib/audited_controller/version.rb

@@ -0,0 +1,3 @@
+module AuditedController
+  VERSION = "0.0.1"
+end

data/lib/audited_controller.rb

@@ -0,0 +1,5 @@
+require "audited_controller/version"
+
+module AuditedController
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: audited_controller
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Siwei Shen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-30 00:00:00.000000000 Z
+dependencies: []
+description: a rubygem to audit the actions in controllers of Rails
+email:
+- sg552sg552@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/application_controller.rb
+- audited_controller.gemspec
+- lib/audited_controller.rb
+- lib/audited_controller/version.rb
+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.8.24
+signing_key: 
+specification_version: 3
+summary: a rubygem to audit the actions in controllers, such as 'update', 'create'.
+  very lightweight and simple. basically it uses a 'before_filter' to achieve this.
+test_files: []
+has_rdoc: