leaderboard 2.2.1 → 2.3.0

data/CHANGELOG.markdown

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## leaderboard 2.3.0 (2012-07-09)
+
+* Added `expire_leaderboard(seconds)` to expire the leaderboard in a set number of seconds.
+* Added `expire_leaderboard_at(timestamp)` to expire the leaderboard at a specific UNIX timestamp.
+* Added optional `page_size` parameter to the `total_pages` method.
+
 ## leaderboard 2.2.1 (2012-06-18)
 
 * Fix for #17 - Leaderboard not compatible with redis 2.1.1. Redis' `zrangebyscore` and `zrevrangebyscore` methods do not return scores by default. No need to pass the option in the initial call.
@@ -40,16 +46,16 @@
 
  * Allow for only single options to be passed to `leaders`, `around_me` and `ranked_in_list` methods - https://github.com/agoragames/leaderboard/issues/4
  * Added `percentile_for(member)` and `percentile_for_in(leaderboard_name, member)` methods to calculate percentile for a given member
- 
+
 ## leaderboard 2.0.0 (2011-08-05)
- 
+
  * Change `add_member` to `rank_member` - https://github.com/agoragames/leaderboard/issues/3
  * Added `delete_leaderboard` and `delete_leaderboard_named` - https://github.com/agoragames/leaderboard/issues/2
  * Ability to pass in an existing Redis connection in initializer - https://github.com/agoragames/leaderboard/issues/1
  * Added transaction support for `score_and_rank_for`, `leaders`, `around_me` and `ranked_in_list`
  * Updated initializer to take a leaderboard name, `options` hash and `redis_options` hash
  * Simplified `leaders`, `around_me` and `ranked_in_list` to use an `options` hash with defaults for the previously individual parameters
- 
+
 ## leaderboard 1.0.6 (unreleased)
 
  * Added `disconnect` method
@@ -69,7 +75,7 @@
 
  * Fixing issue using total_pages in leaderboard_in call
  * Internal `massage_leader_data` method will now respect `with_scores`
- 
+
 ## leaderboard 1.0.2 (2011-02-25)
 
  * Adding `XXX_to`, `XXX_for`, `XXX_in` and `XXX_from` methods that will allow you to set the leaderboard name to interact with outside of creating a new object

data/README.markdown

@@ -252,6 +252,8 @@ Use this method to do bulk insert of data, but be mindful of the amount of data
   remove_members_in_score_range(min_score, max_score): Remove members from the leaderboard within a score range
   percentile_for(member): Calculate the percentile for a given member
   page_for(member, page_size): Determine the page where a member falls in the leaderboard
+  expire_leaderboard(seconds): Expire the leaderboard in a set number of seconds.
+  expire_leaderboard_at(timestamp): Expire the leaderboard at a specific UNIX timestamp.
   rank_members(members_and_scores): Rank an array of members in the leaderboard where you can call via (member_name, score) or pass in an array of [member_name, score]
   merge_leaderboards(destination, keys, options = {:aggregate => :min}): Merge leaderboards given by keys with this leaderboard into destination
   intersect_leaderboards(destination, keys, options = {:aggregate => :min}): Intersect leaderboards given by keys with this leaderboard into destination

data/lib/leaderboard.rb

@@ -240,15 +240,17 @@ class Leaderboard
   
   # Retrieve the total number of pages in the leaderboard.
   #
+  # @param page_size [int, nil] Page size to be used when calculating the total number of pages.
+  #
   # @return the total number of pages in the leaderboard.
-  def total_pages
-    total_pages_in(@leaderboard_name)
+  def total_pages(page_size = nil)
+    total_pages_in(@leaderboard_name, page_size)
   end
   
   # Retrieve the total number of pages in the named leaderboard.
   # 
   # @param leaderboard_name [String] Name of the leaderboard.
-  # @param page_size [int] Page size to be used when paging through the leaderboard.
+  # @param page_size [int, nil] Page size to be used when calculating the total number of pages.
   # 
   # @return the total number of pages in the named leaderboard.
   def total_pages_in(leaderboard_name, page_size = nil)
@@ -478,6 +480,44 @@ class Leaderboard
 
     (rank_for_member.to_f / page_size.to_f).ceil    
   end
+
+  # Expire the current leaderboard in a set number of seconds. Do not use this with 
+  # leaderboards that utilize member data as there is no facility to cascade the 
+  # expiration out to the keys for the member data.
+  #
+  # @param seconds [int] Number of seconds after which the leaderboard will be expired.
+  def expire_leaderboard(seconds)
+    expire_leaderboard_for(@leaderboard_name, seconds)
+  end
+
+  # Expire the given leaderboard in a set number of seconds. Do not use this with 
+  # leaderboards that utilize member data as there is no facility to cascade the 
+  # expiration out to the keys for the member data.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param seconds [int] Number of seconds after which the leaderboard will be expired.
+  def expire_leaderboard_for(leaderboard_name, seconds)
+    @redis_connection.expire(leaderboard_name, seconds)
+  end
+
+  # Expire the current leaderboard at a specific UNIX timestamp. Do not use this with 
+  # leaderboards that utilize member data as there is no facility to cascade the 
+  # expiration out to the keys for the member data.
+  #
+  # @param timestamp [int] UNIX timestamp at which the leaderboard will be expired.
+  def expire_leaderboard_at(timestamp)
+    expire_leaderboard_at_for(@leaderboard_name, timestamp)
+  end
+
+  # Expire the given leaderboard at a specific UNIX timestamp. Do not use this with 
+  # leaderboards that utilize member data as there is no facility to cascade the 
+  # expiration out to the keys for the member data.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param timestamp [int] UNIX timestamp at which the leaderboard will be expired.
+  def expire_leaderboard_at_for(leaderboard_name, timestamp)
+    @redis_connection.expireat(leaderboard_name, timestamp)
+  end
     
   # Retrieve a page of leaders from the leaderboard.
   # 

data/lib/leaderboard/version.rb

@@ -1,4 +1,4 @@
 class Leaderboard
   # Leaderboard version
-  VERSION = '2.2.1'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -80,6 +80,7 @@ describe 'Leaderboard' do
     rank_members_in_leaderboard(10)
     
     @leaderboard.total_pages.should be(1)
+    @leaderboard.total_pages(5).should be(2)
     
     @redis_connection.flushdb
     
@@ -546,6 +547,26 @@ describe 'Leaderboard' do
     @leaderboard.page_for('member_1', 10).should be(2)
   end
 
+  it 'should set an expire on the leaderboard' do
+    rank_members_in_leaderboard
+
+    @leaderboard.expire_leaderboard(3)    
+    @redis_connection.ttl(@leaderboard.leaderboard_name).tap do |ttl|
+      ttl.should be > 1
+      ttl.should be <= 3
+    end
+  end
+
+  it 'should set an expire on the leaderboard using a timestamp' do
+    rank_members_in_leaderboard
+
+    @leaderboard.expire_leaderboard_at((Time.now + 10).to_i)
+    @redis_connection.ttl(@leaderboard.leaderboard_name).tap do |ttl|
+      ttl.should be > 1
+      ttl.should be <= 10
+    end
+  end
+
   it 'should allow you to rank multiple members with a variable number of arguments' do
     @leaderboard.total_members.should be(0)
     @leaderboard.rank_members('member_1', 1, 'member_10', 10)

data/spec/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'Leaderboard::VERSION' do
   it 'should be the correct version' do
-    Leaderboard::VERSION.should == '2.2.1'
+    Leaderboard::VERSION.should == '2.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-18 00:00:00.000000000 Z
+date: 2012-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -27523170013791394
+      hash: -401137284638736499
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -27523170013791394
+      hash: -401137284638736499
 requirements: []
 rubyforge_project: leaderboard
 rubygems_version: 1.8.23