updates to restify example to add tests and Yeoman support

Author: headwinds

examples/nodejs-mongodb-mongoose-restify/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 4
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

examples/nodejs-mongodb-mongoose-restify/.gitattributes

@@ -0,0 +1 @@
+* text=auto

examples/nodejs-mongodb-mongoose-restify/.gitignore

@@ -0,0 +1,2 @@
+temp
+dist

examples/nodejs-mongodb-mongoose-restify/.jshintrc

@@ -0,0 +1,22 @@
+{
+    "node": true,
+    "browser": true,
+    "es5": true,
+    "esnext": true,
+    "bitwise": true,
+    "camelcase": true,
+    "curly": true,
+    "eqeqeq": true,
+    "immed": true,
+    "indent": 4,
+    "latedef": true,
+    "newcap": true,
+    "noarg": true,
+    "quotmark": "single",
+    "regexp": true,
+    "undef": true,
+    "unused": true,
+    "strict": true,
+    "trailing": true,
+    "smarttabs": true
+}

examples/nodejs-mongodb-mongoose-restify/Gruntfile.js

@@ -0,0 +1,189 @@
+module.exports = function( grunt ) {
+  'use strict';
+  //
+  // Grunt configuration:
+  //
+  // https://github.com/cowboy/grunt/blob/master/docs/getting_started.md
+  //
+  grunt.initConfig({
+
+    // Project configuration
+    // ---------------------
+
+    // specify an alternate install location for Bower
+    bower: {
+      dir: 'public/components'
+    },
+
+    // Coffee to JS compilation
+    coffee: {
+      compile: {
+        files: {
+          'temp/scripts/*.js': 'public/scripts/**/*.coffee' 
+        },
+        options: {
+          basePath: 'public/scripts'
+        }
+      }
+    },
+
+    // compile .scss/.sass to .css using Compass
+    compass: {
+      dist: {
+        // http://compass-style.org/help/tutorials/configuration-reference/#configuration-properties
+        options: {
+          css_dir: 'temp/styles',
+          sass_dir: 'public/styles',
+          images_dir: 'public/images',
+          javascripts_dir: 'temp/scripts',
+          force: true
+        }
+      }
+    },
+
+    // generate application cache manifest
+    manifest:{
+      dest: ''
+    },
+
+    // headless testing through PhantomJS
+    mocha: {
+      all: ['test/**/*.html']
+    },
+
+    // default watch configuration
+    watch: {
+      coffee: {
+        files: 'public/scripts/**/*.coffee',
+        tasks: 'coffee reload'
+      },
+      compass: {
+        files: [
+          'public/styles/**/*.{scss,sass}'
+        ],
+        tasks: 'compass reload'
+      },
+      reload: {
+        files: [
+          'public/*.html',
+          'public/styles/**/*.css',
+          'public/scripts/**/*.js',
+          'public/images/**/*'
+        ],
+        tasks: 'reload'
+      }
+    },
+
+    // default lint configuration, change this to match your setup:
+    // https://github.com/cowboy/grunt/blob/master/docs/task_lint.md#lint-built-in-task
+    lint: {
+      files: [
+        'Gruntfile.js',
+        'public/scripts/**/*.js',
+        'spec/**/*.js'
+      ]
+    },
+
+    // specifying JSHint options and globals
+    // https://github.com/cowboy/grunt/blob/master/docs/task_lint.md#specifying-jshint-options-and-globals
+    jshint: {
+      options: {
+        curly: true,
+        eqeqeq: true,
+        immed: true,
+        latedef: true,
+        newcap: true,
+        noarg: true,
+        sub: true,
+        undef: true,
+        boss: true,
+        eqnull: true,
+        browser: true
+      },
+      globals: {
+        jQuery: true
+      }
+    },
+
+    // Build configuration
+    // -------------------
+
+    // the staging directory used during the process
+    staging: 'temp',
+    // final build output
+    output: 'dist',
+
+    mkdirs: {
+      staging: 'public/'
+    },
+
+    // Below, all paths are relative to the staging directory, which is a copy
+    // of the public/ directory. Any .gitignore, .ignore and .buildignore file
+    // that might appear in the public/ tree are used to ignore these values
+    // during the copy process.
+
+    // concat css/**/*.css files, inline @import, output a single minified css
+    css: {
+      'styles/main.css': ['styles/**/*.css']
+    },
+
+    // renames JS/CSS to prepend a hash of their contents for easier
+    // versioning
+    rev: {
+      js: 'scripts/**/*.js',
+      css: 'styles/**/*.css',
+      img: 'images/**'
+    },
+
+    // usemin handler should point to the file containing
+    // the usemin blocks to be parsed
+    'usemin-handler': {
+      html: 'index.html'
+    },
+
+    // update references in HTML/CSS to revved files
+    usemin: {
+      html: ['**/*.html'],
+      css: ['**/*.css']
+    },
+
+    // HTML minification
+    html: {
+      files: ['**/*.html']
+    },
+
+    // Optimizes JPGs and PNGs (with jpegtran & optipng)
+    img: {
+      dist: '<config:rev.img>'
+    },
+
+    // rjs configuration. You don't necessarily need to specify the typical
+    // `path` configuration, the rjs task will parse these values from your
+    // main module, using http://requirejs.org/docs/optimization.html#mainConfigFile
+    //
+    // name / out / mainConfig file should be used. You can let it blank if
+    // you're using usemin-handler to parse rjs config from markup (default
+    // setup)
+    rjs: {
+      // no minification, is done by the min task
+      optimize: 'none',
+      baseUrl: './scripts',
+      wrap: true,
+      name: 'main'
+    },
+
+    // While Yeoman handles concat/min when using
+    // usemin blocks, you can still use them manually
+    concat: {
+      dist: ''
+    },
+
+    min: {
+      dist: ''
+    }
+  });
+
+  // Alias the `test` task to run the `mocha` task instead
+  grunt.registerTask('test', 'server:phantom mocha');
+
+};

examples/nodejs-mongodb-mongoose-restify/README.md

@@ -1 +1,77 @@
-Message me if you need a hand getting this to work
+# Simple example - Node.js, Restify, MongoDb and Mongoose
+
+There are basically two big parts to this demo - two servers. The first server, httpServer, serves up static html/js/css to the 
+browser and the second, mongodbServer, is purely for saving and retrieving data from the mongodb.  
+
+I've put both servers in the server.js which makes it extremely long and challenging to maintain but it does the job for this demo. Also, each server is listening on its own port. If you required only one public port, you could choose one server to listen on that port then pass the events to the other port which may be interested in different routes.  
+
+In addition to server.js, I've refactored it into two separate files: server-http.js and server-mongo.js. 
+
+## HTTP SERVER
+
+Originally, this tutorial started out as purely a mongodb one but I wanted to see the data in a browser and since this is a collection of Backbone tutorials, I might as well include some client-side backbone views. I aslo started working on it before discovering Google's Yeoman which includes its own web server that serves static files thus making the HTTP portion not necessary when testing locally, however, when you move to host these files somewhere else like nodejitsu, you may need to use your own static web server if it doesn't support nginx or apache.    
+
+To view the data in your browser, you will need to host the app locally. In my case, I started up Yeoman using the terminal. 
+
+$ yeoman server
+
+By default, yeoman looks at the "app" directory. If you update to Yeoman 1.0, you are able to configure this path in the grunt.js file and configure it to look any folder like "public" but at the time of writing this demo, I'm using Yeoman 0.9.6 so will keep the "app" directory.
+ 
+It automatically launches a browswer window to: 
+
+http://localhost:3501/ 
+
+I should see the index.html which presents MainView and its MessagesCollection will then go out and talk to:  
+
+http://localhost:8080/messages 
+
+This static server is taken very largely from this example: 
+http://thecodinghumanist.com/blog/archives/2011/5/6/serving-static-files-from-node-js
+
+## MONGODB
+
+In order to setup my mongodb database, I've taken the following steps:
+
+1. I have two terminal windows open.
+
+2. In the the first one, I've started mongoDB: 
+$ mongod
+
+3. In the second, I've started the mongo shell
+$ mongo
+
+In the mongo shell, I've created a database called "nationalpark"
+
+> use nationalpark <-- will automatically create and use this new database 
+
+then, I've added a collection called "messages" and inserted a message
+
+var message = { message: "onward, upward", hiker: "rosella"}; 
+
+> db.messages.insert(message); <--- once you use nationalpark, db becomes the link to it
+
+Just to prove you've added a message, you can display all the messages 
+
+> db.messages.find();
+
+Now, I have a database with a collection of messages containing at least one message.
+
+## DATABASE
+
+ If you opened your browser to http://localhost:8080/messages, you might see this cryptic message:
+{"message":"Invalid sort() argument. Must be a string or object."}
+
+It means there are no messages in your database but we'll get rid of that message by manually inserting a message.
+
+Once you've inserted a mesage, you can open your brower to: http://localhost:8080/messages
+and it should spit out the message   
+
+
+## CONFIG
+
+if you plan to work with a public github, it is a good idea to protect your production mongodb connection uri 
+and put it in a config file which you include in .gitignore so that it doesn't get committed  
+
+var config = require('./config'); // Local congig file to hide creds
+db = mongoose.connect(config.mongoose_auth),
+Schema = mongoose.Schema;