Merge branch 'release/1.0.0'

Author: Todd Appleton

README.md

@@ -1 +1,57 @@
-# ios-swift-sdk
+Address Book for iOS Swift
+==========================
+
+This repo contains a sample address book application for iOS Swift that demonstrates how to use the DreamFactory REST API. It includes new user registration, user login, and CRUD for related tables.
+
+#Getting DreamFactory on your local machine
+
+To download and install DreamFactory, follow the instructions [here](http://wiki.dreamfactory.com/DreamFactory/Installation). Alternatively, you can create a [free hosted developer account](http://www.dreamfactory.com) at www.dreamfactory.com if you don't want to install DreamFactory locally.
+
+#Configuring your DreamFactory instance to run the app
+
+- Enable [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) for development purposes.
+    - In the admin console, navigate to the Config tab and click on CORS in the left sidebar.
+    - Click Add.
+    - Set Origin, Paths, and Headers to *.
+    - Set Max Age to 0.
+    - Allow all HTTP verbs and check the Enabled box.
+    - Click update when you are done.
+    - More info on setting up CORS is available [here](http://wiki.dreamfactory.com/DreamFactory/Tutorials/Enabling_CORS_Access).
+
+- Create a default role for new users and enable open registration
+    - In the admin console, click the Roles tab then click Create in the left sidebar.
+    - Enter a name for the role and check the Active box.
+    - Go to the Access tab.
+    - Add a new entry under Service Access (you can make it more restrictive later).
+        - set Service = All
+        - set Component = *
+        - check all HTTP verbs under Access
+        - set Requester = API
+    - Click Create Role.
+    - Click the Services tab, then edit the user service. Go to Config and enable Allow Open Registration.
+    - Set the Open Reg Role Id to the name of the role you just created.
+    - Make sure Open Reg Email Service Id is blank, so that new users can register without email confirmation.
+    - Save changes.
+
+- Import the package file for the app.
+    - From the Apps tab in the admin console, click Import and click 'Address Book for iOS Swift' in the list of sample apps. The Address Book package contains the application description, schemas, and sample data.
+    - Leave storage service and folder blank. This is a native iOS app so it requires no file storage on the server.
+    - Click the Import button. If successful, your app will appear on the Apps tab. You may have to refresh the page to see your new app in the list.
+    
+- Make sure you have a SQL database service named 'db'. Depending on how you installed DreamFactory you may or may not have a 'db' service already available on your instance. You can add one by going to the Services tab in the admin console and creating a new SQL service. Make sure you set the name to 'db'.
+
+#Running the Address Book app
+
+Almost there! Clone this repo to your local machine then open and run the project with Xcode.
+
+Before running the project you need to edit API_KEY in the file Network/RESTEngine.swift to match the key for your new app. This key can be found by selecting your app from the list on the Apps tab in the admin console.
+
+The default instance URL is localhost:8080. If your instance is not at that path, you can change the default path in Network/RESTEngine.swift.
+
+When the app starts up you can register a new user, or log in as an existing user. Currently the app does not support registering and logging in admin users.
+
+#Additional Resources
+
+More detailed information on the DreamFactory REST API is available [here](http://wiki.dreamfactory.com/DreamFactory/API).
+
+The live API documentation included in the admin console is a great way to learn how the DreamFactory REST API works.

SampleAppSwift/API/NIKApiInvoker.swift

@@ -0,0 +1,207 @@
+//
+//  NIKApiInvoker.swift
+//  SampleAppSwift
+//
+//  Created by Timur Umayev on 1/4/16.
+//  Copyright © 2016 dreamfactory. All rights reserved.
+//
+
+import UIKit
+
+final class NIKApiInvoker {
+
+    let queue = NSOperationQueue()
+    let cachePolicy = NSURLRequestCachePolicy.UseProtocolCachePolicy
+    
+    /**
+     get the shared singleton
+    */
+    static let sharedInstance = NIKApiInvoker()
+    static var __LoadingObjectsCount = 0
+    private init() {
+    }
+    
+    private func updateLoadCountWithDelta(countDelta: Int) {
+        objc_sync_enter(self)
+        NIKApiInvoker.__LoadingObjectsCount += countDelta
+        NIKApiInvoker.__LoadingObjectsCount = max(0, NIKApiInvoker.__LoadingObjectsCount)
+        
+        UIApplication.sharedApplication().networkActivityIndicatorVisible = NIKApiInvoker.__LoadingObjectsCount > 0
+        
+        objc_sync_exit(self)
+    }
+    
+    private func startLoad() {
+        updateLoadCountWithDelta(1)
+    }
+    
+    private func stopLoad() {
+        updateLoadCountWithDelta(-1)
+    }
+    
+    /**
+     primary way to access and use the API
+     builds and sends an async NSUrl request
+     
+     - Parameter path: url to service, general form is <base instance url>/api/v2/<service>/<path>
+     - Parameter method: http verb
+     - Parameter queryParams: varies by call, can be put into path instead of here
+     - Parameter body: request body, varies by call
+     - Parameter headerParams: user should pass in the app api key and a session token
+     - Parameter contentType: json or xml
+     - Parameter completionBlock: block to be executed once call is done
+    */
+    func restPath(path: String, method: String, queryParams: [String: AnyObject]?, body: AnyObject?, headerParams: [String: String]?, contentType: String?, completionBlock: ([String: AnyObject]?, NSError?) -> Void) {
+        let request = NIKRequestBuilder.restPath(path, method: method, queryParams: queryParams, body: body, headerParams: headerParams, contentType: contentType)
+        
+        /*******************************************************************
+        *
+        *  NOTE: apple added App Transport Security in iOS 9.0+ to improve
+        *          security. As of this writing (7/15) all plain text http
+        *          connections fail by default. For more info about App
+        *          Transport Security and how to handle this issue here:
+        *          https://developer.apple.com/library/prerelease/ios/technotes/App-Transport-Security-Technote/index.html
+        *
+        *******************************************************************/
+        
+        // Handle caching on GET requests
+
+        if (cachePolicy == .ReturnCacheDataElseLoad || cachePolicy == .ReturnCacheDataDontLoad) && method == "GET" {
+            let cacheResponse = NSURLCache.sharedURLCache().cachedResponseForRequest(request)
+            let data = cacheResponse?.data
+            if let data = data {
+                let results = try? NSJSONSerialization.JSONObjectWithData(data, options: []) as? [String: AnyObject]
+                completionBlock(results!, nil)
+            }
+        }
+        
+        if cachePolicy == .ReturnCacheDataDontLoad {
+            return
+        }
+        startLoad() // for network activity indicator
+        
+        let date = NSDate()
+        NSURLConnection.sendAsynchronousRequest(request, queue: queue) {(response, response_data, var response_error) -> Void in
+            self.stopLoad()
+            if let response_error = response_error {
+                if let response_data = response_data {
+                    let results = try? NSJSONSerialization.JSONObjectWithData(response_data, options: [])
+                    if let results = results as? [String: AnyObject] {
+                        completionBlock(nil, NSError(domain: response_error.domain, code: response_error.code, userInfo: results))
+                    } else {
+                        completionBlock(nil, response_error)
+                    }
+                } else {
+                    completionBlock(nil, response_error)
+                }
+                return
+            } else {
+                let statusCode = (response as! NSHTTPURLResponse).statusCode
+                if !NSLocationInRange(statusCode, NSMakeRange(200, 99)) {
+                    response_error = NSError(domain: "swagger", code: statusCode, userInfo: try! NSJSONSerialization.JSONObjectWithData(response_data!, options: []) as? [NSObject: AnyObject])
+                    completionBlock(nil, response_error)
+                    return
+                } else {
+                    let results = try! NSJSONSerialization.JSONObjectWithData(response_data!, options: []) as! [String: AnyObject]
+                    if NSUserDefaults.standardUserDefaults().boolForKey("RVBLogging") {
+                        NSLog("fetched results (\(NSDate().timeIntervalSinceDate(date)) seconds): \(results)")
+                    }
+                    completionBlock(results, nil)
+                }
+            }
+        }
+    }
+}
+
+final class NIKRequestBuilder {
+    
+    /**
+     Builds NSURLRequests with the format for the DreamFactory Rest API
+     
+     This will play nice if you want to roll your own set up or use a
+     third party library like AFNetworking to send the REST requests
+     
+     - Parameter path: url to service, general form is <base instance url>/api/v2/<service>/<path>
+     - Parameter method: http verb
+     - Parameter queryParams: varies by call, can be put into path instead of here
+     - Parameter body: request body, varies by call
+     - Parameter headerParams: user should pass in the app api key and a session token
+     - Parameter contentType: json or xml
+     */
+    static func restPath(path: String, method: String, queryParams: [String: AnyObject]?, body: AnyObject?, headerParams: [String: String]?, contentType: String?) -> NSURLRequest {
+        let request = NSMutableURLRequest()
+        var requestUrl = path
+        if let queryParams = queryParams {
+            // build the query params into the URL
+            // ie @"filter" = "id=5" becomes "<url>?filter=id=5
+            let parameterString = queryParams.stringFromHttpParameters()
+            requestUrl = "\(path)?\(parameterString)"
+        }
+        
+        if NSUserDefaults.standardUserDefaults().boolForKey("RVBLogging") {
+            NSLog("request url: \(requestUrl)")
+        }
+        
+        let URL = NSURL(string: requestUrl)!
+        request.URL = URL
+        // The cache settings get set by the ApiInvoker
+        request.timeoutInterval = 30
+        
+        if let headerParams = headerParams {
+            for (key, value) in headerParams {
+                request.setValue(value, forHTTPHeaderField: key)
+            }
+        }
+        
+        request.HTTPMethod = method
+        if let body = body {
+            // build the body into JSON
+            var data: NSData!
+            if body is [String: AnyObject] || body is [AnyObject] {
+                data = try? NSJSONSerialization.dataWithJSONObject(body, options: [])
+            } else if let body = body as? NIKFile {
+                data = body.data
+            } else {
+                data = body.dataUsingEncoding(NSUTF8StringEncoding)
+            }
+            let postLength = "\(data.length)"
+            request.setValue(postLength, forHTTPHeaderField: "Content-Length")
+            request.HTTPBody = data
+            request.setValue(contentType, forHTTPHeaderField: "Content-Type")
+        }
+        
+        return request
+    }
+}
+
+extension String {
+    
+    /** Percent escape value to be added to a URL query value as specified in RFC 3986
+    - Returns: Percent escaped string.
+    */
+    
+    func stringByAddingPercentEncodingForURLQueryValue() -> String? {
+        let characterSet = NSMutableCharacterSet.alphanumericCharacterSet()
+        characterSet.addCharactersInString("-._~")
+        
+        return self.stringByAddingPercentEncodingWithAllowedCharacters(characterSet)
+    }
+}
+
+extension Dictionary {
+    
+    /** Build string representation of HTTP parameter dictionary of keys and objects
+        This percent escapes in compliance with RFC 3986
+    - Returns: String representation in the form of key1=value1&key2=value2 where the keys and values are percent escaped
+    */
+    
+    func stringFromHttpParameters() -> String {
+        let parameterArray = self.map { (key, value) -> String in
+            let percentEscapedKey = (key as! String).stringByAddingPercentEncodingForURLQueryValue()!
+            let percentEscapedValue = (value as! String).stringByAddingPercentEncodingForURLQueryValue()!
+            return "\(percentEscapedKey)=\(percentEscapedValue)"
+        }
+        
+        return parameterArray.joinWithSeparator("&")
+    }
+}

SampleAppSwift/API/NIKFile.swift

@@ -0,0 +1,26 @@
+//
+//  NIKFile.swift
+//  SampleAppSwift
+//
+//  Created by Timur Umayev on 1/4/16.
+//  Copyright © 2016 dreamfactory. All rights reserved.
+//
+
+import UIKit
+
+/**
+ Use this object when building a request with a file. Pass it
+ in as the body of the request to ensure that the file is built
+ and sent up properly, especially with images.
+*/
+class NIKFile {
+    let name: String
+    let mimeType: String
+    let data: NSData
+    
+    init(name: String, mimeType: String, data: NSData) {
+        self.name = name
+        self.mimeType = mimeType
+        self.data = data
+    }
+}