Merge pull request #49 from WebFiori/dev

Refactoring: Created Class for Parameter Options
WebFiori · Jan 1, 2024 · bae1872 · bae1872
2 parents cc09c90 + b25b52f
commit bae1872
Show file tree

Hide file tree

Showing 14 changed files with 137 additions and 50 deletions.
diff --git a/examples/GetRandomService.php b/examples/GetRandomService.php
@@ -8,8 +8,7 @@
 class GetRandomService extends AbstractWebService {
     public function __construct() {
         parent::__construct('get-random-number');
-        $this->addRequestMethod('get');
-        $this->addRequestMethod('post');
+        $this->setRequestMethods(['get', 'post']);
 
         $this->addParameter(new RequestParameter('min', 'integer', true));
         $this->addParameter(new RequestParameter('max', 'integer', true));

diff --git a/examples/loader.php b/examples/loader.php
@@ -14,5 +14,6 @@
 require_once '../src/RequestParameter.php';
 require_once '../src/Request.php';
 require_once '../src/Response.php';
+require_once '../src/ParamOption.php';
 require_once '../src/Uri.php';
 require_once 'GetRandomService.php';
diff --git a/tests/loader.php b/tests/loader.php
@@ -54,6 +54,7 @@
 require_once $rootDir.'webfiori'.$DS.'http'.$DS.'HttpCookie.php';
 require_once $rootDir.'webfiori'.$DS.'http'.$DS.'HeadersPool.php';
 require_once $rootDir.'webfiori'.$DS.'http'.$DS.'ParamTypes.php';
+require_once $rootDir.'webfiori'.$DS.'http'.$DS.'ParamOption.php';
 require_once $rootDir.'webfiori'.$DS.'http'.$DS.'AbstractWebService.php';
 require_once $rootDir.'webfiori'.$DS.'http'.$DS.'APIFilter.php';
 require_once $rootDir.'webfiori'.$DS.'http'.$DS.'RequestParameter.php';

diff --git a/tests/webfiori/tests/http/RequestParameterTest.php b/tests/webfiori/tests/http/RequestParameterTest.php
@@ -1,9 +1,12 @@
 <?php
 namespace webfiori\tests\http;
 
+use Exception;
 use PHPUnit\Framework\TestCase;
-use webfiori\http\RequestParameter;
 use webfiori\http\APIFilter;
+use webfiori\http\ParamOption;
+use webfiori\http\ParamTypes;
+use webfiori\http\RequestParameter;
 /**
  * Description of RequestParameterTest
  *
@@ -32,8 +35,8 @@ public function testCreateParameter01() {
      */
     public function testCreateParameter02() {
         $param = RequestParameter::create([
-            'name'=>'hello',
-            'type' => 'integer',
+            ParamOption::NAME =>'hello',
+            ParamOption::TYPE => 'integer',
             'min' => 33,
             'max' => 100,
             'custom-filter' => function ($original, $basicFilterResult, $param) {
@@ -55,10 +58,10 @@ public function testCreateParameter02() {
     public function testCreateParameter03() {
         $param = RequestParameter::create([
             'name'=>'ok',
-            'type' => 'string',
-            'default' => 'Ibrahim',
-            'allow-empty' => true,
-            'description' => 'Super param.'
+            ParamOption::TYPE => ParamTypes::STRING,
+            ParamOption::DEFAULT => 'Ibrahim',
+            ParamOption::EMPTY => true,
+            ParamOption::DESCRIPTION => 'Super param.'
         ]);
         $this->assertNotNull($param);
         $this->assertEquals('ok', $param->getName());
@@ -73,9 +76,9 @@ public function testCreateParameter03() {
     public function testCreateParameter04() {
         $param = RequestParameter::create([
             'name'=>'ok',
-            'type' => 'int',
-            'default' => 44,
-            'description' => 'Super param.'
+            ParamOption::TYPE => 'int',
+            ParamOption::DEFAULT => 44,
+            ParamOption::DESCRIPTION => 'Super param.'
         ]);
         $this->assertNotNull($param);
         $this->assertEquals('ok', $param->getName());
@@ -234,7 +237,7 @@ public function testSetDefault00() {
         $this->assertEquals('A string.',$rp->getDefault());
         $this->assertFalse($rp->setDefault(44.99));
         $this->assertFalse($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertFalse($rp->setDefault(false));
     }
@@ -249,7 +252,7 @@ public function testSetDefault01() {
         $this->assertEquals('A string.',$rp->getDefault());
         $this->assertFalse($rp->setDefault(44.99));
         $this->assertFalse($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertFalse($rp->setDefault(false));
     }
@@ -264,7 +267,7 @@ public function testSetDefault02() {
         $this->assertEquals('A string.',$rp->getDefault());
         $this->assertFalse($rp->setDefault(44.99));
         $this->assertFalse($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertFalse($rp->setDefault(false));
     }
@@ -278,7 +281,7 @@ public function testSetDefault03() {
         $this->assertEquals(44,$rp->getDefault());
         $this->assertFalse($rp->setDefault(44.99));
         $this->assertFalse($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertFalse($rp->setDefault(false));
     }
@@ -291,7 +294,7 @@ public function testSetDefault04() {
         $this->assertTrue($rp->setDefault(44));
         $this->assertTrue($rp->setDefault(44.99));
         $this->assertFalse($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertFalse($rp->setDefault(false));
     }
@@ -304,7 +307,7 @@ public function testSetDefault05() {
         $this->assertFalse($rp->setDefault(44));
         $this->assertFalse($rp->setDefault(44.99));
         $this->assertFalse($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertTrue($rp->setDefault(false));
     }
@@ -317,7 +320,7 @@ public function testSetDefault06() {
         $this->assertFalse($rp->setDefault(44));
         $this->assertFalse($rp->setDefault(44.99));
         $this->assertTrue($rp->setDefault([]));
-        $this->assertFalse($rp->setDefault(new \Exception()));
+        $this->assertFalse($rp->setDefault(new Exception()));
         $this->assertFalse($rp->setDefault(null));
         $this->assertFalse($rp->setDefault(false));
     }

diff --git a/tests/webfiori/tests/http/WebServiceTest.php b/tests/webfiori/tests/http/WebServiceTest.php
@@ -2,9 +2,12 @@
 namespace webfiori\tests\http;
 
 use PHPUnit\Framework\TestCase;
-use webfiori\tests\http\testServices\TestServiceObj;
+use webfiori\http\ParamOption;
+use webfiori\http\ParamTypes;
+use webfiori\http\RequestMethod;
 use webfiori\http\RequestParameter;
 use webfiori\tests\http\testServices\NoAuthService;
+use webfiori\tests\http\testServices\TestServiceObj;
 
 class WebServiceTest extends TestCase {
     /**
@@ -71,8 +74,8 @@ public function testAddParameter00() {
     public function testAddParameter01() {
         $action = new TestServiceObj('add-user');
         $this->assertTrue($action->addParameter([
-            'name' => 'new-param',
-            'type' => 'boolean'
+            ParamOption::NAME => 'new-param',
+            ParamOption::TYPE => ParamTypes::BOOL
         ]));
 
         $this->assertEquals(1,count($action->getParameters()));
@@ -111,9 +114,9 @@ public function testAddParameters02() {
         $action->addParameters([
             new RequestParameter('username'),
             'password' => [
-                'optional' => true,
-                'default' => 1234,
-                'type' => 'integer'
+                ParamOption::OPTIONAL => true,
+                ParamOption::DEFAULT => 1234,
+                ParamOption::TYPE => 'integer'
             ]
         ]);
         $this->assertEquals(2,count($action->getParameters()));
@@ -273,14 +276,13 @@ public function testToJson00() {
                 .'"request-methods":[],'
                 .'"parameters":[],'
                 .'"responses":[]}',$action->toJSON().'');
-        $action->addRequestMethod('get');
-        $action->addRequestMethod('put');
-        $action->addRequestMethod('post');
+        $action->setRequestMethods([RequestMethod::GET, RequestMethod::POST, RequestMethod::PUT]);
+
         $this->assertEquals(''
                 .'{"name":"login",'
                 .'"since":"1.0.1",'
                 .'"description":"Allow the user to login to the system.",'
-                .'"request-methods":["GET","PUT","POST"],'
+                .'"request-methods":["GET","POST","PUT"],'
                 .'"parameters":[],'
                 .'"responses":[]}',$action->toJSON().'');
         $action->removeRequestMethod('put');
@@ -337,7 +339,7 @@ public function testToJson00() {
      */
     public function testToString00() {
         $action = new TestServiceObj('get-user');
-        $action->addRequestMethod('get');
+        $action->addRequestMethod(RequestMethod::GET);
         $action->addParameter(new RequestParameter('user-id', 'integer'));
         $action->getParameterByName('user-id')->setDescription('The ID of the user.');
         $action->setDescription('Returns a JSON string which holds user profile info.');
@@ -367,8 +369,7 @@ public function testToString00() {
      */
     public function testToString01() {
         $action = new TestServiceObj('add-user');
-        $action->addRequestMethod('post');
-        $action->addRequestMethod('put');
+        $action->setRequestMethods([RequestMethod::POST, RequestMethod::PUT]);
         $action->addParameter(new RequestParameter('username'));
         $action->addParameter(new RequestParameter('email'));
         $action->getParameterByName('username')->setDescription('The username of the user.');

diff --git a/tests/webfiori/tests/http/testServices/AddNubmersService.php b/tests/webfiori/tests/http/testServices/AddNubmersService.php
@@ -2,6 +2,7 @@
 
 namespace webfiori\tests\http\testServices;
 
+use webfiori\http\RequestMethod;
 use webfiori\http\RequestParameter;
 /**
  * Description of AddNubmersService
@@ -12,7 +13,7 @@ class AddNubmersService extends AbstractNumbersService {
     public function __construct() {
         parent::__construct('add-two-integers');
         $this->setDescription('Returns a JSON string that has the sum of two integers.');
-        $this->addRequestMethod('get');
+        $this->addRequestMethod(RequestMethod::GET);
 
         $this->addParameter(new RequestParameter('first-number', 'integer'));
         $this->addParameter(new RequestParameter('second-number', 'integer'));

diff --git a/tests/webfiori/tests/http/testServices/CreateUserProfileService.php b/tests/webfiori/tests/http/testServices/CreateUserProfileService.php
@@ -2,9 +2,12 @@
 
 namespace webfiori\tests\http\testServices;
 
+use Exception;
+use webfiori\http\ParamOption;
+use webfiori\http\ParamTypes;
+use webfiori\http\RequestMethod;
 use webfiori\http\RequestParameter;
 use webfiori\json\Json;
-use Exception;
 /**
  * Description of CreateUserProfileService
  *
@@ -13,20 +16,20 @@
 class CreateUserProfileService extends AbstractNumbersService {
     public function __construct() {
         parent::__construct('create-user-profile');
-        $this->addRequestMethod('post');
+        $this->addRequestMethod(RequestMethod::POST);
         $this->addParameter(new RequestParameter('id', 'integer'));
         $this->getParameterByName('id')->setIsOptional(true);
         $this->addParameters([
             'name' => [
-                'type' => 'string'
+                ParamOption::TYPE => ParamTypes::STRING
             ],
             'username' => [
-                'type' => 'string'
+                ParamOption::TYPE => ParamTypes::STRING
             ],
             'x' => [
-                'type' => 'int',
-                'optional' => true,
-                'default' => 3
+                ParamOption::TYPE => ParamTypes::INT,
+                ParamOption::OPTIONAL => true,
+                ParamOption::DEFAULT => 3
             ]
         ]);
     }

diff --git a/tests/webfiori/tests/http/testServices/GetUserProfileService.php b/tests/webfiori/tests/http/testServices/GetUserProfileService.php
@@ -2,6 +2,7 @@
 
 namespace webfiori\tests\http\testServices;
 
+use webfiori\http\RequestMethod;
 use webfiori\http\RequestParameter;
 use webfiori\json\Json;
 /**
@@ -12,7 +13,7 @@
 class GetUserProfileService extends AbstractNumbersService {
     public function __construct() {
         parent::__construct('get-user-profile');
-        $this->addRequestMethod('post');
+        $this->addRequestMethod(RequestMethod::POST);
         $this->setDescription('Returns a JSON string that has user profile info.');
         $this->addParameter(new RequestParameter('user-id', 'integer'));
     }

diff --git a/tests/webfiori/tests/http/testServices/MulNubmersService.php b/tests/webfiori/tests/http/testServices/MulNubmersService.php
@@ -3,6 +3,7 @@
 namespace webfiori\tests\http\testServices;
 
 use webfiori\http\AbstractWebService;
+use webfiori\http\RequestMethod;
 use webfiori\http\RequestParameter;
 /**
  *
@@ -12,7 +13,7 @@ class MulNubmersService extends AbstractWebService {
     public function __construct() {
         parent::__construct('mul-two-integers');
         $this->setDescription('Returns a JSON string that has the multiplication of two integers.');
-        $this->addRequestMethod('get');
+        $this->addRequestMethod(RequestMethod::GET);
 
         $this->addParameter(new RequestParameter('first-number', 'integer'));
         $this->addParameter(new RequestParameter('second-number', 'integer'));

diff --git a/tests/webfiori/tests/http/testServices/NoAuthService.php b/tests/webfiori/tests/http/testServices/NoAuthService.php
@@ -3,6 +3,7 @@
 namespace webfiori\tests\http\testServices;
 
 use webfiori\http\AbstractWebService;
+use webfiori\http\RequestMethod;
 /**
  * Description of NoAuthService
  *
@@ -12,7 +13,7 @@ class NoAuthService extends AbstractWebService {
     public function __construct() {
         parent::__construct('ok-service');
         $this->setIsAuthRequired(false);
-        $this->addRequestMethod('get');
+        $this->addRequestMethod(RequestMethod::GET);
     }
     public function isAuthorized() {
         return false;

diff --git a/tests/webfiori/tests/http/testServices/NotImplService.php b/tests/webfiori/tests/http/testServices/NotImplService.php
@@ -3,6 +3,7 @@
 namespace webfiori\tests\http\testServices;
 
 use webfiori\http\AbstractWebService;
+use webfiori\http\RequestMethod;
 
 /**
  * Description of NotImplService
@@ -12,7 +13,7 @@
 class NotImplService extends AbstractWebService {
     public function __construct() {
         parent::__construct('not-implemented');
-        $this->addRequestMethod('post');
+        $this->addRequestMethod(RequestMethod::POST);
     }
     public function isAuthorized() {
 

diff --git a/webfiori/http/AbstractWebService.php b/webfiori/http/AbstractWebService.php
@@ -320,6 +320,16 @@ public final function addRequestMethod(string $method) : bool {
 
         return false;
     }
+    /**
+     * Adds multiple request methods as one group.
+     * 
+     * @param array $methods
+     */
+    public function setRequestMethods(array $methods) {
+        foreach ($methods as $m) {
+            $this->addRequestMethod($m);
+        }
+    }
     /**
      * Adds response description.
      * 

diff --git a/webfiori/http/ManagerInfoService.php b/webfiori/http/ManagerInfoService.php
@@ -31,15 +31,14 @@ public function __construct() {
                 .'needed information about all end points which are registered '
                 .'under given manager.');
         $this->addParameter([
-            'name' => 'version',
-            'type' => 'string',
-            'optional' => true,
-            'description' => 'Optional parameter. '
+            ParamOption::NAME => 'version',
+            ParamOption::TYPE => ParamTypes::STRING,
+            ParamOption::OPTIONAL => true,
+            ParamOption::DESCRIPTION => 'Optional parameter. '
                 .'If set, the information that will be returned will be specific '
                 .'to the given version number.'
         ]);
-        $this->addRequestMethod('get');
-        $this->addRequestMethod('post');
+        $this->setRequestMethods(RequestMethod::GET, RequestMethod::POST);
     }
     /**
      * Sends back JSON response that contains information about the services