activitylog 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjUzY2RlY2E0YTRmNWI3ZmUyNDg2YWI4OWZjMmFmZThhN2E1MzJiNw==
+  data.tar.gz: !binary |-
+    NTZmZTk0ZTMxNDNkNDIxMjg3M2IxYjI5NTdjZjUyOGE1MjY2ZjgyMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTU1MmRjZWMyMjgzZTA2MzMxMmVhNGIyNzhjNGM2YmM4NzBlNWQ2YzAwODQy
+    YzJlMzRhYTA1N2ViMzFlZDE1MGZiYjIzOTdiZWYzMWY1MzMxMDRhZjk1OTQw
+    MDU4ZTFlNWQxODY0YmQwODg5NDBmNDQwOTk3OGZlYjg1Mjc4ZTM=
+  data.tar.gz: !binary |-
+    MzhkNGE3MDU4M2U4ZjdmNDQyNzJiNTk2NTFmNzYxODI2MzA1ZmVhZGVhOTMy
+    MGE2MzE4ZjRmOTM5ZmVmYjc2MDg3ZTBhYjNkZTExYzU5MDcyNWU1MTRlZTUw
+    ZDkzOGU4MTM4OWU2MjQyMDMxODllZTU3ZjZjMDI1NjNhODA0MGM=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 1.8.7)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jon Erik Suero
+
+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.markdown

@@ -0,0 +1,39 @@
+# Activity Log
+
+Activity Log provides the ability to track model and controller activity in your app.
+
+## How to Use
+
+First run the generator the create the required migrations and initializers:
+
+    $ rails generate activity_log
+
+Then migrate the database:
+
+    $ rake db:migrate
+
+To log a model's activity, add the following line to the class:
+
+    log_model_activity
+
+To log a controller's activity, add the follow line to the controller:
+
+    log_controller_activity
+
+Data can be accessed using the ActivityLog Active Record class.
+
+## Contributing to Activity Log
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Jon Erik Suero. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "activitylog"
+  gem.homepage = "http://github.com/JonErikDSuero/activitylog"
+  gem.license = "MIT"
+  gem.summary = "Provides Activity Log functionality to your code"
+  gem.description = "Coming soon"
+  gem.email = "jonerikdsuero@gmail.com"
+  gem.authors = ["Jon Erik Suero", "Elan Dubrofsky"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activitylog #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/activity_log/activity_log.rb

@@ -0,0 +1,27 @@
+class ActivityLog < ActiveRecord::Base
+
+  serialize :data, Hash
+
+  belongs_to :parent, :class_name => 'ActivityLog', :foreign_key => 'parent_activity_id'
+  has_many :children, :class_name => 'ActivityLog', :foreign_key => 'parent_activity_id'
+
+  def self.create_new(user, action, object, data={}, parent_activity_id=nil)
+
+    options = {
+        "user_id" => user.id,
+        "object_id" => object.id,
+        "object_type" => object.class.name,
+        "action" => action,
+        "data" => data,
+        "parent_activity_id" => parent_activity_id
+    }
+    log = ActivityLog.create(options)
+
+    if log.save
+      log
+    else
+      raise "ActivityLog failed to be saved" # TODO: this is just temporary
+    end
+
+  end
+end

data/lib/activity_log/activity_logger.rb

@@ -0,0 +1,41 @@
+module ActivityLogger
+
+  extend ActiveSupport::Concern
+
+  mattr_accessor :stored_parent_activity_id
+
+  # INSTANCE METHODS
+  def destroy_parent_activity_id
+    self.stored_parent_activity_id = nil
+  end
+
+  def record_model_activity_log(action_to_store)
+    # if current_user_id == nil, then the User is in the process of Logging In
+    current_id = defined?(current_user_id) ? (current_user_id || id) : id
+    ActivityLog.create_new(User.find(current_id), action_to_store, self, changes, self.stored_parent_activity_id)
+  end
+
+  def record_controller_activity_log
+    return unless params[:id].present?
+    return if request.get? #exit if it's a get
+    object = controller_name.classify.constantize.find_by_id(params[:id]) #TODO: mk-- change find for LoanStep if searching by step name and loan_id
+    return unless object.present?
+    activity = ActivityLog.create_new(User.find(current_user.try(:id) || id), params[:controller]+"/"+params[:action], object, params)
+    self.stored_parent_activity_id = activity.id
+  end
+
+  # CLASS METHODS (self.)
+  module ClassMethods
+    def log_model_activity
+      self.has_many :object_activity_logs, :foreign_key => 'object_id', :class_name => 'ActivityLog', :conditions => {:object_type => self.class.name}
+      self.after_create {record_model_activity_log("create")}
+      self.after_update {record_model_activity_log("update")}
+      self.before_destroy {record_model_activity_log("destroy")}
+    end
+
+    def log_controller_activity
+      self.before_filter {record_controller_activity_log}
+      self.after_filter {destroy_parent_activity_id}
+    end
+  end
+end

data/lib/activity_log.rb

@@ -0,0 +1,3 @@
+require 'activity_log/activity_log'
+require 'activity_log/activity_logger.rb'
+ActiveRecord::Base.send(:include, ActivityLogger)

data/lib/generators/activity_log/activity_log_generator.rb

@@ -0,0 +1,26 @@
+# Requires
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActivityLogGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'create_activity_logs.rb', 'db/migrate/create_activity_logs.rb'
+  end
+
+  def create_initializer_file
+    create_file "config/initializers/activity_log.rb", "require 'activity_log'"
+  end
+end

data/lib/generators/activity_log/templates/create_activity_logs.rb

@@ -0,0 +1,13 @@
+class CreateActivityLogs < ActiveRecord::Migration
+  def change
+    create_table :activity_logs do |t|
+      t.integer :user_id
+      t.integer :object_id
+      t.string :object_type
+      t.string :action
+      t.integer :parent_activity_id
+      t.binary :data, :limit => 10.megabyte
+      t.timestamps
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'activitylog'
+
+class Test::Unit::TestCase
+end

data/test/test_activity_log.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestActivityLog < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: activitylog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Erik Suero
+- Elan Dubrofsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: Coming soon
+email: jonerikdsuero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/activity_log.rb
+- lib/activity_log/activity_log.rb
+- lib/activity_log/activity_logger.rb
+- lib/generators/activity_log/activity_log_generator.rb
+- lib/generators/activity_log/templates/create_activity_logs.rb
+- test/helper.rb
+- test/test_activity_log.rb
+homepage: http://github.com/JonErikDSuero/activitylog
+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.5
+signing_key: 
+specification_version: 4
+summary: Provides Activity Log functionality to your code
+test_files: []