ApnChannel::openConnection() - Code Metrics - Inspection of "batch send failure #31" - laravel-notification-channels/apn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32)

unknown

created 2017-12-24 08:49 UTC

ApnChannel::openConnection() A

↳ Parent: ApnChannel

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	4
cts	5
cp	0.8
rs	9.4285
cc	2
eloc	5
nc	2
nop	0
crap	2.032

<?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;
use ZendService\Apple\Apns\Client\Feedback as FeedbackClient;
use ZendService\Apple\Apns\Response\Feedback as FeedbackResponse;

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 \ZendService\Apple\Apns\Client\Feedback */
    protected $feedbackClient;

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

    /**
     * @param \ZendService\Apple\Apns\Client\Message $client
     * @param \ZendService\Apple\Apns\Client\Feedback $feedbackClient
     * @param \Illuminate\Events\Dispatcher $events
     * @param string $environment
     * @param string $certificate
     * @param string|null $passPhrase
     */
    public function __construct(
        Client $client,
        FeedbackClient $feedbackClient,
        Dispatcher $events,
        $environment,
        $certificate,
        $passPhrase = null
    ) {
        $this->client = $client;
        $this->feedbackClient = $feedbackClient;
        $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(),
                        ])
                    );
                    
                    //connection is useless so create a new connection
                    $this->closeConnection();
                    $this->openConnection();
                }
            } catch (Exception $e) {
                throw SendingFailed::create($e);
            }
        }

        $this->closeConnection();
    }

    /**
     * Get feedback from the Apple Feedback Service about failed deliveries.
     *
     * @return array|ApnFeedback[]
     * @throws Exceptions\ConnectionFailed
     */
    public function getFeedback()
    {
        $client = $this->feedbackClient;

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

        $feedback = [];

        /** @var FeedbackResponse $response */
        foreach ($client->feedback() as $response) {
            $feedback[] = new ApnFeedback($response->getToken(), $response->getTime());
        }

        $client->close();

        return $feedback;
    }

    /**
     * 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		use ZendService\Apple\Apns\Client\Feedback as FeedbackClient;
15		use ZendService\Apple\Apns\Response\Feedback as FeedbackResponse;
16
17		class ApnChannel
18		{
19		const SANDBOX = 0;
20		const PRODUCTION = 1;
21
22		/** @var string */
23		protected $environment;
24
25		/** @var string */
26		protected $certificate;
27
28		/** @var string\|null */
29		protected $passPhrase;
30
31		/** @var \ZendService\Apple\Apns\Client\Message */
32		protected $client;
33
34		/** @var \ZendService\Apple\Apns\Client\Feedback */
35		protected $feedbackClient;
36
37		/** @var \Illuminate\Events\Dispatcher */
38		protected $events;
39
40		/**
41		* @param \ZendService\Apple\Apns\Client\Message $client
42		* @param \ZendService\Apple\Apns\Client\Feedback $feedbackClient
43		* @param \Illuminate\Events\Dispatcher $events
44		* @param string $environment
45		* @param string $certificate
46		* @param string\|null $passPhrase
47		*/
48	2	public function __construct(
49		Client $client,
50		FeedbackClient $feedbackClient,
51		Dispatcher $events,
52		$environment,
53		$certificate,
54		$passPhrase = null
55		) {
56	2	$this->client = $client;
57	2	$this->feedbackClient = $feedbackClient;
58	2	$this->events = $events;
59	2	$this->environment = $environment;
60	2	$this->certificate = $certificate;
61	2	$this->passPhrase = $passPhrase;
62	2	}
63
64		/**
65		* Send the notification to Apple Push Notification Service.
66		*
67		* @param mixed $notifiable
68		* @param \Illuminate\Notifications\Notification $notification
69		*
70		* @throws \NotificationChannels\Apn\Exceptions\SendingFailed
71		*/
72	1	public function send($notifiable, Notification $notification)
73		{
74	1	$tokens = (array) $notifiable->routeNotificationFor('apn');
75	1	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...
76		return;
77		}
78
79	1	$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...
80	1	if (! $message) {
81		return;
82		}
83
84	1	$this->openConnection();
85
86	1	foreach ($tokens as $token) {
87		try {
88	1	$alert = new Alert();
89	1	$alert->setTitle($message->title);
90	1	$alert->setBody($message->body);
91
92	1	$packet = new Packet();
93	1	$packet->setToken($token);
94	1	$packet->setBadge($message->badge);
95	1	$packet->setSound($message->sound);
96	1	$packet->setCategory($message->category);
97	1	$packet->setContentAvailable($message->contentAvailable);
98	1	$packet->setAlert($alert);
99	1	$packet->setCustom($message->custom);
100
101	1	$response = $this->client->send($packet);
102
103	1	if ($response->getCode() !== Response::RESULT_OK) {
104	1	$this->events->fire(
105	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...
106	1	'token' => $token,
107	1	'error' => $response->getCode(),
108	1	])
109	1	);
110
111		//connection is useless so create a new connection
112	1	$this->closeConnection();
113	1	$this->openConnection();
114	1	}
115	1	} catch (Exception $e) {
116		throw SendingFailed::create($e);
117		}
118	1	}
119
120	1	$this->closeConnection();
121	1	}
122
123		/**
124		* Get feedback from the Apple Feedback Service about failed deliveries.
125		*
126		* @return array\|ApnFeedback[]
127		* @throws Exceptions\ConnectionFailed
128		*/
129	1	public function getFeedback()
130		{
131	1	$client = $this->feedbackClient;
132
133		try {
134	1	$client->open($this->environment, $this->certificate, $this->passPhrase);
135	1	} catch (Exception $exception) {
136		throw Exceptions\ConnectionFailed::create($exception);
137		}
138
139	1	$feedback = [];
140
141		/** @var FeedbackResponse $response */
142	1	foreach ($client->feedback() as $response) {
143	1	$feedback[] = new ApnFeedback($response->getToken(), $response->getTime());
144	1	}
145
146	1	$client->close();
147
148	1	return $feedback;
149		}
150
151		/**
152		* Open the connection.
153		*
154		* @throws \NotificationChannels\Apn\Exceptions\ConnectionFailed
155		*/
156	1	private function openConnection()
157		{
158		try {
159	1	$this->client->open($this->environment, $this->certificate, $this->passPhrase);
160	1	} catch (Exception $exception) {
161		throw Exceptions\ConnectionFailed::create($exception);
162		}
163	1	}
164
165		/**
166		* Close the connection.
167		*/
168	1	private function closeConnection()
169		{
170	1	$this->client->close();
171	1	}
172		}
173

laravel-notification-channels / apn

GitHub Access Token became invalid

Pull Request — master (#32)

ApnChannel::openConnection() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like