No commit activity in last 3 years
No release in over 3 years
Organize remote coffee pairs in your slack workspace.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

RemoteCoffeeSlack

CI

A Ruby gem that helps you to create groups for a remote coffee in your Slack organization.

remote-cofee-slack

Installation

Add this line to your application's Gemfile:

gem 'remote_coffee_slack'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install remote_coffee_slack

Usage

Create a new slack app in your slack workspace and add the following Bot Token Scopes: channels:read , chat:write, users:read, im:write, mpim:write

Initalize the gem adding the following block:

RemoteCoffeeSlack.configure do |config|
  config.slack_bot_token = your-Bot-User-OAuth-Access-Token
  config.slack_channel = the-slack-channel-what-you-will-take-as-water-cooler # optional (default value is #general)
  config.members_per_group = members-per-group # optional (default value is 2)
end

In your Ruby application where you want to trigger the RemoteCoffeeSlack pairing event you should call

RemoteCoffeeSlack.notify_next_session

This action will perform the following steps:

  • Get the users inside the configured channel.
  • Create the groups for the next coffee session.
  • Publish the list in the confifured channel.

You can notify via DM using

RemoteCoffeeSlack.notify_next_session_via_dm

This action will perform the following steps:

  • Get the users inside the configured channel.
  • Get th channel_ids for th DMs.
  • Publish the message via direct message.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/remote_coffee_slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the RemoteCoffeeSlack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.