@stormgle/user-services v2.1.1

user-services

@stormgle

Introduction

user-services is a collection of micro-services aim to manage user account. It is based on nodejs and express. Each service can be deploy as an REST API so that it is easy to scale in production or integrate with serverless platforms such as Amazon Lambda.

Run example demo

If you want to explore the services, run the example demo provided with this package.

Clone package from GitHub

git clone https://github.com/stormgle/user-services

Run example demo

npm run example

It will run setup script to download AWS DynamoDB Local and then start the example server at port 3100. The example server includes all provided APIs.

Open a ternimal and make a request to example server, using curl for example.

Signup a new account

curl -H "Content-Type: application/json" -X POST -d '{"username":"tester@test-team.com","password":"123456"}' http://localhost:3100/user/signup

Login

curl -H "Content-Type: application/json" -X POST -d '{"username":"tester@test-team.com","password":"123456"}' http://localhost:3100/user/login

For the complete list of the API, refer section TBD

Use the package in your project

Install packages

npm install --save @stormgle/user-services

Since the user-service uses an abstraction layer (userdb-api) for accessing database, We need to install a database driver. Here we will select dynamodb driver.

npm install --save @stormgle/userdb-dynamodb

Setup environment for local development

If you use AWS DynamoDB Web Service. You only need to configure your aws credential provided by AWS.

If you want to use AWS DynamoDB Local for development, you need to download the downloadable version of DynamoDB and extract it into your workspace (under ./localdb for example). You still need to configure aws credential for accessing DynamoDB programmatically. Simply setup these two keys in your environment variable:

AWS_ACCESS_KEY_ID = whatever_you_want_it_is_not_important

AWS_SECRET_ACCESS_KEY = whatever_you_want_it_is_not_important

To start DynamoDB on your computer at port 3001, assume that you have extracted dynamodb into ./localdb

cd localdb && java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -port 3001 -sharedDb

Create signup.server.js

signup.server.js

"use strict"

/* Define Host and Port for server and database */
const SERVER_HOST = 'localhost';
const SERVER_PORT = 3100;

const DB_HOST = 'localhost';
const DB_PORT = 3001;

/* Import user-service helper and database driver */
const app = require('@stormgle/user-services');
const dynamodb = require('@stormgle/userdb-dynamodb')

/* configure the driver */
const dbDriver = dynamodb({ 
  region : 'us-west-2', 
  endpoint : `${DB_HOST}:${DB_PORT}`
});

/* use the driver and create function from the API, it will add the api to the express route */
app
  .useDbDriver(dbDriver)
  .createFunction('/user/signup', require('@stormgle/user-services/api/user/signup'))


/* start signup server */
const httpServer = require('http').createServer(app);
httpServer.listen(SERVER_PORT)
console.log(`# Signup server is running at ${SERVER_HOST}:${SERVER_PORT}\n`);

start DynamoDB on your compiter first, then run the server:

node signup.server.js

Create server that implement more than one API

You can create a server that implement more than one API. For example, we will create server.js that implement both user/signup and user/login

server.js

"use strict"

/* Define Host and Port for server and database */
const SERVER_HOST = 'localhost';
const SERVER_PORT = 3100;

const DB_HOST = 'localhost';
const DB_PORT = 3001;

/* Import user-services helper and database driver */
const app = require('@stormgle/user-services');
const dynamodb = require('@stormgle/userdb-dynamodb')

/* configure the driver */
const dbDriver = dynamodb({ 
  region : 'us-west-2', 
  endpoint : `${DB_HOST}:${DB_PORT}`
});

app
  .useDbDriver(dbDriver)

/* create function from the APIs, it will add the api to the express route */
['user/signup', 'user/login']
.forEach(api => {
  app.createFunction(`/${api}`, require(`@stormgle/user-services/api/${api}`))
}) 


/* start the server */
const httpServer = require('http').createServer(app);
httpServer.listen(SERVER_PORT)
console.log(`# Server (signup & login) is running at ${SERVER_HOST}:${SERVER_PORT}\n`);