├── .apk_repo ├── test-12.apk ├── test-3.apk └── test-8.apk ├── .gitignore ├── package.json ├── test └── apkReaderTest.js ├── README.md ├── lib ├── updater.js └── apkReader.js └── LICENSE /.apk_repo/test-12.apk: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.apk_repo/test-3.apk: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.apk_repo/test-8.apk: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | *~ 3 | test-reports.xml 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "apk-updater", 3 | "version": "0.1.1", 4 | "description": "Express module for apk auto-updater", 5 | "directories": { 6 | "test": "test" 7 | }, 8 | "main": "lib/updater.js", 9 | "scripts": { 10 | "test": "./node_modules/.bin/mocha --reporter xunit --ui bdd test/ > test-reports.xml" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/NDMAC/apk-updater.git" 15 | }, 16 | "keywords": [ 17 | "node", 18 | "android", 19 | "apk" 20 | ], 21 | "dependencies": { 22 | "underscore": "*", 23 | "node-uuid": "*", 24 | "winston": "*" 25 | }, 26 | "devDependencies": { 27 | "mocha": "*", 28 | "should": "*", 29 | "express": "3.x" 30 | }, 31 | "author": "G.Bourel", 32 | "license": "Apache" 33 | } 34 | -------------------------------------------------------------------------------- /test/apkReaderTest.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var should = require('should') 4 | , fs = require('fs') 5 | , reader = require('../lib/apkReader.js'); 6 | 7 | 8 | describe('Reader available apk',function(){ 9 | var apk; 10 | before(function(done){ 11 | apk = reader.available(); 12 | done(); 13 | }); 14 | 15 | it('should be an object',function(){ 16 | apk.should.be.a.object; 17 | }); 18 | 19 | it('should contain 3 values for test apk',function(){ 20 | apk.test.should.have.length(3); 21 | }); 22 | 23 | it('should sort values',function(){ 24 | apk.test[0].version.should.eql(3); 25 | apk.test[2].version.should.eql(12); 26 | }); 27 | 28 | it('should contain filenames',function(){ 29 | apk.test[0].filename.should.be.a.string; 30 | }); 31 | 32 | // How to test watch ? 33 | // it('should handle file modifications',function(){ 34 | // var tmpName = '.apk_repo/test2-20.apk'; 35 | // fs.writeFileSync(tmpName, 'test content'); 36 | // setTimeout(function() { 37 | // apk.test2[4].version.should.eql(42); 38 | // fs.unlinkSync(tmpName); 39 | // }, 100); 40 | 41 | // }); 42 | }); 43 | 44 | describe('Reader last apk',function(){ 45 | it('should have greater version',function(){ 46 | reader.last('test').version.should.eql(12); 47 | }); 48 | 49 | it('should ignore unknown apk name',function(){ 50 | should.not.exist(reader.last('unknown')); 51 | }); 52 | }); 53 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | apk-updater 2 | =========== 3 | 4 | Android's apk automatic updater server module for [Node.js](http://nodejs.org/) with [Express](http://expressjs.com/). This update server is an alternative to Google play server in order to completely manage the APK packages to offer. 5 | 6 | See [android-auto-updater-client](https://github.com/NDMAC/android-auto-updater-client) for Android's client library. 7 | 8 | ## Installation 9 | 10 | Install with [npm](https://github.com/npm/npm) : 11 | ``` 12 | npm install apk-updater 13 | ``` 14 | 15 | ## Public API 16 | 17 | ### enable(app, route, repoDir) 18 | 19 | Enables update server module. 20 | - **app** parent Express application (required) 21 | - **route** route prefix for current updater (required) 22 | - **repoDir** path for apk directory (*optional*) 23 | 24 | ```javascript 25 | var apkUpdater = require('apk-updater'); 26 | 27 | var app = express() 28 | 29 | apkUpdater.enable(app, '/anyUpdateServerRoute'); 30 | ``` 31 | 32 | This will enable both post GET and POST methods for '/anyUpdateServerRoute' in 'app' and will provide APK files found in './.apk_repo' directory. These APK file names must match the following format: *packageName*-*packageVersion*.apk with `packageName` the APK name itself (matched as `\w+` for now), and `packageVersion` the package version number (matched as `\d+` for now). 33 | 34 | In the above example the 'http://yourserver/anyUpdateServerRoute' URL will return the list of all available APK packages as a JSON list. 35 | 36 | ## Configuration 37 | 38 | ### APK Directory 39 | 40 | To change APK directory an extra parameter is needed during initialization. Eg. 41 | ```javascript 42 | enable(app, '/anyUpdateServerRoute', 'myDirectory'); 43 | ``` 44 | 45 | ## Client usage 46 | 47 | See [android-auto-updater-client](https://github.com/NDMAC/android-auto-updater-client) for client implementation. 48 | 49 | ### Provided routes 50 | 51 | HTTP GET method returns a JSON list of all available packages. 52 | 53 | HTTP POST method with 'pkgname' and 'version' parameters returns an auto-generated download URL if an update is available for the given package and version. 54 | 55 | -------------------------------------------------------------------------------- /lib/updater.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var uuid = require('node-uuid'), 4 | winston = require('winston'), 5 | reader = require('./apkReader'); 6 | 7 | var HOUR = 3600000; 8 | 9 | var androidUpdate = {} 10 | , expressApp 11 | , routePfx 12 | , links = []; 13 | 14 | androidUpdate.updater = function (req, res){ 15 | var name = req.body.pkgname, 16 | version = req.body.version, 17 | last = reader.last(name), 18 | key; 19 | if(last && last.version > version){ 20 | key = name + "-" + version; 21 | if(!links[key]){ 22 | links[key] = { 23 | url: routePfx + '/' + uuid.v4(), 24 | timeoutId: setTimeout(function() { 25 | var idx; 26 | for(idx in expressApp.routes.get){ 27 | if(expressApp.routes.get[idx].path === links[key].url){ 28 | expressApp.routes.get.splice(idx, 1); 29 | break; 30 | } 31 | } 32 | links[key] = null; 33 | }, 4 * HOUR) 34 | }; 35 | expressApp.get(links[key].url, function(req, res){ 36 | res.download(last.filepath); 37 | }); 38 | // hack to put this route at first 39 | expressApp.routes.get.unshift(expressApp.routes.get.pop()); 40 | } 41 | winston.info("have update for version " + version + "\n" + links[key].url + "\n" + last.version); 42 | res.send("have update\n" + links[key].url + "\n" + last.version); 43 | } else { 44 | winston.debug("No update for " + name + " - " + version + " / Last : " + last ); 45 | res.send(200); 46 | } 47 | }; 48 | 49 | 50 | /** 51 | * Enable auto apk updater for provided Express application and route. 52 | * @param {@Object} app parent Express application 53 | * @param {@String} route route prefix for current updater 54 | * @param {@String} repoDir path for apk directory 55 | */ 56 | function enable(app, route, repoDir){ 57 | expressApp = app; 58 | routePfx = route; 59 | if(repoDir){ 60 | reader.setRepoDir(repoDir); 61 | } 62 | app.post(route, androidUpdate.updater); 63 | 64 | app.get(route, function (req, res){ 65 | res.send(reader.available()); 66 | }); 67 | }; 68 | 69 | 70 | /** 71 | * Module exports. 72 | */ 73 | module.exports = { 74 | 'enable': enable 75 | }; 76 | -------------------------------------------------------------------------------- /lib/apkReader.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var fs = require('fs') 4 | , _ = require('underscore'); 5 | 6 | /** Contains apk definitions. */ 7 | var apk = {} 8 | , initialized = false 9 | , repoDir = '.apk_repo' 10 | /** APK filenames pattern. */ 11 | , apkPattern = /([\w\.]+)-(\d+)\.apk/; 12 | 13 | 14 | function init(){ 15 | var files; 16 | try { 17 | files = fs.readdirSync(repoDir, 'utf8'); 18 | } 19 | catch (e) { 20 | console.log("Cannot read apk repository directory : " + repoDir); 21 | return; 22 | } 23 | 24 | function addApk(file){ 25 | if(apkPattern.test(file)){ 26 | if(!apk[RegExp.$1]){ 27 | apk[RegExp.$1] = []; 28 | } 29 | apk[RegExp.$1].push({ 30 | 'version' : parseInt(RegExp.$2), 31 | 'filename' : file, 32 | 'filepath' : repoDir + '/' + file 33 | }); 34 | // console.log("New APK : " + RegExp.$1 + "\n" + JSON.stringify(apk[RegExp.$1])); 35 | apk[RegExp.$1] = _.sortBy(apk[RegExp.$1], function(def){ return def.version; }); 36 | } 37 | } 38 | 39 | function removeApk(file){ 40 | if(apkPattern.test(file)){ 41 | if(!apk[RegExp.$1]){ 42 | apk[RegExp.$1] = []; 43 | } 44 | apk[RegExp.$1] = _.reject(apk[RegExp.$1], function(def){ return def.filename === file; }); 45 | } 46 | } 47 | 48 | _.each(files, addApk); 49 | 50 | fs.watch(repoDir, function (event, filename) { 51 | var i, filepath = repoDir + '/' + filename; 52 | if (event === 'rename') { 53 | if (fs.existsSync(filepath)) { 54 | // file created or renamed 55 | for(i in apk){ 56 | apk[i] = _.filter(apk[i], function(def){ 57 | return fs.existsSync(repoDir + '/' + def.filename); 58 | }); 59 | } 60 | addApk(filename); 61 | } else { 62 | // file deleted 63 | removeApk(filename); 64 | } 65 | } 66 | }); 67 | 68 | initialized = true; 69 | } 70 | 71 | /** 72 | * Returns all available apk files. 73 | * @param {@String} name name (prefix) for apk files to look for (optional). 74 | */ 75 | function available(name){ 76 | if(!initialized) { init(); } 77 | if(name) 78 | return apk[name]; 79 | return apk; 80 | }; 81 | 82 | /** 83 | * Returns last (version) apk for provided name. 84 | * @param {@String} name name (prefix) for apk files to look for. 85 | */ 86 | function last(name){ 87 | if(!initialized) { init(); } 88 | return _.last(apk[name]); 89 | }; 90 | 91 | /** 92 | * Change directory where new APK files are located. 93 | * @param {@String} path the directory path. 94 | */ 95 | function setRepoDir(path){ 96 | repoDir = path; 97 | init(); 98 | }; 99 | 100 | /** 101 | * Module exports. 102 | */ 103 | module.exports = { 104 | 'available': available 105 | , 'last': last 106 | , 'setRepoDir': setRepoDir 107 | }; 108 | -------------------------------------------------------------------------------- /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 | 203 | --------------------------------------------------------------------------------