leaderboard 3.0.1 → 3.0.2

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## leaderboard 3.0.2 (2013-02-22)
+
+* Fixed a data leak in `expire_leaderboard` and `expire_leaderboard_at` to also set expiration on the member data hash.
+
 ## leaderboard 3.0.1 (2012-12-19)
 
 * Fixed a bug in `remove_member` that would remove all of the optional member data.

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2012 David Czarnecki
+Copyright (c) 2011-2013 David Czarnecki
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -146,6 +146,12 @@ highscore_lb.remove_member_data('84849292')
 ```
 
 If you delete the leaderboard, ALL of the member data is deleted as well.
+
+#### Optional member data notes
+
+If you use optional member data, the use of the `remove_members_in_score_range` will leave data around in the member data 
+hash. This is because the internal Redis method, `zremrangebyscore`, only returns the number of items removed. It does 
+not return the members that it removed.
   
 Get some information about a specific member(s) in the leaderboard:
 
@@ -404,10 +410,10 @@ end
 
 The following ports have been made of the leaderboard gem.
 
+* CoffeeScript: https://github.com/agoragames/leaderboard-coffeescript
 * Java: https://github.com/agoragames/java-leaderboard
-* NodeJS: https://github.com/omork/node-leaderboard
 * PHP: https://github.com/agoragames/php-leaderboard
-* Python: https://github.com/agoragames/python-leaderboard
+* Python: https://github.com/agoragames/leaderboard-python
 * Scala: https://github.com/agoragames/scala-leaderboard
 
 ## Contributing to leaderboard
@@ -422,5 +428,5 @@ The following ports have been made of the leaderboard gem.
 
 ## Copyright
 
-Copyright (c) 2011-2012 David Czarnecki. See LICENSE.txt for further details.
+Copyright (c) 2011-2013 David Czarnecki. See LICENSE.txt for further details.
 

data/lib/leaderboard.rb

@@ -109,7 +109,7 @@ class Leaderboard
   #
   # @param member [String] Member name.
   # @param score [float] Member score.
-  # @param member_data [Hash] Optional member data.
+  # @param member_data [String] Optional member data.
   def rank_member(member, score, member_data = nil)
     rank_member_in(@leaderboard_name, member, score, member_data)
   end
@@ -119,7 +119,7 @@ class Leaderboard
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
   # @param score [float] Member score.
-  # @param member_data [Hash] Optional member data.
+  # @param member_data [String] Optional member data.
   def rank_member_in(leaderboard_name, member, score, member_data = nil)
     @redis_connection.multi do |transaction|
       transaction.zadd(leaderboard_name, score, member)
@@ -127,7 +127,7 @@ class Leaderboard
     end
   end
 
-  # Rank a member in the leaderboard based on execution of the +rank_conditional+. 
+  # Rank a member in the leaderboard based on execution of the +rank_conditional+.
   #
   # The +rank_conditional+ is passed the following parameters:
   #   member: Member name.
@@ -138,13 +138,13 @@ class Leaderboard
   #
   # @param rank_conditional [lambda] Lambda which must return +true+ or +false+ that controls whether or not the member is ranked in the leaderboard.
   # @param member [String] Member name.
-  # @param score [String] Member score.
-  # @param member_data [Hash] Optional member_data.
+  # @param score [float] Member score.
+  # @param member_data [String] Optional member_data.
   def rank_member_if(rank_conditional, member, score, member_data = nil)
     rank_member_if_in(@leaderboard_name, rank_conditional, member, score, member_data)
   end
 
-  # Rank a member in the named leaderboard based on execution of the +rank_conditional+. 
+  # Rank a member in the named leaderboard based on execution of the +rank_conditional+.
   #
   # The +rank_conditional+ is passed the following parameters:
   #   member: Member name.
@@ -156,10 +156,10 @@ class Leaderboard
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param rank_conditional [lambda] Lambda which must return +true+ or +false+ that controls whether or not the member is ranked in the leaderboard.
   # @param member [String] Member name.
-  # @param score [String] Member score.
-  # @param member_data [Hash] Optional member_data.
+  # @param score [float] Member score.
+  # @param member_data [String] Optional member_data.
   def rank_member_if_in(leaderboard_name, rank_conditional, member, score, member_data = nil)
-    current_score = @redis_connection.zscore(leaderboard_name, member) 
+    current_score = @redis_connection.zscore(leaderboard_name, member)
     current_score = current_score.to_f if current_score
 
     if rank_conditional.call(member, current_score, score, member_data, {:reverse => @reverse})
@@ -171,7 +171,7 @@ class Leaderboard
   #
   # @param member [String] Member name.
   #
-  # @return Hash of optional member data.
+  # @return String of optional member data.
   def member_data_for(member)
     member_data_for_in(@leaderboard_name, member)
   end
@@ -181,7 +181,7 @@ class Leaderboard
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
   #
-  # @return Hash of optional member data.
+  # @return String of optional member data.
   def member_data_for_in(leaderboard_name, member)
     @redis_connection.hget(member_data_key(leaderboard_name), member)
   end
@@ -189,7 +189,7 @@ class Leaderboard
   # Update the optional member data for a given member in the leaderboard.
   #
   # @param member [String] Member name.
-  # @param member_data [Hash] Optional member data.
+  # @param member_data [String] Optional member data.
   def update_member_data(member, member_data)
     update_member_data_in(@leaderboard_name, member, member_data)
   end
@@ -198,7 +198,7 @@ class Leaderboard
   #
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
-  # @param member_data [Hash] Optional member data.
+  # @param member_data [String] Optional member data.
   def update_member_data_in(leaderboard_name, member, member_data)
     @redis_connection.hset(member_data_key(leaderboard_name), member, member_data)
   end
@@ -336,7 +336,7 @@ class Leaderboard
   # Retrieve the rank for a member in the leaderboard.
   #
   # @param member [String] Member name.
-  # 
+  #
   # @return the rank for a member in the leaderboard.
   def rank_for(member)
     rank_for_in(@leaderboard_name, member)
@@ -346,7 +346,7 @@ class Leaderboard
   #
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
-  # 
+  #
   # @return the rank for a member in the leaderboard.
   def rank_for_in(leaderboard_name, member)
     if @reverse
@@ -372,7 +372,7 @@ class Leaderboard
   #
   # @return the score for a member in the leaderboard or +nil+ if the member is not in the leaderboard.
   def score_for_in(leaderboard_name, member)
-    score = @redis_connection.zscore(leaderboard_name, member) 
+    score = @redis_connection.zscore(leaderboard_name, member)
     score.to_f if score
   end
 
@@ -422,8 +422,8 @@ class Leaderboard
 
     responses[0] = responses[0].to_f if responses[0]
     responses[1] = responses[1] + 1 rescue nil
-    
-    {:member => member, :score => responses[0], :rank => responses[1]}    
+
+    {:member => member, :score => responses[0], :rank => responses[1]}
   end
 
   # Remove members from the leaderboard in a given score range.
@@ -521,7 +521,10 @@ class Leaderboard
   # @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)
+    @redis_connection.multi do |transaction|
+      transaction.expire(leaderboard_name, seconds)
+      transaction.expire(member_data_key(leaderboard_name), seconds)
+    end
   end
 
   # Expire the current leaderboard at a specific UNIX timestamp. Do not use this with
@@ -540,7 +543,10 @@ class Leaderboard
   # @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)
+    @redis_connection.multi do |transaction|
+      transaction.expireat(leaderboard_name, timestamp)
+      transaction.expireat(member_data_key(leaderboard_name), timestamp)
+    end
   end
 
   # Retrieve a page of leaders from the leaderboard.
@@ -873,10 +879,10 @@ class Leaderboard
   # Key for retrieving optional member data.
   #
   # @param leaderboard_name [String] Name of the leaderboard.
-  # 
+  #
   # @return a key in the form of +leaderboard_name:member_data+
   def member_data_key(leaderboard_name)
-    "#{leaderboard_name}:member_data" 
+    "#{leaderboard_name}:member_data"
   end
 
   # Validate and return the page size. Returns the +DEFAULT_PAGE_SIZE+ if the page size is less than 1.

data/lib/leaderboard/version.rb

@@ -1,4 +1,3 @@
 class Leaderboard
-  # Leaderboard version
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.0.2'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -528,6 +528,10 @@ describe 'Leaderboard' do
       ttl.should be > 1
       ttl.should be <= 3
     end
+    @redis_connection.ttl(@leaderboard.send(:member_data_key, @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
@@ -538,6 +542,10 @@ describe 'Leaderboard' do
       ttl.should be > 1
       ttl.should be <= 10
     end
+    @redis_connection.ttl(@leaderboard.send(:member_data_key, @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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -93,15 +93,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1304683116950225093
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1304683116950225093
 requirements: []
 rubyforge_project: leaderboard
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Leaderboards backed by Redis in Ruby