activity_feed 1.0.0 → 1.1.0

data/CHANGELOG.markdown

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.1.0
+
+* Added support for Ohm persistence, http://ohm.keyvalue.org
+* Updated specs
+
 ## 1.0.0
 
 * Initial release

data/README.markdown

@@ -23,7 +23,7 @@ check out the Redis documentation, http://redis.io/documentation.
 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)
+ActivityFeed.persistence = :memory # (or :active_record or :mongo_mapper or :ohm)
 ```
 
 ## Usage
@@ -167,6 +167,32 @@ ruby-1.9.2-p290 :012 > feed.page(1)
 ruby-1.9.2-p290 :013 > 
 ```
 
+### Ohm-backed persistence
+
+ActivityFeed can also use Ohm to persist the items in Redis. You can set this using:
+
+```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.5)> 
+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.5)> 
+ruby-1.9.2-p290 :005 > ActivityFeed.persistence = :ohm
+ => :ohm 
+ruby-1.9.2-p290 :006 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'Text')
+ => #<ActivityFeed::Ohm::Item:1 created_at="2011-10-08 17:40:03 UTC" updated_at="2011-10-08 17:40:03 UTC" user_id=1 nickname="David Czarnecki" type="activity-type" title=nil text="Text" url=nil icon=nil sticky=nil> 
+ruby-1.9.2-p290 :007 > ActivityFeed.create_item(:user_id => 1, :nickname => 'David Czarnecki', :type => 'activity-type', :text => 'More text')
+ => #<ActivityFeed::Ohm::Item:2 created_at="2011-10-08 17:40:25 UTC" updated_at="2011-10-08 17:40:25 UTC" user_id=1 nickname="David Czarnecki" type="activity-type" title=nil text="More text" url=nil icon=nil sticky=nil> 
+ruby-1.9.2-p290 :008 > feed = ActivityFeed::Feed.new(1)
+ => #<ActivityFeed::Feed:0x007fd009bc05f8 @feederboard=#<Leaderboard:0x007fd009bc0508 @leaderboard_name="activity:feed:1", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.5)>>> 
+ruby-1.9.2-p290 :009 > feed.page(1)
+ => [#<ActivityFeed::Ohm::Item:2 created_at="2011-10-08 17:40:25 UTC" updated_at="2011-10-08 17:40:25 UTC" user_id="1" nickname="David Czarnecki" type="activity-type" title=nil text="More text" url=nil icon=nil sticky=nil>, #<ActivityFeed::Ohm::Item:1 created_at="2011-10-08 17:40:03 UTC" updated_at="2011-10-08 17:40:03 UTC" user_id="1" nickname="David Czarnecki" type="activity-type" title=nil text="Text" url=nil icon=nil sticky=nil>] 
+ruby-1.9.2-p290 :010 > 
+```
+
 ### Custom persistence
 
 ActivityFeed can also use a custom class to do more customization. You can set this using:

data/activity_feed.gemspec

@@ -30,8 +30,12 @@ Gem::Specification.new do |s|
   
   s.add_development_dependency('activerecord')
   s.add_development_dependency('sqlite3')
+  
+  s.add_development_dependency('ohm')
+  s.add_development_dependency('ohm-contrib')
    
   s.add_dependency('activesupport')
+  s.add_dependency('activemodel')
   s.add_dependency('i18n')
   
   s.add_dependency('json')

data/lib/activity_feed.rb

@@ -15,15 +15,18 @@ module ActivityFeed
     @@persistence_type = type
     
     case type
+    when :active_record
+      require 'activity_feed/active_record/item'
+      klazz = ActivityFeed::ActiveRecord::Item
     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
+    when :ohm
+      require 'activity_feed/ohm/item'
+      klazz = ActivityFeed::Ohm::Item
     else
       klazz = "ActivityFeed::#{type.to_s.classify}::Item".constantize
     end
@@ -39,12 +42,14 @@ module ActivityFeed
   
   def self.load_item(item_or_item_id)
     case @@persistence_type
+    when :active_record
+      ActivityFeed::ActiveRecord::Item.find(item_or_item_id)
     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)
+    when :ohm
+      ActivityFeed::Ohm::Item[item_or_item_id]
     else
       @@persistence.find(item_or_item_id)    
     end

data/lib/activity_feed/ohm/item.rb

@@ -0,0 +1,28 @@
+require 'ohm'
+require 'ohm/contrib'
+
+module ActivityFeed
+  module Ohm
+    class Item < ::Ohm::Model
+      include ::Ohm::Callbacks
+      include ::Ohm::Timestamping
+      
+      attribute :user_id
+      attribute :nickname
+      attribute :type
+      attribute :title
+      attribute :text
+      attribute :url
+      attribute :icon
+      attribute :sticky      
+      
+      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

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

data/spec/activity_feed_spec.rb

@@ -39,6 +39,17 @@ describe ActivityFeed do
       ActivityFeed.redis.zcard("#{ActivityFeed.namespace}:#{ActivityFeed.key}:#{user_id}").should be(1)      
       ActivityFeed::ActiveRecord::Item.count.should be(1)
     end
+
+    it 'should allow you to create a new item using :ohm' do
+      user_id = 1
+      ActivityFeed.persistence = :ohm
+      
+      ActivityFeed::Ohm::Item.all.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::Ohm::Item.all.count.should be(1)
+    end
   end
   
   describe 'loading' do
@@ -68,6 +79,15 @@ describe ActivityFeed do
       loaded_item = ActivityFeed.load_item(item.id)
       loaded_item.should == item
     end
+
+    it 'should allow you to load an item using :ohm' do
+      user_id = 1
+      ActivityFeed.persistence = :ohm
+      
+      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        

data/spec/fabricators/item_fabricator.rb

@@ -30,3 +30,14 @@ Fabricator(ActivityFeed::MongoMapper::Item) do
   icon { 'http://icon' }
   sticky { false }
 end
+
+Fabricator(ActivityFeed::Ohm::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

@@ -10,6 +10,18 @@ describe ActivityFeed::Feed do
     feed.page(1).size.should be(5)
   end
 
+  it 'should pull up the correct list of ActivityFeed::ActiveRecord::Item when calling #page using :active_record' do    
+    ActivityFeed.persistence = :active_record
+    ActivityFeed::ActiveRecord::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::ActiveRecord::Item.count.should be(5)
+    
+    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)
@@ -21,6 +33,18 @@ describe ActivityFeed::Feed do
     feed = ActivityFeed::Feed.new(1)
     feed.page(1).size.should be(5)
   end
+
+  it 'should pull up the correct list of ActivityFeed::Ohm::Item when calling #page using :ohm' do    
+    ActivityFeed.persistence = :ohm
+    ActivityFeed::Ohm::Item.all.count.should be(0)
+    1.upto(5) do |index|
+      item = ActivityFeed.create_item(:user_id => 1, :nickname => 'nickname_1', :text => "text_#{index}")
+    end
+    ActivityFeed::Ohm::Item.all.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|

data/spec/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe ActivityFeed do
   it "should be the correct version" do
-    ActivityFeed::VERSION.should == '1.0.0'
+    ActivityFeed::VERSION.should == '1.1.0'
   end
 end

metadata

@@ -1,181 +1,210 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: activity_feed
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70104353383360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353383360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70104353382940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353382940
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70104353382520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353382520
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: &70104353382100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353382100
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &70104353381680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353381680
+- !ruby/object:Gem::Dependency
+  name: mongo_ext
+  requirement: &70104353381260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353381260
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70104353380840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353380840
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70104353380420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70104353380420
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: &70104353380000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70104353380000
+- !ruby/object:Gem::Dependency
+  name: ohm
+  requirement: &70104353379580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *70104353379580
+- !ruby/object:Gem::Dependency
+  name: ohm-contrib
+  requirement: &70104353379160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70104353379160
+- !ruby/object:Gem::Dependency
   name: activesupport
+  requirement: &70104353378740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *70104353378740
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70104353378320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353378320
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70104353377900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353377900
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70104353377480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353377480
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70104353377060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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 
+  version_requirements: *70104353377060
+- !ruby/object:Gem::Dependency
+  name: leaderboard
+  requirement: &70104353376640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id014
+  prerelease: false
+  version_requirements: *70104353376640
 description: Activity feeds backed by Redis
-email: 
+email:
 - dczarnecki@agoragames.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - CHANGELOG.markdown
@@ -189,6 +218,7 @@ files:
 - lib/activity_feed/feed.rb
 - lib/activity_feed/memory/item.rb
 - lib/activity_feed/mongo_mapper/item.rb
+- lib/activity_feed/ohm/item.rb
 - lib/activity_feed/version.rb
 - spec/activity_feed/custom/item.rb
 - spec/activity_feed_spec.rb
@@ -199,32 +229,29 @@ files:
 - spec/version_spec.rb
 homepage: https://github.com/agoragames/activity_feed
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: activity_feed
-rubygems_version: 1.8.11
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Activity feeds backed by Redis
-test_files: 
+test_files:
 - spec/activity_feed/custom/item.rb
 - spec/activity_feed_spec.rb
 - spec/fabricators/item_fabricator.rb