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

Author: dynabic-billing-team

Jenkinsfile

@@ -3,46 +3,40 @@ parameters {
 		string(name: 'apiUrl', defaultValue: 'https://api-qa.aspose.cloud', description: 'server url')		
 }
 
-def runtests(version)
-{
-    dir(version){
-        try {
-            stage('checkout_' + version){
-                checkout([$class: 'GitSCM', branches: [[name: params.branch]], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'LocalBranch', localBranch: "**"]], submoduleCfg: [], userRemoteConfigs: [[credentialsId: '361885ba-9425-4230-950e-0af201d90547', url: 'https://git.auckland.dynabic.com/words-cloud/words-cloud-sdk-swift.git']]])
-                withCredentials([usernamePassword(credentialsId: '6839cbe8-39fa-40c0-86ce-90706f0bae5d', passwordVariable: 'AppKey', usernameVariable: 'AppSid')]) {
-					sh 'mkdir -p Settings'
-                    sh 'echo "{\\"AppSid\\": \\"$AppSid\\",\\"AppKey\\": \\"$AppKey\\", \\"BaseUrl\\": \\"$apiUrl\\"}" > Settings/servercreds.json'
-                }
-            }
-            
-            docker.image('swift:' + version).inside{
-                stage('build_' + version){
-					sh "swift build"
-				}
-            
-                stage('tests_' + version){
-					try{
-						sh "swift test"
-					} finally{
-						junit 'tests.xml'
-					}
-                }
-				
-				stage('clean-compiled_' + version){
-					sh "rm -rf %s"
-				}
-            }        
-        } finally {
-			deleteDir()
-        }
-    }
-}
-
 node('words-linux') {
 	cleanWs()
     if (!params.branch.contains("release")) {
-	    runtests("4.2")
-        runtests("5.0")
+        dir('swift') {
+            try {
+                stage('checkout'){
+                    checkout([$class: 'GitSCM', branches: [[name: params.branch]], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'LocalBranch', localBranch: "**"]], submoduleCfg: [], userRemoteConfigs: [[credentialsId: '361885ba-9425-4230-950e-0af201d90547', url: 'https://git.auckland.dynabic.com/words-cloud/words-cloud-sdk-swift.git']]])
+                    withCredentials([usernamePassword(credentialsId: '6839cbe8-39fa-40c0-86ce-90706f0bae5d', passwordVariable: 'AppKey', usernameVariable: 'AppSid')]) {
+                        sh 'mkdir -p Settings'
+                        sh 'echo "{\\"AppSid\\": \\"$AppSid\\",\\"AppKey\\": \\"$AppKey\\", \\"BaseUrl\\": \\"$apiUrl\\"}" > Settings/servercreds.json'
+                    }
+                }
+                
+                docker.image('swift:5.0').inside{
+                    stage('build'){
+                        sh "swift build"
+                    }
+                
+                    stage('tests'){
+                        try{
+                            sh "chmod +x ./Scripts/runTests.sh"
+                            sh "./Scripts/runTests.sh"
+                        } finally{
+                            junit 'tests.xml'
+                        }
+                    }
+                    
+                    stage('clean-compiled'){
+                        sh "rm -rf %s"
+                    }
+                }        
+            } finally {
+                deleteDir()
+            }
+        }
     }
-
 }

README.md

@@ -26,7 +26,7 @@ Add link to this repository as dependency to your Package.swift:
 
 dependencies: [
     // Dependencies declare other packages that this package depends on.
-    .package(url: "https://github.com/aspose-words-cloud/aspose-words-cloud-swift", from: "20.3"),
+    .package(url: "https://github.com/aspose-words-cloud/aspose-words-cloud-swift", from: "20.4"),
 ],
 targets: [
     // Targets are the basic building blocks of a package. A target can define a module or a test suite.

Scripts/runTests.bat

@@ -1 +1 @@
-docker run --rm -v %cd%:/opt/project -w="/opt/project" swift:4.2 /bin/bash Scripts/runTests.sh
+docker run --rm -v %cd%:/opt/project -w="/opt/project" swift:5.0 /bin/bash Scripts/runTests.sh

Scripts/runTests.sh

@@ -1 +1,14 @@
-swift build && swift test
+#!/bin/bash
+swift build && swift test --enable-code-coverage
+report_line=$(llvm-cov report .build/x86_64-unknown-linux/debug/AsposeWordsCloudPackageTests.xctest -instr-profile=.build/x86_64-unknown-linux/debug/codecov/default.profdata | grep "Sources/AsposeWordsCloud/Api/WordsAPI.swift *")
+IFS=' ' read -ra report_splited <<< "$report_line"
+code_coverage=${report_splited[6]}
+echo "Words API code coverage: $code_coverage"
+
+if [[ $code_coverage == "100.00%" ]]
+then
+    echo "OK"
+else
+    echo "Failed: code coverage should be 100.00%"
+    exit 1
+fi

Sources/AsposeWordsCloud/Api/Configuration.swift

@@ -91,6 +91,6 @@ public class Configuration : Codable {
 
     // Returns SDK version for using in statistics headers
     public func getSdkVersion() -> String {
-        return "20.3";
+        return "20.4";
     }
 }

Sources/AsposeWordsCloud/Api/WordsAPI.swift

@@ -39,7 +39,7 @@ public class WordsAPI {
     }
 
     // Initializes a new instance of the WordsAPI class based on AppSid and AppKey.
-    public init(appSid: String, appKey: String) {
+    public init(appSid: String, appKey: String) {        
         self.configuration = Configuration(appSid: appSid, appKey: appKey);
         self.apiInvoker = ApiInvoker(configuration: configuration);
     }
@@ -426,7 +426,7 @@ public class WordsAPI {
     }
 
     // Async representation of convertDocument method
-    // Converts document from the request's content to the specified format .       
+    // Converts document from the request's content to the specified format.       
     public func convertDocument(request : ConvertDocumentRequest, callback : @escaping (_ response : Data?, _ error : Error?) -> ()) {
         do {
             let rawPath = "/words/convert";
@@ -472,7 +472,7 @@ public class WordsAPI {
     }   
 
     // Sync representation of convertDocument method
-    // Converts document from the request's content to the specified format .     
+    // Converts document from the request's content to the specified format.     
     public func convertDocument(request : ConvertDocumentRequest) throws -> Data {
         let semaphore = DispatchSemaphore(value: 0);
         var responseObject : Data? = nil;
@@ -7041,7 +7041,9 @@ public class WordsAPI {
             var rawPath = "/words/{name}/range/{rangeStartIdentifier}/{rangeEndIdentifier}";
             rawPath = rawPath.replacingOccurrences(of: "{name}", with: try ObjectSerializer.serializeToString(value: request.getName()));
             rawPath = rawPath.replacingOccurrences(of: "{rangeStartIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeStartIdentifier()));
-            rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()));
+            if (request.getRangeEndIdentifier() != nil) {
+                rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()!));
+            }
             let urlPath = (try self.configuration.getApiRootUrl()).appendingPathComponent(rawPath);
 
             var urlBuilder = URLComponents(url: urlPath, resolvingAgainstBaseURL: false)!;
@@ -10283,7 +10285,9 @@ public class WordsAPI {
             var rawPath = "/words/{name}/range/{rangeStartIdentifier}/{rangeEndIdentifier}";
             rawPath = rawPath.replacingOccurrences(of: "{name}", with: try ObjectSerializer.serializeToString(value: request.getName()));
             rawPath = rawPath.replacingOccurrences(of: "{rangeStartIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeStartIdentifier()));
-            rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()));
+            if (request.getRangeEndIdentifier() != nil) {
+                rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()!));
+            }
             let urlPath = (try self.configuration.getApiRootUrl()).appendingPathComponent(rawPath);
 
             var urlBuilder = URLComponents(url: urlPath, resolvingAgainstBaseURL: false)!;
@@ -11070,7 +11074,9 @@ public class WordsAPI {
             var rawPath = "/words/{name}/range/{rangeStartIdentifier}/{rangeEndIdentifier}";
             rawPath = rawPath.replacingOccurrences(of: "{name}", with: try ObjectSerializer.serializeToString(value: request.getName()));
             rawPath = rawPath.replacingOccurrences(of: "{rangeStartIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeStartIdentifier()));
-            rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()));
+            if (request.getRangeEndIdentifier() != nil) {
+                rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()!));
+            }
             let urlPath = (try self.configuration.getApiRootUrl()).appendingPathComponent(rawPath);
 
             var urlBuilder = URLComponents(url: urlPath, resolvingAgainstBaseURL: false)!;
@@ -11272,7 +11278,9 @@ public class WordsAPI {
             var rawPath = "/words/{name}/range/{rangeStartIdentifier}/{rangeEndIdentifier}/SaveAs";
             rawPath = rawPath.replacingOccurrences(of: "{name}", with: try ObjectSerializer.serializeToString(value: request.getName()));
             rawPath = rawPath.replacingOccurrences(of: "{rangeStartIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeStartIdentifier()));
-            rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()));
+            if (request.getRangeEndIdentifier() != nil) {
+                rawPath = rawPath.replacingOccurrences(of: "{rangeEndIdentifier}", with: try ObjectSerializer.serializeToString(value: request.getRangeEndIdentifier()!));
+            }
             let urlPath = (try self.configuration.getApiRootUrl()).appendingPathComponent(rawPath);
 
             var urlBuilder = URLComponents(url: urlPath, resolvingAgainstBaseURL: false)!;
@@ -11554,6 +11562,7 @@ public class WordsAPI {
 
             var urlBuilder = URLComponents(url: urlPath, resolvingAgainstBaseURL: false)!;
             var queryItems : [URLQueryItem] = [];
+            queryItems.append(URLQueryItem(name: "format", value: try ObjectSerializer.serializeToString(value: request.getFormat())));
             if (request.getFolder() != nil) {
                 queryItems.append(URLQueryItem(name: "folder", value: try ObjectSerializer.serializeToString(value: request.getFolder()!)));
             }
@@ -11569,9 +11578,6 @@ public class WordsAPI {
             if (request.getDestFileName() != nil) {
                 queryItems.append(URLQueryItem(name: "destFileName", value: try ObjectSerializer.serializeToString(value: request.getDestFileName()!)));
             }
-            if (request.getFormat() != nil) {
-                queryItems.append(URLQueryItem(name: "format", value: try ObjectSerializer.serializeToString(value: request.getFormat()!)));
-            }
             if (request.getFrom() != nil) {
                 queryItems.append(URLQueryItem(name: "from", value: try ObjectSerializer.serializeToString(value: request.getFrom()!)));
             }

Sources/AsposeWordsCloud/Model/ApiError.swift

@@ -42,7 +42,7 @@ public class ApiError : Codable, WordsApiModel {
     // Field of dateTime. Gets or sets server datetime.      
     private var dateTime : Date?;
 
-    // Field of innerError. Gets or sets inner error.      
+    // Field of innerError.       
     private var innerError : ApiError?;
 
     private enum CodingKeys: String, CodingKey {
@@ -128,12 +128,12 @@ public class ApiError : Codable, WordsApiModel {
         return self.dateTime;
     }
 
-    // Sets innerError. Gets or sets inner error.  
+    // Sets innerError.   
     public func setInnerError(innerError : ApiError?) {
         self.innerError = innerError;
     }
 
-    // Gets innerError. Gets or sets inner error.  
+    // Gets innerError.   
     public func getInnerError() -> ApiError? {
         return self.innerError;
     }

Sources/AsposeWordsCloud/Model/BookmarkResponse.swift

@@ -30,7 +30,7 @@ import Foundation
 // This response should be returned by the service when handling:  GET bookmarks/{bookmarkName}.
 public class BookmarkResponse : WordsResponse {
 
-    // Field of bookmark. Gets or sets bookmark.      
+    // Field of bookmark.       
     private var bookmark : Bookmark?;
 
     private enum CodingKeys: String, CodingKey {
@@ -56,12 +56,12 @@ public class BookmarkResponse : WordsResponse {
         }
     }
 
-    // Sets bookmark. Gets or sets bookmark.  
+    // Sets bookmark.   
     public func setBookmark(bookmark : Bookmark?) {
         self.bookmark = bookmark;
     }
 
-    // Gets bookmark. Gets or sets bookmark.  
+    // Gets bookmark.   
     public func getBookmark() -> Bookmark? {
         return self.bookmark;
     }

Sources/AsposeWordsCloud/Model/BookmarksOutlineLevelData.swift

@@ -50,7 +50,7 @@ public class BookmarksOutlineLevelData : Codable, WordsApiModel {
 
         let container = try decoder.container(keyedBy: CodingKeys.self);
         self.name = try container.decodeIfPresent(String.self, forKey: .name);
-        self.bookmarksOutlineLevel = try container.decode(Int.self, forKey: .bookmarksOutlineLevel);
+        self.bookmarksOutlineLevel = try container.decodeIfPresent(Int.self, forKey: .bookmarksOutlineLevel);
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -59,10 +59,9 @@ public class BookmarksOutlineLevelData : Codable, WordsApiModel {
         if (self.name != nil) {
             try container.encode(self.name, forKey: .name);
         }
-        if (self.bookmarksOutlineLevel == nil) {
-            throw WordsApiError.requiredArgumentError(argumentName: "bookmarksOutlineLevel");
+        if (self.bookmarksOutlineLevel != nil) {
+            try container.encode(self.bookmarksOutlineLevel, forKey: .bookmarksOutlineLevel);
         }
-        try container.encode(self.bookmarksOutlineLevel, forKey: .bookmarksOutlineLevel);
     }
 
     // Sets name. Gets or sets specify the bookmark's name.  
@@ -76,12 +75,12 @@ public class BookmarksOutlineLevelData : Codable, WordsApiModel {
     }
 
     // Sets bookmarksOutlineLevel. Gets or sets specify the bookmark's level.  
-    public func setBookmarksOutlineLevel(bookmarksOutlineLevel : Int) {
+    public func setBookmarksOutlineLevel(bookmarksOutlineLevel : Int?) {
         self.bookmarksOutlineLevel = bookmarksOutlineLevel;
     }
 
     // Gets bookmarksOutlineLevel. Gets or sets specify the bookmark's level.  
-    public func getBookmarksOutlineLevel() -> Int {
-        return self.bookmarksOutlineLevel!;
+    public func getBookmarksOutlineLevel() -> Int? {
+        return self.bookmarksOutlineLevel;
     }
 }

Sources/AsposeWordsCloud/Model/BookmarksResponse.swift

@@ -30,7 +30,7 @@ import Foundation
 // This response should be returned by the service when handling:  GET bookmarks.
 public class BookmarksResponse : WordsResponse {
 
-    // Field of bookmarks. Gets or sets bookmarks which are contained in document.      
+    // Field of bookmarks.       
     private var bookmarks : Bookmarks?;
 
     private enum CodingKeys: String, CodingKey {
@@ -56,12 +56,12 @@ public class BookmarksResponse : WordsResponse {
         }
     }
 
-    // Sets bookmarks. Gets or sets bookmarks which are contained in document.  
+    // Sets bookmarks.   
     public func setBookmarks(bookmarks : Bookmarks?) {
         self.bookmarks = bookmarks;
     }
 
-    // Gets bookmarks. Gets or sets bookmarks which are contained in document.  
+    // Gets bookmarks.   
     public func getBookmarks() -> Bookmarks? {
         return self.bookmarks;
     }