AuthNegotiation::negotiate() - Code Metrics - Inspection of "Implement imap client" - genkgo/mail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

by Frederik

created 2018-03-01 09:56 UTC

AuthNegotiation::negotiate() B

↳ Parent: AuthNegotiation

Complexity

Conditions	6
Paths	5

Size

Total Lines	52
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	52
rs	8.6868
c	0
b	0
f	0
cc	6
eloc	34
nc	5
nop	1

How to fix Long Method

<?php
declare(strict_types=1);

namespace Genkgo\Mail\Protocol\Imap\Negotiation;

use Genkgo\Mail\Exception\ImapAuthenticationException;
use Genkgo\Mail\Protocol\Imap\Client;
use Genkgo\Mail\Protocol\Imap\NegotiationInterface;
use Genkgo\Mail\Protocol\Imap\Request\AuthPlainCommand;
use Genkgo\Mail\Protocol\Imap\Request\AuthPlainCredentialsRequest;
use Genkgo\Mail\Protocol\Imap\Request\CapabilityCommand;
use Genkgo\Mail\Protocol\Imap\Response\Command\CapabilityCommandResponse;
use Genkgo\Mail\Protocol\Imap\Response\CompletionResult;

final class AuthNegotiation implements NegotiationInterface
{
    /**
     * @var int
     */
    private $method;
    /**
     * @var string
     */
    private $username;
    /**
     * @var string
     */
    private $password;

    /**
     * AuthNegotiation constructor.
     * @param int $method
     * @param string $username
     * @param string $password
     */
    public function __construct(int $method, string $username, string $password)
    {
        $this->method = $method;
        $this->username = $username;
        $this->password = $password;
    }

    /**
     * @param Client $client
     * @throws ImapAuthenticationException
     */
    public function negotiate(Client $client): void
    {
        $method = $this->method;
        if ($method === Client::AUTH_AUTO) {
            $responseList = $client->emit(new CapabilityCommand($client->newTag()));

            $capabilities = CapabilityCommandResponse::fromResponse($responseList->first());

            $responseList
                ->last()
                ->assertCompletion(CompletionResult::ok())
                ->assertTagged();

            $options = [
                'AUTH=PLAIN' => Client::AUTH_PLAIN,
            ];

            foreach ($options as $capability => $auth) {
                if ($capabilities->isAdvertising($capability)) {
                    $method = $auth;
                }
            }

            if ($method === Client::AUTH_AUTO) {
                throw new ImapAuthenticationException(
                    'IMAP server does not advertise one the supported AUTH methods (AUTH PLAIN)'
                );
            }
        }

        switch ($method) {
            case Client::AUTH_PLAIN:
                $tag = $client->newTag();
                $client
                    ->emit(new AuthPlainCommand($tag))
                    ->first()
                    ->assertContinuation();

                $client
                    ->emit(
                        new AuthPlainCredentialsRequest(
                            $tag,
                            $this->username,
                            $this->password
                        )
                    )
                    ->last()
                    ->assertCompletion(CompletionResult::ok())
                    ->assertTagged();
                break;
        }
    }
}

1			<?php
2			declare(strict_types=1);
3
4			namespace Genkgo\Mail\Protocol\Imap\Negotiation;
5
6			use Genkgo\Mail\Exception\ImapAuthenticationException;
7			use Genkgo\Mail\Protocol\Imap\Client;
8			use Genkgo\Mail\Protocol\Imap\NegotiationInterface;
9			use Genkgo\Mail\Protocol\Imap\Request\AuthPlainCommand;
10			use Genkgo\Mail\Protocol\Imap\Request\AuthPlainCredentialsRequest;
11			use Genkgo\Mail\Protocol\Imap\Request\CapabilityCommand;
12			use Genkgo\Mail\Protocol\Imap\Response\Command\CapabilityCommandResponse;
13			use Genkgo\Mail\Protocol\Imap\Response\CompletionResult;
14
15			final class AuthNegotiation implements NegotiationInterface
16			{
17			/**
18			* @var int
19			*/
20			private $method;
21			/**
22			* @var string
23			*/
24			private $username;
25			/**
26			* @var string
27			*/
28			private $password;
29
30			/**
31			* AuthNegotiation constructor.
32			* @param int $method
33			* @param string $username
34			* @param string $password
35			*/
36			public function __construct(int $method, string $username, string $password)
37			{
38			$this->method = $method;
39			$this->username = $username;
40			$this->password = $password;
41			}
42
43			/**
44			* @param Client $client
45			* @throws ImapAuthenticationException
46			*/
47			public function negotiate(Client $client): void
48			{
49			$method = $this->method;
50			if ($method === Client::AUTH_AUTO) {
51			$responseList = $client->emit(new CapabilityCommand($client->newTag()));
52
53			$capabilities = CapabilityCommandResponse::fromResponse($responseList->first());
54
55			$responseList
56			->last()
57			->assertCompletion(CompletionResult::ok())
58			->assertTagged();
59
60			$options = [
61			'AUTH=PLAIN' => Client::AUTH_PLAIN,
62			];
63
64			foreach ($options as $capability => $auth) {
65			if ($capabilities->isAdvertising($capability)) {
66			$method = $auth;
67			}
68			}
69
70			if ($method === Client::AUTH_AUTO) {
71			throw new ImapAuthenticationException(
72			'IMAP server does not advertise one the supported AUTH methods (AUTH PLAIN)'
73			);
74			}
75			}
76
77			switch ($method) {
78			case Client::AUTH_PLAIN:
79			$tag = $client->newTag();
80			$client
81			->emit(new AuthPlainCommand($tag))
82			->first()
83			->assertContinuation();
84
85			$client
86			->emit(
87			new AuthPlainCredentialsRequest(
88			$tag,
89			$this->username,
90			$this->password
91			)
92			)
93			->last()
94			->assertCompletion(CompletionResult::ok())
95			->assertTagged();
96			break;
97			}
98			}
99			}

genkgo / mail

Pull Request — master (#42)

AuthNegotiation::negotiate() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like