FakeDriver::typesAndWaits() - Code Metrics - Inspection of "Merge branch 'master' of github.com:botman/botman" - botman/botman - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1563e2...9d8e98 )

by Marcel

created 2018-03-10 19:34 UTC

FakeDriver::typesAndWaits() A

↳ Parent: FakeDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2

<?php

namespace BotMan\BotMan\Drivers\Tests;

use BotMan\BotMan\Users\User;
use BotMan\BotMan\Messages\Incoming\Answer;
use BotMan\BotMan\Interfaces\DriverInterface;
use BotMan\BotMan\Interfaces\VerifiesService;
use BotMan\BotMan\Messages\Outgoing\Question;
use Symfony\Component\HttpFoundation\Request;
use BotMan\BotMan\Drivers\Events\GenericEvent;
use Symfony\Component\HttpFoundation\Response;
use BotMan\BotMan\Messages\Incoming\IncomingMessage;

/**
 * A fake driver for tests. Must be used with ProxyDriver.
 * Example to set it up in a unit test:
 * <code>
 *  public static function setUpBeforeClass()
 *  {
 *      DriverManager::loadDriver(ProxyDriver::class);
 *  }
 *  public function setUp()
 *  {
 *      $this->fakeDriver = new FakeDriver();
 *      ProxyDriver::setInstance($this->fakeDriver);
 *  }
 * </code>.
 */
class FakeDriver implements DriverInterface, VerifiesService
{
    /** @var bool */
    public $matchesRequest = true;

    /** @var bool */
    public $hasMatchingEvent = false;

    /** @var \BotMan\BotMan\Messages\Incoming\IncomingMessage[] */
    public $messages = [];

    /** @var bool */
    public $isBot = false;

    /** @var bool */
    public $isInteractiveMessageReply = false;

    /** @var bool */
    public $isConfigured = true;

    /** @var array */
    private $botMessages = [];

    /** @var bool */
    private $botIsTyping = false;

    /** @var string */
    private $driver_name = 'Fake';

    /** @var string */
    private $event_name;

    /** @var array */
    private $event_payload;

    /** @var string */
    private $user_id = null;

    /** @var string */
    private $user_first_name = 'Marcel';

    /** @var string */
    private $user_last_name = 'Pociot';

    /** @var string */
    private $username = 'BotMan';

    /** @var array */
    private $user_info = [];

    /**
     * @return FakeDriver
     */
    public static function create()
    {
        return new static;
    }

    /**
     * @return FakeDriver
     */
    public static function createInactive()
    {
        $driver = new static;
        $driver->isConfigured = false;

        return $driver;
    }

    public function matchesRequest()
    {
        return $this->matchesRequest;
    }

    public function getMessages()
    {
        foreach ($this->messages as &$message) {
            $message->setIsFromBot($this->isBot());
        }

        return $this->messages;
    }

    protected function isBot()
    {
        return $this->isBot;
    }

    public function isConfigured()
    {
        return $this->isConfigured;
    }

    public function setUser(array $user_info)
    {
        $this->user_id = $user_info['id'] ?? $this->user_id;
        $this->user_first_name = $user_info['first_name'] ?? $this->user_first_name;
        $this->user_last_name = $user_info['last_name'] ?? $this->user_last_name;
        $this->username = $user_info['username'] ?? $this->username;
        $this->user_info = $user_info;
    }

    public function getUser(IncomingMessage $matchingMessage)
    {
        return new User($this->user_id ?? $matchingMessage->getSender(), $this->user_first_name, $this->user_last_name, $this->username, $this->user_info);
    }

    public function getConversationAnswer(IncomingMessage $message)
    {
        $answer = Answer::create($message->getText())->setMessage($message)->setValue($message->getText());
        $answer->setInteractiveReply($this->isInteractiveMessageReply);

        return $answer;
    }

    public function buildServicePayload($message, $matchingMessage, $additionalParameters = [])
    {
        return $message;

    }

    public function sendPayload($payload)
    {
        $this->botMessages[] = $payload;
        $text = method_exists($payload, 'getText') ? $payload->getText() : '';

        return Response::create(json_encode($text));
    }

    public function setName($name)
    {
        $this->driver_name = $name;
    }

    public function getName()
    {
        return $this->driver_name;
    }

    public function types(IncomingMessage $matchingMessage)
    {
        $this->botIsTyping = true;
    }

    /**
     * Send a typing indicator and wait for the given amount of seconds.
     * @param IncomingMessage $matchingMessage
     * @param int $seconds
     * @return mixed
     */
    public function typesAndWaits(IncomingMessage $matchingMessage, int $seconds)
    {
        $this->types($matchingMessage);
    }

    /**
     * Returns true if types() has been called.
     *
     * @return bool
     */
    public function isBotTyping()
    {
        return $this->botIsTyping;
    }

    /**
     * @return void
     */
    public function setEventName($name)
    {
        $this->event_name = $name;
    }

    /**
     * @return void
     */
    public function setEventPayload($payload)
    {
        $this->event_payload = $payload;
    }

    /**
     * @return bool|GenericEvent
     */
    public function hasMatchingEvent()
    {
        if (isset($this->event_name)) {
            $event = new GenericEvent($this->event_payload);
            $event->setName($this->event_name);

            return $event;
        }

        return $this->hasMatchingEvent;
    }

    /**
     * Returns array of messages from bot.
     *
     * @return string[]|Question[]
     */
    public function getBotMessages()
    {
        return $this->botMessages;
    }

    /**
     * Clear received messages from bot.
     */
    public function resetBotMessages()
    {
        $this->botIsTyping = false;
        $this->botMessages = [];
    }

    /**
     * Tells if the stored conversation callbacks are serialized.
     *
     * @return bool
     */
    public function serializesCallbacks()
    {
        return true;
    }

    public function verifyRequest(Request $request)
    {
        $_SERVER['driver_verified'] = true;

        return true;
    }
}


1			<?php
2
3			namespace BotMan\BotMan\Drivers\Tests;
4
5			use BotMan\BotMan\Users\User;
6			use BotMan\BotMan\Messages\Incoming\Answer;
7			use BotMan\BotMan\Interfaces\DriverInterface;
8			use BotMan\BotMan\Interfaces\VerifiesService;
9			use BotMan\BotMan\Messages\Outgoing\Question;
10			use Symfony\Component\HttpFoundation\Request;
11			use BotMan\BotMan\Drivers\Events\GenericEvent;
12			use Symfony\Component\HttpFoundation\Response;
13			use BotMan\BotMan\Messages\Incoming\IncomingMessage;
14
15			/**
16			* A fake driver for tests. Must be used with ProxyDriver.
17			* Example to set it up in a unit test:
18			* <code>
19			* public static function setUpBeforeClass()
20			* {
21			* DriverManager::loadDriver(ProxyDriver::class);
22			* }
23			* public function setUp()
24			* {
25			* $this->fakeDriver = new FakeDriver();
26			* ProxyDriver::setInstance($this->fakeDriver);
27			* }
28			* </code>.
29			*/
30			class FakeDriver implements DriverInterface, VerifiesService
31			{
32			/** @var bool */
33			public $matchesRequest = true;
34
35			/** @var bool */
36			public $hasMatchingEvent = false;
37
38			/** @var \BotMan\BotMan\Messages\Incoming\IncomingMessage[] */
39			public $messages = [];
40
41			/** @var bool */
42			public $isBot = false;
43
44			/** @var bool */
45			public $isInteractiveMessageReply = false;
46
47			/** @var bool */
48			public $isConfigured = true;
49
50			/** @var array */
51			private $botMessages = [];
52
53			/** @var bool */
54			private $botIsTyping = false;
55
56			/** @var string */
57			private $driver_name = 'Fake';
58
59			/** @var string */
60			private $event_name;
61
62			/** @var array */
63			private $event_payload;
64
65			/** @var string */
66			private $user_id = null;
67
68			/** @var string */
69			private $user_first_name = 'Marcel';
70
71			/** @var string */
72			private $user_last_name = 'Pociot';
73
74			/** @var string */
75			private $username = 'BotMan';
76
77			/** @var array */
78			private $user_info = [];
79
80			/**
81			* @return FakeDriver
82			*/
83			public static function create()
84			{
85			return new static;
86			}
87
88			/**
89			* @return FakeDriver
90			*/
91			public static function createInactive()
92			{
93			$driver = new static;
94			$driver->isConfigured = false;
95
96			return $driver;
97			}
98
99			public function matchesRequest()
100			{
101			return $this->matchesRequest;
102			}
103
104			public function getMessages()
105			{
106			foreach ($this->messages as &$message) {
107			$message->setIsFromBot($this->isBot());
108			}
109
110			return $this->messages;
111			}
112
113			protected function isBot()
114			{
115			return $this->isBot;
116			}
117
118			public function isConfigured()
119			{
120			return $this->isConfigured;
121			}
122
123			public function setUser(array $user_info)
124			{
125			$this->user_id = $user_info['id'] ?? $this->user_id;
126			$this->user_first_name = $user_info['first_name'] ?? $this->user_first_name;
127			$this->user_last_name = $user_info['last_name'] ?? $this->user_last_name;
128			$this->username = $user_info['username'] ?? $this->username;
129			$this->user_info = $user_info;
130			}
131
132			public function getUser(IncomingMessage $matchingMessage)
133			{
134			return new User($this->user_id ?? $matchingMessage->getSender(), $this->user_first_name, $this->user_last_name, $this->username, $this->user_info);
135			}
136
137			public function getConversationAnswer(IncomingMessage $message)
138			{
139			$answer = Answer::create($message->getText())->setMessage($message)->setValue($message->getText());
140			$answer->setInteractiveReply($this->isInteractiveMessageReply);
141
142			return $answer;
143			}
144
145			public function buildServicePayload($message, $matchingMessage, $additionalParameters = [])
146			{
147			return $message;
			0 ignored issues – show Bug Compatibility introduced 2017-06-09 05:58 UTC by Report Bug Copy Issue Report The expression `return $message;` of type `string\|BotMan\BotMan\Messages\Outgoing\Question` is incompatible with the return type declared by the interface `BotMan\BotMan\Interfaces...ce::buildServicePayload` of type `BotMan\BotMan\Interfaces\DriverInterface` as it can also be of type `string` which is not included in this return type. Loading history...
148			}
149
150			public function sendPayload($payload)
151			{
152			$this->botMessages[] = $payload;
153			$text = method_exists($payload, 'getText') ? $payload->getText() : '';
154
155			return Response::create(json_encode($text));
156			}
157
158			public function setName($name)
159			{
160			$this->driver_name = $name;
161			}
162
163			public function getName()
164			{
165			return $this->driver_name;
166			}
167
168			public function types(IncomingMessage $matchingMessage)
169			{
170			$this->botIsTyping = true;
171			}
172
173			/**
174			* Send a typing indicator and wait for the given amount of seconds.
175			* @param IncomingMessage $matchingMessage
176			* @param int $seconds
177			* @return mixed
178			*/
179			public function typesAndWaits(IncomingMessage $matchingMessage, int $seconds)
180			{
181			$this->types($matchingMessage);
182			}
183
184			/**
185			* Returns true if types() has been called.
186			*
187			* @return bool
188			*/
189			public function isBotTyping()
190			{
191			return $this->botIsTyping;
192			}
193
194			/**
195			* @return void
196			*/
197			public function setEventName($name)
198			{
199			$this->event_name = $name;
200			}
201
202			/**
203			* @return void
204			*/
205			public function setEventPayload($payload)
206			{
207			$this->event_payload = $payload;
208			}
209
210			/**
211			* @return bool\|GenericEvent
212			*/
213			public function hasMatchingEvent()
214			{
215			if (isset($this->event_name)) {
216			$event = new GenericEvent($this->event_payload);
217			$event->setName($this->event_name);
218
219			return $event;
220			}
221
222			return $this->hasMatchingEvent;
223			}
224
225			/**
226			* Returns array of messages from bot.
227			*
228			* @return string[]\|Question[]
229			*/
230			public function getBotMessages()
231			{
232			return $this->botMessages;
233			}
234
235			/**
236			* Clear received messages from bot.
237			*/
238			public function resetBotMessages()
239			{
240			$this->botIsTyping = false;
241			$this->botMessages = [];
242			}
243
244			/**
245			* Tells if the stored conversation callbacks are serialized.
246			*
247			* @return bool
248			*/
249			public function serializesCallbacks()
250			{
251			return true;
252			}
253
254			public function verifyRequest(Request $request)
255			{
256			$_SERVER['driver_verified'] = true;
257
258			return true;
259			}
260			}
261

botman / botman

Push — master ( 1563e2...9d8e98 )

FakeDriver::typesAndWaits() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like