No commit activity in last 3 years
No release in over 3 years
Ruby wrapper for the Overwatch League API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 12.3.3
~> 3.0
~> 3.3

Runtime

~> 3.0
 Project Readme

Gem Version Build Status Test Coverage Maintainability

Overwatch League

A Ruby wrapper around the Overwatch League API

Installation

$ gem install overwatch_league

Basic Example

require 'overwatch_league'

owl = OverwatchLeague.new
teams = owl.teams

Usage

There is no official documentation for the API. However, this Reddit post documents the API reasonably well.

The following methods are supported as part of the basic client.

teams

team(team_id)

ranking

standings

matches

match(match_id)

live_match

schedule

streams

vods

maps

news

videos

Rather than just returning a JSON Hash, each method returns an OpenStruct representation of the JSON where the keys have been converted to snake case. This is done for convenience, as it allows for object.key.another_key instead of object['key']['another_key'] when parsing the response.

Development & Contributions

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jgayfer/overwatch_league.

License

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