access_logging 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nick Ragaz
+
+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,49 @@
+AccessLogging
+============
+
+Log access to models through your controllers.
+
+Requires Rails ~> 3 and Ruby 1.9.2.
+
+Usage
+-----
+
+    create_table "access_logs" do |t|
+      t.integer  "user_id"
+      t.string   "user_type",   :limit => 16
+      t.string   "user_email",  :limit => 100
+      t.string   "ip",          :limit => 15
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.string   "user_name",   :limit => 48
+      t.string   "path",        :limit => 100
+      t.string   "model_type",  :limit => 24
+      t.integer  "model_id"
+      t.string   "description", :default => ""
+      t.string   "verb",        :limit => 24
+    end
+  
+    rails generate access_logging:model
+  
+    class SecretsController < ApplicationController
+      log_access_to :secret
+    
+      # restful actions: index, show, create, etc.
+    end
+  
+    PUT '/sessions/new' # => John Smith signs in
+  
+    GET '/secrets' # => AccessLog.count += 1; John Smith viewed /secrets
+    GET '/secrets/1' # => AccessLog.count += 1; John Smith viewed /secrets/1
+    PUT '/secrets/1' # => AccessLog.count += 1; John Smith updated /secrets/1
+  
+    etc.
+  
+    AccessLog.find(2).secret # => <Secret id: 1>
+
+
+TODO
+----
+
+* Add generator
+* Log accesses to Redis first, then dump them into the SQL database later.

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AccessLogging'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/access_logging/controller.rb

@@ -0,0 +1,51 @@
+require 'active_support/concern'
+
+module AccessLogging::Controller
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    
+    # example usage:
+    #
+    #   class ReportsController < ActionController::Base
+    #     log_access_to :report, through: :print
+    #
+    #     # restful actions here...
+    #
+    #     def print
+    #       @report = Report.find(params[:id])
+    #     end
+    #   end
+    #
+    # Also depends on the presence of a `current_anyone` method (probably on
+    # ApplicationController) to determine the user.
+    def log_access_to(model, opts={})
+      after_filter(only: :index) do
+        log_access
+      end
+    
+      after_filter only: [:show, :create, :edit, :update, :destroy] do
+        log_access instance_variable_get("@#{model}")
+      end
+    
+      if opts[:through]
+        opts[:through] = [ *opts[:through] ]
+        opts[:through].each do |action|
+          after_filter only: action do
+            log_access instance_variable_get("@#{model}"), "#{action}ed"
+          end
+        end
+      end
+    end
+  end
+  
+  # An alternative to a controller-wide filter (above) -- call something like
+  # `log_access(@report, 'transmogrifying')` anywhere in an action.
+  def log_access(object=nil, verb=nil)
+    return unless current_anyone
+    AccessLog.log_request current_anyone, request, model: object, verb: verb
+  rescue => e
+    # in production, don't kill the request just because logging failed
+    raise e if Rails.env.development?
+  end
+end

data/lib/access_logging/model.rb

@@ -0,0 +1,97 @@
+require 'active_support/concern'
+
+module AccessLogging::Model
+  extend ActiveSupport::Concern
+  
+  include DateRangeScopes
+  
+  REDIS_ATTRIBUTES = [
+    :created_at,
+    :ip, :user_type, :user_id, 
+    :verb, :model_type, :model_id, :description,
+    :path
+  ]
+  
+  REDIS_SEPARATOR = "||"
+  
+  included do
+    belongs_to :user, polymorphic: true
+    belongs_to :model, polymorphic: true
+    
+    before_validation :set_user_name_and_email, :set_description
+    
+    validates_presence_of :ip, :path, :verb,
+                          :user_name, :user_email, :user_id, :user_type,
+                          :created_at
+    
+    default_scope order('access_logs.created_at DESC')
+  end
+  
+  module ClassMethods
+    def log_request(user, request, opts={})
+      log = AccessLog.new
+      log.user = user
+      log.path = request.fullpath
+      log.ip = request.remote_ip
+      
+      log.model = opts[:model]
+      log.verb = opts[:verb] || default_verb_for_method(request.request_method)
+      
+      return if log.model && log.model.new_record?
+      
+      log.save!
+    end
+  
+    def default_verb_for_method(method)
+      case method.to_s.upcase
+      when 'GET'
+        "viewed"
+      when 'POST'
+        "created"
+      when 'PUT'
+        "updated"
+      when 'DELETE'
+        "deleted"
+      end
+    end
+  
+    def build_from_redis_string(str)
+      log = AccessLog.new
+      parts = str.split(REDIS_SEPARATOR, -1)
+    
+      REDIS_ATTRIBUTES.each_with_index do |attribute, i|
+        log.send "#{attribute}=", parts[i]
+      end
+    
+      log
+    end
+  end
+  
+  def created_at
+    self[:created_at] ||= Time.zone.now
+  end
+  
+  def redis_string
+    REDIS_ATTRIBUTES.map { |attribute| send(attribute) }.join(REDIS_SEPARATOR)
+  end
+  
+  
+  private
+  
+  def set_description
+    self.description = "" and return unless model && !model.new_record?
+    
+    if model.respond_to?(:description)
+      self.description = model.description
+    elsif model.respond_to?(:name)
+      self.description = "#{model.class.name} #{model.try(:name)}"
+    else
+      self.description = "#{model.class.name} #{model.id}"
+    end
+  end
+  
+  def set_user_name_and_email
+    self.user_name = user.try :name
+    self.user_email = user.try :email
+  end
+end

data/lib/access_logging.rb

@@ -0,0 +1,10 @@
+require 'active_support/dependencies'
+
+ActiveSupport.on_load(:action_controller) do
+  include AccessLogging::Controller
+end
+
+module AccessLogging
+  autoload :Controller, 'access_logging/controller'
+  autoload :Model,      'access_logging/model'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: access_logging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ragaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-29 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2157446640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157446640
+- !ruby/object:Gem::Dependency
+  name: date_range_scopes
+  requirement: &2157446240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157446240
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2157445780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157445780
+description: Log access to models through your controllers.
+email: nick.ragaz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/access_logging/controller.rb
+- lib/access_logging/model.rb
+- lib/access_logging.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/nragaz/access_logging
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Log access to models through your controllers.
+test_files: []