Controller::guardAgainstInvalidRequest() - Code Metrics - Inspection of "refactor to improve readability" - spatie/laravel-slack-slash-command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9ca3c4...0e5848 )

by Freek

created 2016-07-13 20:00 UTC

Controller::guardAgainstInvalidRequest() A

↳ Parent: Controller

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	3
nop	0

<?php

namespace Spatie\SlashCommand;

use Illuminate\Config\Repository;
use Illuminate\Http\Request as IlluminateRequest;
use Illuminate\Http\Response as IlluminateResponse;
use Illuminate\Routing\Controller as IlluminateController;
use Spatie\SlashCommand\Exceptions\InvalidHandler;
use Spatie\SlashCommand\Exceptions\InvalidRequest;
use Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled;

class Controller extends IlluminateController
{
    /** @var \Spatie\SlashCommand\Request */
    protected $request;

    /** @var \Illuminate\Support\Collection */
    protected $config;

    public function __construct(IlluminateRequest $request, Repository $config)
    {
        $this->request = Request::createFromIlluminateRequest($request);

        $this->config = collect($config->get('laravel-slack-slash-command'));
    }

    public function getResponse(): IlluminateResponse
    {
        $this->guardAgainstInvalidRequest();

        $handler = $this->determineHandler();

        $response = $handler->handle($this->request);

        return $response->getIlluminateResponse();
    }

    protected function guardAgainstInvalidRequest()
    {
        if (!request()->has('token')) {
            throw InvalidRequest::tokenNotFound();
        }

        if ($this->request->get('token') != $this->config->get('verification_token')) {
            throw InvalidRequest::invalidToken($this->request->get('token'));
        }
    }

    /**
     * @return \Spatie\SlashCommand\Handlers\BaseHandler
     *
     * @throws \Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled
     */
    protected function determineHandler()
    {
        $handler = collect($this->config->get('handlers'))
            ->map(function (string $handlerClassName) {

                if (! class_exists($handlerClassName)) {
                    throw InvalidHandler::handlerDoesNotExist($handlerClassName);
                }

                return new $handlerClassName($this->request);
            })
            ->filter(function (HandlesSlashCommand $handler) {
                return $handler->canHandle($this->request);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            })
            ->first();

        if (!$handler) {
            throw RequestCouldNotBeHandled::noHandlerFound($this->request);
        }

        return $handler;
    }
}


1			<?php
2
3			namespace Spatie\SlashCommand;
4
5			use Illuminate\Config\Repository;
6			use Illuminate\Http\Request as IlluminateRequest;
7			use Illuminate\Http\Response as IlluminateResponse;
8			use Illuminate\Routing\Controller as IlluminateController;
9			use Spatie\SlashCommand\Exceptions\InvalidHandler;
10			use Spatie\SlashCommand\Exceptions\InvalidRequest;
11			use Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled;
12
13			class Controller extends IlluminateController
14			{
15			/** @var \Spatie\SlashCommand\Request */
16			protected $request;
17
18			/** @var \Illuminate\Support\Collection */
19			protected $config;
20
21			public function __construct(IlluminateRequest $request, Repository $config)
22			{
23			$this->request = Request::createFromIlluminateRequest($request);
24
25			$this->config = collect($config->get('laravel-slack-slash-command'));
26			}
27
28			public function getResponse(): IlluminateResponse
29			{
30			$this->guardAgainstInvalidRequest();
31
32			$handler = $this->determineHandler();
33
34			$response = $handler->handle($this->request);
35
36			return $response->getIlluminateResponse();
37			}
38
39			protected function guardAgainstInvalidRequest()
40			{
41			if (!request()->has('token')) {
42			throw InvalidRequest::tokenNotFound();
43			}
44
45			if ($this->request->get('token') != $this->config->get('verification_token')) {
46			throw InvalidRequest::invalidToken($this->request->get('token'));
47			}
48			}
49
50			/**
51			* @return \Spatie\SlashCommand\Handlers\BaseHandler
52			*
53			* @throws \Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled
54			*/
55			protected function determineHandler()
56			{
57			$handler = collect($this->config->get('handlers'))
58			->map(function (string $handlerClassName) {
59
60			if (! class_exists($handlerClassName)) {
61			throw InvalidHandler::handlerDoesNotExist($handlerClassName);
62			}
63
64			return new $handlerClassName($this->request);
65			})
66			->filter(function (HandlesSlashCommand $handler) {
67			return $handler->canHandle($this->request);
			0 ignored issues – show Bug introduced 2016-07-13 20:02 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Spatie\SlashCommand\HandlesSlashCommand` as the method `canHandle()` does only exist in the following implementations of said interface: `Spatie\SlashCommand\Handlers\BaseHandler`, `Spatie\SlashCommand\Handlers\CatchAll`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
68			})
69			->first();
70
71			if (!$handler) {
72			throw RequestCouldNotBeHandled::noHandlerFound($this->request);
73			}
74
75			return $handler;
76			}
77			}
78

spatie / laravel-slack-slash-command

GitHub Access Token became invalid

Push — master ( 9ca3c4...0e5848 )

Controller::guardAgainstInvalidRequest() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like