Dev - Release prep 3.1.0 (#177)

* add page and limit params

* fix unit tests

* convert let to var

* codable conformance + tests

* default `unpublished` to false if the key is missing

* update to 3.1.0

* update CHANGELOG.md

Author: cjmconie

BLOCKv.podspec

@@ -5,7 +5,7 @@
 
 Pod::Spec.new do |s|
     s.name                  = 'BLOCKv'
-    s.version               = '3.0.1'
+    s.version               = '3.1.0'
     s.summary               = 'The BLOCKv SDK allows you to easily integrate your apps into the BLOCKv Platform.'
     s.homepage              = 'https://blockv.io'
     s.license               = { :type => 'BLOCKv AG', :file => 'LICENSE' }

BlockV/Core/Network/Models/Activity/MessageListModel.swift

@@ -20,15 +20,21 @@ public struct MessageListModel: Equatable {
      */
 
     // Inner model
-    struct InnerModel: Decodable {
+    struct InnerModel: Codable {
         let message: MessageModel
 //        let whenModified: Date
 
         enum CodingKeys: String, CodingKey {
             case message
-            case whenModified = "when_modified"
+//            case whenModified = "when_modified"
         }
 
+        init(message: MessageModel) {
+            self.message = message
+        }
+
+        // MARK: - Codable
+
         init(from decoder: Decoder) throws {
             let container = try decoder.container(keyedBy: CodingKeys.self)
             self.message = try container.decode(MessageModel.self, forKey: .message)
@@ -37,12 +43,17 @@ public struct MessageListModel: Equatable {
 //            whenModified = Date(timeIntervalSince1970: _whenModified / 1000)
         }
 
+        func encode(to encoder: Encoder) throws {
+            var container = encoder.container(keyedBy: CodingKeys.self)
+            try container.encode(message, forKey: .message)
+        }
+
     }
 
     /// Filters out all threads more recent than the cursor (useful for paging).
-    public let cursor: String
+    public var cursor: String
     /// Array of messages for the specifed thread.
-    public let messages: [MessageModel]
+    public var messages: [MessageModel]
 
     enum CodingKeys: String, CodingKey {
         case cursor
@@ -51,16 +62,21 @@ public struct MessageListModel: Equatable {
 
 }
 
-extension MessageListModel: Decodable {
+extension MessageListModel: Codable {
 
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         self.cursor = try container.decode(String.self, forKey: .cursor)
-        //print(self.cursor)
         let inner = container.decodeSafelyArray(of: InnerModel.self, forKey: .messages)
-        //print(inner)
         self.messages = inner.map { $0.message }
         print(self.messages)
     }
 
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(cursor, forKey: .cursor)
+        let innerWrapper = messages.map { InnerModel(message: $0) }
+        try container.encode(innerWrapper, forKey: .messages)
+    }
+
 }

BlockV/Core/Network/Models/Activity/ThreadListModel.swift

@@ -15,9 +15,9 @@ import Foundation
 public struct ThreadListModel: Equatable {
 
     /// Filters out all threads more recent than the cursor (useful for paging).
-    public let cursor: String
+    public var cursor: String
     /// Array of threads
-    public let threads: [ThreadModel]
+    public var threads: [ThreadModel]
 
     enum CodingKeys: String, CodingKey {
         case cursor

BlockV/Core/Network/Models/Package/VatomModel.swift

@@ -69,11 +69,11 @@ extension VatomModel: Codable {
         let items = try decoder.container(keyedBy: CodingKeys.self)
         id                = try items.decode(String.self, forKey: .id)
         version           = try items.decode(String.self, forKey: .version)
-        isUnpublished     = try items.decode(Bool.self, forKey: .isUnpublished)
         whenCreated       = try items.decode(Date.self, forKey: .whenCreated)
         whenModified      = try items.decode(Date.self, forKey: .whenModified)
         props             = try items.decode(RootProperties.self, forKey: .props)
-
+        
+        isUnpublished     = try items.decodeIfPresent(Bool.self, forKey: .isUnpublished) ?? false
         `private`         = try items.decodeIfPresent(JSON.self, forKey: .private)
         eos               = try items.decodeIfPresent(JSON.self, forKey: .eos)
         eth               = try items.decodeIfPresent(JSON.self, forKey: .eth)

BlockV/Core/Network/Params/DiscoverQueryBuilder.swift

@@ -37,11 +37,6 @@ public class DiscoverQueryBuilder {
 
     // - Public
 
-    /*
-     Page and limit are not yet documented by the backend.
-     They will be added in a later release.
-     */
-
     /// The page to return.
     ///
     /// Note: This property should only be use in conjunction with a non-zero `limit`
@@ -53,15 +48,15 @@ public class DiscoverQueryBuilder {
     /// "page": 1,
     /// "limit" : 10
     /// ```
-//    public var page: Int = 0
+    public var page: Int = 0
 
     /// Limits the number of vAtoms returned in the response.
     ///
     /// Defaults to zero - which enusres *all* results are returned.
     ///
     /// Note that the API will return a maximum of 1000 vAtoms. The `page`
     /// property should be used to traverse the colleciton further.
-//    public var limit: Int = 0
+    public var limit: Int = 0
 
     // - Private
 
@@ -173,6 +168,8 @@ extension DiscoverQueryBuilder: DictionaryCodable {
             payload["filters"] = [["filter_elems": filterElems]] // filters is an array, the first element is
         }
         payload["return"] = self.resultStructure
+        payload["limit"] = self.limit
+        payload["page"] = self.page
 
         return payload
 

CHANGELOG.md

@@ -2,6 +2,7 @@
 All notable changes to this project will be documented in this file.
 
 #### 3.x Release (API v1)
+- `3.1.x` Releases - [3.1.0](#310)
 - `3.0.x` Releases - [3.0.0](#300)
 
 #### 2.x Releases (API v1)
@@ -19,6 +20,24 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [3.1.0](https://github.com/BLOCKvIO/ios-sdk/releases/tag/3.1.0)
+
+### Updated
+
+- Add `Codable` conformance to `MessageListModel`.  
+- Convert `cursor` and `messages` properties on `MessageListModel` from `let` to `var` . 
+- Convert `cursor` and `threads` properties on  `MessageListModel`  from `let` to `var`.
+    - Pull Request [#175](https://github.com/BLOCKvIO/ios-sdk/pull/175)
+    
+- Add `page` and `limit` properties to `DiscoverQueryBuilder` to allow for paging.
+    - Pull Request [#173](https://github.com/BLOCKvIO/ios-sdk/pull/173/files)
+
+### Fixed
+
+- Default `isPublished` is `false`. This allows vAtoms with a missing `unpublished` JSON key to be decoded.
+    - Pull Request [#176](https://github.com/BLOCKvIO/ios-sdk/pull/176)
+
+
 ## [3.0.0](https://github.com/BLOCKvIO/ios-sdk/releases/tag/3.0.0)
 
 ### Added

Example/BLOCKv Unit Tests/Face Selection Procedure/FaceSelectionProcedure_Tests.swift

@@ -13,78 +13,78 @@ import XCTest
 @testable import BLOCKv
 
 class FaceSelectionProcedure_Tests: XCTestCase {
-    
+
     //TODO: Replace with official blockv decoder
     lazy private var decoder: JSONDecoder = {
         let decoder = JSONDecoder()
         decoder.dateDecodingStrategy = .iso8601
         return decoder
     }()
-    
+
     override func setUp() {
         super.setUp()
         // Put setup code here. This method is called before the invocation of each test method in the class.
     }
-    
+
     override func tearDown() {
         // Put teardown code here. This method is called after the invocation of each test method in the class.
         super.tearDown()
     }
-    
+
     // MARK: - Tests
-    
+
     ///TODO: This does not yet test whether the native face is installed.
     func testEmbeddedIconSelectionProcedure() {
-        
+
         do {
-            
+
             // decode json into face models
             let faceModels = try decoder.decode([FaceModel].self, from: MockModelFaces.genericIconAnd3D)
             XCTAssertEqual(faceModels.count, 2)
-            
+
             // decode json into a vatom model
             var vatomModel = try decoder.decode(VatomModel.self, from: MockModel.VatomModel.basicVatom)
             vatomModel.faceModels = faceModels
-            
+
             let possibleBestFaceForIcon = EmbeddedProcedure.icon.procedure(vatomModel,
                                                                            ["native://image", "native://generic-3d"])
-            
+
             let bestFaceForIcon = try self.require(possibleBestFaceForIcon)
             XCTAssertEqual(bestFaceForIcon.id, "bbbb")
-            
+
         } catch {
             XCTFail(error.localizedDescription)
         }
-        
+
     }
-    
+
     func testEmbeddedCardSelectionProcedure() {
-        
+
         do {
             // decode json into pack model
             let faceModels = try decoder.decode([FaceModel].self, from: MockModelFaces.genericIconAnd3D)
             XCTAssertEqual(faceModels.count, 2)
-            
+
             // decode json into a vatom model
             var vatomModel = try decoder.decode(VatomModel.self, from: MockModel.VatomModel.basicVatom)
             vatomModel.faceModels = faceModels
-            
+
             let possibleBestFaceForCard = EmbeddedProcedure.card.procedure(vatomModel,
                                                                            ["native://image", "native://generic-3d"])
             let bestFaceForCard = try self.require(possibleBestFaceForCard)
             XCTAssertEqual(bestFaceForCard.id, "aaaa")
-            
+
         } catch {
             XCTFail(error.localizedDescription)
         }
-        
+
     }
-    
+
     func testPerformanceExample() {
         // This is an example of a performance test case.
         self.measure {
             // Put the code you want to measure the time of here.
         }
     }
-    
+
 }