Stattleship API Ruby client
Ruby
Latest commit 3e55baf Oct 14, 2016 @dthyresson dthyresson committed on GitHub Merge pull request #5 from dustinsmith1024/patch-1
Readme updates for Ruby syntax highlighting and corrects an emoji for Github mardown

README.md

stattleship-ruby

Join the chat at https://gitter.im/stattleship/stattleship-ruby Stattleship API Ruby client

Build Status

Check out the Stattleship API - The Sports Data API you've always wanted

Meaningful. Developer-Friendly.

🏈 🏀 and ⚫️ ❄️ and ⚾️ !

We're gonna need a bigger ⛵️!

Installation

gem install stattleship-ruby

Usage

gem 'stattleship-ruby', '~> 0.1.25'

Build

gem build stattleship-ruby.gemspec

Install

gem install stattleship-ruby-0.1.25.gem

Prerequisites

You'll need

Configuration

There are two ways to configure the gem.

Stattleship.configure do |config|
  config.api_token = YOUR_TOKEN
end

or via a .env

STATTLESHIP_ACCESS_TOKEN=YOUR_TOKEN

API Documentation

Examples

Check out some examples of how to make API calls.

It's dead simple.

  • Build and set parameters
  • Use that to fetch data
  • Use fully populated PORO's with real Ruby datatypes (DateTime, Integers, bool) not just JSON strings

The pattern is pretty much as follows:

query_params = Stattleship::Params::BasketballGameLogsParams.new
query_params.player_id = 'nba-stephen-curry'
query_params.since = '1 week ago'
game_logs = Stattleship::BasketballGameLogs.fetch(params: query_params)
pp game_logs.first

That's it.

If you want to see what the example JSON responses are, have a look in fixtures as there are samples for each sport.

Apps

We're using the Stattleship API and this gem! You can, too.

Questions?

Follow us on @stattleship or join our free, public Fanboat Slack group where you can try out "cosell" -- an instance of Glickman -- and get API updates.