WebhookRequestHandler::__construct() - Code Metrics - Inspection of "Update documentation" - tgallice/fb-messenger-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — event_dispatcher (b175ed)

by Gallice

created 2016-11-11 18:21 UTC

WebhookRequestHandler::__construct() A

↳ Parent: WebhookRequestHandler

Complexity

Conditions	3
Paths	4

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	6
cts	6
cp	1
rs	9.4285
cc	3
eloc	5
nc	4
nop	4
crap	3

<?php

namespace Tgallice\FBMessenger;

use GuzzleHttp\Psr7\ServerRequest;
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Tgallice\FBMessenger\Callback\CallbackEvent;
use Tgallice\FBMessenger\Callback\MessageEvent;
use Tgallice\FBMessenger\Callback\PostbackEvent;
use Tgallice\FBMessenger\Model\Callback\Entry;

class WebhookRequestHandler
{
    /**
     * @var ServerRequestInterface
     */
    private $request;

    /**
     * App secret used to verify the request sha1
     *
     * @var string
     */
    private $secret;

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

    /**
     * @var Entry[]
     */
    private $hydratedEntries;

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

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

    /**
     * @var EventDispatcherInterface
     */
    private $dispatcher;

    /**
     * @param string $secret
     * @param string $verifyToken
     * @param ServerRequestInterface|null $request
     */
    public function __construct($secret, $verifyToken, ServerRequestInterface $request = null, EventDispatcherInterface $dispatcher = null)
    {
        $this->secret = $secret;
        $this->verifyToken = $verifyToken;
        $this->request = $request ?: ServerRequest::fromGlobals();
        $this->dispatcher = $dispatcher ?: new EventDispatcher();
    }

    /**
     * Check if the token match with the given verify token.
     * This is useful in the webhook setup process.
     *
     * @return bool
     */
    public function isValidVerifyTokenRequest()
    {
        if ($this->request->getMethod() !== 'GET') {
            return false;
        }

        $params = $this->request->getQueryParams();

        if (!isset($params['hub_verify_token'])) {
            return false;
        }

        return  $params['hub_verify_token'] === $this->verifyToken;
    }

    /**
     * @return null|string
     */
    public function getChallenge()
    {
        $params = $this->request->getQueryParams();

        return isset($params['hub_challenge']) ? $params['hub_challenge'] : null;
    }

    /**
     * Check if the request is a valid webhook request
     *
     * @return bool
     */
    public function isValidCallbackRequest()
    {
        if (!$this->isValidHubSignature()) {
            return false;
        }

        $decoded = $this->getDecodedBody();

        $object = isset($decoded['object']) ? $decoded['object'] : null;
        $entry = isset($decoded['entry']) ? $decoded['entry'] : null;

        return $object === 'page' && null !== $entry;
    }

    /**
     * Check if the request is a valid webhook request
     *
     * @deprecated use WebhookRequestHandler::isValidCallbackRequest() instead
     *
     * @return bool
     */
    public function isValid()
    {
        return $this->isValidCallbackRequest();
    }

    /**
     * @return CallbackEvent[]
     */
    public function getAllCallbackEvents()
    {
        $events = [];

        foreach ($this->getHydratedEntries() as $hydratedEntry) {
            $events = array_merge($events, $hydratedEntry->getCallbackEvents());
        }

        return $events;
    }

    /**
     * @return Entry[]
     */
    public function getEntries()
    {
        return $this->getHydratedEntries();
    }

    /**
     * @return ServerRequestInterface
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * @return array
     */
    public function getDecodedBody()
    {
        if (isset($this->decodedBody)) {
            return $this->decodedBody;
        }

        $decoded = @json_decode($this->getBody(), true);

        return $this->decodedBody = null === $decoded ? [] : $decoded;
    }

    /**
     * Dispatch events to listeners
     */
    public function dispatchCallbackEvents()
    {
        foreach ($this->getAllCallbackEvents() as $event) {
            $this->dispatcher->dispatch($event->getName(), $event);

            if ($event instanceof PostbackEvent) {
                // Dispatch postback payload
                $this->dispatcher->dispatch($event->getPostback(), $event);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            if ($event instanceof MessageEvent && $event->isQuickReply()) {
                // Dispatch quick reply payload
                $this->dispatcher->dispatch($event->getQuickReplyPayload(), $event);
            }
        }
    }

    /**
     * @param EventSubscriberInterface $subscriber
     */
    public function addEventSubscriber(EventSubscriberInterface $subscriber)
    {
        $this->dispatcher->addSubscriber($subscriber);
    }

    /**
     * @return Entry[]
     */
    private function getHydratedEntries()
    {
        if (isset($this->hydratedEntries)) {
            return $this->hydratedEntries;
        }

        $decodedBody = $this->getDecodedBody();
        $entries = $decodedBody['entry'];

        $hydrated = [];

        foreach ($entries as $entry) {
            $hydrated[] = Entry::create($entry);
        }

        return $this->hydratedEntries = $hydrated;
    }

    /**
     * @return string
     */
    private function getBody()
    {
        if (isset($this->body)) {
            return $this->body;
        }

        $this->body = (string) $this->request->getBody();

        return $this->body;
    }

    /**
     * @return bool
     */
    private function isValidHubSignature()
    {
        $headers = $this->request->getHeader('X-Hub-Signature');

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

        $signature = XHubSignature::parseHeader($headers[0]);

        return XHubSignature::validate($this->getBody(), $this->secret, $signature);
    }
}


1		<?php
2
3		namespace Tgallice\FBMessenger;
4
5		use GuzzleHttp\Psr7\ServerRequest;
6		use Psr\Http\Message\ServerRequestInterface;
7		use Symfony\Component\EventDispatcher\EventDispatcher;
8		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
9		use Symfony\Component\EventDispatcher\EventSubscriberInterface;
10		use Tgallice\FBMessenger\Callback\CallbackEvent;
11		use Tgallice\FBMessenger\Callback\MessageEvent;
12		use Tgallice\FBMessenger\Callback\PostbackEvent;
13		use Tgallice\FBMessenger\Model\Callback\Entry;
14
15		class WebhookRequestHandler
16		{
17		/**
18		* @var ServerRequestInterface
19		*/
20		private $request;
21
22		/**
23		* App secret used to verify the request sha1
24		*
25		* @var string
26		*/
27		private $secret;
28
29		/**
30		* @var array
31		*/
32		private $decodedBody;
33
34		/**
35		* @var Entry[]
36		*/
37		private $hydratedEntries;
38
39		/**
40		* @var string
41		*/
42		private $body;
43
44		/**
45		* @var string
46		*/
47		private $verifyToken;
48
49		/**
50		* @var EventDispatcherInterface
51		*/
52		private $dispatcher;
53
54		/**
55		* @param string $secret
56		* @param string $verifyToken
57		* @param ServerRequestInterface\|null $request
58		*/
59	12	public function __construct($secret, $verifyToken, ServerRequestInterface $request = null, EventDispatcherInterface $dispatcher = null)
60		{
61	12	$this->secret = $secret;
62	12	$this->verifyToken = $verifyToken;
63	12	$this->request = $request ?: ServerRequest::fromGlobals();
64	12	$this->dispatcher = $dispatcher ?: new EventDispatcher();
65	12	}
66
67		/**
68		* Check if the token match with the given verify token.
69		* This is useful in the webhook setup process.
70		*
71		* @return bool
72		*/
73	1	public function isValidVerifyTokenRequest()
74		{
75	1	if ($this->request->getMethod() !== 'GET') {
76		return false;
77		}
78
79	1	$params = $this->request->getQueryParams();
80
81	1	if (!isset($params['hub_verify_token'])) {
82		return false;
83		}
84
85	1	return $params['hub_verify_token'] === $this->verifyToken;
86		}
87
88		/**
89		* @return null\|string
90		*/
91	1	public function getChallenge()
92		{
93	1	$params = $this->request->getQueryParams();
94
95	1	return isset($params['hub_challenge']) ? $params['hub_challenge'] : null;
96		}
97
98		/**
99		* Check if the request is a valid webhook request
100		*
101		* @return bool
102		*/
103	3	public function isValidCallbackRequest()
104		{
105	3	if (!$this->isValidHubSignature()) {
106	2	return false;
107		}
108
109	1	$decoded = $this->getDecodedBody();
110
111	1	$object = isset($decoded['object']) ? $decoded['object'] : null;
112	1	$entry = isset($decoded['entry']) ? $decoded['entry'] : null;
113
114	1	return $object === 'page' && null !== $entry;
115		}
116
117		/**
118		* Check if the request is a valid webhook request
119		*
120		* @deprecated use WebhookRequestHandler::isValidCallbackRequest() instead
121		*
122		* @return bool
123		*/
124		public function isValid()
125		{
126		return $this->isValidCallbackRequest();
127		}
128
129		/**
130		* @return CallbackEvent[]
131		*/
132	2	public function getAllCallbackEvents()
133		{
134	2	$events = [];
135
136	2	foreach ($this->getHydratedEntries() as $hydratedEntry) {
137	2	$events = array_merge($events, $hydratedEntry->getCallbackEvents());
138	2	}
139
140	2	return $events;
141		}
142
143		/**
144		* @return Entry[]
145		*/
146	1	public function getEntries()
147		{
148	1	return $this->getHydratedEntries();
149		}
150
151		/**
152		* @return ServerRequestInterface
153		*/
154	1	public function getRequest()
155		{
156	1	return $this->request;
157		}
158
159		/**
160		* @return array
161		*/
162	5	public function getDecodedBody()
163		{
164	5	if (isset($this->decodedBody)) {
165		return $this->decodedBody;
166		}
167
168	5	$decoded = @json_decode($this->getBody(), true);
169
170	5	return $this->decodedBody = null === $decoded ? [] : $decoded;
171		}
172
173		/**
174		* Dispatch events to listeners
175		*/
176	1	public function dispatchCallbackEvents()
177		{
178	1	foreach ($this->getAllCallbackEvents() as $event) {
179	1	$this->dispatcher->dispatch($event->getName(), $event);
180
181	1	if ($event instanceof PostbackEvent) {
182		// Dispatch postback payload
183		$this->dispatcher->dispatch($event->getPostback(), $event);
		0 ignored issues – show Documentation introduced 2016-11-05 11:23 UTC by Report Bug Copy Issue Report `$event->getPostback()` is of type `object<Tgallice\FBMessen...odel\Callback\Postback>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
184		}
185
186	1	if ($event instanceof MessageEvent && $event->isQuickReply()) {
187		// Dispatch quick reply payload
188	1	$this->dispatcher->dispatch($event->getQuickReplyPayload(), $event);
189	1	}
190	1	}
191	1	}
192
193		/**
194		* @param EventSubscriberInterface $subscriber
195		*/
196	1	public function addEventSubscriber(EventSubscriberInterface $subscriber)
197		{
198	1	$this->dispatcher->addSubscriber($subscriber);
199	1	}
200
201		/**
202		* @return Entry[]
203		*/
204	3	private function getHydratedEntries()
205		{
206	3	if (isset($this->hydratedEntries)) {
207		return $this->hydratedEntries;
208		}
209
210	3	$decodedBody = $this->getDecodedBody();
211	3	$entries = $decodedBody['entry'];
212
213	3	$hydrated = [];
214
215	3	foreach ($entries as $entry) {
216	3	$hydrated[] = Entry::create($entry);
217	3	}
218
219	3	return $this->hydratedEntries = $hydrated;
220		}
221
222		/**
223		* @return string
224		*/
225	7	private function getBody()
226		{
227	7	if (isset($this->body)) {
228	1	return $this->body;
229		}
230
231	7	$this->body = (string) $this->request->getBody();
232
233	7	return $this->body;
234		}
235
236		/**
237		* @return bool
238		*/
239	3	private function isValidHubSignature()
240		{
241	3	$headers = $this->request->getHeader('X-Hub-Signature');
242
243	3	if (empty($headers)) {
244		return false;
245		}
246
247	3	$signature = XHubSignature::parseHeader($headers[0]);
248
249	3	return XHubSignature::validate($this->getBody(), $this->secret, $signature);
250		}
251		}
252

tgallice / fb-messenger-sdk

GitHub Access Token became invalid

Branch — event_dispatcher (b175ed)

WebhookRequestHandler::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like