Feature/filters #100

srottem · 2016-09-18T14:29:50Z

Hi Nil,

Let me try this again: I've been working up a filtering scheme that uses RQL in the filter request parameter to populate the eloquent query used by the controller index method with where clauses. For example, the request string could contain something like the following:

filter=and(or(and(like(name,b_),ne(name,bob),like(name,a_)),eq(size,10))

There are other ways of expressing this using RQL, but this will do for an example. At the moment I'm supporting all the standard scalar checks (eq, gt, ge, lt, le, ne) as well as null checks, array checks (in, out) and the logical 'and' and 'or' operators in groups (not is unsupported because I can't figure out how to map it to an Eloquent query builder).

The implementation I've thrown together is using the xiag-ag/rql-parser (https://github.com/xiag-ag/rql-parser) to parse the content of the filter parameter passed on in the request string and then uses a class I've added named EloquentNodeVisitor to add where clauses to the eloquent query builder.

My implementation does kind of break your approach to handling the filter parameter (based, I assume on the recommendation on the jsonapi website) since I want to have a single RQL filter rather than a filter per field. Since the current implementation of your json-api package exposes the filter through the Request->getFilters and this always returns an array it posed an issue with obtaining the RQL and still getting correctly formed links in the response. As a workaround the JsonApiController now converts the result from getFilters to a string or a null - it might be better to change this in the json-api package instead but I didn't know whether this approach made sense to you so I've just hacked it for now.

Let me know if you want anything further clarified.

Symon.

Nitpick-CI · 2016-09-18T14:30:03Z

tests/NilPortugues/App/Controller/EmployeesController.php

@@ -136,6 +136,18 @@ public function getOrdersByEmployee($id)
        $sorting = $apiRequest->getSort();
        $included = $apiRequest->getIncludedRelationships();
        $filters = $apiRequest->getFilters();
+
+        //HACK: JsonAPI is specifying this as an array but it should be a string at this point for RQL processing.
+    	switch(count($filters)){


Spaces must be used to indent lines; tabs are not allowed

Expected 1 space after SWITCH keyword; 0 found

Expected 1 space after closing parenthesis; found 0

Nitpick-CI · 2016-09-18T14:30:04Z

tests/NilPortugues/App/Controller/EmployeesController.php

+
+        //HACK: JsonAPI is specifying this as an array but it should be a string at this point for RQL processing.
+    	switch(count($filters)){
+        	case 0:


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:04Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        //HACK: JsonAPI is specifying this as an array but it should be a string at this point for RQL processing.
+    	switch(count($filters)){
+        	case 0:
+        		$filters = null;


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:04Z

tests/NilPortugues/App/Controller/EmployeesController.php

+    	switch(count($filters)){
+        	case 0:
+        		$filters = null;
+        		break;


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:04Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        	case 0:
+        		$filters = null;
+        		break;
+        	case 1:


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:04Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        		$filters = null;
+        		break;
+        	case 1:
+        		$filters = $filters[0];


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:05Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        		break;
+        	case 1:
+        		$filters = $filters[0];
+        		break;


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:05Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        	case 1:
+        		$filters = $filters[0];
+        		break;
+        	default:


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:05Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        		$filters = $filters[0];
+        		break;
+        	default:
+        		throw new \Exception('Only a single filter is supported at present.');


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:05Z

tests/NilPortugues/App/Controller/EmployeesController.php

+        		break;
+        	default:
+        		throw new \Exception('Only a single filter is supported at present.');
+        }      


Whitespace found at end of line

Nitpick-CI · 2016-09-18T14:30:05Z

tests/NilPortugues/App/Transformers/EmployeesTransformer.php

+
+    public function getRequiredProperties()
+    {
+    	return [];


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:06Z

tests/NilPortugues/App/Transformers/OrdersTransformer.php

+
+    public function getRequiredProperties()
+    {
+    	return [];


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:06Z

tests/NilPortugues/Laravel5/JsonApi/JsonApiControllerTest.php

+
+    public function testListActionCanFilter()
+    {
+    	$this->call('GET', 'http://localhost/employees?filter=ne(a,b)');


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:06Z

tests/NilPortugues/Laravel5/JsonApi/JsonApiControllerTest.php

+    public function testListActionCanFilter()
+    {
+    	$this->call('GET', 'http://localhost/employees?filter=ne(a,b)');
+    	$response = $this->response;


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:06Z

tests/NilPortugues/Laravel5/JsonApi/JsonApiControllerTest.php

+    	$this->call('GET', 'http://localhost/employees?filter=ne(a,b)');
+    	$response = $this->response;
+
+    	$this->assertEquals(200, $response->getStatusCode());


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:06Z

tests/NilPortugues/Laravel5/JsonApi/JsonApiControllerTest.php

+    	$response = $this->response;
+
+    	$this->assertEquals(200, $response->getStatusCode());
+    	$this->assertEquals('application/vnd.api+json', $response->headers->get('Content-type'));


Spaces must be used to indent lines; tabs are not allowed

Nitpick-CI · 2016-09-18T14:30:06Z

tests/NilPortugues/Laravel5/JsonApi/JsonApiControllerTest.php

+
+    	$this->assertEquals(200, $response->getStatusCode());
+    	$this->assertEquals('application/vnd.api+json', $response->headers->get('Content-type'));
+    	$this->assertContains('&filter=ne(a,b)', $response->getContent());


Spaces must be used to indent lines; tabs are not allowed

srottem · 2016-09-18T14:33:49Z

Oh, and I forgot to mention that the 'like' operator is also supported using RQL glob syntax.

… for malformed URLs.

…t\QueryBuilder in order to potentially support more possible calls. Also reorganized logical node handling to facilitate future implementation of 'not()' RQL clause.

Nitpick-CI · 2016-09-20T06:52:29Z

src/NilPortugues/Laravel5/JsonApi/Controller/JsonApiController.php

+                throw new \Exception('Only a single filter is supported at present.');
+        }
+
+        $resource = new ListResource($this->serializer, $page, $fields, $sorting, $included, urlencode($filters)); 


Whitespace found at end of line

… encoding but have to be able to separate the parts and re-generate so only appropriate elements are URL encoded rather than all elements.

srottem · 2016-09-24T16:40:39Z

src/NilPortugues/Laravel5/JsonApi/Controller/JsonApiController.php

@@ -45,10 +47,11 @@ public function index()
        $fields = $apiRequest->getFields();
        $sorting = $apiRequest->getSort();
        $included = $apiRequest->getIncludedRelationships();
-        $filters = $apiRequest->getFilters();
+        $filters = $apiRequest->getRawFilter();


The getRawFilter has been implemented on a modified version of the php-json-api package that I've rolled which returns the entire and unmodified text of the filter parameter in the URL. The method uses the $_SERVER['QUERY_STRING'] value to obtain the value as the ServerRequestInterface object's getQueryParams() method has run the values through urldecode which makes returning original filters provided by the user in URLs generated by the controller near impossible.

srottem added 2 commits September 18, 2016 14:24

Implement filters.

8071e11

Tidy code to meet PSR-2 recommendation.

32abfdb

Nitpick-CI reviewed Sep 18, 2016

View reviewed changes

srottem added 2 commits September 20, 2016 08:50

Filters were not being URL encoded in response resulting in potential…

c063b1b

… for malformed URLs.

Modified node visitor to accept Query\QueryBuilder instead of Eloquen…

4b2d915

…t\QueryBuilder in order to potentially support more possible calls. Also reorganized logical node handling to facilitate future implementation of 'not()' RQL clause.

Nitpick-CI reviewed Sep 20, 2016

View reviewed changes

srottem added 7 commits September 20, 2016 15:43

Refactored node visitor and got RQL not clause working.

4487509

Added documentation on using RQL filters.

f27fccd

Documentation corrections and improvements.

fcdb1a8

Fixed filter test so it passes. The current output is ugly due to URL…

2b66f13

… encoding but have to be able to separate the parts and re-generate so only appropriate elements are URL encoded rather than all elements.

Controller now uses raw filter query string.

99fa354

Update composer to use dev version.

56c5af3

Reverted test to use unencoded filter characters.

f2fd1d4

srottem commented Sep 24, 2016

View reviewed changes

srottem added 4 commits September 24, 2016 18:47

Updated hacked test to use getRawFilter.

e3d5571

Fixed modified test files for nitpick compliance.

dfc62de

Documentation update.

0756494

Updated docs.

234cb2b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/filters #100

Feature/filters #100

srottem commented Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

Nitpick-CI Sep 18, 2016

srottem commented Sep 18, 2016

Nitpick-CI Sep 20, 2016

srottem Sep 24, 2016 •

edited

Loading

Feature/filters #100

Are you sure you want to change the base?

Feature/filters #100

Conversation

srottem commented Sep 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srottem commented Sep 18, 2016

Choose a reason for hiding this comment

srottem Sep 24, 2016 • edited Loading

Choose a reason for hiding this comment

srottem Sep 24, 2016 •

edited

Loading