francis94c / ci-rest

libraries/REST.php

Indentation +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
     $auths = null;
     foreach ($uri_auths as $uri => $auth_array) {
       // Convert wildcards to RegEx.
-			$uri = str_replace(array(':any', ':num'), array('[^/]+', '[0-9]+'), $uri);
+   $uri = str_replace(array(':any', ':num'), array('[^/]+', '[0-9]+'), $uri);
       if (preg_match('#^'.$uri.'$#', uri_string())) $auths = $auth_array; // Assign Authentication Steps.
       break;
     }

Braces +28 added lines, -8 removed lines

@@ -138,16 +138,24 @@ 
     // Match Auth Routes.
     // The below algorithm is similar to the one Code Igniter uses in its
     // Routing Class.
-    if ($uri_auths == null || !is_array($uri_auths)) return;
+    if ($uri_auths == null || !is_array($uri_auths)) {
+     return;
+    }
     $auths = null;
     foreach ($uri_auths as $uri => $auth_array) {
       // Convert wildcards to RegEx.
 			$uri = str_replace(array(':any', ':num'), array('[^/]+', '[0-9]+'), $uri);
-      if (preg_match('#^'.$uri.'$#', uri_string())) $auths = $auth_array; // Assign Authentication Steps.
+      if (preg_match('#^'.$uri.'$#', uri_string())) {
+       $auths = $auth_array;
+      }
+      // Assign Authentication Steps.
       break;
     }
     //$auths = $this->ci->config->item('rest')['uri_auth'][uri_string()] ?? null;
-    if ($auths == null) return; // No authentication(s) to acrry out.
+    if ($auths == null) {
+     return;
+    }
+    // No authentication(s) to acrry out.
     // $this->process_auth() terminates the script if authentication fails
     // It will call the callable in the rest.php config file under
     // response_callbacks which matches the necesarry RESTResponse constant
@@ -157,7 +165,9 @@ 
       $this->process_auth($auths);
       return;
     }
-    foreach ($auths as $auth) $this->process_auth($auth);
+    foreach ($auths as $auth) {
+     $this->process_auth($auth);
+    }
   }
   /**
    * [process_auth description]
@@ -202,8 +212,14 @@ 
   private function basic_auth():void {
     $username = $_SERVER['PHP_AUTH_USER'] ?? null;
     $password = $_SERVER['PHP_AUTH_PW'] ?? null;
-    if (!$username || !$password) $this->handle_response(RESTResponse::BAD_REQUEST, RESTAuth::BASIC); // Exits.
-    if (!$this->rest_model->basicAuth($this, $username, $password)) $this->handle_response(RESTResponse::UN_AUTHORIZED, RESTAuth::BASIC); // Exits.
+    if (!$username || !$password) {
+     $this->handle_response(RESTResponse::BAD_REQUEST, RESTAuth::BASIC);
+    }
+    // Exits.
+    if (!$this->rest_model->basicAuth($this, $username, $password)) {
+     $this->handle_response(RESTResponse::UN_AUTHORIZED, RESTAuth::BASIC);
+    }
+    // Exits.
   }
   /**
    * [api_key_auth description]
@@ -263,7 +279,9 @@ 
     // Trunctate Rate Limit Data.
     $this->rest_model->truncateRatelimitData();
     // Check Whitelist.
-    if (in_array($this->ci->input->ip_address(), $this->whitelist)) return;
+    if (in_array($this->ci->input->ip_address(), $this->whitelist)) {
+     return;
+    }
     // Should we acyually Limit?
     if ($this->ip_per_hour > 0) {
       $client = hash('md5', $this->ci->input->ip_address());
@@ -339,7 +357,9 @@ 
     if (isset($this->ci->config->item('rest')['response_callbacks'][$code])) {
       $this->ci->config->item('rest')['response_callbacks'][$code]($auth);
     }
-    if (ENVIRONMENT != 'testing') exit($code);
+    if (ENVIRONMENT != 'testing') {
+     exit($code);
+    }
     throw new Exception("Error $code in $auth", $code);
   }
 }

Spacing +10 added lines, -10 removed lines

@@ -83,7 +83,7 @@ 
    * [PACKAGE description]
    * @var string
    */
-  const   PACKAGE    = "francis94c/ci-rest";
+  const   PACKAGE = "francis94c/ci-rest";
   /**
    * [RATE_LIMIT description]
    * @var string
@@ -97,8 +97,8 @@ 
    * @param array|null $params Initialization parameters from the Slint system.
    *                           There's no use for this arg yet.
    */
-  function __construct($params=null) {
-    $this->ci =& get_instance();
+  function __construct($params = null) {
+    $this->ci = & get_instance();
     // Load Config If Exists.
     $this->ci->config->load('rest', true, true);
     // Load Database.
@@ -109,7 +109,7 @@ 
     $this->ci->load->splint(self::PACKAGE, '%rest');
     // Load Model.
     $this->ci->load->splint(self::PACKAGE, '*RESTModel', 'rest_model');
-    $this->rest_model =& $this->ci->rest_model;
+    $this->rest_model = & $this->ci->rest_model;
     $config = [
       'users_table'           => $this->ci->config->item('rest')['basic_auth']['users_table'] ?? null,
       'users_id_column'       => $this->ci->config->item('rest')['basic_auth']['id_column'] ?? null,
@@ -198,7 +198,7 @@ 
   /**
    * [bearer_auth description]
    */
-  private function bearer_auth($auth=RESTAuth::BEARER):void {
+  private function bearer_auth($auth = RESTAuth::BEARER):void {
     $authorization = $this->get_authorization_header();
     if ($authorization == null || substr_count($authorization, " ") != 1) {
       $this->handle_response(RESTResponse::BAD_REQUEST, $auth); // Exits.
@@ -231,11 +231,11 @@ 
    * [api_key_auth description]
    */
   private function api_key_auth():void {
-    if (!isset($_SERVER['HTTP_' . str_replace("-", "_", $this->apiKeyHeader)])) {
+    if (!isset($_SERVER['HTTP_'.str_replace("-", "_", $this->apiKeyHeader)])) {
       $this->handle_response(RESTResponse::BAD_REQUEST, RESTAuth::API_KEY); // Exits.
     }
     $apiKey = $this->rest_model->getAPIKeyData(
-      $_SERVER['HTTP_' . str_replace("-", "_", $this->apiKeyHeader)]
+      $_SERVER['HTTP_'.str_replace("-", "_", $this->apiKeyHeader)]
     );
     if ($apiKey == null) {
       $this->handle_response(RESTResponse::UN_AUTHORIZED, RESTAuth::API_KEY); // Exits.
@@ -251,7 +251,7 @@ 
       }
       // Should we acyually Limit?
       if ($this->per_hour > 0) {
-        $client = hash('md5', $this->ci->input->ip_address() . "%" . $apiKey[$this->api_key_column]);
+        $client = hash('md5', $this->ci->input->ip_address()."%".$apiKey[$this->api_key_column]);
         $limitData = $this->rest_model->getLimitData($client, '_api_keyed_user');
         if ($limitData == null) {
           $limitData = [];
@@ -334,7 +334,7 @@ 
    * [get_authorization_header description]
    * @return [type] [description]
    */
-  private function get_authorization_header():?string {
+  private function get_authorization_header(): ?string {
     if (isset($_SERVER['Authorization'])) {
       return trim($_SERVER["Authorization"]);
     } else if (isset($_SERVER['HTTP_AUTHORIZATION'])) { //Nginx or fast CGI
@@ -355,7 +355,7 @@ 
    * [handle_response description]
    * @param int $code [description]
    */
-  private function handle_response(int $code, $auth=null):void {
+  private function handle_response(int $code, $auth = null):void {
     http_response_code($code);
     header("Content-Type: application/json");
     if (isset($this->ci->config->item('rest')['response_callbacks'][$code])) {

models/RESTModel.php

Spacing +2 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
    * @param  string $apiKey [description]
    * @return array          [description]
    */
-  public function getAPIKeyData(string $apiKey):?array {
+  public function getAPIKeyData(string $apiKey): ?array {
     // Preliminary Check.
     if ($this->api_key_table == null || $this->api_key_column == null) return null;
     // Query.
@@ -120,7 +120,7 @@ 
    * @param  string $group  [description]
    * @return [type]         [description]
    */
-  public function getLimitData(string $client, string $group):?array {
+  public function getLimitData(string $client, string $group): ?array {
     $sql = 'SELECT count, start, (`start` + INTERVAL (1 - TIMESTAMPDIFF(HOUR, UTC_TIMESTAMP(), NOW())) HOUR) AS reset_epoch FROM rest_api_rate_limit WHERE client = ? AND _group = ?';
     $query = $this->db->query($sql, [$client, $group]);
     if (!is_scalar($query) && $query->num_rows() > 0) return $query->result_array()[0];

Braces +18 added lines, -6 removed lines

@@ -81,10 +81,14 @@ 
       $this->db->or_where($this->users_username_column, $username);
     }
     $query = $this->db->get();
-    if ($query->num_rows() == 0) return false;
+    if ($query->num_rows() == 0) {
+     return false;
+    }
     // Authenticate.
     if (password_verify($password, $query->result()[0]->{$this->users_password_column})) {
-      if ($this->users_id_column != null) $context->userId = $query->result()[0]->{$this->users_id_column};
+      if ($this->users_id_column != null) {
+       $context->userId = $query->result()[0]->{$this->users_id_column};
+      }
       return true;
     }
     return false;
@@ -96,15 +100,21 @@ 
    */
   public function getAPIKeyData(string $apiKey):?array {
     // Preliminary Check.
-    if ($this->api_key_table == null || $this->api_key_column == null) return null;
+    if ($this->api_key_table == null || $this->api_key_column == null) {
+     return null;
+    }
     // Query.
     $this->db->select($this->api_key_column);
-    if ($this->api_key_limit_column != null) $this->db->select($this->api_key_limit_column);
+    if ($this->api_key_limit_column != null) {
+     $this->db->select($this->api_key_limit_column);
+    }
     $this->db->from($this->api_key_table);
     $this->db->where($this->api_key_column, $apiKey);
     $query = $this->db->get();
     // Process Result.
-    if ($query->num_rows() > 0) return $query->result_array()[0];
+    if ($query->num_rows() > 0) {
+     return $query->result_array()[0];
+    }
     return null;
   }
   /**
@@ -123,7 +133,9 @@ 
   public function getLimitData(string $client, string $group):?array {
     $sql = 'SELECT count, start, (`start` + INTERVAL (1 - TIMESTAMPDIFF(HOUR, UTC_TIMESTAMP(), NOW())) HOUR) AS reset_epoch FROM rest_api_rate_limit WHERE client = ? AND _group = ?';
     $query = $this->db->query($sql, [$client, $group]);
-    if (!is_scalar($query) && $query->num_rows() > 0) return $query->result_array()[0];
+    if (!is_scalar($query) && $query->num_rows() > 0) {
+     return $query->result_array()[0];
+    }
     return null;
   }
   /**

phpunit/BasicAuthTest.php

Spacing +4 added lines, -4 removed lines

@@ -22,10 +22,10 @@ 
    * @covers JWT::__construct
    */
   public static function setUpBeforeClass(): void {
-    self::$ci =& get_instance();
+    self::$ci = & get_instance();
     self::$ci->load->database('mysqli://root@localhost/test_db');
     self::$ci->load->helper("url");
-    $queries = explode("#@@@", file_get_contents(FCPATH . 'application/splints/' . self::PACKAGE . '/phpunit/database.sql'));
+    $queries = explode("#@@@", file_get_contents(FCPATH.'application/splints/'.self::PACKAGE.'/phpunit/database.sql'));
     self::assertTrue(count($queries) > 0);
     self::$ci->load->database();
     foreach ($queries as $query) {
@@ -41,7 +41,7 @@ 
     // However, for the purpose of this test, we are going to Hack Code CodeIgniter
     // with a Splint Config variable to allow us load config files from where
     // ever we want. This happens below.
-    self::$ci->load->add_package_path(APPPATH . 'splints/' . self::PACKAGE . "/phpunit/");
+    self::$ci->load->add_package_path(APPPATH.'splints/'.self::PACKAGE."/phpunit/");
     //self::$ci->config->set_item('st_config_path_prefix', '../splints/' . self::PACKAGE . "/phpunit/config/");
   }
   /**
@@ -58,7 +58,7 @@ 
     $_SERVER['PHP_AUTH_PW'] = "012345678901234567890";
     self::$ci->config->set_item('expected_uri', 'basic/auth');
     self::$ci->config->set_item('expected_auth', RESTAuth::BASIC);
-    $this->expectExceptionMessage('Error ' . RESTResponse::UN_AUTHORIZED . ' in ' . RESTAuth::BASIC);
+    $this->expectExceptionMessage('Error '.RESTResponse::UN_AUTHORIZED.' in '.RESTAuth::BASIC);
     self::$ci->load->splint(self::PACKAGE, '+REST', null, 'basic_rest_2');
   }
   /**

phpunit/APIKeyAuthAuthTest.php

Spacing +2 added lines, -2 removed lines

@@ -22,10 +22,10 @@
    * @covers JWT::__construct
    */
   public static function setUpBeforeClass(): void {
-    self::$ci =& get_instance();
+    self::$ci = & get_instance();
     self::$ci->load->database('mysqli://root@localhost/test_db');
     self::$ci->load->helper("url");
-    $queries = explode("#@@@", file_get_contents(FCPATH . 'application/splints/' . self::PACKAGE . '/phpunit/database.sql'));
+    $queries = explode("#@@@", file_get_contents(FCPATH.'application/splints/'.self::PACKAGE.'/phpunit/database.sql'));
     self::assertTrue(count($queries) > 0);
     self::$ci->load->database();
     foreach ($queries as $query) {

phpunit/config/rest.php

Spacing +6 added lines, -6 removed lines

@@ -11,19 +11,19 @@ 
 
 $config['auth_callbacks'] = [
 
-  RESTAuth::CUSTOM('X-APP-ID')    => function (&$context, $value):bool {
+  RESTAuth::CUSTOM('X-APP-ID')    => function(&$context, $value):bool {
     return true;
   },
 
-  RESTAuth::CUSTOM('X-DEVICE-ID') => function (&$context, $value):bool {
+  RESTAuth::CUSTOM('X-DEVICE-ID') => function(&$context, $value):bool {
     return true;
   },
 
-  RESTAuth::BEARER                => function (&$context, $token):bool {
+  RESTAuth::BEARER                => function(&$context, $token):bool {
     return true;
   },
 
-  RESTAuth::OAUTH2                => function (&$context, $token):bool {
+  RESTAuth::OAUTH2                => function(&$context, $token):bool {
     return true;
   }
 
@@ -38,8 +38,8 @@ 
   },
 
   RESTResponse::UN_AUTHORIZED      => function(&$auth):void {
-    $ci =& get_instance();
-    Assert::assertTrue(uri_string() == $ci->config->item('expected_uri')&& $auth == $ci->config->item('expected_auth'));
+    $ci = & get_instance();
+    Assert::assertTrue(uri_string() == $ci->config->item('expected_uri') && $auth == $ci->config->item('expected_auth'));
   },
 
   RESTResponse::NOT_ACCEPTABLE     => function(&$auth):void {

libraries/RESTAuth.php

Spacing +4 added lines, -4 removed lines

@@ -6,7 +6,7 @@ 
    * [BasicAuth description]
    * @var string
    */
-  const BASIC   = "Basic";
+  const BASIC = "Basic";
   /**
    * [API_KEY description]
    * @var string
@@ -16,17 +16,17 @@ 
    * [BEARER description]
    * @var string
    */
-  const BEARER  = "Bearer";
+  const BEARER = "Bearer";
   /**
    * [OAUTH2 description]
    * @var string
    */
-  const OAUTH2  = "OAUTH2";
+  const OAUTH2 = "OAUTH2";
   /**
    * [IP description]
    * @var string
    */
-  const IP      = "IP";
+  const IP = "IP";
   /**
    * [CUSTOM description]
    * @param  string $header [description]

helpers/rest_helper.php

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 declare(strict_types=1);
 
 if (!function_exists('response')) {
-  function response($data=null, int $code=null):RESTResponse
+  function response($data = null, int $code = null):RESTResponse
   {
     return new RESTResponse($data, $code);
   }

libraries/RESTResponse.php

Spacing +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
    * @var bool
    */
   protected $json;
-  function __construct($data=null, int $code=null)
+  function __construct($data = null, int $code = null)
   {
     $this->data = $data;
     $this->code = $code;
@@ -61,7 +61,7 @@ 
    * @date  2019-11-11
    * @param boolean    $exit [description]
    */
-  public function send(bool $exit=false):void
+  public function send(bool $exit = false):void
   {
     http_response_code($this->code ?? 200);
 

Braces +9 added lines, -3 removed lines

@@ -65,11 +65,17 @@
   {
     http_response_code($this->code ?? 200);
 
-    if ($this->json) header('Content-Type: application/json');
+    if ($this->json) {
+     header('Content-Type: application/json');
+    }
 
-    if ($this->data !== null) echo !$this->json ? $this->data : json_encode($this->data, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES);
+    if ($this->data !== null) {
+     echo !$this->json ? $this->data : json_encode($this->data, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES);
+    }
 
-    if ($exit) exit(EXIT_SUCCESS);
+    if ($exit) {
+     exit(EXIT_SUCCESS);
+    }
   }
 }
 ?>