Openkit
The ruby client for OpenKit's gaming backend.
Installation
gem install 'openkit'
Or add the following line to your application's Gemfile:
gem 'openkit'
And run bundle install
from your shell.
Usage
Get your app_key and secret_key from https://developer.openkit.io.
Set credentials:
OpenKit::Config.app_key = "<your-app-key>"
OpenKit::Config.secret_key = "<your-secret-key>"
OpenKit::Config.skip_https = true # required unless you're using the beta-api endpoint
Request examples:
include OpenKit::Request
# Get
response = Get.new('/v1/leaderboards').perform
# Post
response = Post.new('/v1/users', {:nick => 'lou'}).perform
# Put
response = Put.new('/v1/users/:id', {:nick => 'lou z'}).perform
# Multipart Post
upload = Upload.new('<param-name-of-upload>', '<path-to-file>')
req = OpenKit::PostMultipart.new('/v1/scores', {:score => {:value => 100}}, upload)
response = req.perform
Parse the response:
json = JSON.parse(response.body)
Check the response headers:
puts response.code
response.header.each { |h, v| puts "#{h}: #{v}" }
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request