Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mpociot committed Jul 19, 2017
0 parents commit e5bdd02
Show file tree
Hide file tree
Showing 14 changed files with 587 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
* text=auto

/.github export-ignore
/tests export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php_cs export-ignore
.styleci.yml export-ignore
.travis.yml export-ignore
phpunit.xml export-ignore
CHANGELOG.md export-ignore
CONTRIBUTING.md export-ignore
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.idea/
.DS_Store
composer.lock
.php_cs.cache
/vendor/
8 changes: 8 additions & 0 deletions .php_cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

// Needed to get styleci-bridge loaded
require_once __DIR__.'/vendor/sllh/php-cs-fixer-styleci-bridge/autoload.php';

use SLLH\StyleCIBridge\ConfigBridge;

return ConfigBridge::create();
6 changes: 6 additions & 0 deletions .styleci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
preset: laravel

enabled:
- unalign_double_arrow

linting: true
19 changes: 19 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
language: php

php:
- 7.0
- 7.1

before_script:
- travis_retry composer self-update --preview
- travis_retry composer install --prefer-dist --no-interaction

script:
- vendor/bin/phpunit --coverage-clover=coverage.xml

before_install:
- pip install --user codecov
- echo "extension = redis.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini

after_success:
- codecov
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing

Contributions are **welcome** and will be fully **credited**. We accept contributions via Pull Requests on [Github](https://github.com/botman/driver-facebook).

## Pull Requests

- **[PSR-2 Coding Standard.](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** The easiest way to apply the conventions is to install [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
- **Add tests!** Your patch won't be accepted if it doesn't have tests.
- **Document any change in behaviour.** Make sure the `README.md` and any other relevant documentation are kept up-to-date.
- **Consider our release cycle.** We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
- **Create feature branches.** Don't ask us to pull from your master branch.
- **One pull request per feature.** If you want to do more than one thing, send multiple pull requests.
- **Send coherent history.** Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

## Running Tests

```bash
$ phpunit
```


*Happy coding!*
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Marcel Pociot

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# BotMan HipChat Driver

BotMan driver to connect HipChat with [BotMan](https://github.com/botman/botman)

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

If you discover a security vulnerability within BotMan, please send an e-mail to Marcel Pociot at [email protected]. All security vulnerabilities will be promptly addressed.

## License

BotMan is free software distributed under the terms of the MIT license.

42 changes: 42 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"name": "botman/driver-hipchat",
"license": "MIT",
"description": "HipChat driver for BotMan",
"keywords": [
"Bot",
"BotMan",
"HipChat"
],
"homepage": "http://github.com/botman/driver-hipchat",
"authors": [
{
"name": "Marcel Pociot",
"email": "[email protected]"
}
],
"require": {
"php": ">=7.0",
"mpociot/botman": "~2.0"
},
"require-dev": {
"phpunit/phpunit": "~5.0",
"mockery/mockery": "dev-master",
"ext-curl": "*"
},
"autoload": {
"psr-4": {
"BotMan\\Drivers\\HipChat\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
}
},
"scripts": {
"test": "vendor/bin/phpunit",
"cs": "php-cs-fixer fix"
},
"minimum-stability": "dev",
"prefer-stable": true
}
8 changes: 8 additions & 0 deletions discovery.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"botman/driver-config": [
"stubs/hipchat.php"
],
"botman/driver": [
"BotMan\\Drivers\\HipChat\\HipChatDriver"
]
}
23 changes: 23 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
backupStaticAttributes="false"
bootstrap="vendor/autoload.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
>
<testsuites>
<testsuite name="Package Test Suite">
<directory>tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
</phpunit>
158 changes: 158 additions & 0 deletions src/HipChatDriver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<?php

namespace BotMan\Drivers\HipChat;

use BotMan\BotMan\Users\User;
use Illuminate\Support\Collection;
use BotMan\BotMan\Drivers\HttpDriver;
use BotMan\BotMan\Messages\Incoming\Answer;
use BotMan\BotMan\Messages\Outgoing\Question;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ParameterBag;
use BotMan\BotMan\Messages\Incoming\IncomingMessage;
use BotMan\BotMan\Messages\Outgoing\OutgoingMessage;

class HipChatDriver extends HttpDriver
{
const DRIVER_NAME = 'HipChat';

protected $apiURL;

/**
* @param Request $request
*/
public function buildPayload(Request $request)
{
$this->payload = new ParameterBag((array) json_decode($request->getContent(), true));
$this->event = Collection::make($this->payload->get('item'));
$this->config = Collection::make($this->config->get('hipchat', []));
}

/**
* Determine if the request is for this driver.
*
* @return bool
*/
public function matchesRequest()
{
return ! is_null($this->payload->get('webhook_id')) && $this->payload->get('event') === 'room_message';
}

/**
* @param \BotMan\BotMan\Messages\Incoming\IncomingMessage $message
* @return Answer
*/
public function getConversationAnswer(IncomingMessage $message)
{
return Answer::create($message->getText())->setMessage($message);
}

/**
* Retrieve the chat message.
*
* @return array
*/
public function getMessages()
{
return [
new IncomingMessage($this->event->get('message')['message'], $this->event->get('message')['from']['id'],
$this->event->get('room')['id'], $this->event),
];
}

/**
* @return bool
*/
public function isBot()
{
return false;
}

/**
* @param string|Question|IncomingMessage $message
* @param \BotMan\BotMan\Messages\Incoming\IncomingMessage $matchingMessage
* @param array $additionalParameters
* @return Response|null
*/
public function buildServicePayload($message, $matchingMessage, $additionalParameters = [])
{
$parameters = array_merge_recursive([
'message_format' => 'text',
], $additionalParameters);
/*
* If we send a Question with buttons, ignore
* the text and append the question.
*/
if ($message instanceof Question) {
$parameters['message'] = $message->getText();
} elseif ($message instanceof OutgoingMessage) {
$parameters['message'] = $message->getText();
} else {
$parameters['message'] = $message;
}

$this->apiURL = Collection::make($this->config->get('urls', []))->filter(function ($url) use (
$matchingMessage
) {
return strstr($url, 'room/'.$matchingMessage->getRecipient().'/notification');
})->first();

return $parameters;
}

/**
* @param mixed $payload
* @return Response
*/
public function sendPayload($payload)
{
$headers = [
'Content-Type:application/json',
];

if (! is_null($this->apiURL)) {
return $this->http->post($this->apiURL, [], $payload, $headers, true);
}
}

/**
* @return bool
*/
public function isConfigured()
{
$urls = $this->config->get('urls');

if (is_array($urls)) {
$urls = array_filter($urls);
}

return ! empty($urls);
}

/**
* Retrieve User information.
* @param \BotMan\BotMan\Messages\Incoming\IncomingMessage $matchingMessage
* @return User
*/
public function getUser(IncomingMessage $matchingMessage)
{
$payload = $matchingMessage->getPayload();

return new User($payload->get('message')['from']['id'], $payload->get('message')['from']['name'], null,
$payload->get('message')['from']['mention_name']);
}

/**
* Low-level method to perform driver specific API requests.
*
* @param string $endpoint
* @param array $parameters
* @param \BotMan\BotMan\Messages\Incoming\IncomingMessage $matchingMessage
* @return void
*/
public function sendRequest($endpoint, array $parameters, IncomingMessage $matchingMessage)
{
//
}
}
15 changes: 15 additions & 0 deletions stubs/hipchat.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

return [

/*
|--------------------------------------------------------------------------
| Hipchat URLs
|--------------------------------------------------------------------------
|
| An array containing all Hipchat Webhook URLs.
|
*/
'urls' => env('HIPCHAT_URLS'),

];
Loading

0 comments on commit e5bdd02

Please sign in to comment.