Skip to content

Commit 10753e6

Browse files
ivi-adminiv-craig
authored and
atymic
committed
Add InterFAX notifications channel (#2)
Add InterFAX notifications channel Co-authored-by: null <[email protected]>
1 parent 115d95b commit 10753e6

19 files changed

+978
-2
lines changed

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.gitattributes export-ignore
6+
/.gitignore export-ignore
7+
/.travis.yml export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/.scrutinizer.yml export-ignore
10+
/tests export-ignore

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/vendor
2+
build
3+
composer.phar
4+
composer.lock

‎.scrutinizer.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
filter:
2+
excluded_paths: [tests/*]
3+
4+
checks:
5+
php:
6+
remove_extra_empty_lines: true
7+
remove_php_closing_tag: true
8+
remove_trailing_whitespace: true
9+
fix_use_statements:
10+
remove_unused: true
11+
preserve_multiple: false
12+
preserve_blanklines: true
13+
order_alphabetically: true
14+
fix_php_opening_tag: true
15+
fix_linefeed: true
16+
fix_line_ending: true
17+
fix_identation_4spaces: true
18+
fix_doc_comments: true
19+
20+
tools:
21+
external_code_coverage: true

‎.styleci.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
preset: laravel

‎.travis.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
language: php
2+
3+
php:
4+
- 7.2
5+
- 7.3
6+
- 7.4
7+
8+
env:
9+
matrix:
10+
- COMPOSER_FLAGS="--prefer-lowest"
11+
- COMPOSER_FLAGS=""
12+
13+
before_script:
14+
- travis_retry composer self-update
15+
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
16+
17+
script:
18+
- phpunit --coverage-text --coverage-clover=coverage.clover
19+
20+
after_script:
21+
- wget https://scrutinizer-ci.com/ocular.phar
22+
- php ocular.phar code-coverage:upload --format=php-clover coverage.clover

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
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.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[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).
44+
45+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46+
47+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48+
49+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
50+
51+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52+
53+
- **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.
54+
55+
**Happy coding**!

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) Craig Spivack <[email protected]>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

‎README.md‎

Lines changed: 137 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,137 @@
1-
# interfax
2-
InterFAX notification channel for Laravel
1+
# InterFAX notification channel for Laravel 5.8+ and 6.x
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/interfax.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/interfax)
4+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
5+
[![Build Status](https://img.shields.io/travis/laravel-notification-channels/interfax/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/interfax)
6+
[![StyleCI](https://styleci.io/repos/217342993/shield)](https://styleci.io/repos/217342993)
7+
[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/5c642897-a39d-4a62-8618-2880d818b101.svg?style=flat-square)](https://insight.sensiolabs.com/projects/5c642897-a39d-4a62-8618-2880d818b101)
8+
[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/interfax.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/interfax)
9+
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/interfax/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/interfax/?branch=master)
10+
[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/interfax.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/interfax)
11+
12+
This package makes it easy to send notifications using [InterFAX](https://interfax.net) with Laravel 5.8+ and 6.x.
13+
14+
## Contents
15+
16+
- [Installation](#installation)
17+
- [Setting up the InterFAX service](#setting-up-the-InterFAX-service)
18+
- [Usage](#usage)
19+
- [Available Message methods](#available-message-methods)
20+
- [Changelog](#changelog)
21+
- [Testing](#testing)
22+
- [Security](#security)
23+
- [Contributing](#contributing)
24+
- [Credits](#credits)
25+
- [License](#license)
26+
27+
28+
## Installation
29+
30+
You can install this package via composer:
31+
32+
```bash
33+
composer require laravel-notification-channels/interfax
34+
```
35+
36+
The service provider gets loaded automatically.
37+
38+
### Setting up the InterFAX service
39+
40+
This channel will use your InterFAX username and password. To use the channel, add this to your `config/services.php` file:
41+
42+
```php
43+
...
44+
'interfax' => [
45+
'username' => env('INTERFAX_USERNAME'),
46+
'password' => env('INTERFAX_PASSWORD'),
47+
'pci' => env('INTERFAX_PCI', false),
48+
],
49+
...
50+
```
51+
52+
This will load your InterFAX credentials from the `.env` file. If your requests must be PCI-DSS-compliant, set `INTERFAX_PCI=true` in your `.env` file.
53+
54+
## Usage
55+
56+
To use this package, you can create a notification class, like `DocumentWasSent` from the example below, in your Laravel application. Make sure to check out [Laravel's documentation](https://laravel.com/docs/master/notifications) for this process.
57+
58+
### Send PDF via fax
59+
60+
```php
61+
<?php
62+
use NotificationChannels\Interfax\InterfaxChannel;
63+
use NotificationChannels\Interfax\InterfaxMessage;
64+
65+
class DocumentWasSent extends Notification
66+
{
67+
68+
protected $files;
69+
70+
public function __construct(array $files)
71+
{
72+
$this->files = $files;
73+
}
74+
75+
/**
76+
* Get the notification's delivery channels.
77+
*
78+
* @param mixed $notifiable
79+
* @return array
80+
*/
81+
public function via($notifiable)
82+
{
83+
return [InterfaxChannel::class];
84+
}
85+
86+
public function toInterfax($notifiable)
87+
{
88+
return (new InterfaxMessage)
89+
->files($this->files);
90+
}
91+
}
92+
```
93+
94+
The Notifiable model will need to return a destination fax number.
95+
96+
```php
97+
public function routeNotificationForInterfax($notification)
98+
{
99+
if($this->fax)
100+
return preg_replace('/[^\d]/', '', $this->fax);
101+
102+
return null;
103+
}
104+
```
105+
106+
### Available Message methods
107+
108+
`file(string $file)` : Accepts the full path to a single file (full list of supported file types [found here](https://www.interfax.net/en/help/supported_file_types)).
109+
`files(array $array)` : Accepts an array of file paths.
110+
`stream(Filestream $stream, string $name)` : Accepts a file stream.
111+
112+
## Changelog
113+
114+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
115+
116+
## Testing
117+
118+
``` bash
119+
$ composer test
120+
```
121+
122+
## Security
123+
124+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
125+
126+
## Contributing
127+
128+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
129+
130+
## Credits
131+
132+
- [Craig Spivack](https://github.com/iv-craig)
133+
- [All Contributors](../../contributors)
134+
135+
## License
136+
137+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

‎composer.json‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"name": "laravel-notification-channels/interfax",
3+
"description": "This package makes it easy to send PDFs as faxes via InterFAX with Laravel notifications",
4+
"homepage": "https://github.com/laravel-notification-channels/interfax",
5+
"license": "MIT",
6+
"authors": [
7+
{
8+
"name": "Craig Spivack",
9+
"email": "[email protected]",
10+
"homepage": "https://www.ivinteractive.com",
11+
"role": "Developer"
12+
}
13+
],
14+
"require": {
15+
"php": "^7.2",
16+
"illuminate/notifications": "5.8.*|^6.0",
17+
"illuminate/support": "5.8.*|^6.0",
18+
"interfax/interfax": "^1.1"
19+
},
20+
"require-dev": {
21+
"mockery/mockery": "^1.0",
22+
"mpdf/mpdf": "^8.0",
23+
"orchestra/testbench": "~3.8|~4.0",
24+
"phpunit/phpunit": "^8.0"
25+
},
26+
"autoload": {
27+
"psr-4": {
28+
"NotificationChannels\\Interfax\\": "src"
29+
}
30+
},
31+
"autoload-dev": {
32+
"psr-4": {
33+
"NotificationChannels\\Interfax\\Test\\": "tests"
34+
}
35+
},
36+
"scripts": {
37+
"test": "vendor/bin/phpunit"
38+
},
39+
"config": {
40+
"sort-packages": true
41+
}
42+
}

0 commit comments

Comments
 (0)