ApnChannel::openConnection() - Code Metrics - Inspection of "Break APNS feedback out of the channel" - laravel-notification-channels/apn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#35)

by Dwight

created 2018-02-09 05:04 UTC

ApnChannel::openConnection() A

↳ Parent: ApnChannel

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	8
Ratio	100 %

Code Coverage

Tests	3
CRAP Score	2.2559

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	8
loc	8
ccs	3
cts	5
cp	0.6
rs	9.4285
cc	2
eloc	5
nc	2
nop	0
crap	2.2559

<?php

namespace NotificationChannels\Apn;

use Exception;
use Illuminate\Events\Dispatcher;
use ZendService\Apple\Apns\Message\Alert;
use Illuminate\Notifications\Notification;
use ZendService\Apple\Apns\Message as Packet;
use ZendService\Apple\Apns\Client\Message as Client;
use NotificationChannels\Apn\Exceptions\SendingFailed;
use Illuminate\Notifications\Events\NotificationFailed;
use ZendService\Apple\Apns\Response\Message as Response;

class ApnChannel
{
    const SANDBOX = 0;
    const PRODUCTION = 1;

    /** @var string */
    protected $environment;

    /** @var string */
    protected $certificate;

    /** @var string|null */
    protected $passPhrase;

    /** @var \ZendService\Apple\Apns\Client\Message */
    protected $client;

    /** @var \Illuminate\Events\Dispatcher */
    protected $events;

    /**
     * @param \ZendService\Apple\Apns\Client\Message $client
     * @param \Illuminate\Events\Dispatcher $events
     * @param string $environment
     * @param string $certificate
     * @param string|null $passPhrase
     */
    public function __construct(
        Client $client,
        Dispatcher $events,
        $environment,
        $certificate,
        $passPhrase = null
    ) {
        $this->client = $client;
        $this->events = $events;
        $this->environment = $environment;
        $this->certificate = $certificate;
        $this->passPhrase = $passPhrase;
    }

    /**
     * Send the notification to Apple Push Notification Service.
     *
     * @param mixed $notifiable
     * @param \Illuminate\Notifications\Notification $notification
     *
     * @throws \NotificationChannels\Apn\Exceptions\SendingFailed
     */
    public function send($notifiable, Notification $notification)
    {
        $tokens = (array) $notifiable->routeNotificationFor('apn');
        if (! $tokens) {

            return;
        }

        $message = $notification->toApn($notifiable);

        if (! $message) {
            return;
        }

        $this->openConnection();

        foreach ($tokens as $token) {
            try {
                $alert = new Alert();
                $alert->setTitle($message->title);
                $alert->setBody($message->body);

                $packet = new Packet();
                $packet->setToken($token);
                $packet->setBadge($message->badge);
                $packet->setSound($message->sound);
                $packet->setCategory($message->category);
                $packet->setContentAvailable($message->contentAvailable);
                $packet->setAlert($alert);
                $packet->setCustom($message->custom);

                $response = $this->client->send($packet);

                if ($response->getCode() !== Response::RESULT_OK) {
                    $this->events->fire(
                        new NotificationFailed($notifiable, $notification, $this, [
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                            'token' => $token,
                            'error' => $response->getCode(),
                        ])
                    );
                }
            } catch (Exception $e) {
                throw SendingFailed::create($e);
            }
        }

        $this->closeConnection();
    }

    /**
     * Open the connection.
     *
     * @throws \NotificationChannels\Apn\Exceptions\ConnectionFailed
     */
    private function openConnection()

    {
        try {
            $this->client->open($this->environment, $this->certificate, $this->passPhrase);
        } catch (Exception $exception) {
            throw Exceptions\ConnectionFailed::create($exception);
        }
    }

    /**
     * Close the connection.
     */
    private function closeConnection()
    {
        $this->client->close();
    }
}


1			<?php
2
3			namespace NotificationChannels\Apn;
4
5			use Exception;
6			use Illuminate\Events\Dispatcher;
7			use ZendService\Apple\Apns\Message\Alert;
8			use Illuminate\Notifications\Notification;
9			use ZendService\Apple\Apns\Message as Packet;
10			use ZendService\Apple\Apns\Client\Message as Client;
11			use NotificationChannels\Apn\Exceptions\SendingFailed;
12			use Illuminate\Notifications\Events\NotificationFailed;
13			use ZendService\Apple\Apns\Response\Message as Response;
14
15			class ApnChannel
16			{
17			const SANDBOX = 0;
18			const PRODUCTION = 1;
19
20			/** @var string */
21			protected $environment;
22
23			/** @var string */
24			protected $certificate;
25
26			/** @var string\|null */
27			protected $passPhrase;
28
29			/** @var \ZendService\Apple\Apns\Client\Message */
30			protected $client;
31
32			/** @var \Illuminate\Events\Dispatcher */
33			protected $events;
34
35			/**
36			* @param \ZendService\Apple\Apns\Client\Message $client
37			* @param \Illuminate\Events\Dispatcher $events
38			* @param string $environment
39			* @param string $certificate
40			* @param string\|null $passPhrase
41			*/
42	2		public function __construct(
43			Client $client,
44			Dispatcher $events,
45			$environment,
46			$certificate,
47			$passPhrase = null
48			) {
49	2		$this->client = $client;
50	2		$this->events = $events;
51	2		$this->environment = $environment;
52	2		$this->certificate = $certificate;
53	2		$this->passPhrase = $passPhrase;
54	2		}
55
56			/**
57			* Send the notification to Apple Push Notification Service.
58			*
59			* @param mixed $notifiable
60			* @param \Illuminate\Notifications\Notification $notification
61			*
62			* @throws \NotificationChannels\Apn\Exceptions\SendingFailed
63			*/
64	2		public function send($notifiable, Notification $notification)
65			{
66	2		$tokens = (array) $notifiable->routeNotificationFor('apn');
67	2		if (! $tokens) {
			0 ignored issues – show Bug Best Practice introduced 2016-09-24 12:53 UTC by Report Bug Copy Issue Report The expression `$tokens` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
68			return;
69			}
70
71	2		$message = $notification->toApn($notifiable);
			0 ignored issues – show Bug introduced 2017-02-01 22:31 UTC by Report Bug Copy Issue Report The method `toApn()` does not seem to exist on `object<Illuminate\Notifications\Notification>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
72	2		if (! $message) {
73			return;
74			}
75
76	2		$this->openConnection();
77
78	2		foreach ($tokens as $token) {
79			try {
80	2		$alert = new Alert();
81	2		$alert->setTitle($message->title);
82	2		$alert->setBody($message->body);
83
84	2		$packet = new Packet();
85	2		$packet->setToken($token);
86	2		$packet->setBadge($message->badge);
87	2		$packet->setSound($message->sound);
88	2		$packet->setCategory($message->category);
89	2		$packet->setContentAvailable($message->contentAvailable);
90	2		$packet->setAlert($alert);
91	2		$packet->setCustom($message->custom);
92
93	2		$response = $this->client->send($packet);
94
95	2		if ($response->getCode() !== Response::RESULT_OK) {
96	1		$this->events->fire(
97	1		new NotificationFailed($notifiable, $notification, $this, [
			0 ignored issues – show Documentation introduced 2016-09-24 12:53 UTC by Report Bug Copy Issue Report `$this` is of type `this<NotificationChannels\Apn\ApnChannel>`, 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...
98	1		'token' => $token,
99	2		'error' => $response->getCode(),
100			])
101			);
102			}
103			} catch (Exception $e) {
104	2		throw SendingFailed::create($e);
105			}
106			}
107
108	2		$this->closeConnection();
109	2		}
110
111			/**
112			* Open the connection.
113			*
114			* @throws \NotificationChannels\Apn\Exceptions\ConnectionFailed
115			*/
116	2	View Code Duplication	private function openConnection()
			0 ignored issues – show Duplication introduced 2018-02-09 05:06 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...
117			{
118			try {
119	2		$this->client->open($this->environment, $this->certificate, $this->passPhrase);
120			} catch (Exception $exception) {
121			throw Exceptions\ConnectionFailed::create($exception);
122			}
123	2		}
124
125			/**
126			* Close the connection.
127			*/
128	2		private function closeConnection()
129			{
130	2		$this->client->close();
131	2		}
132			}
133

laravel-notification-channels / apn

GitHub Access Token became invalid

Pull Request — master (#35)

ApnChannel::openConnection() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like