namespace Tests\Api;
-use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Page;
+use Carbon\Carbon;
+use Illuminate\Support\Facades\DB;
use Tests\TestCase;
class PagesApiTest extends TestCase
{
use TestsApi;
- protected $baseEndpoint = '/api/pages';
+ protected string $baseEndpoint = '/api/pages';
public function test_index_endpoint_returns_expected_page()
{
public function test_create_endpoint()
{
$this->actingAsApiEditor();
- $book = Book::query()->first();
+ $book = $this->entities->book();
$details = [
'name' => 'My API page',
'book_id' => $book->id,
public function test_page_name_needed_to_create()
{
$this->actingAsApiEditor();
- $book = Book::query()->first();
+ $book = $this->entities->book();
$details = [
'book_id' => $book->id,
'html' => '<p>A page created via the API</p>',
'chapter_id' => ['The chapter id field is required when book id is not present.'],
]));
- $chapter = Chapter::visible()->first();
+ $chapter = $this->entities->chapter();
$resp = $this->postJson($this->baseEndpoint, array_merge($details, ['chapter_id' => $chapter->id]));
$resp->assertStatus(200);
- $book = Book::visible()->first();
+ $book = $this->entities->book();
$resp = $this->postJson($this->baseEndpoint, array_merge($details, ['book_id' => $book->id]));
$resp->assertStatus(200);
}
public function test_markdown_can_be_provided_for_create()
{
$this->actingAsApiEditor();
- $book = Book::visible()->first();
+ $book = $this->entities->book();
$details = [
'book_id' => $book->id,
'name' => 'My api page',
public function test_read_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$resp = $this->getJson($this->baseEndpoint . "/{$page->id}");
$resp->assertStatus(200);
public function test_read_endpoint_provides_rendered_html()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$page->html = "<p>testing</p><script>alert('danger')</script><h1>Hello</h1>";
$page->save();
public function test_update_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$details = [
'name' => 'My updated API page',
'html' => '<p>A page created via the API</p>',
public function test_providing_new_chapter_id_on_update_will_move_page()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$chapter = Chapter::visible()->where('book_id', '!=', $page->book_id)->first();
$details = [
'name' => 'My updated API page',
public function test_providing_move_via_update_requires_page_create_permission_on_new_parent()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$chapter = Chapter::visible()->where('book_id', '!=', $page->book_id)->first();
- $this->setEntityRestrictions($chapter, ['view'], [$this->getEditor()->roles()->first()]);
+ $this->entities->setPermissions($chapter, ['view'], [$this->getEditor()->roles()->first()]);
$details = [
'name' => 'My updated API page',
'chapter_id' => $chapter->id,
public function test_update_endpoint_does_not_wipe_content_if_no_html_or_md_provided()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$originalContent = $page->html;
$details = [
'name' => 'My updated API page',
$this->assertEquals($originalContent, $page->html);
}
+ public function test_update_increments_updated_date_if_only_tags_are_sent()
+ {
+ $this->actingAsApiEditor();
+ $page = $this->entities->page();
+ DB::table('pages')->where('id', '=', $page->id)->update(['updated_at' => Carbon::now()->subWeek()]);
+
+ $details = [
+ 'tags' => [['name' => 'Category', 'value' => 'Testing']],
+ ];
+
+ $resp = $this->putJson($this->baseEndpoint . "/{$page->id}", $details);
+ $resp->assertOk();
+
+ $page->refresh();
+ $this->assertGreaterThan(Carbon::now()->subDay()->unix(), $page->updated_at->unix());
+ }
+
public function test_delete_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$resp = $this->deleteJson($this->baseEndpoint . "/{$page->id}");
$resp->assertStatus(204);
public function test_export_html_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/html");
$resp->assertStatus(200);
public function test_export_plain_text_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/plaintext");
$resp->assertStatus(200);
public function test_export_pdf_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/pdf");
$resp->assertStatus(200);
public function test_export_markdown_endpoint()
{
$this->actingAsApiEditor();
- $page = Page::visible()->first();
+ $page = $this->entities->page();
$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/markdown");
$resp->assertStatus(200);
$resp->assertSee('# ' . $page->name);
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $page->slug . '.md"');
}
+
+ public function test_cant_export_when_not_have_permission()
+ {
+ $types = ['html', 'plaintext', 'pdf', 'markdown'];
+ $this->actingAsApiEditor();
+ $this->removePermissionFromUser($this->getEditor(), 'content-export');
+
+ $page = $this->entities->page();
+ foreach ($types as $type) {
+ $resp = $this->get($this->baseEndpoint . "/{$page->id}/export/{$type}");
+ $this->assertPermissionError($resp);
+ }
+ }
}