activity_feed 2.0.0 → 2.1.0

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.1.0 (2012-08-13)
+
+* Added `full_feed(user_id, aggregate = ActivityFeed.aggregate)` method to be able to retrieve an entire activity feed
+
 ## 2.0.0 (2012-06-29)
 
 * Rewrite of the activity_feed gem

data/README.markdown

@@ -1,6 +1,6 @@
 # ActivityFeed
 
-Activity feeds backed by Redis. Activity feeds may also be referred to as timelines or 
+Activity feeds backed by Redis. Activity feeds may also be referred to as timelines or
 news feeds.
 
 ## Compatibility
@@ -15,7 +15,7 @@ or:
 
 `gem 'activity_feed'`
 
-Make sure your redis server is running! Redis configuration is outside the scope of this README, but 
+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
@@ -54,7 +54,7 @@ require 'mongoid'
 module ActivityFeed
   module Mongoid
     class Item
-      include ::Mongoid::Document    
+      include ::Mongoid::Document
       include ::Mongoid::Timestamps
 
       field :user_id, type: String
@@ -70,7 +70,7 @@ module ActivityFeed
 
       index :user_id
 
-      after_save :update_item_in_activity_feed    
+      after_save :update_item_in_activity_feed
 
       private
 
@@ -95,8 +95,8 @@ If you need to handle any exceptions when loading activity feed items, please do
 ### Developing an Activity Feed for an Individual
 
 Below is a complete example using Mongoid as our persistent storage for activity feed items.
-The example uses callbacks to update and remove items from the activity feed. As this example 
-uses the `updated_at` time of the item, updated items will "bubble up" to the top of the 
+The example uses callbacks to update and remove items from the activity feed. As this example
+uses the `updated_at` time of the item, updated items will "bubble up" to the top of the
 activity feed.
 
 ```ruby
@@ -111,7 +111,7 @@ end
 module ActivityFeed
   module Mongoid
     class Item
-      include ::Mongoid::Document    
+      include ::Mongoid::Document
       include ::Mongoid::Timestamps
 
       field :user_id, type: String
@@ -157,7 +157,7 @@ end
 
 # Create a couple of activity feed items
 activity_item_1 = ActivityFeed::Mongoid::Item.create(
-  :user_id => 'david', 
+  :user_id => 'david',
   :nickname => 'David Czarnecki',
   :type => 'some_activity',
   :title => 'Great activity',
@@ -166,7 +166,7 @@ activity_item_1 = ActivityFeed::Mongoid::Item.create(
 )
 
 activity_item_2 = ActivityFeed::Mongoid::Item.create(
-  :user_id => 'david', 
+  :user_id => 'david',
   :nickname => 'David Czarnecki',
   :type => 'some_activity',
   :title => 'Another great activity',
@@ -176,7 +176,7 @@ activity_item_2 = ActivityFeed::Mongoid::Item.create(
 
 # Pull up the activity feed
 feed = ActivityFeed.feed('david', 1)
- => [#<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000004, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:08:22 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Another great activity", text: "This is some other text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>, #<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000003, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:08:22 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Great activity", text: "This is text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>] 
+ => [#<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000004, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:08:22 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Another great activity", text: "This is some other text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>, #<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000003, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:08:22 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Great activity", text: "This is text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>]
 
 # Update an actitivity feed item
 activity_item_1.text = 'Updated some text for the activity feed item'
@@ -184,7 +184,7 @@ activity_item_1.save
 
 # Pull up the activity feed item and notice that the item you updated has "bubbled up" to the top of the feed
 feed = ActivityFeed.feed('david', 1)
- => [#<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000003, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:11:27 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Great activity", text: "Updated some text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>, #<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000004, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:08:22 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Another great activity", text: "This is some other text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>] 
+ => [#<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000003, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:11:27 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Great activity", text: "Updated some text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>, #<ActivityFeed::Mongoid::Item _id: 4fe0ce26421aa91fc2000004, _type: nil, created_at: 2012-06-19 19:08:22 UTC, updated_at: 2012-06-19 19:08:22 UTC, user_id: "david", nickname: "David Czarnecki", type: "some_activity", title: "Another great activity", text: "This is some other text for the activity feed item", url: "http://url.com", icon: nil, sticky: nil>]
 ```
 
 ### Developing an Aggregate Activity Feed for an Individual
@@ -201,7 +201,7 @@ end
 module ActivityFeed
   module Mongoid
     class Item
-      include ::Mongoid::Document    
+      include ::Mongoid::Document
       include ::Mongoid::Timestamps
 
       field :user_id, type: String
@@ -251,7 +251,7 @@ end
     :text => "This is from unknown's activity feed"
   )
 
-  sleep(1) 
+  sleep(1)
 
   ActivityFeed.aggregate_item('david', another_item.id, another_item.updated_at.to_i)
 end
@@ -272,8 +272,8 @@ pp feed = ActivityFeed.feed('david', 1, true)
 
 ## ActivityFeed Caveats
 
-`ActivityFeed.remove_item` can ONLY remove items from a single user's activity feed. If you allow activity feed 
-items to be deleted from a user's activity feed, you will need to propagate that delete out to all the other 
+`ActivityFeed.remove_item` can ONLY remove items from a single user's activity feed. If you allow activity feed
+items to be deleted from a user's activity feed, you will need to propagate that delete out to all the other
 feeds in which that activity feed item may have been aggregated.
 
 ## ActivityFeed method summary
@@ -288,6 +288,7 @@ ActivityFeed.remove_item(user_id, item_id)
 # Feed-related
 
 ActivityFeed.feed(user_id, page, aggregate = ActivityFeed.aggregate)
+ActivityFeed.full_feed(user_id, aggregate = ActivityFeed.aggregate)
 ActivityFeed.feed_between_timestamps(user_id, starting_timestamp, ending_timestamp, aggregate = ActivityFeed.aggregate)
 ActivityFeed.total_pages_in_feed(user_id, aggregate = ActivityFeed.aggregate, page_size = ActivityFeed.page_size)
 ActivityFeed.total_items_in_feed(user_id, aggregate = ActivityFeed.aggregate)

data/lib/activity_feed/feed.rb

@@ -1,14 +1,14 @@
 module ActivityFeed
   module Feed
-    # Retrieve a page from the activity feed for a given +user_id+. You can configure 
-    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example, 
-    # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the page 
+    # Retrieve a page from the activity feed for a given +user_id+. You can configure
+    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example,
+    # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the page
     # returned with loaded items rather than item IDs.
     #
     # @param user_id [String] User ID.
     # @param page [int] Page in the feed to be retrieved.
     # @param aggregate [boolean, false] Whether to retrieve the aggregate feed for +user_id+.
-    # 
+    #
     # @return page from the activity feed for a given +user_id+.
     def feed(user_id, page, aggregate = ActivityFeed.aggregate)
       feederboard = ActivityFeed.feederboard_for(user_id, aggregate)
@@ -26,17 +26,42 @@ module ActivityFeed
       feed.nil? ? [] : feed
     end
 
-    # Retrieve a page from the activity feed for a given +user_id+ between a 
-    # +starting_timestamp+ and an +ending_timestamp+. You can configure 
-    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example, 
-    # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the feed data  
+    # Retrieve the entire activity feed for a given +user_id+. You can configure
+    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example,
+    # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the page
+    # returned with loaded items rather than item IDs.
+    #
+    # @param user_id [String] User ID.
+    # @param aggregate [boolean, false] Whether to retrieve the aggregate feed for +user_id+.
+    #
+    # @return the full activity feed for a given +user_id+.
+    def full_feed(user_id, aggregate = ActivityFeed.aggregate)
+      feederboard = ActivityFeed.feederboard_for(user_id, aggregate)
+      feed = feederboard.leaders(1, :page_size => feederboard.total_members).inject([]) do |feed_items, feed_item|
+        item = if ActivityFeed.item_loader
+          ActivityFeed.item_loader.call(feed_item[:member])
+        else
+          feed_item[:member]
+        end
+
+        feed_items << item unless item.nil?
+        feed_items
+      end
+
+      feed.nil? ? [] : feed
+    end
+
+    # Retrieve a page from the activity feed for a given +user_id+ between a
+    # +starting_timestamp+ and an +ending_timestamp+. You can configure
+    # +ActivityFeed.item_loader+ with a Proc to retrieve an item from, for example,
+    # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the feed data
     # returned with loaded items rather than item IDs.
     #
     # @param user_id [String] User ID.
     # @param starting_timestamp [int] Starting timestamp between which items in the feed are to be retrieved.
     # @param ending_timestamp [int] Ending timestamp between which items in the feed are to be retrieved.
     # @param aggregate [boolean, false] Whether to retrieve items from the aggregate feed for +user_id+.
-    # 
+    #
     # @return feed items from the activity feed for a given +user_id+ between the +starting_timestamp+ and +ending_timestamp+.
     def feed_between_timestamps(user_id, starting_timestamp, ending_timestamp, aggregate = ActivityFeed.aggregate)
       feederboard = ActivityFeed.feederboard_for(user_id, aggregate)

data/lib/activity_feed/version.rb

@@ -1,3 +1,3 @@
 module ActivityFeed
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/activity_feed/feed_spec.rb

@@ -25,6 +25,30 @@ describe ActivityFeed::Feed do
     end
   end
 
+  describe '#full_feed' do
+    describe 'without aggregation' do
+      it 'should return the full activity feed' do
+        add_items_to_feed('david', 30)
+
+        feed = ActivityFeed.full_feed('david', false)
+        feed.length.should == 30
+        feed[0].to_i.should == 30
+        feed[29].to_i.should == 1
+      end
+    end
+
+    describe 'with aggregation' do
+      it 'should return the full activity feed' do
+        add_items_to_feed('david', 30, true)
+
+        feed = ActivityFeed.full_feed('david', true)
+        feed.length.should == 30
+        feed[0].to_i.should == 30
+        feed[29].to_i.should == 1
+      end
+    end
+  end
+
   describe '#feed_between_timestamps' do
     describe 'without aggregation' do
       it 'should return activity feed items between the starting and ending timestamps' do
@@ -176,15 +200,15 @@ describe ActivityFeed::Feed do
   describe 'ORM or ODM loading' do
     describe 'ActiveRecord' do
       it 'should be able to load an item via ActiveRecord when requesting a feed' do
-        ActivityFeed.item_loader = Proc.new do |id| 
+        ActivityFeed.item_loader = Proc.new do |id|
           ActivityFeed::ActiveRecord::Item.find(id)
         end
-      
+
         feed = ActivityFeed.feed('david', 1)
         feed.length.should == 0
 
         item = ActivityFeed::ActiveRecord::Item.create(
-          :user_id => 'david', 
+          :user_id => 'david',
           :nickname => 'David Czarnecki',
           :type => 'some_activity',
           :title => 'Great activity',
@@ -200,12 +224,12 @@ describe ActivityFeed::Feed do
     describe 'Mongoid' do
       it 'should be able to load an item via Mongoid when requesting a feed' do
         ActivityFeed.item_loader = Proc.new { |id| ActivityFeed::Mongoid::Item.find(id) }
-      
+
         feed = ActivityFeed.feed('david', 1)
         feed.length.should == 0
 
         item = ActivityFeed::Mongoid::Item.create(
-          :user_id => 'david', 
+          :user_id => 'david',
           :nickname => 'David Czarnecki',
           :type => 'some_activity',
           :title => 'Great activity',
@@ -242,7 +266,7 @@ describe ActivityFeed::Feed do
         end
 
         item = ActivityFeed::Mongoid::Item.create(
-          :user_id => 'david', 
+          :user_id => 'david',
           :nickname => 'David Czarnecki',
           :type => 'some_activity',
           :title => 'Great activity',
@@ -253,7 +277,7 @@ describe ActivityFeed::Feed do
         ActivityFeed.update_item('david', '4fe4c5f3421aa9b89c000001', DateTime.now.to_i)
 
         another_item = ActivityFeed::Mongoid::Item.create(
-          :user_id => 'david', 
+          :user_id => 'david',
           :nickname => 'David Czarnecki',
           :type => 'some_activity',
           :title => 'Great activity',

data/spec/version_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activity_feed
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -215,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1134823681499475640
+      hash: -2201344879016856649
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1134823681499475640
+      hash: -2201344879016856649
 requirements: []
 rubyforge_project: activity_feed
 rubygems_version: 1.8.24