activity_feed 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.rdb

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2-p290@activity_feed_gem --create

data/CHANGELOG.markdown

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activity_feed.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 David Czarnecki
+
+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,205 @@
+# ActivityFeed
+
+Activity feeds backed by Redis
+
+## Compatibility
+
+The gem has been built and tested under Ruby 1.9.2-p290
+
+## Installation
+
+`gem install activity_feed`
+
+or:
+
+`gem 'activity_feed'`
+
+Make sure your redis server is running! Redis configuration is outside the scope of this README, but 
+check out the Redis documentation, http://redis.io/documentation.
+
+## Configuration
+
+```ruby
+ActivityFeed.redis = Redis.new(:host => '127.0.0.1', :port => 6379)
+ActivityFeed.namespace = 'activity'
+ActivityFeed.key = 'feed'
+ActivityFeed.persistence = :memory (or :active_record or :mongo_mapper)
+```
+
+## Usage
+
+Make sure to set the Redis connection for use by the ActivityFeed classes.
+
+```ruby
+$redis = Redis.new(:host => '127.0.0.1', :port => 6379)
+ActivityFeed.redis = $redis
+```
+
+### Memory-backed persistence
+
+ActivityFeed defaults to using memory-backed persistence, storing the full item as JSON in Redis.
+
+```ruby
+ruby-1.9.2-p290 :001 > require 'redis'
+ => true 
+ruby-1.9.2-p290 :002 > $redis = Redis.new(:host => 'localhost', :port => 6379)
+ => #<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)> 
+ruby-1.9.2-p290 :003 > require 'activity_feed'
+ => true 
+ruby-1.9.2-p290 :004 > ActivityFeed.redis = $redis
+ => #<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)> 
+ruby-1.9.2-p290 :005 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'Text')
+ => #<ActivityFeed::Memory::Item:0x00000100ceaaa8 @attributes={:user_id=>1, :nickname=>"David Czarnecki", :type=>"activity-type", :text=>"Text"}, @user_id=1, @nickname="David Czarnecki", @type="activity-type", @text="Text"> 
+ruby-1.9.2-p290 :006 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'More text')
+ => #<ActivityFeed::Memory::Item:0x000001022b0c48 @attributes={:user_id=>1, :nickname=>"David Czarnecki", :type=>"activity-type", :text=>"More text"}, @user_id=1, @nickname="David Czarnecki", @type="activity-type", @text="More text"> 
+ruby-1.9.2-p290 :007 > feed = ActivityFeed::Feed.new(1)
+ => #<ActivityFeed::Feed:0x00000103023b78 @feederboard=#<Leaderboard:0x00000103023a88 @leaderboard_name="activity:feed:1", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)>>> 
+ruby-1.9.2-p290 :008 > feed.page(1)
+ => [{"user_id"=>1, "nickname"=>"David Czarnecki", "type"=>"activity-type", "text"=>"More text"}, {"user_id"=>1, "nickname"=>"David Czarnecki", "type"=>"activity-type", "text"=>"Text"}] 
+ruby-1.9.2-p290 :009 > 
+```
+
+### ActiveRecord persistence
+
+ActivityFeed can also use ActiveRecord to persist the items to more durable storage while 
+keeping the IDs for the activity feed items in Redis. You can set this using:
+
+```ruby
+ActivityFeed.persistence = :active_record
+```
+
+Example:
+
+```ruby
+ruby-1.9.2-p290 :001 > require 'active_record'
+ => true 
+ruby-1.9.2-p290 :002 > 
+ruby-1.9.2-p290 :003 >   ActiveRecord::Base.establish_connection(
+ruby-1.9.2-p290 :004 >       :adapter => "sqlite3",
+ruby-1.9.2-p290 :005 >       :database => ":memory:"
+ruby-1.9.2-p290 :006?>   )
+ => #<ActiveRecord::ConnectionAdapters::ConnectionPool:0x00000101329cc0 @spec=#<ActiveRecord::Base::ConnectionSpecification:0x00000101329d38 @config={:adapter=>"sqlite3", :database=>":memory:"}, @adapter_method="sqlite3_connection">, @reserved_connections={}, @connection_mutex=#<Monitor:0x00000101329bd0 @mon_owner=nil, @mon_count=0, @mon_mutex=#<Mutex:0x00000101329b80>>, @queue=#<MonitorMixin::ConditionVariable:0x00000101329b30 @monitor=#<Monitor:0x00000101329bd0 @mon_owner=nil, @mon_count=0, @mon_mutex=#<Mutex:0x00000101329b80>>, @cond=#<ConditionVariable:0x00000101329b08 @waiters=[], @waiters_mutex=#<Mutex:0x00000101329978>>>, @timeout=5, @size=5, @connections=[], @checked_out=[], @automatic_reconnect=true, @tables={}, @visitor=nil, @columns={}, @columns_hash={}, @column_defaults={}, @primary_keys={}> 
+ruby-1.9.2-p290 :007 > 
+ruby-1.9.2-p290 :008 >   ActiveRecord::Migration.verbose = false
+ => false 
+ruby-1.9.2-p290 :009 > 
+ruby-1.9.2-p290 :010 >   ActiveRecord::Schema.define do
+ruby-1.9.2-p290 :011 >       create_table :activity_feed_items, :force => true do |t|
+ruby-1.9.2-p290 :012 >           t.integer :user_id
+ruby-1.9.2-p290 :013?>         t.string :nickname
+ruby-1.9.2-p290 :014?>         t.string :type
+ruby-1.9.2-p290 :015?>         t.string :title
+ruby-1.9.2-p290 :016?>         t.text :text
+ruby-1.9.2-p290 :017?>         t.string :url
+ruby-1.9.2-p290 :018?>         t.string :icon
+ruby-1.9.2-p290 :019?>         t.boolean :sticky
+ruby-1.9.2-p290 :020?>         
+ruby-1.9.2-p290 :021 >           t.timestamps
+ruby-1.9.2-p290 :022?>       end
+ruby-1.9.2-p290 :023?>   
+ruby-1.9.2-p290 :024 >       add_index :activity_feed_items, :user_id
+ruby-1.9.2-p290 :025?>   end
+ => nil 
+ruby-1.9.2-p290 :026 > 
+ruby-1.9.2-p290 :027 >   require 'redis'
+ => true 
+ruby-1.9.2-p290 :028 > $redis = Redis.new(:host => 'localhost', :port => 6379)
+ => #<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)> 
+ruby-1.9.2-p290 :029 > require 'activity_feed'
+ => true 
+ruby-1.9.2-p290 :030 > ActivityFeed.redis = $redis
+ => #<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)> 
+ruby-1.9.2-p290 :031 > ActivityFeed.persistence = :active_record
+ => :active_record 
+ruby-1.9.2-p290 :032 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'Text')
+ => #<ActivityFeed::ActiveRecord::Item id: 1, user_id: 1, nickname: "David Czarnecki", type: nil, title: nil, text: "Text", url: nil, icon: nil, sticky: nil, created_at: "2011-09-14 15:08:22", updated_at: "2011-09-14 15:08:22"> 
+ruby-1.9.2-p290 :033 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'More text')
+ => #<ActivityFeed::ActiveRecord::Item id: 2, user_id: 1, nickname: "David Czarnecki", type: nil, title: nil, text: "More text", url: nil, icon: nil, sticky: nil, created_at: "2011-09-14 15:08:25", updated_at: "2011-09-14 15:08:25"> 
+ruby-1.9.2-p290 :034 > feed = ActivityFeed::Feed.new(1)
+ => #<ActivityFeed::Feed:0x000001030f1898 @feederboard=#<Leaderboard:0x000001030f1578 @leaderboard_name="activity:feed:1", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)>>> 
+ruby-1.9.2-p290 :035 > feed.page(1)
+ => [#<ActivityFeed::ActiveRecord::Item id: 2, user_id: 1, nickname: "David Czarnecki", type: nil, title: nil, text: "More text", url: nil, icon: nil, sticky: nil, created_at: "2011-09-14 15:08:25", updated_at: "2011-09-14 15:08:25">, #<ActivityFeed::ActiveRecord::Item id: 1, user_id: 1, nickname: "David Czarnecki", type: nil, title: nil, text: "Text", url: nil, icon: nil, sticky: nil, created_at: "2011-09-14 15:08:22", updated_at: "2011-09-14 15:08:22">] 
+ruby-1.9.2-p290 :036 > 
+```
+
+### MongoMapper persistence
+
+ActivityFeed can also use MongoMapper to persist the items to more durable storage while 
+keeping the IDs for the activity feed items in Redis. You can set this using:
+
+```ruby
+ActivityFeed.persistence = :mongo_mapper
+```
+
+Make sure MongoMapper is configured correctly before setting this option. 
+If using Activity Feed outside of Rails, you can do: 
+
+```ruby
+MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+MongoMapper.database = 'activity_feeds_production'
+```
+
+```ruby
+ruby-1.9.2-p290 :001 > require 'mongo_mapper'
+ => true 
+ruby-1.9.2-p290 :002 > MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+ => #<Mongo::Connection:0x00000100c7d520 @host_to_try=["localhost", 27017], @port=nil, @host=nil, @slave_ok=nil, @auths=[], @id_lock=#<Mutex:0x00000100c7d480>, @pool_size=1, @timeout=5.0, @op_timeout=nil, @connection_mutex=#<Mutex:0x00000100c7d458>, @safe=false, @safe_mutexes={#<TCPSocket:(closed)>=>#<Mutex:0x00000100c6f8a8>, #<TCPSocket:fd 5>=>#<Mutex:0x00000100c6db70>}, @queue=#<ConditionVariable:0x00000100c7d390 @waiters=[], @waiters_mutex=#<Mutex:0x00000100c7d340>>, @primary=["localhost", 27017], @primary_pool=#<Mongo::Pool:0x00000100c6f128 @connection=#<Mongo::Connection:0x00000100c7d520 ...>, @port=27017, @host="localhost", @size=1, @timeout=5.0, @connection_mutex=#<Mutex:0x00000100c6f100>, @queue=#<ConditionVariable:0x00000100c6f0b0 @waiters=[], @waiters_mutex=#<Mutex:0x00000100c6f060>>, @socket_ops={#<TCPSocket:fd 5>=>[]}, @sockets=[#<TCPSocket:fd 5>], @pids={#<TCPSocket:fd 5>=>61344}, @checked_out=[]>, @logger=nil, @read_primary=true> 
+ruby-1.9.2-p290 :003 > MongoMapper.database = 'activity_feed_gem_test'
+ => "activity_feed_gem_test" 
+ruby-1.9.2-p290 :004 > require 'redis'
+ => true 
+ruby-1.9.2-p290 :005 > $redis = Redis.new(:host => 'localhost', :port => 6379)
+ => #<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)> 
+ruby-1.9.2-p290 :006 > require 'activity_feed'
+ => true 
+ruby-1.9.2-p290 :007 > ActivityFeed.redis = $redis
+ => #<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)> 
+ruby-1.9.2-p290 :008 > ActivityFeed.persistence = :mongo_mapper
+ => :mongo_mapper 
+ruby-1.9.2-p290 :009 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'Text')
+ => #<ActivityFeed::MongoMapper::Item _id: BSON::ObjectId('4e70dcc512dac1efa0000001'), created_at: 2011-09-14 16:56:37 UTC, nickname: "David Czarnecki", text: "Text", type: "activity-type", updated_at: 2011-09-14 16:56:37 UTC, user_id: 1> 
+ruby-1.9.2-p290 :010 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'More text')
+ => #<ActivityFeed::MongoMapper::Item _id: BSON::ObjectId('4e70dcc512dac1efa0000003'), created_at: 2011-09-14 16:56:37 UTC, nickname: "David Czarnecki", text: "More text", type: "activity-type", updated_at: 2011-09-14 16:56:37 UTC, user_id: 1> 
+ruby-1.9.2-p290 :011 > feed = ActivityFeed::Feed.new(1)
+ => #<ActivityFeed::Feed:0x00000100c583d8 @feederboard=#<Leaderboard:0x00000100c58298 @leaderboard_name="activity:feed:1", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.12)>>> 
+ruby-1.9.2-p290 :012 > feed.page(1)
+ => [#<ActivityFeed::MongoMapper::Item _id: BSON::ObjectId('4e70dcc512dac1efa0000003'), created_at: 2011-09-14 16:56:37 UTC, nickname: "David Czarnecki", text: "More text", type: "activity-type", updated_at: 2011-09-14 16:56:37 UTC, user_id: 1>, #<ActivityFeed::MongoMapper::Item _id: BSON::ObjectId('4e70dcc512dac1efa0000001'), created_at: 2011-09-14 16:56:37 UTC, nickname: "David Czarnecki", text: "Text", type: "activity-type", updated_at: 2011-09-14 16:56:37 UTC, user_id: 1>] 
+ruby-1.9.2-p290 :013 > 
+```
+
+### Custom persistence
+
+ActivityFeed can also use a custom class to do more customization. You can set this using:
+
+```ruby
+ActivityFeed.persistence = :custom
+```
+
+This will try to load the following class:
+
+```ruby
+ActivityFeed::Custom::Item
+```
+
+If you set persistence to be `:foo`, it would try to load the following class:
+
+```ruby
+ActivityFeed::Foo::Item
+```
+
+The custom class should implement a find(item_or_item_id) method that does "the right thing". 
+Consult the specs to see this working if you have questions.
+
+## Contributing to Activity Feed
+
+* 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) 2011 David Czarnecki. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
+end
+
+task :default  => :spec

data/activity_feed.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'activity_feed/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'activity_feed'
+  s.version     = ActivityFeed::VERSION
+  s.authors     = ['David Czarnecki']
+  s.email       = ['dczarnecki@agoragames.com']
+  s.homepage    = 'https://github.com/agoragames/activity_feed'
+  s.summary     = %q{Activity feeds backed by Redis}
+  s.description = %q{Activity feeds backed by Redis}
+
+  s.rubyforge_project = 'activity_feed'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  
+  s.require_paths = ['lib']
+  
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('database_cleaner')
+  s.add_development_dependency('fabrication')
+  
+  s.add_development_dependency('mongo_mapper')
+  s.add_development_dependency('mongo_ext')
+  s.add_development_dependency('bson_ext')
+  
+  s.add_development_dependency('activerecord')
+  s.add_development_dependency('sqlite3')
+   
+  s.add_dependency('activesupport')
+  s.add_dependency('i18n')
+  
+  s.add_dependency('json')
+  s.add_dependency('redis')
+  s.add_dependency('leaderboard')
+end

data/lib/activity_feed.rb

@@ -0,0 +1,56 @@
+require 'activity_feed/version'
+require 'activity_feed/feed'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/inflector'
+
+require 'redis'
+
+module ActivityFeed
+  mattr_accessor :redis
+  mattr_accessor :namespace
+  mattr_accessor :key
+  mattr_accessor :persistence
+    
+  def self.persistence=(type = :memory)
+    @@persistence_type = type
+    
+    case type
+    when :memory
+      require 'activity_feed/memory/item'
+      klazz = ActivityFeed::Memory::Item      
+    when :mongo_mapper
+      require 'activity_feed/mongo_mapper/item'
+      klazz = ActivityFeed::MongoMapper::Item
+    when :active_record
+      require 'activity_feed/active_record/item'
+      klazz = ActivityFeed::ActiveRecord::Item
+    else
+      klazz = "ActivityFeed::#{type.to_s.classify}::Item".constantize
+    end
+    
+    @@persistence = klazz
+  end
+  
+  def self.create_item(attributes)
+    item = @@persistence.new(attributes)
+    item.save
+    item
+  end
+  
+  def self.load_item(item_or_item_id)
+    case @@persistence_type
+    when :memory
+      JSON.parse(item_or_item_id)
+    when :mongo_mapper
+      ActivityFeed::MongoMapper::Item.find(item_or_item_id)
+    when :active_record
+      ActivityFeed::ActiveRecord::Item.find(item_or_item_id)
+    else
+      @@persistence.find(item_or_item_id)    
+    end
+  end
+  
+  self.namespace = 'activity'
+  self.key = 'feed'
+  self.persistence = :memory
+end

data/lib/activity_feed/active_record/item.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+
+module ActivityFeed
+  module ActiveRecord
+    class Item < ::ActiveRecord::Base
+      set_table_name 'activity_feed_items'
+        
+      after_save :update_redis
+
+      private
+
+      def update_redis
+        ActivityFeed.redis.zadd("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{self.user_id}", self.created_at.to_i, self.id)
+      end
+    end
+  end
+end

data/lib/activity_feed/feed.rb

@@ -0,0 +1,26 @@
+require 'leaderboard'
+
+module ActivityFeed
+  class Feed
+    def initialize(user_id)
+      @feederboard = Leaderboard.new("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}", Leaderboard::DEFAULT_OPTIONS, {:redis_connection => ActivityFeed.redis})
+    end
+    
+    def page(page)
+      feed_items = []
+      @feederboard.leaders(page).each do |feed_item|
+        feed_items << ActivityFeed.load_item(feed_item[:member])
+      end
+
+      feed_items
+    end
+    
+    def total_pages
+      @feederboard.total_pages
+    end
+    
+    def total_items
+      @feederboard.total_members
+    end
+  end
+end

data/lib/activity_feed/memory/item.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/date_time/conversions'
+require 'json'
+
+module ActivityFeed
+  module Memory
+    class Item
+      attr_accessor :user_id
+      attr_accessor :nickname
+      attr_accessor :type
+      attr_accessor :title
+      attr_accessor :text
+      attr_accessor :url
+      attr_accessor :icon
+      attr_accessor :sticky
+
+      def initialize(attributes = {})
+        @attributes = attributes
+      
+        attributes.each do |key,value|
+          self.send("#{key}=", value)
+        end      
+      end
+    
+      def save
+        raise 'user_id MUST be defined in the attributes' if user_id.blank?
+      
+        ActivityFeed.redis.zadd("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{self.user_id}", DateTime.now.to_i, @attributes.to_json)
+      end
+    end
+  end
+end

data/lib/activity_feed/mongo_mapper/item.rb

@@ -0,0 +1,30 @@
+require 'mongo_mapper'
+
+module ActivityFeed
+  module MongoMapper
+    class Item
+      include ::MongoMapper::Document    
+
+      key :user_id, Integer, :required => true, :numeric => true
+      key :nickname, String
+      key :type, String
+      key :title, String
+      key :text, String
+      key :url, String
+      key :icon, String
+      key :sticky, Boolean
+
+      timestamps!
+
+      self.ensure_index(:user_id)
+
+      after_save :update_redis
+
+      private
+
+      def update_redis
+        ActivityFeed.redis.zadd("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{self.user_id}", self.created_at.to_i, self.id)
+      end
+    end
+  end
+end

data/lib/activity_feed/version.rb

@@ -0,0 +1,3 @@
+module ActivityFeed
+  VERSION = "1.0.0"
+end

data/spec/activity_feed/custom/item.rb

@@ -0,0 +1,32 @@
+module ActivityFeed
+  module Custom
+    class Item
+      attr_accessor :user_id
+      attr_accessor :nickname
+      attr_accessor :type
+      attr_accessor :title
+      attr_accessor :text
+      attr_accessor :url
+      attr_accessor :icon
+      attr_accessor :sticky
+
+      def initialize(attributes = {})
+        @attributes = attributes
+
+        attributes.each do |key,value|
+          self.send("#{key}=", value)
+        end      
+      end
+
+      def self.find(item)
+        JSON.parse(item)
+      end
+
+      def save
+        raise 'user_id MUST be defined in the attributes' if user_id.blank?
+
+        ActivityFeed.redis.zadd("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{self.user_id}", DateTime.now.to_i, @attributes.to_json)
+      end
+    end
+  end
+end

data/spec/activity_feed_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe ActivityFeed do
+  it 'should have defaults set for :namespace and :key' do
+    ActivityFeed.namespace.should eql('activity')
+    ActivityFeed.key.should eql('feed')
+    ActivityFeed.persistence = :memory
+    ActivityFeed.persistence.should be(ActivityFeed::Memory::Item)
+  end
+  
+  describe 'creating' do
+    it 'should allow you to create a new item using :memory' do
+      user_id = 1
+      ActivityFeed.persistence = :memory
+      
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(0)
+      ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(1)      
+    end
+    
+    it 'should allow you to create a new item using :mongo_mapper' do
+      user_id = 1
+      ActivityFeed.persistence = :mongo_mapper
+      
+      ActivityFeed::MongoMapper::Item.count.should be(0)
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(0)
+      ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(1)      
+      ActivityFeed::MongoMapper::Item.count.should be(1)
+    end
+
+    it 'should allow you to create a new item using :active_record' do
+      user_id = 1
+      ActivityFeed.persistence = :active_record
+      
+      ActivityFeed::ActiveRecord::Item.count.should be(0)
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(0)
+      ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(1)      
+      ActivityFeed::ActiveRecord::Item.count.should be(1)
+    end
+  end
+  
+  describe 'loading' do
+    it 'should allow you to load an item using :memory' do
+      user_id = 1
+      ActivityFeed.persistence = :memory
+      
+      item = ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      loaded_item = ActivityFeed.load_item(item.to_json)
+      loaded_item.should == JSON.parse(item.to_json)
+    end
+    
+    it 'should allow you to load an item using :mongo_mapper' do
+      user_id = 1
+      ActivityFeed.persistence = :mongo_mapper
+      
+      item = ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      loaded_item = ActivityFeed.load_item(item.id)
+      loaded_item.should == item
+    end
+
+    it 'should allow you to load an item using :active_record' do
+      user_id = 1
+      ActivityFeed.persistence = :active_record
+      
+      item = ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      loaded_item = ActivityFeed.load_item(item.id)
+      loaded_item.should == item
+    end
+  end
+  
+  describe 'custom persistence' do        
+    it 'should allow you to define a custom persistence handler class' do
+      ActivityFeed.persistence = :custom
+    end
+    
+    it 'should allow you to create a new item using a custom persistence handler class' do
+      user_id = 1
+      ActivityFeed.persistence = :custom
+
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(0)
+      ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(1)      
+    end
+    
+    it 'should allow you to load an item using a custom persistence handler class' do
+      user_id = 1
+      ActivityFeed.persistence = :custom
+      
+      item = ActivityFeed.create_item(:user_id => user_id, :text => 'This is text for my activity feed')
+      loaded_item = ActivityFeed.load_item(item.to_json)
+      loaded_item.should == JSON.parse(item.to_json)
+    end
+  end
+end

data/spec/fabricators/item_fabricator.rb

@@ -0,0 +1,32 @@
+Fabricator(ActivityFeed::ActiveRecord::Item) do
+  user_id { sequence(:user_id) }
+  nickname { sequence(:nickname) { |i| "nickname_#{i}" } }
+  type { 'activity' }
+  title { 'item title' }
+  text { 'feed item' }
+  url { 'http://url' }
+  icon { 'http://icon' }
+  sticky { false }
+end
+
+Fabricator(ActivityFeed::Memory::Item) do
+  user_id { sequence(:user_id) }
+  nickname { sequence(:nickname) { |i| "nickname_#{i}" } }
+  type { 'activity' }
+  title { 'item title' }
+  text { 'feed item' }
+  url { 'http://url' }
+  icon { 'http://icon' }
+  sticky { false }
+end
+
+Fabricator(ActivityFeed::MongoMapper::Item) do
+  user_id { sequence(:user_id) }
+  nickname { sequence(:nickname) { |i| "nickname_#{i}" } }
+  type { 'activity' }
+  title { 'item title' }
+  text { 'feed item' }
+  url { 'http://url' }
+  icon { 'http://icon' }
+  sticky { false }
+end

data/spec/feed_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe ActivityFeed::Feed do
+  it 'should pull up the correct list of ActivityFeed::Memory::Item when calling #page using :memory' do    
+    1.upto(5) do |index|
+      item = ActivityFeed.create_item(:user_id => 1, :nickname => 'nickname_1', :text => "text_#{index}")
+    end
+    
+    feed = ActivityFeed::Feed.new(1)
+    feed.page(1).size.should be(5)
+  end
+
+  it 'should pull up the correct list of ActivityFeed::MongoMapper::Item when calling #page using :mongo_mapper' do    
+    ActivityFeed.persistence = :mongo_mapper
+    ActivityFeed::MongoMapper::Item.count.should be(0)
+    1.upto(5) do |index|
+      item = ActivityFeed.create_item(:user_id => 1, :nickname => 'nickname_1', :text => "text_#{index}")
+    end
+    ActivityFeed::MongoMapper::Item.count.should be(5)
+    
+    feed = ActivityFeed::Feed.new(1)
+    feed.page(1).size.should be(5)
+  end
+  
+  it 'should return the correct number for #total_items' do
+    1.upto(3) do |index|
+      item = ActivityFeed.create_item(:user_id => 1, :nickname => 'nickname_1', :text => "text_#{index}")
+    end
+    
+    feed = ActivityFeed::Feed.new(1)
+    feed.total_items.should be(3)
+  end
+  
+  it 'should return the correct number for #total_pages' do
+    1.upto(Leaderboard::DEFAULT_PAGE_SIZE + 1) do |index|
+      item = ActivityFeed.create_item(:user_id => 1, :nickname => 'nickname_1', :text => "text_#{index}")
+    end
+    
+    feed = ActivityFeed::Feed.new(1)
+    feed.total_pages.should be(2)
+  end
+  
+  describe 'custom persistence' do
+    it 'should allow you to pull up the correct list of ActivityFeed::Custom::Item when calling #page using :custom' do
+      ActivityFeed.persistence = :custom
+      1.upto(5) do |index|
+        item = ActivityFeed.create_item(:user_id => 1, :nickname => 'nickname_1', :text => "text_#{index}")
+      end
+      
+      feed = ActivityFeed::Feed.new(1)
+      feed.page(1).size.should be(5)
+    end
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'ActivityFeed::Item' do
+  it 'should allow you to create a new Item' do
+    item = Fabricate.build(ActivityFeed.persistence)
+    item.save.should be_true
+  end
+  
+  it 'should allow for a large amount of text' do
+    item = Fabricate.build(ActivityFeed.persistence, :text => '*' * 8192)
+    item.text.should eql('*' * 8192)
+  end
+  
+  it 'should add the feed item ID to redis' do
+    item = Fabricate.build(ActivityFeed.persistence)
+          
+    ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{item.user_id}").should be(0)
+    item.save
+    ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{item.user_id}").should be(1)
+  end
+  
+  it 'should have default attributes for .title .url .icon and .sticky' do
+    item = Fabricate.build(ActivityFeed.persistence)
+    
+    item.title.should eql('item title')
+    item.url.should eql('http://url')
+    item.icon.should eql('http://icon')
+    item.sticky.should be_false
+  end
+  
+  it 'should not create a new item in Redis after saving, only on create' do
+    item = Fabricate.build(ActivityFeed::Memory::Item)
+    
+    ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{item.user_id}").should be(0)
+    item.save
+    ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{item.user_id}").should be(1)
+    
+    item.text = 'updated text'
+    item.save
+    ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{item.user_id}").should be(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rspec'
+require 'redis'
+require 'mongo_mapper'
+require 'database_cleaner'
+require 'fabrication'
+require 'json'
+
+$redis = Redis.new(:host => '127.0.0.1', :port => 6379)
+
+# TODO: Move to spec/mongo_mapper
+MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+MongoMapper.database = 'activity_feed_gem_test'
+
+# TODO: Move to spec/active_record
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :activity_feed_items, :force => true do |t|
+    t.integer :user_id
+    t.string :nickname
+    t.string :type
+    t.string :title
+    t.text :text
+    t.string :url
+    t.string :icon
+    t.boolean :sticky
+    
+    t.timestamps
+  end
+
+  add_index :activity_feed_items, :user_id
+end
+
+DatabaseCleaner[:active_record].strategy = :transaction
+DatabaseCleaner[:mongo_mapper].strategy = :truncation
+
+require 'activity_feed'
+
+ActivityFeed.redis = $redis
+
+require 'activity_feed/custom/item'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+    $redis.flushdb
+  end
+
+  config.before(:each) do
+    ActivityFeed.persistence = :memory
+    DatabaseCleaner.start
+    DatabaseCleaner.clean
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+    $redis.flushdb
+  end  
+end

data/spec/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ActivityFeed do
+  it "should be the correct version" do
+    ActivityFeed::VERSION.should == '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification 
+name: activity_feed
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Czarnecki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fabrication
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mongo_ext
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: leaderboard
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id014
+description: Activity feeds backed by Redis
+email: 
+- dczarnecki@agoragames.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- CHANGELOG.markdown
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- activity_feed.gemspec
+- lib/activity_feed.rb
+- lib/activity_feed/active_record/item.rb
+- lib/activity_feed/feed.rb
+- lib/activity_feed/memory/item.rb
+- lib/activity_feed/mongo_mapper/item.rb
+- lib/activity_feed/version.rb
+- spec/activity_feed/custom/item.rb
+- spec/activity_feed_spec.rb
+- spec/fabricators/item_fabricator.rb
+- spec/feed_spec.rb
+- spec/item_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+homepage: https://github.com/agoragames/activity_feed
+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: activity_feed
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Activity feeds backed by Redis
+test_files: 
+- spec/activity_feed/custom/item.rb
+- spec/activity_feed_spec.rb
+- spec/fabricators/item_fabricator.rb
+- spec/feed_spec.rb
+- spec/item_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb