Cleaned up memcached example and added tests.

Author: jmdobry

.travis.yml

@@ -34,6 +34,7 @@ cache:
 
 services:
   - redis-server
+  - memcached
   - docker
 
 env:

README.md

@@ -13,6 +13,7 @@ and applications on [Google App Engine](http://cloud.google.com/nodejs).
 ### Frameworks
 
 - Express.js - [Source code][express_1] | [App Engine Tutorial][express_2] | [Live demo][express_3] | [Documentation][express_4]
+  - Express.js + Memcached Sessions - [Source code][express_5] | [Documentation][express_6]
 - Geddy.js - [Source code][geddy_1] | [App Engine Tutorial][geddy_2] | [Live demo][geddy_3] | [Documentation][geddy_4]
 - Hapi.js - [Source code][hapi_1] | [App Engine Tutorial][hapi_2] | [Live demo][hapi_3] | [Documentation][hapi_4]
 - Loopback.js - [Source code][loopback_1] | [App Engine Tutorial][loopback_2] | [Live demo][loopback_3] | [Documentation][loopback_4]
@@ -68,6 +69,8 @@ See [LICENSE](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/ma
 [express_2]: https://cloud.google.com/nodejs/resources/frameworks/express
 [express_3]: http://express-dot-nodejs-docs-samples.appspot.com
 [express_4]: http://expressjs.com/
+[express_5]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/express-memcached-session
+[express_6]: https://github.com/balor/connect-memcached
 
 [geddy_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/geddy
 [geddy_2]: https://cloud.google.com/nodejs/resources/frameworks/geddy

appengine/express-memcached-session/README.md

@@ -1,10 +1,14 @@
-# Express + Memcached Sessions -> Google App Engine
+## Express.js + Memcached Sessions on Google App Engine
 
-This is a simple guide to using memcached for session state while running [expressjs](http://expressjs.com/) on Google App Engine.  Each Google App Engine application comes with a memcached service instance, which can be reached with a standard memcached driver at `memcache:11211`.
+This is a simple guide to using memcached for session state while running
+[Express.js](http://expressjs.com/) on Google App Engine. Each Google App Engine
+application comes with a memcached service instance, which can be reached with a
+standard memcached driver at `memcache:11211`.
 
 1. [Create a new Express app](http://expressjs.com/starter/generator.html)
 
-2. Create an `app.yaml` in the root of your application with the following contents:
+2. Create an `app.yaml` in the root of your application with the following
+contents:
 
     ```yaml
     runtime: nodejs
@@ -16,33 +20,37 @@ This is a simple guide to using memcached for session state while running [expre
 
     Notice the MEMCACHE_URL environment variable - this is where you can reach your standard memcached cluster across instances. 
 
-3. Use the [connect-memcached](https://github.com/balor/connect-memcached) module.  Run `npm install --save connect-memcached`, and add the following to your server.js or app.js:
+3. Use the [connect-memcached](https://github.com/balor/connect-memcached)
+module.  Run `npm install --save connect-memcached`, and add the following to
+your server.js or app.js:
 
     ```js
     var MemcachedStore = require('connect-memcached')(session);
-    ...
+    // ...
     app.use(session({
-        secret: 'appengineFTW',
-        key: 'test',
-        proxy: 'true',
-        store: new MemcachedStore({
-            hosts: [process.env.MEMCACHE_URL || '127.0.0.1:11211']
-        })
+      secret: 'appengineFTW',
+      key: 'test',
+      proxy: 'true',
+      store: new MemcachedStore({
+        hosts: [process.env.MEMCACHE_URL || '127.0.0.1:11211']
+      })
     }));
     ```
-4. In your express route handlers, you can now safely use `req.session.*` across multiple nodejs instances:
+
+4. In your express route handlers, you can now safely use `req.session.*` across
+multiple nodejs instances:
 
     ```js
     app.get('/', function(req, res){
-        publicIp.v4(function (err, ip) {
-            res.write("<div>" + ip + "</div>");
-            if(req.session.views) {
-                ++req.session.views;
-            } else {
-                req.session.views = 1;
-            }
-            res.end('Viewed <strong>' + req.session.views + '</strong> times.');
-        });
+      publicIp.v4(function (err, ip) {
+        res.write('<div>' + ip + '</div>');
+        if(req.session.views) {
+          ++req.session.views;
+        } else {
+          req.session.views = 1;
+        }
+        res.end('Viewed <strong>' + req.session.views + '</strong> times.');
+      });
     });
     ```
 
@@ -52,13 +60,13 @@ This is a simple guide to using memcached for session state while running [expre
 
     Run memcached on localhost:11211 by running `memcached`
 
-
-6. Deploy your app. For convenience, you can use an npm script to run the command. Modify your `package.json` to include:
+6. Deploy your app. For convenience, you can use an npm script to run the
+command. Modify your `package.json` to include:
 
     ```js
     "scripts": {
       "start": "node server.js",
-      "deploy": "gcloud preview app deploy app.yaml --set-default --project [project id]"
+      "deploy": "gcloud preview app deploy app.yaml"
     }
     ```
 

appengine/express-memcached-session/app.yaml

@@ -12,7 +12,6 @@
 # limitations under the License.
 
 runtime: nodejs
-api_version: 1
 vm: true
 env_variables:
   PORT: 8080

appengine/express-memcached-session/package.json

@@ -1,14 +1,20 @@
 {
-  "name": "express-memcached-session-demo",
-  "version": "1.0.0",
+  "name": "appengine-express-memcached-session",
+  "description": "An example of using memcached for sessions in Express.js on Google App Engine.",
+  "version": "0.0.1",
   "private": true,
+  "license": "Apache Version 2.0",
+  "engines": {
+    "node": "~0.12.7"
+  },
   "scripts": {
-    "deploy": "gcloud preview app deploy app.yaml --set-default --project express-memcached-demo"
+    "start": "node server.js",
+    "deploy": "gcloud preview app deploy app.yaml"
   },
   "dependencies": {
     "connect-memcached": "^0.1.0",
-    "cookie-parser": "~1.3.5",
-    "express": "~4.12.4",
+    "cookie-parser": "^1.3.5",
+    "express": "^4.12.4",
     "express-session": "^1.11.3",
     "public-ip": "^1.1.0"
   }

appengine/express-memcached-session/server.js

@@ -24,29 +24,33 @@ var app = express();
 
 app.use(cookieParser());
 app.use(session({
-    secret: 'appengineFTW',
-    key: 'test',
-    proxy: 'true',
-    store: new MemcachedStore({
-        hosts: [process.env.MEMCACHE_URL || '127.0.0.1:11211']
-    })
+  secret: 'your-secret-here',
+  key: 'test',
+  proxy: 'true',
+  store: new MemcachedStore({
+    hosts: [process.env.MEMCACHE_URL || '127.0.0.1:11211']
+  })
 }));
 
 app.get('/', function(req, res){
-    publicIp.v4(function (err, ip) {
-
-        // This shows the IP for each 
-        res.write('<div>' + ip + '</div>');
-   
-        if(req.session.views) {
-            ++req.session.views;
-        } else {
-            req.session.views = 1;
-        }
-        res.end('Viewed <strong>' + req.session.views + '</strong> times.');
-    });
+  publicIp.v4(function (err, ip) {
+
+    // This shows the IP for each 
+    res.write('<div>' + ip + '</div>');
+
+    if(req.session.views) {
+      ++req.session.views;
+    } else {
+      req.session.views = 1;
+    }
+    res.end('Viewed <strong>' + req.session.views + '</strong> times.');
+  });
 });
 
-http.createServer(app).listen(process.env.PORT || 8080, function() {
+if (module === require.main) {
+  http.createServer(app).listen(process.env.PORT || 8080, function() {
     console.log('Listening on %d', this.address().port);
-});
+  });  
+}
+
+module.exports = app;

test/appengine/all.test.js

@@ -34,6 +34,13 @@ var sampleTests = [
     msg: 'Hello World! Express.js on Google App Engine.',
     TRAVIS_NODE_VERSION: '0.10'
   },
+  {
+    dir: 'express-memcached-session',
+    cmd: 'node',
+    args: ['server.js'],
+    msg: 'Viewed',
+    TRAVIS_NODE_VERSION: '0.10'
+  },
   {
     dir: 'geddy',
     deploy: true,
@@ -82,12 +89,12 @@ var sampleTests = [
     args: ['app.js'],
     msg: 'Express.js + Mailgun on Google App Engine.'
   },
-  // {
-  //   dir: 'redis',
-  //   cmd: 'node',
-  //   args: ['server.js'],
-  //   msg: '127.0.0.1'
-  // },
+  {
+    dir: 'redis',
+    cmd: 'node',
+    args: ['server.js'],
+    msg: '127.0.0.1'
+  },
   {
     dir: 'restify',
     deploy: true,
@@ -112,7 +119,7 @@ if (process.env.TRAVIS_NODE_VERSION === '0.10') {
   });
 }
 
-//if (process.env.TRAVIS_NODE_VERSION === 'stable') {
+if (process.env.TRAVIS_NODE_VERSION === 'stable') {
   // For some reason the "npm install" step for the Sails sample doesn't work on
   // Travis when using Node.js stable. It works locally, however.
   sampleTests.push({
@@ -123,7 +130,7 @@ if (process.env.TRAVIS_NODE_VERSION === '0.10') {
     msg: 'Hello World! Koa.js on Google App Engine.',
     TRAVIS_NODE_VERSION: 'stable'
   });
-//}
+}
 
 // Send a request to the given url and test that the response body has the
 // expected value

test/appengine/express-memcached-session.test.js

@@ -0,0 +1,33 @@
+// Copyright 2015, Google, Inc.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+var assert = require('assert');
+var request = require('supertest');
+var app = require('../../appengine/express-memcached-session/server.js');
+
+describe('express-memcached-session', function () {
+  it('should return 200 and the correct response', function (done) {
+    request(app)
+      .get('/')
+      .expect(200)
+      .expect(function (res) {
+        assert(res.text.match(/<div>(\d|\d\d|\d\d\d)\.(\d|\d\d|\d\d\d)\.(\d|\d\d|\d\d\d)\.(\d|\d\d|\d\d\d)<\/div>Viewed <strong>\d<\/strong> times./), // jshint ignore:line
+          'Response should match expected response.\n' + 
+          'Found: ' + res.text
+        );
+      })
+      .end(done);
+  });
+});