Erdemkeren\JetSms\Http\Responses\JetSmsXmlResponse

Complexity

Total Complexity

10

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	isSuccessful()	0	4	1
A	message()	0	4	2
A	groupId()	0	4	1
A	messageReportIdentifiers()	0	6	1
A	statusCode()	0	4	1
A	status()	0	6	2

<?php

namespace Erdemkeren\JetSms\Http\Responses;

use BadMethodCallException;

/**
 * Class JetSmsXmlResponse.
 */
class JetSmsXmlResponse implements JetSmsResponseInterface
{
    /**
     * The predefined status codes of the JetSms Xml api.
     *
     * @var array
     */
    protected static $statuses = [
        '00' => 'Success',
        '10' => 'Invalid client credentials',
        '11' => 'Insufficient funds',
        '20' => 'Invalid xml',
        '81' => 'Out of limits',
        '90' => 'System error',
    ];

    /**
     * The JetSms Http status code.
     *
     * @var string
     */
    protected $statusCode;

    /**
     * The message of the response if any.
     *
     * @var string|null
     */
    protected $message;

    /**
     * The group identifier.
     *
     * @var string|null
     */
    protected $groupId;

    /**
     * XmlJetSmsHttpResponse constructor.
     *
     * @param  string $data
     */
    public function __construct($data)
    {
        $response = explode(" ", $data);
        $this->statusCode = array_shift($response);

        if (! $this->isSuccessful()) {
            $this->message = implode(' ', $response);
        } else {
            $this->groupId =  array_shift($response);
        }
    }

    /**
     * Determine if the operation was successful or not.
     *
     * @return bool
     */
    public function isSuccessful()
    {
        return $this->statusCode === '00';
    }

    /**
     * Get the message of the response.
     *
     * @return null|string
     */
    public function message()
    {
        return trim($this->message) ?: null;
    }

    /**
     * Get the group identifier from the response.
     *
     * @return string
     */
    public function groupId()
    {
        return $this->groupId;
    }

    /**
     * Get the message report identifiers for the messages sent.
     * Message report id returns -1 if invalid Msisdns, -2 if invalid message text.
     */
    public function messageReportIdentifiers()
    {
        throw new BadMethodCallException(
            "JetSms XML API responses do not return message identifiers. Use groupId instead."
        );
    }

    /**
     * Get the status code.
     *
     * @return string
     */
    public function statusCode()
    {
        return $this->statusCode;
    }

    /**
     * Get the string representation of the status.
     *
     * @return string
     */
    public function status()
    {
        return array_key_exists($this->statusCode(), self::$statuses)
            ? self::$statuses[$this->statusCode()]
            : 'Unknown';
    }
}