mars-phobos v0.2.2

Phobos

A mock server for mars

Example

var phobos = require("phobos");
var connect = require("connect");
var http = require("http");

// read options from $PWD/.phobosrc by default
var options = {
  locale : 'zh_CN',
  dir : "./phobos", // dir of mock define files
  vars : {"somekey": "somevalue"} // variables for mock define file
  rewrite : [ // rewrite rules
    {
      test : "/wildcard/*",
      target : "/target/$1"
    }, {
      test : /^\/regexp\/(\?.*)?$/,
      target : "/target$1",
      method : "get"
    },{
      test : "/wildcard/*",
      target : "http://revert.proxy.com/$1"
    },
  ]
};

app = connect();

// use as a connect middleware
app.use('/mock', phobos(options));

// start server
http.createServer(app).listen(8080);

About .phobosrc

This is a js file NOT A JSON. Never forget to add module.exports on it's head.

module.exports = {
   rewrite : [ // use comments
    {
      test : "/wildcard/*",
      target : "/target/$1"
    }, {
      test : /^\/regexp\/(\?.*)?$/, // regexp directly
      target : "/target$1",
      method : "get"
    }
  ]
}

About define files

Structure of directory

$PWD/.phobos
├── item.json        => /mock/item
└── user
    ├── get.json     => /mock/user (with method GET)
    ├── list.json    => /mock/user/list
    └── put.json     => /mock/user (with method POST)

Usable methods: GET, POST, DELETE, PUT

Define file

define file is a JSON file. you can use #{name [arg1[, arg2...]]} to access predefined variables (base on mars-deimos).

{
  "name" : "#{person.name}",
  "age" : "#{person.age}",
  "city" : "#{address.city}",
  "zipcode": "#{address.zipcode}",
  "intro": "#{lorem.sentence 1}",
  "somekey": "#{somekey}",
  "friends_number": "#{number}",
  "lastLocation": {
    "lati" : "#{number.float -180, 180, '0[.]0000'}",
    "long" : "#{number.float -180, 180, '0[.]0000'}"
  }
}

Predefined variables list

here.