Initialize app from template

Author: tomcat6

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+*~
+cov-*
+coverage
+plato
+.idea

.jshintrc

@@ -0,0 +1,27 @@
+{
+    "asi"           : true,
+    "camelcase"     : false,
+    "bitwise"       : false,  
+    "unused"        : true,
+    "laxbreak"      : true,
+    "laxcomma"      : true,
+    "curly"         : false,   
+    "eqeqeq"        : true,
+    "evil"          : true,    
+    "forin"         : false,     
+    "immed"         : true, 
+    "latedef"       : true,  
+    "newcap"        : true,   
+    "noarg"         : true,    
+    "noempty"       : true,
+    "nonew"         : true,
+    "plusplus"      : false, 
+    "regexp"        : true,  
+    "undef"         : true,   
+    "strict"        : false,    
+    "sub"           : true,
+    "trailing"      : true,     
+    "node"          : true,    
+    "maxerr"        : 100, 
+    "indent"        : 2    
+}

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - "0.10"
+sudo: false
+before_install:
+  - npm install -g [email protected]
+  - npm install -g grunt-cli
+install: npm install

Grunt-ReadMe.md

@@ -0,0 +1,52 @@
+# Grunt
+
+This template uses [Grunt](http://gruntjs.com/), the Javascript Task Runner. To use Grunt with this Template App, do the following:
+
+* Install grunt: ```npm install -g grunt-cli```
+* In your App directory, run: ```npm install```. This installs Grunt plugins, etc for use with this App.
+
+# Tasks
+
+The following are a short overview of the Grunt tasks available for this App. You can get a full list of tasks from Grunt with ```grunt --help```.
+
+## grunt serve
+
+Run ```grunt serve``` to serve this App locally. By default this App will run on http://localhost:8001.
+
+Note that 'grunt serve' supports live reload, i.e. it will monitor for any changes in your node.js application and automatically restart the server
+
+## grunt debug
+
+Run ```grunt debug``` to debug this App locally. This task uses [Node Inspector](https://github.com/node-inspector/node-inspector) to debug your application, and will open the Debugger at 'application.js' in Google Chrome. See the documentation for [Node Inspector](https://github.com/node-inspector/node-inspector) for more information on how to use Node Inspector.
+
+## grunt test
+
+Run ```grunt test``` to run the unit tests for this App.
+
+## grunt coverage
+
+This App uses [Istanbul](https://github.com/gotwarlost/istanbul) for generating code coverage for your tests.
+
+Run ```grunt coverage``` to run code coverage for this App.
+
+## grunt analysis
+
+Run ```grunt analysis``` to get a static analysis report of your code. This task uses [Plato](https://github.com/es-analysis/plato) to generate the report. See the documentaion for [Plato](https://github.com/es-analysis/plato) for more information on how to use and configure Plato.
+
+## Environment variables
+
+The [grunt env](https://www.npmjs.org/package/grunt-env) plugin is included by default. To set your own environment variables, modify the `env` config accordingly, e.g.
+
+```
+ env : {
+      options : {},
+      // Sample environment variable - see https://github.com/jsoverson/grunt-env for more information
+      local : {
+        SAMPLE_ENV_VAR : 'sample-env-var'
+      }
+    },
+```
+
+Alternatively you can load environment variables from a local file, see the `grunt env` [documentation](https://www.npmjs.org/package/grunt-env#using-external-files) for more details.
+
+

Gruntfile.js

@@ -0,0 +1,164 @@
+'use strict';
+
+module.exports = function(grunt) {
+  require('time-grunt')(grunt);
+  // Project Configuration
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    watch: {
+      js: {
+        files: ['gruntfile.js', 'application.js', 'lib/**/*.js', 'test/**/*.js'],
+        options: {
+          livereload: true
+        }
+      },
+      html: {
+        files: ['public/views/**', 'app/views/**'],
+        options: {
+          livereload: true
+        }
+      }
+    },
+    nodemon: {
+      dev: {
+        script: 'application.js',
+        options: {
+          args: [],
+          ignore: ['public/**'],
+          ext: 'js,html',
+          nodeArgs: [],
+          delayTime: 1,
+          env: {
+            PORT: 3000
+          },
+          cwd: __dirname
+        }
+      }
+    },
+    concurrent: {
+      serve: ['nodemon', 'watch'],
+      debug: ['node-inspector', 'shell:debug', 'open:debug'],
+      options: {
+        logConcurrentOutput: true
+      }
+    },
+    env: {
+      options: {},
+      // environment variables - see https://github.com/jsoverson/grunt-env for more information
+      local: {
+        FH_USE_LOCAL_DB: true,
+        FH_SERVICE_MAP: function() {
+          /*
+           * Define the mappings for your services here - for local development.
+           * You must provide a mapping for each service you wish to access
+           * This can be a mapping to a locally running instance of the service (for local development)
+           * or a remote instance.
+           */
+          var serviceMap = {
+            'SERVICE_GUID_1': 'http://127.0.0.1:8010',
+            'SERVICE_GUID_2': 'https://host-and-path-to-service'
+          };
+          return JSON.stringify(serviceMap);
+        }
+      }
+    },
+    'node-inspector': {
+      dev: {}
+    },
+    shell: {
+      debug: {
+        options: {
+          stdout: true
+        },
+        command: 'env NODE_PATH=. node --debug-brk application.js'
+      },
+      unit: {
+        options: {
+          stdout: true,
+          stderr: true
+        },
+        command: 'env NODE_PATH=. ./node_modules/.bin/mocha -A -u exports --recursive test/unit/'
+      },
+      accept: {
+        options: {
+          stdout: true,
+          stderr: true
+        },
+        command: 'env NODE_PATH=. ./node_modules/.bin/mocha -A -u exports --recursive test/server.js test/accept/'
+      },
+      coverage_unit: {
+        options: {
+          stdout: true,
+          stderr: true
+        },
+        command: [
+          'rm -rf coverage cov-unit',
+          'env NODE_PATH=. ./node_modules/.bin/istanbul cover --dir cov-unit ./node_modules/.bin/turbo -- test/unit',
+          './node_modules/.bin/istanbul report',
+          'echo "See html coverage at: `pwd`/coverage/lcov-report/index.html"'
+        ].join('&&')
+      },
+      coverage_accept: {
+        options: {
+          stdout: true,
+          stderr: true
+        },
+        command: [
+          'rm -rf coverage cov-accept',
+          'env NODE_PATH=. ./node_modules/.bin/istanbul cover --dir cov-accept ./node_modules/.bin/turbo -- --setUp=test/accept/server.js --tearDown=test/accept/server.js test/accept',
+          './node_modules/.bin/istanbul report',
+          'echo "See html coverage at: `pwd`/coverage/lcov-report/index.html"'
+        ].join('&&')
+      }
+    },
+    open: {
+      debug: {
+        path: 'http://127.0.0.1:8080/debug?port=5858',
+        app: 'Google Chrome'
+      },
+      platoReport: {
+        path: './plato/index.html',
+        app: 'Google Chrome'
+      }
+    },
+    plato: {
+      src: {
+        options: {
+          jshint: grunt.file.readJSON('.jshintrc')
+        },
+        files: {
+          'plato': ['lib/**/*.js']
+        }
+      }
+    },
+    jshint: {
+      files: ['*.js', 'lib/**/*.js', 'test/**/*.js'],
+      options: {
+        jshintrc: true
+      }
+    },
+  });
+
+  // Load NPM tasks
+  require('load-grunt-tasks')(grunt, {
+    scope: 'devDependencies'
+  });
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+
+  // Testing tasks
+  grunt.registerTask('test', ['jshint', 'shell:unit', 'shell:accept']);
+  grunt.registerTask('unit', ['jshint', 'shell:unit']);
+  grunt.registerTask('accept', ['env:local', 'shell:accept']);
+
+  // Coverate tasks
+  grunt.registerTask('coverage', ['shell:coverage_unit', 'shell:coverage_accept']);
+  grunt.registerTask('coverage-unit', ['shell:coverage_unit']);
+  grunt.registerTask('coverage-accept', ['env:local', 'shell:coverage_accept']);
+
+
+  grunt.registerTask('analysis', ['plato:src', 'open:platoReport']);
+
+  grunt.registerTask('serve', ['env:local', 'concurrent:serve']);
+  grunt.registerTask('debug', ['env:local', 'concurrent:debug']);
+  grunt.registerTask('default', ['serve']);
+};

LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014 FeedHenry Ltd, All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+This software may download additional open source software components upon install
+that are distributed under separate terms and conditions.  Please see the license
+information provided in the individual software components for more information.

README.md

@@ -0,0 +1,25 @@
+# FeedHenry Hello World MBaaS Server
+
+This is a blank 'hello world' FeedHenry MBaaS. Use it as a starting point for building your APIs. 
+
+# Group Hello World API
+
+# hello [/hello]
+
+'Hello world' endpoint.
+
+## hello [POST] 
+
+'Hello world' endpoint.
+
++ Request (application/json)
+    + Body
+            {
+              "hello": "world"
+            }
+
++ Response 200 (application/json)
+    + Body
+            {
+              "msg": "Hello world"
+            }

application.js

@@ -0,0 +1,34 @@
+var mbaasApi = require('fh-mbaas-api');
+var express = require('express');
+var mbaasExpress = mbaasApi.mbaasExpress();
+var cors = require('cors');
+
+// list the endpoints which you want to make securable here
+var securableEndpoints;
+securableEndpoints = ['/hello'];
+
+var app = express();
+
+// Enable CORS for all requests
+app.use(cors());
+
+// Note: the order which we add middleware to Express here is important!
+app.use('/sys', mbaasExpress.sys(securableEndpoints));
+app.use('/mbaas', mbaasExpress.mbaas);
+
+// allow serving of static files from the public directory
+app.use(express.static(__dirname + '/public'));
+
+// Note: important that this is added just before your own Routes
+app.use(mbaasExpress.fhmiddleware());
+
+app.use('/hello', require('./lib/hello.js')());
+
+// Important that this is last!
+app.use(mbaasExpress.errorHandler());
+
+var port = process.env.FH_PORT || process.env.OPENSHIFT_NODEJS_PORT || 8001;
+var host = process.env.OPENSHIFT_NODEJS_IP || '0.0.0.0';
+app.listen(port, host, function() {
+  console.log("App started at: " + new Date() + " on port: " + port); 
+});

lib/hello.js

@@ -0,0 +1,34 @@
+var express = require('express');
+var bodyParser = require('body-parser');
+var cors = require('cors');
+
+function helloRoute() {
+  var hello = new express.Router();
+  hello.use(cors());
+  hello.use(bodyParser());
+
+
+  // GET REST endpoint - query params may or may not be populated
+  hello.get('/', function(req, res) {
+    console.log(new Date(), 'In hello route GET / req.query=', req.query);
+    var world = req.query && req.query.hello ? req.query.hello : 'World';
+
+    // see http://expressjs.com/4x/api.html#res.json
+    res.json({msg: 'Hello ' + world});
+  });
+
+  // POST REST endpoint - note we use 'body-parser' middleware above to parse the request body in this route.
+  // This can also be added in application.js
+  // See: https://github.com/senchalabs/connect#middleware for a list of Express 4 middleware
+  hello.post('/', function(req, res) {
+    console.log(new Date(), 'In hello route POST / req.body=', req.body);
+    var world = req.body && req.body.hello ? req.body.hello : 'World';
+
+    // see http://expressjs.com/4x/api.html#res.json
+    res.json({msg: 'Hello ' + world});
+  });
+
+  return hello;
+}
+
+module.exports = helloRoute;