scoreoid 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGES.md

@@ -0,0 +1,9 @@
+Scoreoid Ruby Change Log
+========================
+
+2012-11-24 *v0.1.0*
+-------------------
+
+First development release.
+
+Currently the only feature is counting players with `Scoreoid::Player.count`, but hey, it works.

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec', '~> 2.12'
+gem 'yard', '~> 0.8.3'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin Workman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.

data/README.md

@@ -0,0 +1,59 @@
+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.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'scoreoid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoreoid
+
+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
+
+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.
+
+License
+-------
+
+Copyright © 2012 [Justin Workman](mailto:xtagon@gmail.com)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new(:yard)
+
+task default: :spec

data/lib/scoreoid.rb

@@ -0,0 +1,20 @@
+require 'scoreoid/version'
+require 'scoreoid/api_client'
+require 'scoreoid/player'
+
+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.
+	#
+	# @example
+	#    Scoreoid.configure(ENV['SCOREOID_API_KEY'], ENV['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}
+	end
+end

data/lib/scoreoid/api_client.rb

@@ -0,0 +1,61 @@
+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/lib/scoreoid/player.rb

@@ -0,0 +1,15 @@
+require 'scoreoid/api_client'
+
+module Scoreoid
+	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']
+		end
+	end
+end

data/lib/scoreoid/version.rb

@@ -0,0 +1,3 @@
+module Scoreoid
+	VERSION = '0.1.0'
+end

data/scoreoid.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'scoreoid/version'
+
+Gem::Specification.new do |gem|
+	gem.name = 'scoreoid'
+	gem.version = Scoreoid::VERSION
+	gem.author = 'Justin Workman'
+	gem.email = 'xtagon@gmail.com'
+	gem.summary = 'Scoreoid Ruby is a wrapper for the Scoreoid API.'
+
+	gem.required_ruby_version = '1.9.2'
+	gem.add_runtime_dependency 'multi_json', '~> 1.3'
+	gem.add_runtime_dependency 'rest-client', '~> 1.6'
+
+	gem.files = `git ls-files`.split($/)
+	gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+	gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+	gem.require_paths = ['lib']
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,80 @@
+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

@@ -0,0 +1,10 @@
+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/scoreoid_spec.rb

@@ -0,0 +1,14 @@
+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'
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+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
+
+  # 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

data/spec/version_spec.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: scoreoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Justin Workman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-25 00:00:00.000000000 Z
+dependencies:
+- !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: 
+email: xtagon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scoreoid.rb
+- lib/scoreoid/api_client.rb
+- lib/scoreoid/player.rb
+- lib/scoreoid/version.rb
+- scoreoid.gemspec
+- spec/api_client_spec.rb
+- spec/player_spec.rb
+- spec/scoreoid_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+homepage: 
+licenses: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Scoreoid Ruby is a wrapper for the Scoreoid API.
+test_files:
+- spec/api_client_spec.rb
+- spec/player_spec.rb
+- spec/scoreoid_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+has_rdoc: