Slackbot::respond() - Code Metrics - Inspection of "temporarily remove the tests" - iranianpep/botonomous - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0b92a4...d3ac05 )

by Ehsan

created 2017-07-19 11:08 UTC

Slackbot::respond() B

↳ Parent: Slackbot

Complexity

Conditions	5
Paths	23

Size

Total Lines	30
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	5.4742

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	30
ccs	11
cts	15
cp	0.7332
rs	8.439
cc	5
eloc	16
nc	23
nop	1
crap	5.4742

<?php

namespace Botonomous;

use Botonomous\listener\EventListener;
use Botonomous\plugin\AbstractPlugin;

/**
 * Class Botonomous.
 */
class Slackbot extends AbstractBot
{
    private $commands;
    private $lastError;
    private $currentCommand;

    /**
     * Botonomous constructor.
     *
     * @param Config|null $config
     *
     * @throws \Exception
     */
    public function __construct(Config $config = null)
    {
        if ($config !== null) {
            $this->setConfig($config);
        }

        $this->setTimezone();
    }

    /**
     * Set the timezone.
     */
    private function setTimezone()
    {
        // set timezone
        date_default_timezone_set($this->getConfig()->get('timezone'));
    }

    /**
     * @param null|string $key
     *
     * @return mixed
     */
    public function getRequest($key = null)
    {
        return $this->getListener()->getRequest($key);
    }

    /**
     * @return AbstractBaseSlack|null|void
     */
    private function handleMessageActions()
    {
        $post = $this->getRequestUtility()->getPost();

        // ignore if payload is not set
        if (!isset($post['payload'])) {
            /* @noinspection PhpInconsistentReturnPointsInspection */
            return;
        }

        // posted payload is in JSON
        $payload = json_decode($post['payload'], true);

        return (new MessageAction())->load($payload);
    }

    /**
     * @throws \Exception
     */
    private function handleSendResponse()
    {
        // 1. Start listening
        $this->getListener()->listen();

        // 2. verify the request
        try {
            $verificationResult = $this->getListener()->verifyRequest();

            if ($verificationResult['success'] !== true) {
                throw new \Exception($verificationResult['message']);
            }
        } catch (\Exception $e) {
            throw $e;
        }

        // 3. pre process the request
        $this->preProcessRequest();

        // 4. check access control
        if ($this->checkAccessControl() !== true) {
            return;
        }

        // 5. set the current command
        $message = $this->getListener()->getMessage();
        $this->setCurrentCommand($this->getMessageUtility()->extractCommandName($message));

        // 6. log the message
        $this->getLoggerUtility()->logChat(__METHOD__, $message);

        // 7. send confirmation message if is enabled
        $this->getSender()->sendConfirmation();

        // 8. And send the response to the channel, only if the response is not empty
        $response = $this->respond($message);

        if (!empty($response)) {
            $this->getSender()->send($response);
        }
    }

    /**
     * @return bool
     */
    private function checkAccessControl()
    {
        // if accessControlEnabled is not set true ignore the check and return true
        if ($this->getConfig()->get('accessControlEnabled') !== true) {
            return true;
        }

        if ($this->getBlackList()->isBlackListed() !== false) {
            // found in blacklist
            $this->getSender()->send($this->getDictionary()->get('generic-messages')['blacklistedMessage']);

            return false;
        }

        if ($this->getWhiteList()->isWhiteListed() !== true) {
            // not found in whitelist
            $this->getSender()->send($this->getDictionary()->get('generic-messages')['whitelistedMessage']);

            return false;
        }

        return true;
    }

    /**
     * @throws \Exception
     */
    public function run()
    {
        switch ($this->getListener()->determineAction()) {
            case 'oauth':
                return $this->handleOAuth();
            case 'message_actions':
                return $this->handleMessageActions();
            case 'url_verification':
                return $this->handleUrlVerification();
            default:
                return $this->handleSendResponse();
        }
    }

    /**
     * handle OAuth.
     */
    private function handleOAuth()
    {
        return $this->getOauth()->doOauth();
    }

    /**
     * @throws \Exception
     */
    private function handleUrlVerification()
    {
        $request = $this->getRequestUtility()->getPostedBody();

        if (empty($request['challenge'])) {
            throw new \Exception('Challenge is missing for URL verification');
        }

        echo $request['challenge'];
    }

    /**
     * Pre-process the request.
     */
    private function preProcessRequest()
    {
        $request = $this->getListener()->getRequest();

        // remove the trigger_word from beginning of the message
        if (!empty($request['trigger_word'])) {
            $request['text'] = $this->getMessageUtility()->removeTriggerWord(
                $request['text'],
                $request['trigger_word']
            );

            $this->getListener()->setRequest($request);
        }
    }

    /**
     * @param null $message
     *
     * @throws \Exception
     *
     * @return mixed
     */
    public function respond($message = null)
    {
        try {
            // If message is not set, get it from the current request
            if ($message === null) {
                $message = $this->getListener()->getMessage();
            }

            $commandExtractor = $this->getCommandExtractor();
            $command = $commandExtractor->getCommandByMessage($message);

            if (!$command instanceof Command) {
                // something went wrong, error will tell us!
                return $commandExtractor->getError();
            }

            $pluginClass = $this->getPluginClassByCommand($command);

            // check action exists
            $action = $command->getAction();
            if (!method_exists($pluginClass, $action)) {
                $className = get_class($pluginClass);
                throw new \Exception("Action / function: '{$action}' does not exist in '{$className}'");
            }

            return $pluginClass->$action();
        } catch (\Exception $e) {
            throw $e;
        }
    }

    /**
     * Get plugin class by command.
     *
     * @param Command $command
     *
     * @throws \Exception
     *
     * @return AbstractPlugin
     */
    private function getPluginClassByCommand(Command $command)
    {
        // create the class
        $pluginClassFile = $command->getClass();
        $pluginClass = new $pluginClassFile($this);

        // check class is valid
        if (!$pluginClass instanceof AbstractPlugin) {
            $className = get_class($pluginClass);
            throw new \Exception("Couldn't create class: '{$className}'");
        }

        return $pluginClass;
    }

    /**
     * @return array
     */
    public function getCommands()
    {
        if (!isset($this->commands)) {
            $this->setCommands($this->getCommandContainer()->getAllAsObject());
        }

        return $this->commands;
    }

    /**
     * @param array $commands
     */
    public function setCommands(array $commands)
    {
        $this->commands = $commands;
    }

    /**
     * @return string
     */
    public function getLastError()
    {
        return $this->lastError;
    }

    /**
     * @param string $lastError
     */
    public function setLastError($lastError)
    {
        $this->lastError = $lastError;
    }

    /**
     * Return the current command.
     *
     * @return string
     */
    public function getCurrentCommand()
    {
        return $this->currentCommand;
    }

    /**
     * @param string $currentCommand
     */
    public function setCurrentCommand($currentCommand)
    {
        $this->currentCommand = $currentCommand;
    }

    /**
     * Determine if bot user id is mentioned in the message.
     *
     * @return bool
     */
    public function youTalkingToMe()
    {
        $message = $this->getListener()->getMessage();

        if (empty($message)) {
            return false;
        }

        if ($this->getMessageUtility()->isBotMentioned($message) === true) {
            return true;
        }

        $listener = $this->getListener();
        // check direct messages
        return $listener instanceof EventListener && $listener->getEvent()->isDirectMessage() === true;
    }
}


1		<?php
2
3		namespace Botonomous;
4
5		use Botonomous\listener\EventListener;
6		use Botonomous\plugin\AbstractPlugin;
7
8		/**
9		* Class Botonomous.
10		*/
11		class Slackbot extends AbstractBot
12		{
13		private $commands;
14		private $lastError;
15		private $currentCommand;
16
17		/**
18		* Botonomous constructor.
19		*
20		* @param Config\|null $config
21		*
22		* @throws \Exception
23		*/
24	38	public function __construct(Config $config = null)
25		{
26	38	if ($config !== null) {
27	6	$this->setConfig($config);
28		}
29
30	38	$this->setTimezone();
31	38	}
32
33		/**
34		* Set the timezone.
35		*/
36	38	private function setTimezone()
37		{
38		// set timezone
39	38	date_default_timezone_set($this->getConfig()->get('timezone'));
40	38	}
41
42		/**
43		* @param null\|string $key
44		*
45		* @return mixed
46		*/
47	10	public function getRequest($key = null)
48		{
49	10	return $this->getListener()->getRequest($key);
50		}
51
52		/**
53		* @return AbstractBaseSlack\|null\|void
54		*/
55	1	private function handleMessageActions()
56		{
57	1	$post = $this->getRequestUtility()->getPost();
58
59		// ignore if payload is not set
60	1	if (!isset($post['payload'])) {
61		/* @noinspection PhpInconsistentReturnPointsInspection */
62	1	return;
63		}
64
65		// posted payload is in JSON
66	1	$payload = json_decode($post['payload'], true);
67
68	1	return (new MessageAction())->load($payload);
69		}
70
71		/**
72		* @throws \Exception
73		*/
74	5	private function handleSendResponse()
75		{
76		// 1. Start listening
77	5	$this->getListener()->listen();
78
79		// 2. verify the request
80		try {
81	5	$verificationResult = $this->getListener()->verifyRequest();
82
83	5	if ($verificationResult['success'] !== true) {
84	5	throw new \Exception($verificationResult['message']);
85		}
86	2	} catch (\Exception $e) {
87	2	throw $e;
88		}
89
90		// 3. pre process the request
91	3	$this->preProcessRequest();
92
93		// 4. check access control
94	3	if ($this->checkAccessControl() !== true) {
95	2	return;
96		}
97
98		// 5. set the current command
99	1	$message = $this->getListener()->getMessage();
100	1	$this->setCurrentCommand($this->getMessageUtility()->extractCommandName($message));
101
102		// 6. log the message
103	1	$this->getLoggerUtility()->logChat(__METHOD__, $message);
104
105		// 7. send confirmation message if is enabled
106	1	$this->getSender()->sendConfirmation();
107
108		// 8. And send the response to the channel, only if the response is not empty
109	1	$response = $this->respond($message);
110
111	1	if (!empty($response)) {
112	1	$this->getSender()->send($response);
113		}
114	1	}
115
116		/**
117		* @return bool
118		*/
119	3	private function checkAccessControl()
120		{
121		// if accessControlEnabled is not set true ignore the check and return true
122	3	if ($this->getConfig()->get('accessControlEnabled') !== true) {
123	1	return true;
124		}
125
126	2	if ($this->getBlackList()->isBlackListed() !== false) {
127		// found in blacklist
128	1	$this->getSender()->send($this->getDictionary()->get('generic-messages')['blacklistedMessage']);
129
130	1	return false;
131		}
132
133	1	if ($this->getWhiteList()->isWhiteListed() !== true) {
134		// not found in whitelist
135	1	$this->getSender()->send($this->getDictionary()->get('generic-messages')['whitelistedMessage']);
136
137	1	return false;
138		}
139
140		return true;
141		}
142
143		/**
144		* @throws \Exception
145		*/
146	8	public function run()
147		{
148	8	switch ($this->getListener()->determineAction()) {
149	8	case 'oauth':
150	1	return $this->handleOAuth();
151	7	case 'message_actions':
152	1	return $this->handleMessageActions();
153	6	case 'url_verification':
154	1	return $this->handleUrlVerification();
155		default:
156	5	return $this->handleSendResponse();
157		}
158		}
159
160		/**
161		* handle OAuth.
162		*/
163	1	private function handleOAuth()
164		{
165	1	return $this->getOauth()->doOauth();
166		}
167
168		/**
169		* @throws \Exception
170		*/
171	1	private function handleUrlVerification()
172		{
173	1	$request = $this->getRequestUtility()->getPostedBody();
174
175	1	if (empty($request['challenge'])) {
176		throw new \Exception('Challenge is missing for URL verification');
177		}
178
179	1	echo $request['challenge'];
180	1	}
181
182		/**
183		* Pre-process the request.
184		*/
185	3	private function preProcessRequest()
186		{
187	3	$request = $this->getListener()->getRequest();
188
189		// remove the trigger_word from beginning of the message
190	3	if (!empty($request['trigger_word'])) {
191	3	$request['text'] = $this->getMessageUtility()->removeTriggerWord(
192	3	$request['text'],
193	3	$request['trigger_word']
194		);
195
196	3	$this->getListener()->setRequest($request);
197		}
198	3	}
199
200		/**
201		* @param null $message
202		*
203		* @throws \Exception
204		*
205		* @return mixed
206		*/
207	2	public function respond($message = null)
208		{
209		try {
210		// If message is not set, get it from the current request
211	2	if ($message === null) {
212	1	$message = $this->getListener()->getMessage();
213		}
214
215	2	$commandExtractor = $this->getCommandExtractor();
216	2	$command = $commandExtractor->getCommandByMessage($message);
217
218	2	if (!$command instanceof Command) {
219		// something went wrong, error will tell us!
220	1	return $commandExtractor->getError();
221		}
222
223	2	$pluginClass = $this->getPluginClassByCommand($command);
224
225		// check action exists
226	2	$action = $command->getAction();
227	2	if (!method_exists($pluginClass, $action)) {
228		$className = get_class($pluginClass);
229		throw new \Exception("Action / function: '{$action}' does not exist in '{$className}'");
230		}
231
232	2	return $pluginClass->$action();
233		} catch (\Exception $e) {
234		throw $e;
235		}
236		}
237
238		/**
239		* Get plugin class by command.
240		*
241		* @param Command $command
242		*
243		* @throws \Exception
244		*
245		* @return AbstractPlugin
246		*/
247	2	private function getPluginClassByCommand(Command $command)
248		{
249		// create the class
250	2	$pluginClassFile = $command->getClass();
251	2	$pluginClass = new $pluginClassFile($this);
252
253		// check class is valid
254	2	if (!$pluginClass instanceof AbstractPlugin) {
255		$className = get_class($pluginClass);
256		throw new \Exception("Couldn't create class: '{$className}'");
257		}
258
259	2	return $pluginClass;
260		}
261
262		/**
263		* @return array
264		*/
265	2	public function getCommands()
266		{
267	2	if (!isset($this->commands)) {
268	1	$this->setCommands($this->getCommandContainer()->getAllAsObject());
269		}
270
271	2	return $this->commands;
272		}
273
274		/**
275		* @param array $commands
276		*/
277	2	public function setCommands(array $commands)
278		{
279	2	$this->commands = $commands;
280	2	}
281
282		/**
283		* @return string
284		*/
285	1	public function getLastError()
286		{
287	1	return $this->lastError;
288		}
289
290		/**
291		* @param string $lastError
292		*/
293	1	public function setLastError($lastError)
294		{
295	1	$this->lastError = $lastError;
296	1	}
297
298		/**
299		* Return the current command.
300		*
301		* @return string
302		*/
303	1	public function getCurrentCommand()
304		{
305	1	return $this->currentCommand;
306		}
307
308		/**
309		* @param string $currentCommand
310		*/
311	2	public function setCurrentCommand($currentCommand)
312		{
313	2	$this->currentCommand = $currentCommand;
314	2	}
315
316		/**
317		* Determine if bot user id is mentioned in the message.
318		*
319		* @return bool
320		*/
321	1	public function youTalkingToMe()
322		{
323	1	$message = $this->getListener()->getMessage();
324
325	1	if (empty($message)) {
326	1	return false;
327		}
328
329	1	if ($this->getMessageUtility()->isBotMentioned($message) === true) {
330	1	return true;
331		}
332
333	1	$listener = $this->getListener();
334		// check direct messages
335	1	return $listener instanceof EventListener && $listener->getEvent()->isDirectMessage() === true;
336		}
337		}
338

iranianpep / botonomous

Push — master ( 0b92a4...d3ac05 )

Slackbot::respond() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like