AsyncClient::getCommandBus() - Code Metrics - Inspection of "Split off streaming methods into streaming clients" - php-api-clients/twitter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Cees-Jan

created 2016-12-08 20:47 UTC

AsyncClient::getCommandBus() A

↳ Parent: AsyncClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php declare(strict_types=1);

namespace ApiClients\Client\Twitter;

use ApiClients\Foundation\Client;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use ApiClients\Foundation\Factory;
use ApiClients\Foundation\Hydrator\CommandBus\Command\HydrateCommand;
use ApiClients\Foundation\Oauth1\Middleware\Oauth1Middleware;
use ApiClients\Foundation\Oauth1\Options as Oauth1Options;
use ApiClients\Foundation\Options;
use ApiClients\Foundation\Transport\CommandBus\Command\RequestCommand;
use ApiClients\Foundation\Transport\CommandBus\Command\StreamingRequestCommand;
use ApiClients\Foundation\Transport\Options as TransportOptions;
use ApiClients\Tools\CommandBus\CommandBus;
use ApiClients\Tools\Psr7\Oauth1\Definition;
use GuzzleHttp\Psr7\Request;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use React\EventLoop\LoopInterface;
use React\Promise\PromiseInterface;
use Rx\Extra\Operator\CutOperator;
use Rx\Observable;
use Rx\React\Promise;
use function React\Promise\resolve;

final class AsyncClient
{
    /**
     * @var string
     */
    private $consumerKey;

    /**
     * @var string
     */
    private $consumerSecret;

    /**
     * @var LoopInterface
     */
    private $loop;

    /**
     * @var Client
     */
    protected $client;

    /**
     * @var AsyncStreamingClient
     */
    protected $streamingClient;

    public function __construct(
        string $consumerKey,
        string $consumerSecret,
        LoopInterface $loop,
        array $options = [],
        Client $client = null
    ) {
        $this->consumerKey = $consumerKey;
        $this->consumerSecret = $consumerSecret;
        $this->loop = $loop;

        if (!($client instanceof Client)) {
            $this->options = ApiSettings::getOptions(
class MyClass { }

$x = new MyClass();
$x->foo = true;
                $consumerKey,
                $consumerSecret,
                'Async',
                $options
            );

            $client = Factory::create($this->loop, $this->options);
        }

        $this->client = $client;
    }

    public function withAccessToken(string $accessToken, string $accessTokenSecret): AsyncClient
    {
        $options = $this->options;
        // @codingStandardsIgnoreStart
        $options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN] = new Definition\AccessToken($accessToken);
        $options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET] = new Definition\TokenSecret($accessTokenSecret);
        // @codingStandardsIgnoreEnd

        return new self(
            $this->consumerKey,
            $this->consumerSecret,
            $this->loop,
            $options
        );
    }

    public function withOutAccessToken(): AsyncClient
    {
        $options = $this->options;
        // @codingStandardsIgnoreStart
        if (isset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN])) {

            unset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN]);
        }
        if (isset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET])) {

            unset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET]);
        }
        // @codingStandardsIgnoreEnd

        return new self(
            $this->consumerKey,
            $this->consumerSecret,
            $this->loop,
            $options
        );
    }

    public function getCommandBus(): CommandBus
    {
        return $this->client->getFromContainer(CommandBus::class);
    }

    public function user(string $user): PromiseInterface
    {
        return $this->client->handle(new RequestCommand(
            new Request('GET', 'users/show.json?screen_name=' . $user)
        ))->then(function (ResponseInterface $response) {
            return resolve($this->client->handle(new HydrateCommand('User', $response->getBody()->getJson())));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        });
    }

    public function stream(): AsyncStreamingClient
    {
        if (!($this->streamingClient instanceof AsyncStreamingClient)) {
            $this->streamingClient = new AsyncStreamingClient($this->client);
        }

        return $this->streamingClient;
    }
}


1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Client\Twitter;
4
5		use ApiClients\Foundation\Client;
		0 ignored issues – show Bug introduced 2016-12-07 22:11 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `ApiClients\Client\Twitter\Client`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6		use ApiClients\Foundation\Factory;
7		use ApiClients\Foundation\Hydrator\CommandBus\Command\HydrateCommand;
8		use ApiClients\Foundation\Oauth1\Middleware\Oauth1Middleware;
9		use ApiClients\Foundation\Oauth1\Options as Oauth1Options;
10		use ApiClients\Foundation\Options;
11		use ApiClients\Foundation\Transport\CommandBus\Command\RequestCommand;
12		use ApiClients\Foundation\Transport\CommandBus\Command\StreamingRequestCommand;
13		use ApiClients\Foundation\Transport\Options as TransportOptions;
14		use ApiClients\Tools\CommandBus\CommandBus;
15		use ApiClients\Tools\Psr7\Oauth1\Definition;
16		use GuzzleHttp\Psr7\Request;
17		use Psr\Http\Message\RequestInterface;
18		use Psr\Http\Message\ResponseInterface;
19		use React\EventLoop\LoopInterface;
20		use React\Promise\PromiseInterface;
21		use Rx\Extra\Operator\CutOperator;
22		use Rx\Observable;
23		use Rx\React\Promise;
24		use function React\Promise\resolve;
25
26		final class AsyncClient
27		{
28		/**
29		* @var string
30		*/
31		private $consumerKey;
32
33		/**
34		* @var string
35		*/
36		private $consumerSecret;
37
38		/**
39		* @var LoopInterface
40		*/
41		private $loop;
42
43		/**
44		* @var Client
45		*/
46		protected $client;
47
48		/**
49		* @var AsyncStreamingClient
50		*/
51		protected $streamingClient;
52
53		public function __construct(
54		string $consumerKey,
55		string $consumerSecret,
56		LoopInterface $loop,
57		array $options = [],
58		Client $client = null
59		) {
60		$this->consumerKey = $consumerKey;
61		$this->consumerSecret = $consumerSecret;
62		$this->loop = $loop;
63
64		if (!($client instanceof Client)) {
65		$this->options = ApiSettings::getOptions(
		0 ignored issues – show Bug introduced 2016-12-07 22:11 UTC by Report Bug Copy Issue Report The property `options` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
66		$consumerKey,
67		$consumerSecret,
68		'Async',
69		$options
70		);
71
72		$client = Factory::create($this->loop, $this->options);
73		}
74
75		$this->client = $client;
76		}
77
78		public function withAccessToken(string $accessToken, string $accessTokenSecret): AsyncClient
79		{
80		$options = $this->options;
81		// @codingStandardsIgnoreStart
82		$options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN] = new Definition\AccessToken($accessToken);
83		$options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET] = new Definition\TokenSecret($accessTokenSecret);
84		// @codingStandardsIgnoreEnd
85
86		return new self(
87		$this->consumerKey,
88		$this->consumerSecret,
89		$this->loop,
90		$options
91		);
92		}
93
94		public function withOutAccessToken(): AsyncClient
95		{
96		$options = $this->options;
97		// @codingStandardsIgnoreStart
98	View Code Duplication	if (isset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN])) {
		0 ignored issues – show Duplication introduced 2016-12-08 20:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
99		unset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN]);
100		}
101	View Code Duplication	if (isset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET])) {
		0 ignored issues – show Duplication introduced 2016-12-08 20:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
102		unset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET]);
103		}
104		// @codingStandardsIgnoreEnd
105
106		return new self(
107		$this->consumerKey,
108		$this->consumerSecret,
109		$this->loop,
110		$options
111		);
112		}
113
114		public function getCommandBus(): CommandBus
115		{
116		return $this->client->getFromContainer(CommandBus::class);
117		}
118
119		public function user(string $user): PromiseInterface
120		{
121		return $this->client->handle(new RequestCommand(
122		new Request('GET', 'users/show.json?screen_name=' . $user)
123		))->then(function (ResponseInterface $response) {
124		return resolve($this->client->handle(new HydrateCommand('User', $response->getBody()->getJson())));
		0 ignored issues – show Bug introduced 2016-12-07 22:11 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\StreamInterface` as the method `getJson()` does only exist in the following implementations of said interface: `ApiClients\Foundation\Transport\JsonStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
125		});
126		}
127
128		public function stream(): AsyncStreamingClient
129		{
130		if (!($this->streamingClient instanceof AsyncStreamingClient)) {
131		$this->streamingClient = new AsyncStreamingClient($this->client);
132		}
133
134		return $this->streamingClient;
135		}
136		}
137

php-api-clients / twitter

GitHub Access Token became invalid

Pull Request — master (#2)

AsyncClient::getCommandBus() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like