activity_log 0.0.4 → 0.0.5

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 activity_log.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Slaven
+
+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,62 @@
+# ActivityLog
+
+A very simple activity logging facility, used to record a log of events attached to a unique ID.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activity_log'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activity_log
+
+Once you have the gem installed, execute:
+    $ rails g activity_log:install
+
+followed by
+
+    $ rake db:migrate
+
+This will create the activity_log_entry model and migration as well as creating the new table in the database.
+
+## Usage
+
+Once installed you can then add new activity log entries with by first including the actvity_log library via:
+
+class MyController < ApplicationController
+  include ActivityLog
+
+and use the following methods to add and retrieve activity log entries:
+Create a new entry:
+```ruby
+ActivityLog.log(owner_id, "user logged in")
+```
+
+Retrieve a single entry
+```ruby
+@entry = ActivityLog.get_by_id(activity_log_entry_id)
+```
+
+Retrieve all entries for a unique id
+```ruby
+@entries = ActivityLog.get_by_owner(owner_id)
+```
+
+Retrieve all entries for a unique id within a specific timeframe
+```ruby
+@entries = ActivityLog.get_by_owner_and_range(owner_id, start_date, end_date)
+```
+
+## 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/activity_log.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activity_log/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "activity_log"
+  gem.version       = ActivityLog::VERSION
+  gem.authors       = ["Mike"]
+  gem.email         = ["mslaven@gmail.com"]
+  gem.description   = %q{Provides a simple activity logging and retrieval facility}
+  gem.summary       = %q{Simple Activity Logging Facility}
+  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"]
+
+
+  gem.add_runtime_dependency(%q<rails>, [">= 3.2.0"])
+end

data/lib/activity_log.rb

@@ -0,0 +1,26 @@
+require "activity_log/version"
+
+module ActivityLog
+
+  def self.log(owner_id, data)
+    log_entry = ActivityLogEntry.new
+    log_entry.uid = owner_id unless owner_id.nil?
+    log_entry.data = data unless data.nil?
+
+    return log_entry.save
+  end
+
+  def self.get_by_owner(owner_id)
+  	ActivityLogEntry.all(:conditions => {:uid => owner_id})
+  end
+
+  def self.get_by_owner_and_range(owner_id, start_date = nil, end_date = nil)
+    start_date = Time.now - 50.years if start_date.nil?
+    end_date = Time.now + 1.years if end_date.nil?
+    ActivityLogEntry.all(:conditions => {:uid => owner_id, :created_at => start_date..end_date})
+  end
+
+  def self.get_by_id(id)
+  	ActivityLogEntry.find_by_id(id)
+  end
+end

data/lib/activity_log/version.rb

@@ -0,0 +1,3 @@
+module ActivityLog
+  VERSION = "0.0.5"
+end

data/lib/generators/activity_log/install/install_generator.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+# Copyright (c) 2012 Mike Slaven
+#
+# 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.
+
+require 'rails/generators/migration'
+
+module ActivityLog
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "This generator creates an ActivityLog model, and generates migrations for the activity_log gem."
+      
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+      
+      def copy_migrations
+        migration_template "create_activity_log_entry.rb", "db/migrate/create_activity_log_entry.rb"
+      end
+      
+      def copy_the_activity_log_model
+        copy_file "activity_log_entry.rb", "app/models/activity_log_entry.rb"
+      end
+      
+    end
+  end
+end

data/lib/generators/activity_log/install/templates/activity_log_entry.rb

@@ -0,0 +1,15 @@
+class ActivityLogEntry < ActiveRecord::Base
+  
+  validates :uid, :presence => true
+  validates :data, :presence => true
+  
+  attr_accessible :uid, :data
+
+  before_save :set_defaults
+
+  def set_defaults
+  	self.uid = 0 unless self.uid
+  	self.data = "" unless self.data
+  end
+
+end

data/lib/generators/activity_log/install/templates/create_activity_log_entry.rb

@@ -0,0 +1,9 @@
+class CreateActivityLogEntry < ActiveRecord::Migration
+  def change
+    create_table :activity_log_entries do |t|
+      t.integer :uid
+      t.string :data
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,61 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: activity_log
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
+  prerelease:
 platform: ruby
 authors:
 - Mike
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    none: false
+  prerelease: false
+  type: :runtime
 description: Provides a simple activity logging and retrieval facility
 email:
 - mslaven@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activity_log.gemspec
+- lib/activity_log.rb
+- lib/activity_log/version.rb
+- lib/generators/activity_log/install/install_generator.rb
+- lib/generators/activity_log/install/templates/activity_log_entry.rb
+- lib/generators/activity_log/install/templates/create_activity_log_entry.rb
 homepage: ''
 licenses: []
-post_install_message: 
+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
+      version: !binary |-
+        MA==
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
+  none: false
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key: 
+signing_key:
 specification_version: 3
 summary: Simple Activity Logging Facility
 test_files: []