mirror/php-flarum
1
0
Fork 0
mirror of https://github.com/flarum/core.git synced 2025-08-21 15:52:44 +02:00
Code Issues Releases Wiki Activity

#2492 - Groups filtering & retrieve single endpoint (#3084)

Browse Source 
Fixes #2492

* Added api/groups/{id} endpoint for retrieving a single group by its id
* Fixed GroupRepository incorrectly opening query to User instead of Group model
* Added filtering & paging abilities to GET api/groups endpoint
* Added test for sorting for GET api/groups endpoint

Co-authored-by: Alexander Skvortsov <38059171+askvortsov1@users.noreply.github.com>
This commit is contained in:
MatusMak
2021-10-25 17:48:25 +02:00
committed by GitHub
parent a9b1a518a2
commit 5a1bf08d3f
9 changed files with 451 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
tests/integration/api/groups/ListTest.php
View File

@@ -65,6 +65,148 @@ class ListTest extends TestCase
$this->assertEquals(['1', '2', '3', '4', '10'], Arr::pluck($data['data'], 'id'));
}
/**
* @test
*/
public function filters_only_public_groups_for_admin()
{
$response = $this->send(
$this->request('GET', '/api/groups', [
'authenticatedAs' => 1,
])
->withQueryParams([
'filter' => ['hidden' => 0],
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// The four default groups created by the installer without our hidden group
$this->assertEquals(['1', '2', '3', '4'], Arr::pluck($data['data'], 'id'));
}
/**
* @test
*/
public function filters_only_hidden_groups_for_admin()
{
$response = $this->send(
$this->request('GET', '/api/groups', [
'authenticatedAs' => 1,
])
->withQueryParams([
'filter' => ['hidden' => 1],
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// Only our hidden group
$this->assertEquals(['10'], Arr::pluck($data['data'], 'id'));
}
/**
* @test
*/
public function filters_only_public_groups_for_guest()
{
$response = $this->send(
$this->request('GET', '/api/groups')
->withQueryParams([
'filter' => ['hidden' => 0],
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// The four default groups created by the installer without our hidden group
$this->assertEquals(['1', '2', '3', '4'], Arr::pluck($data['data'], 'id'));
}
/**
* @test
*/
public function hides_hidden_groups_when_filtering_for_guest()
{
$response = $this->send(
$this->request('GET', '/api/groups')
->withQueryParams([
'filter' => ['hidden' => 1],
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// When guest attempts to filter for hidden groups, system should
// still apply scoping and exclude those groups from results
$this->assertEquals([], Arr::pluck($data['data'], 'id'));
}
/**
* @test
*/
public function paginates_groups_without_filter()
{
$response = $this->send(
$this->request('GET', '/api/groups')
->withQueryParams([
'page' => ['limit' => '2', 'offset' => '2'],
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// Show second page of groups
$this->assertEquals(['3', '4'], Arr::pluck($data['data'], 'id'));
}
/**
* @test
*/
public function paginates_groups_with_filter()
{
$response = $this->send(
$this->request('GET', '/api/groups')
->withQueryParams([
'filter' => ['hidden' => 1],
'page' => ['limit' => '1', 'offset' => '1'],
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// Show second page of groups. Because there is only one hidden group,
// second page should be empty.
$this->assertEmpty($data['data']);
}
/**
* @test
*/
public function sorts_groups_by_name()
{
$response = $this->send(
$this->request('GET', '/api/groups', [
'authenticatedAs' => 1,
])
->withQueryParams([
'sort' => 'nameSingular',
])
);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode($response->getBody()->getContents(), true);
// Ascending alphabetical order is: Admin - Guest - Hidden - Member - Mod
$this->assertEquals(['1', '2', '10', '3', '4'], Arr::pluck($data['data'], 'id'));
}
protected function hiddenGroup(): array
{
return [