Cinch::Twitter

A Cinch plugin for accessing Twitter, using Erik Michaels-Ober's wonderful Twitter gem.

Installation

Add this line to your application's Gemfile:

gem 'cinch-twitter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cinch-twitter

Usage

Bot commands

!tw <username><+D> - Gets the latest tweet of the specified user, or the tweet 'D' tweets back, between 1 and 20.
!tw #[id] - Gets the tweet at the specified ID

Shorthand commands are also available:

@[username]<+D>, @#[id]

If for instance, an error occurs (such as a timeout, an account is protected, or can't be found), the plugin will send a message to the channel with an informative message.

Requiring and including the plugin

require 'cinch/plugins/twitter'
# ...
Bot.config {|c|
  # ...
  c.plugins.plugins << Cinch::Plugins::Twitter

Plugin Configuration

To configure the plugin, you must insert your access keys for the client.

To retrieve your access keys and oauth tokens, if you already have an application set up, please visit https://dev.twitter.com/apps, otherwise visit https://dev.twitter.com/apps/new and follow the instructions.

Example:

c.plugins.options[Cinch::Plugins::Twitter::Client] = { 
  access_keys: { 
    consumer_key: "XXXXXXX", 
    consumer_secret: "XXXXXXX", 
    access_token: "XXXXXXX", 
    access_token_secret: "XXXXXXX" 
  } 
}

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request