Configure::configureSms() - Code Metrics - Inspection of "Added support using Puzzel as 2FA via SMS." - nextcloud/twofactor_gateway - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#145)

unknown

created 2018-11-12 21:23 UTC

Configure::configureSms() B

↳ Parent: Configure

Complexity

Conditions	5
Paths	5

Size

Total Lines	77
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	54
dl	0
loc	77
rs	8.6925
c	0
b	0
f	0
cc	5
nc	5
nop	2

How to fix Long Method

<?php

declare(strict_types=1);

/**
 * @author Christoph Wurst <[email protected]>
 *
 * Nextcloud - Two-factor Gateway
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\TwoFactorGateway\Command;

use OCA\TwoFactorGateway\Service\Gateway\IGateway;
use OCA\TwoFactorGateway\Service\Gateway\Signal\Gateway as SignalGateway;
use OCA\TwoFactorGateway\Service\Gateway\Signal\GatewayConfig as SignalConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Gateway as SMSGateway;
use OCA\TwoFactorGateway\Service\Gateway\SMS\GatewayConfig as SMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\PlaySMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\WebSmsConfig;
use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\PuzzelSMSConfig;
use OCA\TwoFactorGateway\Service\Gateway\Telegram\Gateway as TelegramGateway;
use OCA\TwoFactorGateway\Service\Gateway\Telegram\GatewayConfig as TelegramConfig;
use Symfony\Component\Console\Command\Command;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Console\Input\InputArgument;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Console\Input\InputInterface;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Console\Output\OutputInterface;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Console\Question\Question;
filter:
    dependency_paths: ["lib/*"]

class Configure extends Command {

	/** @var SignalGateway */
	private $signalGateway;

	/** @var SMSGateway */
	private $smsGateway;

	/** @var TelegramGateway */
	private $telegramGateway;

	public function __construct(SignalGateway $signalGateway,
								SMSGateway $smsGateway,
								TelegramGateway $telegramGateway) {
		parent::__construct('twofactorauth:gateway:configure');
		$this->signalGateway = $signalGateway;
		$this->smsGateway = $smsGateway;
		$this->telegramGateway = $telegramGateway;

		$this->addArgument(
			'gateway',
			InputArgument::REQUIRED,
			'The identifier (e.g. phone number) of the recipient'
		);
	}

	protected function execute(InputInterface $input, OutputInterface $output) {
		$gatewayName = $input->getArgument('gateway');

		/** @var IGateway $gateway */
		$gateway = null;

		switch ($gatewayName) {
			case 'signal':
				$this->configureSignal($input, $output);
				break;
			case 'sms':
				$this->configureSms($input, $output);
				break;
			case 'telegram':
				$this->configureTelegram($input, $output);
				break;
			default:
				$output->writeln("<error>Invalid gateway $gatewayName</error>");
				return;
		}
	}

	private function configureSignal(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');
		$urlQuestion = new Question('Please enter the URL of the Signal gateway (leave blank to use default): ', 'http://localhost:5000');
		$url = $helper->ask($input, $output, $urlQuestion);
		$output->writeln("Using $url.");

		/** @var SignalConfig $config */
		$config = $this->signalGateway->getConfig();

		$config->setUrl($url);
	}

	private function configureSms(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');
		$providerQuestion = new Question('Please choose a SMS provider (websms, playsms, clockworksms, puzzelsms): ', 'websms');
		$provider = $helper->ask($input, $output, $providerQuestion);

		/** @var SMSConfig $config */
		$config = $this->smsGateway->getConfig();
		switch ($provider) {
			case 'websms':
				$config->setProvider($provider);
				/** @var WebSmsConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$usernameQuestion = new Question('Please enter your websms.de username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your websms.de password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);

				break;
			case 'playsms':
				$config->setProvider($provider);
				/** @var PlaySMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$urlQuestion = new Question('Please enter your PlaySMS URL: ');
				$url = $helper->ask($input, $output, $urlQuestion);
				$usernameQuestion = new Question('Please enter your PlaySMS username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);
				$passwordQuestion = new Question('Please enter your PlaySMS password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$providerConfig->setUrl($url);
				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);

				break;
			case 'clockworksms':
				$config->setProvider($provider);
				/** @var ClockworkSmsConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$apitokenQuestion = new Question('Please enter your clockworksms api token: ');
				$apitoken = $helper->ask($input, $output, $apitokenQuestion);

				$providerConfig->setApiToken($apitoken);

				break;
			case 'puzzelsms':
				$config->setProvider($provider);

				/** @var PuzzelSMSConfig $providerConfig */
				$providerConfig = $config->getProvider()->getConfig();

				$urlQuestion = new Question('Please enter your PuzzelSMS URL: ');
				$url = $helper->ask($input, $output, $urlQuestion);

				$usernameQuestion = new Question('Please enter your PuzzelSMS username: ');
				$username = $helper->ask($input, $output, $usernameQuestion);

				$passwordQuestion = new Question('Please enter your PuzzelSMS password: ');
				$password = $helper->ask($input, $output, $passwordQuestion);

				$serviceQuestion = new Question('Please enter your PuzzelSMS service ID: ');
				$serviceId = $helper->ask($input, $output, $serviceQuestion);

				$providerConfig->setUrl($url);
				$providerConfig->setUser($username);
				$providerConfig->setPassword($password);
				$providerConfig->setServiceId($serviceId);
				break;

			default:
				$output->writeln("Invalid provider $provider");
				break;
		}

	}

	private function configureTelegram(InputInterface $input, OutputInterface $output) {
		$helper = $this->getHelper('question');
		$tokenQuestion = new Question('Please enter your Telegram bot token: ');
		$token = $helper->ask($input, $output, $tokenQuestion);
		$output->writeln("Using $token.");

		/** @var TelegramConfig $config */
		$config = $this->telegramGateway->getConfig();

		$config->setBotToken($token);
	}

}

1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* @author Christoph Wurst <[email protected]>
7			*
8			* Nextcloud - Two-factor Gateway
9			*
10			* This code is free software: you can redistribute it and/or modify
11			* it under the terms of the GNU Affero General Public License, version 3,
12			* as published by the Free Software Foundation.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License, version 3,
20			* along with this program. If not, see <http://www.gnu.org/licenses/>
21			*
22			*/
23
24			namespace OCA\TwoFactorGateway\Command;
25
26			use OCA\TwoFactorGateway\Service\Gateway\IGateway;
27			use OCA\TwoFactorGateway\Service\Gateway\Signal\Gateway as SignalGateway;
28			use OCA\TwoFactorGateway\Service\Gateway\Signal\GatewayConfig as SignalConfig;
29			use OCA\TwoFactorGateway\Service\Gateway\SMS\Gateway as SMSGateway;
30			use OCA\TwoFactorGateway\Service\Gateway\SMS\GatewayConfig as SMSConfig;
31			use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\PlaySMSConfig;
32			use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\WebSmsConfig;
33			use OCA\TwoFactorGateway\Service\Gateway\SMS\Provider\PuzzelSMSConfig;
34			use OCA\TwoFactorGateway\Service\Gateway\Telegram\Gateway as TelegramGateway;
35			use OCA\TwoFactorGateway\Service\Gateway\Telegram\GatewayConfig as TelegramConfig;
36			use Symfony\Component\Console\Command\Command;
			0 ignored issues – show Bug introduced 2018-08-22 06:20 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Console\Command\Command` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
37			use Symfony\Component\Console\Input\InputArgument;
			0 ignored issues – show Bug introduced 2018-08-22 06:20 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Console\Input\InputArgument` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
38			use Symfony\Component\Console\Input\InputInterface;
			0 ignored issues – show Bug introduced 2018-08-22 06:20 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Console\Input\InputInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
39			use Symfony\Component\Console\Output\OutputInterface;
			0 ignored issues – show Bug introduced 2018-08-22 06:20 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Console\Output\OutputInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
40			use Symfony\Component\Console\Question\Question;
			0 ignored issues – show Bug introduced 2018-08-22 06:20 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Console\Question\Question` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
41
42			class Configure extends Command {
43
44			/** @var SignalGateway */
45			private $signalGateway;
46
47			/** @var SMSGateway */
48			private $smsGateway;
49
50			/** @var TelegramGateway */
51			private $telegramGateway;
52
53			public function __construct(SignalGateway $signalGateway,
54			SMSGateway $smsGateway,
55			TelegramGateway $telegramGateway) {
56			parent::__construct('twofactorauth:gateway:configure');
57			$this->signalGateway = $signalGateway;
58			$this->smsGateway = $smsGateway;
59			$this->telegramGateway = $telegramGateway;
60
61			$this->addArgument(
62			'gateway',
63			InputArgument::REQUIRED,
64			'The identifier (e.g. phone number) of the recipient'
65			);
66			}
67
68			protected function execute(InputInterface $input, OutputInterface $output) {
69			$gatewayName = $input->getArgument('gateway');
70
71			/** @var IGateway $gateway */
72			$gateway = null;
			0 ignored issues – show Unused Code introduced 2018-08-22 06:20 UTC by Report Bug Copy Issue Report The assignment to `$gateway` is dead and can be removed. Loading history...
73			switch ($gatewayName) {
74			case 'signal':
75			$this->configureSignal($input, $output);
76			break;
77			case 'sms':
78			$this->configureSms($input, $output);
79			break;
80			case 'telegram':
81			$this->configureTelegram($input, $output);
82			break;
83			default:
84			$output->writeln("<error>Invalid gateway $gatewayName</error>");
85			return;
86			}
87			}
88
89			private function configureSignal(InputInterface $input, OutputInterface $output) {
90			$helper = $this->getHelper('question');
91			$urlQuestion = new Question('Please enter the URL of the Signal gateway (leave blank to use default): ', 'http://localhost:5000');
92			$url = $helper->ask($input, $output, $urlQuestion);
93			$output->writeln("Using $url.");
94
95			/** @var SignalConfig $config */
96			$config = $this->signalGateway->getConfig();
97
98			$config->setUrl($url);
99			}
100
101			private function configureSms(InputInterface $input, OutputInterface $output) {
102			$helper = $this->getHelper('question');
103			$providerQuestion = new Question('Please choose a SMS provider (websms, playsms, clockworksms, puzzelsms): ', 'websms');
104			$provider = $helper->ask($input, $output, $providerQuestion);
105
106			/** @var SMSConfig $config */
107			$config = $this->smsGateway->getConfig();
108			switch ($provider) {
109			case 'websms':
110			$config->setProvider($provider);
111			/** @var WebSmsConfig $providerConfig */
112			$providerConfig = $config->getProvider()->getConfig();
113
114			$usernameQuestion = new Question('Please enter your websms.de username: ');
115			$username = $helper->ask($input, $output, $usernameQuestion);
116			$passwordQuestion = new Question('Please enter your websms.de password: ');
117			$password = $helper->ask($input, $output, $passwordQuestion);
118
119			$providerConfig->setUser($username);
120			$providerConfig->setPassword($password);
121
122			break;
123			case 'playsms':
124			$config->setProvider($provider);
125			/** @var PlaySMSConfig $providerConfig */
126			$providerConfig = $config->getProvider()->getConfig();
127
128			$urlQuestion = new Question('Please enter your PlaySMS URL: ');
129			$url = $helper->ask($input, $output, $urlQuestion);
130			$usernameQuestion = new Question('Please enter your PlaySMS username: ');
131			$username = $helper->ask($input, $output, $usernameQuestion);
132			$passwordQuestion = new Question('Please enter your PlaySMS password: ');
133			$password = $helper->ask($input, $output, $passwordQuestion);
134
135			$providerConfig->setUrl($url);
136			$providerConfig->setUser($username);
137			$providerConfig->setPassword($password);
138
139			break;
140			case 'clockworksms':
141			$config->setProvider($provider);
142			/** @var ClockworkSmsConfig $providerConfig */
143			$providerConfig = $config->getProvider()->getConfig();
144
145			$apitokenQuestion = new Question('Please enter your clockworksms api token: ');
146			$apitoken = $helper->ask($input, $output, $apitokenQuestion);
147
148			$providerConfig->setApiToken($apitoken);
149
150			break;
151			case 'puzzelsms':
152			$config->setProvider($provider);
153
154			/** @var PuzzelSMSConfig $providerConfig */
155			$providerConfig = $config->getProvider()->getConfig();
156
157			$urlQuestion = new Question('Please enter your PuzzelSMS URL: ');
158			$url = $helper->ask($input, $output, $urlQuestion);
159
160			$usernameQuestion = new Question('Please enter your PuzzelSMS username: ');
161			$username = $helper->ask($input, $output, $usernameQuestion);
162
163			$passwordQuestion = new Question('Please enter your PuzzelSMS password: ');
164			$password = $helper->ask($input, $output, $passwordQuestion);
165
166			$serviceQuestion = new Question('Please enter your PuzzelSMS service ID: ');
167			$serviceId = $helper->ask($input, $output, $serviceQuestion);
168
169			$providerConfig->setUrl($url);
170			$providerConfig->setUser($username);
171			$providerConfig->setPassword($password);
172			$providerConfig->setServiceId($serviceId);
173			break;
174
175			default:
176			$output->writeln("Invalid provider $provider");
177			break;
178			}
179
180			}
181
182			private function configureTelegram(InputInterface $input, OutputInterface $output) {
183			$helper = $this->getHelper('question');
184			$tokenQuestion = new Question('Please enter your Telegram bot token: ');
185			$token = $helper->ask($input, $output, $tokenQuestion);
186			$output->writeln("Using $token.");
187
188			/** @var TelegramConfig $config */
189			$config = $this->telegramGateway->getConfig();
190
191			$config->setBotToken($token);
192			}
193
194			}

nextcloud / twofactor_gateway

Pull Request — master (#145)

Configure::configureSms() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like