pip_clients_sessions 1.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 67

Pip.Services Logo
Sessions Microservice Client SDK for Dart #

This is a Dart client SDK for pip-services-sessions microservice.

Download #

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

git clone git@github.com:pip-services-users/pip-clients-sessions-dart.git

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

Contract #

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

class SessionV1 implements IStringIdentifiable {
  /* Identification */
  String id;
  String user_id;
  String user_name;

  /* Session info */
  bool active;
  DateTime open_time;
  DateTime close_time;
  DateTime request_time;
  String address;
  String client;

  /* Cached content */
  var user;
  var data;
}

abstract class ISessionsV1 {
  Future<DataPage<SessionV1>> getSessions(
      String correlationId, FilterParams filter, PagingParams paging);

  Future<SessionV1> getSessionById(String correlationId, String id);

  Future<SessionV1> openSession(
      String correlationId,
      String user_id,
      String user_name,
      String address,
      String client,
      dynamic user,
      dynamic data);

  Future<SessionV1> storeSessionData(String correlationId, String sessionId, dynamic data);

  Future<SessionV1> updateSessionUser(String correlationId, String sessionId, dynamic user);

  Future<SessionV1> closeSession(String correlationId, String sessionId);

  Future<SessionV1> deleteSessionById(String correlationId, String sessionId);
}

Use #

The easiest way to work with the microservice is to use client SDK.

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
);

Instantiate the client and open connection to the microservice

// Create the client instance
var client = SessionsHttpClientV1(config);

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

// Connect to the microservice
try{
  await client.open(null)
}catch() {
  // Error handling...
}       
// Work with the microservice
// ...

Now the client is ready to perform operations


    // Open new session
    try {
      var session1 = await client.openSession('123', '1', 'User 1', 'localhost', 'test', 'abc');
      // Do something with the returned session...
    } catch(err) {
      // Error handling...     
    }
// Get the session
try {
var session = await client.getSessionById(
    null,
    session1.id);
    // Do something with session...

    } catch(err) { // Error handling}

Acknowledgements #

This microservice was created and currently maintained by

  • Sergey Seroukhov.
  • Nuzhnykh Egor

1.0.0 #

  • Initial version

1.0.1 #

  • Added direct client test

example/README.md

Examples for Sessions Microservice #

This is user sessions microservice from Pip.Services library. It opens and closes user sessions and stores sessiond data.

Define configuration parameters that match the configuration of the microservice's external API

// Service/Client configuration
var httpConfig = ConfigParams.fromTuples(
	"connection.protocol", "http",
	"connection.host", "localhost",
	"connection.port", 8080
);

Instantiate the client and open connection to the microservice

// Create the client instance
var client = SessionsHttpClientV1(config);

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

// Connect to the microservice
try{
  await client.open(null)
}catch() {
  // Error handling...
}       
// Work with the microservice
// ...

Now the client is ready to perform operations


    // Open new session
    try {
      var session1 = await client.openSession('123', '1', 'User 1', 'localhost', 'test', 'abc');
      // Do something with the returned session...
    } catch(err) {
      // Error handling...     
    }
// Get the session
try {
var session = await client.getSessionById(
    null,
    session1.id);
    // Do something with session...

    } catch(err) { // Error handling}

In the help for each class there is a general example of its use. Also one of the quality sources are the source code for the tests.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  pip_clients_sessions: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:pip_clients_sessions/pip_clients_sessions.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
34
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
67
Learn more about scoring.

We analyzed this package on Jul 9, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.14

Analysis suggestions

Package not compatible with SDK flutter

Because it is not compatible with any of the supported runtimes: flutter-native, flutter-web

Package not compatible with runtime flutter-native on android

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on ios

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on linux

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on macos

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on windows

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-web on web

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime js

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Package not compatible with runtime native-aot

Because:

  • package:pip_clients_sessions/pip_clients_sessions.dart that imports:
  • package:pip_clients_sessions/src/build/build.dart that imports:
  • package:pip_clients_sessions/src/build/SessionsClientFactory.dart that imports:
  • package:pip_clients_sessions/src/version1/SessionsHttpClientV1.dart that imports:
  • package:pip_clients_sessions/src/version1/ISessionsClientV1.dart that imports:
  • package:pip_services_sessions/pip_services_sessions.dart that imports:
  • package:pip_services_sessions/src/build/build.dart that imports:
  • package:pip_services_sessions/src/build/SessionsServiceFactory.dart that imports:
  • package:pip_services_sessions/src/services/version1/SessionsHttpServiceV1.dart that imports:
  • package:pip_services3_commons/pip_services3_commons.dart that imports:
  • package:pip_services3_commons/src/validate/validate.dart that imports:
  • package:pip_services3_commons/src/validate/ProjectionParamsSchema.dart that imports:
  • package:pip_services3_commons/src/validate/ArraySchema.dart that imports:
  • package:pip_services3_commons/src/reflect/ObjectReader.dart that imports:
  • package:pip_services3_commons/src/reflect/PropertyReflector.dart that imports:
  • dart:mirrors

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
angel_framework ^2.1.1 2.1.1
http ^0.12.0 0.12.1
pip_services3_commons >=1.0.5 <2.0.0 1.0.11
pip_services3_components >=1.0.2 <2.0.0 1.0.6
pip_services3_container >=1.0.0 <2.0.0 1.0.3
pip_services3_data >=1.0.0 <2.0.0 1.0.6
pip_services3_grpc >=1.0.0 <2.0.0 1.0.0
pip_services3_mongodb >=1.0.2 <2.0.0 1.0.4
pip_services3_rpc >=1.0.2 <2.0.0 1.0.7
pip_services_sessions >=1.0.0 <2.0.0 1.0.1
Transitive dependencies
angel_container 1.1.0
angel_http_exception 1.1.0
angel_model 1.0.3
angel_route 3.1.0+1
async 2.4.2
bson 0.3.2
charcode 1.1.3
code_buffer 1.0.1
collection 1.14.13 1.15.0-nnbd
combinator 1.1.0
convert 2.1.1
crypto 2.1.5
dart2_constant 1.0.2+dart2
file 5.2.1
fixnum 0.10.11
googleapis_auth 0.2.12
grpc 2.2.0
http2 1.0.0
http_parser 3.1.4
http_server 0.9.8+3
intl 0.16.1
logging 0.11.4
matcher 0.12.8
merge_map 1.0.2
meta 1.2.1
mime 0.9.6+3
mock_request 1.0.7
mongo_dart 0.4.0
mongo_dart_query 0.4.1
more 1.18.2 2.5.0
mustache4dart2 0.1.0
path 1.7.0
pedantic 1.9.1
pool 1.4.0
protobuf 1.0.1
quiver 2.1.3
quiver_hashcode 2.0.0
recase 2.0.1 3.0.0
source_span 1.7.0
sprintf 4.0.2
stack_trace 1.9.5
string_scanner 1.0.5
term_glyph 1.1.0
tuple 1.0.3
typed_data 1.2.0 1.3.0-nnbd
uuid 2.2.0
yaml 2.2.1
Dev dependencies
test >=1.14.2 <2.0.0