action_logger 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # ActionLogger
 
-TODO: Write a gem description
+Simple ActiveRecord activity logger. It allows you to log user actions to the database.
 
 ## Installation
 
@@ -10,15 +10,47 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    bundle
 
-Or install it yourself as:
+You'll need to create the migration:
 
-    $ gem install action_logger
+    rails generate action_logger:install
 
 ## Usage
 
-TODO: Write usage instructions here
+Now you can call `ActionLogger.log` to logs omething to the database. It takes two required paramaters which are `action` and `source`. It also takes an optional attributes hash.
+
+Example:
+
+    ActionLogger.log 'buy', 'search results'
+
+This will log a buy action to the database which appeared on the search results. The optional paramters are:
+
+    :sender    # Takes any object, e.g. current_user
+    :ip        # Allows you to store an ip address
+    :data      # Takes a hash with anything you want
+    :admin_id  # allows you to set an extra id if for example an admin became a user through a "become" functionality
+
+There is also a helper you can use in your controllers or views. In your `ApplicationController` add:
+
+    include ActionLogsHelper
+
+Now you're able to call the `log_action` helper:
+
+    log_action 'buy', 'search results'
+
+The optional attributes has will set some sane defaults:
+
+    :sender    => current_user
+    :ip        => request.remote_ip
+    :data      => params
+    :admin_id  => cirremt_admin_user
+
+## Warning
+
+This code is still very basic and has no automated tests. Your production database might not be the best place to log these actions.
+At some point we might move to Mongo or any other database system if we feel it suits our needs better.
+Feel free to fork and improve the code.
 
 ## Contributing
 

data/action_logger.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   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"]
+
+  gem.add_dependency 'rails', '>= 3.0.0'
 end

data/app/helpers/action_logs_helper.rb

@@ -0,0 +1,5 @@
+module ActionLogsHelper
+  def log_action action, source, attrs = {}
+    ActionLogger.log action, source, attrs
+  end
+end

data/app/models/action_log.rb

@@ -0,0 +1,8 @@
+class ActionLog < ActiveRecord::Base
+  serialize :data
+
+  def self.log action, source, sender = nil, ip = nil, data = {}, admin_id = nil
+    log = create! action: action, source: source, sender_id: sender.try(:id), sender_type: sender.try(:class).try(:name), ip: ip, data: data, admin_id: (admin_id.present? && admin_id.respond_to?(:id) ? admin_id.id : admin_id)
+    Rails.logger.info log.inspect
+  end
+end

data/lib/action_logger.rb

@@ -1,5 +1,13 @@
 require 'action_logger/version'
+require 'action_logger/engine'
 
 module ActionLogger
-  # Your code goes here...
+  def self.log action, source, attrs = {}
+    attrs[:sender] || try(:current_user)
+    attrs[:ip] || request.try(:remote_ip)
+    attrs[:data] || params
+    attrs[:admin_id] || try(:current_admin_user)
+
+    ActionLog.log action, source, attrs[:semder], attrs[:ip], attrs[:data], attrs[:admin_id]
+  end
 end

data/lib/action_logger/engine.rb

@@ -0,0 +1,5 @@
+module ActionLogger
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionLogger
+  end
+end

data/lib/action_logger/version.rb

@@ -1,3 +1,3 @@
 module ActionLogger
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/generators/action_logger/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ActionLogger
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Generates the ActionLogger migrations'
+
+      def self.next_migration_number path
+        Time.now.utc.strftime '%Y%m%d%H%M%S'
+      end
+
+      def create_migrations
+        migration_template 'create_action_logs.rb', 'db/migrate/create_action_logs.rb'
+      end
+    end
+  end
+end

data/lib/generators/action_logger/templates/create_action_logs.rb

@@ -0,0 +1,19 @@
+class CreateActionLogs < ActiveRecord::Migration
+  def self.up
+    create_table :action_logs do |t|
+      t.integer :sender_id
+      t.string :sender_type
+      t.string :action
+      t.string :source
+      t.string :ip
+      t.text :data
+      t.integer :admin_id
+      t.timestamps
+    end
+    add_index :action_logs, [:sender_type, :sender_id]
+  end
+
+  def self.down
+    drop_table :admin_notes
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
-dependencies: []
+date: 2012-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Log actions in your Rails app
 email: gems@jeroenj.be
 executables: []
@@ -23,8 +39,13 @@ files:
 - README.md
 - Rakefile
 - action_logger.gemspec
+- app/helpers/action_logs_helper.rb
+- app/models/action_log.rb
 - lib/action_logger.rb
+- lib/action_logger/engine.rb
 - lib/action_logger/version.rb
+- lib/generators/action_logger/install_generator.rb
+- lib/generators/action_logger/templates/create_action_logs.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -37,12 +58,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3345375381320870001
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3345375381320870001
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24