Skip to content
This repository has been archived by the owner on Sep 27, 2019. It is now read-only.

Commit

Permalink
Added Intercom Channel
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrey Telesh committed Sep 13, 2018
1 parent 7c85b21 commit 443a3cd
Show file tree
Hide file tree
Showing 22 changed files with 1,265 additions and 3 deletions.
9 changes: 9 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore
/tests export-ignore
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/vendor
build
composer.phar
composer.lock
.idea
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to `Intercom Notification` will be documented in this file

## 0.0.1 - 2018-09-13

- initial release
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **[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 Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).

- **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.

- **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.

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

Copyright (c) Andrey Telesh Y. <andrey.telesh.y@gmail.com>

> 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.
131 changes: 128 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,130 @@
# new-channels
# Intercom notifications channel for Laravel 5.6

Discuss about new channel proposals our share your finished channels in the [proposal issue](https://github.com/laravel-notification-channels/new-channels/issues/6).
[![Latest Version on Packagist](https://img.shields.io/packagist/v/ftw-soft/intercom-notification-channel.svg?style=flat-square)](https://packagist.org/packages/ftw-soft/intercom-notification-channel)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://img.shields.io/travis/ftw-soft/intercom-notification-channel/master.svg?style=flat-square)](https://travis-ci.org/ftw-soft/intercom-notification-channel)
[![StyleCI](https://styleci.io/repos/148610087/shield)](https://styleci.io/repos/148610087)
[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/ca6db073-da33-40bb-97b0-ddd1d0f5987f.svg?style=flat-square)](https://insight.sensiolabs.com/projects/ca6db073-da33-40bb-97b0-ddd1d0f5987f)
[![Quality Score](https://img.shields.io/scrutinizer/g/ftw-soft/intercom-notification-channel.svg?style=flat-square)](https://scrutinizer-ci.com/g/ftw-soft/intercom-notification-channel)
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/ftw-soft/intercom-notification-channel/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/ftw-soft/intercom-notification-channel/?branch=master)
[![Total Downloads](https://img.shields.io/packagist/dt/ftw-soft/intercom-notification-channel.svg?style=flat-square)](https://packagist.org/packages/ftw-soft/intercom-notification-channel)

Take a look at our [FAQ](http://laravel-notification-channels.com/) to see our small list of rules, to provide top-notch notification channels.
This package makes it easy to send notifications using [Intercom](https://app.intercom.com) with Laravel 5.6.

## Contents

- [Installation](#installation)
- [Setting up the Intercom service](#setting-up-the-intercom-service)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

## Installation

You can install the package via composer:

``` bash
composer require ftw-soft/intercom-notification-channel
```

### Setting up the Intercom service

Once installed you need to register the service provider with the application. Open up `config/app.php` and find the `providers` key.

``` php
'providers' => [

\FtwSoft\NotificationChannels\Intercom\IntercomServiceProvider::class,

]
```

Put the followings to your config/services

``` php
'intercom' => [
'token' => env('INTERCOM_API_KEY')
]
```

Add your Intercom Token to `.env`

```
INTERCOM_API_KEY=xxx
```


## Usage

Now you can use the channel in your `via()` method inside the notification:

``` php
use FtwSoft\NotificationChannels\Intercom\Contracts\IntercomNotification;
use FtwSoft\NotificationChannels\Intercom\IntercomChannel;
use FtwSoft\NotificationChannels\Intercom\IntercomMessage;
use Illuminate\Notifications\Notification;

class TestNotification extends Notification implements IntercomNotification
{
public function via($notifiable)
{
return ["intercom"];
}

public function toIntercom($notifiable): IntercomMessage
{
return IntercomMessage::create("Hey User!")
->from(123)
->toUserId(321);
}
}
```


### Available methods

- `body('')`: Accepts a string value for the Intercom message body
- `email()`: Accepts a string value for the Intercom message type `email`
- `inapp()`: Accepts a string value for the Intercom message type `inapp` (default)
- `subject('')`: Accepts a string value for the Intercom message body (using with `email` type)
- `plain()`: Accepts a string value for the Intercom message plain template
- `personal()`: Accepts a string value for the Intercom message personal template
- `from('123')`: Accepts a string value of the admin's id (sender)
- `to(['type' => 'user', 'id' => '321'])`: Accepts an array value for the recipient data
- `toUserId('')`: Accepts a string value for the Intercom message user by id recipient
- `toUserEmail('')`: Accepts a string value for the Intercom message user by email recipient
- `toContactId('')`: Accepts a string value for the Intercom message contact by id recipient

More info about fields read in [Intercom API Reference](https://developers.intercom.com/intercom-api-reference/reference#admin-initiated-conversation)

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ composer test
```

## Security

If you discover any security related issues, please email android991@gmail.com instead of using the issue tracker.

## Contributing

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

## Credits

- [Andrey Telesh](https://github.com/ftw-soft)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
40 changes: 40 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"name": "ftw-soft/intercom-notification-channel",
"description": "Intercom Notifications Driver",
"type": "library",
"license": "MIT",
"require": {
"php": ">=7.1.3",
"guzzlehttp/guzzle": "^6.3",
"intercom/intercom-php": "^3.2",
"illuminate/notifications": ">=5.5",
"illuminate/support": ">=5.5"
},
"require-dev": {
"phpunit/phpunit": "~7.0",
"mockery/mockery": "^1.1"
},
"autoload": {
"psr-4": {
"FtwSoft\\NotificationChannels\\Intercom\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"FtwSoft\\NotificationChannels\\Intercom\\Tests\\": "tests"
}
},
"scripts": {
"test": "vendor/bin/phpunit"
},
"config": {
"sort-packages": true
},
"extra": {
"laravel": {
"providers": [
"FtwSoft\\NotificationChannels\\Intercom\\IntercomServiceProvider"
]
}
}
}
29 changes: 29 additions & 0 deletions phpunit.xml.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name=":service_name Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
<!--<logging>-->
<!--<log type="tap" target="build/report.tap"/>-->
<!--<log type="junit" target="build/report.junit.xml"/>-->
<!--<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>-->
<!--<log type="coverage-text" target="build/coverage.txt"/>-->
<!--<log type="coverage-clover" target="build/logs/clover.xml"/>-->
<!--</logging>-->
</phpunit>
18 changes: 18 additions & 0 deletions src/Contracts/IntercomNotification.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php
namespace FtwSoft\NotificationChannels\Intercom\Contracts;

use FtwSoft\NotificationChannels\Intercom\IntercomMessage;

interface IntercomNotification
{

/**
* Make notification to the Intercom channel
*
* @param mixed $notifiable
*
* @return IntercomMessage
*/
public function toIntercom($notifiable): IntercomMessage;

}
14 changes: 14 additions & 0 deletions src/Exceptions/IntercomException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php
/**
* @link http://horoshop.ua
* @copyright Copyright (c) 2015-2018 Horoshop TM
* @author Andrey Telesh <andrey@horoshop.ua>
*/

namespace FtwSoft\NotificationChannels\Intercom\Exceptions;


class IntercomException extends \Exception
{

}
18 changes: 18 additions & 0 deletions src/Exceptions/InvalidArgumentException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php
/**
* @link http://horoshop.ua
* @copyright Copyright (c) 2015-2018 Horoshop TM
* @author Andrey Telesh <andrey@horoshop.ua>
*/

namespace FtwSoft\NotificationChannels\Intercom\Exceptions;

use InvalidArgumentException as BaseInvalidArgmentException;

/**
* @inheritdoc
*/
class InvalidArgumentException extends BaseInvalidArgmentException
{

}

0 comments on commit 443a3cd

Please sign in to comment.