AbstractProvider::getHttpClientOptions() - Code Metrics - Inspection of "Fixing scrutinizer path" - jobapis/jobs-common - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — v2-beta (bab4d8)

by Karl

created 2016-08-27 12:59 UTC

AbstractProvider::getHttpClientOptions() A

↳ Parent: AbstractProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

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

<?php namespace JobApis\Jobs\Client\Providers;

use GuzzleHttp\Client as HttpClient;
use JobApis\Jobs\Client\AttributeTrait;
use JobApis\Jobs\Client\Collection;
use JobApis\Jobs\Client\Exceptions\MissingParameterException;

abstract class AbstractProvider
{
    use AttributeTrait;

    /**
     * Base API Url
     *
     * @var string
     */
    protected $baseUrl;

    /**
     * HTTP Client
     *
     * @var HttpClient
     */
    protected $client;

    /**
     * Query params
     *
     * @var array
     */
    protected $queryParams = [];

    /**
     * Create new client
     *
     * @param array $parameters
     */
    public function __construct($parameters = [])
    {
        $parameters = array_merge($this->defaultParameters(), $parameters);

        array_walk($parameters, [$this, 'updateQuery']);

        $this->setClient(new HttpClient);
    }

    /**
     * Get query param as properties, if exists
     *
     * @param  string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return mixed
     * @throws \OutOfRangeException
     */
    public function __get($key)
    {
        // Then check to see if there's a query parameter
        if (!isset($this->queryParams[$key])) {
            throw new \OutOfRangeException(sprintf(
                '%s does not contain a property by the name of "%s"',
                __CLASS__,
                $key
            ));
        }
        return $this->queryParams[$key];
    }

    /**
     * Set query param as properties, if exists
     *
     * @param  string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return mixed
     * @throws \OutOfRangeException
     */
    public function __set($key, $value)
    {
        // Then check to see if there's a query parameter
        if (!$this->isValidParameter($key)) {
            throw new \OutOfRangeException(sprintf(
                '%s does not contain a property by the name of "%s"',
                __CLASS__,
                $key
            ));
        }
        $this->queryParams[$key] = $value;
        return $this;
    }

    /**
     * Returns the standardized job object
     *
     * @param array|object $payload
     *
     * @return \JobApis\Jobs\Client\Job
     */
    abstract public function createJobObject($payload);

    /**
     * Get default parameters and values
     *
     * @return  string
     */
    abstract public function defaultParameters();

    /**
     * Job object default keys that must be set.
     *
     * @return  string
     */
    abstract public function defaultResponseFields();

    /**
     * Get listings path
     *
     * @return  string
     */
    abstract public function getListingsPath();

    /**
     * Get parameters that MUST be set in order to satisfy the APIs requirements
     *
     * @return  string
     */
    abstract public function requiredParameters();

    /**
     * Get parameters that CAN be set
     *
     * @return  string
     */
    abstract public function validParameters();

    // Public methods

    /**
     * Get format
     *
     * @return  string Currently only 'json' and 'xml' supported
     */
    public function getFormat()
    {
        return 'json';
    }

    /**
     * Get http client options based on current client
     *
     * @return array
     */
    public function getHttpClientOptions()
    {
        $options = [];
        if (strtolower($this->getVerb()) != 'get') {
            $options['body'] = $this->queryParams;
        }

        return $options;
    }

    /**
     * Makes the api call and returns a collection of job objects
     *
     * @return  JobApis\Jobs\Client\Collection
     * @throws MissingParameterException
     */
    public function getJobs()
    {
        if ($this->requiredParamsIncluded()) {
            $client = $this->client;
            $verb = strtolower($this->getVerb());
            $url = $this->getUrl();
            $options = $this->getHttpClientOptions();

            $response = $client->{$verb}($url, $options);

            $body = (string) $response->getBody();

            $payload = $this->parseAsFormat($body, $this->getFormat());

            $listings = is_array($payload) ? $this->getRawListings($payload) : [];

            return $this->getJobsCollectionFromListings($listings);
        } else {
            throw new MissingParameterException("All Required parameters for this provider must be set");
        }
    }

    /**
     * Get source attribution
     *
     * @return string
     */
    public function getSource()
    {
        return $this->getShortName();
    }

    /**
     * Get query string for client based on properties
     *
     * @return string
     */
    public function getQueryString()
    {
        return '?'.http_build_query($this->queryParams);
    }

    /**
     * Get url
     *
     * @return  string
     */
    public function getUrl()
    {
        if (!$this->baseUrl) {
            throw new MissingParameterException("Base URL parameter not set in provider.");
        }
        return $this->baseUrl.$this->getQueryString();
    }

    /**
     * Get http verb to use when making request
     *
     * @return  string
     */
    public function getVerb()
    {
        return 'GET';
    }

    /**
     * Check whether a key is valid for this client
     *
     * @return  string
     */
    public function isValidParameter($key = null)
    {
        return in_array($key, $this->validParameters());
    }

    /**
     * Parse job attributes against defaults
     *
     * @param  array $attributes
     * @param  array $defaults
     *
     * @return array
     */
    public static function parseAttributeDefaults(array $attributes, array $defaults = array())
    {
        array_map(function ($attribute) use (&$attributes) {
            if (!isset($attributes[$attribute])) {
                $attributes[$attribute] = null;
            }
        }, $defaults);
        return $attributes;
    }

    /**
     * Parse location string into components.
     *
     * @param string $location
     *
     * @return  array
     **/
    public static function parseLocation($location, $separator = ', ')
    {
        return explode($separator, $location);
    }

    /**
     * Determines if all required parameters have been set
     *
     * @return  bool
     */
    public function requiredParamsIncluded()
    {
        foreach ($this->requiredParameters() as $key) {

            if (!isset($this->queryParams[$key])) {
                return false;
            }
        }
        return true;
    }

    /**
     * Sets http client
     *
     * @param HttpClient $client
     *
     * @return  AbstractProvider
     */
    public function setClient(HttpClient $client)
    {
        $this->client = $client;

        return $this;
    }

    // Protected methods

    /**
     * Create and get collection of jobs from given listings
     *
     * @param  array $listings
     *
     * @return Collection
     */
    protected function getJobsCollectionFromListings(array $listings = [])
    {
        $collection = new Collection;

        array_map(function ($item) use ($collection) {
            $item = static::parseAttributeDefaults($item, $this->defaultResponseFields());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $job = $this->createJobObject($item);
            $job->setQuery($this->getKeyword())
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                ->setSource($this->getSource());
            $collection->add($job);
        }, $listings);

        return $collection;
    }

    /**
     * Get raw listings from payload
     *
     * @param  array $payload
     *
     * @return array
     */
    protected function getRawListings(array $payload = array())
    {
        $path = $this->getListingsPath();

        if (!empty($path)) {
            $index = explode('.', $path);

            return (array) self::getValue($index, $payload);
        }

        return (array) $payload;
    }

    /**
     * Navigate through a payload array looking for a particular index
     *
     * @param array $index The index sequence we are navigating down
     * @param array $value The portion of the config array to process
     *
     * @return mixed
     */
    protected static function getValue($index, $value)
    {
        $current_index = self::getValueCurrentIndex($index);

        if (isset($value[$current_index])) {
            $index_array = self::isArrayNotEmpty($index);
            $value_array = self::isArrayNotEmpty($value[$current_index]);

            if ($index_array && $value_array) {
                return self::getValue($index, $value[$current_index]);
            } else {
                return $value[$current_index];
            }
        } else {
            throw new \OutOfRangeException("Attempt to access missing variable: $current_index");
        }
    }

    /**
     * Attempt to parse string as given format
     *
     * @param  string  $string
     * @param  string  $format
     *
     * @return array
     */
    protected function parseAsFormat($string, $format)
    {
        $method = 'parseAs'.ucfirst(strtolower($format));

        if (method_exists($this, $method)) {
            return $this->$method($string);
        }

        return [];
    }

    /**
     * Attempts to update current query parameters.
     *
     * @param  string  $value
     * @param  string  $key
     *
     * @return AbstractProvider
     */
    protected function updateQuery($value, $key)
    {
        if (in_array($key, $this->validParameters())) {
            $this->queryParams[$key] = $value;
        }
        return $this;
    }

    // Private methods

    /**
     * Get value current index
     *
     * @param  mixed $index
     *
     * @return array|null
     */
    private static function getValueCurrentIndex(&$index)
    {
        return is_array($index) && count($index) ? array_shift($index) : null;
    }

    /**
     * Checks if given value is an array and that it has contents
     *
     * @param  mixed $array
     *
     * @return boolean
     */
    private static function isArrayNotEmpty($array)
    {
        return is_array($array) && count($array);
    }

    /**
     * Attempt to parse as Json
     *
     * @param  string $string
     *
     * @return array
     */
    private function parseAsJson($string)
    {
        try {
            $json = json_decode($string, true);

            if (json_last_error() != JSON_ERROR_NONE) {
                throw new \Exception;
            }

            return $json;
        } catch (\Exception $e) {
            // Ignore malformed json.
        }

        return [];
    }

    /**
     * Attempt to parse as XML
     *
     * @param  string $string
     *
     * @return array
     */
    private function parseAsXml($string)
    {
        try {
            return json_decode(
                json_encode(
                    simplexml_load_string(
                        $string,
                        null,
                        LIBXML_NOCDATA
                    )
                ),
                true
            );
        } catch (\Exception $e) {
            // Ignore malformed xml.
        }

        return [];
    }

    /**
     * Get short name of a given or current class
     *
     * @param  object $object Optional object
     *
     * @return string
     */
    private function getShortName($object = null)
    {
        if (is_null($object)) {
            $object = $this;
        }

        $ref = new \ReflectionClass(get_class($object));

        return $ref->getShortName();
    }
}


1		<?php namespace JobApis\Jobs\Client\Providers;
2
3		use GuzzleHttp\Client as HttpClient;
4		use JobApis\Jobs\Client\AttributeTrait;
5		use JobApis\Jobs\Client\Collection;
6		use JobApis\Jobs\Client\Exceptions\MissingParameterException;
7
8		abstract class AbstractProvider
9		{
10		use AttributeTrait;
11
12		/**
13		* Base API Url
14		*
15		* @var string
16		*/
17		protected $baseUrl;
18
19		/**
20		* HTTP Client
21		*
22		* @var HttpClient
23		*/
24		protected $client;
25
26		/**
27		* Query params
28		*
29		* @var array
30		*/
31		protected $queryParams = [];
32
33		/**
34		* Create new client
35		*
36		* @param array $parameters
37		*/
38	14	public function __construct($parameters = [])
39		{
40	14	$parameters = array_merge($this->defaultParameters(), $parameters);
41
42	14	array_walk($parameters, [$this, 'updateQuery']);
43
44	14	$this->setClient(new HttpClient);
45	14	}
46
47		/**
48		* Get query param as properties, if exists
49		*
50		* @param string $name
		0 ignored issues – show Bug introduced 2016-08-27 13:05 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
51		*
52		* @return mixed
53		* @throws \OutOfRangeException
54		*/
55	12	public function __get($key)
56		{
57		// Then check to see if there's a query parameter
58	12	if (!isset($this->queryParams[$key])) {
59		throw new \OutOfRangeException(sprintf(
60		'%s does not contain a property by the name of "%s"',
61		__CLASS__,
62		$key
63		));
64		}
65	12	return $this->queryParams[$key];
66		}
67
68		/**
69		* Set query param as properties, if exists
70		*
71		* @param string $name
		0 ignored issues – show Bug introduced 2016-08-27 13:05 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
72		*
73		* @return mixed
74		* @throws \OutOfRangeException
75		*/
76	10	public function __set($key, $value)
77		{
78		// Then check to see if there's a query parameter
79	10	if (!$this->isValidParameter($key)) {
80	2	throw new \OutOfRangeException(sprintf(
81	2	'%s does not contain a property by the name of "%s"',
82	2	__CLASS__,
83		$key
84	2	));
85		}
86	8	$this->queryParams[$key] = $value;
87	8	return $this;
88		}
89
90		/**
91		* Returns the standardized job object
92		*
93		* @param array\|object $payload
94		*
95		* @return \JobApis\Jobs\Client\Job
96		*/
97		abstract public function createJobObject($payload);
98
99		/**
100		* Get default parameters and values
101		*
102		* @return string
103		*/
104		abstract public function defaultParameters();
105
106		/**
107		* Job object default keys that must be set.
108		*
109		* @return string
110		*/
111		abstract public function defaultResponseFields();
112
113		/**
114		* Get listings path
115		*
116		* @return string
117		*/
118		abstract public function getListingsPath();
119
120		/**
121		* Get parameters that MUST be set in order to satisfy the APIs requirements
122		*
123		* @return string
124		*/
125		abstract public function requiredParameters();
126
127		/**
128		* Get parameters that CAN be set
129		*
130		* @return string
131		*/
132		abstract public function validParameters();
133
134		// Public methods
135
136		/**
137		* Get format
138		*
139		* @return string Currently only 'json' and 'xml' supported
140		*/
141	2	public function getFormat()
142		{
143	2	return 'json';
144		}
145
146		/**
147		* Get http client options based on current client
148		*
149		* @return array
150		*/
151		public function getHttpClientOptions()
152		{
153		$options = [];
154		if (strtolower($this->getVerb()) != 'get') {
155		$options['body'] = $this->queryParams;
156		}
157
158		return $options;
159		}
160
161		/**
162		* Makes the api call and returns a collection of job objects
163		*
164		* @return JobApis\Jobs\Client\Collection
165		* @throws MissingParameterException
166		*/
167		public function getJobs()
168		{
169		if ($this->requiredParamsIncluded()) {
170		$client = $this->client;
171		$verb = strtolower($this->getVerb());
172		$url = $this->getUrl();
173		$options = $this->getHttpClientOptions();
174
175		$response = $client->{$verb}($url, $options);
176
177		$body = (string) $response->getBody();
178
179		$payload = $this->parseAsFormat($body, $this->getFormat());
180
181		$listings = is_array($payload) ? $this->getRawListings($payload) : [];
182
183		return $this->getJobsCollectionFromListings($listings);
184		} else {
185		throw new MissingParameterException("All Required parameters for this provider must be set");
186		}
187		}
188
189		/**
190		* Get source attribution
191		*
192		* @return string
193		*/
194	2	public function getSource()
195		{
196	2	return $this->getShortName();
197		}
198
199		/**
200		* Get query string for client based on properties
201		*
202		* @return string
203		*/
204		public function getQueryString()
205		{
206		return '?'.http_build_query($this->queryParams);
207		}
208
209		/**
210		* Get url
211		*
212		* @return string
213		*/
214		public function getUrl()
215		{
216		if (!$this->baseUrl) {
217		throw new MissingParameterException("Base URL parameter not set in provider.");
218		}
219		return $this->baseUrl.$this->getQueryString();
220		}
221
222		/**
223		* Get http verb to use when making request
224		*
225		* @return string
226		*/
227		public function getVerb()
228		{
229		return 'GET';
230		}
231
232		/**
233		* Check whether a key is valid for this client
234		*
235		* @return string
236		*/
237	10	public function isValidParameter($key = null)
238		{
239	10	return in_array($key, $this->validParameters());
240		}
241
242		/**
243		* Parse job attributes against defaults
244		*
245		* @param array $attributes
246		* @param array $defaults
247		*
248		* @return array
249		*/
250	2	public static function parseAttributeDefaults(array $attributes, array $defaults = array())
251		{
252		array_map(function ($attribute) use (&$attributes) {
253	2	if (!isset($attributes[$attribute])) {
254	2	$attributes[$attribute] = null;
255	2	}
256	2	}, $defaults);
257	2	return $attributes;
258		}
259
260		/**
261		* Parse location string into components.
262		*
263		* @param string $location
264		*
265		* @return array
266		**/
267		public static function parseLocation($location, $separator = ', ')
268		{
269		return explode($separator, $location);
270		}
271
272		/**
273		* Determines if all required parameters have been set
274		*
275		* @return bool
276		*/
277	2	public function requiredParamsIncluded()
278		{
279	2	foreach ($this->requiredParameters() as $key) {
		0 ignored issues – show Bug introduced 2016-08-27 13:05 UTC by Report Bug Copy Issue Report The expression `$this->requiredParameters()` of type `string` is not traversable. Loading history...
280	2	if (!isset($this->queryParams[$key])) {
281		return false;
282		}
283	2	}
284	2	return true;
285		}
286
287		/**
288		* Sets http client
289		*
290		* @param HttpClient $client
291		*
292		* @return AbstractProvider
293		*/
294	14	public function setClient(HttpClient $client)
295		{
296	14	$this->client = $client;
297
298	14	return $this;
299		}
300
301		// Protected methods
302
303		/**
304		* Create and get collection of jobs from given listings
305		*
306		* @param array $listings
307		*
308		* @return Collection
309		*/
310	2	protected function getJobsCollectionFromListings(array $listings = [])
311		{
312	2	$collection = new Collection;
313
314	2	array_map(function ($item) use ($collection) {
315	2	$item = static::parseAttributeDefaults($item, $this->defaultResponseFields());
		0 ignored issues – show Documentation introduced 2016-08-27 13:05 UTC by Report Bug Copy Issue Report `$this->defaultResponseFields()` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
316	2	$job = $this->createJobObject($item);
317	2	$job->setQuery($this->getKeyword())
		0 ignored issues – show Documentation Bug introduced 2016-08-27 13:05 UTC by Report Bug Copy Issue Report The method `getKeyword` does not exist on `object<JobApis\Jobs\Clie...iders\AbstractProvider>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
318	2	->setSource($this->getSource());
319	2	$collection->add($job);
320	2	}, $listings);
321
322	2	return $collection;
323		}
324
325		/**
326		* Get raw listings from payload
327		*
328		* @param array $payload
329		*
330		* @return array
331		*/
332	2	protected function getRawListings(array $payload = array())
333		{
334	2	$path = $this->getListingsPath();
335
336	2	if (!empty($path)) {
337	2	$index = explode('.', $path);
338
339	2	return (array) self::getValue($index, $payload);
340		}
341
342		return (array) $payload;
343		}
344
345		/**
346		* Navigate through a payload array looking for a particular index
347		*
348		* @param array $index The index sequence we are navigating down
349		* @param array $value The portion of the config array to process
350		*
351		* @return mixed
352		*/
353	2	protected static function getValue($index, $value)
354		{
355	2	$current_index = self::getValueCurrentIndex($index);
356
357	2	if (isset($value[$current_index])) {
358	2	$index_array = self::isArrayNotEmpty($index);
359	2	$value_array = self::isArrayNotEmpty($value[$current_index]);
360
361	2	if ($index_array && $value_array) {
362		return self::getValue($index, $value[$current_index]);
363		} else {
364	2	return $value[$current_index];
365		}
366		} else {
367		throw new \OutOfRangeException("Attempt to access missing variable: $current_index");
368		}
369		}
370
371		/**
372		* Attempt to parse string as given format
373		*
374		* @param string $string
375		* @param string $format
376		*
377		* @return array
378		*/
379	2	protected function parseAsFormat($string, $format)
380		{
381	2	$method = 'parseAs'.ucfirst(strtolower($format));
382
383	2	if (method_exists($this, $method)) {
384	2	return $this->$method($string);
385		}
386
387		return [];
388		}
389
390		/**
391		* Attempts to update current query parameters.
392		*
393		* @param string $value
394		* @param string $key
395		*
396		* @return AbstractProvider
397		*/
398	14	protected function updateQuery($value, $key)
399		{
400	14	if (in_array($key, $this->validParameters())) {
401	14	$this->queryParams[$key] = $value;
402	14	}
403	14	return $this;
404		}
405
406		// Private methods
407
408		/**
409		* Get value current index
410		*
411		* @param mixed $index
412		*
413		* @return array\|null
414		*/
415	2	private static function getValueCurrentIndex(&$index)
416		{
417	2	return is_array($index) && count($index) ? array_shift($index) : null;
418		}
419
420		/**
421		* Checks if given value is an array and that it has contents
422		*
423		* @param mixed $array
424		*
425		* @return boolean
426		*/
427	2	private static function isArrayNotEmpty($array)
428		{
429	2	return is_array($array) && count($array);
430		}
431
432		/**
433		* Attempt to parse as Json
434		*
435		* @param string $string
436		*
437		* @return array
438		*/
439	2	private function parseAsJson($string)
440		{
441		try {
442	2	$json = json_decode($string, true);
443
444	2	if (json_last_error() != JSON_ERROR_NONE) {
445		throw new \Exception;
446		}
447
448	2	return $json;
449		} catch (\Exception $e) {
450		// Ignore malformed json.
451		}
452
453		return [];
454		}
455
456		/**
457		* Attempt to parse as XML
458		*
459		* @param string $string
460		*
461		* @return array
462		*/
463		private function parseAsXml($string)
464		{
465		try {
466		return json_decode(
467		json_encode(
468		simplexml_load_string(
469		$string,
470		null,
471		LIBXML_NOCDATA
472		)
473		),
474		true
475		);
476		} catch (\Exception $e) {
477		// Ignore malformed xml.
478		}
479
480		return [];
481		}
482
483		/**
484		* Get short name of a given or current class
485		*
486		* @param object $object Optional object
487		*
488		* @return string
489		*/
490	2	private function getShortName($object = null)
491		{
492	2	if (is_null($object)) {
493	2	$object = $this;
494	2	}
495
496	2	$ref = new \ReflectionClass(get_class($object));
497
498	2	return $ref->getShortName();
499		}
500		}
501

jobapis / jobs-common

Branch — v2-beta (bab4d8)

AbstractProvider::getHttpClientOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like