{

use TestsApi;

protected string $baseEndpoint = '/api/books';

public function test_index_endpoint_returns_expected_book()

{

$this->actingAsApiEditor();

$firstBook = Book::query()->orderBy('id', 'asc')->first();

$resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');

$resp->assertJson(['data' => [

[

'id' => $firstBook->id,

'name' => $firstBook->name,

'slug' => $firstBook->slug,

'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.png');

$baseRepo->updateCoverImage($book, $image);

$resp = $this->getJson($this->baseEndpoint . '?filter[id]=' . $book->id);

$resp->assertJson(['data' => [

[

'id' => $book->id,

'cover' => [

'id' => $book->coverInfo()->getImage()->id,

'url' => $book->coverInfo()->getImage()->url,

],

],

]]);

}

public function test_create_endpoint()

{

$this->actingAsApiEditor();

$templatePage = $this->entities->templatePage();

$details = [

'name' => 'My API book',

'description' => 'A book created via the API',

'default_template_id' => $templatePage->id,

];

$resp = $this->postJson($this->baseEndpoint, $details);

$resp->assertStatus(200);

$newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();

$resp->assertJson(array_merge($details, [

'id' => $newItem->id,

'slug' => $newItem->slug,

'description_html' => '<p>A book created via the API</p>',

]));

$this->assertActivityExists('book_create', $newItem);

}

public function test_create_endpoint_with_html()

{

$this->actingAsApiEditor();

$details = [

'name' => 'My API book',

'description_html' => '<p>A book <em>created</em> <strong>via</strong> the API</p>',

];

$resp = $this->postJson($this->baseEndpoint, $details);

$resp->assertStatus(200);

$newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();

$expectedDetails = array_merge($details, [

'id' => $newItem->id,

'description' => 'A book created via the API',

]);

$resp->assertJson($expectedDetails);

$this->assertDatabaseHasEntityData('book', $expectedDetails);

}

public function test_book_name_needed_to_create()

{

$this->actingAsApiEditor();

$details = [

'description' => 'A book 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();

$book = $this->entities->book();

$resp = $this->getJson($this->baseEndpoint . "/{$book->id}");

$resp->assertStatus(200);

$resp->assertJson([

'id' => $book->id,

'slug' => $book->slug,

'created_by' => [

'name' => $book->createdBy->name,

],

'updated_by' => [

'name' => $book->createdBy->name,

],

'owned_by' => [

'name' => $book->ownedBy->name,

],

'default_template_id' => null,

]);

}

public function test_read_endpoint_includes_chapter_and_page_contents()

{

$this->actingAsApiEditor();

$book = $this->entities->bookHasChaptersAndPages();

$chapter = $book->chapters()->first();

$chapterPage = $chapter->pages()->first();

$resp = $this->getJson($this->baseEndpoint . "/{$book->id}");

$directChildCount = $book->directPages()->count() + $book->chapters()->count();

$resp->assertStatus(200);

$resp->assertJsonCount($directChildCount, 'contents');

$contents = $resp->json('contents');

$respChapter = array_values(array_filter($contents, fn ($item) => ($item['id'] === $chapter->id && $item['type'] === 'chapter')))[0];

$this->assertArrayMapIncludes([

'id' => $chapter->id,

'type' => 'chapter',

'name' => $chapter->name,

'slug' => $chapter->slug,

], $respChapter);

$respPage = array_values(array_filter($respChapter['pages'], fn ($item) => ($item['id'] === $chapterPage->id)))[0];

$this->assertArrayMapIncludes([

'id' => $chapterPage->id,

'name' => $chapterPage->name,

'slug' => $chapterPage->slug,

], $respPage);

}

public function test_read_endpoint_contents_nested_pages_has_permissions_applied()

{

$this->actingAsApiEditor();

$book = $this->entities->bookHasChaptersAndPages();

$chapter = $book->chapters()->first();

$chapterPage = $chapter->pages()->first();

$customName = 'MyNonVisiblePageWithinAChapter';

$chapterPage->name = $customName;

$chapterPage->save();

$this->permissions->disableEntityInheritedPermissions($chapterPage);

$resp = $this->getJson($this->baseEndpoint . "/{$book->id}");

$resp->assertJsonMissing(['name' => $customName]);

}

public function test_read_endpoint_lists_visible_shelves_the_book_is_assigned_to()

{

$this->actingAsApiEditor();

$shelf = $this->entities->shelf();

$otherShelf = $this->entities->shelf();

$book = $this->entities->book();

$book->shelves()->detach();

$book->shelves()->attach($shelf);

$book->shelves()->attach($otherShelf);

$this->assertEquals(2, $book->shelves()->count());

$this->permissions->disableEntityInheritedPermissions($otherShelf);

$resp = $this->getJson("{$this->baseEndpoint}/{$book->id}");

$resp->assertOk();

$resp->assertJsonCount(1, 'shelves');

$resp->assertJson([

'shelves' => [

[

'id' => $shelf->id,

'name' => $shelf->name,

'slug' => $shelf->slug,

]

]

]);

$resp->assertJsonMissingPath('shelves.0.description');

$resp->assertJsonMissingPath('shelves.0.pivot');

}

public function test_update_endpoint()

{

$this->actingAsApiEditor();

$book = $this->entities->book();

$templatePage = $this->entities->templatePage();

$details = [

'name' => 'My updated API book',

'description' => 'A book updated via the API',

'default_template_id' => $templatePage->id,

];

$resp = $this->putJson($this->baseEndpoint . "/{$book->id}", $details);

$book->refresh();

$resp->assertStatus(200);

$resp->assertJson(array_merge($details, [

'id' => $book->id,

'slug' => $book->slug,

'description_html' => '<p>A book updated via the API</p>',

]));

$this->assertActivityExists('book_update', $book);

}

public function test_update_endpoint_with_html()

{

$this->actingAsApiEditor();

$book = $this->entities->book();

$details = [

'name' => 'My updated API book',

'description_html' => '<p>A book <strong>updated</strong> via the API</p>',

];

$resp = $this->putJson($this->baseEndpoint . "/{$book->id}", $details);

$resp->assertStatus(200);

$this->assertDatabaseHasEntityData('book', array_merge($details, ['id' => $book->id, 'description' => 'A book updated via the API']));

}

public function test_update_increments_updated_date_if_only_tags_are_sent()

{

$this->actingAsApiEditor();

$book = $this->entities->book();

Book::query()->where('id', '=', $book->id)->update(['updated_at' => Carbon::now()->subWeek()]);

$details = [

'tags' => [['name' => 'Category', 'value' => 'Testing']],

];

$this->putJson($this->baseEndpoint . "/{$book->id}", $details);

$book->refresh();

$this->assertGreaterThan(Carbon::now()->subDay()->unix(), $book->updated_at->unix());

}

public function test_update_cover_image_control()

{

$this->actingAsApiEditor();

/** @var Book $book */

$book = $this->entities->book();

$this->assertNull($book->coverInfo()->getImage());

$file = $this->files->uploadedImage('image.png');

// Ensure cover image can be set via API

$resp = $this->call('PUT', $this->baseEndpoint . "/{$book->id}", [

'name' => 'My updated API book with image',

], [], ['image' => $file]);

$book->refresh();

$resp->assertStatus(200);

$this->assertNotNull($book->coverInfo()->getImage());

// Ensure further updates without image do not clear cover image

$resp = $this->put($this->baseEndpoint . "/{$book->id}", [

'name' => 'My updated book again',

]);

$book->refresh();

$resp->assertStatus(200);

$this->assertNotNull($book->coverInfo()->getImage());

// Ensure update with null image property clears image

$resp = $this->put($this->baseEndpoint . "/{$book->id}", [

'image' => null,

]);

$book->refresh();

$resp->assertStatus(200);

$this->assertNull($book->coverInfo()->getImage());

}

public function test_delete_endpoint()

{

$this->actingAsApiEditor();

$book = $this->entities->book();

$resp = $this->deleteJson($this->baseEndpoint . "/{$book->id}");

$resp->assertStatus(204);

$this->assertActivityExists('book_delete');

}