Project

slackdraft

0.0
No commit activity in last 3 years
No release in over 3 years
slackdraftmikemackintosh/slackdraftHomepageDocumentationSource CodeBug TrackerWiki
Slack messaging with half the Kurt Russell
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
11,838
Stars
2
Forks
0
Watchers
2
 Releases
Current version
1.0.3
Total releases
5
First release
2015-02-14
Latest release
2015-02-14
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-02-22
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
>= 0
rspec
>= 0
webmock
>= 0

Runtime

fattr
>= 0
httparty
>= 0
methadone
>= 0
paint
>= 0
 Project Readme

slackdraft

Simplest way to send messages to Slack.

TravisCI

Installation

Like any other gem:

gem install slackdraft

Features

I created the gem to allow for really simple integration into Slack. Some of the features include:

  • Formatting Support
  • User(@channel and @mike) and Channel (#channel) Notification Support
  • Awesome Attachment Support
  • Command Line Utility

See examples of pre-formated alerts in the examples/formatted/.

Ruby Usage

Usage is very simple:

require 'slackdraft'
url = "https://slack/webhook/url"
slack = Slackdraft::Message.new(url)
    
# Url of the icon or emoji
# slack.icon_url    = "https://..."
slack.icon_emoji  = ":fire:"
    
# Set the bot username
slack.username    = "SlackDraft"
    
# Set the channel
slack.channel     = "#general"
    
# Set text
# Or you can pass text in as an array
# slack.text        = ["Your message here!", ">_*And can have* formatting_"]
slack.text         = "Your message here! _*And can have* formatting_"

# Send the message
slack.send!
  #-> true/false

For more examples, see the examples/ directory.

Command-line Usage

It's dumb simple. Instead of using curl, use this:

slackdraft -u mike \
    -c "#slackdraft" \
    -m "This is our *formammted message*" \
    https://hooks.slack.com/services/xxxxxxx

Note: The CLI version does not support Slack Attachments

Help text

$ slackdraft -h
Usage: slackdraft [options] url

Slack with less Kurt Russell

v0.7.7

Options:
    -h, --help                       Show command line help
        --version                    Show help/version info
    -c, --channel CHANNEL            Channel to send message to
    -u, --username USER              User to send message as
    -m, --message MESSAGE            Message to send
    -e, --emoji EMOJI                Emoji to prefix message with
    -i, --icon ICON                  Icon to prefix message with