NOTICE: Project is unmaintained because the Scoroid API no longer exists.

This repository is left for historical reasons.

Scoreoid Ruby

Summary

Scoreoid Ruby is a wrapper for the Scoreoid API.

Installation

Add this line to your application's Gemfile:

gem 'scoreoid'

And then execute:

$ bundle

Or install it yourself as:

$ gem install scoreoid

Usage

Full documentation is available online.

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')

Then you can start querying Scoreoid API methods:

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 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:

Scoreoid::Player.count # => 34

Contributing

Contributions are most welcome!

You can fork the source code on GitHub or BitBucket.

Please use the issue tracker if you encounter a bug or have a feature request.

License

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.