0.0
No commit activity in last 3 years
No release in over 3 years
Cinch plugin that adds a integrate event to cinch so that other plugins can interface with the integrations in this plugin.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 2.3.2
 Project Readme

Cinch Integration Plugin

GitHub License Dependency Status Gem Version
Plugin to integrate a cinch bot with other services, currently just works with slack web integration.

Usage

install the gem in your application's Gemfile:

gem 'cinch-integration'

then alter your bot's config to include the following:

require 'cinch/plugins/integration'

bot = Cinch::Bot.new do
  configure do |c|
    c.plugins.plugins = [Cinch::Plugins::Integrate]
    c.plugins.options[Cinch::Plugins::Integrate] = {
      integrations: [:slack],
      slack_key:    'insert slack key here'
    }
  end
end
Option Description
integrations A list of symbols that correspond to specific integrations, currently the only option is :slack
slack_key Slack API token to pass to slack-ruby-client

You can then have your bot/plugin integrate with slack by sending :integrate events to the bot like so:

require 'cinch/plugins/integration'

@bot.handlers.dispatch(
  :integrate,
  nil,
  :slack,
  channel: "#channel_here",
  text: 'put your message here',
  as_user: true
)

License

Copyright (C) 2016 Jonas Osborn

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.