(chore): add new feature list as well as update demo app to show these features (#209)

* add new feature list as well as update demo app to show these features

* take out custom to see if coveralls goes up

* slight refactor for swift test app

Author: thomaszurkan-optimizely

CHANGELOG.md

@@ -1,17 +1,18 @@
 # Optimizely Swift SDK Changelog
 
-## 3.1.0-RC
-Date
+## 3.1.0-beta
+May 28, 2019
 
 This the initial release of the Swift SDK. It is a pure Swift implementation take complete advantage of language features and performance.  It supports objective-C as well through objective-c only API. It uses Swift 4.2 but we will be upgrading to 5.0 soon.
 
 This modernized version of the SDK is meant to replace the Objective-C SDK.
 
 ### New Features
-* No new features for this release. It supports all of the 3.1 features in all of Optimizély's SDKs.
+* By default the datafile handler does updates every 10 minutes when the application is in the foreground.  To disable this, set the periodicUpdateInterval to zero.  If you do allow for polling, the project will update automatically when a new datafile change is received. 
+* On top of the above functionality, the developer may register for a datafile change notification.  This notification will be called anytime a new datafile is downloaded to cache and is used to reinitialize the optimizely client automatically.
+* The event handler batches events and will run every 5 minutes in the foreground to send events. 
 
 ### Bug Fixes:
-* Change all instances of attributes and eventTags from NSDictionary<NSString*,NSObject*> to NSDictionary<NSString*,id>
 
 ### Breaking Changes
 

DemoSwiftApp/AppDelegate.swift

@@ -50,14 +50,16 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         //     - initialize immediately with the given JSON datafile or its cached copy
         //     - no network delay, but the local copy is not guaranteed to be in sync with the server experiment settings
 
-        initializeOptimizelySDKAsynchronous()
+        initializeOptimizelySDKWithCustomization()
     }
 
     // MARK: - Initialization Examples
 
     func initializeOptimizelySDKAsynchronous() {
         optimizely = OptimizelyClient(sdkKey: sdkKey, defaultLogLevel: logLevel)
-        
+
+        addListeners()
+
         optimizely.start { result in
             switch result {
             case .failure(let error):
@@ -76,10 +78,13 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         }
 
         optimizely = OptimizelyClient(sdkKey: sdkKey, defaultLogLevel: logLevel)
+        
+        addListeners()
 
         do {
             let datafileJSON = try String(contentsOfFile: localDatafilePath, encoding: .utf8)
             try optimizely!.start(datafile: datafileJSON)
+            
             print("Optimizely SDK initialized successfully!")
         } catch {
             print("Optimizely SDK initiliazation failed: \(error)")
@@ -101,14 +106,30 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                                        periodicDownloadInterval: customDownloadIntervalInSecs,
                                        defaultLogLevel: logLevel)
 
+
+        addListeners()
+        
+        // initialize SDK
+        optimizely!.start { result in
+            switch result {
+            case .failure(let error):
+                print("Optimizely SDK initiliazation failed: \(error)")
+            case .success:
+                print("Optimizely SDK initialized successfully!")
+            }
+            self.startWithRootViewController()
+        }
+    }
+    
+    func addListeners() {
         // notification listeners
 
         _ = optimizely.notificationCenter.addDecisionNotificationListener(decisionListener: { (type, userId, attributes, decisionInfo) in
             print("Received decision notification: \(type) \(userId) \(String(describing: attributes)) \(decisionInfo)")
-         })
+        })
 
         _ = optimizely.notificationCenter.addTrackNotificationListener(trackListener: { (eventKey, userId, attributes, eventTags, event) in
-            print("Received track notification: \(eventKey) \(userId) \(String(describing: attributes)) \(String(describing: eventTags)) \(event)")            
+            print("Received track notification: \(eventKey) \(userId) \(String(describing: attributes)) \(String(describing: eventTags)) \(event)")
         })
 
         _ = optimizely.notificationCenter.addDatafileChangeNotificationListener(datafileListener: { (data) in
@@ -130,19 +151,6 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                 }
             }
         })
-
-        // initialize SDK
-        
-        optimizely!.start { result in
-            switch result {
-            case .failure(let error):
-                print("Optimizely SDK initiliazation failed: \(error)")
-            case .success:
-                print("Optimizely SDK initialized successfully!")
-            }
-            
-            self.startWithRootViewController()
-        }
     }
 
     // MARK: - ViewControl