Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/augustt198/overcast-api

Gem for getting information from the Overcast Network website
https://github.com/augustt198/overcast-api

Last synced: about 2 months ago
JSON representation

Gem for getting information from the Overcast Network website

Awesome Lists containing this project

README

        

# OvercastAPI

Gem for getting information from the Overcast Network website

## Installation

Add this to your Gemfile:

```ruby
gem 'overcast_api', github: 'augustt198/overcast-api'
```

## Usage

First, require `overcast_api` in your file

```ruby
require 'overcast_api'
```

Get a player with `OvercastAPI.player`

```ruby
player = OvercastAPI.player 'monsieurapple'
```

Full output:
```
#,
#
],
@kills=5604,
@deaths=4131,
@friend_count=182,
@kd_ratio=1.357,
@kk_ratio=1.728,
@server_joins=8555,
@days_played=9.24,
@raindrops=29100,
@contacts={
"Twitter"=>"Monsieur_Apple", "Facebook"=>"OvercastNetwork", "YouTube"=>"mrapplecomputer1",
"Twitch"=>"MonsieurApple", "Github"=>"mrapple"
},
@contact_links={
"Twitter"=>"http://twitter.com/Monsieur_Apple", "Facebook"=>"http://facebook.com/OvercastNetwork",
"YouTube"=>"http://youtube.com/user/mrapplecomputer1", "Twitch"=>"http://twitch.tv/MonsieurApple",
"Github"=>"https://github.com/mrapple"
},
@info={
"Gender"=>"Male", "Location"=>"United States of America",
"Occupation"=>"Co-Owner of Overcast Network", "Interests"=>"Computer Science"
},
@bio="",
@trophies=[
#,
#,
#,
#
],
@pvp_encounters=[
#,
#,
#
...
],
@infractions=[]
>
```