NotificationHub::parseConnectionString() - Code Metrics - webwarejp/notificationhubs-rest-php - Measure and Improve Code Quality continuously with Scrutinizer

NotificationHub::parseConnectionString() B
last analyzed 2017-11-15 02:00 UTC

↳ Parent: NotificationHub

Complexity

Conditions	9
Paths	11

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	7.041
c	0
b	0
f	0
cc	9
eloc	13
nc	11
nop	1

<?php

namespace Openpp\NotificationHubsRest\NotificationHub;

use Openpp\NotificationHubsRest\Notification\NotificationInterface;
use Openpp\NotificationHubsRest\Registration\GcmRegistration;
use Openpp\NotificationHubsRest\Registration\RegistrationInterface;

class NotificationHub
{
    const API_VERSION = '?api-version=2013-08';

    const METHOD_GET = 'GET';
    const METHOD_POST = 'POST';
    const METHOD_PUT = 'PUT';
    const METHOD_DELETE = 'DELETE';

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

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

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

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

    /**
     * Initializes a new NotificationHub.
     *
     * @param string $connectionString
     * @param string $hubPath
     */
    public function __construct($connectionString, $hubPath)
    {
        $this->hubPath = $hubPath;
        $this->parseConnectionString($connectionString);
    }

    /**
     * Send a Notification.
     *
     * @param NotificationInterface $notification
     */
    public function sendNotification(NotificationInterface $notification)
    {
        $uri = $notification->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $notification->getHeaders());

        $this->request(self::METHOD_POST, $uri, $headers, $notification->getPayload());
    }

    /**
     * Create Registration.
     *
     * @param RegistrationInterface $registration
     *
     * @throws \RuntimeException
     *
     * @return mixed
     */
    public function createRegistration(RegistrationInterface $registration)

    {
        if ($registration->getRegistrationId() || $registration->getETag()) {
            throw new \RuntimeException('Registration ID and ETag must be empty.');
        }

        $uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $registration->getHeaders());

        $response = $this->request(self::METHOD_POST, $uri, $headers, $registration->getPayload());

        return $registration->scrapeResponse($response);
    }

    /**
     * Create or Update Registration.
     *
     * @param RegistrationInterface $registration
     *
     * @throws \RuntimeException
     *
     * @return mixed
     */
    public function updateRegistration(RegistrationInterface $registration)

    {
        if (!$registration->getRegistrationId()) {
            throw new \RuntimeException('Registration ID is mandatory.');
        }

        $uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $registration->getHeaders());

        $response = $this->request(self::METHOD_PUT, $uri, $headers, $registration->getPayload());

        return $registration->scrapeResponse($response);
    }

    /**
     * Delete Registration.
     *
     * @param ApiContentInterface $registration
     *
     * @throws \RuntimeException
     */
    public function deleteRegistration(RegistrationInterface $registration)

    {
        if (!$registration->getRegistrationId() || !$registration->getETag()) {
            throw new \RuntimeException('Registration ID and ETag are mandatory.');
        }

        $uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $registration->getHeaders());

        $this->request(self::METHOD_DELETE, $uri, $headers);
    }

    /**
     * Read Registration.
     *
     * @param RegistrationInterface $registration
     *
     * @throws \RuntimeException
     *
     * @return mixed
     */
    public function readRegistration(RegistrationInterface $registration)

    {
        if (!$registration->getRegistrationId()) {
            throw new \RuntimeException('Registration ID is mandatory.');
        }

        $uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $registration->getHeaders());

        $response = $this->request(self::METHOD_GET, $uri, $headers);

        return $registration->scrapeResponse($response);
    }

    /**
     * Read All Registrations of a Channel.
     *
     * @param RegistrationInterface $registration
     *
     * @throws \RuntimeException
     *
     * @return mixed
     */
    public function readAllRegistrationsOfAChannel(RegistrationInterface $registration)
    {
        if (!$registration->getToken()) {
            throw new \RuntimeException('Token is mandatory.');
        }

        $uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION.
                '&$filter='.urlencode($registration->getTokenTag().' eq \''.$registration->getToken().'\'');

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $registration->getHeaders());

        $response = $this->request(self::METHOD_GET, $uri, $headers);

        $dom = new \DOMDocument();
        $dom->loadXML($response);

        $registrations = [];
        foreach ($dom->getElementsByTagName('entry') as $entry) {
            $registrations[] = $registration->scrapeResponse($dom->saveXML($entry));
        }

        return $registrations;
    }

    /**
     * Create Registration ID.
     *
     * @return string Registration ID
     */
    public function createRegistrationId()
    {
        $registration = new GcmRegistration();
        // build uri
        $uri = $this->endpoint.$this->hubPath.'/registrationIDs/';

        $token = $this->generateSasToken($uri);
        $headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
        $headers = array_merge(['Content-length: 0'], $headers);

        $response = $this->request(self::METHOD_POST, $uri.self::API_VERSION, $headers, null, true);

        preg_match(
            '#'.$uri.'([^?]+)'.preg_quote(self::API_VERSION).'#',
            $response,
            $matches
        );

        return $matches[1];
    }

    /**
     * Send the request to API.
     *
     * @param string $method
     * @param string $uri
     * @param array  $headers
     * @param string $payload
     * @param bool   $responseHeader
     *
     * @throws \RuntimeException
     *
     * @return string
     *
     * @codeCoverageIgnore
     */
    protected function request($method, $uri, $headers, $payload = null, $responseHeader = false)
    {
        $ch = curl_init($uri);

        $options = [
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_SSL_VERIFYPEER => false,
            CURLOPT_HEADER => $responseHeader,
            CURLOPT_HTTPHEADER => $headers,
        ];

        $options[CURLOPT_CUSTOMREQUEST] = $method;

        if (!is_null($payload)) {
            $options[CURLOPT_POSTFIELDS] = $payload;
        }

        curl_setopt_array($ch, $options);

        $response = curl_exec($ch);

        if (false === $response) {
            throw new \RuntimeException(curl_error($ch));
        }

        $info = curl_getinfo($ch);
        if (200 != $info['http_code'] && 201 != $info['http_code']) {
            throw new \RuntimeException('Error sending request: '.$info['http_code'].' msg: '.$response);
        }

        return $response;
    }

    /**
     * Parses the connection string.
     *
     * @param string $connectionString
     *
     * @throws \RuntimeException
     */
    private function parseConnectionString($connectionString)
    {
        $parts = explode(';', $connectionString);
        if (3 != count($parts)) {
            throw new \RuntimeException('Error parsing connection string: '.$connectionString);
        }

        foreach ($parts as $part) {
            if (0 === strpos($part, 'Endpoint')) {
                $this->endpoint = 'https'.substr($part, 11);
            } elseif (0 === strpos($part, 'SharedAccessKeyName')) {
                $this->sasKeyName = substr($part, 20);
            } elseif (0 === strpos($part, 'SharedAccessKey')) {
                $this->sasKeyValue = substr($part, 16);
            }
        }

        if (!$this->endpoint || !$this->sasKeyName || !$this->sasKeyValue) {
            throw new \RuntimeException('Invalid connection string: '.$connectionString);
        }
    }

    /**
     * Generates the SAS token.
     *
     * @param string $uri
     *
     * @return string
     */
    private function generateSasToken($uri)
    {
        $targetUri = strtolower(rawurlencode(strtolower($uri)));
        $expires = time();
        $expiresInMins = 60;
        $expires = $expires + $expiresInMins * 60;
        $toSign = $targetUri."\n".$expires;
        $signature = rawurlencode(base64_encode(hash_hmac('sha256', $toSign, $this->sasKeyValue, true)));
        $token = 'SharedAccessSignature sr='.$targetUri.'&sig='.$signature.'&se='.$expires.'&skn='.$this->sasKeyName;

        return $token;
    }
}


1		<?php
2
3		namespace Openpp\NotificationHubsRest\NotificationHub;
4
5		use Openpp\NotificationHubsRest\Notification\NotificationInterface;
6		use Openpp\NotificationHubsRest\Registration\GcmRegistration;
7		use Openpp\NotificationHubsRest\Registration\RegistrationInterface;
8
9		class NotificationHub
10		{
11		const API_VERSION = '?api-version=2013-08';
12
13		const METHOD_GET = 'GET';
14		const METHOD_POST = 'POST';
15		const METHOD_PUT = 'PUT';
16		const METHOD_DELETE = 'DELETE';
17
18		/**
19		* @var string
20		*/
21		private $endpoint;
22
23		/**
24		* @var string
25		*/
26		private $hubPath;
27
28		/**
29		* @var string
30		*/
31		private $sasKeyName;
32
33		/**
34		* @var string
35		*/
36		private $sasKeyValue;
37
38		/**
39		* Initializes a new NotificationHub.
40		*
41		* @param string $connectionString
42		* @param string $hubPath
43		*/
44		public function __construct($connectionString, $hubPath)
45		{
46		$this->hubPath = $hubPath;
47		$this->parseConnectionString($connectionString);
48		}
49
50		/**
51		* Send a Notification.
52		*
53		* @param NotificationInterface $notification
54		*/
55		public function sendNotification(NotificationInterface $notification)
56		{
57		$uri = $notification->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;
58
59		$token = $this->generateSasToken($uri);
60		$headers = array_merge(['Authorization: '.$token], $notification->getHeaders());
61
62		$this->request(self::METHOD_POST, $uri, $headers, $notification->getPayload());
63		}
64
65		/**
66		* Create Registration.
67		*
68		* @param RegistrationInterface $registration
69		*
70		* @throws \RuntimeException
71		*
72		* @return mixed
73		*/
74	View Code Duplication	public function createRegistration(RegistrationInterface $registration)
		0 ignored issues – show Duplication introduced 2017-11-13 10:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
75		{
76		if ($registration->getRegistrationId() \|\| $registration->getETag()) {
77		throw new \RuntimeException('Registration ID and ETag must be empty.');
78		}
79
80		$uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;
81
82		$token = $this->generateSasToken($uri);
83		$headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
84
85		$response = $this->request(self::METHOD_POST, $uri, $headers, $registration->getPayload());
86
87		return $registration->scrapeResponse($response);
88		}
89
90		/**
91		* Create or Update Registration.
92		*
93		* @param RegistrationInterface $registration
94		*
95		* @throws \RuntimeException
96		*
97		* @return mixed
98		*/
99	View Code Duplication	public function updateRegistration(RegistrationInterface $registration)
		0 ignored issues – show Duplication introduced 2017-11-13 10:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
100		{
101		if (!$registration->getRegistrationId()) {
102		throw new \RuntimeException('Registration ID is mandatory.');
103		}
104
105		$uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;
106
107		$token = $this->generateSasToken($uri);
108		$headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
109
110		$response = $this->request(self::METHOD_PUT, $uri, $headers, $registration->getPayload());
111
112		return $registration->scrapeResponse($response);
113		}
114
115		/**
116		* Delete Registration.
117		*
118		* @param ApiContentInterface $registration
119		*
120		* @throws \RuntimeException
121		*/
122	View Code Duplication	public function deleteRegistration(RegistrationInterface $registration)
		0 ignored issues – show Duplication introduced 2017-11-13 10:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123		{
124		if (!$registration->getRegistrationId() \|\| !$registration->getETag()) {
125		throw new \RuntimeException('Registration ID and ETag are mandatory.');
126		}
127
128		$uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;
129
130		$token = $this->generateSasToken($uri);
131		$headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
132
133		$this->request(self::METHOD_DELETE, $uri, $headers);
134		}
135
136		/**
137		* Read Registration.
138		*
139		* @param RegistrationInterface $registration
140		*
141		* @throws \RuntimeException
142		*
143		* @return mixed
144		*/
145	View Code Duplication	public function readRegistration(RegistrationInterface $registration)
		0 ignored issues – show Duplication introduced 2017-11-13 10:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
146		{
147		if (!$registration->getRegistrationId()) {
148		throw new \RuntimeException('Registration ID is mandatory.');
149		}
150
151		$uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION;
152
153		$token = $this->generateSasToken($uri);
154		$headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
155
156		$response = $this->request(self::METHOD_GET, $uri, $headers);
157
158		return $registration->scrapeResponse($response);
159		}
160
161		/**
162		* Read All Registrations of a Channel.
163		*
164		* @param RegistrationInterface $registration
165		*
166		* @throws \RuntimeException
167		*
168		* @return mixed
169		*/
170		public function readAllRegistrationsOfAChannel(RegistrationInterface $registration)
171		{
172		if (!$registration->getToken()) {
173		throw new \RuntimeException('Token is mandatory.');
174		}
175
176		$uri = $registration->buildUri($this->endpoint, $this->hubPath).self::API_VERSION.
177		'&$filter='.urlencode($registration->getTokenTag().' eq \''.$registration->getToken().'\'');
178
179		$token = $this->generateSasToken($uri);
180		$headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
181
182		$response = $this->request(self::METHOD_GET, $uri, $headers);
183
184		$dom = new \DOMDocument();
185		$dom->loadXML($response);
186
187		$registrations = [];
188		foreach ($dom->getElementsByTagName('entry') as $entry) {
189		$registrations[] = $registration->scrapeResponse($dom->saveXML($entry));
190		}
191
192		return $registrations;
193		}
194
195		/**
196		* Create Registration ID.
197		*
198		* @return string Registration ID
199		*/
200		public function createRegistrationId()
201		{
202		$registration = new GcmRegistration();
203		// build uri
204		$uri = $this->endpoint.$this->hubPath.'/registrationIDs/';
205
206		$token = $this->generateSasToken($uri);
207		$headers = array_merge(['Authorization: '.$token], $registration->getHeaders());
208		$headers = array_merge(['Content-length: 0'], $headers);
209
210		$response = $this->request(self::METHOD_POST, $uri.self::API_VERSION, $headers, null, true);
211
212		preg_match(
213		'#'.$uri.'([^?]+)'.preg_quote(self::API_VERSION).'#',
214		$response,
215		$matches
216		);
217
218		return $matches[1];
219		}
220
221		/**
222		* Send the request to API.
223		*
224		* @param string $method
225		* @param string $uri
226		* @param array $headers
227		* @param string $payload
228		* @param bool $responseHeader
229		*
230		* @throws \RuntimeException
231		*
232		* @return string
233		*
234		* @codeCoverageIgnore
235		*/
236		protected function request($method, $uri, $headers, $payload = null, $responseHeader = false)
237		{
238		$ch = curl_init($uri);
239
240		$options = [
241		CURLOPT_RETURNTRANSFER => true,
242		CURLOPT_SSL_VERIFYPEER => false,
243		CURLOPT_HEADER => $responseHeader,
244		CURLOPT_HTTPHEADER => $headers,
245		];
246
247		$options[CURLOPT_CUSTOMREQUEST] = $method;
248
249		if (!is_null($payload)) {
250		$options[CURLOPT_POSTFIELDS] = $payload;
251		}
252
253		curl_setopt_array($ch, $options);
254
255		$response = curl_exec($ch);
256
257		if (false === $response) {
258		throw new \RuntimeException(curl_error($ch));
259		}
260
261		$info = curl_getinfo($ch);
262		if (200 != $info['http_code'] && 201 != $info['http_code']) {
263		throw new \RuntimeException('Error sending request: '.$info['http_code'].' msg: '.$response);
264		}
265
266		return $response;
267		}
268
269		/**
270		* Parses the connection string.
271		*
272		* @param string $connectionString
273		*
274		* @throws \RuntimeException
275		*/
276		private function parseConnectionString($connectionString)
277		{
278		$parts = explode(';', $connectionString);
279		if (3 != count($parts)) {
280		throw new \RuntimeException('Error parsing connection string: '.$connectionString);
281		}
282
283		foreach ($parts as $part) {
284		if (0 === strpos($part, 'Endpoint')) {
285		$this->endpoint = 'https'.substr($part, 11);
286		} elseif (0 === strpos($part, 'SharedAccessKeyName')) {
287		$this->sasKeyName = substr($part, 20);
288		} elseif (0 === strpos($part, 'SharedAccessKey')) {
289		$this->sasKeyValue = substr($part, 16);
290		}
291		}
292
293		if (!$this->endpoint \|\| !$this->sasKeyName \|\| !$this->sasKeyValue) {
294		throw new \RuntimeException('Invalid connection string: '.$connectionString);
295		}
296		}
297
298		/**
299		* Generates the SAS token.
300		*
301		* @param string $uri
302		*
303		* @return string
304		*/
305		private function generateSasToken($uri)
306		{
307		$targetUri = strtolower(rawurlencode(strtolower($uri)));
308		$expires = time();
309		$expiresInMins = 60;
310		$expires = $expires + $expiresInMins * 60;
311		$toSign = $targetUri."\n".$expires;
312		$signature = rawurlencode(base64_encode(hash_hmac('sha256', $toSign, $this->sasKeyValue, true)));
313		$token = 'SharedAccessSignature sr='.$targetUri.'&sig='.$signature.'&se='.$expires.'&skn='.$this->sasKeyName;
314
315		return $token;
316		}
317		}
318

webwarejp / notificationhubs-rest-php

GitHub Access Token became invalid

NotificationHub::parseConnectionString() B last analyzed 2017-11-15 02:00 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NotificationHub::parseConnectionString() B
last analyzed 2017-11-15 02:00 UTC