GuzzleAdapter::__construct() - Code Metrics - Inspection of "Unify adapter exception handling" - toin0u/DigitalOceanV2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — exceptions ( 2454be...fb5172 )

by Graham

created 2015-12-22 22:41 UTC

GuzzleAdapter::__construct() A

↳ Parent: GuzzleAdapter

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	2	Features	0

Metric	Value
c	4
b	2
f	0
dl	0
loc	6
rs	9.4286
cc	2
eloc	3
nc	2
nop	2

<?php

/*
 * This file is part of the DigitalOceanV2 library.
 *
 * (c) Antoine Corcy <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DigitalOceanV2\Adapter;

use DigitalOceanV2\Exception\HttpException;
use Guzzle\Http\Client;
use Guzzle\Http\ClientInterface;
use Guzzle\Http\Exception\RequestException;
use Guzzle\Http\Message\Response;

/**
 * @author Liverbool <[email protected]>
 * @author Graham Campbell <[email protected]>
 */
class GuzzleAdapter implements AdapterInterface
{
    /**
     * @var ClientInterface
     */
    protected $client;

    /**
     * @var Response
     */
    protected $response;

    /**
     * @param string               $token
     * @param ClientInterface|null $client
     */
    public function __construct($token, ClientInterface $client = null)
    {
        $this->client = $client ?: new Client();

        $this->client->setDefaultOption('headers/Authorization', sprintf('Bearer %s', $token));
    }

    /**
     * {@inheritdoc}
     */
    public function get($url)
    {
        try {
            $this->response = $this->client->get($url)->send();
        } catch (RequestException $e) {
            $this->response = $e->getResponse();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->handleError();
        }

        return $this->response->getBody(true);
    }

    /**
     * {@inheritdoc}
     */
    public function delete($url)
    {
        try {
            $this->response = $this->client->delete($url)->send();
        } catch (RequestException $e) {
            $this->response = $e->getResponse();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->handleError();
        }

        return $this->response->getBody(true);
    }

    /**
     * {@inheritdoc}
     */
    public function put($url, $content = '')
    {
        $request = $this->client->put($url);

        if (is_array($content)) {
            $request->setBody(json_encode($content), 'application/json');
        } else {
            $request->setBody($content);
        }

        try {
            $this->response = $request->send();
        } catch (RequestException $e) {
            $this->response = $e->getResponse();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->handleError();
        }

        return $this->response->getBody(true);
    }

    /**
     * {@inheritdoc}
     */
    public function post($url, $content = '')
    {
        $request = $this->client->post($url);

        if (is_array($content)) {
            $request->setBody(json_encode($content), 'application/json');
        } else {
            $request->setBody($content);
        }

        try {
            $this->response = $request->send();
        } catch (RequestException $e) {
            $this->response = $e->getResponse();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $this->handleError();
        }

        return $this->response->getBody(true);
    }

    /**
     * {@inheritdoc}
     */
    public function getLatestResponseHeaders()
    {
        if (null === $this->response) {
            return;
        }

        return [
            'reset' => (int) (string) $this->response->getHeader('RateLimit-Reset'),
            'remaining' => (int) (string) $this->response->getHeader('RateLimit-Remaining'),
            'limit' => (int) (string) $this->response->getHeader('RateLimit-Limit'),
        ];
    }

    /**
     * @throws HttpException
     */
    protected function handleError()
    {
        $body = (string) $this->response->getBody(true);
        $code = (int) $this->response->getStatusCode();

        $content = json_decode($body);

        throw new HttpException(isset($content->message) ? $content->message : 'Request not processed.', $code);
    }
}


1			<?php
2
3			/*
4			* This file is part of the DigitalOceanV2 library.
5			*
6			* (c) Antoine Corcy <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace DigitalOceanV2\Adapter;
13
14			use DigitalOceanV2\Exception\HttpException;
15			use Guzzle\Http\Client;
16			use Guzzle\Http\ClientInterface;
17			use Guzzle\Http\Exception\RequestException;
18			use Guzzle\Http\Message\Response;
19
20			/**
21			* @author Liverbool <[email protected]>
22			* @author Graham Campbell <[email protected]>
23			*/
24			class GuzzleAdapter implements AdapterInterface
25			{
26			/**
27			* @var ClientInterface
28			*/
29			protected $client;
30
31			/**
32			* @var Response
33			*/
34			protected $response;
35
36			/**
37			* @param string $token
38			* @param ClientInterface\|null $client
39			*/
40			public function __construct($token, ClientInterface $client = null)
41			{
42			$this->client = $client ?: new Client();
43
44			$this->client->setDefaultOption('headers/Authorization', sprintf('Bearer %s', $token));
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50			public function get($url)
51			{
52			try {
53			$this->response = $this->client->get($url)->send();
54			} catch (RequestException $e) {
55			$this->response = $e->getResponse();
			0 ignored issues – show Bug introduced 2015-12-23 12:43 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Guzzle\Http\Exception\RequestException` as the method `getResponse()` does only exist in the following sub-classes of `Guzzle\Http\Exception\RequestException`: `Guzzle\Http\Exception\BadResponseException`, `Guzzle\Http\Exception\ClientErrorResponseException`, `Guzzle\Http\Exception\ServerErrorResponseException`, `Guzzle\Http\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
56			$this->handleError();
57			}
58
59			return $this->response->getBody(true);
60			}
61
62			/**
63			* {@inheritdoc}
64			*/
65			public function delete($url)
66			{
67			try {
68			$this->response = $this->client->delete($url)->send();
69			} catch (RequestException $e) {
70			$this->response = $e->getResponse();
			0 ignored issues – show Bug introduced 2015-12-23 12:43 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Guzzle\Http\Exception\RequestException` as the method `getResponse()` does only exist in the following sub-classes of `Guzzle\Http\Exception\RequestException`: `Guzzle\Http\Exception\BadResponseException`, `Guzzle\Http\Exception\ClientErrorResponseException`, `Guzzle\Http\Exception\ServerErrorResponseException`, `Guzzle\Http\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
71			$this->handleError();
72			}
73
74			return $this->response->getBody(true);
75			}
76
77			/**
78			* {@inheritdoc}
79			*/
80			public function put($url, $content = '')
81			{
82			$request = $this->client->put($url);
83
84			if (is_array($content)) {
85			$request->setBody(json_encode($content), 'application/json');
86			} else {
87			$request->setBody($content);
88			}
89
90			try {
91			$this->response = $request->send();
92			} catch (RequestException $e) {
93			$this->response = $e->getResponse();
			0 ignored issues – show Bug introduced 2015-12-23 12:43 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Guzzle\Http\Exception\RequestException` as the method `getResponse()` does only exist in the following sub-classes of `Guzzle\Http\Exception\RequestException`: `Guzzle\Http\Exception\BadResponseException`, `Guzzle\Http\Exception\ClientErrorResponseException`, `Guzzle\Http\Exception\ServerErrorResponseException`, `Guzzle\Http\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
94			$this->handleError();
95			}
96
97			return $this->response->getBody(true);
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103			public function post($url, $content = '')
104			{
105			$request = $this->client->post($url);
106
107			if (is_array($content)) {
108			$request->setBody(json_encode($content), 'application/json');
109			} else {
110			$request->setBody($content);
111			}
112
113			try {
114			$this->response = $request->send();
115			} catch (RequestException $e) {
116			$this->response = $e->getResponse();
			0 ignored issues – show Bug introduced 2015-12-23 12:43 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Guzzle\Http\Exception\RequestException` as the method `getResponse()` does only exist in the following sub-classes of `Guzzle\Http\Exception\RequestException`: `Guzzle\Http\Exception\BadResponseException`, `Guzzle\Http\Exception\ClientErrorResponseException`, `Guzzle\Http\Exception\ServerErrorResponseException`, `Guzzle\Http\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
117			$this->handleError();
118			}
119
120			return $this->response->getBody(true);
121			}
122
123			/**
124			* {@inheritdoc}
125			*/
126			public function getLatestResponseHeaders()
127			{
128			if (null === $this->response) {
129			return;
130			}
131
132			return [
133			'reset' => (int) (string) $this->response->getHeader('RateLimit-Reset'),
134			'remaining' => (int) (string) $this->response->getHeader('RateLimit-Remaining'),
135			'limit' => (int) (string) $this->response->getHeader('RateLimit-Limit'),
136			];
137			}
138
139			/**
140			* @throws HttpException
141			*/
142			protected function handleError()
143			{
144			$body = (string) $this->response->getBody(true);
145			$code = (int) $this->response->getStatusCode();
146
147			$content = json_decode($body);
148
149			throw new HttpException(isset($content->message) ? $content->message : 'Request not processed.', $code);
150			}
151			}
152

toin0u / DigitalOceanV2

Push — exceptions ( 2454be...fb5172 )

GuzzleAdapter::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like