added api functionality to handle book Shelves

diff --git a/app/Http/Controllers/Api/BookshelfApiController.php b/app/Http/Controllers/Api/BookshelfApiController.php
new file mode 100644 (file)
index 0000000..e6379fd
--- /dev/null
+++ b/app/Http/Controllers/Api/BookshelfApiController.php
@@ -0,0 +1,113 @@
+<?php namespace BookStack\Http\Controllers\Api;
+
+use BookStack\Facades\Activity;
+use BookStack\Entities\Repos\BookshelfRepo;
+use BookStack\Entities\Bookshelf;
+use Exception;
+use Illuminate\Http\Request;
+use Illuminate\Validation\ValidationException;
+
+
+class BookshelfApiController extends ApiController
+{
+
+    /**
+     * @var BookshelfRepo
+     */
+    protected $bookshelfRepo;
+
+    protected $rules = [
+        'create' => [
+            'name' => 'required|string|max:255',
+            'description' => 'string|max:1000',
+        ],
+        'update' => [
+            'name' => 'string|min:1|max:255',
+            'description' => 'string|max:1000',
+        ],
+    ];
+
+    /**
+     * BookshelfApiController constructor.
+     * @param BookshelfRepo $bookshelfRepo
+     */
+    public function __construct(BookshelfRepo $bookshelfRepo)
+    {
+        $this->bookshelfRepo = $bookshelfRepo;
+    }
+
+    /**
+     * Get a listing of shelves visible to the user.
+     */
+    public function list()
+    {
+        $shelves = Bookshelf::visible();
+        return $this->apiListingResponse($shelves, [
+            'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'image_id',
+        ]);
+    }
+
+    /**
+     * Create a new shelf in the system.
+     * @throws ValidationException
+     */
+    public function create(Request $request)
+    {
+        $this->checkPermission('bookshelf-create-all');
+        $requestData = $this->validate($request, $this->rules['create']);
+
+        $bookIds = $request->get('books', []);
+
+        $shelf = $this->bookshelfRepo->create($requestData,$bookIds);
+        Activity::add($shelf, 'bookshelf_create', $shelf->id);
+
+        return response()->json($shelf);
+    }
+
+    /**
+     * View the details of a single shelf.
+     */
+    public function read(string $id)
+    {
+        $shelf = Bookshelf::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy'])->findOrFail($id);
+        return response()->json($shelf);
+    }
+
+    /**
+     * Update the details of a single shelf.
+     * @throws ValidationException
+     */
+    public function update(Request $request, string $id)
+    {
+        $shelf = Bookshelf::visible()->findOrFail($id);
+        $this->checkOwnablePermission('bookshelf-update', $shelf);
+
+        $requestData = $this->validate($request, $this->rules['update']);
+
+        $bookIds = $request->get('books', []);
+
+        $shelf = $this->bookshelfRepo->update($shelf, $requestData,$bookIds);
+        Activity::add($shelf, 'bookshelf_update', $shelf->id);
+
+        return response()->json($shelf);
+    }
+
+
+
+    /**
+     * Delete a single shelf from the system.
+     * @param string $id
+     * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\Response
+     * @throws Exception
+     */
+    public function delete(string $id)
+    {
+        $shelf = Bookshelf::visible()->findOrFail($id);
+        $this->checkOwnablePermission('bookshelf-delete', $shelf);
+
+        $this->bookshelfRepo->destroy($shelf);
+        Activity::addMessage('bookshelf-delete', $shelf->name);
+
+        return response('', 204);
+    }
+}
\ No newline at end of file

diff --git a/routes/api.php b/routes/api.php
index 73f2faf793cc7ce344279878d0d12a270f5ecab2..7ca5e66fc1688a3e711897e148f343287829a4b9 100644 (file)
--- a/routes/api.php
+++ b/routes/api.php
@@ -14,3 +14,9 @@ Route::post('books', 'BooksApiController@create');
 Route::get('books/{id}', 'BooksApiController@read');
 Route::put('books/{id}', 'BooksApiController@update');
 Route::delete('books/{id}', 'BooksApiController@delete');
+
+Route::get('shelves', 'BookshelfApiController@list');
+Route::post('shelves', 'BookshelfApiController@create');
+Route::get('shelves/{id}', 'BookshelfApiController@read');
+Route::put('shelves/{id}', 'BookshelfApiController@update');
+Route::delete('shelves/{id}', 'BookshelfApiController@delete');
\ No newline at end of file