Jgut\Tify\Adapter\ApnsAdapter

Complexity

Total Complexity

27

Size/Duplication

Total Lines	304
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	4
B	push()	0	30	3
B	feedback()	0	27	3
A	getPushClient()	0	12	2
A	getFeedbackClient()	0	12	2
A	getPushMessage()	0	8	3
A	getErrorCodeFromException()	0	10	2
A	getDefinedParameters()	0	4	1
A	getDefaultParameters()	0	6	1
A	getRequiredParameters()	0	4	1
B	__destruct()	0	10	5

<?php

/*
 * Unified push notification services abstraction (http://github.com/juliangut/tify).
 *
 * @license BSD-3-Clause
 * @link https://github.com/juliangut/tify
 * @author Julián Gutiérrez <juliangut@gmail.com>
 */

namespace Jgut\Tify\Adapter;

use Jgut\Tify\Adapter\Apns\DefaultFactory;
use Jgut\Tify\Adapter\Apns\Factory;
use Jgut\Tify\Exception\AdapterException;
use Jgut\Tify\Exception\NotificationException;
use Jgut\Tify\Notification;
use Jgut\Tify\Receiver\ApnsReceiver;
use Jgut\Tify\Result;
use ZendService\Apple\Exception\RuntimeException as ApnsRuntimeException;

/**
 * APNS service adapter.
 */
class ApnsAdapter extends AbstractAdapter implements PushAdapter, FeedbackAdapter
{
    const PARAMETER_CERTIFICATE = 'certificate';
    const PARAMETER_PASS_PHRASE = 'pass_phrase';

    const RESPONSE_OK = 0;
    const RESPONSE_PROCESSING_ERROR = 1;
    const RESPONSE_MISSING_DEVICE_TOKEN = 2;
    const RESPONSE_MISSING_TOPIC = 3;
    const RESPONSE_MISSING_PAYLOAD = 4;
    const RESPONSE_INVALID_TOKEN_SIZE = 5;
    const RESPONSE_INVALID_TOPIC_SIZE = 6;
    const RESPONSE_INVALID_PAYLOAD_SIZE = 7;
    const RESPONSE_INVALID_TOKEN = 8;
    const RESPONSE_UNKNOWN_ERROR = 255;
    const RESPONSE_UNAVAILABLE = 2048;

    /**
     * Status codes mapping.
     *
     * @var array
     */
    protected static $statusCodeMap = [
        self::RESPONSE_OK => Result::STATUS_SUCCESS,

        self::RESPONSE_MISSING_DEVICE_TOKEN => Result::STATUS_INVALID_MESSAGE,
        self::RESPONSE_MISSING_TOPIC => Result::STATUS_INVALID_MESSAGE,
        self::RESPONSE_MISSING_PAYLOAD => Result::STATUS_INVALID_MESSAGE,
        self::RESPONSE_INVALID_TOKEN_SIZE => Result::STATUS_INVALID_MESSAGE,
        self::RESPONSE_INVALID_TOPIC_SIZE => Result::STATUS_INVALID_MESSAGE,
        self::RESPONSE_INVALID_PAYLOAD_SIZE => Result::STATUS_INVALID_MESSAGE,

        self::RESPONSE_INVALID_TOKEN => Result::STATUS_INVALID_DEVICE,

        self::RESPONSE_PROCESSING_ERROR => Result::STATUS_SERVER_ERROR,
        self::RESPONSE_UNAVAILABLE => Result::STATUS_SERVER_ERROR,

        self::RESPONSE_UNKNOWN_ERROR => Result::STATUS_UNKNOWN_ERROR,
    ];

    /**
     * Status messages mapping.
     *
     * @var array
     */
    protected static $statusMessageMap = [
        self::RESPONSE_OK => 'OK',

        self::RESPONSE_MISSING_DEVICE_TOKEN => 'Missing Device Token',
        self::RESPONSE_MISSING_TOPIC => 'Missing Topic',
        self::RESPONSE_MISSING_PAYLOAD => 'Missing Payload',
        self::RESPONSE_INVALID_TOKEN_SIZE => 'Invalid Token Size',
        self::RESPONSE_INVALID_TOPIC_SIZE => 'Invalid Topic Size',
        self::RESPONSE_INVALID_PAYLOAD_SIZE => 'Invalid Payload Size',

        self::RESPONSE_INVALID_TOKEN => 'Invalid Token',

        self::RESPONSE_PROCESSING_ERROR => 'Processing Error',
        self::RESPONSE_UNAVAILABLE => 'Server Unavailable',

        self::RESPONSE_UNKNOWN_ERROR => 'Unknown Error',
    ];

    /**
     * APNS service factory.
     *
     * @var Factory
     */
    protected $factory;

    /**
     * Push service client.
     *
     * @var \ZendService\Apple\Apns\Client\Message
     */
    protected $pushClient;

    /**
     * Feedback service client.
     *
     * @var \ZendService\Apple\Apns\Client\Feedback
     */
    protected $feedbackClient;

    /**
     * APNS service adapter constructor.
     *
     * @param array   $parameters
     * @param Factory $factory

Should the type for parameter $factory not be null|Factory?

     * @param bool    $sandbox
     *
     * @throws AdapterException
     */
    public function __construct(array $parameters = [], $sandbox = false, Factory $factory = null)
    {
        parent::__construct($parameters, $sandbox);

        $certificatePath = $this->getParameter(static::PARAMETER_CERTIFICATE);
        if (!file_exists($certificatePath) || !is_readable($certificatePath)) {
            throw new AdapterException(
                sprintf('Certificate file "%s" does not exist or is not readable', $certificatePath)
            );
        }

        // @codeCoverageIgnoreStart
        if ($factory === null) {
            $factory = new DefaultFactory;
        }
        // @codeCoverageIgnoreEnd

        $this->factory = $factory;
    }

    /**
     * {@inheritdoc}
     *
     * @throws \InvalidArgumentException
     * @throws \Jgut\Tify\Exception\AdapterException
     * @throws \ZendService\Apple\Exception\RuntimeException
     */
    public function push(Notification $notification)
    {
        $client = $this->getPushClient();

        $pushResults = [];

        $date = new \DateTime('now', new \DateTimeZone('UTC'));

        foreach ($this->getPushMessage($notification) as $pushMessage) {
            try {
                $statusCode = $client->send($pushMessage)->getCode();
            // @codeCoverageIgnoreStart
            } catch (ApnsRuntimeException $exception) {
                $statusCode = $this->getErrorCodeFromException($exception);
            }
            // @codeCoverageIgnoreEnd

            $pushResults[] = new Result(
                $pushMessage->getToken(),
                $date,
                self::$statusCodeMap[$statusCode],
                self::$statusMessageMap[$statusCode]
            );
        }

        $client->close();
        $this->pushClient = null;

        return $pushResults;
    }

    /**
     * {@inheritdoc}
     *
     * @throws \InvalidArgumentException
     * @throws \Jgut\Tify\Exception\AdapterException
     * @throws \Jgut\Tify\Exception\NotificationException
     */
    public function feedback()
    {
        $client = $this->getFeedbackClient();

        $feedbackResults = [];

        try {
            /* @var \ZendService\Apple\Apns\Response\Feedback[] $feedbackResponses */
            $feedbackResponses = $client->feedback();
        // @codeCoverageIgnoreStart
        } catch (ApnsRuntimeException $exception) {
            throw new NotificationException($exception->getMessage(), $exception->getCode(), $exception);
        }
        // @codeCoverageIgnoreEnd

        foreach ($feedbackResponses as $response) {
            $feedbackResults[] = new Result(
                $response->getToken(),
                \DateTime::createFromFormat('U', $response->getTime())

It seems like \DateTime::createFromFormat('U', $response->getTime()) targeting DateTime::createFromFormat() can also be of type false; however, Jgut\Tify\Result::__construct() does only seem to accept object<DateTime>, did you maybe forget to handle an error condition?

            );
        }

        $client->close();
        $this->feedbackClient = null;

        return $feedbackResults;
    }

    /**
     * Get opened push service client.
     *
     * @throws AdapterException
     *
     * @return \ZendService\Apple\Apns\Client\Message
     */
    protected function getPushClient()
    {
        if ($this->pushClient === null) {
            $this->pushClient = $this->factory->buildPushClient(

It seems like $this->factory->buildPushClient($this->getParameter(static::PARAMETER_CERTIFICATE), $this->getParameter(static::PARAMETER_PASS_PHRASE), $this->sandbox) of type object<Jgut\Tify\Adapter\Apns\AbstractClient> is incompatible with the declared type object<ZendService\Apple\Apns\Client\Message> of property $pushClient.

                $this->getParameter(static::PARAMETER_CERTIFICATE),
                $this->getParameter(static::PARAMETER_PASS_PHRASE),
                $this->sandbox
            );
        }

        return $this->pushClient;

The expression $this->pushClient; of type Jgut\Tify\Adapter\Apns\AbstractClient|ZendService\Apple\Apns\Client\Message adds the type Jgut\Tify\Adapter\Apns\AbstractClient to the return on line 228 which is incompatible with the return type documented by Jgut\Tify\Adapter\ApnsAdapter::getPushClient of type ZendService\Apple\Apns\Client\Message.

    }

    /**
     * Get opened feedback service client.
     *
     * @throws AdapterException
     *
     * @return \ZendService\Apple\Apns\Client\Feedback
     */
    protected function getFeedbackClient()
    {
        if ($this->feedbackClient === null) {
            $this->feedbackClient = $this->factory->buildFeedbackClient(
                $this->getParameter('certificate'),
                $this->getParameter('pass_phrase'),
                $this->sandbox
            );
        }

        return $this->feedbackClient;
    }

    /**
     * Get service formatted push message.
     *
     * @param Notification $notification
     *
     * @throws \ZendService\Apple\Exception\RuntimeException
     *
     * @return \Generator<\ZendService\Apple\Apns\Message>

The doc-type \Generator<\ZendService\Apple\Apns\Message> could not be parsed: Expected "|" or "end of type", but got "<" at position 10. (view supported doc-types)

     */
    protected function getPushMessage(Notification $notification)
    {
        foreach ($notification->getReceivers() as $receiver) {
            if ($receiver instanceof ApnsReceiver) {
                yield $this->factory->buildPushMessage($receiver, $notification);
            }
        }
    }

    /**
     * Extract error code from exception.
     *
     * @param ApnsRuntimeException $exception
     *
     * @return int
     */
    protected function getErrorCodeFromException(ApnsRuntimeException $exception)
    {
        $message = $exception->getMessage();

        if (preg_match('/^Server is unavailable/', $message)) {
            return static::RESPONSE_UNAVAILABLE;
        }

        return static::RESPONSE_UNKNOWN_ERROR;
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefinedParameters()
    {
        return [static::PARAMETER_CERTIFICATE, static::PARAMETER_PASS_PHRASE];
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultParameters()
    {
        return [
            static::PARAMETER_PASS_PHRASE => null,
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function getRequiredParameters()
    {
        return [static::PARAMETER_CERTIFICATE];
    }

    /**
     * Disconnect clients.
     *
     * @codeCoverageIgnore
     */
    public function __destruct()
    {
        if ($this->pushClient !== null && $this->pushClient->isConnected()) {
            $this->pushClient->close();
        }

        if ($this->feedbackClient !== null && $this->feedbackClient->isConnected()) {
            $this->feedbackClient->close();
        }
    }
}