opb/laravel-hipchat

HipChat Notifier for Laravel 4

0.3.2 2015-02-04 08:59 UTC

Requires

• php: >=5.5.0
• hipchat/hipchat-php: ~1.0
• illuminate/support: ~5.0

MIT

• Olly Butterfield

• notification
• laravel
• hipchat
• notifier

README

Quickly and easily send messages to Hipchat rooms, backgrounding via the Laravel queue by default. Uses v1 of the Hipchat API, with auth keys (as opposed to v2 with OAuth).

A couple of usage examples:

$user = 'Taylor';

HipchatNotifier::message("A new account [{$user}] signed up!");

Specifying some options:

$message = 'Warning, system is down!';
$options = [
	'notify' => true, 
	'color' => 'red',
	'from' => 'System Monitor',
	'room' => 'Emergency Notifications',
];

HipchatNotifier::message($message, $options);

Installation

Install into your Laravel app via composer.

"opb/laravel-hipchat": "~0.2",

and then

composer update

Register the service provider in app.php:

Opb\LaravelHipchat\HipchatNotifierServiceProvider

Note: The HipchatNotifier facade is registered automatically and does not need to be added to the aliases array in app.php.

Config - Laravel 4 (package version 0.2)

Publish the config file:

php artisan config:publish opb/laravel-hipchat

You should then find the config file at app/config/packages/opb/laravel-hipchat/config.php. Edit it to specify the required settings (API token and default room name) and additional default options.

Config - Laravel 5 (package version 0.3 and above)

Publish the config file:

php artisan vendor:publish

You should then find the config file at config/hipchat.php. Edit it to specify the required settings (API token and default room name) and additional default options. Use the env('VARIABLE_NAME') functionality where appropriate when using Laravel's .env file.

Options

There are several options which can (and some which must) be provided to the package. Most options can be specified at instantiation (via the config file) and optionally overridden when a message is sent.

• Color options - yellow, red, gray, green, purple, random
• Message format - HipChat can format basic html structures (lists, paragraphs, bold, italic, etc) when set to html format. Emoticons are only rendered when text format is used. auto will check for any html tags in your message and decide automagically which to use.

Usage

Using the HipchatNotifier facade allows you to quickly and easily send messages. The simplest is to send a message using all the default options within the package, or using those that were overridden in the config file:

HipchatNotifier::message('Test message with all default options');

You can override options on a per-message basis:

$message = 'Warning, system is down!';
$options = [
	'notify' => true, 
	'color' => 'red',
	'from' => 'System Monitor',
	'room' => 'Emergency Notifications',
];

HipchatNotifier::message($message, $options);

If you're not going to use the facade, and resolve directly out of the IOC container, the key is hipchat-notifier. For example:

$notifier = App::make('hipchat-notifier');

Todo

• Support HipChat API v2