CL\SlackCli\Command\ApiTestCommand

Complexity

Total Complexity

11

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

97.67%

Importance

Changes	6
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	configure()	0	22	1
A	createPayload()	0	21	4
B	handleResponse()	0	28	6

<?php

/*
 * This file is part of the slack-cli package.
 *
 * (c) Cas Leentfaar <info@casleentfaar.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CL\SlackCli\Command;

use CL\Slack\Payload\ApiTestPayload;
use CL\Slack\Payload\ApiTestPayloadResponse;
use Symfony\Component\Console\Input\InputOption;

/**
 * @author Cas Leentfaar <info@casleentfaar.com>
 */
class ApiTestCommand extends AbstractApiCommand
{
    /**
     * @var bool
     */
    private $expectError = false;

    /**
     * {@inheritDoc}
     */
    protected function configure()
    {
        parent::configure();

        $this->setName('api:test');
        $this->setDescription('Tests connecting with the Slack API using the token.');
        $this->addOption('arguments', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Arguments to be tested in key:value format, such as "foo:bar"');
        $this->addOption('error', null, InputOption::VALUE_REQUIRED, 'Optional error message to mock an error response from Slack with');
        $this->setHelp(<<<EOT
The <info>api:test</info> command lets you connect with the Slack API for testing purposes.

Testing arguments returned by Slack
<info>php bin/slack api.test --args="foo=bar&apple=pie"</info>

Testing an error response
<info>php bin/slack api.test --error="This is my error"</info>

For more information about the related API method, check out the official documentation:
<comment>https://api.slack.com/methods/api.test</comment>
EOT
        );
    }

    /**
     * @return ApiTestPayload
     */
    protected function createPayload()
    {
        $payload = new ApiTestPayload();

        if ($this->input->getOption('arguments')) {
            $args = [];
            foreach ($this->input->getOption('arguments') as $keyValue) {
                list($key, $value) = explode(':', $keyValue);
                $args[$key] = $value;
            }

            $payload->replaceArguments($args);
        }

        if ($this->input->getOption('error')) {
            $this->expectError = true;
            $payload->setError($this->input->getOption('error'));
        }

        return $payload;
    }

    /**
     * {@inheritdoc}
     *
     * @param ApiTestPayloadResponse $payloadResponse
     */
    protected function handleResponse($payloadResponse)
    {
        if ($this->expectError === true || $payloadResponse->isOk()) {
            $this->writeOk('Slack API seems to have responded correctly (no error expected, no error returned)');
            $data = [];
            if (null !== $error = $payloadResponse->getError()) {
                $data['error'] = $error;
            }
            foreach ($payloadResponse->getArguments() as $key => $val) {
                if ($key == 'token') {
                    continue;
                }

                $data['args'][$key] = $val;
            }
            $this->renderKeyValueTable($data);

            // force 0 so any error tested here won't trigger a failure
            return 0;
        } else {
            $this->writeError(sprintf(
                'Slack API did not respond correctly (no error expected): %s',
                lcfirst($payloadResponse->getErrorExplanation())
            ));

            return 1;
        }
    }
}