Merge pull request contentful#52 from contentful/develop

Develop

Author: loudmouth

CHANGELOG.md

@@ -0,0 +1,48 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/) starting from 1.x releases.
+
+## Unreleased
+
+#### Planned
+- Further iteration on `ContentModellable` protocol.
+
+#### Added
+- Swift'ier API for [Contentful Delivery API Search Parameters](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters)
+- Mechanism for mapping responses to user-defined Swift types when using `QueryOn` queries.
+- Improved link resolving via the new `Link` type
+- Swift 3.1, Xcode 8.3 support.
+
+#### Changed
+- **BREAKING:** `Contentful.Array` is now called `ArrayResponse` to avoid clashing with native Swift arrays.
+
+#### Planned
+- Better support and Swift'ier API for [Images API](https://www.contentful.com/developers/docs/references/images-api/).
+
+#### Changed
+- `fetch` methods no longer return tuples of `(URLSessionTask?, Observable)` and now simply return the observable.
+
+---
+
+## Table of contents
+
+#### 0.x Releases
+- `0.3.x` Releases - [0.3.0](#030) | [0.3.1](#031)
+
+---
+
+## [`0.3.1`](https://github.com/contentful/contentful.swift/releases/tag/0.3.1)
+Released on 2017-02-03.
+
+#### Added
+- Support for installation via Carthage on all of iOS, macOS, tvOS, & watchOS.
+
+---
+
+## [`0.3.0`](https://github.com/contentful/contentful.swift/releases/tag/0.3.0)
+Released 2017-01-08.
+
+#### Changed
+- **BREAKING:** Upgrade to Swift 3 and Xcode 8. Versions of Swift < 3 and Xcode < 8 no longer supported. 
+

Cartfile

@@ -1,3 +1,3 @@
-github "anviking/Decodable" ~> 0.5
 github "JensRavens/Interstellar" ~> 2.0.0
+github "Hearst-DD/ObjectMapper" ~> 2.2
 

Cartfile.private

@@ -1,4 +1,4 @@
-github "krzyzanowskim/CryptoSwift.git" ~> 0.6.7
-github "Quick/Nimble" ~> 5.1.1
+github "krzyzanowskim/CryptoSwift.git" ~> 0.6.8
+github "Quick/Nimble" ~> 6.1.0
 github "venmo/DVR" ~> 1.0.0
 

Cartfile.resolved

@@ -1,5 +1,5 @@
+github "Hearst-DD/ObjectMapper" "2.2.5"
 github "JensRavens/Interstellar" "2.0.0"
-github "Quick/Nimble" "v5.1.1"
-github "anviking/Decodable" "v0.5.1"
-github "krzyzanowskim/CryptoSwift" "0.6.7"
+github "Quick/Nimble" "v6.1.0"
+github "krzyzanowskim/CryptoSwift" "0.6.8"
 github "venmo/DVR" "v1.0.0"

Contentful.podspec

@@ -2,7 +2,7 @@
 
 Pod::Spec.new do |spec|
   spec.name             = "Contentful"
-  spec.version          = "0.3.1"
+  spec.version          = "0.4.0-beta1"
   spec.summary          = "Swift SDK for Contentful's Content Delivery API."
   spec.homepage         = "https://github.com/contentful/contentful.swift/"
   spec.social_media_url = 'https://twitter.com/contentful'
@@ -18,13 +18,15 @@ Pod::Spec.new do |spec|
   spec.requires_arc = true
 
   spec.source_files         = 'Sources/*.swift'
+  
+  spec.frameworks                = 'CoreLocation'
 
   spec.ios.deployment_target     = '8.0'
   spec.osx.deployment_target     = '10.10'
   spec.watchos.deployment_target = '2.0'
   spec.tvos.deployment_target    = '9.0'
 
-  spec.dependency 'Decodable', '~> 0.5'
+  spec.dependency 'ObjectMapper', '~> 2.2'
   spec.dependency 'Interstellar', '~> 2.0.0'
 end
 

Contentful.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@ import PackageDescription
 let package = Package(
     name: "Contentful",
     dependencies: [
-        .Package(url: "https://github.com/anviking/Decodable", majorVersion: 0),
+        .Package(url: "https://github.com/Hearst-DD/ObjectMapper", majorVersion: 2, minorVersion: 2),
         .Package(url: "https://github.com/jensravens/Interstellar", majorVersion: 2)
     ],
     exclude: ["Tests/"]

Package.swift

@@ -0,0 +1,101 @@
+//
+//  ArrayResponse.swift
+//  Contentful
+//
+//  Created by Boris Bügling on 18/08/15.
+//  Copyright © 2015 Contentful GmbH. All rights reserved.
+//
+
+import ObjectMapper
+
+
+internal protocol Array {
+
+    associatedtype ItemType
+
+    var items: [ItemType] { get }
+
+    var limit: UInt { get }
+
+    var skip: UInt { get }
+
+    var total: UInt { get }
+}
+
+/**
+ A list of resources in Contentful
+
+ This is the result type for any request of a collection of resources.
+ See: <https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination>
+**/
+public struct ArrayResponse<ItemType>: Array, ImmutableMappable where ItemType: Resource {
+
+    /// The resources which are part of the given array
+    public let items: [ItemType]
+
+    /// The maximum number of resources originally requested
+    public let limit: UInt
+
+    /// The number of elements skipped when performing the request
+    public let skip: UInt
+
+    /// The total number of resources which matched the original request
+    public let total: UInt
+
+    internal let includedAssets: [Asset]?
+    internal let includedEntries: [Entry]?
+
+    // MARK: <ImmutableMappable>
+
+    public init(map: Map) throws {
+
+        items           = try map.value("items")
+        limit           = try map.value("limit")
+        skip            = try map.value("skip")
+        total           = try map.value("total")
+
+        includedAssets  = try? map.value("includes.Asset")
+        includedEntries = try? map.value("includes.Entry")
+
+        // Annoying workaround for type system not allowing cast of items to [Entry]
+        let entries: [Entry] = items.flatMap { $0 as? Entry }
+
+        let allIncludedEntries = entries + (includedEntries ?? [])
+
+        // Rememember `Entry`s are classes (passed by reference) so we can change them in place
+        for entry in allIncludedEntries {
+            entry.resolveLinks(against: allIncludedEntries, and: (includedAssets ?? []))
+        }
+    }
+
+}
+
+/**
+ A list of Contentful entries that have been mapped to types conforming to `EntryModellable`
+
+ See: <https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination>
+ */
+public struct MappedArrayResponse<ItemType>: Array where ItemType: EntryModellable {
+
+    /// The resources which are part of the given array
+    public let items: [ItemType]
+
+    /// The maximum number of resources originally requested
+    public let limit: UInt
+
+    /// The number of elements skipped when performing the request
+    public let skip: UInt
+
+    /// The total number of resources which matched the original request
+    public let total: UInt
+}
+
+internal extension ArrayResponse where ItemType: Entry {
+
+    internal func toMappedArrayResponse<EntryType: EntryModellable>() -> MappedArrayResponse<EntryType> {
+        let mappedItems = items.flatMap { entry in
+            return EntryType(sys: entry.sys, fields: entry.fields, linkDepth: 20)
+        }
+        return MappedArrayResponse<EntryType>(items: mappedItems, limit: limit, skip: skip, total: total)
+    }
+}

Sources/Array.swift

@@ -7,24 +7,19 @@
 //
 
 import Foundation
+import ObjectMapper
 
 /// An asset represents a media file in Contentful
-public struct Asset: Resource, LocalizedResource {
-    /// System fields
-    public let sys: [String: Any]
+public class Asset: Resource, LocalizedResource {
+
     /// Content fields
-    public var fields: [String:Any] {
+    public var fields: [String:Any]! {
         return Contentful.fields(localizedFields, forLocale: locale, defaultLocale: defaultLocale)
     }
 
-    let localizedFields: [String:[String:Any]]
-    let defaultLocale: String
-
-    /// The unique identifier of this Asset
-    public let identifier: String
+    var localizedFields: [String: [String: Any]]
 
-    /// Resource type ("Asset")
-    public let type: String
+    let defaultLocale: String
 
     /// Currently selected locale
     public var locale: String
@@ -41,4 +36,15 @@ public struct Asset: Resource, LocalizedResource {
 
         throw SDKError.invalidURL(string: "")
     }
+
+    // MARK: - <ImmutableMappable>
+
+    public required init(map: Map) throws {
+        let (locale, localizedFields) = try parseLocalizedFields(map.JSON)
+        self.locale = locale
+        self.defaultLocale = determineDefaultLocale(map.JSON)
+        self.localizedFields = localizedFields
+
+        try super.init(map: map)
+    }
 }