Skip to content

Commit 154a9b4

Browse files
TheAlexLichterTheAlexLichter
committed
chore: init
0 parents  commit 154a9b4

File tree

10 files changed

+325
-0
lines changed

10 files changed

+325
-0
lines changed

‎.gitignore‎

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

‎.travis.yml‎

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

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to `netlify-build-hook` will be documented in this file
4+
5+
## 1.0.0
6+
7+
- Initial release

‎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) Developmint GbR Alexander Lichter, Max Langer <[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: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Trigger your Netlify build hooks with ease
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/developmint/netlify-build-hook.svg?style=flat-square)](https://packagist.org/packages/developmint/netlify-build-hook)
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/Developmint/netlify-build-hook/master.svg?style=flat-square)](https://travis-ci.org/Developmint/netlify-build-hook)
6+
[![Quality Score](https://img.shields.io/scrutinizer/g/developmint/netlify-build-hook.svg?style=flat-square)](https://scrutinizer-ci.com/g/developmint/netlify-build-hook)
7+
[![Total Downloads](https://img.shields.io/packagist/dt/developmint/netlify-build-hook.svg?style=flat-square)](https://packagist.org/packages/developmint/netlify-build-hook)
8+
9+
This package provides a lightweight class to trigger your [Netlify build hooks](https://www.netlify.com/docs/webhooks/#incoming-webhooks)
10+
properly.
11+
12+
13+
## Installation
14+
15+
You can install the package via composer:
16+
17+
``` bash
18+
composer require developmint/netlify-build-hook
19+
```
20+
21+
## Usage
22+
23+
You must pass the following things to the constructor of `Developmint\NetlifyBuildHook\NetlifyBuildHook`.
24+
25+
* A Guzzle client
26+
* The unique Identifier of you build hook (the last part of the build hook URL).
27+
28+
The last two arguments are optional:
29+
30+
* A custom title shown on Netlify
31+
* Another branch the deploy should use
32+
33+
``` php
34+
$client = new \GuzzleHttp\Client();
35+
$id = 'XXX'
36+
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id);
37+
38+
// Alternatively
39+
40+
// With title
41+
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id, 'My custom title');
42+
43+
// With branch
44+
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id, null, 'other-branch');
45+
46+
// With everything
47+
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id, 'My custom title', 'branch-name');
48+
```
49+
50+
### Get stats for a package of your choice
51+
52+
Trigger the hook with the corresponding `trigger`function of your class instance (from above).
53+
If a problem occurs, a `RequestException` will be thrown.
54+
55+
``` php
56+
$hook->trigger();
57+
```
58+
59+
## Changelog
60+
61+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
62+
63+
## Testing
64+
65+
Testing wasn't entirely possible as mocking the hooks doesn't help anyone and test hooks are not available.
66+
67+
``` bash
68+
$ composer test
69+
```
70+
71+
## Contributing
72+
73+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
74+
75+
## Security
76+
77+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
78+
79+
## Credits
80+
81+
- [Alexander Lichter](https://github.com/manniL)
82+
- [All Contributors](../../contributors)
83+
84+
85+
## License
86+
87+
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": "developmint/netlify-build-hook",
3+
"description": "Trigger your Netlify build hooks with ease",
4+
"keywords": [
5+
"netlify",
6+
"hook",
7+
"build",
8+
"webhook",
9+
"buildhook"
10+
],
11+
"type": "library",
12+
"homepage": "https://github.com/developmint/netlify-build-hook",
13+
"license": "MIT",
14+
"authors": [
15+
{
16+
"name": "Alexander Lichter",
17+
"email": "[email protected]",
18+
"homepage": "https://developmint.de",
19+
"role": "Developer"
20+
}
21+
],
22+
"require": {
23+
"php": "^7.0",
24+
"guzzlehttp/guzzle": "^6.3"
25+
},
26+
"require-dev": {
27+
"phpunit/phpunit": "~6.0"
28+
},
29+
"autoload": {
30+
"psr-4": {
31+
"Developmint\\NetlifyBuildHook\\": "src"
32+
}
33+
},
34+
"autoload-dev": {
35+
"psr-4": {
36+
"Developmint\\NetlifyBuildHook\\Test\\": "tests"
37+
}
38+
},
39+
"scripts": {
40+
"test": "vendor/bin/phpunit"
41+
}
42+
}

‎phpunit.xml.dist‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit bootstrap="vendor/autoload.php"
3+
backupGlobals="false"
4+
backupStaticAttributes="false"
5+
colors="true"
6+
verbose="true"
7+
convertErrorsToExceptions="true"
8+
convertNoticesToExceptions="true"
9+
convertWarningsToExceptions="true"
10+
processIsolation="false"
11+
stopOnFailure="false">
12+
<testsuites>
13+
<testsuite name="Spatie Test Suite">
14+
<directory>tests</directory>
15+
</testsuite>
16+
</testsuites>
17+
<filter>
18+
<whitelist>
19+
<directory suffix=".php">src/</directory>
20+
</whitelist>
21+
</filter>
22+
<logging>
23+
<log type="tap" target="build/report.tap"/>
24+
<log type="junit" target="build/report.junit.xml"/>
25+
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
26+
<log type="coverage-text" target="build/coverage.txt"/>
27+
<log type="coverage-clover" target="build/logs/clover.xml"/>
28+
</logging>
29+
</phpunit>

‎src/NetlifyBuildHook.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?php
2+
3+
namespace Developmint\NetlifyBuildHook;
4+
5+
use GuzzleHttp\Client;
6+
7+
class NetlifyBuildHook
8+
{
9+
/** @var \GuzzleHttp\Client */
10+
protected $client;
11+
protected $id;
12+
protected $branch;
13+
protected $title;
14+
const BASE_URL = 'https://api.netlify.com/build_hooks/';
15+
16+
/**
17+
* @param \GuzzleHttp\Client $client HTTP Client that'll trigger the hook
18+
* @param string $id string Hook identifier
19+
* @param string? $branch The branch that should be used for the build
20+
* @param string? $title The title for the deploy message on Netlify
21+
*/
22+
public function __construct(Client $client, string $id, $title = null, $branch = null)
23+
{
24+
$this->client = $client;
25+
$this->id = $id;
26+
$this->title = $title;
27+
$this->branch = $branch;
28+
}
29+
30+
public function trigger() : void
31+
{
32+
$this->client->post(self::BASE_URL . $this->id, [
33+
"query" => [
34+
'trigger_branch' => $this->branch,
35+
'trigger_title' => $this->title
36+
]
37+
]);
38+
}
39+
}

‎tests/NetlifyBuildHookTest.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
namespace Developmint\NetlifyBuildHook\Test;
4+
5+
use Developmint\NetlifyBuildHook\NetlifyBuildHook;
6+
use GuzzleHttp\Client;
7+
use GuzzleHttp\Exception\RequestException;
8+
use PHPUnit\Framework\TestCase;
9+
10+
class NetlifyBuildHookTest extends TestCase
11+
{
12+
13+
public function testItThrowExceptionOnNonExistingHook()
14+
{
15+
$this->expectException(RequestException::class);
16+
$nonExistingId = 'XXX';
17+
$hook = new NetlifyBuildHook(new Client(), $nonExistingId);
18+
$hook->trigger();
19+
}
20+
}

0 commit comments

Comments
 (0)