Merge pull request #6049 from woocommerce/issue/5953-mark-inbox-note-as-actioned

Mark Inbox Note as actioned from `POST wc-analytics/admin/notes/{{id}}/action/{{action_id}}` - Networking layer

Author: pmusolino

Networking/Networking/Remote/InboxNotesRemote.swift

@@ -16,6 +16,11 @@ public protocol InboxNotesRemoteProtocol {
     func dismissInboxNote(for siteID: Int64,
                           noteID: Int64,
                           completion: @escaping (Result<InboxNote, Error>) -> ())
+
+    func markInboxNoteAsActioned(for siteID: Int64,
+                                 noteID: Int64,
+                                 actionID: Int64,
+                                 completion: @escaping (Result<InboxNote, Error>) -> ())
 }
 
 
@@ -75,7 +80,7 @@ public final class InboxNotesRemote: Remote, InboxNotesRemoteProtocol {
     /// This internally marks a notification’s is_deleted field to true and such notifications do not show in the results anymore.
     ///
     /// - Parameters:
-    ///     - siteID: The site for which we'll fetch InboxNotes.
+    ///     - siteID: The site for which we'll dismiss the InboxNote.
     ///     - noteID: The ID of the note that should be marked as dismissed.
     ///     - completion: Closure to be executed upon completion.
     ///
@@ -93,6 +98,33 @@ public final class InboxNotesRemote: Remote, InboxNotesRemoteProtocol {
 
         enqueue(request, mapper: mapper, completion: completion)
     }
+
+    // MARK: - Set Inbox Note as `actioned`
+
+    /// Set an `InboxNote` as `actioned`.
+    /// This internally marks a notification’s status as `actioned`.
+    ///
+    /// - Parameters:
+    ///     - siteID: The site for which we'll mark the InboxNote as actioned.
+    ///     - noteID: The ID of the note.
+    ///     - actionID: The ID of the action.
+    ///     - completion: Closure to be executed upon completion.
+    ///
+    public func markInboxNoteAsActioned(for siteID: Int64,
+                                        noteID: Int64,
+                                        actionID: Int64,
+                                        completion: @escaping (Result<InboxNote, Error>) -> ()) {
+
+        let request = JetpackRequest(wooApiVersion: .wcAnalytics,
+                                     method: .post,
+                                     siteID: siteID,
+                                     path: Path.notes + "/\(noteID)/action/\(actionID)",
+                                     parameters: nil)
+
+        let mapper = InboxNoteMapper(siteID: siteID)
+
+        enqueue(request, mapper: mapper, completion: completion)
+    }
 }
 
 // MARK: - Constants
@@ -106,7 +138,6 @@ public extension InboxNotesRemote {
 
     private enum Path {
         static let notes = "admin/notes"
-        static let deleteNote = "admin/notes/delete"
     }
 
     private enum ParameterKey {

Networking/NetworkingTests/Remote/InboxNotesRemoteTests.swift

@@ -147,4 +147,54 @@ final class InboxNotesRemoteTests: XCTestCase {
         let resultError = try XCTUnwrap(result.failure as? NetworkError)
         XCTAssertEqual(resultError, .unacceptableStatusCode(statusCode: 500))
     }
+
+    // MARK: - Mark an Inbox Note as `actioned`
+
+    /// Verifies that markInboxNoteAsActioned properly parses the `InboxNote` sample response.
+    ///
+    func test_markInboxNoteAsActioned_properly_returns_parsed_InboxNote() throws {
+        // Given
+        let remote = InboxNotesRemote(network: network)
+        let sampleInboxNoteID: Int64 = 296
+        let sampleActionID: Int64 = 13329
+
+        network.simulateResponse(requestUrlSuffix: "admin/notes/\(sampleInboxNoteID)/action/\(sampleActionID)", filename: "inbox-note")
+
+        // When
+        let result = waitFor { promise in
+            remote.markInboxNoteAsActioned(for: self.sampleSiteID, noteID: sampleInboxNoteID, actionID: sampleActionID) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        XCTAssert(result.isSuccess)
+        let inboxNote = try XCTUnwrap(result.get())
+        XCTAssertEqual(inboxNote.id, sampleInboxNoteID)
+        XCTAssertEqual(inboxNote.actions.first?.id, sampleActionID)
+    }
+
+    /// Verifies that markInboxNoteAsActioned properly relays Networking Layer errors.
+    ///
+    func test_markInboxNoteAsActioned_properly_relays_networking_errors() throws {
+        // Given
+        let remote = InboxNotesRemote(network: network)
+        let sampleInboxNoteID: Int64 = 296
+        let sampleActionID: Int64 = 13329
+
+        let error = NetworkError.unacceptableStatusCode(statusCode: 500)
+        network.simulateError(requestUrlSuffix: "admin/notes/\(sampleInboxNoteID)/action/\(sampleActionID)", error: error)
+
+        // When
+        let result = waitFor { promise in
+            remote.markInboxNoteAsActioned(for: self.sampleSiteID, noteID: sampleInboxNoteID, actionID: sampleActionID) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        XCTAssertTrue(result.isFailure)
+        let resultError = try XCTUnwrap(result.failure as? NetworkError)
+        XCTAssertEqual(resultError, .unacceptableStatusCode(statusCode: 500))
+    }
 }