Add event listen, document code, support other auth strategy, ...

Author: Dahkenangnon

CHANGELOG.md

@@ -1,13 +1,18 @@
-## 0.0.7
 
+## 0.1.0
 
-## 0.0.1+1
+    - Improvment: Documentation of the code
+    - Breaking: on both rest and socketio, you get exactly what feathers js send,  we don't support any serializer or deserializer. So how previous version handle data is breaken
+    - Feature: Add event listen but not fully tested
+    - Authentication don't matter if you auth user with email/password. You can use email/password, phone/password, userName/password
+    - Feature: support now phone, email, etc, with password authentication
 
-    - remove unsed comment
-## 0.0.1
+## 0.0.7
 
+    - remove unused comment
     - Add formData handling 
     - Update readme
+
 ## 0.0.6-dev
 
     - Fix

LICENSE

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) 2019 Justin Dah-kenangnon <dah.kenangnon@gmail.com>
+Copyright (c) 2020-present Justin Dah-kenangnon <dah.kenangnon@gmail.com>
 
 > Permission is hereby granted, free of charge, to any person obtaining a copy
 > of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,11 @@
-# flutter_feathersjs :bird:
+# :bird: flutter_feathersjs :bird:
 
-Communicate with your feathers js server from flutter.
-*__FormData support out the box, auth, reAuth, socketio send event, rest ...__ But event listen via socketio not yet implemented*
+Communicate with your feathers js (https://feathersjs.com/) server from flutter.
 
+`Infos: Feathers js is a node framework for real-time applications and REST APIs.`
+
+
+*__FormData support out the box, auth, reAuth, socketio send event, rest ...__ 
 
 ## Import it
 
@@ -22,34 +25,44 @@ FlutterFeathersjs flutterFeathersjs = FlutterFeathersjs()
 ## Authentication with either with rest or socketio
 
 ```dart
-   // Auth with rest client
+   // Auth with rest client with email/password [Default strategy is email/password]
    var authResponse = await flutterFeathersjs.rest
-      .authenticate(email: user["email"], password: user["password"]);
+      .authenticate(userName: user["email"], password: user["password"]);
+
+    // Auth with rest client with phone/password
+   var authResponse = await flutterFeathersjs.rest.authenticate(
+      strategy: "phone",
+      userNameFieldName: "tel",
+      userName: user["tel"],
+      password: user["password"]);
 
   //Second time, application will restart, just:
   var reAuthResponse = await flutterFeathersjs.rest.reAuthenticate();
 
   // Or With socketio
   // Note: This must be call after rest auth success
+  // Not recommanded to use this directly
   var authResponse = await flutterFeathersjs.scketio.authWithJWT();
 
 ```
 
-## Simplify yor life, Auth both client one time
+## Auth both client one time
 
 ```dart
 
 // Auth first time with credentials
-var authResponse = await flutterFeathersjs.authenticate(email: null, password: null);
+ var authResponse = await flutterFeathersjs.authenticate(
+      strategy: "phone",
+      userNameFieldName: "tel",
+      userName: user["tel"],
+      password: user["password"]);
 
 // on App restart, don't disturbe user, just reAuth with with accessToken, early store by FlutterFeathersjs
 var reAuthResponse = await flutterFeathersjs.reAuthenticate()
 
 ```
 
-## Important
+## Contribution
 
-- Listen to event on socketio is not yet implemented
-- Documentation is coming
 - Contact-me for improvment or contribution purpose
 - Example is coming

example/pubspec.lock

@@ -57,6 +57,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "3.0.10"
+  event_bus:
+    dependency: transitive
+    description:
+      name: event_bus
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.1"
   fake_async:
     dependency: transitive
     description:
@@ -86,10 +93,10 @@ packages:
   flutter_feathersjs:
     dependency: "direct main"
     description:
-      name: flutter_feathersjs
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.0.6-dev"
+      path: ".."
+      relative: true
+    source: path
+    version: "0.1.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter

example/pubspec.yaml

@@ -10,7 +10,8 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  flutter_feathersjs: ^0.0.7
+  flutter_feathersjs: 
+    path: ../
   cupertino_icons: ^1.0.0
 
 dev_dependencies:

lib/flutter_feathersjs.dart

@@ -1,17 +1,44 @@
+/// Communicate with your feathers js (https://feathersjs.com/) server from flutter app.
 library flutter_feathersjs;
 
 import 'package:flutter_feathersjs/src/constants.dart';
 import 'package:flutter_feathersjs/src/rest_client.dart';
 import 'package:flutter_feathersjs/src/scketio_client.dart';
 import 'package:meta/meta.dart';
+//import 'package:flutter/foundation.dart' as Foundation;
 
-/// FlutterFeatherJs allow you to communicate with your feathers js server
+///
+///FlutterFeatherJs allow you to communicate with your feathers js server
+///
+///_______________________________________________
+///_______________________________________________
+///
+///
+/// `GENERAL NOTE 1`: Serialization and Deserialization are not supported.
+///
+/// You get exactly what feathers server send
+///
+/// `GENERAL NOTE 2`: To send file, use rest client, socketio client cannot upload file
+///
+/// Authentification is processed by:
+///
+///     // Global auth (Rest and Socketio)
+///     var rep = await flutterFeathersjs
+///     .authenticate(userName: user["email"], password: user["password"]);
+///
+///     //Then use this one to reUse access token as it still valided
+///      var reAuthResp = await flutterFeathersjs.reAuthenticate();
+///
+///
 class FlutterFeathersjs {
   //RestClient
   RestClient rest;
   //SocketioClient
   SocketioClient scketio;
 
+  // For debug purpose
+  bool dev = false;
+
   ///Using singleton
   static final FlutterFeathersjs _flutterFeathersjs =
       FlutterFeathersjs._internal();
@@ -22,13 +49,32 @@ class FlutterFeathersjs {
 
   ///Intialize both rest and scoketio client
   init({@required String baseUrl, Map<String, dynamic> extraHeaders}) {
+    // if (Foundation.kReleaseMode) {
+    //   // W're on release mode
+    //   dev = false;
+    // } else {
+    //   // W're not on release mode
+    //   dev = true;
+    // }
+
     rest = new RestClient()..init(baseUrl: baseUrl, extraHeaders: extraHeaders);
+
     scketio = new SocketioClient()..init(baseUrl: baseUrl);
   }
 
   /// Authenticate rest and scketio clients so you can use both of them
+  ///
+  ///___________________________________________________________________
+  /// @params `username` can be : email, phone, etc;
+  ///
+  /// But ensure that `userNameFieldName` is correct with your chosed `strategy`
+  ///
+  /// By default this will be `email`and the strategy `local`
   Future<Map<String, dynamic>> authenticate(
-      {@required String email, @required String password}) async {
+      {String strategy = "local",
+      @required String userName,
+      @required String password,
+      String userNameFieldName = "email"}) async {
     //Hold global auth infos
     Map<String, dynamic> authResponse = {
       "error": true,
@@ -39,8 +85,11 @@ class FlutterFeathersjs {
     };
 
     //Auth with rest to refresh or create accessToken
-    Map<String, dynamic> restAuthResponse =
-        await rest.authenticate(email: email, password: password);
+    Map<String, dynamic> restAuthResponse = await rest.authenticate(
+        strategy: strategy,
+        userName: userName,
+        userNameFieldName: userNameFieldName,
+        password: password);
     //Then auth with jwt socketio
     Map<String, dynamic> socketioAuthResponse = await scketio.authWithJWT();
 
@@ -55,6 +104,8 @@ class FlutterFeathersjs {
   }
 
   /// Authenticate rest and scketio clients so you can use both of them
+  ///
+  ///___________________________________________________________________
   Future<Map<String, dynamic>> reAuthenticate() async {
     //Hold global auth infos
     Map<String, dynamic> authResponse = {

lib/src/constants.dart

@@ -14,16 +14,9 @@ class Constants {
   static const String BOTH_CLIENT_AUTHED = "BOTH_CLIENT_AUTHED";
   static const String ONE_OR_BOTH_CLIENT_NOT_AUTHED =
       "ONE_OR_BOTH_CLIENT_NOT_AUTHED";
+  static const String FEATHERSJS_ACCESS_TOKEN = "FEATHERSJS_ACCESS_TOKEN";
 }
 
-class Removed<T> {}
-
-class Patched<T> {}
-
-class Created<T> {}
-
-class Updated<T> {}
-
 class Connected {}
 
 class DisConnected {}