├── .gitignore ├── LICENSE ├── README.md ├── index.js ├── lib ├── instant-api.js └── uploader.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | # Logs 3 | logs 4 | *.log 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 18 | .grunt 19 | 20 | # Compiled binary addons (http://nodejs.org/api/addons.html) 21 | build/Release 22 | 23 | # Dependency directory 24 | # Commenting this out is preferred by some people, see 25 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- 26 | node_modules 27 | 28 | # Users Environment Variables 29 | .lock-wscript 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | 167 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Lambdaws Instant API 2 | 3 | Create scalable and distributed public API endpoints from any Javascript function. Backed by AWS Lambda and Lambdaws. 4 | 5 | ## Usage 6 | ### Installation 7 | 8 | ```npm install lambdaws-instant-api``` or clone this repo. 9 | 10 | ### Create an Instant Function 11 | ```js 12 | var lamdawsInstantApi = require('lambdaws-instant-api'); 13 | 14 | var minus = function(a, b, callback) { 15 | callback(a - b); 16 | } 17 | 18 | lamdawsInstantApi.config({ email: 'your@email.com' }); // So we can reach you when we are in beta 19 | 20 | // Use Lambdaws syntax (https://github.com/mentum/lambdaws) 21 | lamdawsInstantApi.createApi(minus, ['q']) 22 | .then(function(instantEndpoints){ 23 | console.log(instantEndpoints); 24 | // this outputs 25 | //{ invokeUrl: "Url used to ivoke your clouded function", 26 | // revokeUrl : "Url used to revoke your clouded function } 27 | }); 28 | ``` 29 | 30 | ### Invoking it 31 | 32 | Get or post with the ```invokeUrl``` provided by createApi. 33 | If using ```GET```, append to the URL the parameters. 34 | If using ```POST```, put the parameters in the body. 35 | The parameter names don't matter, only the order is important. 36 | 37 | ``` 38 | curl "http://lambdaws-instant-api.herokuapp.com/invoke/your-invoke-id?a=3&b=2" 39 | ``` 40 | 41 | returns 42 | ```js 43 | { 44 | success: true, 45 | result: 1 // 3 - 2 46 | } 47 | ``` 48 | ### Revoking it 49 | 50 | Disables your function. Won't delete your function from AWS Lambda 51 | 52 | ``` 53 | curl "http://lambdaws-instant-api.herokuapp.com/revoke/your-revoke-id?a=3&b=2" -d {} 54 | ``` 55 | 56 | returns 57 | ``` 58 | 200 OK 59 | ``` 60 | 61 | ### Complete API documentation 62 | You can view the full API documentation [here](http://lambdaws-instant-api.herokuapp.com/). 63 | 64 | ## Limitations 65 | 66 | You will understand that since this is an alpha product and it is free to use, your usage of the library is therefore limited. These restrictions are currently in place: 67 | - Instant Functions expire after 50 calls or 30 minutes (the first to be triggered) 68 | - Possible rate limits if doing too many requests in a given amount of time. In which case we will politely ask you to slow down and kick you for a few minutes. 69 | - There is a 2000ms delay before the function is launched 70 | 71 | These limitations will all go away once we go in private beta. 72 | 73 | ### Alpha 74 | lambdaws-instant-api is at a very very early stage. This is by no mean a stable product and should not be used in a production environment. 75 | 76 | ### Private Beta 77 | Please subscribe to the private beta by calling the feedback route. We will send out limited amount of invites once we go in beta. 78 | 79 | ### Feedback 80 | Please give the library a try and give us your feedback. You can do so by invoking the ```/feedback``` route. More information is available [here](http://lambdaws-instant-api.herokuapp.com/). 81 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require('./lib/instant-api'); 2 | -------------------------------------------------------------------------------- /lib/instant-api.js: -------------------------------------------------------------------------------- 1 | var lambdaws = require('lambdaws'), 2 | uploader = require('./uploader'); 3 | 4 | function _extendLambdaws(extendedLambdaws){ 5 | extendedLambdaws.container.lambdaHelper.uploader = uploader; 6 | extendedLambdaws.container.lambdaHelper.createProxy = function(_,__, promise) { return promise }; 7 | } 8 | 9 | module.exports = { 10 | config: function (configs){ 11 | if(typeof configs.email !== 'string'){ 12 | throw Error('you need to specify your email'); 13 | } 14 | lambdaws.config(configs); 15 | }, 16 | 17 | createApi: function(){ 18 | lambdaws.extend(_extendLambdaws); 19 | return lambdaws.create.apply(this, arguments); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /lib/uploader.js: -------------------------------------------------------------------------------- 1 | var request = require('request'), 2 | Q = require('q'), 3 | fs = require('fs'), 4 | uuid = require('node-uuid'); 5 | 6 | var UPLOAD_URL = 'http://lambdaws-instant-api.herokuapp.com/create' 7 | 8 | module.exports = function (zipContent, config) { 9 | var deferred = Q.defer(); 10 | 11 | function requestCallback(err, res, data){ 12 | if(err){ 13 | deferred.reject(err); 14 | } else{ 15 | deferred.resolve(data); 16 | } 17 | } 18 | 19 | var fileName = uuid.v4() + '.zip'; 20 | fs.writeFileSync('./' + fileName, zipContent); 21 | 22 | var formData = { 23 | zippedFunction: [ 24 | fs.createReadStream('./' + fileName) 25 | ], 26 | config: JSON.stringify(config), 27 | email: JSON.stringify(global.settings.email) 28 | }; 29 | 30 | var postReq = request.post({url: UPLOAD_URL, formData: formData}, function() { 31 | fs.unlink('./' + fileName); 32 | requestCallback.apply(this, arguments); 33 | }); 34 | 35 | // todo : change timeout for a setting 36 | return deferred.promise.timeout(5000, "Upload function timed out"); 37 | } 38 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lambdaws-instant-api", 3 | "version": "0.0.1", 4 | "description": "Create scalable and distributed api endpoints with any javascript function", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/mentum/lambdaws-instant-api.git" 12 | }, 13 | "keywords": [ 14 | "aws", 15 | "lambda", 16 | "lambdaws", 17 | "api", 18 | "nodejs" 19 | ], 20 | "author": "", 21 | "license": "LGPLV3", 22 | "bugs": { 23 | "url": "https://github.com/mentum/lambdaws-instant-api/issues" 24 | }, 25 | "homepage": "https://github.com/mentum/lambdaws-instant-api", 26 | "dependencies": { 27 | "lambdaws": "1.0.x", 28 | "node-uuid": "^1.4.2", 29 | "q": "^1.1.2", 30 | "request": "^2.51.0" 31 | } 32 | } 33 | --------------------------------------------------------------------------------