Teaspoon

Send messages to Mint Source

Installation

Add this line to your application's Gemfile:

gem 'teaspoon'

And then execute:

$ bundle

Or install it yourself as:

$ gem install teaspoon

Usage

Standalone

require 'teaspoon'
t = Teaspoon::Client.new('http://your-mint-source.com/endpoint', 'username', 'password') # Optional username & password
t.send('Main message', 'Sub-message', # message, submessage, options hash (which is optional, natch)
  :colour    => '#bada55', # Also accepts color if you're American
  :image     => 'http://farm6.static.flickr.com/5309/5623212581_5f8f3f8788.jpg',
  :timestamp => Time.now
)

With Rails 3+

create a configuration file in Rails.root + config/teaspoon.yml. In it, configure Teaspoon::Client, like this:

url: 'http://your-mint-source.com/endpoint'
username: 'http-auth-username'
password: 'http-auth-password'

Then, in your controller, you have the spoon helper method available:

def index
  active_user_count = User.active.count
  spoon("There are #{active_user_count} active users", "yay!", :color => '#000')
end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request