pip_services_roles

Description:

pip services roles

Roles Microservice #
This is a user roles microservice from Pip.Services library.
It provides basic role-based authorization mechanism for users.
The microservice currently supports the following deployment options:

Deployment platforms: Standalone Process, Seneca
External APIs: HTTP/REST, Seneca
Persistence: Flat Files, MongoDB

This microservice has no dependencies on other microservices.
Quick Links:

Download Links
Development Guide
Configuration Guide
Deployment Guide
Client SDKs

Node.js SDK
Dart SDK


Communication Protocols

HTTP Version 1



Contract #
Logical contract of the microservice is presented below. For physical implementation (HTTP/REST),
please, refer to documentation of the specific protocol.
class UserRolesV1 implements IStringIdentifiable {
String id;
List<String> roles;
DateTime update_time;
}

abstract class IRolesV1 {
Future<DataPage<UserRolesV1>> getRolesByFilter(
String correlationId, FilterParams filter, PagingParams paging);

Future<List<String>> getRolesById(String correlationId, String userId);

Future<List<String>> setRoles(String correlationId, String userId, List<String> roles);

Future<List<String>> grantRoles(String correlationId, String userId, List<String> roles);

Future<List<String>> revokeRoles(String correlationId, String userId, List<String> roles);

Future<bool> authorize(String correlationId, String userId, List<String> roles);
}
copied to clipboard
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-users/pip-services-roles-dart.git
copied to clipboard
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.
Example of microservice configuration
---
# Container descriptor
- descriptor: "pip-services:context-info:default:default:1.0"
name: "pip-services-roles"
description: "Roles microservice for pip-services"

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

# Performance counters that posts values to log
- descriptor: "pip-services:counters:log:default:1.0"
level: "trace"

{{#MEMORY_ENABLED}}
# In-memory persistence. Use only for testing!
- descriptor: "pip-services-roles:persistence:memory:default:1.0"
{{/MEMORY_ENABLED}}

{{#FILE_ENABLED}}
# File persistence. Use it for testing of for simple standalone deployments
- descriptor: "pip-services-roles:persistence:file:default:1.0"
path: {{FILE_PATH}}{{^FILE_PATH}}"./data/roles.json"{{/FILE_PATH}}
{{/FILE_ENABLED}}

{{#MONGO_ENABLED}}
# MongoDB Persistence
- descriptor: "pip-services-roles:persistence:mongodb:default:1.0"
collection: {{MONGO_COLLECTION}}{{^MONGO_COLLECTION}}roles{{/MONGO_COLLECTION}}
connection:
uri: {{{MONGO_SERVICE_URI}}}
host: {{{MONGO_SERVICE_HOST}}}{{^MONGO_SERVICE_HOST}}localhost{{/MONGO_SERVICE_HOST}}
port: {{MONGO_SERVICE_PORT}}{{^MONGO_SERVICE_PORT}}27017{{/MONGO_SERVICE_PORT}}
database: {{MONGO_DB}}{{#^MONGO_DB}}app{{/^MONGO_DB}}
credential:
username: {{MONGO_USER}}
password: {{MONGO_PASS}}
{{/MONGO_ENABLED}}

{{^MEMORY_ENABLED}}{{^FILE_ENABLED}}{{^MONGO_ENABLED}}
# Default in-memory persistence
- descriptor: "pip-services-roles:persistence:memory:default:1.0"
{{/MONGO_ENABLED}}{{/FILE_ENABLED}}{{/MEMORY_ENABLED}}

# Default controller
- descriptor: "pip-services-roles:controller:default:default:1.0"

# Common HTTP endpoint
- descriptor: "pip-services:endpoint:http:default:1.0"
connection:
protocol: "http"
host: "0.0.0.0"
port: 8080

# HTTP endpoint version 1.0
- descriptor: "pip-services-roles:service:http:default:1.0"

# Heartbeat service
- descriptor: "pip-services:heartbeat-service:http:default:1.0"

# Status service
- descriptor: "pip-services:status-service:http:default:1.0"
copied to clipboard
For more information on the microservice configuration see Configuration Guide.
Start the microservice using the command:
dart ./bin/run.dart
copied to clipboard
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 dart, then get references to the required libraries:

Pip.Services3.Commons : https://github.com/pip-services3-dart/pip-services3-commons-dart
Pip.Services3.Rpc:
https://github.com/pip-services3-dart/pip-services3-rpc-dart

Add pip-services3-commons-dart, pip-services3-rpc-dart and pip-services_roles packages
import 'package:pip_services3_commons/pip_services3_commons.dart';
import 'package:pip_services3_rpc/pip_services3_rpc.dart';

import 'package:pip_services_roles/pip_services_roles.dart';

copied to clipboard
Define client configuration parameters that match the configuration of the microservice's external API
// Client configuration
var httpConfig = ConfigParams.fromTuples(
"connection.protocol", "http",
"connection.host", "localhost",
"connection.port", 8080
);
copied to clipboard
Instantiate the client and open connection to the microservice
// Create the client instance
var client = RolesHttpClientV1(config);

// Configure the client
client.configure(httpConfig);

// Connect to the microservice
try{
await client.open(null)
}catch() {
// Error handling...
}
// Work with the microservice
// ...
copied to clipboard
Now the client is ready to perform operations
final ROLES = ['Role 1', 'Role 2', 'Role 3'];

// Set the roles
try {
var role = await client.setRoles('123', '1', ROLES);
// Do something with the returned roles...
} catch(err) {
// Error handling...
}
copied to clipboard
// Get the roles by id
try {
var role = await client.getRolesById(
null,
'1');
// Do something with roles...

} catch(err) { // Error handling}
copied to clipboard
// Grant user a role
try {
var role = await client.grantRoles(
null,
'1',
['admin']);
// Do something with roles...

} catch(err) { // Error handling}

// Authorize user
try {
var role = await client.authorize(
null,
'1',
['admin']);
// Do something with bool value(authorized or not authorized) ...

} catch(err) { // Error handling}
copied to clipboard
Acknowledgements #
This microservice was created and currently maintained by

Sergey Seroukhov.
Nuzhnykh Egor