ServiceClient::transformResponseToResult() - Code Metrics - Inspection of "add StreamResponse, fix cache, fix catch ex variab..." - indragunawan/rest-service - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 327515...051294 )

by Indra

created 2016-12-20 09:37 UTC

ServiceClient::transformResponseToResult() A

↳ Parent: ServiceClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	3
cp	0
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	3
crap	2

<?php

namespace IndraGunawan\RestService;

use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Command\Command;
use GuzzleHttp\Command\CommandInterface;
use GuzzleHttp\Command\ServiceClientInterface;
use GuzzleHttp\Exception\BadResponseException;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Promise;
use GuzzleHttp\Promise\PromiseInterface;
use IndraGunawan\RestService\Exception\BadRequestException;
use IndraGunawan\RestService\Exception\CommandException;
use IndraGunawan\RestService\Exception\ValidatorException;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * The Guzzle ServiceClient serves as the foundation for creating web service
 * clients that interact with RPC-style APIs.
 */
class ServiceClient implements ServiceClientInterface
{
    /**
     * @var HttpClient HTTP client used to send requests
     */
    private $httpClient;

    /**
     * @var HandlerStack
     */
    private $handlerStack;

    /**
     * @var callable
     */
    private $commandToRequestTransformer;

    /**
     * @var callable
     */
    private $responseToResultTransformer;

    /**
     * @var callable
     */
    private $badResponseExceptionParser;

    /**
     * @param string $specificationFile
     * @param array  $config
     * @param string $cacheDir
     * @param bool   $debug
     *
     * @throws \IndraGunawan\RestService\Exception\InvalidSpecificationException
     */
    public function __construct($specificationFile, array $config = [], $cacheDir = null, $debug = false)
    {
        $this->httpClient = new HttpClient(isset($config['httpClient']) ? $config['httpClient'] : []);
        $this->handlerStack = new HandlerStack();
        $this->handlerStack->setHandler($this->createCommandHandler());

        $service = new Service(
            $specificationFile,
            (isset($config['defaults']) && is_array($config['defaults'])) ? $config['defaults'] : [],
            $cacheDir,
            $debug
        );

        $builder = new Builder($service);

        $this->commandToRequestTransformer = $builder->commandToRequestTransformer();
        $this->responseToResultTransformer = $builder->responseToResultTransformer();
        $this->badResponseExceptionParser = $builder->badResponseExceptionParser();
    }

    public function getHttpClient()
    {
        return $this->httpClient;
    }

    public function getHandlerStack()
    {
        return $this->handlerStack;
    }

    /**
     * {@inheritdoc}
     */
    public function getCommand($name, array $params = [])
    {
        return new Command($name, $params, clone $this->handlerStack);
    }

    /**
     * {@inheritdoc}
     */
    public function execute(CommandInterface $command)
    {
        return $this->executeAsync($command)->wait();
    }

    /**
     * {@inheritdoc}
     */
    public function executeAsync(CommandInterface $command)
    {
        $stack = $command->getHandlerStack() ?: $this->handlerStack;
        $handler = $stack->resolve();

        return $handler($command);
    }

    /**
     * {@inheritdoc}
     */
    public function executeAll($commands, array $options = [])
    {
        // Modify provided callbacks to track results.
        $results = [];
        $options['fulfilled'] = function ($v, $k) use (&$results, $options) {
            if (isset($options['fulfilled'])) {
                $options['fulfilled']($v, $k);
            }
            $results[$k] = $v;
        };
        $options['rejected'] = function ($v, $k) use (&$results, $options) {
            if (isset($options['rejected'])) {
                $options['rejected']($v, $k);
            }
            $results[$k] = $v;
        };

        // Execute multiple commands synchronously, then sort and return the results.
        return $this->executeAllAsync($commands, $options)
            ->then(function () use (&$results) {
                ksort($results);

                return $results;
            })
            ->wait();
    }

    /**
     * {@inheritdoc}
     */
    public function executeAllAsync($commands, array $options = [])
    {
        // Apply default concurrency.
        if (!isset($options['concurrency'])) {
            $options['concurrency'] = 25;
        }

        // Convert the iterator of commands to a generator of promises.
        $commands = Promise\iter_for($commands);
        $promises = function () use ($commands) {
            foreach ($commands as $key => $command) {
                if (!$command instanceof CommandInterface) {
                    throw new \InvalidArgumentException('The iterator must '
                        .'yield instances of '.CommandInterface::class);
                }
                yield $key => $this->executeAsync($command);
            }
        };

        // Execute the commands using a pool.
        return (new Promise\EachPromise($promises(), $options))->promise();
    }

    /**
     * Creates and executes a command for an operation by name.
     *
     * @param string $name Name of the command to execute.
     * @param array  $args Arguments to pass to the getCommand method.
     *
     * @throws \IndraGunawan\RestService\Exception\BadRequestException
     * @throws \IndraGunawan\RestService\Exception\BadResponseException
     * @throws \IndraGunawan\RestService\Exception\CommandException
     *
     * @return ResultInterface|PromiseInterface
     *
     * @see \GuzzleHttp\Command\ServiceClientInterface::getCommand
     */
    public function __call($name, array $args)
    {
        $args = isset($args[0]) ? $args[0] : [];
        if (substr($name, -5) === 'Async') {
            $command = $this->getCommand(substr($name, 0, -5), $args);

            return $this->executeAsync($command);
        } else {
            return $this->execute($this->getCommand($name, $args));
        }
    }

    /**
     * Defines the main handler for commands that uses the HTTP client.
     *
     * @throws \IndraGunawan\RestService\Exception\BadRequestException
     * @throws \IndraGunawan\RestService\Exception\BadResponseException
     * @throws \IndraGunawan\RestService\Exception\CommandException
     *
     * @return callable
     */
    private function createCommandHandler()
    {
        return function (CommandInterface $command) {
            return Promise\coroutine(function () use ($command) {
                // Prepare the HTTP options.
                $opts = $command['@http'] ?: [];

                try {
                    // Prepare the request from the command and send it.
                    $request = $this->transformCommandToRequest($command);
                    $promise = $this->httpClient->sendAsync($request, $opts);

                    // Create a result from the response.
                    $response = (yield $promise);
                    yield $this->transformResponseToResult($response, $request, $command);
                } catch (ValidatorException $e) {
                    throw new BadRequestException($e->getField(), $e->getErrorMessage(), $e);
                } catch (BadResponseException $e) {
                    $this->parseBadResponseException($command, $e);
                } catch (\Exception $e) {
                    throw new CommandException($e->getMessage(), $command, $e);
                }
            });
        };
    }

    /**
     * Transforms a Command object into a Request object.
     *
     * @param CommandInterface $command
     *
     * @return RequestInterface
     */
    private function transformCommandToRequest(CommandInterface $command)
    {
        $transform = $this->commandToRequestTransformer;

        return $transform($command);
    }

    /**
     * Transforms a Response object, also using data from the Request object,
     * into a Result object.
     *
     * @param ResponseInterface $response
     * @param RequestInterface  $request
     *
     * @return ResultInterface
     */
    private function transformResponseToResult(
        ResponseInterface $response,
        RequestInterface $request,
        CommandInterface $command
    ) {
        $transform = $this->responseToResultTransformer;

        return $transform($response, $request, $command);
    }

    /**
     * Parse BadResponseException when retrive response.
     *
     * @param CommandInterface     $command
     * @param BadResponseException $e
     *
     * @throws \IndraGunawan\RestService\Exception\BadResponseException
     */
    private function parseBadResponseException(CommandInterface $command, BadResponseException $e)
    {
        $parser = $this->badResponseExceptionParser;

        $parser($command, $e);
    }
}


1		<?php
2
3		namespace IndraGunawan\RestService;
4
5		use GuzzleHttp\Client as HttpClient;
6		use GuzzleHttp\Command\Command;
7		use GuzzleHttp\Command\CommandInterface;
8		use GuzzleHttp\Command\ServiceClientInterface;
9		use GuzzleHttp\Exception\BadResponseException;
10		use GuzzleHttp\HandlerStack;
11		use GuzzleHttp\Promise;
12		use GuzzleHttp\Promise\PromiseInterface;
13		use IndraGunawan\RestService\Exception\BadRequestException;
14		use IndraGunawan\RestService\Exception\CommandException;
15		use IndraGunawan\RestService\Exception\ValidatorException;
16		use Psr\Http\Message\RequestInterface;
17		use Psr\Http\Message\ResponseInterface;
18
19		/**
20		* The Guzzle ServiceClient serves as the foundation for creating web service
21		* clients that interact with RPC-style APIs.
22		*/
23		class ServiceClient implements ServiceClientInterface
24		{
25		/**
26		* @var HttpClient HTTP client used to send requests
27		*/
28		private $httpClient;
29
30		/**
31		* @var HandlerStack
32		*/
33		private $handlerStack;
34
35		/**
36		* @var callable
37		*/
38		private $commandToRequestTransformer;
39
40		/**
41		* @var callable
42		*/
43		private $responseToResultTransformer;
44
45		/**
46		* @var callable
47		*/
48		private $badResponseExceptionParser;
49
50		/**
51		* @param string $specificationFile
52		* @param array $config
53		* @param string $cacheDir
54		* @param bool $debug
55		*
56		* @throws \IndraGunawan\RestService\Exception\InvalidSpecificationException
57		*/
58	2	public function __construct($specificationFile, array $config = [], $cacheDir = null, $debug = false)
59		{
60	2	$this->httpClient = new HttpClient(isset($config['httpClient']) ? $config['httpClient'] : []);
61	2	$this->handlerStack = new HandlerStack();
62	2	$this->handlerStack->setHandler($this->createCommandHandler());
63
64	2	$service = new Service(
65	2	$specificationFile,
66	2	(isset($config['defaults']) && is_array($config['defaults'])) ? $config['defaults'] : [],
67	2	$cacheDir,
68		$debug
69	2	);
70
71		$builder = new Builder($service);
72
73		$this->commandToRequestTransformer = $builder->commandToRequestTransformer();
74		$this->responseToResultTransformer = $builder->responseToResultTransformer();
75		$this->badResponseExceptionParser = $builder->badResponseExceptionParser();
76		}
77
78		public function getHttpClient()
79		{
80		return $this->httpClient;
81		}
82
83		public function getHandlerStack()
84		{
85		return $this->handlerStack;
86		}
87
88		/**
89		* {@inheritdoc}
90		*/
91		public function getCommand($name, array $params = [])
92		{
93		return new Command($name, $params, clone $this->handlerStack);
94		}
95
96		/**
97		* {@inheritdoc}
98		*/
99		public function execute(CommandInterface $command)
100		{
101		return $this->executeAsync($command)->wait();
102		}
103
104		/**
105		* {@inheritdoc}
106		*/
107		public function executeAsync(CommandInterface $command)
108		{
109		$stack = $command->getHandlerStack() ?: $this->handlerStack;
110		$handler = $stack->resolve();
111
112		return $handler($command);
113		}
114
115		/**
116		* {@inheritdoc}
117		*/
118		public function executeAll($commands, array $options = [])
119		{
120		// Modify provided callbacks to track results.
121		$results = [];
122		$options['fulfilled'] = function ($v, $k) use (&$results, $options) {
123		if (isset($options['fulfilled'])) {
124		$options['fulfilled']($v, $k);
125		}
126		$results[$k] = $v;
127		};
128		$options['rejected'] = function ($v, $k) use (&$results, $options) {
129		if (isset($options['rejected'])) {
130		$options['rejected']($v, $k);
131		}
132		$results[$k] = $v;
133		};
134
135		// Execute multiple commands synchronously, then sort and return the results.
136		return $this->executeAllAsync($commands, $options)
137		->then(function () use (&$results) {
138		ksort($results);
139
140		return $results;
141		})
142		->wait();
143		}
144
145		/**
146		* {@inheritdoc}
147		*/
148		public function executeAllAsync($commands, array $options = [])
149		{
150		// Apply default concurrency.
151		if (!isset($options['concurrency'])) {
152		$options['concurrency'] = 25;
153		}
154
155		// Convert the iterator of commands to a generator of promises.
156		$commands = Promise\iter_for($commands);
157		$promises = function () use ($commands) {
158		foreach ($commands as $key => $command) {
159		if (!$command instanceof CommandInterface) {
160		throw new \InvalidArgumentException('The iterator must '
161		.'yield instances of '.CommandInterface::class);
162		}
163		yield $key => $this->executeAsync($command);
164		}
165		};
166
167		// Execute the commands using a pool.
168		return (new Promise\EachPromise($promises(), $options))->promise();
169		}
170
171		/**
172		* Creates and executes a command for an operation by name.
173		*
174		* @param string $name Name of the command to execute.
175		* @param array $args Arguments to pass to the getCommand method.
176		*
177		* @throws \IndraGunawan\RestService\Exception\BadRequestException
178		* @throws \IndraGunawan\RestService\Exception\BadResponseException
179		* @throws \IndraGunawan\RestService\Exception\CommandException
180		*
181		* @return ResultInterface\|PromiseInterface
182		*
183		* @see \GuzzleHttp\Command\ServiceClientInterface::getCommand
184		*/
185		public function __call($name, array $args)
186		{
187		$args = isset($args[0]) ? $args[0] : [];
188		if (substr($name, -5) === 'Async') {
189		$command = $this->getCommand(substr($name, 0, -5), $args);
190
191		return $this->executeAsync($command);
192		} else {
193		return $this->execute($this->getCommand($name, $args));
194		}
195		}
196
197		/**
198		* Defines the main handler for commands that uses the HTTP client.
199		*
200		* @throws \IndraGunawan\RestService\Exception\BadRequestException
201		* @throws \IndraGunawan\RestService\Exception\BadResponseException
202		* @throws \IndraGunawan\RestService\Exception\CommandException
203		*
204		* @return callable
205		*/
206		private function createCommandHandler()
207		{
208		return function (CommandInterface $command) {
209		return Promise\coroutine(function () use ($command) {
210		// Prepare the HTTP options.
211		$opts = $command['@http'] ?: [];
212
213		try {
214		// Prepare the request from the command and send it.
215		$request = $this->transformCommandToRequest($command);
216		$promise = $this->httpClient->sendAsync($request, $opts);
217
218		// Create a result from the response.
219		$response = (yield $promise);
220		yield $this->transformResponseToResult($response, $request, $command);
221		} catch (ValidatorException $e) {
222		throw new BadRequestException($e->getField(), $e->getErrorMessage(), $e);
223		} catch (BadResponseException $e) {
224		$this->parseBadResponseException($command, $e);
225		} catch (\Exception $e) {
226		throw new CommandException($e->getMessage(), $command, $e);
227		}
228		});
229	2	};
230		}
231
232		/**
233		* Transforms a Command object into a Request object.
234		*
235		* @param CommandInterface $command
236		*
237		* @return RequestInterface
238		*/
239		private function transformCommandToRequest(CommandInterface $command)
240		{
241		$transform = $this->commandToRequestTransformer;
242
243		return $transform($command);
244		}
245
246		/**
247		* Transforms a Response object, also using data from the Request object,
248		* into a Result object.
249		*
250		* @param ResponseInterface $response
251		* @param RequestInterface $request
252		*
253		* @return ResultInterface
254		*/
255		private function transformResponseToResult(
256		ResponseInterface $response,
257		RequestInterface $request,
258		CommandInterface $command
259		) {
260		$transform = $this->responseToResultTransformer;
261
262		return $transform($response, $request, $command);
263		}
264
265		/**
266		* Parse BadResponseException when retrive response.
267		*
268		* @param CommandInterface $command
269		* @param BadResponseException $e
270		*
271		* @throws \IndraGunawan\RestService\Exception\BadResponseException
272		*/
273		private function parseBadResponseException(CommandInterface $command, BadResponseException $e)
274		{
275		$parser = $this->badResponseExceptionParser;
276
277		$parser($command, $e);
278		}
279		}
280

indragunawan / rest-service

Push — master ( 327515...051294 )

ServiceClient::transformResponseToResult() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like