Merge pull request #23 from gregorip02/2.x

2.x Remove support for base64 queries

.gitattributes

@@ -12,3 +12,4 @@
 /docs               export-ignore
 /CHANGELOG.md       export-ignore
 /CONTRIBUTING.md    export-ignore
+/.php_cs            export-ignore

src/RequestParser.php

@@ -2,6 +2,7 @@
 
 namespace Restql;
 
+use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
 use Restql\Traits\HasConfigService;
@@ -45,21 +46,9 @@ public static function filter(Request $request): Collection
      */
     protected function decode(): Collection
     {
-        if (strlen($this->getQueryParamName()) && $this->hasParam()) {
-            /// If the user decides to give a value to the attribute in the
-            /// "query_param" setting, then it will be assumed that
-            /// the application accepts base64 encoded queries
-            /// sent as parameters in the HTTP request.
-
-            /// Similarly, when this happens, the value of the
-            /// query must be compulsorily encoded in
-            /// base64.
-            return $this->decodeParam();
-        }
+        $resources = $this->hasParam() ? $this->getQueryParamValue() : $this->request->all();
 
-        /// By default, restql accepts queries that come in the body
-        /// of the HTTP request and are not base64 encoded.
-        return $this->getAllowedResources($this->request->all());
+        return $this->getAllowedResources($resources);
     }
 
     /**
@@ -77,13 +66,19 @@ protected function hasParam(): bool
     /**
      * Get the request param value.
      *
-     * @return string
+     * @return array
      */
-    protected function getQueryParamValue(): string
+    protected function getQueryParamValue(): array
     {
         $paramName = $this->getQueryParamName();
 
-        return $this->request->get($paramName);
+        $paramValue = $this->request->input($paramName);
+
+        if (! is_array($paramValue)) {
+            throw new Exception(sprintf('The value of param %s must be array', $paramName));
+        }
+
+        return $paramValue;
     }
 
     /**
@@ -96,18 +91,6 @@ protected function getQueryParamName(): string
         return $this->getConfigService()->get('query_param', '');
     }
 
-    /**
-     * Decode the parameter.
-     *
-     * @return \Illuminate\Support\Collection
-     */
-    protected function decodeParam(): Collection
-    {
-        $query = (array) json_decode(base64_decode($this->getQueryParamValue()));
-
-        return $this->getAllowedResources($query);
-    }
-
     /**
      * The accepted resources key names (models/resolvers).
      *

tests/Unit/RequestParserTest.php

@@ -3,10 +3,10 @@
 namespace Testing\Unit;
 
 use Illuminate\Http\Request;
-use PHPUnit\Framework\TestCase as FrameworkTestCase;
 use Restql\RequestParser;
+use Testing\TestCase;
 
-class RequestParserTest extends FrameworkTestCase
+class RequestParserTest extends TestCase
 {
     /**
      * Fake request body.
@@ -19,43 +19,25 @@ class RequestParserTest extends FrameworkTestCase
         'unknow_schema_definition' => true
     ];
 
-    /**
-     * Create generic encoded request.
-     *
-     * @return \Illuminate\Http\Request
-     */
-    protected static function genericEncodedRequest(): Request
-    {
-        $body = base64_encode(json_encode(self::$body));
-
-        return new Request([
-            'query' => $body
-        ]);
-    }
-
     /**
      * Create generic request.
      *
      * @return \Illuminate\Http\Request
      */
     protected static function genericRequest(): Request
     {
-        return new Request(self::$body);
+        return new Request([
+            'query' => self::$body
+        ]);
     }
 
     /**
      * @test Exclude unknow resources.
      */
     public function theParserExcludeUnknowResources(): void
     {
-        $encoded = RequestParser::filter(self::genericEncodedRequest());
-
         $decoded = RequestParser::filter(self::genericRequest());
-
-        $this->assertFalse($encoded->has('unknow_schema_definition'));
         $this->assertFalse($decoded->has('unknow_schema_definition'));
-
-        $this->assertTrue($encoded->has('authors'));
         $this->assertTrue($decoded->has('authors'));
     }
 }