pip_clients_activities 1.0.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 75

Pip.Services Logo
Activities Microservice Client SDK for Dart #

This is a Dart client SDK for pip-services-activities 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-activities-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 PartyActivityV1 implements IStringIdentifiable {
  /* Identification */
  String id;
  String org_id;

  /* Identification fields */
  DateTime time;
  String type;
  ReferenceV1 party;

  /* References objects (notes, goals, etc.) */
  ReferenceV1 ref_item;
  List<ReferenceV1> ref_parents;
  ReferenceV1 ref_party;

  /* Other details like % of progress or new status */
  StringValueMap details;
}

class ReferenceV1 implements IStringIdentifiable {
  String id;
  String type;
  String name;
}

abstract class IActivitiesV1 {
  Future<DataPage<PartyActivityV1>> getPartyActivities(
      String correlationId, FilterParams filter, PagingParams paging);

  Future<PartyActivityV1> logPartyActivity(String correlationId, PartyActivityV1 activity);

  Future<List<PartyActivityV1>> batchPartyActivities(String correlationId, List<PartyActivityV1> activities);

  Future deletePartyActivities(String correlationId, dynamic filter);
}

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 = ActivitiesHttpClientV1(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

// Create a new activity
final ACTIVITY = PartyActivityV1({
        type: 'signup',
        party: {
            id: '123',
            name: 'Test User'
        }
});

    // Create the activity
    try {
      var activity = await client.logPartyActivity('123', ACTIVITY);
      // Do something with the returned activity...
    } catch(err) {
      // Error handling...     
    }
// Get the list of activities for 'My Samples' product
var now = new Date();
try {
var page = await client.getPartyActivities(
    null,
    {
        party_id: '123',
        from_time: new Date(now.getTime() - 24 * 3600 * 1000),
        to_time: now
    },
    {
        total: true,
        skip: 0,
        take: 10
    });
    // Do something with page...

    } catch(err) { // Error handling}

Acknowledgements #

This microservice was created and currently maintained by

  • Sergey Seroukhov.
  • Nuzhnykh Egor

1.0.0 #

  • Initial version

example/README.md

Examples for Party Activities Microservice #

This is a party activity logging microservice from Pip.Services library. It logs important party activities like signups, signins, creation, changes or deletion of data items and so on.

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 = ActivitiesHttpClientV1(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

// Create a new activity
final ACTIVITY = PartyActivityV1({
        type: 'signup',
        party: {
            id: '123',
            name: 'Test User'
        }
});

    // Create the activity
    try {
      var activity = await client.logPartyActivity('123', ACTIVITY);
      // Do something with the returned activity...
    } catch(err) {
      // Error handling...     
    }
// Get the list of activities for 'My Samples' product
var now = Date();
try {
var page = await client.getPartyActivities(
    null,
    {
        party_id: '123',
        from_time: Date(now.getTime() - 24 * 3600 * 1000),
        to_time: now
    },
    {
        total: true,
        skip: 0,
        take: 10
    });
    // Do something with page...

    } 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_activities: ^1.0.0

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_activities/pip_clients_activities.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
49
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]
75
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.13

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 of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime flutter-native on ios

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime flutter-native on linux

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime flutter-native on macos

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime flutter-native on windows

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime flutter-web on web

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime native-aot

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Package not compatible with runtime web

Because of the import of dart:mirrors via the import chain package:pip_clients_activities/pip_clients_activities.dartpackage:pip_clients_activities/src/build/build.dartpackage:pip_clients_activities/src/build/ActivitiesClientFactory.dartpackage:pip_clients_activities/src/version1/ActivitiesHttpClientV1.dartpackage:pip_clients_activities/src/version1/IActivitiesClientV1.dartpackage:pip_services_activities/pip_services_activities.dartpackage:pip_services_activities/src/build/build.dartpackage:pip_services_activities/src/build/ActivitiesServiceFactory.dartpackage:pip_services_activities/src/services/version1/ActivitiesHttpServiceV1.dartpackage:pip_services3_commons/pip_services3_commons.dartpackage:pip_services3_commons/src/validate/validate.dartpackage:pip_services3_commons/src/validate/ProjectionParamsSchema.dartpackage:pip_services3_commons/src/validate/ArraySchema.dartpackage:pip_services3_commons/src/reflect/ObjectReader.dartpackage:pip_services3_commons/src/reflect/PropertyReflector.dartdart:mirrors

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.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_activities >=1.0.0 <2.0.0 1.0.2
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
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
uuid 2.2.0
yaml 2.2.1
Dev dependencies
test >=1.14.2 <2.0.0