Request::authorize() - Code Metrics - Inspection of "Merge pull request #8 from realpage/authorization" - realpage/json-api-for-lumen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1295a1...d2e260 )

by Ben

created 2016-12-16 14:08 UTC

Request::authorize() A

↳ Parent: Request

Complexity

Conditions	2
Paths	2

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.2
c	0
b	0
f	0
cc	2
eloc	16
nc	2
nop	3

<?php

namespace RealPage\JsonApi\Requests;

use Illuminate\Contracts\Validation\Validator;
use Illuminate\Http\Request as IlluminateRequest;
use Neomerx\JsonApi\Document\Error;
use Neomerx\JsonApi\Document\Link;
use Neomerx\JsonApi\Exceptions\JsonApiException;
use RealPage\JsonApi\Authorization\RequestFailedAuthorization;
use RealPage\JsonApi\ErrorFactory;
use RealPage\JsonApi\Validation\RequestFailedValidation;
use RealPage\JsonApi\Validation\ValidatesRequests;

class Request
{
    /** @var array */
    protected $json;

    /** @var IlluminateRequest */
    protected $request;

    /** @var Validator */
    protected $validator;

    public function __construct(IlluminateRequest $request)

    {
        $this->request = $request;
    }

    /**
     * @throws RequestFailedValidation
     */
    public function validate()
    {
        /** @var ValidatesRequests $validator */
        $validator = $this->validator();

        if ($validator->isValid($this) === false) {
            throw new RequestFailedValidation($validator->errors());
        }
    }

    /**
     * Ensure that a requested operation is authorized.
     * If not, throw an exception.
     *
     * This requires a registered Policy.
     * If no policy is defined,
     * the framework will throw InvalidArgumentException.
     *
     * See also:
     *   https://laravel.com/docs/master/authorization
     *   http://jsonapi.org/format/#errors
     *
     * @param string $action Desired action; must match a policy method name.
     * @param mixed  $object Target object; class must match a policy.
     * @param array  $source Reference to source of error in request.
     *
     * @return bool  True on success; throws exception on failure.
     *
     * @throws RequestFailedAuthorization
     *
     * TODO: use a UUID for the source?
     */
    public function authorize(
        string $action,
        $object,
        array $source = null
    ) {
        if ($this->request()->user()->cant($action, $object)) {
            throw new RequestFailedAuthorization(
                new Error(
                    $id = null,
                    $link = new Link('https://tools.ietf.org/html/rfc7231#section-6.5.3'),
                    $status = '403',
                    $code = null,
                    $title = 'Forbidden',
                    $desc = 'Access is denied for one or more of the specified resources',
                    $source,
                    $meta = null
                )
            );
        }

        return true;
    }

    public function json(): array
    {
        if (!isset($this->json)) {
            $json = json_decode(
                $this->request()->getContent(),
                true, // associative array
                512, // depth
                JSON_UNESCAPED_SLASHES
            );

            if (JSON_ERROR_NONE !== json_last_error()) {
                throw new JsonApiException(new MalformedRequest());
            }

            $this->json = $json;
        }

        return $this->json;
    }

    public function validator() : ValidatesRequests
    {
        return $this->validator;
    }

    public function setValidator(ValidatesRequests $validator)
    {
        $this->validator = $validator;

    }

    public function request(): IlluminateRequest
    {
        return $this->request;
    }
}


1			<?php
2
3			namespace RealPage\JsonApi\Requests;
4
5			use Illuminate\Contracts\Validation\Validator;
6			use Illuminate\Http\Request as IlluminateRequest;
7			use Neomerx\JsonApi\Document\Error;
8			use Neomerx\JsonApi\Document\Link;
9			use Neomerx\JsonApi\Exceptions\JsonApiException;
10			use RealPage\JsonApi\Authorization\RequestFailedAuthorization;
11			use RealPage\JsonApi\ErrorFactory;
12			use RealPage\JsonApi\Validation\RequestFailedValidation;
13			use RealPage\JsonApi\Validation\ValidatesRequests;
14
15			class Request
16			{
17			/** @var array */
18			protected $json;
19
20			/** @var IlluminateRequest */
21			protected $request;
22
23			/** @var Validator */
24			protected $validator;
25
26			public function __construct(IlluminateRequest $request)
			0 ignored issues – show Bug introduced 2016-09-30 17:35 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
27			{
28			$this->request = $request;
29			}
30
31			/**
32			* @throws RequestFailedValidation
33			*/
34			public function validate()
35			{
36			/** @var ValidatesRequests $validator */
37			$validator = $this->validator();
38
39			if ($validator->isValid($this) === false) {
40			throw new RequestFailedValidation($validator->errors());
41			}
42			}
43
44			/**
45			* Ensure that a requested operation is authorized.
46			* If not, throw an exception.
47			*
48			* This requires a registered Policy.
49			* If no policy is defined,
50			* the framework will throw InvalidArgumentException.
51			*
52			* See also:
53			* https://laravel.com/docs/master/authorization
54			* http://jsonapi.org/format/#errors
55			*
56			* @param string $action Desired action; must match a policy method name.
57			* @param mixed $object Target object; class must match a policy.
58			* @param array $source Reference to source of error in request.
59			*
60			* @return bool True on success; throws exception on failure.
61			*
62			* @throws RequestFailedAuthorization
63			*
64			* TODO: use a UUID for the source?
65			*/
66			public function authorize(
67			string $action,
68			$object,
69			array $source = null
70			) {
71			if ($this->request()->user()->cant($action, $object)) {
72			throw new RequestFailedAuthorization(
73			new Error(
74			$id = null,
75			$link = new Link('https://tools.ietf.org/html/rfc7231#section-6.5.3'),
76			$status = '403',
77			$code = null,
78			$title = 'Forbidden',
79			$desc = 'Access is denied for one or more of the specified resources',
80			$source,
81			$meta = null
82			)
83			);
84			}
85
86			return true;
87			}
88
89			public function json(): array
90			{
91			if (!isset($this->json)) {
92			$json = json_decode(
93			$this->request()->getContent(),
94			true, // associative array
95			512, // depth
96			JSON_UNESCAPED_SLASHES
97			);
98
99			if (JSON_ERROR_NONE !== json_last_error()) {
100			throw new JsonApiException(new MalformedRequest());
101			}
102
103			$this->json = $json;
104			}
105
106			return $this->json;
107			}
108
109			public function validator() : ValidatesRequests
110			{
111			return $this->validator;
112			}
113
114			public function setValidator(ValidatesRequests $validator)
115			{
116			$this->validator = $validator;
			0 ignored issues – show Documentation Bug introduced 2016-11-07 14:26 UTC by Report Bug Copy Issue Report It seems like `$validator` of type `object<RealPage\JsonApi\...tion\ValidatesRequests>` is incompatible with the declared type `object<Illuminate\Contracts\Validation\Validator>` of property `$validator`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
117			}
118
119			public function request(): IlluminateRequest
120			{
121			return $this->request;
122			}
123			}
124

realpage / json-api-for-lumen

Push — master ( 1295a1...d2e260 )

Request::authorize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like