Merge pull request #25 from WebFiori/dev

Fix to Small bug + Improvements
WebFiori · Jun 25, 2022 · 932c478 · 932c478
2 parents f1d18c2 + 84c2e8e
commit 932c478
Show file tree

Hide file tree

Showing 14 changed files with 130 additions and 73 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
- Copyright 2019 Ibrahim BinAlshikh, restEasy library.
+ Copyright 2019 Ibrahim BinAlshikh, WebFiori HTTP.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ It includes inputs feltering and data validation in addion to creating user-defi
   <a href="https://sonarcloud.io/dashboard?id=WebFiori_http">
       <img src="https://sonarcloud.io/api/project_badges/measure?project=WebFiori_http&metric=alert_status" />
   </a>
-  <a href="https://github.com/WebFiori/restEasy/releases">
+  <a href="https://github.com/WebFiori/http/releases">
       <img src="https://img.shields.io/github/release/WebFiori/http.svg?label=latest" />
   </a>
   <a href="https://packagist.org/packages/webfiori/http">

diff --git a/tests/webfiori/tests/http/HttpCookieTest.php b/tests/webfiori/tests/http/HttpCookieTest.php
@@ -39,7 +39,7 @@ public function testConstructor01() {
         $this->assertEquals('/b/a/m', $cookie->getPath());
         $this->assertEquals('', $cookie->getLifetime());
         $cookie->setExpires(10);
-        $expires = date(DATE_COOKIE, time() + 10);
+        $expires = date(DATE_COOKIE, time() + 10*60);
         $this->assertTrue($cookie->isPersistent());
         $this->assertEquals($expires, $cookie->getLifetime());
         $this->assertEquals('Lax', $cookie->getSameSite());
@@ -52,8 +52,8 @@ public function testConstructor01() {
         $this->assertTrue($cookie->isHttpOnly());
         $this->assertTrue($cookie->isSecure());
         $cookie->setExpires(-1);
-        $expires = date(DATE_COOKIE, time() - 1);
-        $this->assertEquals(time() - 1, $cookie->getExpires());
+        $expires = date(DATE_COOKIE, time() - 1*60);
+        $this->assertEquals(time() - 1*60, $cookie->getExpires());
         $this->assertEquals($expires, $cookie->getLifetime());
         $this->assertEquals('super=cool; expires='.$expires.'; path=/b/a/m; Secure; HttpOnly; SameSite=None', $cookie->getHeaderString());
         $cookie->setExpires(0);
@@ -87,4 +87,25 @@ public function testConstructor03() {
         $cookie->kill();
         $this->assertEquals(date(DATE_COOKIE, time() - 60*60*24), $cookie->getLifetime());
     }
+    /**
+     * @test
+     */
+    public function testRemainingTime00() {
+        $cookie = new HttpCookie();
+        $this->assertEquals(0, $cookie->getRemainingTime());
+        $cookie->setExpires(1);
+        $this->assertEquals(60, $cookie->getRemainingTime());
+        sleep(3);
+        $this->assertEquals(57, $cookie->getRemainingTime());
+    }
+    /**
+     * @test
+     */
+    public function testRemainingTime01() {
+        $cookie = new HttpCookie();
+        $cookie->setExpires(0.1);
+        $this->assertEquals(6, $cookie->getRemainingTime());
+        sleep(8);
+        $this->assertEquals(0, $cookie->getRemainingTime());
+    }
 }
diff --git a/tests/webfiori/tests/http/RequestParameterTest.php b/tests/webfiori/tests/http/RequestParameterTest.php
@@ -3,6 +3,7 @@
 
 use PHPUnit\Framework\TestCase;
 use webfiori\http\RequestParameter;
+use webfiori\http\APIFilter;
 /**
  * Description of RequestParameterTest
  *
@@ -36,7 +37,7 @@ public function testCreateParameter02() {
             'min' => 33,
             'max' => 100,
             'custom-filter' => function ($original, $basicFilterResult, $param) {
-                if ($basicFilterResult != \restEasy\APIFilter::INVALID) {
+                if ($basicFilterResult != APIFilter::INVALID) {
                     return $basicFilterResult * 100;
                 }
             }

diff --git a/tests/webfiori/tests/http/UriTest.php b/tests/webfiori/tests/http/UriTest.php
@@ -83,6 +83,7 @@ public function testParams01() {
         $uri->setParameterValue('first-var', '1009');
         $this->assertEquals(['first-var'], $uri->getParametersNames());
         $this->assertEquals('1009', $uri->getParameter('first-var')->getValue());
+        $this->assertFalse($uri->setParameterValue('not-exist', 'hello'));
     }
     /**
      * @test

diff --git a/tests/webfiori/tests/http/WebServiceTest.php b/tests/webfiori/tests/http/WebServiceTest.php
@@ -16,6 +16,7 @@ public function testGetAuthHeaders00() {
             'scheme' => '',
             'credentials' => ''
         ],$service->getAuthHeader());
+        $this->assertNull($service->isAuthorized());
     }
     /**
      * 

diff --git a/tests/webfiori/tests/http/testServices/TestServiceObj.php b/tests/webfiori/tests/http/testServices/TestServiceObj.php
@@ -14,7 +14,7 @@ public function __construct($name) {
     }
     //put your code here
     public function isAuthorized() {
-
+        return parent::isAuthorized();
     }
 
     public function processRequest() {

diff --git a/webfiori/http/APIFilter.php b/webfiori/http/APIFilter.php
@@ -3,7 +3,7 @@
 /* 
  * The MIT License
  *
- * Copyright 2019 Ibrahim BinAlshikh, restEasy library.
+ * Copyright 2019 Ibrahim BinAlshikh, WebFiori HTTP.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/webfiori/http/AbstractWebService.php b/webfiori/http/AbstractWebService.php
@@ -3,7 +3,7 @@
 /* 
  * The MIT License
  *
- * Copyright 2019 Ibrahim BinAlshikh, restEasy library.
+ * Copyright 2019 Ibrahim BinAlshikh, WebFiori HTTP.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/webfiori/http/HttpCookie.php b/webfiori/http/HttpCookie.php
@@ -25,6 +25,18 @@ class HttpCookie {
     private $val;
     /**
      * Creates new instance of the class with default properties.
+     * 
+     * A newly created cookie will have following properties by default:
+     * <ul>
+     * <li>name: new-cookie</li>
+     * <li>path: /</li>
+     * <li>secure: true</li>
+     * <li>http only: true</li>
+     * <li>domain: The domain at which the library is operating from.</li>
+     * <li>same site: Lax</li>
+     * <li>expires: 0</li>
+     * <li>value: sha256 hash</li>
+     * </ul>
      */
     public function __construct() {
         $this->httpOnly = true;
@@ -133,6 +145,26 @@ public function getName() : string {
     public function getPath() : string {
         return $this->path;
     }
+    /**
+     * Returns number of seconds before the cookie expires.
+     * 
+     * @return int If the cookie is non-persistent or the cookie has expired,
+     * the method will always return 0. Other than that, the method will return
+     * number of seconds remaining before the cookie dies.
+     */
+    public function getRemainingTime() : int {
+        $expiresAt = $this->getExpires();
+
+        if ($expiresAt == 0) {
+            return 0;
+        }
+        $remaining = $expiresAt - time();
+
+        if ($remaining < 0) {
+            return 0;
+        }
+        return $remaining;
+    }
     /**
      * Returns the value of the attribute 'SameSite'.
      * 
@@ -231,7 +263,7 @@ public function setExpires(float $expireAfter) {
 
             return;
         }
-        $this->expires = time() + $expireAfter;
+        $this->expires = time() + $expireAfter*60;
     }
     /**
      * Sets the attribute 'HttpOnly'.

diff --git a/webfiori/http/ManagerInfoService.php b/webfiori/http/ManagerInfoService.php
@@ -3,7 +3,7 @@
 /*
  * The MIT License
  *
- * Copyright 2020 Ibrahim BinAlshikh, restEasy library.
+ * Copyright 2020 Ibrahim BinAlshikh, WebFiori HTTP.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/webfiori/http/RequestParameter.php b/webfiori/http/RequestParameter.php
@@ -3,7 +3,7 @@
 /* 
  * The MIT License
  *
- * Copyright 2019 Ibrahim BinAlshikh, restEasy library.
+ * Copyright 2019 Ibrahim BinAlshikh, WebFiori HTTP.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/webfiori/http/Uri.php b/webfiori/http/Uri.php
@@ -72,7 +72,7 @@ public function __construct(string $requestedUri) {
         if (gettype($this->uriBroken) != 'array') {
             throw new InvalidArgumentException('Invalid URI given.');
         }
-        
+
         if (!$this->checkOptionalParamsOrder()) {
             throw  new InvalidArgumentException('Inncorrect parameters order.');
         }
@@ -82,19 +82,6 @@ public function __construct(string $requestedUri) {
             $this->uriBroken['vars-possible-values'][$varName] = [];
         }
     }
-    private function checkOptionalParamsOrder() {
-        $hasOptional = false;
-
-        foreach ($this->getParameters() as $obj) {
-            $hasOptional = $hasOptional || $obj->isOptional();
-            if ($hasOptional && !$obj->isOptional()) {
-
-                return false;
-            }
-        }
-
-        return true;
-    }
 
     /**
      * Adds a request method to the allowed set of methods at which the URI can 
@@ -340,6 +327,50 @@ public function getParametersNames() : array {
 
         return $retVal;
     }
+    /**
+     * Returns the value of URI parameter given its name.
+     * 
+     * A URI parameter is a string which is defined while creating the route. 
+     * it is name is included between '{}'.
+     * 
+     * @param string $varName The name of the parameter. Note that this value 
+     * must not include braces.
+     * 
+     * @return string|null The method will return the value of the 
+     * parameter if found. If the parameter is not set or the parameter 
+     * does not exist, the method will return null.
+     * 
+     * @since 1.0
+     */
+    public function getParameterValue(string $varName) {
+        $param = $this->getParameter($varName);
+
+        if ($param !== null) {
+            return $param->getValue();
+        }
+
+        return null;
+    }
+    /**
+     * Returns an array that contains possible values for a URI parameter.
+     * 
+     * @param string $varName The name of the parameter.
+     * 
+     * @return array The method will return an array that contains all possible 
+     * values for the parameter which was added using the method Router::addUriVarValue(). 
+     * If the parameter does not exist, the array will be empty.
+     * 
+     * @since 1.3.6
+     */
+    public function getParameterValues(string $varName) {
+        $trimmed = trim($varName);
+
+        if (isset($this->uriBroken['vars-possible-values'][$trimmed])) {
+            return $this->uriBroken['vars-possible-values'][$trimmed];
+        }
+
+        return [];
+    }
     /**
      * Returns the path part of the URI.
      * 
@@ -472,49 +503,6 @@ public function getUri(bool $incQueryStr = false, bool $incFragment = false) {
 
         return $retVal;
     }
-    /**
-     * Returns the value of URI parameter given its name.
-     * 
-     * A URI parameter is a string which is defined while creating the route. 
-     * it is name is included between '{}'.
-     * 
-     * @param string $varName The name of the parameter. Note that this value 
-     * must not include braces.
-     * 
-     * @return string|null The method will return the value of the 
-     * parameter if found. If the parameter is not set or the parameter 
-     * does not exist, the method will return null.
-     * 
-     * @since 1.0
-     */
-    public function getParameterValue(string $varName) {
-        $param = $this->getParameter($varName);
-        if ($param !== null) {
-            return $param->getValue();
-        }
-
-        return null;
-    }
-    /**
-     * Returns an array that contains possible values for a URI parameter.
-     * 
-     * @param string $varName The name of the parameter.
-     * 
-     * @return array The method will return an array that contains all possible 
-     * values for the parameter which was added using the method Router::addUriVarValue(). 
-     * If the parameter does not exist, the array will be empty.
-     * 
-     * @since 1.3.6
-     */
-    public function getParameterValues(string $varName) {
-        $trimmed = trim($varName);
-
-        if (isset($this->uriBroken['vars-possible-values'][$trimmed])) {
-            return $this->uriBroken['vars-possible-values'][$trimmed];
-        }
-
-        return [];
-    }
     /**
      * Checks if the URI has a parameter or not given its name.
      * 
@@ -562,7 +550,7 @@ public function isAllParametersSet() : bool {
 
         return $canRoute;
     }
-    
+
     /**
      * Checks if URI is fetched using allowed request method or not.
      * 
@@ -578,7 +566,7 @@ public function isRequestMethodAllowed() : bool {
 
         return count($methods) == 0 || in_array(Request::getMethod(), $this->getRequestMethods());
     }
-    
+
     /**
      * Sets the value of a URI parameter.
      * 
@@ -726,7 +714,7 @@ public static function splitURI(string $uri) {
 
         return $retVal;
     }
-    
+
     /**
      * Splits a string based on character mask.
      * 
@@ -764,4 +752,17 @@ private static function _queryOrFragment($split, $char, $encoded) {
 
         return $split2;
     }
+    private function checkOptionalParamsOrder() {
+        $hasOptional = false;
+
+        foreach ($this->getParameters() as $obj) {
+            $hasOptional = $hasOptional || $obj->isOptional();
+
+            if ($hasOptional && !$obj->isOptional()) {
+                return false;
+            }
+        }
+
+        return true;
+    }
 }
diff --git a/webfiori/http/WebServicesManager.php b/webfiori/http/WebServicesManager.php
@@ -2,7 +2,7 @@
 /*
  * The MIT License
  *
- * Copyright 2019 Ibrahim BinAlshikh, restEasy library.
+ * Copyright 2019 Ibrahim BinAlshikh, WebFiori HTTP.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal