Merge pull request #10 from iliasbhal/master

update readme, better test

Author: iliasbhal

README.md

@@ -13,7 +13,7 @@ Works with provider :
   - [x] **Google Cloud Platform - Cloud functions**
   - [ ] Microsoft Azure - Cloud functions | *in development*
 
-## Installation
+## Download
 Type this command inside your terminal
 ```
 npm install --save serverless-express
@@ -24,7 +24,7 @@ or for yarn users
 yarn add serverless-express
 ```
 
-## Usage
+## Installation
 
 ### 1 - Add it to your serverless.yml
 
@@ -96,3 +96,41 @@ exports.handler = handler(app)
 
 Now that everything is done, you can get back to work and enjoy serverless and express in the same time ;)
 
+## Usage
+Make sure that you register an HTTP event for each endpoint of your express app.
+For example, if you register an endpoint like this one: 
+```js
+  app.get( '/users' , showUsers )
+```
+
+You will need to make sure that your cloud provider routes the HTTP call to your app. In order to do so, you will need to update your serverless.yml like so :
+```yml
+# like this 
+functions:
+  app: 
+    handler: handler.handler  #assuming your handler file is handler.js
+    events: 
+      - http:
+          path: GET
+          method: /users
+
+# or like this
+# be careful, this will route every HTTP event to your function.
+functions:
+  app:
+    handler: handler.handler 
+    events: 
+      - http:
+          path: /{proxy+}
+          method: ANY
+```
+
+
+
+
+
+
+### Todo 
+
+- [ ] create "serverless express yaml" command that updates the serverless.yml file with all the endpoints of the express app
+

express.js

@@ -1,16 +1,12 @@
 const express = require('express')
-
+const allowAccessControlOriginMiddleware = require('./src/access_control_middleare')
 
 let slsExpress = () => implement(express())
 Object.setPrototypeOf(slsExpress, express)
 module.exports = slsExpress 
 
 function implement(app){
-    app.use((req, res, next)=>{
-        res.append('Access-Control-Allow-Origin', '*');
-        next()
-    })    
-
+    app.use(allowAccessControlOriginMiddleware)  //  res.append('Access-Control-Allow-Origin', '*');
     switch( process.env.SERVERLESS_EXPRESS_PLATFORM ){
         case 'aws': return aws_express(app);
         case 'google': return google_express(app);
@@ -22,7 +18,7 @@ function implement(app){
 
 function aws_express(app){
     const aws_middleware = require('./src/aws/aws_middleware')
-    app.use(aws_middleware)
+    app.use(aws_middleware)  
     return app
 }
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-express",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "Run express apps on AWS λ easily.",
   "main": "index.js",
   "scripts": {

package.json

@@ -0,0 +1,4 @@
+module.exports = (req, res, next)=>{
+    res.append('Access-Control-Allow-Origin', '*');
+    next()
+}

src/access_control_middleare.js

@@ -75,34 +75,46 @@ describe("serverless-express express", function() {
 
   })
 
-  it('should Access-Control-Allow-Origin to everyone by defualt', function(done){
+  it('should Access-Control-Allow-Origin to everyone by default', function(done){
 
     let testIsCompleted = false
-    let testRunned = 0
+    let testsRunned = 0
+    let testsToRun = tdd.supported_providers.length 
+
     tdd.supported_providers.forEach((provider)=>{
 
-      initPlugin({provider: provider})
+      initPlugin({provider: 'google'})
       let app = sls_express()
           app.get('*', (req, res)=>{
             res.json(res)
            }) // if we don't register a route the middleware stack is not exposed
 
-           request(app).get('/')
-                       .then((res)=>{
-                          testRunned += 1
-                          console.log(res)
-                          expect(res.headers['access-control-allow-origin']).to.equal('*')
-
-                          if( testRunned == tdd.supported_providers.length - 1){
-                            done()
-                          }
-
-                       })
-
-
-      // let injected = app._router.stack.filter( layer => layer && layer.handle == aws_middle ).length == 1
-      // expect(injected).to.equal( provider == 'aws')
-
+          //  console.log(mock.apiGatewayEvent())
+          // // done()
+          if( provider == 'aws'){
+
+              request(app).get('/', mock.apiGatewayEvent() )
+              .then( (res)=>{
+                let response = res.res
+                let responseHeader = response.headers
+                expect(responseHeader['access-control-allow-origin']).to.equal('*')
+                testsRunned = testsRunned + 1
+                if( testsRunned == testsToRun){ done()  }
+              })
+
+          } else {
+              
+              request(app).get('/')
+              .then((res)=>{
+                let response = res.res
+                let responseHeader = response.headers
+                 expect(res.headers['access-control-allow-origin']).to.equal('*')
+                 testsRunned = testsRunned + 1
+                 if( testsRunned == testsToRun ){ done()  }
+              })
+
+          }
+         
     })
 
   })

test/express.test.js

@@ -32,7 +32,6 @@ exports.generate = ()=>{
 
 exports.apiGatewayEvent = (config)=>{
     let createEvent = require('aws-event-mocks');
-
     config = config || {}
 
     let path = config.path || '/'