<?php

namespace Tests\Api;

use BookStack\Entities\Models\Book;

use BookStack\Entities\Models\Chapter;

use Carbon\Carbon;

use Illuminate\Support\Facades\DB;

use Tests\TestCase;

class ChaptersApiTest extends TestCase

{

use TestsApi;

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

public function test_index_endpoint_returns_expected_chapter()

{

$this->actingAsApiEditor();

$firstChapter = Chapter::query()->orderBy('id', 'asc')->first();

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

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

[

'id' => $firstChapter->id,

'name' => $firstChapter->name,

'slug' => $firstChapter->slug,

'book_id' => $firstChapter->book->id,

'priority' => $firstChapter->priority,

'book_slug' => $firstChapter->book->slug,

'owned_by' => $firstChapter->owned_by,

'created_by' => $firstChapter->created_by,

'updated_by' => $firstChapter->updated_by,

],

]]);

}

public function test_create_endpoint()

{

$this->actingAsApiEditor();

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

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

$details = [

'name' => 'My API chapter',

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

'book_id' => $book->id,

'tags' => [

[

'name' => 'tagname',

'value' => 'tagvalue',

],

],

'priority' => 15,

'default_template_id' => $templatePage->id,

];

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

$resp->assertStatus(200);

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

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

'id' => $newItem->id,

'slug' => $newItem->slug,

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

]));

$this->assertDatabaseHas('tags', [

'entity_id' => $newItem->id,

'entity_type' => $newItem->getMorphClass(),

'name' => 'tagname',

'value' => 'tagvalue',

]);

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

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

}

public function test_create_endpoint_with_html()

{

$this->actingAsApiEditor();

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

$details = [

'name' => 'My API chapter',

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

'book_id' => $book->id,

];

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

$resp->assertStatus(200);

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

$expectedDetails = array_merge($details, [

'id' => $newItem->id,

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

]);

$resp->assertJson($expectedDetails);

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

}

public function test_chapter_name_needed_to_create()

{

$this->actingAsApiEditor();

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

$details = [

'book_id' => $book->id,

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

];

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

$resp->assertStatus(422);

$resp->assertJson($this->validationResponse([

'name' => ['The name field is required.'],

]));

}

public function test_chapter_book_id_needed_to_create()

{

$this->actingAsApiEditor();

$details = [

'name' => 'My api chapter',

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

];

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

$resp->assertStatus(422);

$resp->assertJson($this->validationResponse([

'book_id' => ['The book id field is required.'],

]));

}

public function test_read_endpoint()

{

$this->actingAsApiEditor();

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

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

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

$resp->assertStatus(200);

$resp->assertJson([

'id' => $chapter->id,

'slug' => $chapter->slug,

'book_slug' => $chapter->book->slug,

'created_by' => [

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

],

'book_id' => $chapter->book_id,

'updated_by' => [

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

],

'owned_by' => [

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

],

'pages' => [

[

'id' => $page->id,

'slug' => $page->slug,

'name' => $page->name,

'owned_by' => $page->owned_by,

'created_by' => $page->created_by,

'updated_by' => $page->updated_by,

'book_id' => $page->book->id,

'chapter_id' => $chapter->id,

'priority' => $page->priority,

'book_slug' => $chapter->book->slug,

'draft' => $page->draft,

'template' => $page->template,

'editor' => $page->editor,

],

],

'default_template_id' => null,

]);

$resp->assertJsonMissingPath('book');

$resp->assertJsonCount($chapter->pages()->count(), 'pages');

}

public function test_update_endpoint()

{

$this->actingAsApiEditor();

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

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

$details = [

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

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

'tags' => [

[

'name' => 'freshtag',

'value' => 'freshtagval',

],

],

'priority' => 15,

'default_template_id' => $templatePage->id,

];

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

$chapter->refresh();

$resp->assertStatus(200);

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

'id' => $chapter->id,

'slug' => $chapter->slug,

'book_id' => $chapter->book_id,

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

]));

$this->assertActivityExists('chapter_update', $chapter);

}

public function test_update_endpoint_with_html()

{

$this->actingAsApiEditor();

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

$details = [

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

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

];

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

$resp->assertStatus(200);

$this->assertDatabaseHasEntityData('chapter', array_merge($details, [

'id' => $chapter->id, 'description' => 'A chapter updated via the API'

]));

}

public function test_update_increments_updated_date_if_only_tags_are_sent()

{

$this->actingAsApiEditor();

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

$chapter->newQuery()->where('id', '=', $chapter->id)->update(['updated_at' => Carbon::now()->subWeek()]);

$details = [

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

];

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

$chapter->refresh();

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

}

public function test_update_with_book_id_moves_chapter()

{

$this->actingAsApiEditor();

$chapter = $this->entities->chapterHasPages();

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

$newBook = Book::query()->where('id', '!=', $chapter->book_id)->first();

$resp = $this->putJson($this->baseEndpoint . "/{$chapter->id}", ['book_id' => $newBook->id]);

$resp->assertOk();

$chapter->refresh();

$this->assertDatabaseHasEntityData('chapter', ['id' => $chapter->id, 'book_id' => $newBook->id]);

$this->assertDatabaseHasEntityData('page', ['id' => $page->id, 'book_id' => $newBook->id, 'chapter_id' => $chapter->id]);

}

public function test_update_with_new_book_id_requires_delete_permission()

{

$editor = $this->users->editor();

$this->permissions->removeUserRolePermissions($editor, ['chapter-delete-all', 'chapter-delete-own']);

$this->actingAsForApi($editor);

$chapter = $this->entities->chapterHasPages();

$newBook = Book::query()->where('id', '!=', $chapter->book_id)->first();

$resp = $this->putJson($this->baseEndpoint . "/{$chapter->id}", ['book_id' => $newBook->id]);

$this->assertPermissionError($resp);

}

public function test_delete_endpoint()

{

$this->actingAsApiEditor();

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

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

$resp->assertStatus(204);

$this->assertActivityExists('chapter_delete');

}

}