Swiftpack.co - Package - convertigo/c8osdk-ios

C8oSDK iOS

License Travis Status

TOC

Introduction

About SDKs

This is the Convertigo library for native swift iOS

Convertigo Client SDK is a set of libraries used by mobile or Windows desktop applications to access Convertigo Server services. An application using the SDK can easily access Convertigo services such as Sequences and Transactions.

The Client SDK will abstract the programmer from handling the communication protocols, local cache, FullSync off line data management, UI thread management and remote logging. So the developer can focus on building the application.

Client SDK is available for:

This current package is the Native iOS SDK. For others SDKs see official Convertigo Documentation.

About Convertigo Platform

Convertigo Mobility Platform supports native iOS developers. Services brought by the platform are available for iOS clients applications thanks to the Convertigo MBaaS SDK. SDK provides an iOS framework you can use to access Convertigo Server’s services such as:

  • Connectors to back-end data (SQL, NoSQL, REST/SOAP, SAP, - WEB HTML, AS/400, Mainframes)
  • Server Side Business Logic (Protocol transform, Business logic augmentation, ...)
  • Automatic offline replicated databases with FullSync technology
  • Security and access control (Identity managers, LDAP , SAML, oAuth)
  • Server side Cache
  • Push notifications (APND, GCM)
  • Auditing Analytics and logs (SQL, and Google Analytics)

Convertigo Technology Overview

Access Convertigo mBaaS technical documentation

Access Convertigo SDK Documentations

Requirements

  • Cocoapods >= 1.5.3
  • Xcode >= 9.4

Installation

Create a PodFile with :

    use_frameworks!

	target 'MyApp' do
	  pod 'C8oSDK', '2.3.3'
	end

Then type:

$ pod install

Restart Xcode and open the .xcworkspace

And there you go !

Documentation

Full documentation is available here

Initializing a Convertigo Endpoint

You can have as many C8o instance,pointing to a same or different endpoint. Each instance handles its own session and settings. We strongly recommend using a single C8o instance per application because server licensing can based on the number of sessions used.

import C8o

// In swift there is two ways to handle errors :
// We can either choose to don't care about errors using the following syntax (this may produce in case of error an "EXC_BAD_INSTRUCTION")

let c8o : C8o = try! C8o(endpoint: "https://demo.convertigo.net/cems/projects/sampleMobileCtfGallery")
	
// or we can choose to use do/catch syntax that will allow us to catch errors
do{
	let c8o : C8o = try C8o(endpoint: "https://demo.convertigo.net/cems/projects/sampleMobileCtfGallery")
}
catch let e as NSError{
	print(e.description
}
// the C8o instance is ready to interact over https with the demo.convertigo.net server, using sampleMobileUsDirectoryDemo as default project.

Advanced instance settings

The endpoint is the mandatory setting to get a C8o instance, but there is additional settings through the C8oSettings class.
A C8oSettings instance should be passed after the endpoint. Settings are copied inside the C8o instance and a C8oSettings instance can be modified and reused after the C8o constructor.
Setters of C8oSettings always return its own instance and can be chained.
A C8oSettings can be instantiated from an existing C8oSettings or C8o instance.

import C8o
// The common way
var c8o : C8o = try! C8o(endpoint: "https://demo.convertigo.net/cems/projects/sampleMobileCtfGallery", c8oSettings: C8oSettings().setDefaultDatabaseName("mydb_fullsync").setTimeout(30000))

// The verbose way
let endpoint : String = "https://demo.convertigo.net/cems/projects/sampleMobileCtfGallery"
let c8oSettings : C8oSettings = C8oSettings()
c8oSettings.setDefaultDatabaseName("mydb_fullsync")
c8oSettings.setTimeout(30000)
c8o = try! C8o(endpoint: endpoint, c8oSettings: c8oSettings)

// customize existing settings
var customSettings : C8oSettings = C8oSettings(c8oSettings: c8oSettings).setTimeout(60000);
// or from a C8o instance
customSettings = C8oSettings(c8oSettings: c8o).setTimeout(60000);
		
// all settings can be retrieve from a C8o or C8oSettings instance
let timeout : Int = c8o.timeout

Calling a Convertigo Requestable

With a C8o instance you can call Convertigo Sequence and Transaction or make query to your local FullSync database. You must specify the result type you want: an XML Document or a JSON Object response.

Returning JSON:
Just use the c8o.callJson method to request a JSON response.

import SwiftyJSON

// c8o is a C8o instance
let jObject : JSON = try! c8o.callJson(".getSimpleData").sync()!

// You now have JSON object that you can use in your app!

Returning XML:
Just use the c8o.callXml method to request a XML response.

import AEXML

// c8o is a C8o instance
let document : AEXMLDocument = try! c8o.callXml(".getSimpleData").sync()!

Call parameters

The call method expects the requester string of the following syntax:

  • For a transaction: [project].connector.transaction
  • For a sequence: [project].sequence

The project name is optional, i.e. if not specified, the project specified in the endpoint will be used.
Convertigo requestables generally need key/value parameters. The key is always a string and the value can be any object but a string is the standard case.
Here a sample with JSON but this would be the same for XML calls:

// the common way with parameters
let JObject : JSON = try! c8o.callJson(".getSimpleData",
			parameters:
			"firstname", "John",
			"lastname", "Do"
)!.sync()!

// the verbose way
var parameters : Dictionary = Dictionary()
parameters["firstname"] = "John"
parameters["lastname"] = "Do"
let JSONObject : JSON = try! c8o.callJson(".getSimpleData", parameters: parameters)!.sync()!

Working with threads

Maybe you noticed that the calls methods doesn’t return the result directly and that all the sample code chains to the .sync() method.
This is because the call methods return a C8oPromise instance. That allows the developer to choose if he wants to block the current thread, make an async request or get the response in a callback.
The .sync() method locks the current thread and return the result as soon as it’s available. Of course this should not be used in a UI thread as this will result to a frozen UI until data is returned by the server. You should use the .sync() method only in worker threads.

// lock the current thread while the request is done
let JSONObject : JSON = try! c8o.callJson(".getSimpleData")!.sync()!
// the response can be used in this scope

As in many cases, locking the current thread is not recommended, the .then() method allows to register a callback that will be executed on a worker thread.
The .thenUI() method does the same but the callback will be executed on a UI thread. This is useful for quick UI widgets updates.
The .then() and .thenUI() callbacks receives as parameters the response and the request parameters.

// doesn't lock the current thread while the request is done

c8o.callJson(".getSimpleData")?.then({ (response, parameters) -> (C8oPromise?) in
	// the jObject is available, the current code is executed in an another working thread
		
	return nil // return nil for a simple call
})

// following lines are executed immediately, before the end of the request.
		
c8o.callJson(".getSimpleData")?.thenUI({ (response, parameters) -> (C8oPromise?) in
	// the jObject is available, the current code is executed in the UI thread
	self.simpleLabel.text = response.stringValue

	return nil // return nil for a simple call
})

// following lines are executed immediately, before the end of the request.

Chaining calls

The .then() or .thenUI() returns a C8oPromise that can be use to chain other promise methods, such as .then() or .thenUI() or failure handlers.
The last .then() or .thenUI() must return a nil value. .then() or .thenUI() can be mixed but the returning type must be the same: XML or JSON.

c8o.callJson(".getSimpleData", parameters: "callNumber", 1)?.then({ (response, parameters) -> (C8oPromise?) in
	// you can do stuff here and return the next C8oPromise instead of deep nested blocks
	return c8o.callJson(".getSimpleData", parameters: "callNumber", 2)
})?.thenUI({ (response, parameters) -> (C8oPromise?) in
	// you can do stuff here and even modify previous parameters
	var parameters : [String : AnyObject]? = nil
	parameters!["callNumber"] = 3
	parameters!["extraParameter"] = "ok"
	return c8o.callJson(".getSimpleData", parameters: parameters)
})?.then({ (response, parameters) -> (C8oPromise?) in
	// you can do stuff here and return nil because this is the end of the chain
	return nil
})

Handling failures

A call can throw an error for many reasons: technical failure, network error and so on.
The standard do/catch should be used to handle this.
This is the case for the .sync() method: if an exception occurs during the request execution, the original exception is thrown by the method and can be encapsulated in a C8oException.

do{
	try c8o.callJson(".getSimpleData")!.sync()
} catch let Exception as NSError{
	// process the exception
}

When you use the .then() or the .thenUI() methods, the do/catch mechanism can’t catch a “future” exception or throwable: you have to use the .fail() or .failUI() methods at the end on the promise chain.
One fail handler per promise chain is allowed. The fail callback provide the object thrown (like an Exception) and the parameters of the failed request.

c8o.callJson(".getSimpleData", parameters: "callNumber", 1)?.then({ (jObject, parameters) -> (C8oPromise?) in
	return c8o.callJson(".getSimpleData", parameters: "callNumber", 2)
})?.thenUI({ (response, parameters) -> (C8oPromise?) in
	return nil
})?.fail({ (exception, parameters) in
	// exception caught from the first or the second CallJson, can be an Exception
	// this code runs in a worker thread
	//...
})
		
c8o.callJson(".getSimpleData", parameters: "callNumber", 1)?.then({ (jObject, parameters) -> (C8oPromise?) in
	return c8o.callJson(".getSimpleData", parameters: "callNumber", 2)
})?.thenUI({ (jObject, parameters) -> (C8oPromise?) in
	return nil
})?.failUI({ (exception, parameters) in
	// exception caught from the first or the second CallJson, can be an Exception
	// this code runs in a UI thread
	//...
})

Writing the device logs to the Convertigo server

Basic

An application developer usually adds log information in his code. This is useful for the code execution tracking, statistics or debugging.

The Convertigo Client SDK offers an API to easily log on the standard device logger, generally in a dedicated console. To see this console, a device must be physically connected on a computer.

Fortunately, the same API also send log to the Convertigo server and they are merged with the server log. You can easily debug your device and server code on the same screen, on the same timeline. Logs from a device contain metadata, such as the device UUID and can help to filter logs on the server.

A log level must be specified:

  • Fatal: used for critical error message
  • Error: used for common error message
  • Warn: used for not expected case
  • Info: used for high level messages
  • Debug: used for help the developer to understand the execution
  • Trace: used for help the developer to trace the code
  • To write a log string, use the C8oLogger instance of a C8o instance:
do{
    try c8o.log.info("hello world!") // the message can be a simple string
}
catch let e as C8oException{
    c8o.log.error("bye world...", exceptions: e) // the message can also take an Exception argument
}
if(c8o.log.isDebug){ // check if currents log levels are enough
    // enter here only if a log level is 'trace' or 'debug', can prevent unnecessary CPU usage
    let msg : String  = serializeData() // compute a special string, like a Document serialization
    c8o.log.debug(msg)
}

Advanced

A C8oLogger have 2 log levels, one for local logging and the other for the remote logging. With the Android SDK, the local logging is set by the logcat options. With the .Net SDK, the local logging depends of the LogLevelLocal setting of C8oSettings.

The remote logging level is enslaved by Convertigo server Log levels property: devices output logger. In case of failure, the remote logging is disabled and cannot be re-enabled for the current C8o instance. It can also be disabled using the LogRemote setting of C8oSettings, enabled with true (default) and disabled with false.

To monitor remote logging failure, a LogOnFail handler can be registered with the C8oSetting.

The Convertigo Client SDK itself writes logs. They can be turned off using the LogC8o setting of C8oSettings, enabled with true (default) and disabled with false.

C8oSettings()
    .setLogC8o(false)   // disable log from the Convertigo Client SDK itself
    .setLogRemote(false) // disable remote logging
    .setLogLevelLocal(C8oLogLevel.TRACE)
    // or
C8oSettings().setLogOnFail { (exception, parameters) -> (Void) in
    // the exception contains the cause of the remote logging failure
}

Using the Local Cache

Sometimes we would like to use local cache on C8o calls and responses, in order to:

  • save network traffic between the device and the server,
  • be able to display data when the device is not connected to the network.

The Local Cache feature allows to store locally on the device the responses to a C8o call, using the variables and their values as cache key.

To use the Local Cache, add to a call a pair parameter of "__localCache" and a C8oLocalCache instance. The constructor of C8oLocalCache needs some parameters:

  • C8oLocalCache.Priority (SERVER / LOCAL): defines whether the response should be retrieved from local cache or from Convertigo server when the device can access the network. When the device has no network access, the local cache response is used.
  • ttl: defines the time to live of the cached response, in milliseconds. If no value is passed, the time to live is infinite.
  • enabled: allows to enable or disable the local cache on a Convertigo requestable, default value is true.
// return the response if is already know and less than 180 sec else call the server
try! c8o.callJson(".getSimpleData",
        parameters: C8oLocalCache.PARAM, C8oLocalCache(priority: C8oLocalCache.Priority.LOCAL, ttl: 180 * 1000)
)!.sync()
        
// same sample but with parameters, also acting as cache keys
try! c8o.callJson(".getSimpleData",
        parameters: "firstname", "John",
                    "lastname", "Doe",
        C8oLocalCache.PARAM, C8oLocalCache(priority: C8oLocalCache.Priority.LOCAL, ttl: 180 * 1000)
)!.sync()
        
// make a standard network call with the server
// but in case of offline move or network failure
// return the response if is already know and less than 1 hour
try! c8o.callJson(".getSimpleData",
            parameters: C8oLocalCache.PARAM, C8oLocalCache(priority: C8oLocalCache.Priority.SERVER, ttl: 3600 * 1000)
)!.sync()

Using the Full Sync

Full Sync enables mobile apps to handle fully disconnected scenarios, still having data handled and controlled by back end business logic. See the presentation of the Full Sync architecture for more details.

Convertigo Client SDK provides a high level access to local data following the standard Convertigo Sequence paradigm. They differ from standard sequences by a fs:// prefix. Calling these local Full Sync requestable will enable the app to read, write, query and delete data from the local database:

  • fs://.create creates the local database if not already exist
  • fs://.view queries a view from the local database
  • fs://.get reads an object from the local database
  • fs://.post writes/update an object to the local database
  • fs://.delete deletes an object from the local database
  • fs://.all gets all objects from the local database
  • fs://.sync synchronizes with server database
  • fs://.replicate_push pushes local modifications on the database server
  • fs://.replicate_pull gets all database server modifications
  • fs://.reset resets a database by removing all the data in it
  • fs://.put_attachment Puts (add) an attachment to a document in the database
  • fs://.get_attachment Gets an attachment from a document

Where fs:// is the name of a specific FullSync Connector in the project specified in the endpoint. The fs:// name is optional only if the default database name is specified with the method setDefaultDatabaseName on the C8oSetting.

An application can have many databases. On mobile (Android, iOS and Xamarin based) they are stored in the secure storage of the application. On Windows desktop application, they are stored in the user AppData/Local folder, without application isolation.

All platforms can specify a local database prefix that allows many local database copies of the same remote database. Use the method setFullSyncLocalSuffix on the C8oSetting.

c8o.callJson("fs://base.reset")?.then({ (json, parameters) -> (C8oPromise?) in
    // json content:
    // { "ok": true }
    return c8o.callJson("fs://base.post", // creates a new document on "base", with 2 key/value pairs
        parameters: "firstname", "John",
        "lastname", "Doe"
    )
})?.then({ (json, parameters) -> (C8oPromise?) in
    // json content:
    // {
    //   "ok": true,
    //   "id": "6f1b52df",
    //   "rev": "1-b0620371"
    // }
    return c8o.callJson("fs://base.get",
        parameters: "docid", json["id"].stringValue) // retrieves the complet document from its "docid"
})?.then({ (json, parameters) -> (C8oPromise?) in
    // json content:
    // {
    //   "lastname": "Doe",
    //   "rev": "1-b0620371",
    //   "firstname": "John",
    //   "_id": "6f1b52df"
    // }
    c8o.log.info(json.stringValue) // output the document in the log
    return nil
})

Replicating Full Sync databases

FullSync has the ability to replicate mobile and Convertigo server databases over unreliable connections still preserving integrity. Data can be replicated in upload or download or both directions. The replication can also be continuous: a new document is instantaneously replicated to the other side.

The client SDK offers the progress event to monitor the replication progression thanks to a C8oProgress instance.

A device cannot pull private documents or push any document without authentication. A session must be established before and the Convertigo server must authenticate the session (using the Set authenticated user step for example).

// Assuming c8o is a C8o instance properly instanciated and initiated as describe above.

c8o.callJson(".login")?.then({ (json, parameters) -> (C8oPromise?) in  	if(json == "ok"){
		// replication_pull can also be sync or replication_push
		c8o.callJson("fs://base.replication_pull")?.then({ (json, parameters) -> (C8oPromise?) in  // launches a database replication from the server to the device
			// json content:
			// { "ok": true }
			// the documents are retrieved from the server and can be used
			return nil
			
		})?.progress({ (progress) in
			// this code runs after each progression event
			// progress.Total is calculated and grows up then progress.Current increases to the total
			c8o.log.info("progress: " + progress.description)
		})
	}
	return nil
})

Replicating Full Sync databases with continuous flag

As mentioned above, a replication can also be continuous: a new document is instantaneously replicated to the other side.

Progress will be called at each entering replication during the all life of the application until that you explicitly cancel that one

c8o.callJson("fs://base.replication_pull", "continuous", true)?.then({ (json, parameters) -> (C8oPromise?) in  // launches a database replication from the server to the device
			// json content:
			// { "ok": true }
			// the documents are retrieved from the server and can be used
			return nil
			
		})?.progress({ (progress) in
			// this code runs after each progression event
			// progress.Total is calculated and grows up then progress.Current increases to the total
			c8o.log.info("progress: " + progress.description)
		})

Full Sync FS_LIVE requests

Full Sync has the ability to re-execute your fs:// calls if the database is modified. The then or thenUI following a FS_LIVE parameter is re-executed after each database update. Database update can be local modification or remote modification replicated.

This allow you keep your UI synchronized with database documents.

A FS_LIVE parameter must have a string value, its liveid. The liveid allow to cancel a FS_LIVE request.

c8o.callJson("fs://.view",
    parameters: "ddoc", "design",
    "view", "customers",
    C8O.FS_LIVE, "customers")?.thenUI({ (json, parameters) -> (C8oPromise?) in  // launches a live view
    // will be call now and after each database update
    updateCustomersUI(json)
  return nil
})?
…
// cancel the previous FS_LIVE request, can be on application page change for example
c8o.cancelLive("customers")	

Full Sync Change Listener

Full Sync has also the ability to notify your if there is any change on the database. The progress following a FS_LIVE parameter is triggered after each database update. The changes contains the origin of the change, and other attributes :

  • isExternal
  • isCurrentRevision
  • isConflict
  • id
  • revisionId
let changeListener = C8oFullSyncChangeListener(handler: {(changes: JSON) -> () in
    checkChanges(changes)
})
…
c8o.addFullSyncChangeListener("base", changeListener) // add this listener for the database "base" ; null or "" while use the default database.
…
c8o.removeFullSyncChangeListener("base", changeListener) // remove this listener for the database "base" ; null or "" while use the default database.

Building c8osdk-ios

Please see the wiki page

Github

link
Stars: 3
Help us keep the lights on

Dependencies

Used By

Total: 0

Releases

2.3.4 - Jul 26, 2018

2.3.3 - Jul 6, 2018

2.3.2 - Jun 25, 2018

2.3.1 - Jun 5, 2018

2.3.0 - May 31, 2018