activity_feed 2.2.0 → 2.2.2

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.2.1 (2012-08-27)
+
+* Added `total_pages` and `total_items` as aliases for `total_pages_in_feed` and `total_items_in_feed`, respectively.
+
 ## 2.2.0 (2012-08-20)
 
 * Added `expire_feed(user_id, seconds, aggregate = ActivityFeed.aggregate)` and `expire_feed_at(user_id, timestamp, aggregate = ActivityFeed.aggregate)` methods to expire an activity feed after a given number of seconds or at a given time stamp, respectively.

data/README.markdown

@@ -282,6 +282,9 @@ feeds in which that activity feed item may have been aggregated.
 # Item-related
 
 ActivityFeed.update_item(user_id, item_id, timestamp, aggregate = ActivityFeed.aggregate)
+ActivityFeed.add_item(user_id, item_id, timestamp, aggregate = ActivityFeed.aggregate)
+# add_item is an alias for update_item
+
 ActivityFeed.aggregate_item(user_id, item_id, timestamp)
 ActivityFeed.remove_item(user_id, item_id)
 
@@ -291,7 +294,9 @@ 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_pages(user_id, aggregate = ActivityFeed.aggregate, page_size = ActivityFeed.page_size)
 ActivityFeed.total_items_in_feed(user_id, aggregate = ActivityFeed.aggregate)
+ActivityFeed.total_items(user_id, aggregate = ActivityFeed.aggregate)
 ActivityFeed.trim_feed(user_id, starting_timestamp, ending_timestamp, aggregate = ActivityFeed.aggregate)
 ActivityFeed.expire_feed(user_id, seconds, aggregate = ActivityFeed.aggregate)
 ActivityFeed.expire_feed_at(user_id, timestamp, aggregate = ActivityFeed.aggregate)

data/lib/activity_feed/feed.rb

@@ -90,6 +90,8 @@ module ActivityFeed
       ActivityFeed.feederboard_for(user_id, aggregate).total_pages_in(ActivityFeed.feed_key(user_id, aggregate), page_size)
     end
 
+    alias_method :total_pages, :total_pages_in_feed
+
     # Return the total number of items in the activity feed.
     #
     # @param user_id [String] User ID.
@@ -100,6 +102,8 @@ module ActivityFeed
       ActivityFeed.feederboard_for(user_id, aggregate).total_members
     end
 
+    alias_method :total_items, :total_items_in_feed
+
     # Remove the activity feeds for a given +user_id+.
     #
     # @param user_id [String] User ID.

data/lib/activity_feed/item.rb

@@ -16,8 +16,10 @@ module ActivityFeed
       end
     end
 
-    # Specifically aggregate an item in the activity feed for a given +user_id+. 
-    # This is useful if you are going to background the process of populating 
+    alias_method :add_item, :update_item
+
+    # Specifically aggregate an item in the activity feed for a given +user_id+.
+    # This is useful if you are going to background the process of populating
     # a user's activity feed from friend's activities.
     #
     # @param user_id [String] User ID.
@@ -28,10 +30,10 @@ module ActivityFeed
       feederboard.rank_member(item_id, timestamp)
     end
 
-    # Remove an item from the activity feed for a given +user_id+. This 
+    # Remove an item from the activity feed for a given +user_id+. This
     # will also remove the item from the aggregate activity feed for the
     # user.
-    # 
+    #
     # @param user_id [String] User ID.
     # @param item_id [String] Item ID.
     def remove_item(user_id, item_id)

data/lib/activity_feed/version.rb

@@ -1,3 +1,3 @@
 module ActivityFeed
-  VERSION = "2.2.0"
+  VERSION = "2.2.2"
 end

data/spec/activity_feed/configuration_spec.rb

@@ -4,10 +4,10 @@ describe ActivityFeed::Configuration do
   describe '#configure' do
     it 'should have default attributes' do
       ActivityFeed.configure do |configuration|
-        configuration.namespace.should == 'activity_feed'
+        configuration.namespace.should eql('activity_feed')
         configuration.aggregate.should be_false
-        configuration.aggregate_key.should == 'aggregate'
-        configuration.page_size.should== 25
+        configuration.aggregate_key.should eql('aggregate')
+        configuration.page_size.should eql(25)
       end
     end
   end

data/spec/activity_feed/feed_spec.rb

@@ -7,9 +7,9 @@ describe ActivityFeed::Feed do
         add_items_to_feed('david')
 
         feed = ActivityFeed.feed('david', 1)
-        feed.length.should == 5
-        feed[0].to_i.should == 5
-        feed[4].to_i.should == 1
+        feed.length.should eql(5)
+        feed[0].to_i.should eql(5)
+        feed[4].to_i.should eql(1)
       end
     end
 
@@ -18,9 +18,9 @@ describe ActivityFeed::Feed do
         add_items_to_feed('david', 5, true)
 
         feed = ActivityFeed.feed('david', 1, true)
-        feed.length.should == 5
-        feed[0].to_i.should == 5
-        feed[4].to_i.should == 1
+        feed.length.should eql(5)
+        feed[0].to_i.should eql(5)
+        feed[4].to_i.should eql(1)
       end
     end
   end
@@ -31,9 +31,9 @@ describe ActivityFeed::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
+        feed.length.should eql(30)
+        feed[0].to_i.should eql(30)
+        feed[29].to_i.should eql(1)
       end
     end
 
@@ -42,9 +42,9 @@ describe ActivityFeed::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
+        feed.length.should eql(30)
+        feed[0].to_i.should eql(30)
+        feed[29].to_i.should eql(1)
       end
     end
   end
@@ -65,9 +65,9 @@ describe ActivityFeed::Feed do
         Timecop.return
 
         feed = ActivityFeed.feed_between_timestamps('david', Time.local(2012, 6, 19, 4, 43, 0).to_i, Time.local(2012, 6, 19, 8, 16, 0).to_i)
-        feed.length.should == 2
-        feed[0].to_i.should == 4
-        feed[1].to_i.should == 3
+        feed.length.should eql(2)
+        feed[0].to_i.should eql(4)
+        feed[1].to_i.should eql(3)
       end
     end
 
@@ -86,19 +86,20 @@ describe ActivityFeed::Feed do
         Timecop.return
 
         feed = ActivityFeed.feed_between_timestamps('david', Time.local(2012, 6, 19, 4, 43, 0).to_i, Time.local(2012, 6, 19, 8, 16, 0).to_i, true)
-        feed.length.should == 2
-        feed[0].to_i.should == 4
-        feed[1].to_i.should == 3
+        feed.length.should eql(2)
+        feed[0].to_i.should eql(4)
+        feed[1].to_i.should eql(3)
       end
     end
   end
 
-  describe '#total_pages_in_feed' do
+  describe '#total_pages_in_feed and #total_pages' do
     describe 'without aggregation' do
       it 'should return the correct number of pages in the activity feed' do
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1)
 
-        ActivityFeed.total_pages_in_feed('david').should == 2
+        ActivityFeed.total_pages_in_feed('david').should eql(2)
+        ActivityFeed.total_pages('david').should eql(2)
       end
     end
 
@@ -106,7 +107,8 @@ describe ActivityFeed::Feed do
       it 'should return the correct number of pages in the aggregate activity feed' do
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1, true)
 
-        ActivityFeed.total_pages_in_feed('david', true).should == 2
+        ActivityFeed.total_pages_in_feed('david', true).should eql(2)
+        ActivityFeed.total_pages('david', true).should eql(2)
       end
     end
 
@@ -114,7 +116,8 @@ describe ActivityFeed::Feed do
       it 'should return the correct number of pages in the activity feed' do
         add_items_to_feed('david', 25)
 
-        ActivityFeed.total_pages_in_feed('david', false, 4).should == 7
+        ActivityFeed.total_pages_in_feed('david', false, 4).should eql(7)
+        ActivityFeed.total_pages('david', false, 4).should eql(7)
       end
     end
   end
@@ -123,22 +126,23 @@ describe ActivityFeed::Feed do
     it 'should remove the activity feeds for a given user ID' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1, true)
 
-      ActivityFeed.total_items_in_feed('david').should == Leaderboard::DEFAULT_PAGE_SIZE + 1
-      ActivityFeed.total_items_in_feed('david', true).should == Leaderboard::DEFAULT_PAGE_SIZE + 1
+      ActivityFeed.total_items_in_feed('david').should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
+      ActivityFeed.total_items_in_feed('david', true).should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
 
       ActivityFeed.remove_feeds('david')
 
-      ActivityFeed.total_items_in_feed('david').should == 0
-      ActivityFeed.total_items_in_feed('david', true).should == 0
+      ActivityFeed.total_items_in_feed('david').should eql(0)
+      ActivityFeed.total_items_in_feed('david', true).should eql(0)
     end
   end
 
-  describe '#total_items_in_feed' do
+  describe '#total_items_in_feed and #total_items' do
     describe 'without aggregation' do
       it 'should return the correct number of items in the activity feed' do
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1)
 
-        ActivityFeed.total_items_in_feed('david').should == Leaderboard::DEFAULT_PAGE_SIZE + 1
+        ActivityFeed.total_items_in_feed('david').should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
+        ActivityFeed.total_items('david').should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
       end
     end
 
@@ -146,7 +150,8 @@ describe ActivityFeed::Feed do
       it 'should return the correct number of items in the aggregate activity feed' do
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1, true)
 
-        ActivityFeed.total_items_in_feed('david', true).should == Leaderboard::DEFAULT_PAGE_SIZE + 1
+        ActivityFeed.total_items_in_feed('david', true).should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
+        ActivityFeed.total_items('david', true).should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
       end
     end
   end
@@ -154,45 +159,45 @@ describe ActivityFeed::Feed do
   describe '#trim_feed' do
     describe 'without aggregation' do
       it 'should trim activity feed items between the starting and ending timestamps' do
-        t1 = Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
         ActivityFeed.update_item('david', 1, DateTime.now.to_i)
-        t2 = Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
         ActivityFeed.update_item('david', 2, DateTime.now.to_i)
-        t3 = Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
         ActivityFeed.update_item('david', 3, DateTime.now.to_i)
-        t4 = Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
         ActivityFeed.update_item('david', 4, DateTime.now.to_i)
-        t5 = Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
         ActivityFeed.update_item('david', 5, DateTime.now.to_i)
         Timecop.return
 
         ActivityFeed.trim_feed('david', Time.local(2012, 6, 19, 4, 29, 0).to_i, Time.local(2012, 6, 19, 8, 16, 0).to_i)
         feed = ActivityFeed.feed('david', 1)
-        feed.length.should == 2
-        feed[0].to_i.should == 5
-        feed[1].to_i.should == 1
+        feed.length.should eql(2)
+        feed[0].to_i.should eql(5)
+        feed[1].to_i.should eql(1)
       end
     end
 
     describe 'with aggregation' do
       it 'should trim activity feed items between the starting and ending timestamps' do
-        t1 = Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
         ActivityFeed.update_item('david', 1, DateTime.now.to_i, true)
-        t2 = Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
         ActivityFeed.update_item('david', 2, DateTime.now.to_i, true)
-        t3 = Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
         ActivityFeed.update_item('david', 3, DateTime.now.to_i, true)
-        t4 = Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
         ActivityFeed.update_item('david', 4, DateTime.now.to_i, true)
-        t5 = Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
+        Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
         ActivityFeed.update_item('david', 5, DateTime.now.to_i, true)
         Timecop.return
 
         ActivityFeed.trim_feed('david', Time.local(2012, 6, 19, 4, 29, 0).to_i, Time.local(2012, 6, 19, 8, 16, 0).to_i, true)
         feed = ActivityFeed.feed('david', 1, true)
-        feed.length.should == 2
-        feed[0].to_i.should == 5
-        feed[1].to_i.should == 1
+        feed.length.should eql(2)
+        feed[0].to_i.should eql(5)
+        feed[1].to_i.should eql(1)
       end
     end
   end
@@ -205,7 +210,7 @@ describe ActivityFeed::Feed do
         end
 
         feed = ActivityFeed.feed('david', 1)
-        feed.length.should == 0
+        feed.length.should eql(0)
 
         item = ActivityFeed::ActiveRecord::Item.create(
           :user_id => 'david',
@@ -216,7 +221,7 @@ describe ActivityFeed::Feed do
         )
 
         feed = ActivityFeed.feed('david', 1)
-        feed.length.should == 1
+        feed.length.should eql(1)
         feed[0].should == item
       end
     end
@@ -226,7 +231,7 @@ describe ActivityFeed::Feed do
         ActivityFeed.item_loader = Proc.new { |id| ActivityFeed::Mongoid::Item.find(id) }
 
         feed = ActivityFeed.feed('david', 1)
-        feed.length.should == 0
+        feed.length.should eql(0)
 
         item = ActivityFeed::Mongoid::Item.create(
           :user_id => 'david',
@@ -238,7 +243,7 @@ describe ActivityFeed::Feed do
         )
 
         feed = ActivityFeed.feed('david', 1)
-        feed.length.should == 1
+        feed.length.should eql(1)
         feed[0].should == item
       end
     end
@@ -248,7 +253,7 @@ describe ActivityFeed::Feed do
     it 'should set an expiration on an activity feed' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
 
-      ActivityFeed.expire_feed('david', 10)    
+      ActivityFeed.expire_feed('david', 10)
       ActivityFeed.redis.ttl(ActivityFeed.feed_key('david')).tap do |ttl|
         ttl.should be > 1
         ttl.should be <= 10

data/spec/activity_feed/item_spec.rb

@@ -22,6 +22,16 @@ describe ActivityFeed::Item do
     end
   end
 
+  describe '#add_item' do
+    describe 'without aggregation' do
+      it 'should correctly build an activity feed' do
+        ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_false
+        ActivityFeed.add_item('david', 1, DateTime.now.to_i)
+        ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_true
+      end
+    end
+  end
+
   describe '#aggregate_item' do
     it 'should correctly add an item into an aggregate activity feed' do
       ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_false
@@ -36,12 +46,12 @@ describe ActivityFeed::Item do
     describe 'without aggregation' do
       it 'should remove an item from an activity feed' do
         ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_false
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should == 0
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should eql(0)
         ActivityFeed.update_item('david', 1, DateTime.now.to_i)
         ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_true
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should == 1
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should eql(1)
         ActivityFeed.remove_item('david', 1)
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should == 0
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should eql(0)
       end
     end
 
@@ -49,16 +59,16 @@ describe ActivityFeed::Item do
       it 'should remove an item from an activity feed and the aggregate feed' do
         ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_false
         ActivityFeed.redis.exists(ActivityFeed.feed_key('david', true)).should be_false
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should == 0
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david', true)).should == 0
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should eql(0)
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david', true)).should eql(0)
         ActivityFeed.update_item('david', 1, DateTime.now.to_i, true)
         ActivityFeed.redis.exists(ActivityFeed.feed_key('david')).should be_true
         ActivityFeed.redis.exists(ActivityFeed.feed_key('david', true)).should be_true
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should == 1
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david', true)).should == 1
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should eql(1)
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david', true)).should eql(1)
         ActivityFeed.remove_item('david', 1)
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should == 0
-        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david', true)).should == 0
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david')).should eql(0)
+        ActivityFeed.redis.zcard(ActivityFeed.feed_key('david', true)).should eql(0)
       end
     end
   end

data/spec/support/mongoid.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'mongoid'
 
 Mongoid.configure do |config|
@@ -10,7 +9,7 @@ DatabaseCleaner[:mongoid].strategy = :truncation
 module ActivityFeed
   module Mongoid
     class Item
-      include ::Mongoid::Document    
+      include ::Mongoid::Document
       include ::Mongoid::Timestamps
 
       field :user_id, :type => String

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.2.0'
+    ActivityFeed::VERSION.should == '2.2.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activity_feed
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-09-12 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: -3462149266482733398
+      hash: -3848997138192536076
 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: -3462149266482733398
+      hash: -3848997138192536076
 requirements: []
 rubyforge_project: activity_feed
 rubygems_version: 1.8.24