Guzzle6Adapter::setCorrelationIdProvider() - Code Metrics - Inspection of "Merge pull request #334 from commercetools/token_p..." - commercetools/commercetools-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 166b0f...9fc299 )

by Jens

created 2017-08-08 11:09 UTC

Guzzle6Adapter::setCorrelationIdProvider() A

↳ Parent: Guzzle6Adapter

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php
/**
 * @author @jayS-de <[email protected]>
 */

namespace Commercetools\Core\Client\Adapter;

use Commercetools\Core\Client\OAuth\TokenProvider;
use Commercetools\Core\Helper\CorrelationIdProvider;
use Commercetools\Core\Response\AbstractApiResponse;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\MessageFormatter;
use GuzzleHttp\Middleware;
use GuzzleHttp\Pool;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
use Commercetools\Core\Error\Message;
use Commercetools\Core\Error\ApiException;
use Psr\Log\LogLevel;

class Guzzle6Adapter implements AdapterInterface, CorrelationIdAware, TokenProviderAware
{
    /**
     * @var Client
     */
    protected $client;

    protected $logger;

    public function __construct(array $options = [])
    {
        $options = array_merge(
            [
                'allow_redirects' => false,
                'verify' => true,
                'timeout' => 60,
                'connect_timeout' => 10,
                'pool_size' => 25
            ],
            $options
        );
        $this->client = new Client($options);
    }

    public function setLogger(LoggerInterface $logger, $logLevel = LogLevel::INFO, $formatter = null)
    {
        if (is_null($formatter)) {
            $formatter = new MessageFormatter();
        }
        $this->logger = $logger;
        $this->addHandler(self::log($logger, $formatter, $logLevel));
    }

    public function setCorrelationIdProvider(CorrelationIdProvider $provider)
    {
        $this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($provider) {
            return $request->withAddedHeader(
                AbstractApiResponse::X_CORRELATION_ID,
                $provider->getCorrelationId()
            );
        }));
    }

    public function setOAuthTokenProvider(TokenProvider $tokenProvider)
    {
        $this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($tokenProvider) {
            return $request->withAddedHeader(
                'Authorization',
                'Bearer ' . $tokenProvider->getToken()->getToken()
            );
        }));
    }

    /**
     * Middleware that logs requests, responses, and errors using a message
     * formatter.
     *
     * @param LoggerInterface  $logger Logs messages.
     * @param MessageFormatter $formatter Formatter used to create message strings.
     * @param string           $logLevel Level at which to log requests.
     *
     * @return callable Returns a function that accepts the next handler.
     */
    private static function log(LoggerInterface $logger, MessageFormatter $formatter, $logLevel = LogLevel::INFO)
    {
        return function (callable $handler) use ($logger, $formatter, $logLevel) {
            return function ($request, array $options) use ($handler, $logger, $formatter, $logLevel) {
                return $handler($request, $options)->then(
                    function ($response) use ($logger, $request, $formatter, $logLevel) {
                        $message = $formatter->format($request, $response);
                        $context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                            AbstractApiResponse::X_CORRELATION_ID
                        );
                        $logger->log($logLevel, $message, $context);
                        return $response;
                    },
                    function ($reason) use ($logger, $request, $formatter) {
                        $response = null;
                        $context = [];
                        if ($reason instanceof RequestException) {
                            $response = $reason->getResponse();
                            if (!is_null($response)) {
                                $context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
                                    AbstractApiResponse::X_CORRELATION_ID
                                );
                            }
                        }
                        $message = $formatter->format($request, $response, $reason);
                        $logger->notice($message, $context);
                        return \GuzzleHttp\Promise\rejection_for($reason);
                    }
                );
            };
        };
    }

    public function addHandler($handler)
    {
        $this->client->getConfig('handler')->push($handler);
    }

    /**
     * @param RequestInterface $request
     * @return ResponseInterface
     */
    public function execute(RequestInterface $request)
    {
        try {
            $response = $this->client->send($request);
        } catch (RequestException $exception) {
            $response = $exception->getResponse();
            throw ApiException::create($request, $response, $exception);
        }

        return $response;
    }

    /**
     * @param RequestInterface[] $requests
     * @return ResponseInterface[]
     */
    public function executeBatch(array $requests)
    {
        $results = Pool::batch(
            $this->client,
            $requests
        );

        $responses = [];
        foreach ($results as $key => $result) {
            $httpResponse = $result;
            if ($result instanceof RequestException) {

                $request = $requests[$key];
                $httpResponse = $result->getResponse();
                $httpResponse = ApiException::create($request, $httpResponse, $result);
            }
            $responses[$key] = $httpResponse;
        }

        return $responses;
    }

    /**
     * @param $oauthUri
     * @param $clientId
     * @param $clientSecret
     * @param $formParams
     * @return ResponseInterface
     */
    public function authenticate($oauthUri, $clientId, $clientSecret, $formParams)
    {
        $options = [
            'form_params' => $formParams,
            'auth' => [$clientId, $clientSecret]
        ];

        try {
            $response = $this->client->post($oauthUri, $options);
        } catch (RequestException $exception) {
            throw ApiException::create($exception->getRequest(), $exception->getResponse(), $exception);
        }
        return $response;
    }

    /**
     * @param RequestInterface $request
     * @return AdapterPromiseInterface
     */
    public function executeAsync(RequestInterface $request)
    {
        $guzzlePromise = $this->client->sendAsync($request);

        return new Guzzle6Promise($guzzlePromise);
    }

    public static function getAdapterInfo()
    {
        return 'GuzzleHttp/' . Client::VERSION;
    }
}


1			<?php
2			/**
3			* @author @jayS-de <[email protected]>
4			*/
5
6			namespace Commercetools\Core\Client\Adapter;
7
8			use Commercetools\Core\Client\OAuth\TokenProvider;
9			use Commercetools\Core\Helper\CorrelationIdProvider;
10			use Commercetools\Core\Response\AbstractApiResponse;
11			use GuzzleHttp\Client;
12			use GuzzleHttp\Exception\RequestException;
13			use GuzzleHttp\MessageFormatter;
14			use GuzzleHttp\Middleware;
15			use GuzzleHttp\Pool;
16			use GuzzleHttp\Promise\PromiseInterface;
17			use Psr\Http\Message\RequestInterface;
18			use Psr\Http\Message\ResponseInterface;
19			use Psr\Log\LoggerInterface;
20			use Commercetools\Core\Error\Message;
21			use Commercetools\Core\Error\ApiException;
22			use Psr\Log\LogLevel;
23
24			class Guzzle6Adapter implements AdapterInterface, CorrelationIdAware, TokenProviderAware
25			{
26			/**
27			* @var Client
28			*/
29			protected $client;
30
31			protected $logger;
32
33	111		public function __construct(array $options = [])
34			{
35	111		$options = array_merge(
36			[
37	111		'allow_redirects' => false,
38			'verify' => true,
39			'timeout' => 60,
40			'connect_timeout' => 10,
41			'pool_size' => 25
42			],
43	111		$options
44			);
45	111		$this->client = new Client($options);
46	111		}
47
48	44		public function setLogger(LoggerInterface $logger, $logLevel = LogLevel::INFO, $formatter = null)
49			{
50	44		if (is_null($formatter)) {
51	44		$formatter = new MessageFormatter();
52			}
53	44		$this->logger = $logger;
54	44		$this->addHandler(self::log($logger, $formatter, $logLevel));
55	44		}
56
57			public function setCorrelationIdProvider(CorrelationIdProvider $provider)
58			{
59	474		$this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($provider) {
60	474		return $request->withAddedHeader(
61	474		AbstractApiResponse::X_CORRELATION_ID,
62	474		$provider->getCorrelationId()
63			);
64	39		}));
65	39		}
66
67			public function setOAuthTokenProvider(TokenProvider $tokenProvider)
68			{
69	496		$this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($tokenProvider) {
70	496		return $request->withAddedHeader(
71	496		'Authorization',
72	496		'Bearer ' . $tokenProvider->getToken()->getToken()
73			);
74	58		}));
75	58		}
76
77			/**
78			* Middleware that logs requests, responses, and errors using a message
79			* formatter.
80			*
81			* @param LoggerInterface $logger Logs messages.
82			* @param MessageFormatter $formatter Formatter used to create message strings.
83			* @param string $logLevel Level at which to log requests.
84			*
85			* @return callable Returns a function that accepts the next handler.
86			*/
87			private static function log(LoggerInterface $logger, MessageFormatter $formatter, $logLevel = LogLevel::INFO)
88			{
89			return function (callable $handler) use ($logger, $formatter, $logLevel) {
90	480		return function ($request, array $options) use ($handler, $logger, $formatter, $logLevel) {
91	480		return $handler($request, $options)->then(
92	480		function ($response) use ($logger, $request, $formatter, $logLevel) {
93	480		$message = $formatter->format($request, $response);
94	480		$context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-09-26 12:42 UTC by Report Bug Copy Issue Report `$context` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$context = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
95	480		AbstractApiResponse::X_CORRELATION_ID
96			);
97	480		$logger->log($logLevel, $message, $context);
98	480		return $response;
99	480		},
100	480		function ($reason) use ($logger, $request, $formatter) {
101			$response = null;
102			$context = [];
103			if ($reason instanceof RequestException) {
104			$response = $reason->getResponse();
105			if (!is_null($response)) {
106			$context[AbstractApiResponse::X_CORRELATION_ID] = $response->getHeader(
107			AbstractApiResponse::X_CORRELATION_ID
108			);
109			}
110			}
111			$message = $formatter->format($request, $response, $reason);
112			$logger->notice($message, $context);
113			return \GuzzleHttp\Promise\rejection_for($reason);
114	480		}
115			);
116	39		};
117	44		};
118			}
119
120	65		public function addHandler($handler)
121			{
122	65		$this->client->getConfig('handler')->push($handler);
123	65		}
124
125			/**
126			* @param RequestInterface $request
127			* @return ResponseInterface
128			*/
129	524		public function execute(RequestInterface $request)
130			{
131			try {
132	524		$response = $this->client->send($request);
133	111		} catch (RequestException $exception) {
134	111		$response = $exception->getResponse();
135	111		throw ApiException::create($request, $response, $exception);
136			}
137
138	498		return $response;
139			}
140
141			/**
142			* @param RequestInterface[] $requests
143			* @return ResponseInterface[]
144			*/
145	402		public function executeBatch(array $requests)
146			{
147	402		$results = Pool::batch(
148	402		$this->client,
149	402		$requests
150			);
151
152	402		$responses = [];
153	402		foreach ($results as $key => $result) {
154	402		$httpResponse = $result;
155	402	View Code Duplication	if ($result instanceof RequestException) {
			0 ignored issues – show Duplication introduced 2015-12-07 15:55 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...
156	16		$request = $requests[$key];
157	16		$httpResponse = $result->getResponse();
158	16		$httpResponse = ApiException::create($request, $httpResponse, $result);
159			}
160	402		$responses[$key] = $httpResponse;
161			}
162
163	402		return $responses;
164			}
165
166			/**
167			* @param $oauthUri
168			* @param $clientId
169			* @param $clientSecret
170			* @param $formParams
171			* @return ResponseInterface
172			*/
173	45		public function authenticate($oauthUri, $clientId, $clientSecret, $formParams)
174			{
175			$options = [
176	45		'form_params' => $formParams,
177	45		'auth' => [$clientId, $clientSecret]
178			];
179
180			try {
181	45		$response = $this->client->post($oauthUri, $options);
182	3		} catch (RequestException $exception) {
183	3		throw ApiException::create($exception->getRequest(), $exception->getResponse(), $exception);
184			}
185	44		return $response;
186			}
187
188			/**
189			* @param RequestInterface $request
190			* @return AdapterPromiseInterface
191			*/
192	4		public function executeAsync(RequestInterface $request)
193			{
194	4		$guzzlePromise = $this->client->sendAsync($request);
195
196	4		return new Guzzle6Promise($guzzlePromise);
197			}
198
199	74		public static function getAdapterInfo()
200			{
201	74		return 'GuzzleHttp/' . Client::VERSION;
202			}
203			}
204

commercetools / commercetools-php-sdk

Push — develop ( 166b0f...9fc299 )

Guzzle6Adapter::setCorrelationIdProvider() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like