├── .eslintignore ├── routes ├── hello-admin.js └── hello-eg.js ├── .gitignore ├── .eslintrc ├── conditions └── url-match.js ├── policies ├── example-policy.js └── advanced-policy.js ├── package.json ├── manifest.js ├── README.md └── LICENSE /.eslintignore: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /routes/hello-admin.js: -------------------------------------------------------------------------------- 1 | module.exports = function (adminExpressApp) { 2 | adminExpressApp.get('/hello', (req, res) => { 3 | res.json({hello: 'admin'}); 4 | }); 5 | }; 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | .idea 3 | node_modules/ 4 | npm-debug.log 5 | example/keys/*.pem 6 | .DS_Store 7 | **/.DS_Store 8 | coverage 9 | .nyc_output 10 | coverage.lcov 11 | -------------------------------------------------------------------------------- /routes/hello-eg.js: -------------------------------------------------------------------------------- 1 | module.exports = function (gatewayExpressApp) { 2 | gatewayExpressApp.get('/hello', (req, res) => { 3 | res.json({hello: 'Express-Gateway'}); 4 | }); 5 | }; 6 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "standard", 3 | "env": { 4 | "es6": true, 5 | "node": true 6 | }, 7 | "rules": { 8 | "no-console": "off" 9 | }, 10 | "root": true 11 | } 12 | -------------------------------------------------------------------------------- /conditions/url-match.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | name: 'url-match', 3 | handler: function (req, conditionConfig) { 4 | return (conditionConfig.expected === req.url); 5 | }, 6 | schema: { // This is for Admin API to validate params 7 | expected: { 8 | title: 'expected', 9 | description: 'the expected url', 10 | type: 'string', 11 | required: false 12 | } 13 | } 14 | }; 15 | -------------------------------------------------------------------------------- /policies/example-policy.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | name: 'example', 3 | policy: (actionParams) => { 4 | return (req, res, next) => { 5 | console.log('executing policy example with params', actionParams) 6 | } 7 | }, 8 | schema: { // This is for Admin API to validate params 9 | type: 'object', 10 | properties: { 11 | url: { 12 | title: 'url', 13 | description: 'the url to initialize', 14 | type: 'string', 15 | required: false 16 | } 17 | } 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "express-gateway-plugin-example", 3 | "version": "1.1.0", 4 | "description": "Plugin Example for Express Gateway", 5 | "main": "manifest.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "", 10 | "license": "Apache-2.0", 11 | "dependencies": {}, 12 | "devDependencies": { 13 | "eslint": "^4.9.0", 14 | "eslint-plugin-standard": "^3.0.1", 15 | "eslint-config-standard": "^10.2.1", 16 | "eslint-plugin-import": "^2.8.0", 17 | "eslint-plugin-node": "^5.2.1", 18 | "eslint-plugin-promise": "^3.6.0" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /policies/advanced-policy.js: -------------------------------------------------------------------------------- 1 | module.exports = pluginContext => { 2 | return { 3 | name: 'exampleWithContext', 4 | policy: (actionParams) => { 5 | return (req, res, next) => { 6 | console.log('executing policy exampleWithContext with params and context', actionParams, pluginContext) 7 | } 8 | }, 9 | schema: { // This is for Admin API to ask about params 10 | type: 'object', 11 | properties: { 12 | url: { 13 | title: 'url', 14 | description: 'the url to initialize', 15 | type: 'string', 16 | required: false 17 | } 18 | } 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /manifest.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | version: '1.3.0', 3 | init: function (pluginContext) { 4 | pluginContext.registerPolicy(require('./policies/example-policy')); 5 | pluginContext.registerCondition(require('./conditions/url-match')); 6 | pluginContext.registerGatewayRoute(require('./routes/hello-eg')); 7 | pluginContext.registerAdminRoute(require('./routes/hello-admin')); 8 | 9 | pluginContext.eventBus.on('hot-reload', function ({ type, newConfig }) { 10 | console.log('hot-reload', type, newConfig); 11 | }); 12 | pluginContext.eventBus.on('http-ready', function ({ httpServer }) { 13 | console.log('http ready'); 14 | }); 15 | pluginContext.eventBus.on('https-ready', function ({ httpsServer }) { 16 | console.log('https ready'); 17 | }); 18 | pluginContext.eventBus.on('admin-ready', function ({ adminServer }) { 19 | console.log('admin ready'); 20 | }); 21 | }, 22 | policies:['example'], // this is for CLI to automatically add to "policies" whitelist in gateway.config 23 | schema: { // This is for CLI to ask about params 'eg plugin configure example' 24 | baseUrl: { 25 | title: 'Base Url', 26 | description: 'the base url to initialize', 27 | type: 'string', 28 | required: true 29 | }, 30 | maxRequestsPerSecond: { 31 | title: 'Max Requests per second', 32 | description: 'the max rps value', 33 | type: 'number' 34 | } 35 | } 36 | }; 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # express-gateway-plugin-example 2 | Generic plugin example for [Express Gateway](http://www.express-gateway.io/) 3 | 4 | It shows all extension points available in the Express Gateway Plugin Engine 1.2.0 5 | 6 | ### Getting Started in 5 minutes: 7 | 8 | ```bash 9 | $ npm -i -g express-gateway 10 | $ eg gateway create 11 | 12 | eg gateway create 13 | # follow prompts 14 | ? What\'s the name of your Express Gateway? demo 15 | ? Where would you like to install your Express Gateway? demo 16 | ? What type of Express Gateway do you want to create? Getting Started with Express Gateway 17 | 18 | # cd to new directory 19 | $ cd ./demo 20 | 21 | # install this plugin 22 | $ eg plugin install example 23 | ? Set value for baseUrl: http://example.com 24 | ? Set value for maxRequestsPerSecond: 234 25 | ? Would you like to enable this plugin in system config? Yes 26 | ? Would you like to add new policies to gateway config? Yes 27 | Plugin installed! 28 | ``` 29 | 30 | ### Detailed documentation: 31 | 32 | [Express Gateway Overview](http://www.express-gateway.io/about/) 33 | 34 | Express Gateway plugin explanation: 35 | [Plugin Documentation](http://www.express-gateway.io/docs/plugins/) 36 | 37 | CLI for installing and configuring plugin: 38 | [Plugins CLI](http://localhost:4000/docs/cli/plugins/) 39 | 40 | Guidlines how to write your custom plugin: 41 | [Plugin Development Guide](http://www.express-gateway.io/docs/plugins/development-guide) 42 | 43 | [Express Gateway Boot Sequence](http://www.express-gateway.io/docs/plugins/boot-sequence) explains order in which plugin entities are loaded and executed. 44 | -------------------------------------------------------------------------------- /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 {yyyy} {name of copyright owner} 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 | --------------------------------------------------------------------------------