Improved code quality and added support for private files

eldadfux · eldadfux · commit cb8bed0d5b2e · 2021-03-03T08:58:00.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,24 @@
+language: dart
+
+dart: stable
+
+os: linux
+
+install:
+- mkdir -p  ~/.pub-cache
+- |
+  cat <<EOF > ~/.pub-cache/credentials.json
+    {
+      "accessToken":"$PUB_ACCESS_TOKEN",
+      "refreshToken":"$PUB_REFRESH_TOKEN",
+      "tokenEndpoint":"$PUB_TOKEN_EDNPOINT",
+      "scopes":["https://www.googleapis.com/auth/plus.me","https://www.googleapis.com/auth/userinfo.email"],
+      "expiration":$PUB_EXPIRATION
+    }
+
+deploy:
+  provider: script
+  skip_cleanup: true
+  script: pub publish -f
+  on:
+    tags: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## 0.3.0
+
+- Improved code quality
+- Added a custom Appwrite exception
+- Enabled access to private storage file
+
+## 0.2.0
+
+- Upgraded to work with Appwrite 0.7
+
 ## 0.1.0
 
 - First release
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^0.2.0
+  dart_appwrite: ^0.3.0
 ```
 
 You can install packages from the command line:
diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getBrowser(
+  Future result = avatars.getBrowser(
     code: 'aa',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getCreditCard(
+  Future result = avatars.getCreditCard(
     code: 'amex',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/avatars/get-favicon.md b/docs/examples/avatars/get-favicon.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getFavicon(
+  Future result = avatars.getFavicon(
     url: 'https://example.com',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getFlag(
+  Future result = avatars.getFlag(
     code: 'af',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getImage(
+  Future result = avatars.getImage(
     url: 'https://example.com',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md
@@ -10,8 +10,13 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getInitials(
+  Future result = avatars.getInitials(
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = avatars.getQR(
+  Future result = avatars.getQR(
     text: '[TEXT]',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = storage.getFileDownload(
+  Future result = storage.getFileDownload(
     fileId: '[FILE_ID]',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = storage.getFilePreview(
+  Future result = storage.getFilePreview(
     fileId: '[FILE_ID]',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/docs/examples/storage/get-file-view.md b/docs/examples/storage/get-file-view.md
@@ -10,9 +10,14 @@ void main() { // Init SDK
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  String result = storage.getFileView(
+  Future result = storage.getFileView(
     fileId: '[FILE_ID]',
   );
 
-  print(result); // Resource URL string
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
 }
diff --git a/lib/client.dart b/lib/client.dart
@@ -1,8 +1,4 @@
-import 'dart:io';
-import 'package:dio/dio.dart';
-import 'package:dio/adapter.dart';
-
-import 'enums.dart';
+part of dart_appwrite;
 
 class Client {
     String endPoint;
@@ -17,7 +13,7 @@ class Client {
         
         this.headers = {
             'content-type': 'application/json',
-            'x-sdk-version': 'appwrite:dart:0.2.0',
+            'x-sdk-version': 'appwrite:dart:0.3.0',
         };
 
         this.config = {};
@@ -70,7 +66,7 @@ class Client {
         }
     }
 
-    Future<Response> call(HttpMethod method, {String path = '', Map<String, String> headers = const {}, Map<String, dynamic> params = const {}}) async {
+    Future<Response> call(HttpMethod method, {String path = '', Map<String, String> headers = const {}, Map<String, dynamic> params = const {}, ResponseType responseType}) async {
         if(selfSigned) {
             // Allow self signed requests
             (http.httpClientAdapter as DefaultHttpClientAdapter).onHttpClientCreate = (HttpClient client) {
@@ -85,20 +81,30 @@ class Client {
         Options options = Options(
             headers: {...this.headers, ...headers},
             method: method.name(),
+            responseType: responseType
         );
-
-        if(headers['content-type'] == 'multipart/form-data') {
-            return http.request(path, data: FormData.fromMap(params), options: options);
-        }
-
-        if (method == HttpMethod.get) {
-            params.keys.forEach((key) {if (params[key] is int || params[key] is double) {
-              params[key] = params[key].toString();
-            }});
-            
-            return http.get(path, queryParameters: params, options: options);
-        } else {
-            return http.request(path, data: params, options: options);
+        try {
+
+            if(headers['content-type'] == 'multipart/form-data') {
+                return http.request(path, data: FormData.fromMap(params), options: options);
+            }
+
+            if (method == HttpMethod.get) {
+                params.keys.forEach((key) {if (params[key] is int || params[key] is double) {
+                params[key] = params[key].toString();
+                }});
+                
+                return http.get(path, queryParameters: params, options: options);
+            } else {
+                return http.request(path, data: params, options: options);
+            }
+        } on DioError catch(e) {
+          if(e.response == null) {
+            throw AppwriteException(e.message);
+          }
+          throw AppwriteException(e.response.data['message'],e.response.data['code'], e.response.data);
+        } catch(e) {
+          throw AppwriteException(e.message);
         }
     }
 }
diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart
@@ -1,12 +1,22 @@
+library dart_appwrite;
+
+import 'dart:io';
+import 'package:dio/dio.dart';
+import 'package:meta/meta.dart';
+import 'package:dio/adapter.dart';
+
+
 export 'package:dio/dio.dart' show Response, MultipartFile;
 
-export 'client.dart';
-export 'enums.dart';
-export 'services/avatars.dart';
-export 'services/database.dart';
-export 'services/functions.dart';
-export 'services/health.dart';
-export 'services/locale.dart';
-export 'services/storage.dart';
-export 'services/teams.dart';
-export 'services/users.dart';
+part 'client.dart';
+part 'enums.dart';
+part 'service.dart';
+part 'exception.dart';
+part 'services/avatars.dart';
+part 'services/database.dart';
+part 'services/functions.dart';
+part 'services/health.dart';
+part 'services/locale.dart';
+part 'services/storage.dart';
+part 'services/teams.dart';
+part 'services/users.dart';
diff --git a/lib/enums.dart b/lib/enums.dart
@@ -1,3 +1,5 @@
+part of dart_appwrite;
+
 enum HttpMethod { get, post, put, delete, patch }
 
 extension HttpMethodString on HttpMethod {
diff --git a/lib/exception.dart b/lib/exception.dart
@@ -0,0 +1,10 @@
+part of dart_appwrite;
+
+class AppwriteException implements Exception {
+  final String message;
+  final int code;
+  final dynamic response;
+
+  AppwriteException([this.message = "", this.code, this.response]);
+  
+}
diff --git a/lib/service.dart b/lib/service.dart
@@ -1,4 +1,4 @@
-import 'client.dart';
+part of dart_appwrite;
 
 class Service {
   final Client client;
diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart
diff --git a/lib/services/database.dart b/lib/services/database.dart
diff --git a/lib/services/functions.dart b/lib/services/functions.dart
diff --git a/lib/services/health.dart b/lib/services/health.dart
diff --git a/lib/services/locale.dart b/lib/services/locale.dart
diff --git a/lib/services/storage.dart b/lib/services/storage.dart
diff --git a/lib/services/teams.dart b/lib/services/teams.dart
diff --git a/lib/services/users.dart b/lib/services/users.dart
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,13 @@ void main() { // Init SDK`
`10`	`10`	`.setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key`
`11`	`11`	`;`
`12`	`12`
`13`		`- String result = avatars.getInitials(`
	`13`	`+ Future result = avatars.getInitials(`
`14`	`14`	`);`
`15`	`15`
`16`		`- print(result); // Resource URL string`
	`16`	`+ result`
	`17`	`+ .then((response) {`
	`18`	`+ print(response);`
	`19`	`+ }).catchError((error) {`
	`20`	`+ print(error.response);`
	`21`	`+ });`
`17`	`22`	`}`