leaderboard 2.1.0 → 2.2.1

data/CHANGELOG.markdown

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 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.
+
+## leaderboard 2.2.0 (2012-06-18)
+
+* Added `members_from_score_range` and `members_from_score_range_in` methods. These will retrieve members from the leaderboard that fall within a given score range.
+* Add `member_at` and `member_at_in` methods. These will retrieve a given member from the leaderboard at the specified position.
+* `members` and `members_in` are now aliases for the `leaders` and `leaders_in` methods.
+
 ## leaderboard 2.1.0 (2012-06-11)
 
 * Added ability to store optional member data alongside the leaderboard data.

data/README.markdown

@@ -174,6 +174,8 @@ Below is an example of retrieving the first page in the leaderboard without scor
    => [{:member=>"member_10"}, {:member=>"member_9"}, {:member=>"member_8"}, {:member=>"member_7"}, {:member=>"member_6"}, {:member=>"member_5"}, {:member=>"member_4"}, {:member=>"member_3"}, {:member=>"member_2"}, {:member=>"member_1"}] 
 ```
 
+You can also use the `members` and `members_in` methods as aliases for the `leaders` and `leaders_in` methods.
+
 Add more members to your leaderboard:
 
 ```ruby
@@ -199,6 +201,20 @@ Get rank and score for an arbitrary list of members (e.g. friends) from the lead
    => [{:member=>"member_1", :rank=>56, :score=>1.0}, {:member=>"member_62", :rank=>34, :score=>62.0}, {:member=>"member_67", :rank=>29, :score=>67.0}]
 ```
 
+Retrieve members from the leaderboard in a given score range:
+
+```ruby
+members = highscore_lb.members_from_score_range(4, 19)
+ => [{:member=>"member_10", :rank=>47, :score=>10.0}, {:member=>"member_9", :rank=>48, :score=>9.0}, {:member=>"member_8", :rank=>49, :score=>8.0}, {:member=>"member_7", :rank=>50, :score=>7.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_5", :rank=>52, :score=>5.0}, {:member=>"member_4", :rank=>53, :score=>4.0}] 
+```
+
+Retrieve a single member from the leaderboard at a given position:
+
+```ruby
+members = highscore_lb.member_at(4)
+ => {:member=>"member_92", :rank=>4, :score=>92.0}
+```
+
 ### Ranking multiple members in a leaderboard at once 
 
 Insert multiple data items for members and their associated scores:

data/lib/leaderboard.rb

@@ -489,6 +489,8 @@ class Leaderboard
     leaders_in(@leaderboard_name, current_page, options)
   end
 
+  alias_method :members, :leaders
+
   # Retrieve a page of leaders from the named leaderboard.
   # 
   # @param leaderboard_name [String] Name of the leaderboard.
@@ -531,6 +533,72 @@ class Leaderboard
       return []
     end
   end
+
+  alias_method :members_in, :leaders_in
+
+  # Retrieve members from the leaderboard within a given score range.
+  #
+  # @param minimum_score [float] Minimum score (inclusive).
+  # @param maximum_score [float] Maximum score (inclusive).
+  # @param options [Hash] Options to be used when retrieving the data from the leaderboard.
+  #
+  # @return members from the leaderboard that fall within the given score range.
+  def members_from_score_range(minimum_score, maximum_score, options = {})
+    members_from_score_range_in(@leaderboard_name, minimum_score, maximum_score, options)
+  end
+
+  # Retrieve members from the named leaderboard within a given score range.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param minimum_score [float] Minimum score (inclusive).
+  # @param maximum_score [float] Maximum score (inclusive).
+  # @param options [Hash] Options to be used when retrieving the data from the leaderboard.
+  #
+  # @return members from the leaderboard that fall within the given score range.
+  def members_from_score_range_in(leaderboard_name, minimum_score, maximum_score, options = {})
+    leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
+    leaderboard_options.merge!(options)
+
+    raw_leader_data = @reverse ? 
+      @redis_connection.zrangebyscore(leaderboard_name, minimum_score, maximum_score) :
+      @redis_connection.zrevrangebyscore(leaderboard_name, maximum_score, minimum_score)
+
+    if raw_leader_data
+      return ranked_in_list_in(leaderboard_name, raw_leader_data, leaderboard_options)
+    else
+      return []
+    end
+  end
+
+  # Retrieve a member at the specified index from the leaderboard.
+  # 
+  # @param position [int] Position in leaderboard.
+  # @param options [Hash] Options to be used when retrieving the member from the leaderboard.
+  # 
+  # @return a member from the leaderboard.
+  def member_at(position, options = {})
+    member_at_in(@leaderboard_name, position, options)
+  end
+
+  # Retrieve a member at the specified index from the leaderboard.
+  # 
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param position [int] Position in named leaderboard.
+  # @param options [Hash] Options to be used when retrieving the member from the named leaderboard.
+  # 
+  # @return a page of leaders from the named leaderboard.
+  def member_at_in(leaderboard_name, position, options = {})
+    if position <= total_members_in(leaderboard_name)
+      leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
+      leaderboard_options.merge!(options)
+      page_size = validate_page_size(leaderboard_options[:page_size]) || @page_size
+      current_page = (position.to_f / page_size.to_f).ceil
+      offset = (position - 1) % page_size
+
+      leaders = leaders_in(leaderboard_name, current_page, options)
+      leaders[offset] if leaders
+    end
+  end
   
   # Retrieve a page of leaders from the leaderboard around a given member.
   #

data/lib/leaderboard/version.rb

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

data/spec/leaderboard_spec.rb

@@ -102,6 +102,20 @@ describe 'Leaderboard' do
     leaders[-1][:score].to_i.should be(1)
   end
 
+  it 'should return the correct list when calling members' do
+    rank_members_in_leaderboard(25)
+    
+    @leaderboard.total_members.should be(25)
+
+    members = @leaderboard.members(1)
+        
+    members.size.should be(25)
+    members[0][:member].should == 'member_25'
+    members[-2][:member].should == 'member_2'
+    members[-1][:member].should == 'member_1'
+    members[-1][:score].to_i.should be(1)
+  end
+
   it 'should return the correct number of members when calling leaders with multiple pages' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE * 3 + 1)
     
@@ -126,6 +140,26 @@ describe 'Leaderboard' do
     leaders.size.should be(1)
   end
 
+  it 'should allow you to retrieve members in a given score range' do
+    rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
+
+    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => false, :with_rank => false})
+
+    member_15 = {:member => 'member_15'}
+    members[0].should == member_15
+
+    member_10 = {:member => 'member_10'}
+    members[5].should == member_10
+
+    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => true, :with_rank => true, :with_member_data => true})
+
+    member_15 = {:member => 'member_15', :rank => 11, :score => 15.0, :member_data => {'member_name' => 'Leaderboard member 15'}}
+    members[0].should == member_15
+
+    member_10 = {:member => 'member_10', :rank => 16, :score => 10.0, :member_data => {'member_name' => 'Leaderboard member 10'}}
+    members[5].should == member_10
+  end
+
   it 'should allow you to retrieve leaders without scores and ranks' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
     
@@ -210,6 +244,17 @@ describe 'Leaderboard' do
     leaders[0].should == member_26
   end
 
+  it 'should return a single member when calling member_at' do
+    rank_members_in_leaderboard(50)
+    @leaderboard.member_at(1)[:rank].should == 1
+    @leaderboard.member_at(1)[:score].should == 50.0
+    @leaderboard.member_at(26)[:rank].should == 26
+    @leaderboard.member_at(50)[:rank].should == 50
+    @leaderboard.member_at(51).should be_nil
+    @leaderboard.member_at(1, :with_member_data => true)[:member_data].should == {'member_name' => 'Leaderboard member 50'}
+    @leaderboard.member_at(1, :use_zero_index_for_rank => true)[:rank].should == 0
+  end
+
   it 'should return the correct information when calling around_me' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE * 3 + 1)
 

data/spec/reverse_leaderboard_spec.rb

@@ -33,6 +33,40 @@ describe 'Leaderboard (reverse option)' do
     leaders[-1][:score].to_i.should be(25)
   end
 
+  it 'should return the correct list when calling members' do
+    rank_members_in_leaderboard(25)
+    
+    @leaderboard.total_members.should be(25)
+
+    members = @leaderboard.members(1)
+        
+    members.size.should be(25)
+    members[0][:member].should == 'member_1'
+    members[-2][:member].should == 'member_24'
+    members[-1][:member].should == 'member_25'
+    members[-1][:score].to_i.should be(25)
+  end
+
+  it 'should allow you to retrieve members in a given score range' do
+    rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
+
+    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => false, :with_rank => false})
+
+    member_10 = {:member => 'member_10'}
+    members[0].should == member_10
+
+    member_15 = {:member => 'member_15'}
+    members[5].should == member_15
+
+    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => true, :with_rank => true, :with_member_data => true})
+
+    member_10 = {:member => 'member_10', :rank => 10, :score => 10.0, :member_data => {'member_name' => 'Leaderboard member 10'}}
+    members[0].should == member_10
+
+    member_15 = {:member => 'member_15', :rank => 15, :score => 15.0, :member_data => {'member_name' => 'Leaderboard member 15'}}
+    members[5].should == member_15
+  end
+
   it 'should allow you to retrieve leaders without scores and ranks' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
     
@@ -81,6 +115,17 @@ describe 'Leaderboard (reverse option)' do
     leaders[0].should == member_1
   end
 
+  it 'should return a single member when calling member_at' do
+    rank_members_in_leaderboard(50)
+    @leaderboard.member_at(1)[:rank].should == 1
+    @leaderboard.member_at(1)[:score].should == 1.0
+    @leaderboard.member_at(26)[:rank].should == 26
+    @leaderboard.member_at(50)[:rank].should == 50
+    @leaderboard.member_at(51).should be_nil
+    @leaderboard.member_at(1, :with_member_data => true)[:member_data].should == {'member_name' => 'Leaderboard member 1'}
+    @leaderboard.member_at(1, :use_zero_index_for_rank => true)[:rank].should == 0
+  end
+
   it 'should return the correct information when calling around_me' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE * 3 + 1)
 

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-06-18 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: 248515504144092266
+      hash: -27523170013791394
 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: 248515504144092266
+      hash: -27523170013791394
 requirements: []
 rubyforge_project: leaderboard
 rubygems_version: 1.8.23