AbstractProvider::handles() - Code Metrics - Inspection of "Replace raw curl with guzzlehttp" - ronanchilvers/deploy - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#24)

by Ronan

created 2019-11-20 22:04 UTC

AbstractProvider::handles() A

↳ Parent: AbstractProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace App\Provider;

use App\Model\Project;
use GuzzleHttp\ClientInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use ReflectionClass;
use Ronanchilvers\Utility\Str;
use RuntimeException;

/**
 * Base provider class
 *
 * @author Ronan Chilvers <[email protected]>
 */
abstract class AbstractProvider
{
    /**
     * @var ClientInterface
     */
    private $client;

    /**
     * @var string
     */
    protected $token;

    /**
     * @var array
     */
    protected $typesHandled = [];

    /**
     * @var string
     */
    protected $headUrl = null;

    /**
     * @var string
     */
    protected $commitUrl = null;

    /**
     * @var string
     */
    protected $downloadUrl = null;

    /**
     * @var string
     */
    protected $configUrl = null;

    /**
     * @var string
     */
    protected $repoUrl = null;

    /**
     * @var string
     */
    protected $branchUrl = null;

    /**
     * @var string
     */
    protected $shaUrl = null;

    /**
     * Class constructor
     *
     * @param string $token
     * @author Ronan Chilvers <[email protected]>
     */
    public function __construct(ClientInterface $client, string $token)
    {
        $this->client = $client;
        $this->token = $token;
    }

    /**
     * @see \App\Provider\ProviderInterface::handles()
     */
    public function handles(Project $project)
    {
        return in_array(
            $project->provider,
            $this->typesHandled
        );
    }

    /**
     * @author Ronan Chilvers <[email protected]>
     */
    public function getLabel()
    {
        $reflection = new ReflectionClass($this);

        return strtolower($reflection->getShortName());
    }

    /**
     * Get a repository link for a given repository
     *
     * @param string $repository
     * @return string
     * @author Ronan Chilvers <[email protected]>
     */
    public function getRepositoryLink(string $repository)
    {
        $params = [
            'repository' => $repository,
        ];

        return Str::moustaches(
            $this->repoUrl,
            $params
        );
    }

    /**
     * Get a link to a repository branch
     *
     * @param string $repository
     * @param string $branch
     * @return string
     * @author Ronan Chilvers <[email protected]>
     */
    public function getBranchLink(string $repository, string $branch)
    {
        $params = [
            'repository' => $repository,
            'branch'     => $branch,
        ];

        return Str::moustaches(
            $this->branchUrl,
            $params
        );
    }

    /**
     * Get a link for a given repository and sha
     *
     * @param string $repository
     * @param string $sha
     * @return string
     * @author Ronan Chilvers <[email protected]>
     */
    public function getShaLink(string $repository, string $sha)
    {
        $params = [
            'repository' => $repository,
            'sha'        => $sha,
        ];

        return Str::moustaches(
            $this->shaUrl,
            $params
        );
    }

    /**
     * Get a curl handle
     *
     * @param string $url
     * @return resource
     * @author Ronan Chilvers <[email protected]>
     */
    protected function getCurlHandle($url)
    {
        if (!$curl = curl_init($url)) {
            throw new RuntimeException('Unable to initialise CURL Github API request');
        }
        curl_setopt_array($curl, [
            CURLOPT_USERAGENT      => 'ronanchilvers/deploy - curl ' . curl_version()['version'],
            CURLOPT_FOLLOWLOCATION => false,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_TIMEOUT        => 5,
        ]);

        return $curl;
    }

    /**
     * Send a GET request to a URL and get back a JSON array
     *
     * @return array
     * @throws RuntimeException
     * @author Ronan Chilvers <[email protected]>
     */
    protected function getJSON($url, array $options = []): array
    {
        $response = $this->get($url, $options);
        $body = $response->getBody();
        if (!$body instanceof StreamInterface) {

            throw new RuntimeException($this->getLabel() . ' : Unable to read response body');
        }
        if (!$data = json_decode($body->getContents(), true)) {
            throw new RuntimeException($this->getLabel() . ' : Invalid JSON response for HEAD information request');
        }

        return $data;
    }

    /**
     * Send a GET request to a URL
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @author Ronan Chilvers <[email protected]>
     */
    protected function get($url, array $options = []): ResponseInterface
    {
        return $this->client()->request(
            'GET',
            $url,
            $options
        );
    }

    /**
     * Get the HTTP client object
     *
     * @return \GuzzleHttp\ClientInterface
     * @author Ronan Chilvers <[email protected]>
     */
    protected function client(): ClientInterface
    {
        return $this->client;
    }
}


1			<?php
2
3			namespace App\Provider;
4
5			use App\Model\Project;
6			use GuzzleHttp\ClientInterface;
7			use Psr\Http\Message\ResponseInterface;
8			use Psr\Http\Message\StreamInterface;
9			use ReflectionClass;
10			use Ronanchilvers\Utility\Str;
11			use RuntimeException;
12
13			/**
14			* Base provider class
15			*
16			* @author Ronan Chilvers <[email protected]>
17			*/
18			abstract class AbstractProvider
19			{
20			/**
21			* @var ClientInterface
22			*/
23			private $client;
24
25			/**
26			* @var string
27			*/
28			protected $token;
29
30			/**
31			* @var array
32			*/
33			protected $typesHandled = [];
34
35			/**
36			* @var string
37			*/
38			protected $headUrl = null;
39
40			/**
41			* @var string
42			*/
43			protected $commitUrl = null;
44
45			/**
46			* @var string
47			*/
48			protected $downloadUrl = null;
49
50			/**
51			* @var string
52			*/
53			protected $configUrl = null;
54
55			/**
56			* @var string
57			*/
58			protected $repoUrl = null;
59
60			/**
61			* @var string
62			*/
63			protected $branchUrl = null;
64
65			/**
66			* @var string
67			*/
68			protected $shaUrl = null;
69
70			/**
71			* Class constructor
72			*
73			* @param string $token
74			* @author Ronan Chilvers <[email protected]>
75			*/
76			public function __construct(ClientInterface $client, string $token)
77			{
78			$this->client = $client;
79			$this->token = $token;
80			}
81
82			/**
83			* @see \App\Provider\ProviderInterface::handles()
84			*/
85			public function handles(Project $project)
86			{
87			return in_array(
88			$project->provider,
89			$this->typesHandled
90			);
91			}
92
93			/**
94			* @author Ronan Chilvers <[email protected]>
95			*/
96			public function getLabel()
97			{
98			$reflection = new ReflectionClass($this);
99
100			return strtolower($reflection->getShortName());
101			}
102
103			/**
104			* Get a repository link for a given repository
105			*
106			* @param string $repository
107			* @return string
108			* @author Ronan Chilvers <[email protected]>
109			*/
110			public function getRepositoryLink(string $repository)
111			{
112			$params = [
113			'repository' => $repository,
114			];
115
116			return Str::moustaches(
117			$this->repoUrl,
118			$params
119			);
120			}
121
122			/**
123			* Get a link to a repository branch
124			*
125			* @param string $repository
126			* @param string $branch
127			* @return string
128			* @author Ronan Chilvers <[email protected]>
129			*/
130			public function getBranchLink(string $repository, string $branch)
131			{
132			$params = [
133			'repository' => $repository,
134			'branch' => $branch,
135			];
136
137			return Str::moustaches(
138			$this->branchUrl,
139			$params
140			);
141			}
142
143			/**
144			* Get a link for a given repository and sha
145			*
146			* @param string $repository
147			* @param string $sha
148			* @return string
149			* @author Ronan Chilvers <[email protected]>
150			*/
151			public function getShaLink(string $repository, string $sha)
152			{
153			$params = [
154			'repository' => $repository,
155			'sha' => $sha,
156			];
157
158			return Str::moustaches(
159			$this->shaUrl,
160			$params
161			);
162			}
163
164			/**
165			* Get a curl handle
166			*
167			* @param string $url
168			* @return resource
169			* @author Ronan Chilvers <[email protected]>
170			*/
171			protected function getCurlHandle($url)
172			{
173			if (!$curl = curl_init($url)) {
174			throw new RuntimeException('Unable to initialise CURL Github API request');
175			}
176			curl_setopt_array($curl, [
177			CURLOPT_USERAGENT => 'ronanchilvers/deploy - curl ' . curl_version()['version'],
178			CURLOPT_FOLLOWLOCATION => false,
179			CURLOPT_RETURNTRANSFER => true,
180			CURLOPT_TIMEOUT => 5,
181			]);
182
183			return $curl;
184			}
185
186			/**
187			* Send a GET request to a URL and get back a JSON array
188			*
189			* @return array
190			* @throws RuntimeException
191			* @author Ronan Chilvers <[email protected]>
192			*/
193			protected function getJSON($url, array $options = []): array
194			{
195			$response = $this->get($url, $options);
196			$body = $response->getBody();
197			if (!$body instanceof StreamInterface) {
			0 ignored issues – show introduced 2019-11-20 22:14 UTC by Report Bug Copy Issue Report `$body` is always a sub-type of `Psr\Http\Message\StreamInterface`. Loading history...
198			throw new RuntimeException($this->getLabel() . ' : Unable to read response body');
199			}
200			if (!$data = json_decode($body->getContents(), true)) {
201			throw new RuntimeException($this->getLabel() . ' : Invalid JSON response for HEAD information request');
202			}
203
204			return $data;
205			}
206
207			/**
208			* Send a GET request to a URL
209			*
210			* @return \Psr\Http\Message\ResponseInterface
211			* @author Ronan Chilvers <[email protected]>
212			*/
213			protected function get($url, array $options = []): ResponseInterface
214			{
215			return $this->client()->request(
216			'GET',
217			$url,
218			$options
219			);
220			}
221
222			/**
223			* Get the HTTP client object
224			*
225			* @return \GuzzleHttp\ClientInterface
226			* @author Ronan Chilvers <[email protected]>
227			*/
228			protected function client(): ClientInterface
229			{
230			return $this->client;
231			}
232			}
233

ronanchilvers / deploy

Pull Request — master (#24)

AbstractProvider::handles() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like