GoogleBooks::__construct() - Code Metrics - Inspection of "Add support for country parameter" - scriptotek/php-google-books - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 881e99...c00d03 )

by Dan Michael O.

created 2016-09-22 22:16 UTC

GoogleBooks::__construct() B

↳ Parent: GoogleBooks

Complexity

Conditions	5
Paths	8

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	15
rs	8.8571
cc	5
eloc	9
nc	8
nop	1

<?php

namespace Scriptotek\GoogleBooks;

use GuzzleHttp\Client;

class GoogleBooks
{
    /**
     * @var string
     */
    protected $baseUri = 'https://www.googleapis.com/books/v1/';

    /**
     * @var integer (Number of results to retrieve per batch, between 1 and 40)
     */
    protected $batchSize = 40;

    /**
     * @var Client
     */
    protected $http;

    /**
     * @var key string API key
     */
    protected $key;

    /**
     * @var country string 2 letter ISO 639 country code.
     *
     * The Books API must honor copyright laws from various countries, and have
     * country-specific rights from publishers. It uses the IP address of the
     * client to geo-locate the user, but if this fails for some reason, it will
     * return 403 Forbidden with reason "unknownLocation". To avoid this, we can
     * manually set the country code.
     */
    protected $country;

    /**
     * @var Volumes
     */
    public $volumes;

    /**
     * @var Bookshelves
     */
    public $bookshelves;

    public function __construct($options = [])
    {
        $this->http = new Client([
            'base_uri' => $this->baseUri,
            'handler' => isset($options['handler']) ? $options['handler'] : null,
        ]);

        $this->key = isset($options['key']) ? $options['key'] : null;
        $this->country = isset($options['country']) ? $options['country'] : null;

        $this->volumes = new Volumes($this);
        $this->bookshelves = new Bookshelves($this);

        $this->batchSize = isset($options['batchSize']) ? $options['batchSize'] : 40;
    }

    protected function raw($endpoint, $params = [], $method='GET')
    {
        if (!is_null($this->key)) {
            $params['key'] = $this->key;
        }
        if (!is_null($this->country)) {
            $params['country'] = $this->country;
        }
        try {
            $response = $this->http->request($method, $endpoint, [
                'query' => $params,
            ]);
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            // 400 level errors
            if ($e->getResponse()->getStatusCode() == 403) {
                $json = json_decode($e->getResponse()->getBody());

                $domain = $json->error->errors[0]->domain;
                $reason = $json->error->errors[0]->reason;
                $message = $json->error->errors[0]->message;

                if ($domain == 'usageLimits') {
                    throw new Exceptions\UsageLimitExceeded($message, $reason);
                }
            }

            throw $e;

        } catch (\GuzzleHttp\Exception\RequestException $e) {
            // networking error (connection timeout, DNS errors, etc.)

            // TODO: sleep and retry

            throw $e;
        }

        return json_decode($response->getBody());
    }

    public function getItem($path)
    {
        return $this->raw($path);
    }

    public function listItems($endpoint, $params = [])
    {
        $params['maxResults'] = $this->batchSize;

        $i = 0;
        while (true) {
            $n = $i % $this->batchSize;
            if ($n == 0) {
                $params['startIndex'] = $i;
                $response = $this->raw($endpoint, $params);
            }
            if (isset($response->totalItems) && $i >= $response->totalItems) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
                return;
            }
            if (!isset($response->items[$n])) {
                return;
            }
            yield $response->items[$n];
            $i++;
        }
    }

}


1			<?php
2
3			namespace Scriptotek\GoogleBooks;
4
5			use GuzzleHttp\Client;
6
7			class GoogleBooks
8			{
9			/**
10			* @var string
11			*/
12			protected $baseUri = 'https://www.googleapis.com/books/v1/';
13
14			/**
15			* @var integer (Number of results to retrieve per batch, between 1 and 40)
16			*/
17			protected $batchSize = 40;
18
19			/**
20			* @var Client
21			*/
22			protected $http;
23
24			/**
25			* @var key string API key
26			*/
27			protected $key;
28
29			/**
30			* @var country string 2 letter ISO 639 country code.
31			*
32			* The Books API must honor copyright laws from various countries, and have
33			* country-specific rights from publishers. It uses the IP address of the
34			* client to geo-locate the user, but if this fails for some reason, it will
35			* return 403 Forbidden with reason "unknownLocation". To avoid this, we can
36			* manually set the country code.
37			*/
38			protected $country;
39
40			/**
41			* @var Volumes
42			*/
43			public $volumes;
44
45			/**
46			* @var Bookshelves
47			*/
48			public $bookshelves;
49
50			public function __construct($options = [])
51			{
52			$this->http = new Client([
53			'base_uri' => $this->baseUri,
54			'handler' => isset($options['handler']) ? $options['handler'] : null,
55			]);
56
57			$this->key = isset($options['key']) ? $options['key'] : null;
58			$this->country = isset($options['country']) ? $options['country'] : null;
59
60			$this->volumes = new Volumes($this);
61			$this->bookshelves = new Bookshelves($this);
62
63			$this->batchSize = isset($options['batchSize']) ? $options['batchSize'] : 40;
64			}
65
66			protected function raw($endpoint, $params = [], $method='GET')
67			{
68			if (!is_null($this->key)) {
69			$params['key'] = $this->key;
70			}
71			if (!is_null($this->country)) {
72			$params['country'] = $this->country;
73			}
74			try {
75			$response = $this->http->request($method, $endpoint, [
76			'query' => $params,
77			]);
78			} catch (\GuzzleHttp\Exception\ClientException $e) {
79			// 400 level errors
80			if ($e->getResponse()->getStatusCode() == 403) {
81			$json = json_decode($e->getResponse()->getBody());
82
83			$domain = $json->error->errors[0]->domain;
84			$reason = $json->error->errors[0]->reason;
85			$message = $json->error->errors[0]->message;
86
87			if ($domain == 'usageLimits') {
88			throw new Exceptions\UsageLimitExceeded($message, $reason);
89			}
90			}
91
92			throw $e;
93
94			} catch (\GuzzleHttp\Exception\RequestException $e) {
95			// networking error (connection timeout, DNS errors, etc.)
96
97			// TODO: sleep and retry
98
99			throw $e;
100			}
101
102			return json_decode($response->getBody());
103			}
104
105			public function getItem($path)
106			{
107			return $this->raw($path);
108			}
109
110			public function listItems($endpoint, $params = [])
111			{
112			$params['maxResults'] = $this->batchSize;
113
114			$i = 0;
115			while (true) {
116			$n = $i % $this->batchSize;
117			if ($n == 0) {
118			$params['startIndex'] = $i;
119			$response = $this->raw($endpoint, $params);
120			}
121			if (isset($response->totalItems) && $i >= $response->totalItems) {
			0 ignored issues – show Bug introduced 2016-09-20 21:38 UTC by Report Bug Copy Issue Report The variable `$response` 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...
122			return;
123			}
124			if (!isset($response->items[$n])) {
125			return;
126			}
127			yield $response->items[$n];
128			$i++;
129			}
130			}
131
132			}
133

scriptotek / php-google-books

Push — master ( 881e99...c00d03 )

GoogleBooks::__construct() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like