Controller::getResponse() - Code Metrics - Inspection of "Catch all Exceptions (#32)" - spatie/laravel-slack-slash-command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 66a540...03ba15 )

by Freek

created 2016-10-05 05:10 UTC

Controller::getResponse() B

↳ Parent: Controller

Complexity

Conditions	4
Paths	4

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.6845
c	0
b	0
f	0
cc	4
eloc	15
nc	4
nop	0

<?php

namespace Spatie\SlashCommand;

use Exception;
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\SlackSlashCommandException;
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();

        try {
            $response = $handler->handle($this->request);
        } catch (SlackSlashCommandException $exception) {
            $response = $exception->getResponse($this->request);
        } catch (Exception $exception) {
            $message = config('app.debug') ? (string) $exception : 'Whoops, something went wrong..';

            $exception = new SlackSlashCommandException(
                $message,
                $exception->getCode(),
                $exception
            );

            $response = $exception->getResponse($this->request);
        }

        return $response->getIlluminateResponse();
    }

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

        if ($this->request->get('token') != $this->config->get('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 Exception;
6			use Illuminate\Config\Repository;
7			use Illuminate\Http\Request as IlluminateRequest;
8			use Illuminate\Http\Response as IlluminateResponse;
9			use Illuminate\Routing\Controller as IlluminateController;
10			use Spatie\SlashCommand\Exceptions\InvalidHandler;
11			use Spatie\SlashCommand\Exceptions\InvalidRequest;
12			use Spatie\SlashCommand\Exceptions\SlackSlashCommandException;
13			use Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled;
14
15			class Controller extends IlluminateController
16			{
17			/** @var \Spatie\SlashCommand\Request */
18			protected $request;
19
20			/** @var \Illuminate\Support\Collection */
21			protected $config;
22
23			public function __construct(IlluminateRequest $request, Repository $config)
24			{
25			$this->request = Request::createFromIlluminateRequest($request);
26
27			$this->config = collect($config->get('laravel-slack-slash-command'));
28			}
29
30			public function getResponse(): IlluminateResponse
31			{
32			$this->guardAgainstInvalidRequest();
33
34			$handler = $this->determineHandler();
35
36			try {
37			$response = $handler->handle($this->request);
38			} catch (SlackSlashCommandException $exception) {
39			$response = $exception->getResponse($this->request);
40			} catch (Exception $exception) {
41			$message = config('app.debug') ? (string) $exception : 'Whoops, something went wrong..';
42
43			$exception = new SlackSlashCommandException(
44			$message,
45			$exception->getCode(),
46			$exception
47			);
48
49			$response = $exception->getResponse($this->request);
50			}
51
52			return $response->getIlluminateResponse();
53			}
54
55			protected function guardAgainstInvalidRequest()
56			{
57			if (! request()->has('token')) {
58			throw InvalidRequest::tokenNotFound();
59			}
60
61			if ($this->request->get('token') != $this->config->get('token')) {
62			throw InvalidRequest::invalidToken($this->request->get('token'));
63			}
64			}
65
66			/**
67			* @return \Spatie\SlashCommand\Handlers\BaseHandler
68			*
69			* @throws \Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled
70			*/
71			protected function determineHandler()
72			{
73			$handler = collect($this->config->get('handlers'))
74			->map(function (string $handlerClassName) {
75			if (! class_exists($handlerClassName)) {
76			throw InvalidHandler::handlerDoesNotExist($handlerClassName);
77			}
78
79			return new $handlerClassName($this->request);
80			})
81			->filter(function (HandlesSlashCommand $handler) {
82			return $handler->canHandle($this->request);
			0 ignored issues – show Bug introduced 2016-10-03 09:53 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`, `Spatie\SlashCommand\Handlers\Help`, `Spatie\SlashCommand\Handlers\SignatureHandler`. 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...
83			})
84			->first();
85
86			if (! $handler) {
87			throw RequestCouldNotBeHandled::noHandlerFound($this->request);
88			}
89
90			return $handler;
91			}
92			}
93

spatie / laravel-slack-slash-command

GitHub Access Token became invalid

Push — master ( 66a540...03ba15 )

Controller::getResponse() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like