Thunk!

Description

An API for talking to thunk.us, a (soon to be) generally awesome notification service. Thunk lets you share and change simple state.

Notes in Progress

We know these docs are rough, but we wanted to get a version of the API out quickly. We’ll have it all polished by 1.0, we promise. :)

Since Thunk gets used in basic infrastructure tools, it works extra hard to never throw exceptions or cause hangs/timeouts. If it does, please file a bug! Even a nonexistent or read-only thunk will successfully respond to pokes, returning stub information. If you need to make extra sure you’re hooked up to a valid thunk, check out Thunk#exists? and Thunk#pokeable?.

Examples

(Eventually) check out the RDoc for more detailed information.

Poking & Reading a Thunk

thunk = Thunk.for "0681851956dccf88"
thunk.good! "Everything went better than expected!"

thunk.good?   # => true
thunk.payload # => "Everything went..."

Creating a Thunk

thunk = Thunk.create "My New Thunk"

thunk.name  # => "My New Thunk"
thunk.state # => :new
thunk.uuid  # => "..."

thunk.good! "I just made this thunk! Aaugh!"

At the Command Line

$ thunk -h

Installation

$ gem install thunk

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.