README

这是一个针对Laravel & Lumen版本5进行优化的非常简单的HipChat API。

安装

通过Composer安装

在命令行中运行

composer require bestit/hipchat-api

Laravel 5

第1步：发布配置

在命令行中运行

php artisan vendor:publish --provider HipChatServiceProvider

第2步：服务提供者

对于您的Laravel应用，打开 config/app.php 并在 providers 数组中添加

Bestit\HipChat\HipChatServiceProvider::class,

这将启动包到Laravel中。

第3步：外观

对于您的Laravel应用，打开 config/app.php 并在 aliases 数组中添加

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

这将HipChat外观添加到Laravel中。

第4步：配置

将以下条目添加到您的环境 (.env) 文件中

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

第1步：服务提供者

在您的bootstrap/app.php文件中添加

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

第2步：配置

将vendor/bestit/hipchat-api/src/config/hipchat.php文件复制到您的本地配置目录（如果尚未存在，则必须创建它），并不要忘记将Laravel配置的第4步中描述的条目添加到环境 (.env) 文件中。

用法

• 在房间中发送通知

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

  更多信息：这里

• 向用户发送通知

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

  更多信息：这里

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');

待办事项

• 覆盖更多API端点
• 测试
• 清理/接口等。
• Travis CI