Cinch::Plugins::TwitterWatch

Gem Version Dependency Status Build Status Coverage Status Code Climate

Posts the content of a linked Tweet to the channel, can also follow users and post their tweets.

Installation

Add this line to your application's Gemfile:

gem 'cinch-twitterwatch'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cinch-twitterwatch

Usage

For the gem to work all you will need to is require the gem and add it to your plugins:

require 'cinch-twitterwatch'

@bot = Cinch::Bot.new do
  configure do |c|
    c.plugins.plugins = [ Cinch::Plugins::TwitterWatch]
  end
end

And, acquire Twitter credentials. They are simple to acquire, see https://dev.twitter.com/apps/new

Once you have said credentials you will need to pass them to the Plugin's config like so:

c.plugins.options[Cinch::Plugins::TwitterWatch] = { consumer_key:    'consumer_key',
                                                    consumer_secret: 'consumer_secret',
                                                    access_token:    'access_token',
                                                    access_secret:   'access_secret',
                                                    watchers: {
                                                      '#CHANNEL' => ['TWITTER_USERNAME']
                                                    }
                                                  }

Then post a link to a specific tweet and the bot should post the content of said tweet to the channel.

Contributing

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