Ruby>> clash-api>> 返回
项目作者： leocabeza

项目描述 ：
Ruby wrapper for the Clash of Clans API
高级语言： Ruby
项目地址: git://github.com/leocabeza/clash-api.git
创建时间： 2016-04-29T19:52:41Z
项目社区：https://github.com/leocabeza/clash-api
开源协议：MIT License
下载


Clashinator

Ruby wrapper for the Clash of Clans API, based on the v1 version

Note: These docs were updated for the new tagged version 1.0

Installation

Add this line to your application’s Gemfile:

  1. gem 'clashinator'

And then execute:

  1. $ bundle

Or install it yourself as:

  1. $ gem install clashinator

Usage

You’ll need to generate an access token in Clash of Clans developer page at:
https://developer.clashofclans.com

With your access token, retrieve a client instance with it.

client = Clashinator::Client.new('YOUR TOKEN')

All query options can be passed as underscored variables instead of
camelcased, query options available are at: https://developer.clashofclans.com

There are several types of objects you can retrieve:

  1. clans = client.search_clans(name: 'vzlan warriors', min_members: 25)
  3. clan = client.clan_info('#VQ2QUJG')
  5. players = client.list_clan_members('#VQ2QUJG')
  7. war_log = client.clan_war_log('#VQ2QUJG')
  9. locations = client.list_locations
  11. location = client.location_info(32000254)
  13. clan_rankings = client.location_clan_rankings(32000254)
  15. player_rankings = client.location_player_rankings(32000254)
  17. leagues = client.list_leagues
  19. league = client.league_info(29000022)
  21. seasons = client.league_seasons(29000022)
  23. player_rankings = client.league_season_rankings(29000022, '2015-10')
  25. player = client.player_info('#QOCRLV90')

Development

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

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.

Create a new file called secrets.yml in the config folder with the contents of config/secrets.sample.yml
Then, you’ll need to generate an access token in Clash of Clans developer page at:
https://developer.clashofclans.com

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/leocabeza/clash-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.
Remember to add a test for each new feature you add, and before submitting a pull request, check that all tests are passing by running: rake

License

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