scoreoid 0.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/.yardopts

@@ -0,0 +1,4 @@
+-
+CHANGES.md
+LICENSE.txt
+README.md

data/CHANGES.md

@@ -1,6 +1,21 @@
 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*
+-------------------
+
+- Allow passing date parameters (`:start_date` or `:end_date`) in natural language, such as "1 year ago". You can still pass a Date or Time object instead.
+
+2012-11-25 *v1.0.0*
+-------------------
+
+First stable release.
+
 2012-11-24 *v0.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,41 +1,79 @@
+## NOTICE: Project is unmaintained because the Scoroid API no longer exists.
+
+This repository is left for historical reasons.
+
 Scoreoid Ruby
 =============
 
-Scoreoid Ruby is a wrapper for the Scoreoid API. It is in the early development stages,
-with plans to support all Scoreoid API methods.
+[![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][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][2].
+
+To get started, configure Scoreoid Ruby with your API key and 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:
+
+``` 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.
+
+Future versions of Scoreoid Ruby will provide a more object-oriented manner of querying data. Then it will look more like 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 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
 
@@ -57,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/Rakefile

@@ -6,3 +6,8 @@ RSpec::Core::RakeTask.new(:spec)
 YARD::Rake::YardocTask.new(:yard)
 
 task default: :spec
+
+desc 'Start an IRB session in the context of the current bundle'
+task :irb do
+	sh 'bundle console'
+end

data/lib/scoreoid/api.rb

@@ -0,0 +1,99 @@
+require 'chronic'
+require 'multi_json'
+require 'rest_client'
+
+module Scoreoid
+	# This exception is raised when the Scoreoid API returns an error response.
+	class APIError < StandardError; end
+
+	# 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.
+			# This is so that you can, for example,  supply a Date object for :start_date
+			# even though the Scoreoid API expects it to be a string formatted as "YYYY-MM-DD".
+			#
+			# @param [String] api_method The Scoreoid API method to query
+			# @param [Hash] params Parameters to include in the API request
+			#
+			# @return [String] The Scoreoid API response
+			#
+			# @see .query_and_parse
+			def query(api_method, params={})
+				params = self.prepare_params(params)
+				params.merge!(self.default_params ||= {})
+				RestClient.post("https://www.scoreoid.com/api/#{api_method}", params)
+			end
+
+			# Query a given Scoreoid API method and parse the JSON response.
+			#
+			# The response type is set to 'json' for you automatically.
+			#
+			# @param [String] api_method The Scoreoid API method to query
+			# @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
+
+			# Attempt to coerce parameters into formats that the Scoreoid API expects.
+			#
+			# Date parameters will be parsed with Chronic, so you can supply dates in
+			# natural language such as "may 5th 2012" or "1 year ago".
+			#
+			# @param [Hash] params A hash of any parameters you wish to format.
+			#
+			# @option params [#to_s, #strftime] :start_date
+			# @option params [#to_s, #strftime] :end_date
+			#
+			# @return [Hash] The formatted parameters, ready to use in an API query.
+			def prepare_params(params)
+				params.each do |key, _|
+					if [:start_date, :end_date].include?(key)
+						if params[key].respond_to? :to_s
+							params[key] = Chronic.parse(params[key].to_s, context: :past)
+						end
+
+						if params[key].respond_to? :strftime
+							params[key] = params[key].strftime '%Y-%m-%d'
+						end
+					end
+				end
+				params
+			end
+		end
+	end
+end

data/lib/scoreoid/player.rb

@@ -1,15 +1,159 @@
-require 'scoreoid/api_client'
-
 module Scoreoid
+	# Represents the game players.
 	class Player
-		# @return [Integer] The total number of players for the game.
-		#
-		# @example
-		#    Scoreoid.configure 'YOUR_API_KEY', 'YOUR_GAME_ID'
-		#    
-		#    puts "This game has #{Scoreoid::Player.count} players!"
-		def self.count
-			Scoreoid::APIClient.countPlayers['players']
+		# Get the number of players for a game.
+		#
+		# @example Count the total number of players
+		#    puts "This game has #{Scoreoid::Player.count} total players."
+		#
+		# @example Count new players
+		#    count = Scoreoid::Player.count(start_date: '2012-11-01')
+		#    puts "There are #{count} new players since 2012-11-01."
+		#
+		# @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,3 +1,4 @@
 module Scoreoid
-	VERSION = '0.1.0'
+	# The currently loaded Scoreoid Ruby version.
+	VERSION = '1.1.1.alpha'
 end

data/lib/scoreoid.rb

@@ -1,20 +1,28 @@
 require 'scoreoid/version'
-require 'scoreoid/api_client'
+require 'scoreoid/api'
 require 'scoreoid/player'
 
+# The main Scoreoid Ruby namespace.
+#
+# To get started, set your Scoreoid API key and game ID with {Scoreoid.configure}.
+# Then you can use {Scoreoid::API.query_and_parse} to query any Scoreoid API method.
+# See the {http://wiki.scoreoid.net/category/api/ Scoreoid Wiki} for information
+# on available API methods.
 module Scoreoid
-	# This exception is raised when Scoreoid Ruby is used without first being configured.
-	# To configure Scoreoid Ruby, see {Scoreoid.configure}.
-	class NotConfiguredError < RuntimeError; end
-
-	# Configure Scoreoid Ruby with your Scoreoid API key and game ID.
-	# This must be done once before calling any Scoreoid API methods.
+	# Configure Scoreoid Ruby by setting default API request parameters.
+	# You can set any parameters here, but it is only recommended to set
+	# :api_key and :game_id as they are common to all API methods.
+	#
+	# @example Setting your API key and game ID from environment variables:
+	#    Scoreoid.configure(api_key: ENV['SCOREOID_API_KEY'], game_id: ENV['SCOREOID_GAME_ID'])
+	#
+	# @param [Hash] params A hash of default parameters to set
 	#
-	# @example
-	#    Scoreoid.configure(ENV['SCOREOID_API_KEY'], ENV['SCOREOID_GAME_ID'])
+	# @option params [String] :api_key Your Scoreoid API key
+	# @option params [String] :game_id Your Scoreoid game ID
 	#
-	# @return [Hash] A hash of the parameters you just configured.
-	def self.configure(api_key, game_id)
-		Scoreoid::APIClient.default_params = {api_key: api_key, game_id: game_id}
+	# @return [Hash] The parameters you just set
+	def self.configure(params)
+		Scoreoid::API.default_params = params
 	end
 end

data/scoreoid.gemspec

@@ -9,8 +9,12 @@ Gem::Specification.new do |gem|
 	gem.author = 'Justin Workman'
 	gem.email = 'xtagon@gmail.com'
 	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'
 	gem.add_runtime_dependency 'rest-client', '~> 1.6'
 

data/spec/scoreoid/api_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Scoreoid::API do
+	before :each do
+		# Tests should be run independantly, so I don't understand why this is neccessary :/
+		Scoreoid.configure({})
+	end
+
+	describe '.query' do
+		it 'should query a Scoreoid API method and return the response as a string' do
+			example_response = %q({"players": 7})
+			given_params = {response: 'json', api_key: 'API_KEY', game_id: 'GAME_ID'}
+
+			RestClient.stub(:post).and_return(example_response)
+			RestClient.should_receive(:post).with('https://www.scoreoid.com/api/playerCount', given_params)
+
+			api_response = Scoreoid::API.query('playerCount', given_params)
+			api_response.should be_instance_of String
+			api_response.should == example_response
+		end
+
+		it 'should use default params if they are set' do
+			example_response = %q({"players": 7})
+			default_params = {api_key: 'API_KEY', game_id: 'GAME_ID'}
+			given_params = {start_date: '2009-01-01'}
+			expected_params = default_params.merge(given_params)
+
+			RestClient.stub(:post).and_return(example_response)
+			RestClient.should_receive(:post).with('https://www.scoreoid.com/api/playerCount', expected_params)
+
+			Scoreoid.configure(default_params)
+			Scoreoid::API.query('playerCount', given_params)
+		end
+
+		it 'should format the parameters before sending' do
+			example_response = %q({"players": 7})
+			given_params = {start_date: Date.new(2010, 1, 1), end_date: 'december 3rd 2011'}
+			formatted_params = {start_date: '2010-01-01', end_date: '2011-12-03'}
+
+			RestClient.stub(:post).and_return(example_response)
+			RestClient.should_receive(:post).with('https://www.scoreoid.com/api/playerCount', formatted_params)
+
+			Scoreoid::API.query('playerCount', given_params)
+		end
+	end
+
+	describe '.query_and_parse' do
+		it 'should query a Scoreoid API method and parse the JSON response' do
+			given_params = {api_key: 'API_KEY', game_id: 'GAME_ID'}
+			params_plus_response_param = given_params.merge(response: 'json')
+
+			Scoreoid::API.stub(:query).and_return(%q({"players": 7}))
+			Scoreoid::API.should_receive(:query).with('playerCount', params_plus_response_param)
+
+			parsed_response = Scoreoid::API.query_and_parse('playerCount', given_params)
+			parsed_response.should be_instance_of Hash
+			parsed_response.should == {'players' => 7}
+		end
+
+		it 'should raise an error if the Scoreoid API returned one in the JSON' do
+			response_with_error = %q({"error": "The API key is broken or the game is not active"})
+
+			Scoreoid::API.stub(:query).and_return(response_with_error)
+			
+			expect 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

data/spec/scoreoid_spec.rb

@@ -1,14 +1,12 @@
 require 'spec_helper'
 
 describe Scoreoid do
-	describe 'self.configure' do
-		it 'should set Scoreoid API key and game ID parameters' do
-			Scoreoid.configure('API_KEY', 'GAME_ID')
-			default_params = Scoreoid::APIClient.class_variable_get(:@@default_params)
-			default_params.key?(:api_key).should be_true
-			default_params.key?(:game_id).should be_true
-			default_params[:api_key].should == 'API_KEY'
-			default_params[:game_id].should == 'GAME_ID'
+	describe '.configure' do
+		it 'should set default API parameters' do
+			default_params = {api_key: 'API_KEY', game_id: 'GAME_ID'}
+			Scoreoid::API.should_receive(:default_params=).and_return(default_params)
+			returned_default_params = Scoreoid.configure(default_params)
+			returned_default_params.should == default_params
 		end
 	end
 end

data/spec/spec_helper.rb

@@ -2,13 +2,13 @@ require 'scoreoid'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+	config.treat_symbols_as_metadata_keys_with_true_values = true
+	config.run_all_when_everything_filtered = true
+	config.filter_run :focus
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  #config.order = 'random'
+	# Run specs in random order to surface order dependencies. If you find an
+	# order dependency and want to debug it, you can fix the order by providing
+	# the seed, which is printed after each run.
+	#     --seed 1234
+	config.order = 'random'
 end

metadata

@@ -1,46 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: scoreoid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 1.1.1.alpha
 platform: ruby
 authors:
 - Justin Workman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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: 
@@ -49,51 +58,52 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/scoreoid.rb
-- lib/scoreoid/api_client.rb
+- lib/scoreoid/api.rb
 - lib/scoreoid/player.rb
 - lib/scoreoid/version.rb
 - scoreoid.gemspec
-- spec/api_client_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: []
+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_client_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/lib/scoreoid/api_client.rb

@@ -1,61 +0,0 @@
-require 'multi_json'
-require 'rest_client'
-
-module Scoreoid
-	# This exception is raised when the Scoreoid API returns an error response.
-	class APIError < StandardError; end
-
-	class APIClient
-		REQUIRED_PARAMETERS = [:api_key, :game_id]
-
-		@@default_params = Hash.new
-
-		# Set the default request parameters.
-		# Normally you would not call this directly, but instead use {Scoreoid.configure}.
-		#
-		# @param [Hash] params A hash of the default parameters to set.
-		#
-		# @return [Hash] Default request parameters.
-		def self.default_params= params
-			@@default_params = params
-		end
-
-		# Get the default request parameters.
-		#
-		# @raise [Scoreoid::NotConfiguredError] if required parameters are not set.
-		#
-		# @return Default request paremeters.
-		def self.default_params
-			REQUIRED_PARAMETERS.each do |param_key|
-				unless @@default_params.key?(param_key)
-					raise Scoreoid::NotConfiguredError, "Scoreoid Ruby has not been configured correctly. Please set the API key and game ID with Scoreoid.configure(api_key, game_id) before using this library."
-				end
-			end
-
-			@@default_params
-		end
-
-		# Query the Scoreoid API and return the un-parsed response.
-		# This is used internally and you should only call it if you really know what you're doing.
-		def self.api_call(api_method)
-			# Add :response => 'json' to the post parameters because the entire library
-			# epects JSON responses.
-			post_params = self.default_params.merge({response: 'json'})
-			RestClient.post("https://www.scoreoid.com/api/#{api_method}", post_params)
-		end
-
-		# Query the Scoreoid API method "countPlayers()" and parse the response.
-		#
-		# @see Scoreoid::Player.count
-		#
-		# @raise [Scoreoid::APIError] if the Scoreoid API returns an error response.
-		#
-		# @return [Hash] The Scoreoid API response parsed into a Hash.
-		def self.countPlayers
-			api_response = self.api_call('countPlayers')
-			json = MultiJson.load(api_response)
-			raise APIError, json['error'] if json.key? 'error'
-			json
-		end
-	end
-end

data/spec/api_client_spec.rb

@@ -1,80 +0,0 @@
-require 'spec_helper'
-
-describe Scoreoid::APIClient do
-	describe 'self.default_params' do
-		it 'should be set to empty hash by default' do
-			Scoreoid::APIClient.class_variable_get(:@@default_params).should be_instance_of Hash
-		end
-
-		context 'setting default parameters' do
-			it 'should set default parameters when required parameters are provided' do
-				example_params = {api_key: 'API_KEY', game_id: 'GAME_ID'}
-				Scoreoid::APIClient.default_params = example_params
-				Scoreoid::APIClient.class_variable_get(:@@default_params).should == example_params
-			end
-		end
-
-		context 'getting default parameters' do
-			it 'returns exactly the parameters which were set' do
-				example_params = {api_key: 'API_KEY', game_id: 'GAME_ID'}
-				Scoreoid::APIClient.default_params = example_params
-				Scoreoid::APIClient.default_params.should == example_params
-			end
-
-			it 'raises an error if required parameters are absent' do
-				Scoreoid::APIClient.default_params = {api_key: 'API_KEY'} # missing :game_id
-				expect do
-					Scoreoid::APIClient.default_params
-				end.to raise_error Scoreoid::NotConfiguredError
-
-				Scoreoid::APIClient.default_params = {game_key: 'GAME_ID'} # missing :api_key
-				expect do
-					Scoreoid::APIClient.default_params
-				end.to raise_error Scoreoid::NotConfiguredError
-			end
-		end
-	end
-
-	describe 'self.api_call' do
-		it 'should call Scoreoid API methods with default parameters' do
-			# We're testing that :response => 'json' is added to the parameters
-			# because the entire library expects JSON responses.
-
-			example_response = %q({"players": 7})
-			default_params = {api_key: 'API_KEY', game_id: 'GAME_ID'}
-			post_params = default_params.merge({response: 'json'})
-
-			Scoreoid::APIClient.stub(:default_params).and_return(default_params)
-			RestClient.stub(:post).and_return(example_response)
-			RestClient.should_receive(:post).with('https://www.scoreoid.com/api/playerCount', post_params)
-
-			api_response = Scoreoid::APIClient.api_call('playerCount')
-			api_response.should be_instance_of String
-			api_response.should == example_response
-		end
-	end
-
-	describe 'self.countPlayers' do
-		it 'should call the countPlayers() Scoreoid API method' do
-			Scoreoid::APIClient.stub(:api_call).and_return(%q({"players":7}))
-			Scoreoid::APIClient.should_receive(:api_call).with('countPlayers')
-			Scoreoid::APIClient.countPlayers
-		end
-
-		it 'should parse the JSON result into a Hash' do
-			Scoreoid::APIClient.stub(:api_call).and_return(%q({"players":7}))
-			result = Scoreoid::APIClient.countPlayers
-			result.should be_instance_of Hash
-			result.should == {'players' => 7}
-		end
-
-		it 'should raise an error if the Scoreoid API returns an error' do
-			example_response = %q({"error": "The API key is broken or the game is not active"})
-			Scoreoid::APIClient.stub(:api_call).and_return(example_response)
-			
-			expect do
-				Scoreoid::APIClient.countPlayers
-			end.to raise_error(Scoreoid::APIError, 'The API key is broken or the game is not active')
-		end
-	end
-end

data/spec/player_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe Scoreoid::Player do
-	it 'should count players' do
-		Scoreoid::APIClient.should_receive(:countPlayers).and_return({'players' => 7})
-		how_many_players = Scoreoid::Player.count
-		how_many_players.should be_kind_of Integer
-		how_many_players.should >= 0
-	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