pip-services-guides-node

Guides Microservice

This is an application guides microservice from Pip.Services library. It provides guidance to application users: introduces about application features, tells about new version and so on. Each guide:

• Can be written in multiple languages
• Can include one or more pages with title, text and a picture
• Supports editing lifecycle via status tracking

The microservice currently supports the following deployment options:

• Deployment platforms: Standalone Process, Seneca
• External APIs: HTTP/REST, Seneca, AWS Lambda
• Persistence: In-Memory, Flat Files, MongoDB

This microservice has dependencies on the following microservices:

• pip-services-attachments - to reference pictures and documents associates with guides

Quick Links:

• Download Links
• Development Guide
• Configuration Guide
• Deployment Guide
• Client SDKs
  • Node.js SDK
• Communication Protocols
  • HTTP Version 1
  • Seneca Version 1

Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.

class GuideTypeV1 {
    public static readonly Introduction = "introduction";
    public static readonly NewRelease = "new release";
}

class GuideV1 implements IStringIdentifiable {
    /* Identification */
    public id: string;
    public type: string;
    public app?: string;
    public version?: string;

    /* Automatically managed fields */
    public create_time: Date;

    /* Content */
    public pages: GuidePageV1[];

    /* Search */
    public tags?: string[];
    public all_tags?: string[];

    /* Status */
    public status?: string;

    /* Custom fields */
    public custom_hdr?: any;
    public custom_dat?: any;
}

class GuidePageV1 {
    public title: MultiString;
    public content?: MultiString;
    public more_url?: string;
    public color?: string;
    public pic_id?: string;
    public pic_url?: string;
}

class GuideStatusV1 {
    public static readonly New = "new";
    public static readonly Writing = "writing";
    public static readonly Translating = "translating";
    public static readonly Verifying = "verifying";
    public static readonly Completed = "completed";
}

interface IGuidesV1 {
    getGuides(correlationId: string, filter: FilterParams, paging: PagingParams,
        callback: (err: any, page: DataPage<GuideV1>) => void): void;

    getRandomGuide(correlationId: string, filter: FilterParams,
        callback: (err: any, guide: GuideV1) => void): void;

    getGuideById(correlationId: string, guideId: string,
        callback: (err: any, guide: GuideV1) => void): void;

    createGuide(correlationId: string, guide: GuideV1,
        callback: (err: any, guide: GuideV1) => void): void;

    updateGuide(correlationId: string, guide: GuideV1,
        callback: (err: any, guide: GuideV1) => void): void;

    deleteGuideById(correlationId: string, guideId: string,
        callback: (err: any, guide: GuideV1) => void): void;
}

Download

Right now the only way to get the microservice is to check it out directly from github repository

git clone [e-mail]:pip-services-content/pip-services-guides-node.git

Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.

Run

Add config.yaml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yaml file.

Example of microservice configuration

---
- descriptor: "pip-services-commons:logger:console:default:1.0"
  level: "trace"

- descriptor: "pip-services-guides:persistence:file:default:1.0"
  path: "./data/guides.json"

- descriptor: "pip-services-guides:controller:default:default:1.0"

- descriptor: "pip-services-attachments:client:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8082

- descriptor: "pip-services-guides:service:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8080

For more information on the microservice configuration see Configuration Guide.

Start the microservice using the command:

node run

Use

The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links

If you use Node.js then you should add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-guides-node": "^1.0.*",
        ...
    }
}

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-guides-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.GuidesHttpClientV1(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

// Create a new guide
client.createGuide(
    null,
    { 
        type: 'introduction',
        app: 'Test App 1',
        pages: [
            { 
                title: { en: 'Welcome to Test App 1' } 
            }
        ]
    },
    function (err, guide) {
        ...
    }
);

// Get a random intro guide for app1
client.getRandomGuide(
    null,
    {
        type: 'introduction',
        app: 'app1'
    },
    function(err, guide) {
        ...    
    }
);

Acknowledgements

This microservice was created and currently maintained by Sergey Seroukhov.