Project

hipnote

0.0
No commit activity in last 3 years
No release in over 3 years
Post a notification in hipchat
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0

Runtime

~> 1.2.0
 Project Readme

Hipnote

Post a notification in hipchat

Installation

Add this line to your application's Gemfile:

gem 'hipnote'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hipnote

Usage

Make sure you set ENV['HIPCHAT_API_TOKEN']

######Interface: Hipnote.post([room], [message], { title: [title], color: [color], format: [format] })

  • room (where you want the message to post)
  • message (what you want to post)
  • title (title of the post) Default: 'Note'
  • color (color of the post) Default: 'yellow'
  • format (format of the post: 'text' or 'html') Default: 'text'

######Examples:

Hipnote.post('project room', 'Deploying now', title: 'Deployment')
Hipnote.post('technical comms', 'Attention, this is an <strong>alert.</strong>',
             color: 'red',
             format: 'html')

Contributing

  1. Fork it ( https://github.com/[my-github-username]/hipnote/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 a new Pull Request