0.0
The project is in a healthy, maintained state
Full Slack integration for the Waylon Bot Framework
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.3
~> 13.0
~> 3.10
~> 1.23
~> 0.21
~> 0.9, >= 0.9.27

Runtime

 Project Readme

Waylon::Slack

The Slack Sense for the Waylon Bot Framework. This allows Waylon to interact with Slack via the Slack Web API and Events API (for sending and receiving messages, respectively).

Installation

Add this line to your bot's Gemfile:

gem 'waylon-slack'

Or, if your bot is itself a gem, add this to your .gemspec:

spec.add_dependency "waylon-slack", "~> 0.1"

And then execute:

$ bundle install

Or install it yourself via:

$ gem install waylon-slack

Usage

You'll need both your webhook server and your workers to have a line like this:

# right after 'require "waylon"'...
require "waylon/slack"

That should get it working in your bot. You'll also need to ensure that these environment variables are properly defined based on your bot's Slack app setup:

SLACK_OAUTH_TOKEN="xoxb-..."
SLACK_SIGNING_SECRET="..."

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jgnagy/waylon-slack.

License

The gem is available as open source under the terms of the MIT License.