@ohos-ports/emulator 0.1.0-beta.0

package/README.md

@@ -0,0 +1,80 @@
+# Emulator
+
+A simple server for emulating an API.
+
+Install through npm:
+
+    npm install -g emulator
+
+## Usage
+
+### API response simulation
+
+Emulator is a simple server that allows for rapid prototyping of client-side applications.
+
+Make any request:
+
+    http://localhost:3000/profile?user=me
+
+    $.ajax('http://localhost:3000/profile', {
+      data: {user: 'me'}
+    });
+
+And get the same response data:
+
+    {user: 'me'}
+
+Or specify a different response:
+
+    http://localhost:3000/profile?user=me&response[user]=you
+
+    $.ajax('http://localhost:3000/profile', {
+      data: {
+        user: 'me',
+        response: {
+          user: 'you'
+        }
+      }
+    });
+
+And get the response you specified:
+
+    {user: 'you'}
+
+### Other routes
+
+Emulator also includes other helper routes that may be useful in your application.
+
+#### Redirects
+
+Redirect to a different url:
+
+    http://localhost:3000/redirect/me
+
+    http://localhost:3000/redirect?redirect=me
+
+These routes both redirect to `http://localhost:3000/me`
+
+#### Simulate high latentcy or long response times
+
+Force the server to simulate long response times:
+
+    http://localhost:3000/wait/4000?user=me
+
+This request would wait 4 seconds and then respond with:
+
+    {user: me}
+
+#### Test error codes
+
+Test how your application would respond to error codes:
+
+    http://localhost:3000/500
+
+    http://localhost:3000/404
+
+Responds with a 500 (Internal Server Error) code and a 404 (Not Found) code, respectively
+
+## License
+
+MIT

package/bin/emulator

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+/**
+ * Module dependencies.
+ */
+var path    = require('path'),
+    fs      = require('fs'),
+    program = require('commander');
+
+program
+  .version(require('../package.json').version)
+  .usage('[options]')
+  .option('-p, --port', 'specify a port')
+  .option('-C, --cors', 'disable cross-origin resource sharing')
+  .option('-R, --redirect', 'disable redirect route')
+  .option('-W, --wait', 'disable wait route')
+  .option('-S, --status', 'disable http status code route')
+  .parse(process.argv);
+
+var lib = path.join(path.dirname(fs.realpathSync(__filename)), '../lib');
+require(lib + '/emulator')(program);

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/emulator')();

package/lib/emulator.js

@@ -0,0 +1,35 @@
+var http   = require('http'),
+    router = require('router')()
+    routes = require('./routes');
+
+module.exports = function(config) {
+  config || (config = {});
+  var port = config.port || 3000;
+
+  router.get('/favicon.icon', function(req, res) {
+    res.writeHead(200, {'Content-Type': 'image/x-icon'} );
+    res.end();
+  });
+
+  if (!config.cors)     router.all('*', routes.crossdomain);
+  if (!config.redirect) router.all(/^\/redirect\/*(\S+)*/, routes.redirect);
+  if (!config.wait)     router.all('/wait/:time', routes.wait);
+  if (!config.status)   router.all(/(10[012]|20[0-8]|226|30[0-8]|4[01][\d]|42[02-689]|431|44[49]|45[01]|49[4-79]|50[\d]|51[01]|522|59[89])/, routes.statusCode);
+
+  router.all('*', routes.response);
+
+  http.createServer(function(req, res) {
+    router(req, res, function(err) {
+      if (err) {
+        res.statusCode = 500;
+        res.end(err.message);
+      } else {
+        res.statusCode = 404;
+        res.end();
+      }
+    });
+  }).listen(port, function() {
+    console.log('Emulator running on port '+ port);
+  });
+}
+

package/lib/routes.js

@@ -0,0 +1,73 @@
+var url = require('url'),
+    qs = require('qs');
+
+var routes = {}
+
+routes.crossdomain = function(req, res, next) {
+  res.setHeader('Access-Control-Allow-Origin', '*');
+  res.setHeader('Access-Control-Allow-Methods', 'GET,PUT,POST,DELETE,OPTIONS');
+  res.setHeader('Access-Control-Allow-Headers', 'Content-Type');
+  if (req.method == 'OPTIONS') return res.end();
+  next();
+}
+
+routes.statusCode = function(req, res){
+  var code = req.params[0];
+  res.writeHead(code);
+  res.end();
+};
+
+routes.redirect = function(req, res) {
+  var route = req.params[0];
+
+  var fn = function(data) {
+    var redirect = data.redirect || '/';
+    if (!redirect.match(/https?:\/\//)) {
+      redirect = (redirect[0] == '/') ? redirect : '/' + redirect;
+      redirect = 'http://' + req.headers.host + redirect;
+    }
+    res.writeHead(302, {
+      'Location' : redirect
+    });
+    res.end();
+  }
+  if (route) {
+    fn({redirect: route})
+  } else {
+    parseData(req, fn)
+  }
+}
+
+routes.wait = function(req, res) {
+  var wait = req.params.time;
+  setTimeout(function() {
+    routes.response(req, res);
+  }, wait);
+}
+
+routes.response = function(req, res) {
+  parseData(req, function(data) {
+    res.writeHead(200, {'Content-Type': 'application/json; charset=utf-8'});
+    var responseBody = data.response || data;
+    res.write(JSON.stringify(responseBody));
+    res.end();
+  });
+}
+
+function parseData(req, fn) {
+  var queryData = ''
+  if (req.method == 'GET') {
+    queryData = qs.parse(url.parse(req.url).query);
+    fn(queryData);
+  } else {
+    req.on('data', function(data) {
+      queryData += data;
+    })
+    req.on('end', function() {
+      queryData = qs.parse(queryData);
+      fn(queryData);
+    })
+  }
+}
+
+module.exports = routes;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@ohos-ports/emulator",
+  "version": "0.1.0-beta.0",
+  "description": "A simple server for emulating an API",
+  "author": "Josh Vermaire <joshvermaire@gmail.com>",
+  "preferGlobal": true,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joshvermaire/emulator"
+  },
+  "main": "index.js",
+  "bin": {
+    "emulator": "./bin/emulator"
+  },
+  "files": [
+    "index.js",
+    "bin/",
+    "lib/",
+    "README.md"
+  ],
+  "keywords": [
+    "prototyping",
+    "api",
+    "response",
+    "error"
+  ],
+  "dependencies": {
+    "router": "^1.0.0",
+    "qs": "^6.0.0",
+    "commander": "^2.0.0"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/joshvermaire/emulator/issues"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">= 0.6.x"
+  }
+}