scoreoid 1.1.0 → 1.1.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 053fe26edc9947c41476ce2e2539a66d6e928e5dc09ef8cf9883e3d606af0c06
+  data.tar.gz: 7d03f92f8fb9d44337f494a60ccd715e0c61e226e5c0ee84e7e740c4d9e58865
+SHA512:
+  metadata.gz: 7bebbfe865785aa65cec817db5b8032c2aa896c0ce2fb9b45331d2256d12b75d52601c2befe262900818eef835b7e87c7065f1bbd4fa8211480fd7821d89515a
+  data.tar.gz: 80b430ad30cfe62d0f010141a2a9c55e7393118e72daeb73662f0ac67d2563e0e8203e4dfea22b82c1078191649d6dc1da7dba19ed9c452a167e95794dc0f825

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+rvm: [ruby-head, 2.0.0, 1.9.3, 1.9.2]

data/CHANGES.md

@@ -1,6 +1,11 @@
 Scoreoid Ruby Change Log
 ========================
 
+2012-11-25 *v1.1.1*
+-------------------
+
+- Fix a issue that occured when parsing API responses where the root node is an array.
+
 2012-11-25 *v1.1.0*
 -------------------
 

data/Gemfile

@@ -2,5 +2,9 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rspec', '~> 2.12'
-gem 'yard', '~> 0.8.3'
+group :development do
+	gem 'rake'
+	gem 'rspec', '~> 2.12'
+	gem 'yard', '~> 0.8.3'
+	gem 'travis-lint'
+end

data/README.md

@@ -1,62 +1,79 @@
+## NOTICE: Project is unmaintained because the Scoroid API no longer exists.
+
+This repository is left for historical reasons.
+
 Scoreoid Ruby
 =============
 
+[![Build Status](https://travis-ci.org/xtagon/scoreoid-gem.png)](https://travis-ci.org/xtagon/scoreoid-gem)
+
 Summary
 -------
 
-Scoreoid Ruby is a wrapper for the [Scoreoid](https://www.scoreoid.com/) API.
+Scoreoid Ruby is a wrapper for the [Scoreoid][1] API.
 
 Installation
 ------------
 
 Add this line to your application's Gemfile:
 
-    gem 'scoreoid'
+``` ruby
+gem 'scoreoid'
+```
 
 And then execute:
 
-    $ bundle
+``` shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install scoreoid
+``` shell
+$ gem install scoreoid
+```
 
 Usage
 -----
 
-Full documentation is [available online](http://rubydoc.info/gems/scoreoid/frames).
+Full documentation is [available online][2].
 
 To get started, configure Scoreoid Ruby with your API key and game ID:
 
-    require 'scoreoid'
-    
-    Scoreoid.configure(api_key: 'YOUR_API_KEY', game_id: 'YOUR_GAME_ID')
+``` ruby
+require 'scoreoid'
+
+Scoreoid.configure(api_key: 'YOUR_API_KEY', game_id: 'YOUR_GAME_ID')
+```
 
 Then you can start querying Scoreoid API methods:
 
-    new_players_count = Scoreoid::API.query('countPlayers', start_date: '2009-08-04')
+``` ruby
+new_players_count = Scoreoid::API.query('countPlayers', start_date: '2009-08-04')
+new_players_count['players'] # => 34
+```
+
+Any Scoreoid API method may be called in this manner. See the [Scoreoid Wiki][3] for information on available API methods.
 
-Any Scoreoid API method may be called in this mannor. See the [Scoreoid Wiki](http://wiki.scoreoid.net/category/api/) for information on available API methods.
+Future versions of Scoreoid Ruby will provide a more object-oriented manner of querying data. Then it will look more like this:
 
-Future versions of Scoreoid Ruby will provide a more object-oriented mannor of querying data. See the `Scoreoid::Player` class for a basic example of this.
+``` ruby
+Scoreoid::Player.count # => 34
+```
 
 Contributing
 ------------
 
 Contributions are most welcome!
 
-1. [Fork it on Bitbucket](https://bitbucket.org/xtagon/scoreoid-ruby-gem/fork)
-2. Create your feature branch (`git checkout -b feature/my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+You can fork the source code on [GitHub][4] or [BitBucket][5].
 
-Please use the [issue tracker](https://bitbucket.org/xtagon/scoreoid-ruby-gem/issues?status=new&status=open) if you encounter a bug or have a feature request.
+Please use the [issue tracker][6] if you encounter a bug or have a feature request.
 
 License
 -------
 
-Copyright © 2012 [Justin Workman](mailto:xtagon@gmail.com)
+Copyright © 2012-2013 [Justin Workman](mailto:xtagon@gmail.com)
 
 MIT License
 
@@ -78,3 +95,10 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[1]: https://rubygems.org/gems/scoreoid
+[2]: http://rubydoc.info/gems/scoreoid/frames
+[3]: http://wiki.scoreoid.net/category/api/
+[4]: https://github.com/xtagon/scoreoid-gem
+[5]: https://bitbucket.org/xtagon/scoreoid-gem
+[6]: https://github.com/xtagon/scoreoid-gem/issues

data/lib/scoreoid/api.rb

@@ -9,6 +9,11 @@ module Scoreoid
 	# A singleton class with methods for querying the Scoreoid API.
 	class API
 		class << self
+			# Default API request parameters used by {.query}
+			#
+			# This would normally be set with {Scoreoid.configure}
+			attr_accessor :default_params
+
 			# Query a given Scoreoid API method and return the repsonse as a string.
 			#
 			# Supplied parameters will be prepared with {.prepare_params} before sending.
@@ -35,18 +40,32 @@ module Scoreoid
 			# @param [Hash] params Parameters to include in the API request.
 			#
 			# @raise [Scoreoid::APIError] if the Scoreoid API returns an error response.
+			# @raise [MultiJson::DecodeError] if the Scoreoid API response can't be parsed
+			#    (report a bug if this happens!)
 			#
 			# @return [Hash] The Scoreoid API response parsed into a Hash.
 			#
 			# @see .query
 			def query_and_parse(api_method, params={})
+				# We're gonna parse JSON, so ask for JSON
 				params = params.merge(response: 'json')
 
+				# Query Scoreoid
 				api_response = self.query(api_method, params)
+
+				# Fix for API responses that return arrays (they can't be parsed by MultiJson)
+				if api_response =~ /\A\[/ and api_response =~ /\]\Z/
+					api_response.sub!(/\A\[/, '') # Remove leading bracket
+					api_response.sub!(/\]\Z/, '') # Remove trailing bracket
+				end
+
+				# Parse the response
 				parsed_result = MultiJson.load(api_response)
 
+				# Raise an error if the response JSON contained one
 				raise APIError, parsed_result['error'] if parsed_result.key? 'error'
 
+				# Return the parsed result
 				parsed_result
 			end
 
@@ -75,11 +94,6 @@ module Scoreoid
 				end
 				params
 			end
-
-			# Default API request parameters used by {.query}
-			#
-			# This would normally be set with {Scoreoid.configure}
-			attr_accessor :default_params
 		end
 	end
 end

data/lib/scoreoid/player.rb

@@ -1,7 +1,7 @@
 module Scoreoid
 	# Represents the game players.
 	class Player
-		# Get the number of players for the game.
+		# Get the number of players for a game.
 		#
 		# @example Count the total number of players
 		#    puts "This game has #{Scoreoid::Player.count} total players."
@@ -10,13 +10,150 @@ module Scoreoid
 		#    count = Scoreoid::Player.count(start_date: '2012-11-01')
 		#    puts "There are #{count} new players since 2012-11-01."
 		#
-		# @param [Hash] params Optional criteria for counting players.
-		# @option params [Date, Time, String] :start_date Start date ("YYYY-MM-DD" if passed as String)
-		# @option params [Date, Time, String] :end_date End date ("YYYY-MM-DD" if passed as String)
+		# @param [Hash] params Parameters to include in the API request.
+		#    Default parameters set with {Scoreoid.configure} will be included for you.
+		#
+		# @option params [String] :api_key Your Scoreoid API key
+		# @option params [String] :game_id The game ID
+		# @option params [Date, Time, String] :start_date optional
+		# @option params [Date, Time, String] :end_date optional
 		#
 		# @return [Integer] The number of players.
 		def self.count(params={})
 			Scoreoid::API.query_and_parse('countPlayers', params)['players']
 		end
+
+		# Create a new player for a game.
+		#
+		# @example Create a player named Bob
+		#    Scoreoid::Player.create(username: 'bob', first_name: 'Bob', last_name: 'Ross')
+		#
+		# @param [Hash] params Parameters to include in the API request.
+		#    Default parameters set with {Scoreoid.configure} will be included for you.
+		#
+		# @option params [String] :api_key Your Scoreoid API key
+		# @option params [String] :game_id The game ID
+		# @option params [String] :username The player's username (required)
+		# @option params [String] :password Optional
+		# @option params [String] :score optional
+		# @option params [String] :difficulty optional
+		# @option params [String] :unique_id optional
+		# @option params [String] :first_name optional
+		# @option params [String] :last_name optional
+		# @option params [String] :email optional
+		# @option params [String] :created optional
+		# @option params [String] :updated optional
+		# @option params [String] :bonus optional
+		# @option params [String] :achievements optional
+		# @option params [String] :best_score optional
+		# @option params [String] :gold optional
+		# @option params [String] :money optional
+		# @option params [String] :kills optional
+		# @option params [String] :lives optional
+		# @option params [String] :time_played optional
+		# @option params [String] :unlocked_levels optional
+		# @option params [String] :unlocked_items optional
+		# @option params [String] :inventory optional
+		# @option params [String] :last_level optional
+		# @option params [String] :current_level optional
+		# @option params [String] :current_time optional
+		# @option params [String] :current_bonus optional
+		# @option params [String] :current_kills optional
+		# @option params [String] :current_achievements optional
+		# @option params [String] :current_gold optional
+		# @option params [String] :current_unlocked_levels optional
+		# @option params [String] :current_unlocked_items optional
+		# @option params [String] :current_lives optional
+		# @option params [String] :xp optional
+		# @option params [String] :energy optional
+		# @option params [String] :boost optional
+		# @option params [String] :latitude optional
+		# @option params [String] :longitude optional
+		# @option params [String] :game_state optional
+		# @option params [String] :platform optional
+		#
+		# @raise [Scoreoid::APIError] if the player could not be created
+		#
+		# @return [Hash] The API response from Scoreoid (should contain a success message)
+		def self.create(params={})
+			Scoreoid::API.query_and_parse('createPlayer', params)
+		end
+
+		# Edit player information.
+		#
+		# @example Update John's first and last name
+		#    Scoreoid::Player.edit(username: 'john', first_name: 'John', last_name: 'Dough')
+		#
+		# @param [Hash] params Parameters to include in the API request.
+		#    Default parameters set with {Scoreoid.configure} will be included for you.
+		#
+		# @option params [String] :api_key Your Scoreoid API key
+		# @option params [String] :game_id The game ID
+		# @option params [String] :username The player's username (required)
+		# @option params [String] :password Optional
+		# @option params [String] :score optional
+		# @option params [String] :difficulty optional
+		# @option params [String] :unique_id optional
+		# @option params [String] :first_name optional
+		# @option params [String] :last_name optional
+		# @option params [String] :email optional
+		# @option params [String] :created optional
+		# @option params [String] :updated optional
+		# @option params [String] :bonus optional
+		# @option params [String] :achievements optional
+		# @option params [String] :best_score optional
+		# @option params [String] :gold optional
+		# @option params [String] :money optional
+		# @option params [String] :kills optional
+		# @option params [String] :lives optional
+		# @option params [String] :time_played optional
+		# @option params [String] :unlocked_levels optional
+		# @option params [String] :unlocked_items optional
+		# @option params [String] :inventory optional
+		# @option params [String] :last_level optional
+		# @option params [String] :current_level optional
+		# @option params [String] :current_time optional
+		# @option params [String] :current_bonus optional
+		# @option params [String] :current_kills optional
+		# @option params [String] :current_achievements optional
+		# @option params [String] :current_gold optional
+		# @option params [String] :current_unlocked_levels optional
+		# @option params [String] :current_unlocked_items optional
+		# @option params [String] :current_lives optional
+		# @option params [String] :xp optional
+		# @option params [String] :energy optional
+		# @option params [String] :boost optional
+		# @option params [String] :latitude optional
+		# @option params [String] :longitude optional
+		# @option params [String] :game_state optional
+		# @option params [String] :platform optional
+		#
+		# @raise [Scoreoid::APIError] if the player could not be updated
+		#
+		# @return [Hash] The API response from Scoreoid (should contain a success message)
+		def self.edit(params={})
+			Scoreoid::API.query_and_parse('editPlayer', params)
+		end
+
+		# Updates a players field.
+		#
+		# @example Update John's e-mail address
+		#    Scoreoid::Player.update_field(username: 'john', field: 'email', value: 'john@example.com')
+		#
+		# @param [Hash] params Parameters to include in the API request.
+		#    Default parameters set with {Scoreoid.configure} will be included for you.
+		#
+		# @option params [String] :api_key Your Scoreoid API key
+		# @option params [String] :game_id The game ID
+		# @option params [String] :username The player's username (required)
+		# @option params [String] :field The field name to update (see {.edit})
+		# @option params [String] :value The value to set
+		#
+		# @raise [Scoreoid::APIError] if the field could not be updated
+		#
+		# @return [Hash] The API response from Scoreoid (should contain a success message)
+		def self.update_field(params={})
+			Scoreoid::API.query_and_parse('updatePlayerField', params)
+		end
 	end
 end

data/lib/scoreoid/version.rb

@@ -1,4 +1,4 @@
 module Scoreoid
 	# The currently loaded Scoreoid Ruby version.
-	VERSION = '1.1.0'
+	VERSION = '1.1.1.alpha'
 end

data/scoreoid.gemspec

@@ -11,6 +11,8 @@ Gem::Specification.new do |gem|
 	gem.summary = 'Scoreoid Ruby is a wrapper for the Scoreoid API.'
 	gem.license = 'MIT'
 
+	gem.metadata = { 'rubygems_mfa_required' => 'true' }
+
 	gem.required_ruby_version = '1.9.2'
 	gem.add_runtime_dependency 'chronic', '~> 0.8.0'
 	gem.add_runtime_dependency 'multi_json', '~> 1.3'

data/spec/{api_spec.rb → scoreoid/api_spec.rb}

@@ -66,5 +66,14 @@ describe Scoreoid::API do
 				Scoreoid::API.query_and_parse('getScores')
 			end.to raise_error(Scoreoid::APIError, 'The API key is broken or the game is not active')
 		end
+
+		it 'should not raise an error if the the response is an array' do
+			example_response = %q([{"Player": {"username": "pwner"}}])
+			Scoreoid::API.stub(:query).and_return(example_response)
+
+			expect do
+				Scoreoid::API.query_and_parse('getPlayer', username: 'someuser')
+			end.to_not raise_error
+		end
 	end
 end

data/spec/scoreoid/player_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Scoreoid::Player do
+	describe '.create' do
+		it 'should return true on successfully creating a player' do
+			success_response = %q({"success":["The player has been created"]})
+			params = {username: 'AzureDiamond', password: 'hunter2'}
+
+			Scoreoid::API.stub(:query_and_parse).and_return(success_response)
+			Scoreoid::API.should_receive(:query_and_parse).with('createPlayer', params)
+
+			expect do
+				Scoreoid::Player.create(params).should be_true
+			end.to_not raise_error
+		end
+	end
+
+	describe '.count' do
+		it 'should count players with no query parameters' do
+			Scoreoid::API.stub(:query_and_parse).and_return({'players' => 7})
+			Scoreoid::API.should_receive(:query_and_parse).with('countPlayers', {})
+			count = Scoreoid::Player.count
+			count.should == 7
+		end
+
+		it 'should count players with query parameters' do
+			params = {start_date: '2011-11-01', end_date: Time.now}
+			Scoreoid::API.stub(:query_and_parse).and_return({'players' => 7})
+			Scoreoid::API.should_receive(:query_and_parse).with('countPlayers', params)
+			count = Scoreoid::Player.count(params)
+			count.should == 7
+		end
+	end
+
+	describe '.create' do
+		it 'should create the player and return the parsed API response' do
+			success_response = {'success' => ['The player has been created']}
+			params = {username: 'AzureDiamond', password: 'hunter2'}
+
+			Scoreoid::API.stub(:query_and_parse).and_return(success_response)
+			Scoreoid::API.should_receive(:query_and_parse).with('createPlayer', params)
+
+			response = Scoreoid::Player.create(params)
+			response.should == success_response
+		end
+	end
+
+	describe '.edit' do
+		it 'should edit the player and return the parsed API response' do
+			success_response = {'success' => ['The player has been updated']}
+			params = {username: 'AzureDiamond', password: '*******'}
+
+			Scoreoid::API.stub(:query_and_parse).and_return(success_response)
+			Scoreoid::API.should_receive(:query_and_parse).with('editPlayer', params)
+
+			response = Scoreoid::Player.edit(params)
+			response.should == success_response
+		end
+	end
+
+	describe '.update_field' do
+		it 'should update the player field and return the parsed API response' do
+			success_response = {'success' => ['The player field last_name has been updated']}
+			params = {username: 'john', field: 'last_name', value: 'Doe'}
+
+			Scoreoid::API.stub(:query_and_parse).and_return(success_response)
+			Scoreoid::API.should_receive(:query_and_parse).with('updatePlayerField', params)
+
+			response = Scoreoid::Player.update_field(params)
+			response.should == success_response
+		end
+	end
+end

data/spec/scoreoid/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Scoreoid do
+	it 'has a valid version constant' do
+		# This regex is far from perfect, but it should keep me from accidentally
+		# doing something stupid to the version.
+		Scoreoid::VERSION.should =~ /\A\d+\.\d+\.\d+(\.\w+)?\Z/
+	end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: scoreoid
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.1.1.alpha
 platform: ruby
 authors:
 - Justin Workman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 description: 
@@ -65,9 +58,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -78,40 +72,38 @@ files:
 - lib/scoreoid/player.rb
 - lib/scoreoid/version.rb
 - scoreoid.gemspec
-- spec/api_spec.rb
-- spec/player_spec.rb
+- spec/scoreoid/api_spec.rb
+- spec/scoreoid/player_spec.rb
+- spec/scoreoid/version_spec.rb
 - spec/scoreoid_spec.rb
 - spec/spec_helper.rb
-- spec/version_spec.rb
 homepage: 
 licenses:
 - MIT
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.3.18
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Scoreoid Ruby is a wrapper for the Scoreoid API.
 test_files:
-- spec/api_spec.rb
-- spec/player_spec.rb
+- spec/scoreoid/api_spec.rb
+- spec/scoreoid/player_spec.rb
+- spec/scoreoid/version_spec.rb
 - spec/scoreoid_spec.rb
 - spec/spec_helper.rb
-- spec/version_spec.rb
-has_rdoc: 

data/spec/player_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-describe Scoreoid::Player do
-	describe '.count' do
-		it 'should count players with no query parameters' do
-			Scoreoid::API.stub(:query_and_parse).and_return({'players' => 7})
-			Scoreoid::API.should_receive(:query_and_parse).with('countPlayers', {})
-			count = Scoreoid::Player.count
-			count.should == 7
-		end
-
-		it 'should count players with query parameters' do
-			params = {start_date: '2011-11-01', end_date: Time.now}
-			Scoreoid::API.stub(:query_and_parse).and_return({'players' => 7})
-			Scoreoid::API.should_receive(:query_and_parse).with('countPlayers', params)
-			count = Scoreoid::Player.count(params)
-			count.should == 7
-		end
-	end
-end

data/spec/version_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe Scoreoid do
-	it 'has a valid version constant' do
-		Scoreoid::VERSION.should =~ /\A\d+\.\d+\.\d+\Z/
-	end
-end