ZIP Imports: Added API examples, finished testing

[bookstack] / tests / Api / BooksApiTest.php

diff --git a/tests/Api/BooksApiTest.php b/tests/Api/BooksApiTest.php
index 91e2db9e52de5c4cf7bddd0df659e6cdc79c42c8..22ccfb482c9c29a450c2dc27c286bfc580b3f9a6 100644 (file)
--- a/tests/Api/BooksApiTest.php
+++ b/tests/Api/BooksApiTest.php
@@ -3,13 +3,16 @@
 namespace Tests\Api;
 
 use BookStack\Entities\Models\Book;
 namespace Tests\Api;
 
 use BookStack\Entities\Models\Book;

+use BookStack\Entities\Repos\BaseRepo;
+use Carbon\Carbon;
+use Illuminate\Support\Facades\DB;

 use Tests\TestCase;
 
 class BooksApiTest extends TestCase
 {
     use TestsApi;
 
 use Tests\TestCase;
 
 class BooksApiTest extends TestCase
 {
     use TestsApi;
 

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

 
     public function test_index_endpoint_returns_expected_book()
     {
 
     public function test_index_endpoint_returns_expected_book()
     {


@@ -22,6 +25,31 @@ class BooksApiTest extends TestCase
                 'id'   => $firstBook->id,
                 'name' => $firstBook->name,
                 'slug' => $firstBook->slug,
                 '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,
+                ],

             ],
         ]]);
     }
             ],
         ]]);
     }


@@ -29,18 +57,46 @@ class BooksApiTest extends TestCase
     public function test_create_endpoint()
     {
         $this->actingAsApiEditor();
     public function test_create_endpoint()
     {
         $this->actingAsApiEditor();

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

         $details = [
         $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);
         ];
 
         $resp = $this->postJson($this->baseEndpoint, $details);
         $resp->assertStatus(200);

+

         $newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
         $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);
     }
 
         $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();
     public function test_book_name_needed_to_create()
     {
         $this->actingAsApiEditor();


@@ -56,7 +112,7 @@ class BooksApiTest extends TestCase
                 'validation' => [
                     'name' => ['The name field is required.'],
                 ],
                 'validation' => [
                     'name' => ['The name field is required.'],
                 ],

-                'code' => 422,
+                'code'       => 422,

             ],
         ]);
     }
             ],
         ]);
     }


@@ -64,7 +120,7 @@ class BooksApiTest extends TestCase
     public function test_read_endpoint()
     {
         $this->actingAsApiEditor();
     public function test_read_endpoint()
     {
         $this->actingAsApiEditor();

-        $book = Book::visible()->first();
+        $book = $this->entities->book();

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


@@ -81,91 +137,154 @@ class BooksApiTest extends TestCase
             'owned_by' => [
                 'name' => $book->ownedBy->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');
+        $resp->assertJson([
+            'contents' => [
+                [
+                    'type' => 'chapter',
+                    'id' => $chapter->id,
+                    'name' => $chapter->name,
+                    'slug' => $chapter->slug,
+                    'pages' => [
+                        [
+                            'id' => $chapterPage->id,
+                            'name' => $chapterPage->name,
+                            'slug' => $chapterPage->slug,
+                        ]
+                    ]
+                ]
+            ]
+        ]);
+    }
+
+    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();
     public function test_update_endpoint()
     {
         $this->actingAsApiEditor();

-        $book = Book::visible()->first();
+        $book = $this->entities->book();
+        $templatePage = $this->entities->templatePage();

         $details = [
             'name'        => 'My updated API book',
         $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 = $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);
     }
 
         $this->assertActivityExists('book_update', $book);
     }
 

-    public function test_delete_endpoint()
+    public function test_update_endpoint_with_html()

     {
         $this->actingAsApiEditor();
     {
         $this->actingAsApiEditor();

-        $book = Book::visible()->first();
-        $resp = $this->deleteJson($this->baseEndpoint . "/{$book->id}");
+        $book = $this->entities->book();
+        $details = [
+            'name'             => 'My updated API book',
+            'description_html' => '<p>A book <strong>updated</strong> via the API</p>',
+        ];

 
 

-        $resp->assertStatus(204);
-        $this->assertActivityExists('book_delete');
+        $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_export_html_endpoint()
+    public function test_update_increments_updated_date_if_only_tags_are_sent()

     {
         $this->actingAsApiEditor();
     {
         $this->actingAsApiEditor();

-        $book = Book::visible()->first();
+        $book = $this->entities->book();
+        DB::table('books')->where('id', '=', $book->id)->update(['updated_at' => Carbon::now()->subWeek()]);

 
 

-        $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/html");
-        $resp->assertStatus(200);
-        $resp->assertSee($book->name);
-        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.html"');
+        $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_export_plain_text_endpoint()
+    public function test_update_cover_image_control()

     {
         $this->actingAsApiEditor();
     {
         $this->actingAsApiEditor();

-        $book = Book::visible()->first();
+        /** @var Book $book */
+        $book = $this->entities->book();
+        $this->assertNull($book->cover);
+        $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 = $this->get($this->baseEndpoint . "/{$book->id}/export/plaintext");

         $resp->assertStatus(200);
         $resp->assertStatus(200);

-        $resp->assertSee($book->name);
-        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.txt"');
-    }
+        $this->assertNotNull($book->cover);

 
 

-    public function test_export_pdf_endpoint()
-    {
-        $this->actingAsApiEditor();
-        $book = Book::visible()->first();
+        // 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 = $this->get($this->baseEndpoint . "/{$book->id}/export/pdf");

         $resp->assertStatus(200);
         $resp->assertStatus(200);

-        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.pdf"');
-    }
+        $this->assertNotNull($book->cover);

 
 

-    public function test_export_markdown_endpoint()
-    {
-        $this->actingAsApiEditor();
-        $book = Book::visible()->has('pages')->has('chapters')->first();
+        // Ensure update with null image property clears image
+        $resp = $this->put($this->baseEndpoint . "/{$book->id}", [
+            'image' => null,
+        ]);
+        $book->refresh();

 
 

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

         $resp->assertStatus(200);
         $resp->assertStatus(200);

-        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.md"');
-        $resp->assertSee('# ' . $book->name);
-        $resp->assertSee('# ' . $book->pages()->first()->name);
-        $resp->assertSee('# ' . $book->chapters()->first()->name);
+        $this->assertNull($book->cover);

     }
 
     }
 

-    public function test_cant_export_when_not_have_permission()
+    public function test_delete_endpoint()

     {
     {

-        $types = ['html', 'plaintext', 'pdf', 'markdown'];

         $this->actingAsApiEditor();
         $this->actingAsApiEditor();

-        $this->removePermissionFromUser($this->getEditor(), 'content-export');
+        $book = $this->entities->book();
+        $resp = $this->deleteJson($this->baseEndpoint . "/{$book->id}");

 
 

-        $book = Book::visible()->first();
-        foreach ($types as $type) {
-            $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/{$type}");
-            $this->assertPermissionError($resp);
-        }
+        $resp->assertStatus(204);
+        $this->assertActivityExists('book_delete');

     }
 }
     }
 }