ApiClient::isEnabled() - Code Metrics - Napp/fenerum-api-client - Measure and Improve Code Quality continuously with Scrutinizer

ApiClient::isEnabled() A
last analyzed 2020-03-06 14:43 UTC

↳ Parent: ApiClient

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

declare(strict_types=1);

namespace Fenerum;

use Fenerum\API\Exceptions\FenerumApiException;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
use Illuminate\Support\Facades\Log;

class ApiClient
{
    /** @var \GuzzleHttp\Client */
    protected $client;

    public function __construct()
    {
        $this->client = new Client([
            'base_uri' => config('fenerum.base_uri'),
            'headers' => [
                'Authorization' => 'Token '.config('fenerum.api_token'),
                'Content-Type' => 'application/json',
                'Accept' => 'application/json',
            ],
            'timeout'  => 15.0,
        ]);
    }

    /**
     * @param string $url
     * @return array|null
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    public function get(string $url): ?array
    {
        return $this->request('GET', $url);
    }

    /**
     * @param string $url
     * @param array $data
     * @return array|null
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    public function post(string $url, array $data): ?array
    {
        return $this->request('POST', $url, $data);
    }

    /**
     * @param string $url
     * @param array $data
     * @return array
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    public function put(string $url, array $data): ?array
    {
        return $this->request('PUT', $url, $data);
    }

    /**
     * @param string $url
     * @param array $data
     * @return array|null
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    public function patch(string $url, array $data): ?array
    {
        return $this->request('PATCH', $url, $data);
    }

    /**
     * @param string $url
     * @return array|null
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    public function delete(string $url): ?array
    {
        return $this->request('DELETE', $url);
    }

    /**
     * Send Request.
     *
     * @param string $method
     * @param string $uri
     * @param array|null $payload
     * @param array $headers
     * @return array|null
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    public function request(string $method, string $uri, $payload = null, array $headers = []): ?array
    {
        if (! $this->isEnabled()) {
            $this->logger('is not enabled. Please review config');

            return null;
        }

        try {
            $response = $this->client->request($method, $uri, [
                'json' => $payload,
                'headers' => $headers,
            ]);
            $this->logger("Request url: {$uri}", $payload ?? []);

            return json_decode($response->getBody()->getContents(), true);
        } catch (GuzzleException $exception) {
            $this->handleException($exception, $uri);
        }
    }

    /**
     * @param GuzzleException $exception
     * @param string $uri
     * @throws \Fenerum\API\Exceptions\FenerumApiException
     */
    private function handleException(GuzzleException $exception, string $uri): void
    {
        $response = $exception->getResponse();
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.
    }
}
        $code = $exception->getCode();
        $body = $exception->getMessage();

        if (null !== $response) {
            $code = $response->getStatusCode();
            $body = $response->getBody()->getContents();
        }

        $this->logger("Response Error: url: {$uri} Response: {$body}. Response code: $code.");

        throw new FenerumApiException($body, $code, $exception);
    }

    /**
     * Makes sure that all config objects are set before we can use this.
     * @return bool
     */
    private function isEnabled(): bool
    {
        return null !== config('fenerum.base_uri') && null !== config('fenerum.api_token');
    }

    /**
     * @param string $string
     * @param array|null $context
     */
    private function logger(string $string, ?array $context = []): void
    {
        if (true === config('fenerum.debug')) {
            Log::debug(\get_class($this) . ' ' . $string, $context);

        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Fenerum;
6
7			use Fenerum\API\Exceptions\FenerumApiException;
8			use GuzzleHttp\Client;
9			use GuzzleHttp\Exception\GuzzleException;
10			use Illuminate\Support\Facades\Log;
11
12			class ApiClient
13			{
14			/** @var \GuzzleHttp\Client */
15			protected $client;
16
17			public function __construct()
18			{
19			$this->client = new Client([
20			'base_uri' => config('fenerum.base_uri'),
21			'headers' => [
22			'Authorization' => 'Token '.config('fenerum.api_token'),
23			'Content-Type' => 'application/json',
24			'Accept' => 'application/json',
25			],
26			'timeout' => 15.0,
27			]);
28			}
29
30			/**
31			* @param string $url
32			* @return array\|null
33			* @throws \Fenerum\API\Exceptions\FenerumApiException
34			*/
35			public function get(string $url): ?array
36			{
37			return $this->request('GET', $url);
38			}
39
40			/**
41			* @param string $url
42			* @param array $data
43			* @return array\|null
44			* @throws \Fenerum\API\Exceptions\FenerumApiException
45			*/
46			public function post(string $url, array $data): ?array
47			{
48			return $this->request('POST', $url, $data);
49			}
50
51			/**
52			* @param string $url
53			* @param array $data
54			* @return array
55			* @throws \Fenerum\API\Exceptions\FenerumApiException
56			*/
57			public function put(string $url, array $data): ?array
58			{
59			return $this->request('PUT', $url, $data);
60			}
61
62			/**
63			* @param string $url
64			* @param array $data
65			* @return array\|null
66			* @throws \Fenerum\API\Exceptions\FenerumApiException
67			*/
68			public function patch(string $url, array $data): ?array
69			{
70			return $this->request('PATCH', $url, $data);
71			}
72
73			/**
74			* @param string $url
75			* @return array\|null
76			* @throws \Fenerum\API\Exceptions\FenerumApiException
77			*/
78			public function delete(string $url): ?array
79			{
80			return $this->request('DELETE', $url);
81			}
82
83			/**
84			* Send Request.
85			*
86			* @param string $method
87			* @param string $uri
88			* @param array\|null $payload
89			* @param array $headers
90			* @return array\|null
91			* @throws \Fenerum\API\Exceptions\FenerumApiException
92			*/
93			public function request(string $method, string $uri, $payload = null, array $headers = []): ?array
94			{
95			if (! $this->isEnabled()) {
96			$this->logger('is not enabled. Please review config');
97
98			return null;
99			}
100
101			try {
102			$response = $this->client->request($method, $uri, [
103			'json' => $payload,
104			'headers' => $headers,
105			]);
106			$this->logger("Request url: {$uri}", $payload ?? []);
107
108			return json_decode($response->getBody()->getContents(), true);
109			} catch (GuzzleException $exception) {
110			$this->handleException($exception, $uri);
111			}
112			}
113
114			/**
115			* @param GuzzleException $exception
116			* @param string $uri
117			* @throws \Fenerum\API\Exceptions\FenerumApiException
118			*/
119			private function handleException(GuzzleException $exception, string $uri): void
120			{
121			$response = $exception->getResponse();
			0 ignored issues – show Bug introduced 2020-03-06 14:42 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GuzzleHttp\Exception\GuzzleException` as the method `getResponse()` does only exist in the following implementations of said interface: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`. 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...
122			$code = $exception->getCode();
123			$body = $exception->getMessage();
124
125			if (null !== $response) {
126			$code = $response->getStatusCode();
127			$body = $response->getBody()->getContents();
128			}
129
130			$this->logger("Response Error: url: {$uri} Response: {$body}. Response code: $code.");
131
132			throw new FenerumApiException($body, $code, $exception);
133			}
134
135			/**
136			* Makes sure that all config objects are set before we can use this.
137			* @return bool
138			*/
139			private function isEnabled(): bool
140			{
141			return null !== config('fenerum.base_uri') && null !== config('fenerum.api_token');
142			}
143
144			/**
145			* @param string $string
146			* @param array\|null $context
147			*/
148			private function logger(string $string, ?array $context = []): void
149			{
150			if (true === config('fenerum.debug')) {
151			Log::debug(\get_class($this) . ' ' . $string, $context);
			0 ignored issues – show Bug introduced 2020-03-06 14:42 UTC by Report Bug Copy Issue Report It seems like `$context` defined by parameter `$context` on line 148 can also be of type `null`; however, `Illuminate\Support\Facades\Log::debug()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
152			}
153			}
154			}
155

Napp / fenerum-api-client

ApiClient::isEnabled() A last analyzed 2020-03-06 14:43 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ApiClient::isEnabled() A
last analyzed 2020-03-06 14:43 UTC