Glip Poster

glip-poster is a simple gem to make your integration with Glip (https://glip.com/) easier. It supports only incoming communications (from you to Glip).

Installation

Via Bundler

Add glip-poster to your Gemfile and then run bundle:

$ echo "gem 'glip-poster'" >> Gemfile
$ bundle

Via RubyGems

$ gem install glip-poster

Glip setup

This gem uses an incoming webhook integration on Glip. To create a new Glip webhook integration, in Glip.com, click on "Integrations" in the left column and then select the "Glip Webhooks" integration. After you select a conversation, a webhook URL will be presented which you will use with this gem to post messages to. The URL looks like the following:

https://hooks.glip.com/webhook/11112222-3333-4444-5555-666677778888

Usage

Initialize your poster and then call the send_message method to send your message. You must supply the webhook URL or webhook ID configured in the desired "Glip Webhooks" integration.

require 'glip_poster' # note underscore

poster = Glip::Poster.new(YOUR_WEBHOOK_URL) # or YOUR_WEBHOOK_ID (GUID)
poster.send_message('Hi there!') # Faraday::Response

You can send text in Markdown:

poster.send_message("* Location: [The Funky Buddha Lounge](http://www.thefunkybuddha.com)\n*Beer Advocate Rating: [99](http://tinyurl.com/psf4uzq)")

You can use an options array if you don't want to use the default settings.

options = {
  icon: 'http://example.com/icon.png',
  activity: 'Activity Alert',
  title: 'A New Incoming Message Has Been Received'
}
poster.send_message('Hi there!', options)

You can preset your options:

poster = Glip::Poster.new(YOUR_WEBHOOK_URL)
poster.options[:icon] = 'http://example.com/icon.png'
poster.options = {icon: 'http://example.com/icon.png'}
poster.send_message('Hi there!')

Supported Ruby Versions

This library supports and is tested against the following Ruby implementations:

1. Ruby 2.3.0
2. Ruby 2.2.0
3. Ruby 2.1.0
4. Ruby 2.0.0
5. Ruby 1.9.3
6. JRuby
7. Rubinius

Releases

Releases with release notes are availabe on GitHub releases. Release notes include a high level description of the release as well as lists of non-breaking and breaking changes.

Change Log

See CHANGELOG.md

Links

Project Repo

• https://github.com/ringcentral-ruby/glip-poster-ruby

Glip

• https://glip.com

Contributing

1. Fork it ( http://github.com/ringcentral-ruby/glip-poster-ruby/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