Client::putJSON() - Code Metrics - Inspection of "fix: XML put" - scriptotek/php-alma-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a5934...84f46e )

by Dan Michael O.

created 2016-11-25 20:36 UTC

Client::putJSON() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

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

<?php

namespace Scriptotek\Alma;

use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Exception\RequestException;
use Scriptotek\Alma\Analytics\Analytics;
use Scriptotek\Alma\Bibs\Bibs;
use Scriptotek\Alma\Exception\ClientException;
use Scriptotek\Alma\Exception\SruClientNotSetException;
use Scriptotek\Alma\Users\Users;
use Scriptotek\Sru\Client as SruClient;

/**
 * Alma client.
 */
class Client
{
    public $baseUrl;

    /** @var string Alma zone (institution or network) */
    public $zone;

    /** @var string Alma Developers Network API key for this zone */
    public $key;

    /** @var string Network zone instance */
    public $nz;

    /** @var HttpClient */
    protected $httpClient;

    /** @var SruClient */
    public $sru;

    /** @var Bibs */
    public $bibs;

    /** @var Analytics */
    public $analytics;

    /** @var Users */
    public $users;

    /**
     * Create a new client to connect to a given Alma instance.
     *
     * @param string     $key        API key
     * @param string     $region     Hosted region code, used to build base URL
     * @param string     $zone       Alma zone (Either Zones::INSTITUTION or Zones::NETWORK)
     * @param HttpClient $httpClient
     *
     * @throws \ErrorException
     */
    public function __construct($key = null, $region = 'eu', $zone = Zones::INSTITUTION, HttpClient $httpClient = null)
    {
        $this->key = $key;
        $this->setRegion($region);
        $this->httpClient = $httpClient ?: new HttpClient();
        $this->zone = $zone;
        $this->bibs = new Bibs($this);  // Or do some magic instead?
        $this->analytics = new Analytics($this);  // Or do some magic instead?
        $this->users = new Users($this);  // Or do some magic instead?
        if ($zone == Zones::INSTITUTION) {
            $this->nz = new self(null, $region, Zones::NETWORK, $this->httpClient);

        } elseif ($zone != Zones::NETWORK) {
            throw new ClientException('Invalid zone name.');
        }
    }

    /**
     * Attach an SRU client (so you can search for Bib records).
     *
     * @param SruClient $sru
     */
    public function setSruClient(SruClient $sru)
    {
        $this->sru = $sru;
    }

    /**
     * Assert that an SRU client is connected. Throws SruClientNotSetException if not.
     *
     * @throws SruClientNotSetException
     */
    public function assertHasSruClient()
    {
        if (!isset($this->sru)) {
            throw new SruClientNotSetException();
        }
    }

    /**
     * Set the API key for this Alma instance.
     *
     * @param string $key The API key
     * @return $this
     */
    public function setKey($key)
    {
        $this->key = $key;

        return $this;
    }

    /**
     * Set the Alma region code ('na' for North America, 'eu' for Europe, 'ap' for Asia Pacific).
     *
     * @param $regionCode
     * @return $this
     * @throws \ErrorException
     */
    public function setRegion($regionCode)
    {
        if (!in_array($regionCode, ['na', 'eu', 'ap'])) {
            throw new ClientException('Invalid region code');
        }
        $this->baseUrl = 'https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1';

        return $this;
    }

    /**
     * @param $url
     *
     * @return string
     */
    protected function getFullUrl($url)
    {
        return $this->baseUrl . $url;
    }

    /**
     * @param array $options
     *
     * @return array
     */
    protected function getHttpOptions($options = [])
    {
        if (!$this->key) {
            throw new ClientException('No API key defined for ' . $this->zone);
        }
        $defaultOptions = [
            'headers' => ['Authorization' => 'apikey ' . $this->key],
        ];

        return array_merge_recursive($defaultOptions, $options);
    }

    /**
     * Make a HTTP request.
     *
     * @param string $method
     * @param string $url
     * @param array  $options
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function request($method, $url, $options = [])
    {
        try {
            return $this->httpClient->request($method, $this->getFullUrl($url), $this->getHttpOptions($options));
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            $this->handleError($e->getResponse());
        }
    }

    public function handleError($response)
    {
        $msg = $response->getBody();
        throw new ClientException('Client error ' . $response->getStatusCode() . ': ' . $msg);
    }

    /**
     * Make a GET request, accepting JSON.
     *
     * @param string $url
     * @param array  $query
     *
     * @return mixed
     */
    public function getJSON($url, $query = [])

    {
        $response = $this->request('GET', $url, [
            'query'   => $query,
            'headers' => ['Accept' => 'application/json'],
        ]);

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

    /**
     * Make a GET request, accepting XML.
     *
     * @param string $url
     * @param array  $query
     *
     * @return mixed
     */
    public function getXML($url, $query = [])

    {
        $response = $this->request('GET', $url, [
            'query'   => $query,
            'headers' => ['Accept' => 'application/xml'],
        ]);

        return new QuiteSimpleXMLElement(strval($response->getBody()));
    }

    /**
     * Make a PUT request.
     *
     * @param string $url
     * @param $data
     * @param string $contentType
     * @return bool
     */
    public function put($url, $data, $contentType = 'application/json')
    {
        $response = $this->request('PUT', $url, [
            'body'    => $data,
            'headers' => [
                'Content-Type' => $contentType,
                'Accept'       => $contentType,
            ],
        ]);

        return $response->getStatusCode() == '200';
        // TODO: Check if there are other success codes that can be returned
    }

    /**
     * Make a PUT request, sending JSON data.
     *
     * @param string $url
     * @param $data
     *
     * @return bool
     */
    public function putJSON($url, $data)
    {
        $data = json_encode($data);

        return $this->put($url, $data, 'application/json');
    }

    /**
     * Make a PUT request, sending XML data.
     *
     * @param string $url
     * @param $data
     *
     * @return bool
     */
    public function putXML($url, $data)
    {
        return $this->put($url, $data, 'application/xml');
    }

    /**
     * Get the redirect target location of an URL, or null if not a redirect.
     *
     * @param string $url
     * @param array  $query
     *
     * @return string|null
     */
    public function getRedirectLocation($url, $query = [])
    {
        try {
            $response = $this->httpClient->request('GET', $this->getFullUrl($url), $this->getHttpOptions([
                'query'           => $query,
                'headers'         => ['Accept' => 'application/json'],
                'allow_redirects' => false,
            ]));
        } catch (RequestException $e) {
            // We receive a 400 if the barcode is invalid
            // if ($e->hasResponse()) {

            //     echo $e->getResponse()->getStatusCode() . "\n";

            //     echo $e->getResponse()->getBody() . "\n";

            // }
            return;
        }
        $locations = $response->getHeader('Location');

        return count($locations) ? $locations[0] : null;
    }
}


1		<?php
2
3		namespace Scriptotek\Alma;
4
5		use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
6		use GuzzleHttp\Client as HttpClient;
7		use GuzzleHttp\Exception\RequestException;
8		use Scriptotek\Alma\Analytics\Analytics;
9		use Scriptotek\Alma\Bibs\Bibs;
10		use Scriptotek\Alma\Exception\ClientException;
11		use Scriptotek\Alma\Exception\SruClientNotSetException;
12		use Scriptotek\Alma\Users\Users;
13		use Scriptotek\Sru\Client as SruClient;
14
15		/**
16		* Alma client.
17		*/
18		class Client
19		{
20		public $baseUrl;
21
22		/** @var string Alma zone (institution or network) */
23		public $zone;
24
25		/** @var string Alma Developers Network API key for this zone */
26		public $key;
27
28		/** @var string Network zone instance */
29		public $nz;
30
31		/** @var HttpClient */
32		protected $httpClient;
33
34		/** @var SruClient */
35		public $sru;
36
37		/** @var Bibs */
38		public $bibs;
39
40		/** @var Analytics */
41		public $analytics;
42
43		/** @var Users */
44		public $users;
45
46		/**
47		* Create a new client to connect to a given Alma instance.
48		*
49		* @param string $key API key
50		* @param string $region Hosted region code, used to build base URL
51		* @param string $zone Alma zone (Either Zones::INSTITUTION or Zones::NETWORK)
52		* @param HttpClient $httpClient
53		*
54		* @throws \ErrorException
55		*/
56		public function __construct($key = null, $region = 'eu', $zone = Zones::INSTITUTION, HttpClient $httpClient = null)
57		{
58		$this->key = $key;
59		$this->setRegion($region);
60		$this->httpClient = $httpClient ?: new HttpClient();
61		$this->zone = $zone;
62		$this->bibs = new Bibs($this); // Or do some magic instead?
63		$this->analytics = new Analytics($this); // Or do some magic instead?
64		$this->users = new Users($this); // Or do some magic instead?
65		if ($zone == Zones::INSTITUTION) {
66		$this->nz = new self(null, $region, Zones::NETWORK, $this->httpClient);
		0 ignored issues – show Documentation Bug introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report It seems like `new self(null, $region, ...ORK, $this->httpClient)` of type `object<Scriptotek\Alma\Client>` is incompatible with the declared type `string` of property `$nz`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
67		} elseif ($zone != Zones::NETWORK) {
68		throw new ClientException('Invalid zone name.');
69		}
70		}
71
72		/**
73		* Attach an SRU client (so you can search for Bib records).
74		*
75		* @param SruClient $sru
76		*/
77		public function setSruClient(SruClient $sru)
78		{
79		$this->sru = $sru;
80		}
81
82		/**
83		* Assert that an SRU client is connected. Throws SruClientNotSetException if not.
84		*
85		* @throws SruClientNotSetException
86		*/
87		public function assertHasSruClient()
88		{
89		if (!isset($this->sru)) {
90		throw new SruClientNotSetException();
91		}
92		}
93
94		/**
95		* Set the API key for this Alma instance.
96		*
97		* @param string $key The API key
98		* @return $this
99		*/
100		public function setKey($key)
101		{
102		$this->key = $key;
103
104		return $this;
105		}
106
107		/**
108		* Set the Alma region code ('na' for North America, 'eu' for Europe, 'ap' for Asia Pacific).
109		*
110		* @param $regionCode
111		* @return $this
112		* @throws \ErrorException
113		*/
114		public function setRegion($regionCode)
115		{
116		if (!in_array($regionCode, ['na', 'eu', 'ap'])) {
117		throw new ClientException('Invalid region code');
118		}
119		$this->baseUrl = 'https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1';
120
121		return $this;
122		}
123
124		/**
125		* @param $url
126		*
127		* @return string
128		*/
129		protected function getFullUrl($url)
130		{
131		return $this->baseUrl . $url;
132		}
133
134		/**
135		* @param array $options
136		*
137		* @return array
138		*/
139		protected function getHttpOptions($options = [])
140		{
141		if (!$this->key) {
142		throw new ClientException('No API key defined for ' . $this->zone);
143		}
144		$defaultOptions = [
145		'headers' => ['Authorization' => 'apikey ' . $this->key],
146		];
147
148		return array_merge_recursive($defaultOptions, $options);
149		}
150
151		/**
152		* Make a HTTP request.
153		*
154		* @param string $method
155		* @param string $url
156		* @param array $options
157		*
158		* @return \Psr\Http\Message\ResponseInterface
159		*/
160		public function request($method, $url, $options = [])
161		{
162		try {
163		return $this->httpClient->request($method, $this->getFullUrl($url), $this->getHttpOptions($options));
164		} catch (\GuzzleHttp\Exception\ClientException $e) {
165		$this->handleError($e->getResponse());
166		}
167		}
168
169		public function handleError($response)
170		{
171		$msg = $response->getBody();
172		throw new ClientException('Client error ' . $response->getStatusCode() . ': ' . $msg);
173		}
174
175		/**
176		* Make a GET request, accepting JSON.
177		*
178		* @param string $url
179		* @param array $query
180		*
181		* @return mixed
182		*/
183	View Code Duplication	public function getJSON($url, $query = [])
		0 ignored issues – show Duplication introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
184		{
185		$response = $this->request('GET', $url, [
186		'query' => $query,
187		'headers' => ['Accept' => 'application/json'],
188		]);
189
190		return json_decode($response->getBody());
191		}
192
193		/**
194		* Make a GET request, accepting XML.
195		*
196		* @param string $url
197		* @param array $query
198		*
199		* @return mixed
200		*/
201	View Code Duplication	public function getXML($url, $query = [])
		0 ignored issues – show Duplication introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
202		{
203		$response = $this->request('GET', $url, [
204		'query' => $query,
205		'headers' => ['Accept' => 'application/xml'],
206		]);
207
208		return new QuiteSimpleXMLElement(strval($response->getBody()));
209		}
210
211		/**
212		* Make a PUT request.
213		*
214		* @param string $url
215		* @param $data
216		* @param string $contentType
217		* @return bool
218		*/
219		public function put($url, $data, $contentType = 'application/json')
220		{
221		$response = $this->request('PUT', $url, [
222		'body' => $data,
223		'headers' => [
224		'Content-Type' => $contentType,
225		'Accept' => $contentType,
226		],
227		]);
228
229		return $response->getStatusCode() == '200';
230		// TODO: Check if there are other success codes that can be returned
231		}
232
233		/**
234		* Make a PUT request, sending JSON data.
235		*
236		* @param string $url
237		* @param $data
238		*
239		* @return bool
240		*/
241		public function putJSON($url, $data)
242		{
243		$data = json_encode($data);
244
245		return $this->put($url, $data, 'application/json');
246		}
247
248		/**
249		* Make a PUT request, sending XML data.
250		*
251		* @param string $url
252		* @param $data
253		*
254		* @return bool
255		*/
256		public function putXML($url, $data)
257		{
258		return $this->put($url, $data, 'application/xml');
259		}
260
261		/**
262		* Get the redirect target location of an URL, or null if not a redirect.
263		*
264		* @param string $url
265		* @param array $query
266		*
267		* @return string\|null
268		*/
269		public function getRedirectLocation($url, $query = [])
270		{
271		try {
272		$response = $this->httpClient->request('GET', $this->getFullUrl($url), $this->getHttpOptions([
273		'query' => $query,
274		'headers' => ['Accept' => 'application/json'],
275		'allow_redirects' => false,
276		]));
277		} catch (RequestException $e) {
278		// We receive a 400 if the barcode is invalid
279		// if ($e->hasResponse()) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
280		// echo $e->getResponse()->getStatusCode() . "\n";
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
281		// echo $e->getResponse()->getBody() . "\n";
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
282		// }
283		return;
284		}
285		$locations = $response->getHeader('Location');
286
287		return count($locations) ? $locations[0] : null;
288		}
289		}
290

scriptotek / php-alma-client

Push — master ( 9a5934...84f46e )

Client::putJSON() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like