Merge remote-tracking branch 'origin/master' into release

Author: dynabic-billing-team

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [21.12.0] - Aspose Words Cloud for Dart 21.12 Release Notes
+
+- Added 'timeout' parameter to api configuration
+
 ## [21.11.0] - Aspose Words Cloud for Dart 21.11 Release Notes
 
 - Support encryption of 'CommonRequest.Password'. Automatic encryption of all passwords sent to the API server as request parameters.

Jenkinsfile

@@ -6,11 +6,13 @@ properties([
             [$class: 'StringParameterDefinition', name: 'apiUrl', defaultValue: 'https://api-qa.aspose.cloud', description: 'api url'],
             [$class: 'BooleanParameterDefinition', name: 'ignoreCiSkip', defaultValue: false, description: 'ignore CI Skip'],
             [$class: 'StringParameterDefinition', name: 'credentialsId', defaultValue: '6839cbe8-39fa-40c0-86ce-90706f0bae5d', description: 'credentials id'],
+            [$class: 'BooleanParameterDefinition', name: 'packageTesting', defaultValue: false, description: 'Testing package from repository without local sources. Used for prodhealthcheck'],
         ]
     ]
 ])
 
 def needToBuild = false
+def packageTesting = false
 
 node('words-linux') {
     cleanWs()
@@ -24,6 +26,7 @@ node('words-linux') {
                     def commitMessage = readFile('gitMessage').trim()
                     echo commitMessage
                     needToBuild = params.ignoreCiSkip || !commitMessage.contains('[ci skip]')
+                    packageTesting = params.packageTesting
                     sh 'git clean -fdx'
 
                     if (needToBuild) {
@@ -34,7 +37,31 @@ node('words-linux') {
                     }
                 }
 
-                if (needToBuild) {
+                if (packageTesting) {
+                    docker.image('google/dart:2.14').inside {
+                        stage('prepare'){
+                            sh "rm -rf lib"
+                            sh "cp ./pubspec_package_testing.yaml ./pubspec.yaml"
+                            sh "dart pub add aspose_words_cloud"
+                            sh "pub get"
+                            sh "pub global activate junitreport"
+                        }
+                        
+                        stage('lint'){
+                            sh "dartanalyzer --fatal-infos --fatal-warnings --options analysis_options.yaml ."
+                        }
+                    
+                        stage('tests'){
+                            try {
+                                sh "pub run test test/aspose_words_cloud_tests.dart --concurrency=1 --no-color --reporter expanded --file-reporter json:testReport.json"
+                            } finally {
+                                sh "pub global run junitreport:tojunit --input testReport.json --output testReport.xml"
+                                junit 'testReport.xml'
+                            }
+                        }
+                    } 
+                }
+                else if (needToBuild) {
                     docker.image('google/dart:2.14').inside {
                         stage('prepare'){
                             sh "pub get"

README.md

@@ -27,7 +27,7 @@ Add this dependency to your *pubspec.yaml*:
 
 ```yaml
 dependencies:
-  aspose_words_cloud: 21.11.0
+  aspose_words_cloud: 21.12.0
 ```
 
 ## Getting Started

examples/AcceptAllRevisions.dart

@@ -5,7 +5,7 @@ final clientId = "####-####-####-####-####";
 final clientSecret = "##################";
 final config = Configuration(clientId, clientSecret);
 final wordsApi = WordsApi(config);
-final fileName  = 'test_doc.docx';
+final fileName = 'test_doc.docx';
 
 // Upload original document to cloud storage.
 final myVar1 = (await File(fileName).readAsBytes()).buffer.asByteData();

examples/AcceptAllRevisionsOnline.dart

@@ -2,7 +2,7 @@ final clientId = "####-####-####-####-####";
 final clientSecret = "##################";
 final config = Configuration(clientId, clientSecret);
 final wordsApi = WordsApi(config);
-final fileName  = 'test_doc.docx';
+final fileName = 'test_doc.docx';
 
 // Calls AcceptAllRevisionsOnline method for document in cloud.
 final requestDocument = (await File(fileName).readAsBytes()).buffer.asByteData();

lib/aspose_words_cloud.dart

@@ -94,6 +94,7 @@ export 'src/models/field_insert.dart';
 export 'src/models/field_link.dart';
 export 'src/models/field_names.dart';
 export 'src/models/field_names_response.dart';
+export 'src/models/field_options.dart';
 export 'src/models/field_response.dart';
 export 'src/models/field_update.dart';
 export 'src/models/fields_response.dart';
@@ -134,6 +135,8 @@ export 'src/models/hyperlink_response.dart';
 export 'src/models/hyperlinks.dart';
 export 'src/models/hyperlinks_response.dart';
 export 'src/models/image_save_options_data.dart';
+export 'src/models/info_additional_item.dart';
+export 'src/models/info_response.dart';
 export 'src/models/jpeg_save_options_data.dart';
 export 'src/models/json_data_load_options.dart';
 export 'src/models/link.dart';
@@ -267,6 +270,7 @@ export 'src/models/text_save_options_data.dart';
 export 'src/models/tiff_save_options_data.dart';
 export 'src/models/time_zone_info_data.dart';
 export 'src/models/txt_save_options_base_data.dart';
+export 'src/models/user_information.dart';
 export 'src/models/watermark_text.dart';
 export 'src/models/word_ml_save_options_data.dart';
 export 'src/models/words_api_error_response.dart';
@@ -417,6 +421,7 @@ export 'src/requests/get_header_footer_online_request.dart';
 export 'src/requests/get_header_footer_request.dart';
 export 'src/requests/get_header_footers_online_request.dart';
 export 'src/requests/get_header_footers_request.dart';
+export 'src/requests/get_info_request.dart';
 export 'src/requests/get_list_online_request.dart';
 export 'src/requests/get_list_request.dart';
 export 'src/requests/get_lists_online_request.dart';

lib/src/api_client.dart

@@ -116,7 +116,7 @@ class ApiClient {
     final url = configuration.baseUrl + '/connect/token';
     final data = 'grant_type=client_credentials&client_id=${configuration.clientId}&client_secret=${configuration.clientSecret}';
     final headers = {'Content-Type' : 'application/x-www-form-urlencoded'};
-    final response = await http.post(Uri.parse(url), headers: headers, body: data);
+    final response = await http.post(Uri.parse(url), headers: headers, body: data).timeout(configuration.timeout);
     if (response.statusCode == 400) {
       throw ApiException(response.statusCode, 'Invalid server credentials. Please check your ClientSecret and ClientId.');
     }
@@ -471,7 +471,7 @@ class ApiClient {
 
     var httpRequest = http.Request(requestData.method, Uri.parse(requestData.url));
     httpRequest.headers['x-aspose-client'] = 'dart sdk';
-    httpRequest.headers['x-aspose-client-version'] = '21.11';
+    httpRequest.headers['x-aspose-client-version'] = '21.12';
     httpRequest.headers['Authorization'] = await _getAuthToken();
     if (requestData.headers != null) {
       httpRequest.headers.addAll(requestData.headers);
@@ -481,7 +481,7 @@ class ApiClient {
       httpRequest.bodyBytes = requestData.body.buffer.asUint8List(requestData.body.offsetInBytes, requestData.body.lengthInBytes);
     }
 
-    var response = await httpRequest.send();
+    var response = await httpRequest.send().timeout(configuration.timeout);
     var bytes = await response.stream.toBytes();
     var responseData = ByteData.view(bytes.buffer);
 

lib/src/configuration.dart

@@ -32,14 +32,16 @@ class Configuration {
   final String clientSecret;
   final String baseUrl;
   final bool debugMode;
+  final Duration timeout;
 
-  Configuration(final this.clientId, final this.clientSecret, {final this.baseUrl = 'https://api.aspose.cloud', final this.debugMode = false});
+  Configuration(final this.clientId, final this.clientSecret, {final this.baseUrl = 'https://api.aspose.cloud', final this.debugMode = false, final this.timeout = const Duration(seconds: 300)});
 
   Configuration.fromJson(final Map<String, dynamic> json)
     : clientId = json['ClientId'] as String,
       clientSecret = json['ClientSecret'] as String,
       baseUrl = json['BaseUrl'] as String ?? 'https://api.aspose.cloud',
-      debugMode = json['DebugMode'] as bool;
+      debugMode = json['DebugMode'] as bool,
+      timeout = Duration(seconds: json['Timeout'] as int ?? 300);
 
   String getApiRootUrl()
   {