devise_auditable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ef3714b008a0ac6dc42ac934e9a6271f766fe64
+  data.tar.gz: f4f23dbdbf6a3c72ad16ac487b744682c5d47539
+SHA512:
+  metadata.gz: 4697cd6c35a2ff415a4929731b11c8bfee503c823e1c1fe43025bb7ca87b65112c5d58162ac790f778c840eefd2430ee50e1a425786d16d2886acc038ba43bcc
+  data.tar.gz: aeb7a75c87bdc543816e6f65b05adbbb58dbfd04a782c58dc7764cbd2666a9373fc5df0af7dbf7f04581a1e212c7a50a0dfd82fdd281b4c8d4df59243ef3eeea

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 Entropi Software LLC
+
+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,21 @@
+devise_auditable
+=================
+
+devise_auditable is a plugin for Devise that adds a audit log support to Devise.
+
+Installation
+=================
+
+Add devise_auditable to your Gemfile
+
+    gem 'devise_auditable'
+
+Run the installer
+
+    rails g devise_auditable User
+
+Add the auditable key to your devise user model
+
+    class User < ActiveRecord::Base
+      devise :database_authenticatable, ..... , :auditable
+    end

data/lib/devise_auditable.rb

@@ -0,0 +1,11 @@
+unless defined?(Devise)
+  require 'devise'
+end
+require 'devise_auditable'
+
+Devise.add_module :auditable, :model => 'devise_auditable/model'
+
+module DeviseAuditable
+end
+
+require 'devise_auditable/engine'

data/lib/devise_auditable/engine.rb

@@ -0,0 +1,7 @@
+require 'devise_auditable'
+
+module DeviseAuditable
+  class Engine < ::Rails::Engine
+    
+  end
+end

data/lib/devise_auditable/hooks/auditable.rb

@@ -0,0 +1,11 @@
+Warden::Manager.after_authentication do |record, warden, opts|
+  if record.respond_to?(:audit_login!)
+    record.audit_login!(warden.request)
+  end
+end
+
+Warden::Manager.before_logout do |record, warden, opts|
+  if record.respond_to?(:audit_logout!)
+    record.audit_logout!(warden.request)
+  end
+end

data/lib/devise_auditable/model.rb

@@ -0,0 +1,30 @@
+require 'devise_auditable/hooks/auditable'
+
+module Devise
+  module Models
+    module Auditable
+      def audit_login!(request)
+        audit!("login", request)
+      end
+
+      def audit_logout!(request)
+        audit!("logout", request)
+      end
+
+      def audit!(action, request)
+        Rails.logger.info "The Current Action is: #{action}"
+        Rails.logger.info "The Current Time is: #{Time.now}"
+        Rails.logger.info "The Current IP is: #{request.remote_ip}"
+        Rails.logger.info "The User Agent is: #{request.headers['User-Agent']}"
+
+        "#{self.class}Audit".constantize.create(
+            action: action,
+            action_occured_at: Time.now,
+            client_ip: request.remote_ip,
+            user_agent: request.headers['User-Agent'],
+            "#{self.class}".foreign_key.to_sym => self.id
+          )
+      end
+    end
+  end
+end

data/lib/devise_auditable/version.rb

@@ -0,0 +1,3 @@
+module DeviseAuditable
+  VERSION = "0.0.1".freeze
+end

data/lib/generators/devise_auditable/devise_auditable_generator.rb

@@ -0,0 +1,62 @@
+require 'rails/generators/migration'
+
+class DeviseAuditableGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  desc "Generates a model with the given NAME (if one does not exist) with devise " <<
+    "configuration plus a migration file and devise routes."
+
+  def self.source_root
+    @_devise_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.orm_has_migration?
+    Rails::Generators.options[:rails][:orm] == :active_record
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  class_option :orm
+  class_option :migration, :type => :boolean, :default => orm_has_migration?
+
+  def invoke_orm_model
+    create_file "app/models/#{name.downcase}_audit.rb", "class #{name}Audit < ActiveRecord::Base\n" <<
+      "attr_accessible :action, :action_occured_at, :client_ip, :user_agent, :#{name.downcase}_id\n" <<
+      "end"
+
+    if model_exists?
+      say "* Model already exists."
+    elsif options[:orm].present?
+      invoke "model", ["#{name}Audits"], :migration => false, :orm => options[:orm]
+      
+      unless model_exists?
+        abort "Tried to invoke the model generator for '#{options[:orm]}' but could not find it.\n" <<
+          "Please create your model by hand before calling `rails g devise_auditable #{name}`."
+      end
+    else
+      abort "Cannot create a devise model because config.generators.orm is blank.\n" <<
+        "Please create your model by hand or configure your generators orm before calling `rails g devise_auditable #{name}`."
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', "db/migrate/devise_create_#{name.downcase}_audits.rb"
+  end
+
+  protected
+
+  def model_exists?
+    File.exists?(File.join(destination_root, model_path))
+  end
+
+  def model_path
+    print file_path
+    @model_path ||= File.join("app", "models", "#{file_path}.rb")
+  end
+end

data/lib/generators/devise_auditable/templates/migration.rb

@@ -0,0 +1,17 @@
+class DeviseCreate<%= table_name.camelize.singularize %>Audits < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name.singularize %>_audits do |t|
+      t.integer  :<%= table_name.classify.foreign_key  %>
+      t.string    "action"
+      t.datetime  "action_occured_at"
+      t.string    "client_ip"
+      t.string    "user_agent"
+    end
+
+    add_index :<%= table_name.singularize %>_audits, :<%= table_name.classify.foreign_key  %>
+  end
+
+  def self.down
+    drop_table :<%= table_name.singularize %>_audits
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: devise_auditable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicholas W. Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Auditing Plugin for Devise
+email:
+- nick@entropi.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/devise_auditable/engine.rb
+- lib/devise_auditable/hooks/auditable.rb
+- lib/devise_auditable/model.rb
+- lib/devise_auditable/version.rb
+- lib/devise_auditable.rb
+- lib/generators/devise_auditable/devise_auditable_generator.rb
+- lib/generators/devise_auditable/templates/migration.rb
+- MIT-LICENSE
+- README.md
+homepage: http://github.com/entropillc/devise_auditable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Auditing Plugin for Devise
+test_files: []