Zbox\UnifiedPush\NotificationService\APNS\Response

Complexity

Total Complexity

8

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
B	processResponse()	0	27	4
A	validateResponse()	0	12	3

<?php

/*
 * (c) Alexander Zhukov <zbox82@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zbox\UnifiedPush\NotificationService\APNS;

use Zbox\UnifiedPush\NotificationService\ResponseInterface;
use Zbox\UnifiedPush\Message\RecipientDevice;
use Zbox\UnifiedPush\Exception\DispatchMessageException;
use Zbox\UnifiedPush\Exception\InvalidRecipientException;
use Zbox\UnifiedPush\Exception\RuntimeException;

/**
 * Class Response
 * @package Zbox\UnifiedPush\NotificationService\APNS
 */
class Response implements ResponseInterface
{
    /**
     * APNS error-response packet length
     */
    const ERROR_RESPONSE_LENGTH = 6;

    /**
     * APNS error-response packet command
     */
    const ERROR_RESPONSE_COMMAND = 8;

    const NO_ERROR = 0;
    const ERROR_PROCESSING = 1;
    const ERROR_MISSING_DEVICE_TOKEN = 2;
    const ERROR_MISSING_TOPIC = 3;
    const ERROR_MISSING_PAYLOAD = 4;
    const ERROR_INVALID_TOKEN_SIZE = 5;
    const ERROR_INVALID_TOPIC_SIZE = 6;
    const ERROR_INVALID_PAYLOAD_SIZE = 7;
    const ERROR_INVALID_TOKEN = 8;
    const ERROR_SHUTDOWN = 10;
    const ERROR_UNKNOWN = 255;

    /**
     * @var array
     */
    private static $responseDescription = array(
        self::NO_ERROR => 'No errors encountered',
        self::ERROR_PROCESSING => 'Processing error',
        self::ERROR_MISSING_DEVICE_TOKEN => 'Missing device token',
        self::ERROR_MISSING_TOPIC => 'Missing topic',
        self::ERROR_MISSING_PAYLOAD => 'Missing payload',
        self::ERROR_INVALID_TOKEN_SIZE => 'Invalid token size',
        self::ERROR_INVALID_TOPIC_SIZE => 'Invalid topic size',
        self::ERROR_INVALID_PAYLOAD_SIZE => 'Invalid payload size',
        self::ERROR_INVALID_TOKEN => 'Invalid token',
        self::ERROR_SHUTDOWN => 'Shutdown',
        self::ERROR_UNKNOWN => 'None (unknown)',
    );

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

    /**
     * @var \ArrayIterator
     */
    protected $recipients;

    /**
     * @param string $binaryData
     * @param \ArrayIterator $recipients
     */
    public function __construct($binaryData, \ArrayIterator $recipients)
    {
        $this->rawResponse = $binaryData;
        $this->recipients  = $recipients;
    }

    /**
     * Unpacks and process response data
     *
     * {@inheritdoc}
     */
    public function processResponse()
    {
        $rawResponse = $this->rawResponse;

        if (empty($rawResponse)) {
            return;
        }

        $responseData = unpack("Ccommand/Cstatus/Nidentifier", $rawResponse);

        $this->validateResponse($responseData);

        $statusCode = $responseData['status'];
        $errorDescription = self::$responseDescription[$statusCode];

        if (
               $statusCode == self::ERROR_INVALID_TOKEN_SIZE
            || $statusCode == self::ERROR_INVALID_TOKEN
        ) {
            $recipients = $this->recipients;
            $recipients->current()->setIdentifierStatus(RecipientDevice::DEVICE_NOT_REGISTERED);

            throw new InvalidRecipientException($errorDescription, $recipients);
        }

        throw new DispatchMessageException($errorDescription, $statusCode);
    }

    /**
     * Validates response data
     *
     * @param array $responseData
     * @return $this
     */
    public function validateResponse($responseData)
    {
        if ($responseData === false) {
            throw new RuntimeException('Unable to unpack response data');
        }

        if (self::ERROR_RESPONSE_COMMAND != $responseData['command']) {
            throw new RuntimeException("Invalid APNS response packet command");
        }

        return $this;
    }
}