AsyncClient::withAccessToken() - Code Metrics - Inspection of "Merge pull request #3 from php-api-clients/feature..." - php-api-clients/twitter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5c8d92...5e68ac )

by Cees-Jan

created 2016-12-09 21:33 UTC

AsyncClient::withAccessToken() A

↳ Parent: AsyncClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	9
nc	1
nop	2

<?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\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
{
    const STREAM_DELIMITER = "\r\n";

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

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

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

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

    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 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 sampleStream(): Observable
    {
        return $this->stream(
            new Request('GET', 'https://stream.twitter.com/1.1/statuses/sample.json')
        );
    }

    public function filteredStream(array $filter = []): Observable
    {
        $postData = http_build_query($filter);
        return $this->stream(
            new Request(
                'POST',
                'https://stream.twitter.com/1.1/statuses/filter.json',
                [
                    'Content-Type' =>  'application/x-www-form-urlencoded',
                    'Content-Length' => strlen($postData),
                ],
                $postData
            )
        );
    }

    protected function stream(RequestInterface $request): Observable
    {
        return Promise::toObservable($this->client->handle(new StreamingRequestCommand(
            $request
        )))->switchLatest()->lift(function () {
            return new CutOperator(self::STREAM_DELIMITER);
        })->filter(function (string $json) {
            return trim($json) !== ''; // To keep the stream alive Twitter sends an empty line at times
        })->jsonDecode()->flatMap(function (array $document) {
            if (isset($document['delete'])) {
                return Promise::toObservable($this->client->handle(
                    new HydrateCommand('DeletedTweet', $document['delete'])
                ));
            }

            return Promise::toObservable($this->client->handle(new HydrateCommand('Tweet', $document)));
        });
    }
}


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\Psr7\Oauth1\Definition;
15		use GuzzleHttp\Psr7\Request;
16		use Psr\Http\Message\RequestInterface;
17		use Psr\Http\Message\ResponseInterface;
18		use React\EventLoop\LoopInterface;
19		use React\Promise\PromiseInterface;
20		use Rx\Extra\Operator\CutOperator;
21		use Rx\Observable;
22		use Rx\React\Promise;
23		use function React\Promise\resolve;
24
25		final class AsyncClient
26		{
27		const STREAM_DELIMITER = "\r\n";
28
29		/**
30		* @var string
31		*/
32		private $consumerKey;
33
34		/**
35		* @var string
36		*/
37		private $consumerSecret;
38
39		/**
40		* @var LoopInterface
41		*/
42		private $loop;
43
44		/**
45		* @var Client
46		*/
47		protected $client;
48
49		public function __construct(
50		string $consumerKey,
51		string $consumerSecret,
52		LoopInterface $loop,
53		array $options = [],
54		Client $client = null
55		) {
56		$this->consumerKey = $consumerKey;
57		$this->consumerSecret = $consumerSecret;
58		$this->loop = $loop;
59
60		if (!($client instanceof Client)) {
61		$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...
62		$consumerKey,
63		$consumerSecret,
64		'Async',
65		$options
66		);
67
68		$client = Factory::create($this->loop, $this->options);
69		}
70
71		$this->client = $client;
72		}
73
74		public function withAccessToken(string $accessToken, string $accessTokenSecret): AsyncClient
75		{
76		$options = $this->options;
77		// @codingStandardsIgnoreStart
78		$options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN] = new Definition\AccessToken($accessToken);
79		$options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET] = new Definition\TokenSecret($accessTokenSecret);
80		// @codingStandardsIgnoreEnd
81
82		return new self(
83		$this->consumerKey,
84		$this->consumerSecret,
85		$this->loop,
86		$options
87		);
88		}
89
90		public function withOutAccessToken(): AsyncClient
91		{
92		$options = $this->options;
93		// @codingStandardsIgnoreStart
94	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...
95		unset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::ACCESS_TOKEN]);
96		}
97	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...
98		unset($options[Options::TRANSPORT_OPTIONS][TransportOptions::DEFAULT_REQUEST_OPTIONS][Oauth1Middleware::class][Oauth1Options::TOKEN_SECRET]);
99		}
100		// @codingStandardsIgnoreEnd
101
102		return new self(
103		$this->consumerKey,
104		$this->consumerSecret,
105		$this->loop,
106		$options
107		);
108		}
109
110		public function user(string $user): PromiseInterface
111		{
112		return $this->client->handle(new RequestCommand(
113		new Request('GET', 'users/show.json?screen_name=' . $user)
114		))->then(function (ResponseInterface $response) {
115		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...
116		});
117		}
118
119		public function sampleStream(): Observable
120		{
121		return $this->stream(
122		new Request('GET', 'https://stream.twitter.com/1.1/statuses/sample.json')
123		);
124		}
125
126		public function filteredStream(array $filter = []): Observable
127		{
128		$postData = http_build_query($filter);
129		return $this->stream(
130		new Request(
131		'POST',
132		'https://stream.twitter.com/1.1/statuses/filter.json',
133		[
134		'Content-Type' => 'application/x-www-form-urlencoded',
135		'Content-Length' => strlen($postData),
136		],
137		$postData
138		)
139		);
140		}
141
142		protected function stream(RequestInterface $request): Observable
143		{
144		return Promise::toObservable($this->client->handle(new StreamingRequestCommand(
145		$request
146		)))->switchLatest()->lift(function () {
147		return new CutOperator(self::STREAM_DELIMITER);
148		})->filter(function (string $json) {
149		return trim($json) !== ''; // To keep the stream alive Twitter sends an empty line at times
150		})->jsonDecode()->flatMap(function (array $document) {
151		if (isset($document['delete'])) {
152		return Promise::toObservable($this->client->handle(
153		new HydrateCommand('DeletedTweet', $document['delete'])
154		));
155		}
156
157		return Promise::toObservable($this->client->handle(new HydrateCommand('Tweet', $document)));
158		});
159		}
160		}
161

php-api-clients / twitter

GitHub Access Token became invalid

Push — master ( 5c8d92...5e68ac )

AsyncClient::withAccessToken() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like