PageApi::clearEndpoint() - Code Metrics - Inspection of "Adds full test coverage for logic" - journeygroup/vssl-render - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7f5bc2...d69698 )

by Justin

created 2017-03-16 20:27 UTC

PageApi::clearEndpoint() A

↳ Parent: PageApi

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

namespace Vssl\Render;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ConnectException;
use Journey\Cache\CacheAdapterInterface;
use Psr\Http\Message\RequestInterface;

class PageApi
{
    /**
     * Guzzle HTTP interface.
     *
     * @var \GuzzleHTTP\Client
     */
    protected $http;

    /**
     * A cache adapter for storing results.
     *
     * @var \Journey\Cache\CacheAdapterInterface
     */
    protected $cache;

    /**
     * Number of seconds responses should be cached for.
     *
     * @var integer
     */
    protected $ttl;

    /**
     * Initialize the page api methods.
     */
    public function __construct(RequestInterface $request, array $config)
    {
        $this->ttl = $config['cache_ttl'];
        $this->cache = $config['cache'];
        $this->http = new Client([
            'base_uri' => $config['base_uri'],
            'headers' => [
                'X-Render-Host' => $request->getUri()->getHost(),
            ]
        ]);
    }

    /**
     * Get a particular page from the api.
     *
     * @param  string $path path of the page
     * @return array|false
     */
    public function getPage($path)
    {
        return $this->call("get", "/api/pages?slug=" . $path);
    }

    /**
     * Get a particular page from the api.
     *
     * @param  array $ids unique ids of pages to fetch data for.
     * @return array|false
     */
    public function getPagesById($ids)
    {
        $ids = array_filter(array_map(function ($id) {
            return is_numeric($id) ? (integer) $id : null;
        }, $ids));
        return $this->call("get", "/api/pages?ids=" . implode(",", $ids));
    }

    /**
     * Clear the cache of a given endpoint immediately.
     *
     * @param  string $method get/post/put
     * @param  string $url    endpoint to hit
     * @return $this
     */
    public function clearEndpoint($method, $url)
    {
        $cacheKey = md5(strtoupper($method) . "::" . $url);
        $this->cache->delete($cacheKey);
        return $this;
    }

    /**
     * Call a particular api endpoint.
     *
     * @return \Psr\Http\Message\ResponseInterface|false
     */
    public function call($method, $url)
    {
        $cacheKey = md5(strtoupper($method) . "::" . $url);
        try {
            if (!$value = $this->cache->get($cacheKey)) {
                $response = $this->http->request(strtoupper($method), $url);
            }
        } catch (ClientException $e) {
            $response = $e->getResponse();
        } catch (ConnectException $e) {
            // Suppress network errors at this level.
        }
        if (!isset($response) && $value) {
            $response = \GuzzleHttp\Psr7\parse_response($value);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        } elseif ($this->ttl) {
            $this->cache->set($cacheKey, \GuzzleHttp\Psr7\str($response), time() + $this->ttl);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }
        return isset($response) ? $response : false;
    }
}


1		<?php
2
3		namespace Vssl\Render;
4
5		use GuzzleHttp\Client;
6		use GuzzleHttp\Exception\ClientException;
7		use GuzzleHttp\Exception\ConnectException;
8		use Journey\Cache\CacheAdapterInterface;
9		use Psr\Http\Message\RequestInterface;
10
11		class PageApi
12		{
13		/**
14		* Guzzle HTTP interface.
15		*
16		* @var \GuzzleHTTP\Client
17		*/
18		protected $http;
19
20		/**
21		* A cache adapter for storing results.
22		*
23		* @var \Journey\Cache\CacheAdapterInterface
24		*/
25		protected $cache;
26
27		/**
28		* Number of seconds responses should be cached for.
29		*
30		* @var integer
31		*/
32		protected $ttl;
33
34		/**
35		* Initialize the page api methods.
36		*/
37	10	public function __construct(RequestInterface $request, array $config)
38		{
39	10	$this->ttl = $config['cache_ttl'];
40	10	$this->cache = $config['cache'];
41	10	$this->http = new Client([
42	10	'base_uri' => $config['base_uri'],
43		'headers' => [
44	10	'X-Render-Host' => $request->getUri()->getHost(),
45		]
46	10	]);
47	10	}
48
49		/**
50		* Get a particular page from the api.
51		*
52		* @param string $path path of the page
53		* @return array\|false
54		*/
55	4	public function getPage($path)
56		{
57	4	return $this->call("get", "/api/pages?slug=" . $path);
58		}
59
60		/**
61		* Get a particular page from the api.
62		*
63		* @param array $ids unique ids of pages to fetch data for.
64		* @return array\|false
65		*/
66		public function getPagesById($ids)
67		{
68	2	$ids = array_filter(array_map(function ($id) {
69	2	return is_numeric($id) ? (integer) $id : null;
70	2	}, $ids));
71	2	return $this->call("get", "/api/pages?ids=" . implode(",", $ids));
72		}
73
74		/**
75		* Clear the cache of a given endpoint immediately.
76		*
77		* @param string $method get/post/put
78		* @param string $url endpoint to hit
79		* @return $this
80		*/
81	1	public function clearEndpoint($method, $url)
82		{
83	1	$cacheKey = md5(strtoupper($method) . "::" . $url);
84	1	$this->cache->delete($cacheKey);
85	1	return $this;
86		}
87
88		/**
89		* Call a particular api endpoint.
90		*
91		* @return \Psr\Http\Message\ResponseInterface\|false
92		*/
93	8	public function call($method, $url)
94		{
95	8	$cacheKey = md5(strtoupper($method) . "::" . $url);
96		try {
97	8	if (!$value = $this->cache->get($cacheKey)) {
98	8	$response = $this->http->request(strtoupper($method), $url);
99	5	}
100	8	} catch (ClientException $e) {
101	2	$response = $e->getResponse();
102	3	} catch (ConnectException $e) {
103		// Suppress network errors at this level.
104		}
105	8	if (!isset($response) && $value) {
106	1	$response = \GuzzleHttp\Psr7\parse_response($value);
		0 ignored issues – show Bug introduced 2017-03-16 20:00 UTC by Report Bug Copy Issue Report The variable `$value` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
107	8	} elseif ($this->ttl) {
108	4	$this->cache->set($cacheKey, \GuzzleHttp\Psr7\str($response), time() + $this->ttl);
		0 ignored issues – show Bug introduced 2017-03-16 20:29 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$e->getResponse()` on line `101` can be `null`; however, `GuzzleHttp\Psr7\str()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
109	4	}
110	8	return isset($response) ? $response : false;
111		}
112		}
113

journeygroup / vssl-render

Push — master ( 7f5bc2...d69698 )

PageApi::clearEndpoint() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like