Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 2.36 KB

README.md

File metadata and controls

95 lines (58 loc) · 2.36 KB
Raw

Voyeu-rb

Gem Version Circle CI![Coverage Status] (https://coveralls.io/repos/lurraca/voyeu-rb/badge.svg?branch=master&service=github)

Voyeu-rb is a Ruby Wrapper for the WatchPeopleCode.com API.

Installation

Add this line to your application's Gemfile:

gem 'voyeu-rb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install voyeu-rb

Usage

List live streams

Voyeurbb::Stream.live

List upcoming streams

Voyeurb::Stream.upcoming

List completed streams

Voyeurb::Stream.completed

Get information of the stream by ID

Voyeurb::Stream.find(:id)

List all streamers

Voyeurb::Streamer.all

Get information of a streamer by name

Voyeurb::Streamer.find_by_name(:name)

List live streams of a streamer

Voyeurb::Streamer.find_by_name(:name).live

List upcoming streams of a streamer

Voyeurb::Streamer.find_by_name(:name).upcoming

List completed streams of a streamer

Voyeurb::Streamer.find_by_name(:name).completed

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lurraca/voyeu-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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