leaderboard 3.0.2 → 3.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjI2NWFlODMyNTM3NWMzZmM4YzUwMzljMWJkMDQ2MmVhMjVlNjQ1ZQ==
+  data.tar.gz: !binary |-
+    ZDNhMmYzZjU5MGJjYjU3YTIzMWI0NWJhZDNhNDAwNmRjYzFmMjAyOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTk2YTBhNzZhZGUyODgwYzAwYTgzNDAyOTYwYTQzYjVhODdmZGJiZmEwMzc1
+    YzdiODM3MTA2NGI1M2I2NjhjZmVmN2RlMDVlMzBjYmUxMGU1YjkyYjU4ODQy
+    NTRmMWM5NzM3NTE1MDYzYjc1ZjkyNDU1MjA3MDE1NTc0Nzk1ZWU=
+  data.tar.gz: !binary |-
+    MmIwMTc1ZGVjZmE0N2U4NjRjNGM2OGY3M2ZlZTQ4YTM5ZTQ0ZWI3MDRkNzA4
+    MjhjNDhkMWFiMDhiYTExOTdhMDFjNGU2YWEyNTI2MDVhNzA5YmEwYjA1Nzg3
+    NDljMDM5ZWNmZjY3ZDI5NzVlY2VmZGIxZDczMmJlMTAxZjgxOGI=

data/.ruby-gemset

@@ -0,0 +1 @@
+leaderboard_gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+services:
+  - redis-server

data/README.markdown

@@ -4,6 +4,8 @@ Leaderboards backed by [Redis](http://redis.io) in Ruby.
 
 Builds off ideas proposed in http://blog.agoragames.com/2011/01/01/creating-high-score-tables-leaderboards-using-redis/.
 
+[![Build Status](https://secure.travis-ci.org/agoragames/leaderboard.png)](http://travis-ci.org/agoragames/leaderboard)
+
 ## Installation
 
 `gem install leaderboard`
@@ -119,10 +121,10 @@ Get some information about your leaderboard:
    => 1
 ```
 
-The `rank_member` call will also accept an optional parameter, `member_data` that could 
-be used to store other information about a given member in the leaderboard. This 
-may be useful in situations where you are storing member IDs in the leaderboard and 
-you want to be able to store a member name for display. You could use JSON to 
+The `rank_member` call will also accept an optional parameter, `member_data` that could
+be used to store other information about a given member in the leaderboard. This
+may be useful in situations where you are storing member IDs in the leaderboard and
+you want to be able to store a member name for display. You could use JSON to
 encode a Hash of member data. Example:
 
 ```ruby
@@ -138,7 +140,7 @@ JSON.parse(highscore_lb.member_data_for('84849292'))
  => {"username"=>"member_name"}
 
 highscore_lb.update_member_data('84849292', JSON.generate({'last_updated' => Time.now, 'username' => 'updated_member_name'}))
- => "OK" 
+ => "OK"
 JSON.parse(highscore_lb.member_data_for('84849292'))
  => {"username"=>"updated_member_name", "last_updated"=>"2012-06-09 09:11:06 -0400"}
 
@@ -149,10 +151,10 @@ 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 
+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:
 
 ```ruby
@@ -172,15 +174,17 @@ Get page 1 in the leaderboard:
   highscore_lb.leaders(1)
    => [{:member=>"member_10", :rank=>1, :score=>10.0}, {:member=>"member_9", :rank=>2, :score=>9.0}, {:member=>"member_8", :rank=>3, :score=>8.0}, {:member=>"member_7", :rank=>4, :score=>7.0}, {:member=>"member_6", :rank=>5, :score=>6.0}, {:member=>"member_5", :rank=>6, :score=>5.0}, {:member=>"member_4", :rank=>7, :score=>4.0}, {:member=>"member_3", :rank=>8, :score=>3.0}, {:member=>"member_2", :rank=>9, :score=>2.0}, {:member=>"member_1", :rank=>10, :score=>1.0}]
 ```
-	
-You can pass various options to the calls `leaders`, `around_me` and `ranked_in_list`. 
-Valid options are `:with_member_data`, `:page_size` and `:sort_option`. Valid values for 
-`:sort_option` are `:none` (default), `:score` and `:rank`. 
+
+You can pass various options to the calls `leaders`, `all_leaders`, `around_me`, `members_from_score_range`, `members_from_rank_range` and `ranked_in_list`. Valid options are:
+
+* `:with_member_data` - `true` or `false` (default) to return the optional member data.
+* `:page_size` - An integer value to change the page size for that call.
+* `:members_only` - `true` or `false` (default) to return only the members without their score and rank.
+* `:sort_option` - Valid values for `:sort_option` are `:none` (default), `:score` and `:rank`.
 
 You can also use the `members` and `members_in` methods as aliases for the `leaders` and `leaders_in` methods.
 
-There are also a few convenience methods to be able to retrieve all leaders from a given leaderboard. They are `all_leaders` and `all_leaders_from`. You
-may also use the aliases `all_members` or `all_members_from`. Use any of these methods sparingly as all the information in the leaderboard will be returned.
+There are also a few convenience methods to be able to retrieve all leaders from a given leaderboard. They are `all_leaders` and `all_leaders_from`. You may also use the aliases `all_members` or `all_members_from`. Use any of these methods sparingly as all the information in the leaderboard will be returned.
 
 Add more members to your leaderboard:
 
@@ -225,21 +229,21 @@ Retrieve a range of members from the leaderboard within a given rank range:
 
 ```ruby
 members = highscore_lb.members_from_rank_range(1, 5)
- => [{:member=>"member_95", :rank=>1, :score=>95.0}, {:member=>"member_94", :rank=>2, :score=>94.0}, {:member=>"member_93", :rank=>3, :score=>93.0}, {:member=>"member_92", :rank=>4, :score=>92.0}, {:member=>"member_91", :rank=>5, :score=>91.0}] 
+ => [{:member=>"member_95", :rank=>1, :score=>95.0}, {:member=>"member_94", :rank=>2, :score=>94.0}, {:member=>"member_93", :rank=>3, :score=>93.0}, {:member=>"member_92", :rank=>4, :score=>92.0}, {:member=>"member_91", :rank=>5, :score=>91.0}]
 ```
 
-The option `:sort_option` is useful for retrieving an arbitrary list of 
-members from a given leaderboard where you would like the data sorted 
+The option `:sort_option` is useful for retrieving an arbitrary list of
+members from a given leaderboard where you would like the data sorted
 when returned. The follow examples demonstrate its use:
 
 ```ruby
 friends = highscore_lb.ranked_in_list(['member_6', 'member_1', 'member_10'], :sort_by => :rank)
- => [{:member=>"member_10", :rank=>47, :score=>10.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_1", :rank=>56, :score=>1.0}] 
+ => [{:member=>"member_10", :rank=>47, :score=>10.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_1", :rank=>56, :score=>1.0}]
 ```
 
 ```ruby
 friends = highscore_lb.ranked_in_list(['member_6', 'member_1', 'member_10'], :sort_by => :score)
- => [{:member=>"member_1", :rank=>56, :score=>1.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_10", :rank=>47, :score=>10.0}] 
+ => [{:member=>"member_1", :rank=>56, :score=>1.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_10", :rank=>47, :score=>10.0}]
 ```
 
 ### Conditionally rank a member in the leaderboard
@@ -410,10 +414,15 @@ end
 
 The following ports have been made of the leaderboard gem.
 
+Officially supported:
+
 * CoffeeScript: https://github.com/agoragames/leaderboard-coffeescript
+* Python: https://github.com/agoragames/leaderboard-python
+
+Unofficially supported (they need some feature parity love):
+
 * Java: https://github.com/agoragames/java-leaderboard
 * PHP: https://github.com/agoragames/php-leaderboard
-* Python: https://github.com/agoragames/leaderboard-python
 * Scala: https://github.com/agoragames/scala-leaderboard
 
 ## Contributing to leaderboard

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/leaderboard.rb

@@ -29,10 +29,12 @@ class Leaderboard
   # Default options when requesting data from a leaderboard.
   # +:with_member_data+ false: Return member data along with the member names.
   # +:page_size+ nil: The default page size will be used.
+  # +:members_only+ false: Only return the member name, not their score and rank.
   # +:sort_by+ :none: The default sort for a call to `ranked_in_list`.
   DEFAULT_LEADERBOARD_REQUEST_OPTIONS = {
     :with_member_data => false,
     :page_size => nil,
+    :members_only => false,
     :sort_by => :none
   }
 
@@ -831,13 +833,15 @@ class Leaderboard
         end
         transaction.zscore(leaderboard_name, member)
       end
-    end
+    end unless leaderboard_options[:members_only]
 
     members.each_with_index do |member, index|
       data = {}
       data[:member] = member
-      data[:rank] = responses[index * 2] + 1 rescue nil
-      data[:score] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
+      unless leaderboard_options[:members_only]
+        data[:rank] = responses[index * 2] + 1 rescue nil
+        data[:score] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
+      end
 
       if leaderboard_options[:with_member_data]
         data[:member_data] = member_data_for_in(leaderboard_name, member)

data/spec/leaderboard_spec.rb

@@ -187,7 +187,7 @@ describe 'Leaderboard' do
 
     member_25 = {:member => 'member_25', :score => 25.0, :rank => 1, :member_data => { :member_name => "Leaderboard member 25" }.to_s }
     leaders[0].should == member_25
-    
+
     member_1 = {:member => 'member_1', :score => 1.0, :rank => 25, :member_data => { :member_name => "Leaderboard member 1" }.to_s }
     leaders[24].should == member_1
   end
@@ -590,7 +590,7 @@ describe 'Leaderboard' do
     members = @leaderboard.members_from_rank_range(5, 9)
     members.size.should be(5)
     members[0][:member].should eql('member_21')
-    members[0][:score].to_i.should be(21)    
+    members[0][:score].to_i.should be(21)
     members[4][:member].should eql('member_17')
 
     members = @leaderboard.members_from_rank_range(1, 1)
@@ -670,7 +670,7 @@ describe 'Leaderboard' do
 
   it 'should not delete all the member data when calling remove_member' do
     rank_members_in_leaderboard
-    
+
     @redis_connection.exists("name:member_data").should be_true
     @redis_connection.hgetall("name:member_data").size.should be(5)
     @leaderboard.total_members.should be(5)
@@ -679,4 +679,32 @@ describe 'Leaderboard' do
     @redis_connection.hgetall("name:member_data").size.should be(4)
     @leaderboard.total_members.should be(4)
   end
+
+  it 'should return the members only if the :members_only option is passed' do
+    rank_members_in_leaderboard(25)
+
+    leaders = @leaderboard.leaders(1, :page_size => 10, :members_only => true)
+    leaders.size.should == 10
+    leaders.collect { |leader| leader.keys.should == [:member] }
+
+    leaders = @leaderboard.all_leaders(:members_only => true)
+    leaders.size.should == 25
+    leaders.collect { |leader| leader.keys.should == [:member] }
+
+    leaders = @leaderboard.members_from_score_range(10, 14, :members_only => true)
+    leaders.size.should == 5
+    leaders.collect { |leader| leader.keys.should == [:member] }
+
+    leaders = @leaderboard.members_from_rank_range(1, 5, :page_size => 10, :members_only => true)
+    leaders.size.should == 5
+    leaders.collect { |leader| leader.keys.should == [:member] }
+
+    leaders = @leaderboard.around_me('member_10', :page_size => 3, :members_only => true)
+    leaders.size.should == 3
+    leaders.collect { |leader| leader.keys.should == [:member] }
+
+    leaders = @leaderboard.ranked_in_list(['member_1', 'member_25'], :members_only => true)
+    leaders.size.should == 2
+    leaders.collect { |leader| leader.keys.should == [:member] }
+  end
 end

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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.0.2
-  prerelease: 
+  version: 3.1.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -68,7 +61,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
 - CHANGELOG.markdown
 - Gemfile
 - LICENSE.txt
@@ -83,33 +78,26 @@ files:
 - spec/version_spec.rb
 homepage: https://github.com/agoragames/leaderboard
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !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.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Leaderboards backed by Redis in Ruby
 test_files:
 - spec/leaderboard_spec.rb

data/.rvmrc

@@ -1,2 +0,0 @@
-rvm --create 1.8.7@leaderboard_gem
-rvm --create 1.9.3@leaderboard_gem