Improvements for API v1.2

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is mostly based on [Keep a Changelog](https://keepachangelog.com/en/1
 # Unreleased
 ## [18.x.x]
 ### Changed
+- Add routes for starring/unstarring items by id
 
 ### Fixed
 

appinfo/routes.php

@@ -66,6 +66,11 @@
 ['name' => 'folder_api_v2#update', 'url' => '/api/v2/folders/{folderId}', 'verb' => 'PATCH'],
 ['name' => 'folder_api_v2#delete', 'url' => '/api/v2/folders/{folderId}', 'verb' => 'DELETE'],
 
+// API 1.3
+
+['name' => 'item_api#star_by_item_id', 'url' => '/api/v1-3/items/{itemId}/star', 'verb' => 'POST'],
+['name' => 'item_api#unstar_by_item_id', 'url' => '/api/v1-3/items/{itemId}/unstar', 'verb' => 'POST'],
+
 // API 1.2
 ['name' => 'utility_api#version', 'url' => '/api/v1-2/version', 'verb' => 'GET'],
 ['name' => 'utility_api#status', 'url' => '/api/v1-2/status', 'verb' => 'GET'],

lib/Controller/ApiController.php

@@ -82,7 +82,7 @@ protected function getUserId()
     public function index(): array
     {
         return [
-            'apiLevels' => ['v1-2', 'v2']
+            'apiLevels' => ['v1-2', 'v1-3', 'v2']
         ];
     }
 }

lib/Controller/ItemApiController.php

@@ -221,6 +221,25 @@ private function setStarred(int $feedId, string $guidHash, bool $isStarred)
     }
 
 
+    /**
+     * @param int  $itemId
+     * @param bool $isStarred
+     *
+     * @return array|JSONResponse
+     * @throws ServiceConflictException
+     */
+    private function setStarredByItemId(int $itemId, bool $isStarred)
+    {
+        try {
+            $this->itemService->star($this->getUserId(), $itemId, $isStarred);
+        } catch (ServiceNotFoundException $ex) {
+            return $this->error($ex, Http::STATUS_NOT_FOUND);
+        }
+
+        return [];
+    }
+
+
     /**
      * @NoAdminRequired
      * @NoCSRFRequired
@@ -255,6 +274,38 @@ public function unstar(int $feedId, string $guidHash)
     }
 
 
+    /**
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     * @CORS
+     *
+     * @param int $itemId
+     *
+     * @return array|JSONResponse
+     * @throws ServiceConflictException
+     */
+    public function starByItemId(int $itemId)
+    {
+        return $this->setStarredByItemId($itemId, true);
+    }
+
+
+    /**
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     * @CORS
+     *
+     * @param int $itemId
+     *
+     * @return array|JSONResponse
+     * @throws ServiceConflictException
+     */
+    public function unstarByItemId(int $itemId)
+    {
+        return $this->setStarredByItemId($itemId, false);
+    }
+
+
     /**
      * @NoAdminRequired
      *

tests/Unit/Controller/ItemApiControllerTest.php

@@ -499,4 +499,22 @@ public function testUnstarMultiple()
     }
 
 
+    public function testStarByItemId()
+    {
+        $this->itemService->expects($this->once())
+            ->method('star')
+            ->with($this->uid, 123, true);
+
+        $this->class->starByItemId(123);
+    }
+
+
+    public function testUnstarByItemId()
+    {
+        $this->itemService->expects($this->once())
+            ->method('star')
+            ->with($this->uid, 123, false);
+
+        $this->class->unstarByItemId(123);
+    }
 }