@mitchallen/microservice-mongodb-get-one

A microservice REST GET module for retrieving a record from MongoDB

This module extends the @mitchallen/microservice-core module to create microservice endpoints to connect with MongoDB.

For a background on the core and microservices, visit the core npm page.

Installation

You must use npm 2.7.0 or higher because of the scoped package name.

$ npm init
$ npm install @mitchallen/microservice-mongodb-get-one --save

Usage

Provides a way to retrieve a record from MongoDB via REST GET.

Non-Secure Only

Please note that this module is for NON-SECURE get requests only. For ideas on how to create an SSL version see: @mitchallen/microservice-ssl. You may also want to checkout RichmondJS.

Define a Service Object

Define a service object with the following fields:

• name: the name of your service (see example to use package name)
• version: the version of your service (see example to use package version)
• verbose: true or false, whether or not to echo info to the console
• prefix: example: if prefix = "/v1", urls will begin with that (/v1/music)
• port: HTTP port to listen on
• mongodb: MongoDB connection info
  • mongodb.uri: MongoDB uri (example: mongodb://localhost/test)
• collectionName: name of the MongoDB collection for inserting records into

Music Get One Example

Here is the code from the example folder: examples/music-get/index.js

"use strict";

let demand = require('@mitchallen/demand');
let prefix = process.env.MUSIC_GET_API_VERSION || '/v1';

var service = {

    name: require("./package").name,
    version: require("./package").version,
    verbose: true,
    prefix: prefix,
    port: process.env.MUSIC_GET_PORT || 8005,
    mongodb: {
        uri: process.env.TEST_MONGO_URI || 'mongodb://localhost/test',
    },
    collectionName: "music",
};

require('@mitchallen/microservice-mongodb-get-one')(service, function(err,obj) {
    if( err ) {
        console.log(err);
        throw new Error( err.message );
    }
});

1. Create a file with the contents above called index.js

2. Execute the following at the command line:

    npm install
    npm install @mitchallen/microservice-mongodb-get-one --save
    npm install @mitchallen/demand --save

3. Run the app and leave it running:

    node index.js
       

4. Execute the following in the second terminal window (all on one line) (assumes a Mac or Linux and that port 8005 is not busy). Substitute {id} with an id from a music collection in your database. If you want to see a way to create data for testing, see the examples/music-post folder in the git repo:

    curl -i -X GET http://localhost:8005/v1/music/{id}
    

In a Web browser like Chrome you could also browse to the URL and see the JSON response in the browser window. Not all browsers display the JSON response.

MongoDB with Username and Password

To login with a username and password, you would need a uri like this example for mlab.com:

export TEST_MONGO_URI='mongodb://foo:[email protected]:12345/dbnode01'  

You would replace foo with your mlab username and fooword with your password.

You don't have to use your mlab login info. They let you add other users, such as a test user.

The 12345 portion of the string would change to match the uri that mlabs gives you.

Callback

You pass the service object to the module along with a callback:

require('@mitchallen/microservice-mongodb-get-one')(service, function(err,obj) {});

The object returned by the callback contains a server field:

{ server: server }

It's a pointer to the express modules server. If you are familiar with express, it's the value returned by app.listen. You don't need to actually return anything.

It was handy for me to use the close method in the unit tests so I wouldn't get port-in-use errors.

Here is an example of how to create it, then use the server return value to close it (checking for null omitted for brevity):

require('@mitchallen/microservice-mongodb-post')(options, function(err,obj) {
    if(err) {
    	// ...
    }
    var server = obj.server;
    server.close()
}); 

Example

You can find working examples in the examples folder of the git repo.

• examples / music-get - demos how to get a record from MongoDB. See that folders README for more info.
• examples / music-post - demos how to post a record to MongoDB, which is useful for testing the GET command. See that folders README for more info.

Testing

To test, go to the root folder and type (sans $):

$ npm test

Repo(s)

• bitbucket.org/mitchallen/microservice-mongodb-get-one.git

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Version History

Version 0.1.3

• updated code and test cases to return 404 for invalid or missing object ids

Version 0.1.2

• cleaned up module dependencies

Version 0.1.1

• updated music-get to use published module

Version 0.1.0

• initial release