├── .codecov.yml ├── .editorconfig ├── .github ├── FUNDING.yml ├── dependabot.yml ├── stale.yml └── workflows │ └── ci.yml ├── .gitignore ├── .styleci.yml ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── composer.json ├── phpunit.xml ├── src ├── Concerns │ ├── GeneratesSnsMessages.php │ └── HandlesSns.php ├── Events │ ├── SnsNotification.php │ └── SnsSubscriptionConfirmation.php ├── Http │ └── Controllers │ │ └── SnsController.php └── LaravelSnsEventsServiceProvider.php └── tests ├── Controllers ├── CustomSnsController.php └── SnsController.php ├── EventTest.php ├── Events ├── CustomSnsEvent.php └── CustomSubscriptionConfirmation.php ├── TestCase.php ├── TestServiceProvider.php └── routes └── web.php /.codecov.yml: -------------------------------------------------------------------------------- 1 | codecov: 2 | notify: 3 | require_ci_to_pass: yes 4 | 5 | coverage: 6 | precision: 2 7 | round: down 8 | range: "70...100" 9 | 10 | status: 11 | project: yes 12 | patch: yes 13 | changes: no 14 | 15 | comment: 16 | layout: "reach, diff, flags, files, footer" 17 | behavior: default 18 | require_changes: no 19 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | insert_final_newline = true 7 | indent_style = space 8 | indent_size = 4 9 | trim_trailing_whitespace = true 10 | 11 | [*.md] 12 | trim_trailing_whitespace = false 13 | 14 | [*.yml] 15 | indent_size = 2 16 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: rennokki 2 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: "/" 5 | schedule: 6 | interval: weekly 7 | open-pull-requests-limit: 10 8 | - package-ecosystem: composer 9 | directory: "/" 10 | schedule: 11 | interval: weekly 12 | open-pull-requests-limit: 10 13 | versioning-strategy: increase 14 | -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | # Number of days of inactivity before an issue becomes stale 2 | daysUntilStale: 29 3 | # Number of days of inactivity before a stale issue is closed 4 | daysUntilClose: 1 5 | # Issues with these labels will never be considered stale 6 | exemptLabels: 7 | - pinned 8 | - security 9 | # Label to use when marking an issue as stale 10 | staleLabel: wontfix 11 | # Comment to post when marking an issue as stale. Set to `false` to disable 12 | markComment: false 13 | # Comment to post when closing a stale issue. Set to `false` to disable 14 | closeComment: > 15 | This issue has been automatically closed because it has not had any recent activity. 😨 16 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - '*' 7 | tags: 8 | - '*' 9 | pull_request: 10 | branches: 11 | - '*' 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | php: 21 | - '8.1' 22 | - '8.2' 23 | laravel: 24 | - 9.* 25 | - 10.* 26 | prefer: 27 | - 'prefer-lowest' 28 | - 'prefer-stable' 29 | include: 30 | - laravel: '9.*' 31 | testbench: '7.*' 32 | - laravel: '10.*' 33 | testbench: '8.*' 34 | 35 | name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} --${{ matrix.prefer }} 36 | 37 | steps: 38 | - uses: actions/checkout@v3.0.2 39 | 40 | - name: Setup PHP 41 | uses: shivammathur/setup-php@v2 42 | with: 43 | php-version: ${{ matrix.php }} 44 | extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv 45 | coverage: pcov 46 | 47 | - uses: actions/cache@v3.0.11 48 | name: Cache dependencies 49 | with: 50 | path: ~/.composer/cache/files 51 | key: composer-php-${{ matrix.php }}-${{ matrix.laravel }}-${{ matrix.prefer }}-${{ hashFiles('composer.json') }} 52 | 53 | - name: Install dependencies 54 | run: | 55 | composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update 56 | composer update --${{ matrix.prefer }} --prefer-dist --no-interaction --no-suggest 57 | 58 | - name: Run tests 59 | run: | 60 | vendor/bin/phpunit --coverage-text --coverage-clover=coverage.xml 61 | 62 | - uses: codecov/codecov-action@v3.1.0 63 | with: 64 | fail_ci_if_error: false 65 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor 2 | composer.lock -------------------------------------------------------------------------------- /.styleci.yml: -------------------------------------------------------------------------------- 1 | preset: laravel -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 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](https://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](https://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](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. 54 | 55 | **Happy coding**! 56 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright Renoki Co. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Laravel SNS Events 2 | ================== 3 | 4 | ![CI](https://github.com/renoki-co/laravel-sns-events/workflows/CI/badge.svg?branch=master) 5 | [![codecov](https://codecov.io/gh/renoki-co/laravel-sns-events/branch/master/graph/badge.svg)](https://codecov.io/gh/renoki-co/laravel-sns-events/branch/master) 6 | [![StyleCI](https://github.styleci.io/repos/189254977/shield?branch=master)](https://github.styleci.io/repos/189254977) 7 | [![Latest Stable Version](https://poser.pugx.org/rennokki/laravel-sns-events/v/stable)](https://packagist.org/packages/rennokki/laravel-sns-events) 8 | [![Total Downloads](https://poser.pugx.org/rennokki/laravel-sns-events/downloads)](https://packagist.org/packages/rennokki/laravel-sns-events) 9 | [![Monthly Downloads](https://poser.pugx.org/rennokki/laravel-sns-events/d/monthly)](https://packagist.org/packages/rennokki/laravel-sns-events) 10 | [![License](https://poser.pugx.org/rennokki/laravel-sns-events/license)](https://packagist.org/packages/rennokki/laravel-sns-events) 11 | 12 | Laravel SNS Events eases the processing of incoming SNS webhooks using Laravel Events. It leverages a controller that is made to properly listen to SNS HTTP(s) webhooks and trigger events on which you can handle in Laravel, so you just have to focus on writing your logic to handle the events. 13 | 14 | ## 🤝 Supporting 15 | 16 | **If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with [Github Sponsors](https://github.com/sponsors/rennokki). 📦** 17 | 18 | [](https://github-content.renoki.org/github-repo/19) 19 | 20 | ## 📃 Documentation 21 | 22 | [The entire documentation is available on Gitbook 🌍](https://laravel-sns-events.renoki.org/) 23 | 24 | ## 🐛 Testing 25 | 26 | Run the tests with: 27 | 28 | ``` bash 29 | vendor/bin/phpunit 30 | ``` 31 | 32 | ## 🤝 Contributing 33 | 34 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details. 35 | 36 | ## 🔒 Security 37 | 38 | If you discover any security related issues, please email alex@renoki.org instead of using the issue tracker. 39 | 40 | ## 🎉 Credits 41 | 42 | - [Alex Renoki](https://github.com/rennokki) 43 | - [All Contributors](../../contributors) 44 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rennokki/laravel-sns-events", 3 | "description": "Laravel SNS Events eases the processing of incoming SNS webhooks using Laravel Events.", 4 | "type": "package", 5 | "license": "Apache-2.0", 6 | "keywords": [ 7 | "laravel" 8 | ], 9 | "authors": [ 10 | { 11 | "name": "Alex Renoki", 12 | "email": "alex@renoki.org", 13 | "homepage": "https://github.com/rennokki", 14 | "role": "Developer" 15 | } 16 | ], 17 | "require": { 18 | "illuminate/http": "^9.35|^10.5", 19 | "illuminate/routing": "^9.35|^10.5", 20 | "illuminate/support": "^9.35|^10.5", 21 | "aws/aws-php-sns-message-validator": "^1.6" 22 | }, 23 | "autoload": { 24 | "psr-4": { 25 | "Rennokki\\LaravelSnsEvents\\": "./src" 26 | } 27 | }, 28 | "autoload-dev": { 29 | "psr-4": { 30 | "Rennokki\\LaravelSnsEvents\\Tests\\": "tests" 31 | } 32 | }, 33 | "scripts": { 34 | "test": "vendor/bin/phpunit" 35 | }, 36 | "extra": { 37 | "laravel": { 38 | "providers": [ 39 | "Rennokki\\LaravelSnsEvents\\LaravelSnsEventsServiceProvider" 40 | ] 41 | } 42 | }, 43 | "require-dev": { 44 | "mockery/mockery": "^1.5", 45 | "orchestra/testbench": "^7.23|^8.1.1", 46 | "phpunit/phpunit": "^9.5.26" 47 | }, 48 | "config": { 49 | "sort-packages": true 50 | }, 51 | "minimum-stability": "dev", 52 | "prefer-stable": true 53 | } 54 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | 13 | 14 | tests 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | src/ 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /src/Concerns/GeneratesSnsMessages.php: -------------------------------------------------------------------------------- 1 | 'SubscriptionConfirmation', 74 | 'MessageId' => '165545c9-2a5c-472c-8df2-7ff2be2b3b1b', 75 | 'Token' => '2336412f37...', 76 | 'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:MyTopic', 77 | 'Message' => 'You have chosen to subscribe to the topic arn:aws:sns:us-west-2:123456789012:MyTopic.\nTo confirm the subscription, visit the SubscribeURL included in this message.', 78 | 'SubscribeURL' => 'https://example.com', 79 | 'Timestamp' => now()->toDateTimeString(), 80 | 'SignatureVersion' => '1', 81 | 'Signature' => true, 82 | 'SigningCertURL' => static::$snsValidCertUrl, 83 | ], $custom); 84 | 85 | $message['Signature'] = $this->getSignature( 86 | $validator->getStringToSign(new Message($message)) 87 | ); 88 | 89 | return $message; 90 | } 91 | 92 | /** 93 | * Get an example notification payload for testing. 94 | * 95 | * @param array $payload 96 | * @param array $custom 97 | * @return array 98 | */ 99 | protected function getNotificationPayload(array $payload = [], array $custom = []): array 100 | { 101 | $validator = new MessageValidator; 102 | 103 | $payload = json_encode($payload); 104 | 105 | $message = array_merge([ 106 | 'Type' => 'Notification', 107 | 'MessageId' => '22b80b92-fdea-4c2c-8f9d-bdfb0c7bf324', 108 | 'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:MyTopic', 109 | 'Subject' => 'My First Message', 110 | 'Message' => "{$payload}", 111 | 'Timestamp' => now()->toDateTimeString(), 112 | 'SignatureVersion' => '1', 113 | 'Token' => '2336412f37...', 114 | 'Signature' => true, 115 | 'SigningCertURL' => static::$snsValidCertUrl, 116 | 'UnsubscribeURL' => 'https://sns.us-west-2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-west-2:123456789012:MyTopic:c9135db0-26c4-47ec-8998-413945fb5a96', 117 | ], $custom); 118 | 119 | $message['Signature'] = $this->getSignature( 120 | $validator->getStringToSign(new Message($message)) 121 | ); 122 | 123 | return $message; 124 | } 125 | 126 | /** 127 | * Send the SNS-signed message to the given URL. 128 | * 129 | * @param string $url 130 | * @param array $snsPayload 131 | * @return \Illuminate\Testing\TestResponse 132 | */ 133 | protected function sendSnsMessage($url, array $snsPayload = []) 134 | { 135 | /** @var \Illuminate\Foundation\Testing\Concerns\MakesHttpRequests&\Rennokki\LaravelSnsEvents\Concerns\GeneratesSnsMessages $this */ 136 | return $this->withHeaders($this->getHeadersForMessage($snsPayload)) 137 | ->withHeaders(['X-Sns-Testing-Certificate' => static::$snsCertificate]) 138 | ->json('POST', $url, $snsPayload); 139 | } 140 | 141 | /** 142 | * Get the right headers for a SNS message. 143 | * 144 | * @param array $message 145 | * @return array 146 | */ 147 | protected function getHeadersForMessage(array $message): array 148 | { 149 | return [ 150 | 'X-AMZ-SNS-MESSAGE-TYPE' => $message['Type'] ?? null, 151 | 'X-AMZ-SNS-MESSAGE-ID' => $message['MessageId'] ?? null, 152 | 'X-AMZ-SNS-TOPIC-ARN' => $message['TopicArn'] ?? null, 153 | 'X-AMZ-SNS-SUBSCRIPTION-ARN' => ($message['TopicArn'] ?? null).':c9135db0-26c4-47ec-8998-413945fb5a96', 154 | ]; 155 | } 156 | } 157 | -------------------------------------------------------------------------------- /src/Concerns/HandlesSns.php: -------------------------------------------------------------------------------- 1 | getContent() ?: file_get_contents('php://input') 24 | ); 25 | } catch (Exception $e) { 26 | return new Message([]); 27 | } 28 | } 29 | 30 | /** 31 | * Check if the SNS message is valid. 32 | * 33 | * @param \Illuminate\Http\Request $request 34 | * @return bool 35 | */ 36 | public function snsMessageIsValid(Request $request): bool 37 | { 38 | try { 39 | return $this->getMessageValidator($request)->isValid( 40 | $this->getSnsMessage($request) 41 | ); 42 | } catch (Exception $e) { 43 | return false; 44 | } 45 | } 46 | 47 | /** 48 | * Get the message validator instance. 49 | * 50 | * @param \Illuminate\Http\Request $request 51 | * @return \Aws\Sns\MessageValidator 52 | */ 53 | protected function getMessageValidator(Request $request) 54 | { 55 | if (App::environment(['testing', 'local'])) { 56 | return new MessageValidator(function ($url) use ($request) { 57 | if ($certificate = $request->sns_certificate) { 58 | return $certificate; 59 | } 60 | 61 | if ($certificate = $request->header('X-Sns-Testing-Certificate')) { 62 | return $certificate; 63 | } 64 | 65 | return $url; 66 | }); 67 | } 68 | 69 | return new MessageValidator; 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /src/Events/SnsNotification.php: -------------------------------------------------------------------------------- 1 | payload = $payload; 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/Events/SnsSubscriptionConfirmation.php: -------------------------------------------------------------------------------- 1 | snsMessageIsValid($request)) { 24 | return $this->okStatus(); 25 | } 26 | 27 | $snsMessage = $this->getSnsMessage($request)->toArray(); 28 | 29 | if (isset($snsMessage['Type'])) { 30 | if ($snsMessage['Type'] === 'SubscriptionConfirmation') { 31 | @file_get_contents($snsMessage['SubscribeURL']); 32 | 33 | $class = $this->getSubscriptionConfirmationEventClass(); 34 | 35 | event(new $class( 36 | $this->getSubscriptionConfirmationPayload($snsMessage, $request) 37 | )); 38 | 39 | call_user_func([$this, 'onSubscriptionConfirmation'], $snsMessage, $request); 40 | } 41 | 42 | if ($snsMessage['Type'] === 'Notification') { 43 | $class = $this->getNotificationEventClass(); 44 | 45 | event(new $class( 46 | $this->getNotificationPayload($snsMessage, $request) 47 | )); 48 | 49 | call_user_func([$this, 'onNotification'], $snsMessage, $request); 50 | } 51 | } 52 | 53 | return $this->okStatus(); 54 | } 55 | 56 | /** 57 | * Get the event payload to stream to the event in case 58 | * AWS sent a notification payload. 59 | * 60 | * @param array $snsMessage 61 | * @param \Illuminate\Http\Request $request 62 | * @return array 63 | */ 64 | protected function getNotificationPayload(array $snsMessage, Request $request): array 65 | { 66 | return [ 67 | 'message' => $snsMessage, 68 | 'headers' => $request->headers->all(), 69 | ]; 70 | } 71 | 72 | /** 73 | * Get the event payload to stream to the event in case 74 | * AWS sent a subscription confirmation payload. 75 | * 76 | * @param array $snsMessage 77 | * @param \Illuminate\Http\Request $request 78 | * @return array 79 | */ 80 | protected function getSubscriptionConfirmationPayload(array $snsMessage, Request $request): array 81 | { 82 | return $this->getNotificationPayload($snsMessage, $request); 83 | } 84 | 85 | /** 86 | * Get the event class to trigger during subscription confirmation. 87 | * 88 | * @return string 89 | */ 90 | protected function getSubscriptionConfirmationEventClass(): string 91 | { 92 | return SnsSubscriptionConfirmation::class; 93 | } 94 | 95 | /** 96 | * Get the event class to trigger during SNS event. 97 | * 98 | * @return string 99 | */ 100 | protected function getNotificationEventClass(): string 101 | { 102 | return SnsNotification::class; 103 | } 104 | 105 | /** 106 | * Handle logic at the controller level on notification. 107 | * 108 | * @param array $snsMessage 109 | * @param \Illuminate\Http\Request $request 110 | * @return void 111 | */ 112 | protected function onNotification(array $snsMessage, Request $request): void 113 | { 114 | // 115 | } 116 | 117 | /** 118 | * Handle logic at the controller level on subscription. 119 | * 120 | * @param array $snsMessage 121 | * @param \Illuminate\Http\Request $request 122 | * @return void 123 | */ 124 | protected function onSubscriptionConfirmation(array $snsMessage, Request $request): void 125 | { 126 | // 127 | } 128 | 129 | /** 130 | * Get a 200 OK status. 131 | * 132 | * @return \Illuminate\Http\Response 133 | */ 134 | protected function okStatus() 135 | { 136 | return response('OK', 200); 137 | } 138 | } 139 | -------------------------------------------------------------------------------- /src/LaravelSnsEventsServiceProvider.php: -------------------------------------------------------------------------------- 1 | $snsMessage, 24 | 'test' => $request->query('test'), 25 | ]; 26 | } 27 | 28 | /** 29 | * Get the event payload to stream to the event in case 30 | * AWS sent a subscription confirmation payload. 31 | * 32 | * @param array $snsMessage 33 | * @param \Illuminate\Http\Request $request 34 | * @return array 35 | */ 36 | protected function getSubscriptionConfirmationPayload(array $snsMessage, Request $request): array 37 | { 38 | return [ 39 | 'message' => $snsMessage, 40 | 'confirmation_test' => $request->query('test'), 41 | 'on_subscription_confirmation' => $request->onSubscriptionConfirmation, 42 | 'on_notification' => $request->onNotification, 43 | ]; 44 | } 45 | 46 | /** 47 | * Get the event class to trigger during subscription confirmation. 48 | * 49 | * @return string 50 | */ 51 | protected function getSubscriptionConfirmationEventClass(): string 52 | { 53 | return CustomSubscriptionConfirmation::class; 54 | } 55 | 56 | /** 57 | * Get the event class to trigger during SNS event. 58 | * 59 | * @return string 60 | */ 61 | protected function getNotificationEventClass(): string 62 | { 63 | return CustomSnsEvent::class; 64 | } 65 | 66 | /** 67 | * Handle logic at the controller level on notification. 68 | * 69 | * @param array $snsMessage 70 | * @param \Illuminate\Http\Request $request 71 | * @return void 72 | */ 73 | protected function onNotification(array $snsMessage, Request $request): void 74 | { 75 | mt_rand(0, 10000); 76 | } 77 | 78 | /** 79 | * Handle logic at the controller level on subscription. 80 | * 81 | * @param array $snsMessage 82 | * @param \Illuminate\Http\Request $request 83 | * @return void 84 | */ 85 | protected function onSubscriptionConfirmation(array $snsMessage, Request $request): void 86 | { 87 | mt_rand(0, 10000); 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /tests/Controllers/SnsController.php: -------------------------------------------------------------------------------- 1 | sendSnsMessage(route('sns'))->assertSee('OK'); 18 | 19 | Event::assertNotDispatched(SnsNotification::class); 20 | Event::assertNotDispatched(SnsSubscriptionConfirmation::class); 21 | 22 | $this->sendSnsMessage(route('sns'))->assertSee('OK'); 23 | 24 | Event::assertNotDispatched(SnsNotification::class); 25 | Event::assertNotDispatched(SnsSubscriptionConfirmation::class); 26 | 27 | $payload = $this->getSubscriptionConfirmationPayload(); 28 | 29 | $this->sendSnsMessage(route('sns'))->assertSee('OK'); 30 | 31 | Event::assertNotDispatched(SnsNotification::class); 32 | Event::assertNotDispatched(SnsSubscriptionConfirmation::class); 33 | } 34 | 35 | public function test_subscription_confirmation() 36 | { 37 | Event::fake(); 38 | 39 | $payload = $this->getSubscriptionConfirmationPayload(); 40 | 41 | $this->withHeaders(['x-test-header' => 1]) 42 | ->sendSnsMessage(route('sns'), $payload) 43 | ->assertSee('OK'); 44 | 45 | Event::assertNotDispatched(SnsNotification::class); 46 | 47 | Event::assertDispatched(SnsSubscriptionConfirmation::class, function ($event) { 48 | $this->assertTrue( 49 | isset($event->payload['headers']['x-test-header']) 50 | ); 51 | 52 | return true; 53 | }); 54 | } 55 | 56 | public function test_notification_confirmation() 57 | { 58 | Event::fake(); 59 | 60 | $payload = $this->getNotificationPayload([ 61 | 'test' => 1, 62 | 'sns' => true, 63 | ]); 64 | 65 | $this->withHeaders(['x-test-header' => 1]) 66 | ->sendSnsMessage(route('sns'), $payload) 67 | ->assertSee('OK'); 68 | 69 | Event::assertNotDispatched(SnsSubscriptionConfirmation::class); 70 | 71 | Event::assertDispatched(SnsNotification::class, function ($event) { 72 | $this->assertTrue( 73 | isset($event->payload['headers']['x-test-header']) 74 | ); 75 | 76 | $message = json_decode( 77 | $event->payload['message']['Message'], true 78 | ); 79 | 80 | $this->assertEquals(1, $message['test']); 81 | $this->assertEquals(true, $message['sns']); 82 | 83 | return true; 84 | }); 85 | } 86 | 87 | public function test_custom_controller_confirmation() 88 | { 89 | Event::fake(); 90 | 91 | $payload = $this->getSubscriptionConfirmationPayload(); 92 | 93 | $this->withHeaders(['x-test-header' => 1]) 94 | ->sendSnsMessage(route('custom-sns', ['test' => 'some-string']), $payload) 95 | ->assertSee('OK'); 96 | 97 | Event::assertNotDispatched(CustomSnsEvent::class); 98 | 99 | Event::assertDispatched(CustomSubscriptionConfirmation::class, function ($event) { 100 | $this->assertEquals( 101 | 'some-string', $event->payload['confirmation_test'] 102 | ); 103 | 104 | $this->assertFalse( 105 | isset($event->payload['headers']) 106 | ); 107 | 108 | return true; 109 | }); 110 | } 111 | 112 | public function test_custom_controller_notification() 113 | { 114 | Event::fake(); 115 | 116 | $payload = $this->getNotificationPayload([ 117 | 'test' => 1, 118 | 'sns' => true, 119 | ]); 120 | 121 | $this->withHeaders(['x-test-header' => 1]) 122 | ->sendSnsMessage(route('custom-sns', ['test' => 'some-string']), $payload) 123 | ->assertSee('OK'); 124 | 125 | Event::assertNotDispatched(CustomSubscriptionConfirmation::class); 126 | 127 | Event::assertDispatched(CustomSnsEvent::class, function ($event) { 128 | $this->assertEquals( 129 | 'some-string', $event->payload['test'] 130 | ); 131 | 132 | $this->assertFalse( 133 | isset($event->payload['headers']) 134 | ); 135 | 136 | $message = json_decode( 137 | $event->payload['message']['Message'], true 138 | ); 139 | 140 | $this->assertEquals(1, $message['test']); 141 | $this->assertEquals(true, $message['sns']); 142 | 143 | return true; 144 | }); 145 | } 146 | } 147 | -------------------------------------------------------------------------------- /tests/Events/CustomSnsEvent.php: -------------------------------------------------------------------------------- 1 | set('app.key', '6rE9Nz59bGRbeMATftriyQjrpF7DcOQm'); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /tests/TestServiceProvider.php: -------------------------------------------------------------------------------- 1 | loadRoutesFrom(__DIR__.'/routes/web.php'); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /tests/routes/web.php: -------------------------------------------------------------------------------- 1 | name('sns'); 7 | 8 | Route::any('/sns-custom', 'Rennokki\LaravelSnsEvents\Tests\Controllers\CustomSnsController@handle') 9 | ->name('custom-sns'); 10 | --------------------------------------------------------------------------------