Giter Club home page Giter Club logo

slack-poster's Introduction

Dependency Status

Slack Poster

Slack is a mashup of chatrooms and collaborative sharing tools that are meant to do away with redundant conversations in multiple places.

slack-poster is a simple gem to make your integration with Slack easier. It supports only incoming communications (from you to Slack).

Installation

Add this line to your application's Gemfile:

$ gem 'slack-poster'

And then execute:

$ bundle

Or install it yourself as:

$ gem install slack-poster

Usage

First, you need to create an Incoming Webhook integration at https://team-name.slack.com/services/new/incoming-webhook and take note of the generated token.

Next, create a new poster and send the message:

TEAM = 'team-name'
TOKEN = 'hd7heoo2oijd0'

poster = Slack::Poster.new(TEAM, TOKEN)
poster.send_message('Hello, world!')

You can use an options array if you don't want to use the settings configured directly on Slack:

options = {
  icon_url: 'http://example.com/image.png',
  # or icon_emoji: 'emoji_name',
  username: 'Tester',
  channel: '#random'
}

And then use it as a third parameter. Note that every option is optional (no pun intended!).

poster = Slack::Poster.new(TEAM, TOKEN, options)
poster.send_message('Hi!') # will send to #random with the username 'Tester'

That's it!

Contributing

  1. Fork it ( http://github.com/rikas/slack-poster/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

slack-poster's People

Contributors

jdowning avatar rikas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.