Merge pull request #423 from woocommerce/issue/19-notification-subtype

Filtering WooCommerce Notifications

Author: jleandroperez

Networking/Networking/Model/Note.swift

@@ -38,10 +38,18 @@ public struct Note {
     ///
     public let kind: Kind
 
+    /// Notification.Subtype expressed as a Swift Native enum.
+    ///
+    public let subkind: Subkind?
+
     /// Notification Type.
     ///
     public let type: String?
 
+    /// Notification Subtype.
+    ///
+    public let subtype: String?
+
     /// Associated Resource's URL.
     ///
     public let url: String?
@@ -96,6 +104,7 @@ public struct Note {
                 noticon: String?,
                 timestamp: String,
                 type: String,
+                subtype: String?,
                 url: String?,
                 title: String?,
                 subject: Data,
@@ -111,7 +120,9 @@ public struct Note {
         self.timestamp = timestamp
         self.timestampAsDate = DateFormatter.Defaults.iso8601.date(from: timestamp) ?? Date()
         self.type = type
+        self.subtype = subtype
         self.kind = Kind(rawValue: type) ?? .unknown
+        self.subkind = subtype.flatMap { Subkind(rawValue: $0) }
         self.url = url
         self.title = title
 
@@ -148,6 +159,7 @@ extension Note: Decodable {
         let noticon = container.failsafeDecodeIfPresent(String.self, forKey: .noticon)
         let timestamp = container.failsafeDecodeIfPresent(stringForKey: .timestamp) ?? String()
         let type = container.failsafeDecodeIfPresent(String.self, forKey: .type) ?? String()
+        let subtype = container.failsafeDecodeIfPresent(String.self, forKey: .subtype)
         let url = container.failsafeDecodeIfPresent(String.self, forKey: .url)
         let title = container.failsafeDecodeIfPresent(String.self, forKey: .title)
 
@@ -170,6 +182,7 @@ extension Note: Decodable {
                   noticon: noticon,
                   timestamp: timestamp,
                   type: type,
+                  subtype: subtype,
                   url: url,
                   title: title,
                   subject: subjectAsData,
@@ -194,6 +207,7 @@ extension Note {
         case noticon
         case timestamp
         case type
+        case subtype
         case url
         case title
         case subject
@@ -216,4 +230,10 @@ extension Note {
         case user
         case unknown
     }
+
+    /// Known Notification Subkind(s)
+    ///
+    public enum Subkind: String {
+        case storeReview = "store_review"
+    }
 }

Networking/NetworkingTests/Mapper/NoteListMapperTests.swift

@@ -250,6 +250,15 @@ class NoteListMapperTests: XCTestCase {
         let commentNote = sampleNotes.first(where: { $0.kind == .comment })
         XCTAssertEqual(commentNote?.body[1].kind, .comment)
     }
+
+
+    /// Verifies that the Notification's subtype is properly parsed.
+    ///
+    func testStoreReviewSubtypeIsProperlyParsed() {
+        let storeReview = sampleNotes.first(where: { $0.noteId == 100009 })
+        XCTAssertEqual(storeReview?.subtype, "store_review")
+        XCTAssertEqual(storeReview?.subkind, .storeReview)
+    }
 }
 
 

Networking/NetworkingTests/Responses/notifications-load-all.json

@@ -1228,6 +1228,7 @@
         "id": 100009,
         "note_hash": 987654,
         "type": "comment",
+        "subtype": "store_review",
         "read": 1,
         "noticon": "\uf300",
         "timestamp": "2018-10-19T12:56:47+00:00",

Storage/Storage/Model/MIGRATIONS.md

@@ -3,6 +3,9 @@
 This file documents changes in the WCiOS Storage data model. Please explain any changes to the data model as well as any custom migrations.
 
 ## Model 6
+- @jleandroperez 2018-11-12
+    - New `Note.subtype` property (optional type)
+
 - @thuycopeland 2018-11-8
     - Added new attribute: `isJetpackInstalled`, to site entity
     - Added new attribute: `plan`, to site entity

Storage/Storage/Model/Note+CoreDataProperties.swift

@@ -15,6 +15,7 @@ extension Note {
     @NSManaged public var noticon: String?
     @NSManaged public var timestamp: String?
     @NSManaged public var type: String?
+    @NSManaged public var subtype: String?
     @NSManaged public var url: String?
     @NSManaged public var title: String?
     @NSManaged public var subject: Data?

Storage/Storage/Model/WooCommerce.xcdatamodeld/Model 6.xcdatamodel/contents

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="14460.32" systemVersion="18A391" minimumToolsVersion="Automatic" sourceLanguage="Swift" userDefinedModelVersionIdentifier="">
+<model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="14460.32" systemVersion="18B75" minimumToolsVersion="Automatic" sourceLanguage="Swift" userDefinedModelVersionIdentifier="">
     <entity name="Account" representedClassName="Account" syncable="YES">
         <attribute name="displayName" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="email" optional="YES" attributeType="String" syncable="YES"/>
@@ -17,6 +17,7 @@
         <attribute name="noticon" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="read" attributeType="Boolean" usesScalarValueType="YES" syncable="YES"/>
         <attribute name="subject" optional="YES" attributeType="Binary" syncable="YES"/>
+        <attribute name="subtype" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="timestamp" attributeType="String" syncable="YES"/>
         <attribute name="title" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="type" optional="YES" attributeType="String" syncable="YES"/>
@@ -175,7 +176,7 @@
     </entity>
     <elements>
         <element name="Account" positionX="-200.9765625" positionY="63.5625" width="128" height="120"/>
-        <element name="Note" positionX="-162" positionY="180" width="128" height="240"/>
+        <element name="Note" positionX="-162" positionY="180" width="128" height="255"/>
         <element name="Order" positionX="-20" positionY="27" width="128" height="690"/>
         <element name="OrderCoupon" positionX="-206.01953125" positionY="379.74609375" width="128" height="120"/>
         <element name="OrderItem" positionX="-364.890625" positionY="379.453125" width="128" height="225"/>

WooCommerce/Classes/ViewRelated/Notifications/NotificationsViewController.swift

@@ -22,11 +22,10 @@ class NotificationsViewController: UIViewController {
         return ResultsController<StorageNote>(storageManager: storageManager, sectionNameKeyPath: "normalizedAgeAsString", matching: filter, sortedBy: [descriptor])
     }()
 
-    /// Store Notifications CoreData Filter. IMPORTANT!! This is CLEARLY a quick hack (we can't filter based on the title!)
-    /// TODO: Remove ASAP as soon as the (pending) backend PR is merged
+    /// Store Notifications CoreData Filter.
     ///
     private var filter: NSPredicate {
-        return NSPredicate(format: "type == %@ OR title == 'Product Review'", Note.Kind.storeOrder.rawValue)
+        return NSPredicate(format: "type == %@ OR subtype == %@", Note.Kind.storeOrder.rawValue, Note.Subkind.storeReview.rawValue)
     }
 
     /// Pull To Refresh Support.

Yosemite/Yosemite/Model/Storage/Note+ReadOnlyConvertible.swift

@@ -17,6 +17,7 @@ extension Storage.Note: ReadOnlyConvertible {
         url = note.url
         title = note.title
         type = note.type
+        subtype = note.subtype
         subject = note.subjectAsData
         header = note.headerAsData
         body = note.bodyAsData
@@ -33,6 +34,7 @@ extension Storage.Note: ReadOnlyConvertible {
                     noticon: noticon,
                     timestamp: timestamp ?? "",
                     type: type ?? "",
+                    subtype: subtype,
                     url: url,
                     title: title,
                     subject: subject ?? Data(),

Yosemite/YosemiteTests/Stores/NotificationStoreTests.swift

@@ -283,6 +283,7 @@ private extension NotificationStoreTests {
                     noticon: "\u{f408}",
                     timestamp: "2018-10-22T18:51:33+00:00",
                     type: "comment_like",
+                    subtype: nil,
                     url: "https:\\someurl.sometld",
                     title: "3 Likes",
                     subject: Data(),
@@ -299,6 +300,7 @@ private extension NotificationStoreTests {
                     noticon: "\u{f408}",
                     timestamp: "2018-10-22T18:51:33+00:00",
                     type: "comment_like",
+                    subtype: nil,
                     url: "https:\\someurl.sometld",
                     title: "3 Likes",
                     subject: Data(),