Headers - Code Metrics - Inspection of "Add API Auth bootstrap and dev scripts." - mkungla/toolshedr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#13)

by Marko

created 2016-10-09 23:43 UTC

Headers A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	12
lcom	1
cbo	0
dl	0
loc	105
ccs	0
cts	32
cp	0
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	addToWhitelist()	4	1
A	areOk()	8	1
A	checkOrigin()	11	3
A	setStatusCode()	8	2
A	containsRequiredHeaders()	5	2
A	send()	5	1
A	setContentType()	4	1

<?php
/**
 * ******************************************************************
 * Created by   Marko Kungla on 09 Oct 2016
 * @package     toolshedr
 * Encoding     UTF-8
 * File         Headers.php
 * Code format  PSR-2 and 12
 * *******************************************************************/

namespace Toolshedr\Core;


class Headers
{
    /**
     * Domains allowed to connect
     * @var array
     */
    private $whitlisted = array();

    private $http_response_code = 200;
    /**
     * Headers constructor.
     */
    public function __construct()
    {
        $this->addToWhitelist('localhost');
    }
    
    /**
     * Whitelist your UI
     *
     * @param $origin
     * @return void
     */
    public function addToWhitelist(string $origin)
    {
        array_push($this->whitlisted, $origin);
    }

    /**
     * Send all headers
     *
     * @return void

     */
    public function areOk()
    {
        header('Access-Control-Allow-Headers: X-Toolshedr-API-KEY');
        header('X-Powered-By: Toolshedr Server');
        header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS');

        return $this->checkOrigin();
    }

    /**
     * Check request origin
     *
     * @return bool
     */
    private function checkOrigin()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!empty($_SERVER['HTTP_ORIGIN']) && in_array($_SERVER['HTTP_ORIGIN'], $this->whitlisted)) {
            header(sprintf('Access-Control-Allow-Origin: %s', $_SERVER['HTTP_ORIGIN']));
            return true;
        } else {
            $this->setStatusCode(403);
            header(sprintf('Access-Control-Allow-Origin: %s', $_SERVER['HTTP_HOST']));
            return false;
        }
    }

    /**
     * Set HTTP Status Code
     * 
     * @param int $code
     */
    public function setStatusCode(int $code)
    {
        // Do not allow overwrite previous code other than 200
        if($this->http_response_code !== 200) return;

        $this->http_response_code = $code;
       
    }

    /**
     * Check does request have required headers
     * 
     * @return bool
     */
    public function containsRequiredHeaders()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        return !empty($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']) && 
            $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS'] === 'x-toolshedr-api-key';
    }

    /**
     * Send remaining headers
     * 
     * @return void
     */
    public function send()
    {
        http_response_code($this->http_response_code);
        $this->setContentType('application/json');
    }

    /**
     * Set output content type
     * 
     * @param string $content_type
     */
    public function setContentType($content_type = 'application/json')
    {
        header(sprintf('Content-Type: %s', $content_type));
    }
}


1			<?php
2			/**
3			* ******************************************************************
4			* Created by Marko Kungla on 09 Oct 2016
5			* @package toolshedr
6			* Encoding UTF-8
7			* File Headers.php
8			* Code format PSR-2 and 12
9			* *******************************************************************/
10
11			namespace Toolshedr\Core;
12
13
14			class Headers
15			{
16			/**
17			* Domains allowed to connect
18			* @var array
19			*/
20			private $whitlisted = array();
21
22			private $http_response_code = 200;
23			/**
24			* Headers constructor.
25			*/
26			public function __construct()
27			{
28			$this->addToWhitelist('localhost');
29			}
30
31			/**
32			* Whitelist your UI
33			*
34			* @param $origin
35			* @return void
36			*/
37			public function addToWhitelist(string $origin)
38			{
39			array_push($this->whitlisted, $origin);
40			}
41
42			/**
43			* Send all headers
44			*
45			* @return void
			0 ignored issues – show Documentation introduced 2016-10-09 23:45 UTC by Report Bug Copy Issue Report Should the return type not be `boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
46			*/
47			public function areOk()
48			{
49			header('Access-Control-Allow-Headers: X-Toolshedr-API-KEY');
50			header('X-Powered-By: Toolshedr Server');
51			header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS');
52
53			return $this->checkOrigin();
54			}
55
56			/**
57			* Check request origin
58			*
59			* @return bool
60			*/
61			private function checkOrigin()
			0 ignored issues – show Coding Style introduced 2016-10-09 23:45 UTC by Report Bug Copy Issue Report `checkOrigin` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
62			{
63			if (!empty($_SERVER['HTTP_ORIGIN']) && in_array($_SERVER['HTTP_ORIGIN'], $this->whitlisted)) {
64			header(sprintf('Access-Control-Allow-Origin: %s', $_SERVER['HTTP_ORIGIN']));
65			return true;
66			} else {
67			$this->setStatusCode(403);
68			header(sprintf('Access-Control-Allow-Origin: %s', $_SERVER['HTTP_HOST']));
69			return false;
70			}
71			}
72
73			/**
74			* Set HTTP Status Code
75			*
76			* @param int $code
77			*/
78			public function setStatusCode(int $code)
79			{
80			// Do not allow overwrite previous code other than 200
81			if($this->http_response_code !== 200) return;
82
83			$this->http_response_code = $code;
84
85			}
86
87			/**
88			* Check does request have required headers
89			*
90			* @return bool
91			*/
92			public function containsRequiredHeaders()
			0 ignored issues – show Coding Style introduced 2016-10-09 23:45 UTC by Report Bug Copy Issue Report `containsRequiredHeaders` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
93			{
94			return !empty($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']) &&
95			$_SERVER['HTTP_ACCESS_CONTROL_REQUEST_HEADERS'] === 'x-toolshedr-api-key';
96			}
97
98			/**
99			* Send remaining headers
100			*
101			* @return void
102			*/
103			public function send()
104			{
105			http_response_code($this->http_response_code);
106			$this->setContentType('application/json');
107			}
108
109			/**
110			* Set output content type
111			*
112			* @param string $content_type
113			*/
114			public function setContentType($content_type = 'application/json')
115			{
116			header(sprintf('Content-Type: %s', $content_type));
117			}
118			}
119

mkungla / toolshedr

Pull Request — master (#13)

Headers A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like