namespace Tests\Api;
use BookStack\Entities\Models\Book;
+use BookStack\Entities\Repos\BaseRepo;
use Carbon\Carbon;
use Illuminate\Support\Facades\DB;
use Tests\TestCase;
'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');
+ $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,
+ ],
],
]]);
}
public function test_create_endpoint()
{
$this->actingAsApiEditor();
+ $templatePage = $this->entities->templatePage();
$details = [
- 'name' => 'My API book',
- 'description' => 'A book created via the API',
+ '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]));
+ $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->assertDatabaseHas('books', $expectedDetails);
+ }
+
public function test_book_name_needed_to_create()
{
$this->actingAsApiEditor();
'validation' => [
'name' => ['The name field is required.'],
],
- 'code' => 422,
+ 'code' => 422,
],
]);
}
'owned_by' => [
'name' => $book->ownedBy->name,
],
+ 'default_template_id' => null,
]);
}
]);
}
+ 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_update_endpoint()
{
$this->actingAsApiEditor();
$book = $this->entities->book();
+ $templatePage = $this->entities->templatePage();
$details = [
'name' => 'My updated API book',
- 'description' => 'A book created via the API',
+ '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]));
+ $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->assertDatabaseHas('books', 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();