-<?php namespace Tests\Api;
+<?php
-use BookStack\Entities\Book;
+namespace Tests\Api;
+
+use BookStack\Entities\Models\Book;
use Tests\TestCase;
class ApiListingTest extends TestCase
$books = Book::visible()->orderBy('id')->take(3)->get();
$resp = $this->get($this->endpoint . '?count=1');
- $resp->assertJsonMissing(['name' => $books[1]->name ]);
+ $resp->assertJsonMissing(['name' => $books[1]->name]);
$resp = $this->get($this->endpoint . '?count=1&offset=1000');
$resp->assertJsonCount(0, 'data');
$this->actingAsApiEditor();
$sortChecks = [
- '-id' => Book::visible()->orderBy('id', 'desc')->first(),
+ '-id' => Book::visible()->orderBy('id', 'desc')->first(),
'+name' => Book::visible()->orderBy('name', 'asc')->first(),
- 'name' => Book::visible()->orderBy('name', 'asc')->first(),
- '-name' => Book::visible()->orderBy('name', 'desc')->first()
+ 'name' => Book::visible()->orderBy('name', 'asc')->first(),
+ '-name' => Book::visible()->orderBy('name', 'desc')->first(),
];
foreach ($sortChecks as $sortOption => $result) {
$resp = $this->get($this->endpoint . '?count=1&sort=' . $sortOption);
$resp->assertJson(['data' => [
[
- 'id' => $result->id,
+ 'id' => $result->id,
'name' => $result->name,
- ]
+ ],
]]);
}
}
$filterChecks = [
// Test different types of filter
- "filter[id]={$book->id}" => 1,
- "filter[id:ne]={$book->id}" => Book::visible()->where('id', '!=', $book->id)->count(),
- "filter[id:gt]={$book->id}" => Book::visible()->where('id', '>', $book->id)->count(),
- "filter[id:gte]={$book->id}" => Book::visible()->where('id', '>=', $book->id)->count(),
- "filter[id:lt]={$book->id}" => Book::visible()->where('id', '<', $book->id)->count(),
+ "filter[id]={$book->id}" => 1,
+ "filter[id:ne]={$book->id}" => Book::visible()->where('id', '!=', $book->id)->count(),
+ "filter[id:gt]={$book->id}" => Book::visible()->where('id', '>', $book->id)->count(),
+ "filter[id:gte]={$book->id}" => Book::visible()->where('id', '>=', $book->id)->count(),
+ "filter[id:lt]={$book->id}" => Book::visible()->where('id', '<', $book->id)->count(),
"filter[name:like]={$encodedNameSubstr}%" => Book::visible()->where('name', 'like', $nameSubstr . '%')->count(),
// Test mulitple filters 'and' together
}
}
-}
\ No newline at end of file
+ public function test_total_on_results_shows_correctly()
+ {
+ $this->actingAsApiEditor();
+ $bookCount = Book::query()->count();
+ $resp = $this->get($this->endpoint . '?count=1');
+ $resp->assertJson(['total' => $bookCount]);
+ }
+
+ public function test_total_on_results_shows_correctly_when_offset_provided()
+ {
+ $this->actingAsApiEditor();
+ $bookCount = Book::query()->count();
+ $resp = $this->get($this->endpoint . '?count=1&offset=1');
+ $resp->assertJson(['total' => $bookCount]);
+ }
+}