library hipchat-api

bestit/hipchat-api

Hipchat API written in PHP optimized for Laravel.

bestit/hipchat-api

This a very simple HipChat API optimized for Laravel & Lumen version 5., _(*1)

Installation

Install via Composer

From the command line, run:, _(*2)

composer require bestit/hipchat-api

Laravel 5

Step 1: Publishing config

From the command line, run:, _(*3)

php artisan vendor:publish --provider HipChatServiceProvider

Step 2: Service Provider

For your Laravel app, open config/app.php and, within the providers array, append:, _(*4)

Bestit\HipChat\HipChatServiceProvider::class,

This will bootstrap the package into Laravel., _(*5)

Step 3: Facade

For your Laravel app, open config/app.php and, within the aliases array, append:, _(*6)

'HipChat' => Bestit\HipChat\Facade\HipChat::class,

This will add the HipChat Facade into Laravel., _(*7)

Step 4: Configuration

Add the following entries to your environment (.env) file:, _(*8)

HIPCHAT_SERVER_URL // This is optional, defaults to 'https://api.hipchat.com'
HIPCHAT_API_TOKEN // This is required, use a user personal token.

Lumen 5

Step 1: Service provider

Inside your bootstrap/app.php file, add:, _(*9)

$app->register(Bestit\HipChat\HipChatLumenServiceProvider::class);

Step 2: Configuration

Copy the vendor/bestit/hipchat-api/src/config/hipchat.php file to your local config directory (if it does not exist yet, you have to create it) and don't forget add the entries to your environment (.env) file described in Step 4 of the Laravel Configuration., _(*10)

Usage

• Notification in a Room, _(*11)

  HipChat::room('RoomNameOrRoomId')->notify('Some Cool Message');
  
  // you have three optional parameters, `color`, `alert` and `notify`
  

  Read more: here, _(*12)

• Notification to a user, _(*13)

  HipChat::user('UserEmailOrId')->notify('Some Cool Message');
  
  // you have two optional parameters, `alert` and `format`
  

  Read more: here, _(*14)

Usage outside of Laravel / Lumen

$url = 'https://company.hipchat.com'; // Can be left empty, default to https://api.hipchat.com
$token = 'some_api_token';
$client = new \Bestit\HipChat\Client($token, $url);

$client->room('RoomNameOrRoomId')->notify('Some Cool Message');

$client->user('UserEmailOrId')->notify('Some Cool Message');

Todo

• Cover more API Endpoints
• Tests
• Cleanup/Interfaces etc.
• Travis CI