Merge branch '2.0' into 2.1

This commit is contained in:
Robbie Averill 2019-06-11 12:05:29 +12:00
commit aed6575e89
4 changed files with 68 additions and 19 deletions

View File

@ -2,20 +2,20 @@
namespace SilverStripe\RestfulServer; namespace SilverStripe\RestfulServer;
use SilverStripe\ORM\ArrayList; use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Config\Config;
use SilverStripe\Control\Controller; use SilverStripe\Control\Controller;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Control\Director; use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPRequest; use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\SS_List; use SilverStripe\ORM\SS_List;
use SilverStripe\ORM\ValidationException; use SilverStripe\ORM\ValidationException;
use SilverStripe\ORM\ValidationResult; use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Member; use SilverStripe\Security\Member;
use SilverStripe\Security\Security; use SilverStripe\Security\Security;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Injector\Injector;
/** /**
* Generic RESTful server, which handles webservice access to arbitrary DataObjects. * Generic RESTful server, which handles webservice access to arbitrary DataObjects.
@ -253,23 +253,29 @@ class RestfulServer extends Controller
* @todo Access checking * @todo Access checking
* *
* @param string $className * @param string $className
* @param Int $id * @param int $id
* @param string $relation * @param string $relation
* @return string The serialized representation of the requested object(s) - usually XML or JSON. * @return string The serialized representation of the requested object(s) - usually XML or JSON.
*/ */
protected function getHandler($className, $id, $relationName) protected function getHandler($className, $id, $relationName)
{ {
$sort = ''; $sort = ['ID' => 'ASC'];
if ($this->request->getVar('sort')) { if ($sortQuery = $this->request->getVar('sort')) {
$dir = $this->request->getVar('dir'); /** @var DataObject $singleton */
$sort = array($this->request->getVar('sort') => ($dir ? $dir : 'ASC')); $singleton = singleton($className);
// Only apply a sort filter if it is a valid field on the DataObject
if ($singleton && $singleton->hasDatabaseField($sortQuery)) {
$sort = [
$sortQuery => $this->request->getVar('dir') === 'DESC' ? 'DESC' : 'ASC',
];
}
} }
$limit = array( $limit = [
'start' => $this->request->getVar('start'), 'start' => (int) $this->request->getVar('start'),
'limit' => $this->request->getVar('limit') 'limit' => (int) $this->request->getVar('limit'),
); ];
$params = $this->request->getVars(); $params = $this->request->getVars();

View File

@ -53,7 +53,7 @@ class RestfulServerTest extends SapphireTest
{ {
parent::setUp(); parent::setUp();
Director::config()->set('alternate_base_url', $this->baseURI); Director::config()->set('alternate_base_url', $this->baseURI);
Security::setCurrentUser(null); $this->logOut();
} }
public function testApiAccess() public function testApiAccess()
@ -617,6 +617,49 @@ class RestfulServerTest extends SapphireTest
); );
} }
public function testGetWithSortDescending()
{
$urlSafeClassname = $this->urlSafeClassname(RestfulServerTestAuthor::class);
$url = "{$this->baseURI}/api/v1/{$urlSafeClassname}?sort=FirstName&dir=DESC&fields=FirstName";
$response = Director::test($url);
$results = Convert::xml2array($response->getBody());
$this->assertSame('Author 4', $results[$urlSafeClassname][0]['FirstName']);
$this->assertSame('Author 3', $results[$urlSafeClassname][1]['FirstName']);
$this->assertSame('Author 2', $results[$urlSafeClassname][2]['FirstName']);
$this->assertSame('Author 1', $results[$urlSafeClassname][3]['FirstName']);
}
public function testGetWithSortAscending()
{
$urlSafeClassname = $this->urlSafeClassname(RestfulServerTestAuthor::class);
$url = "{$this->baseURI}/api/v1/{$urlSafeClassname}?sort=FirstName&dir=ASC&fields=FirstName";
$response = Director::test($url);
$results = Convert::xml2array($response->getBody());
$this->assertSame('Author 1', $results[$urlSafeClassname][0]['FirstName']);
$this->assertSame('Author 2', $results[$urlSafeClassname][1]['FirstName']);
$this->assertSame('Author 3', $results[$urlSafeClassname][2]['FirstName']);
$this->assertSame('Author 4', $results[$urlSafeClassname][3]['FirstName']);
}
public function testGetSortsByIdWhenInvalidSortColumnIsProvided()
{
$urlSafeClassname = $this->urlSafeClassname(RestfulServerTestAuthor::class);
$url = "{$this->baseURI}/api/v1/{$urlSafeClassname}?sort=Surname&dir=DESC&fields=FirstName";
$response = Director::test($url);
$results = Convert::xml2array($response->getBody());
$this->assertSame('Author 1', $results[$urlSafeClassname][0]['FirstName']);
$this->assertSame('Author 2', $results[$urlSafeClassname][1]['FirstName']);
$this->assertSame('Author 3', $results[$urlSafeClassname][2]['FirstName']);
$this->assertSame('Author 4', $results[$urlSafeClassname][3]['FirstName']);
}
public function testApiAccessWithPOST() public function testApiAccessWithPOST()
{ {
$urlSafeClassname = $this->urlSafeClassname(RestfulServerTestAuthorRating::class); $urlSafeClassname = $this->urlSafeClassname(RestfulServerTestAuthorRating::class);

View File

@ -46,10 +46,10 @@ SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthor:
author2: author2:
FirstName: Author 2 FirstName: Author 2
author3: author3:
Firstname: Author 3 FirstName: Author 3
author4: author4:
FirstName: Author 4 FirstName: Author 4
RelatedAuthors: RelatedAuthors:
- =>SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthor.author2 - =>SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthor.author2
- =>SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthor.author3 - =>SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthor.author3
SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthorRating: SilverStripe\RestfulServer\Tests\Stubs\RestfulServerTestAuthorRating:

View File

@ -12,7 +12,7 @@ class RestfulServerTestAuthor extends DataObject implements TestOnly
private static $table_name = 'RestfulServerTestAuthor'; private static $table_name = 'RestfulServerTestAuthor';
private static $db = array( private static $db = array(
'Name' => 'Text', 'FirstName' => 'Text',
); );
private static $many_many = array( private static $many_many = array(