badams\MicrosoftTranslator\Methods\Speak

Complexity

Total Complexity

9

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	2
A	validateFormat()	0	8	2
A	validateOptions()	0	10	2
A	getRequestMethod()	0	4	1
A	getRequestOptions()	0	9	1
A	processResponse()	0	4	1

<?php
/**
 * This file is part of the badams\MicrosoftTranslator library
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/badams/microsoft-translator
 * @package badams/microsoft-translator
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace badams\MicrosoftTranslator\Methods;

use badams\MicrosoftTranslator\Language;
use badams\MicrosoftTranslator\Exceptions\ArgumentException;

/**
 * Class Speak
 * @package badams\MicrosoftTranslator\Methods
 * @link https://msdn.microsoft.com/en-us/library/ff512420.aspx
 */
class Speak implements \badams\MicrosoftTranslator\ApiMethodInterface
{
    const TEXT_MAX_LENGTH = 2000;

    const FORMAT_MP3 = 'audio/mp3';
    const FORMAT_WAV = 'audio/wav';

    const OPTION_MAX_QUALITY = 'MaxQuality';
    const OPTION_MIN_SIZE = 'MinSize';

    /**
     * @var Language
     */
    protected $language;

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

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

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

    /**
     * Speak constructor.
     * @param $text
     * @param $language
     * @param string $format
     * @param string $options
     */
    public function __construct($text, $language, $format = Speak::FORMAT_MP3, $options = Speak::OPTION_MAX_QUALITY)
    {
        if (strlen($text) > Speak::TEXT_MAX_LENGTH) {
            throw new ArgumentException(
                sprintf('The length of the text must not exceed %s characters.', Speak::TEXT_MAX_LENGTH)
            );
        }

        $this->text = $text;
        $this->language = new Language($language);
        $this->format = $this->validateFormat($format);
        $this->options = $this->validateOptions($options);
    }

    /**
     * @param $format
     * @return mixed
     * @throws ArgumentException
     */
    public function validateFormat($format)
    {
        if (!in_array($format, [Speak::FORMAT_MP3, Speak::FORMAT_WAV])) {
            throw new ArgumentException(sprintf('"%s" is not an accepted format.', $format));
        }

        return $format;
    }

    /**
     * @param $options
     * @return mixed
     * @throws ArgumentException
     */
    public function validateOptions($options)
    {
        if (!in_array($options, [Speak::OPTION_MAX_QUALITY, Speak::OPTION_MIN_SIZE])) {
            throw new ArgumentException(
                sprintf('invalid options: "%s"', $options)
            );
        }

        return $options;
    }

    /**
     * @return string
     */
    public function getRequestMethod()
    {
        return 'GET';
    }

    /**
     * @return array
     */
    public function getRequestOptions()
    {
        return ['query' => [
            'text' => $this->text,
            'language' => (string)$this->language,
            'format' => $this->format,
            'options' => $this->options,
        ]];
    }

    /**
     * @param \GuzzleHttp\Message\ResponseInterface $response
     * @return string
     */
    public function processResponse(\GuzzleHttp\Message\ResponseInterface $response)
    {
        return base64_encode($response->getBody()->getContents());
    }
}