mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
29705a25ce
- Tweaked how books are passed on update to prevent unassignment if parameter is not provided. - Added books to validation so they show in docs. - Added request/response examples. - Added tests to cover. - Added child book info to shelf info. Review of #1908
136 lines
4.2 KiB
PHP
136 lines
4.2 KiB
PHP
<?php namespace Tests\Api;
|
|
|
|
use BookStack\Entities\Book;
|
|
use BookStack\Entities\Bookshelf;
|
|
use Tests\TestCase;
|
|
|
|
class ShelvesApiTest extends TestCase
|
|
{
|
|
use TestsApi;
|
|
|
|
protected $baseEndpoint = '/api/shelves';
|
|
|
|
public function test_index_endpoint_returns_expected_shelf()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$firstBookshelf = Bookshelf::query()->orderBy('id', 'asc')->first();
|
|
|
|
$resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');
|
|
$resp->assertJson(['data' => [
|
|
[
|
|
'id' => $firstBookshelf->id,
|
|
'name' => $firstBookshelf->name,
|
|
'slug' => $firstBookshelf->slug,
|
|
]
|
|
]]);
|
|
}
|
|
|
|
public function test_create_endpoint()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$books = Book::query()->take(2)->get();
|
|
|
|
$details = [
|
|
'name' => 'My API shelf',
|
|
'description' => 'A shelf created via the API',
|
|
];
|
|
|
|
$resp = $this->postJson($this->baseEndpoint, array_merge($details, ['books' => [$books[0]->id, $books[1]->id]]));
|
|
$resp->assertStatus(200);
|
|
$newItem = Bookshelf::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
|
|
$resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug]));
|
|
$this->assertActivityExists('bookshelf_create', $newItem);
|
|
foreach ($books as $index => $book) {
|
|
$this->assertDatabaseHas('bookshelves_books', [
|
|
'bookshelf_id' => $newItem->id,
|
|
'book_id' => $book->id,
|
|
'order' => $index,
|
|
]);
|
|
}
|
|
}
|
|
|
|
public function test_shelf_name_needed_to_create()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$details = [
|
|
'description' => 'A shelf created via the API',
|
|
];
|
|
|
|
$resp = $this->postJson($this->baseEndpoint, $details);
|
|
$resp->assertStatus(422);
|
|
$resp->assertJson([
|
|
"error" => [
|
|
"message" => "The given data was invalid.",
|
|
"validation" => [
|
|
"name" => ["The name field is required."]
|
|
],
|
|
"code" => 422,
|
|
],
|
|
]);
|
|
}
|
|
|
|
public function test_read_endpoint()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$shelf = Bookshelf::visible()->first();
|
|
|
|
$resp = $this->getJson($this->baseEndpoint . "/{$shelf->id}");
|
|
|
|
$resp->assertStatus(200);
|
|
$resp->assertJson([
|
|
'id' => $shelf->id,
|
|
'slug' => $shelf->slug,
|
|
'created_by' => [
|
|
'name' => $shelf->createdBy->name,
|
|
],
|
|
'updated_by' => [
|
|
'name' => $shelf->createdBy->name,
|
|
]
|
|
]);
|
|
}
|
|
|
|
public function test_update_endpoint()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$shelf = Bookshelf::visible()->first();
|
|
$details = [
|
|
'name' => 'My updated API shelf',
|
|
'description' => 'A shelf created via the API',
|
|
];
|
|
|
|
$resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details);
|
|
$shelf->refresh();
|
|
|
|
$resp->assertStatus(200);
|
|
$resp->assertJson(array_merge($details, ['id' => $shelf->id, 'slug' => $shelf->slug]));
|
|
$this->assertActivityExists('bookshelf_update', $shelf);
|
|
}
|
|
|
|
public function test_update_only_assigns_books_if_param_provided()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$shelf = Bookshelf::visible()->first();
|
|
$this->assertTrue($shelf->books()->count() > 0);
|
|
$details = [
|
|
'name' => 'My updated API shelf',
|
|
];
|
|
|
|
$resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details);
|
|
$resp->assertStatus(200);
|
|
$this->assertTrue($shelf->books()->count() > 0);
|
|
|
|
$resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", ['books' => []]);
|
|
$resp->assertStatus(200);
|
|
$this->assertTrue($shelf->books()->count() === 0);
|
|
}
|
|
|
|
public function test_delete_endpoint()
|
|
{
|
|
$this->actingAsApiEditor();
|
|
$shelf = Bookshelf::visible()->first();
|
|
$resp = $this->deleteJson($this->baseEndpoint . "/{$shelf->id}");
|
|
|
|
$resp->assertStatus(204);
|
|
$this->assertActivityExists('bookshelf_delete');
|
|
}
|
|
} |