├── .gitignore ├── package.json ├── README.md ├── gulpfile.js ├── Plugin.php ├── routing.yml ├── Controller ├── OperatorController.php ├── MessageController.php └── ThreadController.php └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Do not index node.js modules that are used for building 2 | node_modules 3 | package-lock.json 4 | 5 | # Do not index releases 6 | release 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.0.1", 3 | "devDependencies": { 4 | "gulp": "~4.0.0", 5 | "event-stream": "3.3.4", 6 | "gulp-zip": "~3.0.2", 7 | "gulp-tar": "~3.1.0", 8 | "gulp-gzip": "~1.1.0", 9 | "gulp-chmod": "~3.0.0", 10 | "gulp-rename": "~1.2.2" 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Mibew External API plugin 2 | 3 | Provides a REST API for external applications. 4 | 5 | 6 | ## Installation 7 | 8 | 1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources. 9 | 10 | 2. Untar/unzip the plugin's archive. 11 | 12 | 3. Put files of the plugins to the `/plugins` folder. 13 | 14 | 4. Navigate to "``/operator/plugin" page and enable the plugin. 15 | 16 | 17 | ## Build from sources 18 | 19 | There are several actions one should do before use the latest version of the plugin from the repository: 20 | 21 | 1. Obtain a copy of the repository using `git clone`, download button, or another way. 22 | 2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). 23 | 3. Install [Gulp](http://gulpjs.com/). 24 | 4. Install npm dependencies using `npm install`. 25 | 5. Run Gulp to build the sources using `gulp default`. 26 | 27 | Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory. 28 | 29 | 30 | ## License 31 | 32 | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 33 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | var eventStream = require('event-stream'), 2 | gulp = require('gulp'), 3 | chmod = require('gulp-chmod'), 4 | zip = require('gulp-zip'), 5 | tar = require('gulp-tar'), 6 | gzip = require('gulp-gzip'), 7 | rename = require('gulp-rename'); 8 | 9 | gulp.task('prepare-release', function() { 10 | var version = require('./package.json').version; 11 | 12 | return eventStream.merge( 13 | getSources() 14 | .pipe(zip('external-api-plugin-' + version + '.zip')), 15 | getSources() 16 | .pipe(tar('external-api-plugin-' + version + '.tar')) 17 | .pipe(gzip()) 18 | ) 19 | .pipe(chmod(0644)) 20 | .pipe(gulp.dest('release')); 21 | }); 22 | 23 | // Builds and packs plugins sources 24 | gulp.task('default', gulp.series('prepare-release')); 25 | 26 | /** 27 | * Returns files stream with the plugin sources. 28 | * 29 | * @returns {Object} Stream with VinylFS files. 30 | */ 31 | var getSources = function() { 32 | return gulp.src([ 33 | 'Controller/*', 34 | 'LICENSE', 35 | 'Plugin.php', 36 | 'README.md', 37 | 'routing.yml' 38 | ], 39 | {base: './'} 40 | ) 41 | .pipe(rename(function(path) { 42 | path.dirname = 'Mibew/Mibew/Plugin/ExternalApi/' + path.dirname; 43 | })); 44 | } 45 | -------------------------------------------------------------------------------- /Plugin.php: -------------------------------------------------------------------------------- 1 | . 6 | * 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | */ 19 | 20 | /** 21 | * @file The main file of Mibew:ExternalApi plugin. 22 | */ 23 | 24 | namespace Mibew\Mibew\Plugin\ExternalApi; 25 | 26 | /** 27 | * The main plugin's file definition. 28 | * 29 | * At the moment it does nothing. 30 | */ 31 | class Plugin extends \Mibew\Plugin\AbstractPlugin implements \Mibew\Plugin\PluginInterface 32 | { 33 | /** 34 | * The plugin does not need extra initialization thus it is always ready to 35 | * work. 36 | * 37 | * @return boolean 38 | */ 39 | public function initialized() 40 | { 41 | return true; 42 | } 43 | 44 | /** 45 | * The main entry point of a plugin. 46 | */ 47 | public function run() 48 | { 49 | // There are no actions that should be done. 50 | } 51 | 52 | /** 53 | * Specify version of the plugin. 54 | * 55 | * @return string Plugin's version. 56 | */ 57 | public static function getVersion() 58 | { 59 | return '0.0.1'; 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /routing.yml: -------------------------------------------------------------------------------- 1 | # Thread 2 | mibew_external_api_threads: 3 | path: /external-api/v1/threads 4 | defaults: 5 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\ThreadController::getThreadCollectionAction 6 | methods: [GET] 7 | 8 | mibew_external_api_thread: 9 | path: /external-api/v1/threads/{thread_id} 10 | defaults: 11 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\ThreadController::getThreadAction 12 | methods: [GET] 13 | requirements: 14 | thread_id: \d{1,10} 15 | 16 | mibew_external_api_thread_update: 17 | path: /external-api/v1/threads/{thread_id} 18 | defaults: 19 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\ThreadController::updateThreadAction 20 | methods: [PUT] 21 | requirements: 22 | thread_id: \d{1,10} 23 | 24 | # Thread's messages 25 | mibew_external_api_messages: 26 | path: /external-api/v1/threads/{thread_id}/messages 27 | defaults: 28 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\MessageController::getMessageCollectionAction 29 | methods: [GET] 30 | requirements: 31 | thread_id: \d{1,10} 32 | 33 | mibew_external_api_message_create: 34 | path: /external-api/v1/threads/{thread_id}/messages 35 | defaults: 36 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\MessageController::postMessageAction 37 | methods: [POST] 38 | requirements: 39 | thread_id: \d{1,10} 40 | 41 | # Operators 42 | mibew_external_api_operator_ping: 43 | path: /external-api/v1/operators/{operator_id}/ping 44 | defaults: 45 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\OperatorController::pingAction 46 | methods: [POST] 47 | requirements: 48 | operator_id: \d{1,10} 49 | 50 | mibew_external_api_operator_status: 51 | path: /external-api/v1/operators/{operator_id}/status 52 | defaults: 53 | _controller: Mibew\Mibew\Plugin\ExternalApi\Controller\OperatorController::updateStatusAction 54 | methods: [PUT] 55 | requirements: 56 | operator_id: \d{1,10} 57 | -------------------------------------------------------------------------------- /Controller/OperatorController.php: -------------------------------------------------------------------------------- 1 | . 6 | * 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | */ 19 | 20 | namespace Mibew\Mibew\Plugin\ExternalApi\Controller; 21 | 22 | use Mibew\Controller\AbstractController; 23 | use Symfony\Component\HttpFoundation\Request; 24 | use Symfony\Component\HttpFoundation\JsonResponse; 25 | 26 | /** 27 | * Process all API calls related with operators. 28 | */ 29 | class OperatorController extends AbstractController 30 | { 31 | public function pingAction(Request $request) 32 | { 33 | // Get the ID of the operator. 34 | $id = $request->attributes->getInt('operator_id'); 35 | 36 | // Update of operator's last ping time. 37 | $time = time(); 38 | 39 | return new JsonResponse(array( 40 | 'id' => $id, 41 | 'lastPingTime' => $time, 42 | )); 43 | } 44 | 45 | public function updateStatusAction(Request $request) 46 | { 47 | // Get ID of the operator whose state should be changed. 48 | $id = $request->attributes->getInt('operator_id'); 49 | 50 | // Get the operator's status from the request and save it into the 51 | // database. 52 | $is_online = true; 53 | 54 | // ...and return the new state 55 | return new JsonResponse(array( 56 | 'id' => $id, 57 | 'isOnline' => $is_online, 58 | )); 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /Controller/MessageController.php: -------------------------------------------------------------------------------- 1 | . 6 | * 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | */ 19 | 20 | namespace Mibew\Mibew\Plugin\ExternalApi\Controller; 21 | 22 | use Mibew\Controller\AbstractController; 23 | use Symfony\Component\HttpFoundation\Request; 24 | use Symfony\Component\HttpFoundation\JsonResponse; 25 | 26 | /** 27 | * Process all API calls related with thread's messages. 28 | */ 29 | class MessageController extends AbstractController 30 | { 31 | public function getMessageCollectionAction(Request $request) 32 | { 33 | // Get the ID of the requested thread. 34 | $thread_id = $request->attributes->getInt('thread_id'); 35 | // Check if only subset of messages should be loaded. 36 | $since = $request->query->getInt('since', 0); 37 | 38 | // Load all messages related with the requested thread whose IDs are 39 | // greater than the specified one and serialize them. 40 | $messages = array(); 41 | 42 | for ($i = 1; $i < 4; $i++) { 43 | $messages[] = array( 44 | 'threadId' => $thread_id, 45 | 'id' => $since + $i, 46 | ); 47 | } 48 | 49 | return new JsonResponse($messages); 50 | } 51 | 52 | public function postMessageAction(Request $request) 53 | { 54 | // Get the ID of the thread the message should be posted to. 55 | $thread_id = $request->attributes->getInt('thread_id'); 56 | 57 | // Save the message... 58 | // ...and send the ID of the created message to the client. 59 | 60 | return new JsonResponse(array( 61 | 'id' => 29, 62 | ), 201); 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /Controller/ThreadController.php: -------------------------------------------------------------------------------- 1 | . 6 | * 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | */ 19 | 20 | namespace Mibew\Mibew\Plugin\ExternalApi\Controller; 21 | 22 | use Mibew\Controller\AbstractController; 23 | use Symfony\Component\HttpFoundation\Request; 24 | use Symfony\Component\HttpFoundation\JsonResponse; 25 | 26 | /** 27 | * Process all API call related with threads. 28 | * 29 | * Notice that messages are processed with 30 | * {@link Mibew\Mibew\Plugin\ExternalApi\Controller\Message} controller. 31 | */ 32 | class ThreadController extends AbstractController 33 | { 34 | public function getThreadCollectionAction(Request $request) 35 | { 36 | // The logic of threads loading and sending goes here. Also the threads 37 | // should be converted to a format which will be appropriate for client. 38 | $threads = array(); 39 | 40 | // Some test data and serialize them. 41 | $threads[] = array( 42 | 'id' => 1, 43 | ); 44 | $threads[] = array( 45 | 'id' => 2, 46 | ); 47 | 48 | // Pass the threads to the client 49 | return new JsonResponse($threads); 50 | } 51 | 52 | public function getThreadAction(Request $request) 53 | { 54 | // Get ID of the requested thread... 55 | $id = $request->attributes->getInt('thread_id'); 56 | // ...load requested thread from the database and serialize it. 57 | $thread = array( 58 | 'id' => $id, 59 | ); 60 | 61 | // Pass the thread to the client 62 | return new JsonResponse($thread); 63 | } 64 | 65 | public function updateThreadAction(Request $request) 66 | { 67 | // Get all thread's info from the request... 68 | $id = $request->attributes->getInt('thread_id'); 69 | // ...and save it to the database 70 | 71 | // Pass the threads to the client 72 | return new JsonResponse(array( 73 | 'id' => $id, 74 | )); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------