ZombieBattleground::Api

Challenge Accepted

Ruby implementation of the Public API for Zombie Battleground

Installation

Add this line to your application's Gemfile:

gem 'zombie_battleground-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zombie_battleground-api

Usage

See the API documentation. Every API call returns a response object that contains a complete modeled Ruby object of the response.

Use the singleton class ZombieBattleground::Api. The singleton has additional extentions, the client implements the public API as is.

require 'zombie_battleground/api'

ZombieBattleground::Api.decks_request(limit: 1)
# => ZombieBattleground::Api::Responses::GetDecksResponse

ZombieBattleground::Api.decks(limit: 1)
# => [ZombieBattleground::Api::Models::Decks]

Use the API client directly

require 'zombie_battleground/api/client'

client = ZombieBattleground::Api::Client.new

client.decks_request(limit: 1)
# => ZombieBattleground::Api::Responses::GetDecksResponse

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

You can also execute docker-compose build && docker-compose run zombie_battleground-api to run within a Docker container that drops into a Pry session to experiment with (this is how I have developed this gem).

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/watmin/zombie_battleground-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ZombieBattleground::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.