https://github.com/luhluh-17/challonge-api-wrapper
Ruby API Wrapper for Challonge
https://github.com/luhluh-17/challonge-api-wrapper
api challonge gem ruby
Last synced: about 1 year ago
JSON representation
Ruby API Wrapper for Challonge
- Host: GitHub
- URL: https://github.com/luhluh-17/challonge-api-wrapper
- Owner: luhluh-17
- License: mit
- Created: 2022-10-25T06:58:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T12:09:50.000Z (over 3 years ago)
- Last Synced: 2025-02-03T09:16:43.329Z (over 1 year ago)
- Topics: api, challonge, gem, ruby
- Language: Ruby
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Challonge-API-Wrapper
Ruby API Wrapper for [Challonge](https://challonge.com/)
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add challonge
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install challonge
## Usage
### Tournament
https://api.challonge.com/v1/documents/tournaments/index#
List all tournament
```ruby
Challonge::Tournament.all
```
filter all tournament using parameters
```ruby
Challonge::Tournament.all(args: {state: 'ended'})
```
Find tournament by id
```ruby
Challonge::Tournament.find_by_id(id: 1)
```
Create new tournament
Currently only accepts name as parameter
```ruby
Challonge::Tournament.create(name: 'My-Tournament')
```
Edit Tournament
Can only edit the tournament name
```ruby
Challonge::Tournament.update(id: 1, name: 'Tournament')
```
Delete Tournament
```ruby
Challonge::Tournament.delete(id: 1)
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/luhluh/challonge. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/luhluh-17/challonge/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Challonge project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/luhluh-17/challonge/blob/main/CODE_OF_CONDUCT.md).