wshost

A generic host for exposing objects as web services.

npm install wshost
14 downloads in the last week
27 downloads in the last month

wshost Build Status

wshost is a generic host for exposing modules as web services in Node.js.

Usage

var wshost = require('wshost');

var configService = {
  _meta: {
    name: 'Configuration Service',
    description: 'A simple configuration service implementation.'
  },

  _repository: { 
    'TEST_KEY': 'TEST_VALUE'
  },

  config: {    
    params: {
      key: { required: true }
    },
    actions: {      
      get: {
        description: 'Returns the value of the specified key.',
        handler: function(params, callback) {
          callback({ value: configService._repository[params.key] });
        }
      },

      post: {
        description: 'Sets the value of the specified key',
        params: {
          value: { required: true }
        },
        handler: function(params, callback) {
          configService._repository[params.key] = params.value;

          callback({ ok: true });
        }
      }
    }
  } 
};

new wshost(configService).listen(3000);

StatsD Middleware

  • The host and port for your StatsD server will be pulled from the following environment variables:
    • STATSD_HOST (default = localhost)
    • STATSD_PORT (default = 8125)
  • The following stats will be published for each request:
    • response time
    • call count increment

Documentation and Test Harness

wshost will service a documentation page which includes a test harness for each endpoint of your service. Visit http://[host]:[port]/_doc to view.

Doc Screenshot

License

(The MIT License)

Copyright (c) 2012 Chatham Financial Corp oss@chathamfinancial.com

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.

npm loves you