Slack Messaging

This is a simple project designed to post messages to a given Slack or Discord channel as a bot.

Add this line to your application's Gemfile:

gem 'slack_messaging'

And then execute:

bundle install

Or install it yourself as:

gem install slack_messaging

This project requires a config file that should look like this:

discord:
  avatar_url: <PUBLIC URL OF AN IMAGE>
  username: <AWESOME USER NAME>
  webhook_url: <DISCORD WEBHOOK URL>
slack:
  channel: <AWESOME CHANNEL NAME>
  username: <AWESOME USER NAME>
  webhook_url: <SLACK WEBHOOK URL>
  icon_emoji: ':<SOME EMOJI>:'

A config file can have both Discord and Slack settings, or just one or the other. To easily generate this file at ~/.slack_messaging.yml, please run this command once for each setting type:

slack-messaging setup

To obtain a Slack webhook URL, follow these instructions. To obtain a Discord webhook URL, follow these instructions.

If you'd like to create the config file at a different directory, I recommend using the setup command, and then manually moving the file to your desired location:

slack-messaging setup
# Walk through the prompts to create the file
mv ~/.slack_messaging.yml /PATH/TO/FILE/config.yml

And then you can pass in that specific file location using the global -c/--config flag:

slack-messaging --config="/PATH/TO/FILE/config.yml" send

To print a friendly message to Slack, run:

slack-messaging send

Here, no specific message is being given to print to Slack, so slack_messaging will choose a random quote. The random quotes are selected using the Quotable API.

However, what if you wanted to print something specific? Well, you can! Just run:

slack-messaging send 'MESSAGE 1'

You can even print multiple messages at once:

slack-messaging send 'MESSAGE 1' 'MESSAGE 2' 'MESSAGE 3' ... 'MESSAGE N'

When using special characters in your custom messages, use single quotes instead of double quotes

If your config file contains both Slack and Discord settings, then running a basic send command (either passing in a message or not), will notify both Slack and Discord. To specify which service to send a message to, you can pass in a -s/--service flag:

slack-messaging send --service slack
# OR
slack-messaging send --service discord

To specify a service and send a customized message, you can pass both at once:

slack-messaging send -s slack 'MESSAGE 1'

The output of a Slack message will look something like this:

The output of a Discord message will look something like this:

I hope you enjoy printing fun and specialized messages to Slack!

To run the tests, run bundle exec rspec from the command-line. GitHub Actions will also run the tests upon every commit to make sure they're up to date and that everything is working correctly. Locally, you can also run bundle exec guard to automatically run tests as you develop!

To submit a feature request, bug ticket, etc, please submit an official GitHub issue. To copy or make changes, please fork this repository. When/if you'd like to contribute back to this upstream, please create a pull request on this repository.

Please follow included Issue Template(s) and Pull Request Template(s) when creating issues or pull requests.

To report any security vulnerabilities, please view this repository's Security Policy.

For information on licensing, please see LICENSE.md.

When interacting with this repository, please follow Contributor Covenant's Code of Conduct.

To make a new release of this gem:

1. Merge the pull request via the big green button
2. Run git tag vX.X.X and git push --tag
3. Make a new release here
4. Run gem build *.gemspec
5. Run gem push *.gem to push the new gem to RubyGems
6. Run rm *.gem to clean up your local repository

To set up your local machine to push to RubyGems via the API, see the RubyGems documentation.

This repository has been archived and designated as read-only. From GitHub's documentation:

This will make the emmahsax/slack_messaging repository, issues, pull requests, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions and comments read-only and disable any future comments. The repository can still be forked.

To unarchive this repository at any time, please reach out to me at https://emmasax.com/contact-me/.