This is a gem for interacting with the WhenHub API.
WhenHub lets you transform time-ordered information such as a timeline or schedule into a beautiful, interactive, embeddable Whencast that entertains, educates, and provides chronological context.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install whenhub
The best guide for using this gem is the script in
bin/test, which exercises all of the supported endpoints and prints the method outputs.
You can use this script as a guide for invoking the gem, and you can run it against your live WhenHub account by running:
RESTCLIENT_LOG=stdout bundle exec bin/test [YOUR ACCESS TOKEN]
The gem uses a client model to query against the API. You create and configure a client with your access token. (Note: You can find your access token by visiting your WhenHub account page.)
require 'whenhub' client = WhenHub::Client.new(access_token: YOUR_ACCESS_TOKEN)
After creating the client you're able to make requests to any of the WhenHub APIs. Some examples follow below.
user = client.me
schedules = client.schedules.all
schedule = client.schedules.find(schedule_id)
schedule = client.schedules.find(schedule_id, media: true)
schedule = client.schedules.create
event = schedule.events.create
event.name = 'My Event' event.save
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.
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whenhub.