Skip to content
This repository has been archived by the owner on Jan 3, 2022. It is now read-only.

Commit

Permalink
routes changeing
Browse files Browse the repository at this point in the history
  • Loading branch information
msayed-net committed May 24, 2020
1 parent b1ae5bd commit bb229ac
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 16 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,7 @@
## 1.2.1

* Easy change routes

## 1.2.0

* Enhanced Quality
Expand Down
17 changes: 10 additions & 7 deletions README.md
Expand Up @@ -17,12 +17,11 @@ Dart - Backend user auth helpe, with common methods
* init with `apiBaseUrl` and optional `store`: `true` | `false`, default is `false`, if `true` plugin will store user and retrieve with `loadUser()`.

## methods
##### you may change routes to fit your API
* `login` : default route `/user/login`, waits for `user` in response to return.
* `check` : default route `/user/details`, waits for `user` in response to return.
* `logout` : default route `/user/details`, return `true` | `false`.
* `loadUser` : local method, return `user` if stored.
* New`register` : default route `/user/register`, waits for `user` in response to return.
* `login` : waits for `user` in response to return.
* `check` : waits for `user` in response to return.
* `logout` : return `true` | `false`.
* `loadUser` : return `user` if stored in prefs.
* `register` : waits for `user` in response to return.

## example
```dart
Expand All @@ -33,8 +32,12 @@ UserAuth user = new UserAuth();
// init
await user.init(
apiBaseUrl: 'https://example.com/api',
store: true,
apiBaseUrl: 'https://example.com/api',
loginUrl: "/user/login",
registerUrl: "/user/register",
checkUrl: "/user/details",
logoutUrl: "/user/logout",
);
// Note : change 'Bearer ' and api_token with your own parameters
Expand Down
4 changes: 4 additions & 0 deletions example/README.md
Expand Up @@ -17,6 +17,10 @@ Future main() async {
await user.init(
apiBaseUrl: 'https://example.com/api',
store: true,
loginUrl: "/user/login",
registerUrl: "/user/register",
checkUrl: "/user/details",
logoutUrl: "/user/logout",
);
runApp(MyApp());
Expand Down
4 changes: 4 additions & 0 deletions example/lib/main.dart
Expand Up @@ -16,6 +16,10 @@ Future main() async {
await user.init(
apiBaseUrl: 'https://example.com/api',
store: true,
loginUrl: "/user/login",
registerUrl: "/user/register",
checkUrl: "/user/details",
logoutUrl: "/user/logout",
);

runApp(MyApp());
Expand Down
2 changes: 1 addition & 1 deletion example/pubspec.lock
Expand Up @@ -204,7 +204,7 @@ packages:
path: ".."
relative: true
source: path
version: "1.2.0"
version: "1.2.1"
vector_math:
dependency: transitive
description:
Expand Down
23 changes: 17 additions & 6 deletions lib/user_auth.dart
Expand Up @@ -7,6 +7,10 @@ class UserAuth {
// ? vars ? //
String baseUrl;
SharedPreferences prefs;
String loginUrl = "/user/login";
String registerUrl = "/user/register";
String checkUrl = "/user/details";
String logoutUrl = "/user/logout";

///------------------------------------
/// User : init
Expand All @@ -15,12 +19,19 @@ class UserAuth {
init({
@required String apiBaseUrl,
bool store = false,
String loginUrl = "/user/login",
String registerUrl = "/user/register",
String checkUrl = "/user/details",
String logoutUrl = "/user/logout",
}) async {
baseUrl = apiBaseUrl;
if (store) {
prefs = await SharedPreferences.getInstance();
}
print(prefs);
loginUrl = loginUrl;
registerUrl = registerUrl;
checkUrl = checkUrl;
logoutUrl = logoutUrl;
}

///------------------------------------
Expand All @@ -35,7 +46,7 @@ class UserAuth {
try {
// ---- API Call ---- //
var response = await http.post(
baseUrl + "/user/login",
baseUrl + loginUrl,
body: {
usernameVar: usernameVal,
'password': password,
Expand All @@ -53,14 +64,14 @@ class UserAuth {
}

///------------------------------------
/// User : Login
/// User : Register
///------------------------------------
/// return user data
Future<dynamic> register({@required Map form}) async {
try {
// ---- API Call ---- //
var response = await http.post(
baseUrl + "/user/register",
baseUrl + registerUrl,
body: form,
);
// ---- Response ---- //
Expand Down Expand Up @@ -96,7 +107,7 @@ class UserAuth {
}) async {
try {
// ---- API Call ---- //
var response = await http.post(baseUrl + "/user/details", headers: {
var response = await http.post(baseUrl + checkUrl, headers: {
'Authorization': type + token,
});

Expand All @@ -117,7 +128,7 @@ class UserAuth {
}) async {
try {
// ---- API Call ---- //
var response = await http.post(baseUrl + "/user/logout", headers: {
var response = await http.post(baseUrl + logoutUrl, headers: {
'Authorization': type + token,
});

Expand Down
4 changes: 2 additions & 2 deletions pubspec.yaml
@@ -1,6 +1,6 @@
name: user_auth
description: Dart - Backend user auth helpe, with common methods
version: 1.2.0
description: Dart - Backend user auth helpe, with common methods like login and register
version: 1.2.1
homepage: https://github.com/MohamedSayed95/user_auth

environment:
Expand Down

0 comments on commit bb229ac

Please sign in to comment.