Controller::getResponse() - Code Metrics - Inspection of "refactor catch all exceptions" - spatie/laravel-slack-slash-command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 03ba15...894123 )

by Freek

created 2016-10-05 05:14 UTC

Controller::getResponse() A

↳ Parent: Controller

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	10
nc	3
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;
use Spatie\SlashCommand\Response;

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) {
            $response = $this->convertToResponse($exception);
        }

        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;
    }

    protected function convertToResponse(Exception $exception) : Response
    {
        $message = config('app.debug') ? (string)$exception : 'Whoops, something went wrong...';

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

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

        return $response;
    }
}


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

spatie / laravel-slack-slash-command

GitHub Access Token became invalid

Push — master ( 03ba15...894123 )

Controller::getResponse() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like