pip_clients_passwords 1.0.0

  • Readme
  • Changelog
  • Example
  • Installing
  • new67

Pip.Services Logo
Passwords Microservice Client SDK for Dart #

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

  /* Password management */
  DateTime change_time;
  bool locked;
  DateTime lock_time;
  num fail_count;
  DateTime fail_time;
  String rec_code;
  DateTime rec_expire_time;

  /* Custom fields */
  dynamic custom_hdr;
  dynamic custom_dat;
}

class UserPasswordInfoV1 implements IStringIdentifiable {
  String id;
  DateTime change_time;
  bool locked;
  DateTime lock_time;
}

abstract class IPasswordsV1 {
  Future<UserPasswordInfoV1> getPasswordInfo(
      String correlationId, String userId);

  Future validatePassword(String correlationId, String password);

  Future setPassword(String correlationId, String userId, String password);

  Future<String> setTempPassword(String correlationId, String userId);

  Future deletePassword(String correlationId, String userId);

  Future<bool> authenticate(
      String correlationId, String userId, String password);

  Future changePassword(String correlationId, String userId, String oldPassword,
      String newPassword);

  Future<bool> validateCode(String correlationId, String userId, String code);

  Future resetPassword(
      String correlationId, String userId, String code, String password);

  Future recoverPassword(String correlationId, String userId);
}

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 = PasswordsHttpClientV1(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 password
final USER_PWD = UserPasswordV1(id: '1', password: 'password123');

    // Create the password
    try {
      await client.setPassword('123', USER_PWD.id, USER_PWD.password);
      // Do something with the returned password...
    } catch(err) {
      // Error handling...     
    }
// Authenticated
try {
var authenticated =
          await controller.authenticate(null, USER_PWD.id, 'password123');
    // Do something with authentication...

    } 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 Passwords Microservice #

This is a password authentication microservice from Pip.Services library.

  • Sets user passwords and authenticate
  • Safely change passwords
  • Reset and recover passwords via emails

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 = PasswordsHttpClientV1(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 password
final USER_PWD = UserPasswordV1(id: '1', password: 'password123');

    // Create the password
    try {
      await client.setPassword('123', USER_PWD.id, USER_PWD.password);
      // Do something with the returned password...
    } catch(err) {
      // Error handling...     
    }
// Authenticated
try {
var authenticated =
          await controller.authenticate(null, USER_PWD.id, 'password123');
    // Do something with authentication...

    } 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_passwords: ^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_passwords/pip_clients_passwords.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]
99
Overall:
Weighted score of the above. [more]
67
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.15

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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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_passwords/pip_clients_passwords.dart that imports:
  • package:pip_clients_passwords/src/build/build.dart that imports:
  • package:pip_clients_passwords/src/build/PasswordsClientFactory.dart that imports:
  • package:pip_clients_passwords/src/version1/PasswordsHttpClientV1.dart that imports:
  • package:pip_clients_passwords/src/version1/IPasswordsClientV1.dart that imports:
  • package:pip_services_passwords/pip_services_passwords.dart that imports:
  • package:pip_services_passwords/src/build/build.dart that imports:
  • package:pip_services_passwords/src/build/PasswordsServiceFactory.dart that imports:
  • package:pip_services_passwords/src/services/version1/PasswordsHttpServiceV1.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

Maintenance suggestions

The package description is too short. (-1 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

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.9 1.0.11
pip_services3_components ^1.0.6 1.0.6
pip_services3_data ^1.0.5 1.0.6
pip_services3_rpc ^1.0.3 1.0.7
pip_services_passwords ^1.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-nullsafety
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
mailer 3.0.4
matcher 0.12.9
merge_map 1.0.2
meta 1.2.2 1.3.0-nullsafety
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.2
pip_clients_activities 1.0.0
pip_clients_email 1.0.0
pip_clients_emailsettings 1.0.2
pip_clients_msgdistribution 1.0.0
pip_clients_msgtemplates 1.0.0
pip_clients_smssettings 1.0.1
pip_services3_container 1.0.3
pip_services3_grpc 1.0.0
pip_services3_mongodb 1.0.4
pip_services_activities 1.0.2
pip_services_email 1.0.1
pip_services_emailsettings 1.0.1
pip_services_msgdistribution 1.0.0
pip_services_msgtemplates 1.0.0
pip_services_smssettings 1.0.0
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-nullsafety
uuid 2.2.0
yaml 2.2.1
Dev dependencies
test >=1.14.2 <2.0.0