NOW MANAGED ON CODEBERG
API: Added cover to book/shelf list endpoints
Dan Brown7e1a8e5ec676
diff --git a/app/Entities/Controllers/BookApiController.php b/app/Entities/Controllers/BookApiController.phpindex c1e38e72f..a617ee2da 100644--- a/app/Entities/Controllers/BookApiController.php+++ b/app/Entities/Controllers/BookApiController.php@@ -30,6 +30,7 @@ class BookApiController extends ApiController{$books = $this->queries->visibleForList()+ ->with(['cover:id,name,url'])->addSelect(['created_by', 'updated_by']);return $this->apiListingResponse($books, [diff --git a/app/Entities/Controllers/BookshelfApiController.php b/app/Entities/Controllers/BookshelfApiController.phpindex a665bcb6b..b512f2d05 100644--- a/app/Entities/Controllers/BookshelfApiController.php+++ b/app/Entities/Controllers/BookshelfApiController.php@@ -26,6 +26,7 @@ class BookshelfApiController extends ApiController{$shelves = $this->queries->visibleForList()+ ->with(['cover:id,name,url'])->addSelect(['created_by', 'updated_by']);return $this->apiListingResponse($shelves, [diff --git a/dev/api/responses/books-list.json b/dev/api/responses/books-list.jsonindex 0f8458fed..50c8c49e6 100644--- a/dev/api/responses/books-list.json+++ b/dev/api/responses/books-list.json@@ -9,7 +9,8 @@"updated_at": "2019-12-11T20:57:31.000000Z","created_by": 1,"updated_by": 1,- "owned_by": 1+ "owned_by": 1,+ "cover": null},{"id": 2,@@ -20,7 +21,12 @@"updated_at": "2019-12-11T20:57:23.000000Z","created_by": 4,"updated_by": 3,- "owned_by": 3+ "owned_by": 3,+ "cover": {+ "id": 11,+ "name": "cat_banner.jpg",+ "url": "https://example.com/uploads/images/cover_book/2021-10/cat-banner.jpg"+ }}],"total": 14diff --git a/dev/api/responses/shelves-list.json b/dev/api/responses/shelves-list.jsonindex 4b1a1b43f..d5debfaef 100644--- a/dev/api/responses/shelves-list.json+++ b/dev/api/responses/shelves-list.json@@ -9,7 +9,12 @@"updated_at": "2020-04-10T13:00:45.000000Z","created_by": 4,"updated_by": 1,- "owned_by": 1+ "owned_by": 1,+ "cover": {+ "id": 4,+ "name": "shelf.jpg",+ "url": "https://example.com/uploads/images/cover_bookshelf/2024-12/shelf.jpg"+ }},{"id": 9,@@ -20,7 +25,8 @@"updated_at": "2020-04-10T13:00:58.000000Z","created_by": 4,"updated_by": 1,- "owned_by": 1+ "owned_by": 1,+ "cover": null},{"id": 10,@@ -31,7 +37,8 @@"updated_at": "2020-04-10T13:00:53.000000Z","created_by": 4,"updated_by": 1,- "owned_by": 4+ "owned_by": 4,+ "cover": null}],"total": 3diff --git a/tests/Api/BooksApiTest.php b/tests/Api/BooksApiTest.phpindex 0de98dc32..084cb59bd 100644--- a/tests/Api/BooksApiTest.php+++ b/tests/Api/BooksApiTest.php@@ -3,6 +3,7 @@namespace Tests\Api;use BookStack\Entities\Models\Book;+use BookStack\Entities\Repos\BaseRepo;use Carbon\Carbon;use Illuminate\Support\Facades\DB;use Tests\TestCase;@@ -27,6 +28,28 @@ class BooksApiTest extends TestCase'owned_by' => $firstBook->owned_by,'created_by' => $firstBook->created_by,'updated_by' => $firstBook->updated_by,+ 'cover' => null,+ ],+ ]]);+ }++ public function test_index_endpoint_includes_cover_if_set()+ {+ $this->actingAsApiEditor();+ $book = $this->entities->book();++ $baseRepo = $this->app->make(BaseRepo::class);+ $image = $this->files->uploadedImage('book_cover');+ $baseRepo->updateCoverImage($book, $image);++ $resp = $this->getJson($this->baseEndpoint . '?filter[id]=' . $book->id);+ $resp->assertJson(['data' => [+ [+ 'id' => $book->id,+ 'cover' => [+ 'id' => $book->cover->id,+ 'url' => $book->cover->url,+ ],],]]);}diff --git a/tests/Api/ShelvesApiTest.php b/tests/Api/ShelvesApiTest.phpindex be276e110..ba13c0153 100644--- a/tests/Api/ShelvesApiTest.php+++ b/tests/Api/ShelvesApiTest.php@@ -4,6 +4,7 @@ namespace Tests\Api;use BookStack\Entities\Models\Book;use BookStack\Entities\Models\Bookshelf;+use BookStack\Entities\Repos\BaseRepo;use Carbon\Carbon;use Illuminate\Support\Facades\DB;use Tests\TestCase;@@ -28,6 +29,28 @@ class ShelvesApiTest extends TestCase'owned_by' => $firstBookshelf->owned_by,'created_by' => $firstBookshelf->created_by,'updated_by' => $firstBookshelf->updated_by,+ 'cover' => null,+ ],+ ]]);+ }++ public function test_index_endpoint_includes_cover_if_set()+ {+ $this->actingAsApiEditor();+ $shelf = $this->entities->shelf();++ $baseRepo = $this->app->make(BaseRepo::class);+ $image = $this->files->uploadedImage('shelf_cover');+ $baseRepo->updateCoverImage($shelf, $image);++ $resp = $this->getJson($this->baseEndpoint . '?filter[id]=' . $shelf->id);+ $resp->assertJson(['data' => [+ [+ 'id' => $shelf->id,+ 'cover' => [+ 'id' => $shelf->cover->id,+ 'url' => $shelf->cover->url,+ ],],]]);}diff --git a/tests/Helpers/EntityProvider.php b/tests/Helpers/EntityProvider.phpindex 1897abefa..22e554f74 100644--- a/tests/Helpers/EntityProvider.php+++ b/tests/Helpers/EntityProvider.php@@ -6,6 +6,7 @@ use BookStack\Entities\Models\Book;use BookStack\Entities\Models\Bookshelf;use BookStack\Entities\Models\Chapter;use BookStack\Entities\Models\Entity;+use BookStack\Entities\Models\HasCoverImage;use BookStack\Entities\Models\Page;use BookStack\Entities\Repos\BookRepo;use BookStack\Entities\Repos\BookshelfRepo;