Merge pull request #4 from NobodyNada/feature/apiresponse-class

Feature/apiresponse class

Sources/APIClient.swift

@@ -46,6 +46,9 @@ open class APIClient: NSObject, URLSessionDataDelegate {
 	///Which API filter to use if none is specified.
 	open var defaultFilter: String?
 
+	///Whether to use a secure connection to communicate with the API.
+	open var useSSL: Bool = true
+
 	///Which site to use if none is specified.
 	open var defaultSite: String = "stackoverflow"
 
@@ -91,11 +94,11 @@ open class APIClient: NSObject, URLSessionDataDelegate {
 	///
 	///- parameter request: The request to make, for example `users/{ids}/answers`.
 	///- parameter parameters: Parameters to be URLEncoded into the request.
-	open func performAPIRequest(
+	open func performAPIRequest<T>(
 		_ request: String,
 		_ parameters: [String:String] = [:],
 		backoffBehavior: BackoffBehavior = .wait
-		) throws -> [Any] {
+		) throws -> APIResponse<T> {
 
 		var params = parameters
 
@@ -111,9 +114,12 @@ open class APIClient: NSObject, URLSessionDataDelegate {
 		if params["site"] == nil {
 			params["site"] = defaultSite
 		}
+		else if params["site"] == "" {
+			params["site"] = nil
+		}
 
 		//Build the URL.
-		var url = "https://api.stackexchange.com/2.2"
+		var url = "\(useSSL ? "http" : "https")://api.stackexchange.com/2.2"
 
 		let prefixedRequest = (request.hasPrefix("/") ? request : "/" + request)
 		url += prefixedRequest
@@ -151,19 +157,22 @@ open class APIClient: NSObject, URLSessionDataDelegate {
 			throw APIError.notDictionary(response: response)
 		}
 
-		if let backoff = json["backoff"] as? Int {
+		let apiResponse = APIResponse<T>(dictionary: json)
+
+		if let backoff = apiResponse.backoff {
 			backoffs[backoffName] = Date().addingTimeInterval(TimeInterval(backoff))
 		}
 		cleanBackoffs()
 
-		guard json["error_id"] == nil, json["error_message"] == nil else {
+		guard apiResponse.error_id == nil, apiResponse.error_message == nil else {
 			throw APIError.apiError(id: json["error_id"] as? Int, message: json["error_message"] as? String)
 		}
 
-		maxQuota = (json["quota_max"] as? Int) ?? maxQuota
-		quota = (json["quota_remaining"] as? Int) ?? quota
 
-		return (json["items"] as? [Any]) ?? []
+		maxQuota = apiResponse.quota_max ?? maxQuota
+		quota = apiResponse.quota_remaining ?? quota
+
+		return apiResponse
 	}
 
 	internal func wait(until date: Date) {

Sources/APIResponse.swift

@@ -0,0 +1,123 @@
+//
+//  APIResponse.swift
+//  SwiftStack
+//
+//  Created by FelixSFD on 11.12.16.
+//
+//
+
+import Foundation
+
+/**
+ The common wrapper object that is returned by the StackExchange API.
+
+ - authors: FelixSFD, NobodyNada
+
+ - seealso: [StackExchange API](https://api.stackexchange.com/docs/wrapper)
+ */
+public class APIResponse<T: JsonConvertible>: JsonConvertible {
+
+    // - MARK: Items
+
+    /**
+     The items that are returned of the generic type `T`.
+
+     - note: It's always an array. Even if only a single item was requested.
+
+     - author: FelixSFD
+     */
+    public var items: [T]?
+
+
+    // - MARK: Initializers
+
+    /**
+     Basic initializer without default values
+     */
+    public init() {
+
+    }
+
+    public required convenience init?(jsonString json: String) {
+        do {
+            guard let dictionary = try JSONSerialization.jsonObject(with: json.data(using: String.Encoding.utf8)!) as? [String: Any] else {
+                return nil
+            }
+
+            self.init(dictionary: dictionary)
+        } catch {
+            return nil
+        }
+    }
+
+    public required init(dictionary: [String: Any]) {
+        self.backoff = dictionary["backoff"] as? Int
+        self.error_id = dictionary["error_id"] as? Int
+        self.error_message = dictionary["error_message"] as? String
+        self.error_name = dictionary["error_name"] as? String
+        self.has_more = dictionary["has_more"] as? Bool
+		self.page = dictionary["page"] as? Int
+		self.page_size = dictionary["page_size"] as? Int
+		self.quota_remaining = dictionary["quota_remaining"] as? Int
+		self.quota_max = dictionary["quota_max"] as? Int
+		self.total = dictionary["total"] as? Int
+		self.type = dictionary["type"] as? String
+
+
+        //items
+        if let array = dictionary["items"] as? [[String: Any]] {
+			items = array.map { T(dictionary: $0) }
+        }
+
+    }
+
+    // - MARK: JsonConvertible
+
+    public var dictionary: [String: Any] {
+        var dict = [String: Any]()
+
+        dict["backoff"] = backoff
+        dict["error_id"] = error_id
+        dict["error_message"] = error_message
+        dict["error_name"] = error_name
+        dict["has_more"] = has_more
+        dict["page"] = page
+        dict["page_size"] = page_size
+        dict["quota_max"] = quota_max
+        dict["quota_remaining"] = quota_remaining
+        dict["total"] = total
+        dict["type"] = type
+
+        return dict
+    }
+
+    public var jsonString: String? {
+        return (try? JsonHelper.jsonString(from: self)) ?? nil
+    }
+
+
+    // - MARK: Fields
+
+    public var backoff: Int?
+
+    public var error_id: Int?
+
+    public var error_message: String?
+
+    public var error_name: String?
+
+    public var has_more: Bool?
+
+    public var page: Int?
+
+    public var page_size: Int?
+
+    public var quota_max: Int?
+
+    public var quota_remaining: Int?
+
+    public var total: Int?
+
+    public var type: String?
+
+}

Sources/BadgeCount.swift

@@ -86,13 +86,9 @@ public struct BadgeCount: JsonConvertible, CustomStringConvertible {
 
      - author: FelixSFD
      */
-    public init?(dictionary: [String: Any]) {
+    public init(dictionary: [String: Any]) {
         self.bronze = dictionary["bronze"] as? Int
         self.silver = dictionary["silver"] as? Int
         self.gold = dictionary["gold"] as? Int
-
-        if bronze == nil, silver == nil, gold == nil {
-            return nil
-        }
     }
 }

Sources/DictionaryConvertible.swift

@@ -17,7 +17,7 @@ public protocol DictionaryConvertible {
     /**
      Initializes the object from a dictionary
      */
-    init?(dictionary: [String: Any])
+    init(dictionary: [String: Any])
 
     /**
      Returns the dictionary-representation of the object

Sources/Question.swift

@@ -129,7 +129,7 @@ public class Question: Post {
             }
         }
 
-        public init?(dictionary: [String : Any]) {
+        public init(dictionary: [String : Any]) {
             if let timestamp = dictionary["on_date"] as? Double {
                 self.on_date = Date(timeIntervalSince1970: timestamp)
             }

Sources/RequestsSites.swift

@@ -0,0 +1,70 @@
+//
+//  RequestsSites.swift
+//  SwiftStack
+//
+//  Created by FelixSFD on 11.12.16.
+//
+//
+
+import Foundation
+import Dispatch
+
+/**
+This extension contains all requests in the SITES section of the StackExchange API Documentation.
+
+- authors: FelixSFD, NobodyNada
+*/
+public extension APIClient {
+
+	// - MARK: /sites
+    /**
+     Fetches all `Sites` in the Stack Exchange network synchronously.
+
+     - parameter parameters: The dictionary of parameters used in the request
+
+     - parameter backoffBehavior: The behavior when an APIRequest has a backoff
+
+     - returns: The list of sites as `APIResponse<Site>`
+
+     - author: NobodyNada
+     */
+	public func fetchSites(
+		_ parameters: [String:String] = [:],
+		backoffBehavior: BackoffBehavior = .wait) throws -> APIResponse<Site> {
+
+
+		var params = parameters
+		params["site"] = ""
+
+		return try performAPIRequest(
+			"sites",
+			params,
+			backoffBehavior: backoffBehavior
+		)
+	}
+
+    /**
+     Fetches all `Sites` in the Stack Exchange network asynchronously.
+
+     - parameter parameters: The dictionary of parameters used in the request
+
+     - parameter backoffBehavior: The behavior when an APIRequest has a backoff
+
+     - author: FelixSFD
+     */
+    public func fetchSites(_ parameters: [String: String] = [:], backoffBehavior: BackoffBehavior = .wait, completionHandler: @escaping (APIResponse<Site>?, Error?) -> ()) {
+
+        queue.async {
+            var params = parameters
+            params["site"] = ""
+
+            do {
+                let response: APIResponse<Site> = try self.performAPIRequest("sites", params, backoffBehavior: backoffBehavior)
+                completionHandler(response, nil)
+            } catch {
+                completionHandler(nil, error)
+            }
+        }
+    }
+
+}

Sources/Site.swift

@@ -37,7 +37,7 @@ public class Site: JsonConvertible {
 
         // - MARK: Initializers
 
-        public init?(dictionary: [String : Any]) {
+        public init(dictionary: [String : Any]) {
             self.api_site_parameter = dictionary["api_site_parameter"] as? String
             self.name = dictionary["name"] as? String
 
@@ -140,7 +140,7 @@ public class Site: JsonConvertible {
 
         // - MARK: Initializers
 
-        public init?(dictionary: [String : Any]) {
+        public init(dictionary: [String : Any]) {
             self.link_color = dictionary["link_color"] as? String
             self.tag_background_color = dictionary["tag_background_color"] as? String
             self.tag_foreground_color = dictionary["tag_foreground_color"] as? String
@@ -203,7 +203,7 @@ public class Site: JsonConvertible {
 
     }
 
-    public required init?(dictionary: [String : Any]) {
+    public required init(dictionary: [String : Any]) {
         self.aliases = dictionary["aliases"] as? [String]
         self.api_site_parameter = dictionary["api_site_parameter"] as? String
         self.audience = dictionary["audience"] as? String
@@ -243,9 +243,7 @@ public class Site: JsonConvertible {
             var relatedArray = [Related]()
 
             for related in relatedSites {
-                if let tmp = Related(dictionary: related) {
-                    relatedArray.append(tmp)
-                }
+                relatedArray.append(Related(dictionary: related))
             }
 
             if relatedArray.count > 0 {

Sources/User.swift

@@ -109,9 +109,7 @@ public class User: JsonConvertible, CustomStringConvertible {
         self.answer_count = dictionary["answer_count"] as? Int
 
         if let badgeCounts = dictionary["badge_counts"] as? [String: Any] {
-            if let badges = BadgeCount(dictionary: badgeCounts) {
-                self.badge_counts = badges
-            }
+            self.badge_counts = BadgeCount(dictionary: badgeCounts)
         }
 
         if let creationTimestamp = dictionary["creation_date"] as? Double {