activity_feed 3.0.0 → 3.0.1

data/CHANGELOG.markdown

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 3.0.1 (2013-07-17)
+
+More useful aliases:
+
+  * `ActivityFeed.for` as an alias for `ActivityFeed.feed`
+  * `ActivityFeed.between` as an alias for `ActivityFeed.feed_between_timestamps`
+  * `ActivityFeed.trim` as an alias for `ActivityFeed.trim_feed`
+  * `ActivityFeed.expire_in` and `ActivityFeed.expire_feed_in` as aliases for `ActivityFeed.expire_feed`
+  * `ActivityFeed.expire_at` as an alias for `ActivityFeed.expire_feed_at`
+
 ## 3.0.0 (2013-07-12)
 
 * Allow for bulk-loading of feed items. The `ActivityFeed.item_loader`

data/README.markdown

@@ -286,7 +286,6 @@ feeds in which that activity feed item may have been aggregated.
 
 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)
@@ -295,16 +294,29 @@ ActivityFeed.check_item?(user_id, item_id, aggregate = ActivityFeed.aggregate)
 # Feed-related
 
 ActivityFeed.feed(user_id, page, aggregate = ActivityFeed.aggregate)
+ActivityFeed.for(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.between(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.trim(user_id, starting_timestamp, ending_timestamp, aggregate = ActivityFeed.aggregate)
+
 ActivityFeed.expire_feed(user_id, seconds, aggregate = ActivityFeed.aggregate)
 ActivityFeed.expire_feed_in(user_id, seconds, aggregate = ActivityFeed.aggregate)
+ActivityFeed.expire_in(user_id, seconds, aggregate = ActivityFeed.aggregate)
+
 ActivityFeed.expire_feed_at(user_id, timestamp, aggregate = ActivityFeed.aggregate)
+ActivityFeed.expire_at(user_id, timestamp, aggregate = ActivityFeed.aggregate)
+
 ActivityFeed.remove_feeds(user_id)
 ```
 

data/activity_feed.gemspec

@@ -10,15 +10,15 @@ Gem::Specification.new do |s|
   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.license = 'MIT'
 
   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('activesupport')
@@ -29,12 +29,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('activerecord')
   s.add_development_dependency('sqlite3')
-  
+
   s.add_development_dependency('database_cleaner')
 
   if '1.8.7'.eql?(RUBY_VERSION)
     s.add_development_dependency('SystemTimer')
   end
-   
+
   s.add_dependency('leaderboard')
 end

data/lib/activity_feed/feed.rb

@@ -16,6 +16,8 @@ module ActivityFeed
       load_feed_items(feed_items)
     end
 
+    alias_method :for, :feed
+
     # Retrieve the entire activity feed for a given +user_id+. You can configure
     # +ActivityFeed.items_loader+ with a Proc to retrieve items from, for example,
     # your ORM (e.g. ActiveRecord) or your ODM (e.g. Mongoid), and have the page
@@ -49,6 +51,8 @@ module ActivityFeed
       load_feed_items(feed_items)
     end
 
+    alias_method :between, :feed_between_timestamps
+
     # Return the total number of pages in the activity feed.
     #
     # @param user_id [String] User ID.
@@ -94,6 +98,8 @@ module ActivityFeed
       ActivityFeed.feederboard_for(user_id, aggregate).remove_members_in_score_range(starting_timestamp, ending_timestamp)
     end
 
+    alias_method :trim, :trim_feed
+
     # Expire an activity feed after a set number of seconds.
     #
     # @param user_id [String] User ID.
@@ -103,6 +109,7 @@ module ActivityFeed
       ActivityFeed.redis.expire(ActivityFeed.feed_key(user_id, aggregate), seconds)
     end
 
+    alias_method :expire_in, :expire_feed
     alias_method :expire_feed_in, :expire_feed
 
     # Expire an activity feed at a given timestamp.
@@ -114,6 +121,8 @@ module ActivityFeed
       ActivityFeed.redis.expireat(ActivityFeed.feed_key(user_id, aggregate), timestamp)
     end
 
+    alias_method :expire_at, :expire_feed_at
+
     private
 
     # Load feed items from the `ActivityFeed.items_loader` if available,

data/lib/activity_feed/version.rb

@@ -1,3 +1,3 @@
 module ActivityFeed
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/spec/activity_feed/feed_spec.rb

@@ -1,20 +1,28 @@
 require 'spec_helper'
 
 describe ActivityFeed::Feed do
-  describe '#feed' do
+  describe '#feed and #for' do
     describe 'without aggregation' do
       it 'should return an activity feed with the items correctly ordered' do
+        feed = ActivityFeed.feed('david', 1)
+        feed.length.should eql(0)
+
         add_items_to_feed('david')
 
-        feed = ActivityFeed.feed('david', 1)
-        feed.length.should eql(5)
-        feed[0].to_i.should eql(5)
-        feed[4].to_i.should eql(1)
+        [:feed, :for].each do |method|
+          feed = ActivityFeed.send(method, 'david', 1)
+          feed.length.should eql(5)
+          feed[0].to_i.should eql(5)
+          feed[4].to_i.should eql(1)
+        end
       end
     end
 
     describe 'with aggregation' do
       it 'should return an aggregate activity feed with the items correctly ordered' do
+        feed = ActivityFeed.feed('david', 1, true)
+        feed.length.should eql(0)
+
         add_items_to_feed('david', 5, true)
 
         feed = ActivityFeed.feed('david', 1, true)
@@ -28,6 +36,9 @@ describe ActivityFeed::Feed do
   describe '#full_feed' do
     describe 'without aggregation' do
       it 'should return the full activity feed' do
+        feed = ActivityFeed.full_feed('david', false)
+        feed.length.should eql(0)
+
         add_items_to_feed('david', 30)
 
         feed = ActivityFeed.full_feed('david', false)
@@ -39,6 +50,9 @@ describe ActivityFeed::Feed do
 
     describe 'with aggregation' do
       it 'should return the full activity feed' do
+        feed = ActivityFeed.full_feed('david', true)
+        feed.length.should eql(0)
+
         add_items_to_feed('david', 30, true)
 
         feed = ActivityFeed.full_feed('david', true)
@@ -49,9 +63,12 @@ describe ActivityFeed::Feed do
     end
   end
 
-  describe '#feed_between_timestamps' do
+  describe '#feed_between_timestamps and #between' do
     describe 'without aggregation' do
       it 'should return activity feed items between the starting and ending timestamps' do
+        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, false)
+        feed.length.should eql(0)
+
         Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
         ActivityFeed.update_item('david', 1, Time.now.to_i)
         Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
@@ -64,15 +81,20 @@ describe ActivityFeed::Feed do
         ActivityFeed.update_item('david', 5, Time.now.to_i)
         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 eql(2)
-        feed[0].to_i.should eql(4)
-        feed[1].to_i.should eql(3)
+        [:feed_between_timestamps, :between].each do |method|
+          feed = ActivityFeed.send(method, 'david', Time.local(2012, 6, 19, 4, 43, 0).to_i, Time.local(2012, 6, 19, 8, 16, 0).to_i, false)
+          feed.length.should eql(2)
+          feed[0].to_i.should eql(4)
+          feed[1].to_i.should eql(3)
+        end
       end
     end
 
     describe 'with aggregation' do
       it 'should return activity feed items between the starting and ending timestamps' do
+        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 eql(0)
+
         Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
         ActivityFeed.update_item('david', 1, Time.now.to_i, true)
         Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
@@ -85,10 +107,12 @@ describe ActivityFeed::Feed do
         ActivityFeed.update_item('david', 5, Time.now.to_i, true)
         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 eql(2)
-        feed[0].to_i.should eql(4)
-        feed[1].to_i.should eql(3)
+        [:feed_between_timestamps, :between].each do |method|
+          feed = ActivityFeed.send(method, '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 eql(2)
+          feed[0].to_i.should eql(4)
+          feed[1].to_i.should eql(3)
+        end
       end
     end
   end
@@ -96,6 +120,9 @@ describe ActivityFeed::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
+        ActivityFeed.total_pages_in_feed('david').should eql(0)
+        ActivityFeed.total_pages('david').should eql(0)
+
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1)
 
         ActivityFeed.total_pages_in_feed('david').should eql(2)
@@ -105,6 +132,9 @@ describe ActivityFeed::Feed do
 
     describe 'with aggregation' do
       it 'should return the correct number of pages in the aggregate activity feed' do
+        ActivityFeed.total_pages_in_feed('david', true).should eql(0)
+        ActivityFeed.total_pages('david', true).should eql(0)
+
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1, true)
 
         ActivityFeed.total_pages_in_feed('david', true).should eql(2)
@@ -114,6 +144,9 @@ describe ActivityFeed::Feed do
 
     describe 'changing page_size parameter' do
       it 'should return the correct number of pages in the activity feed' do
+        ActivityFeed.total_pages_in_feed('david', false, 4).should eql(0)
+        ActivityFeed.total_pages('david', false, 4).should eql(0)
+
         add_items_to_feed('david', 25)
 
         ActivityFeed.total_pages_in_feed('david', false, 4).should eql(7)
@@ -122,7 +155,7 @@ describe ActivityFeed::Feed do
     end
   end
 
-  describe '#remove_feeds' do
+  describe '#remove_feeds and #remove' do
     it 'should remove the activity feeds for a given user ID' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1, true)
 
@@ -139,6 +172,9 @@ describe ActivityFeed::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
+        ActivityFeed.total_items_in_feed('david').should eql(0)
+        ActivityFeed.total_items('david').should eql(0)
+
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1)
 
         ActivityFeed.total_items_in_feed('david').should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
@@ -148,6 +184,9 @@ describe ActivityFeed::Feed do
 
     describe 'with aggregation' do
       it 'should return the correct number of items in the aggregate activity feed' do
+        ActivityFeed.total_items_in_feed('david', true).should eql(0)
+        ActivityFeed.total_items('david', true).should eql(0)
+
         add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE + 1, true)
 
         ActivityFeed.total_items_in_feed('david', true).should eql(Leaderboard::DEFAULT_PAGE_SIZE + 1)
@@ -159,45 +198,49 @@ 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
-        Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
-        ActivityFeed.update_item('david', 1, Time.now.to_i)
-        Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
-        ActivityFeed.update_item('david', 2, Time.now.to_i)
-        Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
-        ActivityFeed.update_item('david', 3, Time.now.to_i)
-        Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
-        ActivityFeed.update_item('david', 4, Time.now.to_i)
-        Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
-        ActivityFeed.update_item('david', 5, Time.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 eql(2)
-        feed[0].to_i.should eql(5)
-        feed[1].to_i.should eql(1)
+        [:trim_feed, :trim].each do |method|
+          Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
+          ActivityFeed.update_item('david', 1, Time.now.to_i)
+          Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
+          ActivityFeed.update_item('david', 2, Time.now.to_i)
+          Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
+          ActivityFeed.update_item('david', 3, Time.now.to_i)
+          Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
+          ActivityFeed.update_item('david', 4, Time.now.to_i)
+          Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
+          ActivityFeed.update_item('david', 5, Time.now.to_i)
+          Timecop.return
+
+          ActivityFeed.send(method, '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 eql(2)
+          feed[0].to_i.should eql(5)
+          feed[1].to_i.should eql(1)
+        end
       end
     end
 
     describe 'with aggregation' do
       it 'should trim activity feed items between the starting and ending timestamps' do
-        Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
-        ActivityFeed.update_item('david', 1, Time.now.to_i, true)
-        Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
-        ActivityFeed.update_item('david', 2, Time.now.to_i, true)
-        Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
-        ActivityFeed.update_item('david', 3, Time.now.to_i, true)
-        Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
-        ActivityFeed.update_item('david', 4, Time.now.to_i, true)
-        Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
-        ActivityFeed.update_item('david', 5, Time.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 eql(2)
-        feed[0].to_i.should eql(5)
-        feed[1].to_i.should eql(1)
+        [:trim_feed, :trim].each do |method|
+          Timecop.travel(Time.local(2012, 6, 19, 4, 0, 0))
+          ActivityFeed.update_item('david', 1, Time.now.to_i, true)
+          Timecop.travel(Time.local(2012, 6, 19, 4, 30, 0))
+          ActivityFeed.update_item('david', 2, Time.now.to_i, true)
+          Timecop.travel(Time.local(2012, 6, 19, 5, 30, 0))
+          ActivityFeed.update_item('david', 3, Time.now.to_i, true)
+          Timecop.travel(Time.local(2012, 6, 19, 6, 37, 0))
+          ActivityFeed.update_item('david', 4, Time.now.to_i, true)
+          Timecop.travel(Time.local(2012, 6, 19, 8, 17, 0))
+          ActivityFeed.update_item('david', 5, Time.now.to_i, true)
+          Timecop.return
+
+          ActivityFeed.send(method, '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 eql(2)
+          feed[0].to_i.should eql(5)
+          feed[1].to_i.should eql(1)
+        end
       end
     end
   end
@@ -251,7 +294,7 @@ describe ActivityFeed::Feed do
     end
   end
 
-  describe '#expire_feed and #expire_feed_in' do
+  describe '#expire_feed, #expire_in and #expire_feed_in' do
     it 'should set an expiration on an activity feed using #expire_feed' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
 
@@ -262,6 +305,16 @@ describe ActivityFeed::Feed do
       end
     end
 
+    it 'should set an expiration on an activity feed using #expire_in' do
+      add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
+
+      ActivityFeed.expire_in('david', 10)
+      ActivityFeed.redis.ttl(ActivityFeed.feed_key('david')).tap do |ttl|
+        ttl.should be > 1
+        ttl.should be <= 10
+      end
+    end
+
     it 'should set an expiration on an activity feed using #expire_feed_in' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
 
@@ -273,8 +326,8 @@ describe ActivityFeed::Feed do
     end
   end
 
-  describe '#expire_feed_at' do
-    it 'should set an expiration timestamp on an activity feed' do
+  describe '#expire_feed_at and #expire_at' do
+    it 'should set an expiration timestamp on an activity feed using #expire_feed' do
       add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
 
       ActivityFeed.expire_feed_at('david', (Time.now + 10).to_i)
@@ -283,5 +336,15 @@ describe ActivityFeed::Feed do
         ttl.should be <= 10
       end
     end
+
+    it 'should set an expiration timestamp on an activity feed using #expire_at' do
+      add_items_to_feed('david', Leaderboard::DEFAULT_PAGE_SIZE)
+
+      ActivityFeed.expire_at('david', (Time.now + 10).to_i)
+      ActivityFeed.redis.ttl(ActivityFeed.feed_key('david')).tap do |ttl|
+        ttl.should be > 1
+        ttl.should be <= 10
+      end
+    end
   end
 end

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activity_feed
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -203,7 +203,8 @@ files:
 - spec/support/mongoid.yml
 - spec/version_spec.rb
 homepage: https://github.com/agoragames/activity_feed
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -216,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3361752817333604694
+      hash: -3957721059363882018
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -225,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3361752817333604694
+      hash: -3957721059363882018
 requirements: []
 rubyforge_project: activity_feed
 rubygems_version: 1.8.25