pip_clients_settings 1.0.0

  • Readme
  • Changelog
  • Example
  • Installing
  • new67

Settings Microservice Client SDK for Dart #

This is a Dart client SDK for pip-services-settings 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-infrastructure/pip-services-settings-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 SettingsSectionV1 implements IStringIdentifiable {
  @override
  String id;
  ConfigParams parameters;
  DateTime update_time;

  SettingsSectionV1({String id, ConfigParams parameters, DateTime update_time});

  void fromJson(Map<String, dynamic> json);
  Map<String, dynamic> toJson();
}


abstract class ISettingsClientV1 {
  Future<DataPage<String>> getSectionIds(String correlationId, FilterParams filter, PagingParams paging);
  Future<DataPage<SettingsSectionV1>> getSections(String correlationId, FilterParams filter, PagingParams paging);
  Future<ConfigParams> getSectionById(String correlationId, String id);
  Future<ConfigParams> setSection(String correlationId, String id, ConfigParams parameters);
  Future<ConfigParams> modifySection(String correlationId, String id, ConfigParams updateParams, ConfigParams incrementParams);
}

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

var parameters = ConfigParams.fromTuples([
                    'myapp', ConfigParams.fromTuples([
                      'theme', 'blue',
                      'language', 'en'
                    ])
                 ]);

// Sets section parameters
client.setSection(
    null,
    '123',
    parameters
);
// Get section parameters
var parameters = client.getSectionById(
    null,
    '123'
);

Acknowledgements #

This microservice was created and currently maintained by

  • Sergey Seroukhov.

1.0.0 #

  • Initial version

example/README.md

Examples for Settings Microservice #

This is a settings microservice from Pip.Services library. It manages system settings separated by individual sections. Each section contains multiple key-value parameter pairs.

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 service

controller = SettingsController();
controller.configure(ConfigParams());

service = SettingsHttpServiceV1();
service.configure(httpConfig);

persistence = SettingsMemoryPersistence();

var references = References.fromTuples([
    Descriptor('pip-services-settings', 'persistence', 'memory', 'default', '1.0'), persistence,
    Descriptor('pip-services-settings', 'controller', 'default', 'default', '1.0'), controller,
    Descriptor('pip-services-settings', 'service', 'http', 'default', '1.0'), service
]);

controller.setReferences(references);
service.setReferences(references);

await controller.open(null);
await service.open(null);

Instantiate the client and open connection to the microservice

// Create the client instance
var client = SettingsHttpClientV1(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

var parameters = ConfigParams.fromTuples([
                    'myapp', ConfigParams.fromTuples([
                      'theme', 'blue',
                      'language', 'en'
                    ])
                 ]);

// Sets section parameters
client.setSection(
    null,
    '123',
    parameters
);
// Get section parameters
var parameters = client.getSectionById(
    null,
    '123'
);

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_settings: ^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_settings/pip_clients_settings.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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_settings/pip_clients_settings.dart that imports:
  • package:pip_clients_settings/src/version1/version1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsCommandableGrpcClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/ISettingsClientV1.dart that imports:
  • package:pip_clients_settings/src/version1/SettingsSectionV1.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

Health suggestions

Format lib/src/build/SettingsClientFactory.dart.

Run dartfmt to format lib/src/build/SettingsClientFactory.dart.

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_data >=1.0.0 <2.0.0 1.0.6
pip_services3_grpc >=1.0.0 <2.0.0 1.0.0
pip_services3_rpc >=1.0.2 <2.0.0 1.0.7
pip_services_settings >=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
pip_services3_container 1.0.3
pip_services3_mongodb 1.0.4
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