Feedbacks Microservice

This is a user feedbacks microservice from Pip.Services library. It allows users to communicate to application support, request help, share ideas or raise copyright issues. When feedbacks are processed by support personnel, user receives a feedback via provided email.

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 feedbacks

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 FeedbackV1 implements IStringIdentifiable {
    /* Identification */
    public id: string;
    public category: string;
    public app?: string;

    /* Generic request properties */
    public sender: PartyReferenceV1;
    public sent_time: Date;

    /* Common properties */
    public title?: string;
    public content?: string;
    public pics: AttachmentV1[];
    public docs: AttachmentV1[];

    /* Copyright/Trademark Violation */
    public company_name?: string;
    public company_addr?: string;
    public copyright_holder?: string;
    public original_loc?: string;
    public copyrighted_work?: string;
    public unauth_loc?: string;

    /* Generic reply properties */
    public reply_time?: Date;
    public replier?: PartyReferenceV1;
    public reply?: string;

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

class AttachmentV1 {
    public id?: string;
    public uri?: string;
    public name?: string;
}

class PartyReferenceV1 {
    public id: string;
    public name?: string;
    public email?: string;
}

interface IFeedbacksController {
    getFeedbacks(correlationId: string, filter: FilterParams, paging: PagingParams,
        callback: (err: any, page: DataPage<FeedbackV1>) => void): void;

    getFeedbackById(correlationId: string, feedbackId: string,
        callback: (err: any, feedback: FeedbackV1) => void): void;

    sendFeedback(correlationId: string, feedback: FeedbackV1, user: PartyReferenceV1,
        callback: (err: any, feedback: FeedbackV1) => void): void;

    replyFeedback(correlationId: string, feedbackId: string, reply: string, user: PartyReferenceV1,
        callback: (err: any, feedback: FeedbackV1) => void): void;

    deleteFeedbackById(correlationId: string, feedbackId: string,
        callback: (err: any, feedback: FeedbackV1) => void): void;
}

Download

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

git clone [email protected]:pip-services-support/pip-services-feedbacks-node.git

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

Run

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

Example of microservice configuration

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

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

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

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

- descriptor: "pip-services-feedbacks: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-feedbacks-node": "^1.0.*",
        ...
    }
}

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-feedbacks-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.FeedbacksHttpClientV1(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

// Send feedback to support
client.sendFeedback(
    null,
    {
        category: 'support',
        title: 'Please help',
        content: 'When I am trying to run application in Win 10 it crashes'
    },
    {
        id: '123',
        name: 'Test User',
        email: '[email protected]'
    },
    function (err, feedback) {
        ...
    }
);

// Reply feedback
client.replyFeedback(
    null,
    feedback.id,
    'Please, be patient. We are working to fix that issue.',
    {
        id: '321',
        name: 'Support Team',
        email: '[email protected]'
    },
    function(err, feedback) {
    ...    
    }
);

Acknowledgements

This microservice was created and currently maintained by Sergey Seroukhov.