ibm-swift / alert-notification-sdk Goto Github PK

See https://ibmnotifybm.mybluemix.net/docs/alerts/v1/.

• Add details about the API for the SDK to the README.
• Add relevant documentation to the README and links to the Alert Notification service.
• Add Travis CI build badges to the README.
• Add OS (masOS and Linux) badges to the README.

See https://ibmnotifybm.mybluemix.net/docs/alerts/v1/.

• Avoid force unwrapping variables. For instance, the following:

 if callback != nil {
   callback!(...)

can be rewritten as:

 callback?(...)

This is applicable to other places in the code such as:

Alert(data: data!)

We can instead have Alert(data: data) inside a block that looks like this if let data = data { }

• Let's make the code more Swifty-like. Instead of the following:

 if error != nil {...}

let's rewrite it as:

 if let error = error {...}

This is applicable to other cases in the code such as:

 if data == nil { ... }

• If the values passed as arguments to the constructor of Message are not valid, let's raise an error.

• Let's rename ServerCredentials to AlertServiceCredentials.

• Would it make sense to make the createSession() method as an extension to URLSession?

• Would it make sense to define AlertURL, Detail, Severity, AlertStatus, and NotificationState as an inner entities inside the Alert class? These entities seem to exist and have meaning only within the context of Alert. Also, if we make AlertStatus an inner entity of Alert, we can then just rename it to Status (same is probably true about AlertURL).

@TheSoundDefense For this task, please reach out to @BDHernand. He can provide you with the necessary guidance to complete the necessary steps.

• Add travis ci badge to README (develop and master).
• Add OS badges
• Add travis.yml

As reference

[![Build Status - Develop](https://travis-ci.org/IBM-Swift/Swift-cfenv.svg?branch=develop)](https://travis-ci.org/IBM-Swift/Swift-cfenv)
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
![Linux](https://img.shields.io/badge/os-linux-green.svg?style=flat)

More references:
https://raw.githubusercontent.com/IBM-Swift/Swift-cfenv/master/README.md
https://github.com/IBM-Swift/Swift-cfenv/blob/master/README.md

Some of the constructors take many paramaters. Here's a few links that can help with this:

• http://stackoverflow.com/questions/6239373/how-to-avoid-too-many-parameters-problem-in-api-design
• http://stackoverflow.com/questions/40264/how-many-constructor-arguments-is-too-many
• https://medium.com/swift-programming/the-builder-pattern-in-swift-770d9cc1ac41#.3dq3ovz03

This includes (hopefully) removing any KituraNet code.

See https://ibmnotifybm.mybluemix.net/docs/messages/v1/.

See https://ibmnotifybm.mybluemix.net/docs/messages/v1/.

As reference, see Swift-cfenv sources: https://github.com/IBM-Swift/Swift-cfenv

Once the first milestone is completed, clone the master branch and create a develop branch. Moving forward we should use the develop branch for any new features and bug fixes.

See https://ibmnotifybm.mybluemix.net/docs/alerts/v1/.

Get familiar with the basic offerings provided by the Alert Notification Service (e.g. types of notifications supported; categorization of alerts; routing of notifications to individuals and/or groups; etc.).

As a reference:

• https://console.ng.bluemix.net/catalog/services/ibm-alert-notification/
• https://www.ng.bluemix.net/docs/services/AlertNotification/index.html
• https://github.com/IBM-Bluemix/alert-notification-helloworld

Using the singleton construct, we can initialize a single HeliumLogger for use in the code, circumventing the potential memory leak we saw previously.

If we can use a single shared session instead of creating a new session for each request, we can remove the bugged finishTasksAndInvalidate() function. I suspect this will allow us to completely remove the KituraNet code and allow us to use pure URLSession on both macOS and Linux.