├── .gitignore
├── DependencyInjection
    ├── Configuration.php
    └── MinishlinkWebPushExtension.php
├── LICENSE
├── MinishlinkWebPushBundle.php
├── README.md
├── Resources
    └── config
    │   └── web_push.yml
├── Tests
    └── DependencyInjection
    │   └── MinishlinkWebPushExtensionTest.php
├── composer.json
└── phpunit.xml.dist


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | composer.lock
3 | .vscode/


--------------------------------------------------------------------------------
/DependencyInjection/Configuration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Minishlink\Bundle\WebPushBundle\DependencyInjection;
 4 | 
 5 | use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 6 | use Symfony\Component\Config\Definition\ConfigurationInterface;
 7 | 
 8 | class Configuration implements ConfigurationInterface
 9 | {
10 |     /**
11 |      * Generates the configuration tree builder.
12 |      */
13 |     public function getConfigTreeBuilder(): TreeBuilder
14 |     {
15 |         $treeBuilder = new TreeBuilder('minishlink_web_push');
16 | 
17 |         $treeBuilder->getRootNode()
18 |             ->children()
19 |                 ->arrayNode('VAPID')
20 |                     ->children()
21 |                         ->scalarNode('subject')
22 |                         ->end()
23 |                         ->scalarNode('publicKey')
24 |                         ->end()
25 |                         ->scalarNode('privateKey')
26 |                         ->end()
27 |                         ->scalarNode('pemFile')
28 |                         ->end()
29 |                         ->scalarNode('pem')
30 |                         ->end()
31 |                     ->end()
32 |                 ->end()
33 |                 ->integerNode('ttl')
34 |                     ->defaultValue(2419200)
35 |                 ->end()
36 |                 ->scalarNode('topic')
37 |                     ->defaultNull()
38 |                 ->end()
39 |                 ->scalarNode('urgency')
40 |                     ->defaultNull()
41 |                 ->end()
42 |                 ->integerNode('timeout')
43 |                     ->defaultValue(30)
44 |                 ->end()
45 |                 ->booleanNode('automatic_padding')
46 |                     ->defaultValue(true)
47 |                 ->end()
48 |             ->end()
49 |         ;
50 | 
51 |         return $treeBuilder;
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/DependencyInjection/MinishlinkWebPushExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Minishlink\Bundle\WebPushBundle\DependencyInjection;
 4 | 
 5 | use Symfony\Component\Config\FileLocator;
 6 | use Symfony\Component\DependencyInjection\ContainerBuilder;
 7 | use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 8 | use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 9 | 
10 | /**
11 |  * MinishlinkWebPushExtension.
12 |  *
13 |  * @author Louis Lagrange <lagrange.louis@gmail.com>
14 |  */
15 | class MinishlinkWebPushExtension extends Extension
16 | {
17 |     public function load(array $configs, ContainerBuilder $container): void
18 |     {
19 |         $configuration = $this->getConfiguration($configs, $container);
20 |         $config = $this->processConfiguration($configuration, $configs);
21 | 
22 |         $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
23 |         $loader->load('web_push.yml');
24 | 
25 |         $defaultOptions = array(
26 |             'TTL' => $config['ttl'],
27 |             'urgency' => $config['urgency'],
28 |             'topic' => $config['topic'],
29 |         );
30 | 
31 |         $container->setParameter('minishlink_web_push.auth', isset($config['VAPID']) ? ['VAPID' => $config['VAPID']] : []);
32 |         $container->setParameter('minishlink_web_push.default_options', $defaultOptions);
33 |         $container->setParameter('minishlink_web_push.timeout', $config['timeout']);
34 |         $container->setParameter('minishlink_web_push.automatic_padding', $config['automatic_padding']);
35 |     }
36 | }
37 | 


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


--------------------------------------------------------------------------------
/MinishlinkWebPushBundle.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Minishlink\Bundle\WebPushBundle;
 4 | 
 5 | use Symfony\Component\HttpKernel\Bundle\Bundle;
 6 | 
 7 | /**
 8 |  * MinishlinkWebPushBundle.
 9 |  *
10 |  * @author Louis Lagrange <lagrange.louis@gmail.com>
11 |  */
12 | class MinishlinkWebPushBundle extends Bundle
13 | {
14 | }
15 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # MinishlinkWebPushBundle
 2 | This bundle provides a simple integration of the [WebPush library](https://github.com/Minishlink/web-push).
 3 | 
 4 | [![SensioLabsInsight](https://insight.sensiolabs.com/projects/0c2947f7-f173-4d00-b0bb-da26613d52a2/mini.png)](https://insight.sensiolabs.com/projects/0c2947f7-f173-4d00-b0bb-da26613d52a2)
 5 | 
 6 | ## Usage
 7 | Web Push sends notifications to endpoints which server delivers web push notifications as described in
 8 | the [Web Push API specification](http://www.w3.org/TR/push-api/).
 9 | 
10 | ```php
11 | <?php
12 | /** @var \Minishlink\WebPush\WebPush */
13 | $webPush = $this->container->get('minishlink_web_push');
14 | ```
15 | 
16 | The bundle provides a new `minishlink_web_push` service that returns an instance of `Minishlink\WebPush\WebPush`.
17 | 
18 | For more info on what you can do with `$webPush`, check [Minishlink/web-push](https://github.com/Minishlink/web-push).
19 | 
20 | ## Installation
21 | 
22 | 1. `composer require minishlink/web-push-bundle`
23 | 2. Enable the bundle in your `app/AppKernel.php`.
24 | 
25 | ```php
26 | <?php
27 | // app/AppKernel.php
28 | 
29 | public function registerBundles()
30 | {
31 |     $bundles = array(
32 |         // ...
33 |         new Minishlink\Bundle\WebPushBundle\MinishlinkWebPushBundle(),
34 |         // ...
35 |     );
36 | }
37 | ```
38 | 
39 | ## Configuration
40 | Here is the default configuration, you may change it in your `app/config/config.yml`.
41 | 
42 | ```yml
43 | minishlink_web_push:
44 |   VAPID:
45 |     subject: https://yoursite.com # can be an URL or a mailto:
46 |     publicKey: ~88 chars          # uncompressed public key P-256 encoded in Base64-URL
47 |     privateKey: ~44 chars         # the secret multiplier of the private key encoded in Base64-URL
48 |     pemFile: path/to/pem          # if you have a PEM file and can link to it on your filesystem
49 |     pem: pemFileContent           # if you have a PEM file and want to hardcode its content
50 |   ttl: 2419200                    # Time to Live of notifications in seconds
51 |   urgency: ~                      # can be very-low / low / normal / high
52 |   topic: ~                        # default identifier for your notifications
53 |   timeout: 30                     # Timeout of each request in seconds
54 |   automatic_padding: true         # pad messages automatically for better security (against more bandwith usage)
55 | ```
56 | 


--------------------------------------------------------------------------------
/Resources/config/web_push.yml:
--------------------------------------------------------------------------------
 1 | parameters:
 2 |   minishlink_web_push.class: Minishlink\WebPush\WebPush
 3 | 
 4 | services:
 5 |   minishlink_web_push:
 6 |     class: '%minishlink_web_push.class%'
 7 |     arguments: ['%minishlink_web_push.auth%', '%minishlink_web_push.default_options%', '%minishlink_web_push.timeout%', []]
 8 |     calls:
 9 |       - [setAutomaticPadding, ['%minishlink_web_push.automatic_padding%']]
10 |   Minishlink\WebPush\WebPush:
11 |       alias: minishlink_web_push
12 | 


--------------------------------------------------------------------------------
/Tests/DependencyInjection/MinishlinkWebPushExtensionTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests\Minishlink\WebPushBundle\DependencyInjection;
 4 | 
 5 | use Minishlink\WebPush\WebPush;
 6 | use PHPUnit\Framework\TestCase;
 7 | use Symfony\Component\DependencyInjection\ContainerBuilder;
 8 | use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
 9 | use Minishlink\Bundle\WebPushBundle\DependencyInjection\MinishlinkWebPushExtension;
10 | 
11 | /**
12 |  * Test for the WebPush Extension
13 |  * 
14 |  * @author Tim Bernhard <tim@bernhard-webstudio.ch>
15 |  */
16 | class MinishlinkWebPushExtensionTest extends AbstractExtensionTestCase
17 | {
18 | 
19 |     protected function getContainerExtensions(): array
20 |     {
21 |         return array(
22 |             new MinishlinkWebPushExtension()
23 |         );
24 |     }
25 | 
26 |     public function testWithoutConfiguration() {
27 |         $this->load();
28 | 
29 |         $this->assertContainerBuilderHasParameter('minishlink_web_push.auth');
30 |         $this->assertContainerBuilderHasParameter('minishlink_web_push.default_options');
31 |         $this->assertContainerBuilderHasParameter('minishlink_web_push.timeout');
32 |         $this->assertContainerBuilderHasParameter('minishlink_web_push.automatic_padding');
33 |         $this->assertContainerBuilderHasService('minishlink_web_push');
34 |         $this->assertContainerBuilderHasService('Minishlink\WebPush\WebPush');
35 |         $this->assertInstanceOf(WebPush::class, $this->container->get('minishlink_web_push'));
36 |         $this->assertInstanceOf(WebPush::class, $this->container->get('Minishlink\WebPush\WebPush'));
37 |     }
38 | 
39 | }
40 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "minishlink/web-push-bundle",
 3 |   "type": "symfony-bundle",
 4 |   "description": "Symfony Bundle around the WebPush library",
 5 |   "keywords": [
 6 |     "push",
 7 |     "notifications",
 8 |     "web",
 9 |     "WebPush"
10 |   ],
11 |   "homepage": "https://github.com/minishlink/web-push-bundle",
12 |   "license": "MIT",
13 |   "authors": [
14 |     {
15 |       "name": "Louis Lagrange",
16 |       "email": "lagrange.louis@gmail.com",
17 |       "homepage": "https://github.com/Minishlink"
18 |     }
19 |   ],
20 |   "require": {
21 |     "php": "^7.2 || ^8.0",
22 |     "minishlink/web-push": "^6.0|^7.0|^8.0"
23 |   },
24 |   "require-dev": {
25 |     "symfony/framework-bundle": "^4.2|^5.0",
26 |     "phpunit/phpunit": "^9.3.0",
27 |     "symfony/phpunit-bridge": "^5.0",
28 |     "matthiasnoback/symfony-dependency-injection-test": "^4.2.1"
29 |   },
30 |   "target-dir": "Minishlink/Bundle/WebPushBundle",
31 |   "autoload": {
32 |     "psr-0": {
33 |       "Minishlink\\Bundle\\WebPushBundle": "",
34 |       "Tests\\Minishlink\\WebPushBundle": "Tests"
35 |     }
36 |   }
37 | }
38 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | 
 3 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
 5 |          backupGlobals="false"
 6 |          colors="true"
 7 |          bootstrap="vendor/autoload.php">
 8 |     <php>
 9 |         <ini name="error_reporting" value="-1" />
10 |     </php>
11 | 
12 |     <testsuites>
13 |         <testsuite name="Symfony WebPushBundle Test Suite">
14 |             <directory>./Tests</directory>
15 |         </testsuite>
16 |     </testsuites>
17 | 
18 |     <filter>
19 |         <whitelist>
20 |             <directory>./</directory>
21 |             <exclude>
22 |                 <directory>./Tests</directory>
23 |                 <directory>./Resources</directory>
24 |                 <directory>./vendor</directory>
25 |             </exclude>
26 |         </whitelist>
27 |     </filter>
28 | </phpunit>


--------------------------------------------------------------------------------