mikeastock/cbs_sports

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# CBSSports
[![Circle CI](https://circleci.com/gh/mikeastock/cbs_sports/tree/master.svg?style=svg)](https://circleci.com/gh/mikeastock/cbs_sports/tree/master)
[![Code Climate](https://codeclimate.com/github/mikeastock/cbs_sports/badges/gpa.svg)](https://codeclimate.com/github/mikeastock/cbs_sports)
[![Test Coverage](https://codeclimate.com/github/mikeastock/cbs_sports/badges/coverage.svg)](https://codeclimate.com/github/mikeastock/cbs_sports/coverage)

This gem is a Ruby wrapper around the CBSSports API

## Installation

Add this line to your application's Gemfile:

```ruby
gem "cbs_sports"
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install cbs_sports

## Usage

### Client

When you create a client you can specify the response format you want. It defaults to JSON. You must also specify a sport for which you want data.
```ruby
client = CBSSports.client(response_format: :json, sport: :baseball)
```

### Players
```ruby
client.players
=> [
  {
    "id"         => "2044515",
    "fullname"   => "Martin Agosta",
    "firstname"  => "Martin",
    "lastname"   => "Agosta",
    "position"   => "SP",
    "age"        => 24,
    "pro_team"   => "SF",
    "pro_status" => "M",
    "photo"      => "https://www.cbssports.com/images/players/unknown-hat-170x170.png"
  }
]
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

1. Fork it ( https://github.com/[my-github-username]/cbs_sports/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request