Client::search() - Code Metrics - Inspection of "Develop" - chadicus/marvel-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#26)

by Chad

created 2017-01-31 23:33 UTC

Client::search() A

↳ Parent: Client

Complexity

Conditions	3
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
c	0
b	0
f	0
rs	9.4285
cc	3
eloc	9
nc	2
nop	2

<?php

namespace Chadicus\Marvel\Api;

use DominionEnterprises\Util;
use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\ClientInterface as GuzzleClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Zend\Diactoros\Request;

/**
 * PHP Client for the Marvel API.
 */
class Client implements ClientInterface
{
    /**
     * The public api key issued by Marvel.
     *
     * @var string
     */
    private $publicApiKey;

    /**
     * The private api key issued by Marvel.
     *
     * @var string
     */
    private $privateApiKey;

    /**
     * Guzzle HTTP Client implementation.
     *
     * @var GuzzleClientInterface
     */
    private $guzzleClient;

    /**
     * Cache implementation.
     *
     * @var Cache\CacheInterface
     */
    private $cache;

    /**
     * The Marvel API url.
     *
     * @const string
     */
    const BASE_URL = 'http://gateway.marvel.com/v1/public/';

    /**
     * Construct a new Client.
     *
     * @param string               $privateApiKey The private api key issued by Marvel.
     * @param string               $publicApiKey  The public api key issued by Marvel.
     * @param ClientInterface      $guzzleClient  Implementation of a Guzzle HTTP client.
     * @param Cache\CacheInterface $cache         Implementation of Cache.
     */
    final public function __construct(

        $privateApiKey,
        $publicApiKey,
        GuzzleClientInterface $guzzleClient = null,
        Cache\CacheInterface $cache = null
    ) {
        Util::throwIfNotType(['string' => [$privateApiKey, $publicApiKey]], true);

        $this->privateApiKey = $privateApiKey;
        $this->publicApiKey = $publicApiKey;
        $this->guzzleClient = $guzzleClient ?: new GuzzleClient();
        $this->cache = $cache;
    }

    /**
     * Execute a search request against the Marvel API.
     *
     * @param string $resource The API resource to search for.
     * @param array  $filters  Array of search criteria to use in request.
     *
     * @return ResponseInterface
     *
     * @throws \InvalidArgumentException Thrown if $resource is empty or not a string.
     */
    final public function search($resource, array $filters = [])
    {
        if (!is_string($resource) || trim($resource) == '') {
            throw new \InvalidArgumentException('$resource must be a non-empty string');
        }

        $filters['apikey'] = $this->publicApiKey;
        $timestamp = time();
        $filters['ts'] = $timestamp;
        $filters['hash'] = md5($timestamp . $this->privateApiKey . $this->publicApiKey);
        $url = self::BASE_URL . urlencode($resource) . '?' . http_build_query($filters);

        return $this->send(new Request($url, 'GET', 'php://temp', ['Accept' =>  'application/json']));
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Execute a GET request against the Marvel API for a single resource.
     *
     * @param string  $resource The API resource to search for.
     * @param integer $id       The id of the API resource.
     *
     * @return ResponseInterface
     */
    final public function get($resource, $id)
    {
        Util::throwIfNotType(['string' => [$resource], 'int' => [$id]], true);

        $timestamp = time();
        $query = [
            'apikey' => $this->publicApiKey,
            'ts' => $timestamp,
            'hash' => md5($timestamp . $this->privateApiKey . $this->publicApiKey),
        ];

        $url = self::BASE_URL . urlencode($resource) . "/{$id}?" . http_build_query($query);

        return $this->send(new Request($url, 'GET', 'php://temp', ['Accept' =>  'application/json']));
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Send the given API Request.
     *
     * @param RequestInterface $request The request to send.
     *
     * @return ResponseInterface
     */
    final private function send(RequestInterface $request)
    {
        $response = $this->getFromCache($request);
        if ($response !== null) {
            return $response;
        }

        $response = $this->guzzleClient->send($request);

        if ($this->cache !== null) {
            $this->cache->set($request, $response);
        }

        return $response;
    }

    /**
     * Retrieve the Response for the given Request from cache.
     *
     * @param RequestInterface $request The request to send.
     *
     * @return ResponseInterface|null Returns the cached Response or null if it does not exist.
     */
    final private function getFromCache(RequestInterface $request)
    {
        if ($this->cache === null) {
            return null;
        }

        return $this->cache->get($request);
    }

    /**
     * Allow calls such as $client->characters();
     *
     * @param string $name      The name of the api resource.
     * @param array  $arguments The parameters to pass to get() or search().
     *
     * @return Collection|EntityInterface
     */
    final public function __call($name, array $arguments)
    {
        $resource = strtolower($name);
        $parameters = array_shift($arguments);
        if ($parameters === null || is_array($parameters)) {
            return new Collection($this, $resource, $parameters ?: []);
        }

        $response = $this->get($resource, $parameters);
        if ($response->getStatusCode() !== 200) {
            return null;
        }

        $json = (string)$response->getBody();
        $dataWrapper = new DataWrapper(json_decode($json, true));
        $results = $dataWrapper->getData()->getResults();
        if (empty($results)) {
            return null;
        }

        return $results[0];
    }
}


1			<?php
2
3			namespace Chadicus\Marvel\Api;
4
5			use DominionEnterprises\Util;
6			use GuzzleHttp\Client as GuzzleClient;
7			use GuzzleHttp\ClientInterface as GuzzleClientInterface;
8			use Psr\Http\Message\RequestInterface;
9			use Psr\Http\Message\ResponseInterface;
10			use Zend\Diactoros\Request;
11
12			/**
13			* PHP Client for the Marvel API.
14			*/
15			class Client implements ClientInterface
16			{
17			/**
18			* The public api key issued by Marvel.
19			*
20			* @var string
21			*/
22			private $publicApiKey;
23
24			/**
25			* The private api key issued by Marvel.
26			*
27			* @var string
28			*/
29			private $privateApiKey;
30
31			/**
32			* Guzzle HTTP Client implementation.
33			*
34			* @var GuzzleClientInterface
35			*/
36			private $guzzleClient;
37
38			/**
39			* Cache implementation.
40			*
41			* @var Cache\CacheInterface
42			*/
43			private $cache;
44
45			/**
46			* The Marvel API url.
47			*
48			* @const string
49			*/
50			const BASE_URL = 'http://gateway.marvel.com/v1/public/';
51
52			/**
53			* Construct a new Client.
54			*
55			* @param string $privateApiKey The private api key issued by Marvel.
56			* @param string $publicApiKey The public api key issued by Marvel.
57			* @param ClientInterface $guzzleClient Implementation of a Guzzle HTTP client.
58			* @param Cache\CacheInterface $cache Implementation of Cache.
59			*/
60			final public function __construct(
			0 ignored issues – show Coding Style introduced 2017-01-31 23:35 UTC by Report Bug Copy Issue Report Expected type hint "ClientInterface"; found "GuzzleClientInterface" for $guzzleClient Loading history...
61			$privateApiKey,
62			$publicApiKey,
63			GuzzleClientInterface $guzzleClient = null,
64			Cache\CacheInterface $cache = null
65			) {
66			Util::throwIfNotType(['string' => [$privateApiKey, $publicApiKey]], true);
67
68			$this->privateApiKey = $privateApiKey;
69			$this->publicApiKey = $publicApiKey;
70			$this->guzzleClient = $guzzleClient ?: new GuzzleClient();
71			$this->cache = $cache;
72			}
73
74			/**
75			* Execute a search request against the Marvel API.
76			*
77			* @param string $resource The API resource to search for.
78			* @param array $filters Array of search criteria to use in request.
79			*
80			* @return ResponseInterface
81			*
82			* @throws \InvalidArgumentException Thrown if $resource is empty or not a string.
83			*/
84			final public function search($resource, array $filters = [])
85			{
86			if (!is_string($resource) \|\| trim($resource) == '') {
87			throw new \InvalidArgumentException('$resource must be a non-empty string');
88			}
89
90			$filters['apikey'] = $this->publicApiKey;
91			$timestamp = time();
92			$filters['ts'] = $timestamp;
93			$filters['hash'] = md5($timestamp . $this->privateApiKey . $this->publicApiKey);
94			$url = self::BASE_URL . urlencode($resource) . '?' . http_build_query($filters);
95
96			return $this->send(new Request($url, 'GET', 'php://temp', ['Accept' => 'application/json']));
			0 ignored issues – show Bug Best Practice introduced 2017-01-31 21:02 UTC by Report Bug Copy Issue Report The return type of `return $this->send(new \... 'application/json')));` (`Psr\Http\Message\ResponseInterface`) is incompatible with the return type declared by the interface `Chadicus\Marvel\Api\ClientInterface::search` of type `Chadicus\Marvel\Api\ResponseInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
97			}
98
99			/**
100			* Execute a GET request against the Marvel API for a single resource.
101			*
102			* @param string $resource The API resource to search for.
103			* @param integer $id The id of the API resource.
104			*
105			* @return ResponseInterface
106			*/
107			final public function get($resource, $id)
108			{
109			Util::throwIfNotType(['string' => [$resource], 'int' => [$id]], true);
110
111			$timestamp = time();
112			$query = [
113			'apikey' => $this->publicApiKey,
114			'ts' => $timestamp,
115			'hash' => md5($timestamp . $this->privateApiKey . $this->publicApiKey),
116			];
117
118			$url = self::BASE_URL . urlencode($resource) . "/{$id}?" . http_build_query($query);
119
120			return $this->send(new Request($url, 'GET', 'php://temp', ['Accept' => 'application/json']));
			0 ignored issues – show Bug Best Practice introduced 2017-01-31 21:02 UTC by Report Bug Copy Issue Report The return type of `return $this->send(new \... 'application/json')));` (`Psr\Http\Message\ResponseInterface`) is incompatible with the return type declared by the interface `Chadicus\Marvel\Api\ClientInterface::get` of type `Chadicus\Marvel\Api\ResponseInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
121			}
122
123			/**
124			* Send the given API Request.
125			*
126			* @param RequestInterface $request The request to send.
127			*
128			* @return ResponseInterface
129			*/
130			final private function send(RequestInterface $request)
131			{
132			$response = $this->getFromCache($request);
133			if ($response !== null) {
134			return $response;
135			}
136
137			$response = $this->guzzleClient->send($request);
138
139			if ($this->cache !== null) {
140			$this->cache->set($request, $response);
141			}
142
143			return $response;
144			}
145
146			/**
147			* Retrieve the Response for the given Request from cache.
148			*
149			* @param RequestInterface $request The request to send.
150			*
151			* @return ResponseInterface\|null Returns the cached Response or null if it does not exist.
152			*/
153			final private function getFromCache(RequestInterface $request)
154			{
155			if ($this->cache === null) {
156			return null;
157			}
158
159			return $this->cache->get($request);
160			}
161
162			/**
163			* Allow calls such as $client->characters();
164			*
165			* @param string $name The name of the api resource.
166			* @param array $arguments The parameters to pass to get() or search().
167			*
168			* @return Collection\|EntityInterface
169			*/
170			final public function __call($name, array $arguments)
171			{
172			$resource = strtolower($name);
173			$parameters = array_shift($arguments);
174			if ($parameters === null \|\| is_array($parameters)) {
175			return new Collection($this, $resource, $parameters ?: []);
176			}
177
178			$response = $this->get($resource, $parameters);
179			if ($response->getStatusCode() !== 200) {
180			return null;
181			}
182
183			$json = (string)$response->getBody();
184			$dataWrapper = new DataWrapper(json_decode($json, true));
185			$results = $dataWrapper->getData()->getResults();
186			if (empty($results)) {
187			return null;
188			}
189
190			return $results[0];
191			}
192			}
193

chadicus / marvel-api-client

Pull Request — master (#26)

Client::search() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like