Client::checkCache() - Code Metrics - Inspection of "PSR-7 Middleware" - php-api-clients/transport - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Cees-Jan

created 2016-10-31 20:01 UTC

Client::checkCache() A

↳ Parent: Client

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php declare(strict_types=1);

namespace ApiClients\Foundation\Transport;

use ApiClients\Foundation\Middleware\MiddlewareInterface;
use ApiClients\Foundation\Transport\CommandBus;
use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Psr7\Request as Psr7Request;
use GuzzleHttp\Psr7\Uri;
use Interop\Container\ContainerInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use React\EventLoop\LoopInterface;
use React\EventLoop\Timer\TimerInterface;
use React\Promise\CancellablePromiseInterface;
use React\Promise\PromiseInterface;
use function React\Promise\reject;
use function React\Promise\resolve;
use function WyriHaximus\React\futureFunctionPromise;

class Client
{
    const DEFAULT_OPTIONS = [
        Options::SCHEMA => 'https',
        Options::PATH => '/',
        Options::USER_AGENT => 'WyriHaximus/php-api-client',
        Options::HEADERS => [],
    ];

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

    /**
     * @var ContainerInterface
     */
    protected $container;

    /**
     * @var GuzzleClient
     */
    protected $handler;

    /**
     * @var array
     */
    protected $options = [];

    /**
     * @var MiddlewareInterface[]
     */
    protected $middleware = [];

    /**
     * @param LoopInterface $loop
     * @param ContainerInterface $container
     * @param GuzzleClient $handler
     * @param array $options
     */
    public function __construct(
        LoopInterface $loop,
        ContainerInterface $container,
        GuzzleClient $handler,
        array $options = []
    ) {
        $this->loop = $loop;
        $this->container = $container;
        $this->handler = $handler;
        $this->options = $options + self::DEFAULT_OPTIONS;

        if (isset($this->options[Options::MIDDLEWARE])
        ) {
            $this->middleware = $this->options[Options::MIDDLEWARE];
        }
    }
    protected function preRequest(

        array $middlewares,
        RequestInterface $request,
        array $options
    ): CancellablePromiseInterface {
        $promise = resolve($request);

        foreach ($middlewares as $middleware) {
            $requestMiddleware = $middleware;
            $promise = $promise->then(function (RequestInterface $request) use ($options, $requestMiddleware) {
                return $requestMiddleware->pre($request, $options);
            });
        }

        return $promise;
    }

    protected function postRequest(

        array $middlewares,
        ResponseInterface $response,
        array $options
    ): CancellablePromiseInterface {
        $promise = resolve($response);

        foreach ($middlewares as $middleware) {
            $responseMiddleware = $middleware;
            $promise = $promise->then(function (ResponseInterface $response) use ($options, $responseMiddleware) {
                return $responseMiddleware->post($response, $options);
            });
        }

        return $promise;
    }

    protected function constructMiddlewares(array $options): array
    {
        $set = $this->middleware;

        if (isset($options[Options::MIDDLEWARE])) {
            $set = $options[Options::MIDDLEWARE];
        }

        $middlewares = [];
        foreach ($set as $middleware) {
            if (!is_subclass_of($middleware, MiddlewareInterface::class)) {

                continue;
            }

            $middlewares[] = $this->container->get($middleware);
        }

        return $middlewares;
    }

    /**
     * @param RequestInterface $request
     * @param array $options
     * @return PromiseInterface
     */
    public function request(RequestInterface $request, array $options = []): PromiseInterface
    {
        $request = $this->applyApiSettingsToRequest($request);
        $middlewares = $this->constructMiddlewares($options);

        return $this->preRequest($middlewares, $request, $options)->then(function ($request) use ($options) {
            return resolve($this->handler->sendAsync(
                $request,
                $options
            ));
        }, function (ResponseInterface $response) {
            return resolve($response);
        })->then(function (ResponseInterface $response) use ($middlewares, $options) {
            return $this->postRequest($middlewares, $response, $options);
        });
    }

    protected function streamBody(Response $response)
    {
        $stream = $response->getResponse()->getBody();
        $this->loop->addPeriodicTimer(0.001, function (TimerInterface $timer) use ($stream, $response) {
            if ($stream->eof()) {
                $timer->cancel();
                $response->emit('end');
                return;
            }

            $size = $stream->getSize();
            if ($size === 0) {
                return;
            }

            $response->emit('data', [$stream->read($size)]);
        });
    }

    protected function applyApiSettingsToRequest(RequestInterface $request): RequestInterface
    {
        $uri = $request->getUri();
        if (substr((string)$uri, 0, 4) !== 'http') {
            $uri = Uri::resolve(
                new Uri(
                    $this->options[Options::SCHEMA] .
                    '://' .
                    $this->options[Options::HOST] .
                    $this->options[Options::PATH]
                ),
                $request->getUri()
            );
        }

        return new Psr7Request(
            $request->getMethod(),
            $uri,
            $this->getHeaders() + $request->getHeaders(),
            $request->getBody(),
            $request->getProtocolVersion()
        );
    }

    /**
     * @return array
     */
    public function getHeaders(): array
    {
        $headers = [
            'User-Agent' => $this->options[Options::USER_AGENT],
        ];
        $headers += $this->options[Options::HEADERS];
        return $headers;
    }

    /**
     * @return string
     */
    public function getBaseURL(): string
    {
        return $this->options[Options::SCHEMA] . '://' . $this->options[Options::HOST] . $this->options[Options::PATH];
    }
}


1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Foundation\Transport;
4
5		use ApiClients\Foundation\Middleware\MiddlewareInterface;
6		use ApiClients\Foundation\Transport\CommandBus;
7		use GuzzleHttp\Client as GuzzleClient;
8		use GuzzleHttp\Psr7\Request as Psr7Request;
9		use GuzzleHttp\Psr7\Uri;
10		use Interop\Container\ContainerInterface;
11		use Psr\Http\Message\RequestInterface;
12		use Psr\Http\Message\ResponseInterface;
13		use React\EventLoop\LoopInterface;
14		use React\EventLoop\Timer\TimerInterface;
15		use React\Promise\CancellablePromiseInterface;
16		use React\Promise\PromiseInterface;
17		use function React\Promise\reject;
18		use function React\Promise\resolve;
19		use function WyriHaximus\React\futureFunctionPromise;
20
21		class Client
22		{
23		const DEFAULT_OPTIONS = [
24		Options::SCHEMA => 'https',
25		Options::PATH => '/',
26		Options::USER_AGENT => 'WyriHaximus/php-api-client',
27		Options::HEADERS => [],
28		];
29
30		/**
31		* @var LoopInterface
32		*/
33		protected $loop;
34
35		/**
36		* @var ContainerInterface
37		*/
38		protected $container;
39
40		/**
41		* @var GuzzleClient
42		*/
43		protected $handler;
44
45		/**
46		* @var array
47		*/
48		protected $options = [];
49
50		/**
51		* @var MiddlewareInterface[]
52		*/
53		protected $middleware = [];
54
55		/**
56		* @param LoopInterface $loop
57		* @param ContainerInterface $container
58		* @param GuzzleClient $handler
59		* @param array $options
60		*/
61		public function __construct(
62		LoopInterface $loop,
63		ContainerInterface $container,
64		GuzzleClient $handler,
65		array $options = []
66		) {
67		$this->loop = $loop;
68		$this->container = $container;
69		$this->handler = $handler;
70		$this->options = $options + self::DEFAULT_OPTIONS;
71
72		if (isset($this->options[Options::MIDDLEWARE])
73		) {
74		$this->middleware = $this->options[Options::MIDDLEWARE];
75		}
76		}
77	View Code Duplication	protected function preRequest(
		0 ignored issues – show Duplication introduced 2016-10-26 19:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
78		array $middlewares,
79		RequestInterface $request,
80		array $options
81		): CancellablePromiseInterface {
82		$promise = resolve($request);
83
84		foreach ($middlewares as $middleware) {
85		$requestMiddleware = $middleware;
86		$promise = $promise->then(function (RequestInterface $request) use ($options, $requestMiddleware) {
87		return $requestMiddleware->pre($request, $options);
88		});
89		}
90
91		return $promise;
92		}
93
94	View Code Duplication	protected function postRequest(
		0 ignored issues – show Duplication introduced 2016-10-26 19:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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		array $middlewares,
96		ResponseInterface $response,
97		array $options
98		): CancellablePromiseInterface {
99		$promise = resolve($response);
100
101		foreach ($middlewares as $middleware) {
102		$responseMiddleware = $middleware;
103		$promise = $promise->then(function (ResponseInterface $response) use ($options, $responseMiddleware) {
104		return $responseMiddleware->post($response, $options);
105		});
106		}
107
108		return $promise;
109		}
110
111		protected function constructMiddlewares(array $options): array
112		{
113		$set = $this->middleware;
114
115		if (isset($options[Options::MIDDLEWARE])) {
116		$set = $options[Options::MIDDLEWARE];
117		}
118
119		$middlewares = [];
120		foreach ($set as $middleware) {
121		if (!is_subclass_of($middleware, MiddlewareInterface::class)) {
		0 ignored issues – show Bug introduced 2016-10-26 19:12 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\ApiClients\Foundation\M...dlewareInterface::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
122		continue;
123		}
124
125		$middlewares[] = $this->container->get($middleware);
126		}
127
128		return $middlewares;
129		}
130
131		/**
132		* @param RequestInterface $request
133		* @param array $options
134		* @return PromiseInterface
135		*/
136		public function request(RequestInterface $request, array $options = []): PromiseInterface
137		{
138		$request = $this->applyApiSettingsToRequest($request);
139		$middlewares = $this->constructMiddlewares($options);
140
141		return $this->preRequest($middlewares, $request, $options)->then(function ($request) use ($options) {
142		return resolve($this->handler->sendAsync(
143		$request,
144		$options
145		));
146		}, function (ResponseInterface $response) {
147		return resolve($response);
148		})->then(function (ResponseInterface $response) use ($middlewares, $options) {
149		return $this->postRequest($middlewares, $response, $options);
150		});
151		}
152
153		protected function streamBody(Response $response)
154		{
155		$stream = $response->getResponse()->getBody();
156		$this->loop->addPeriodicTimer(0.001, function (TimerInterface $timer) use ($stream, $response) {
157		if ($stream->eof()) {
158		$timer->cancel();
159		$response->emit('end');
160		return;
161		}
162
163		$size = $stream->getSize();
164		if ($size === 0) {
165		return;
166		}
167
168		$response->emit('data', [$stream->read($size)]);
169		});
170		}
171
172		protected function applyApiSettingsToRequest(RequestInterface $request): RequestInterface
173		{
174		$uri = $request->getUri();
175		if (substr((string)$uri, 0, 4) !== 'http') {
176		$uri = Uri::resolve(
177		new Uri(
178		$this->options[Options::SCHEMA] .
179		'://' .
180		$this->options[Options::HOST] .
181		$this->options[Options::PATH]
182		),
183		$request->getUri()
184		);
185		}
186
187		return new Psr7Request(
188		$request->getMethod(),
189		$uri,
190		$this->getHeaders() + $request->getHeaders(),
191		$request->getBody(),
192		$request->getProtocolVersion()
193		);
194		}
195
196		/**
197		* @return array
198		*/
199		public function getHeaders(): array
200		{
201		$headers = [
202		'User-Agent' => $this->options[Options::USER_AGENT],
203		];
204		$headers += $this->options[Options::HEADERS];
205		return $headers;
206		}
207
208		/**
209		* @return string
210		*/
211		public function getBaseURL(): string
212		{
213		return $this->options[Options::SCHEMA] . '://' . $this->options[Options::HOST] . $this->options[Options::PATH];
214		}
215		}
216

php-api-clients / transport

GitHub Access Token became invalid

Pull Request — master (#2)

Client::checkCache() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like