Product::getBaseUri() - Code Metrics - Inspection of "Bump to Laravel v10" - mtvbrianking/laravel-mtn-momo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 015cf1...83dbe9 )

by Brian

created 2023-02-11 15:56 UTC

Product::getBaseUri() A

↳ Parent: Product

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Product.
 */

namespace Bmatovu\MtnMomo\Products;

use Bmatovu\MtnMomo\Repositories\TokenRepository;
use Bmatovu\OAuthNegotiator\GrantTypes\ClientCredentials;
use Bmatovu\OAuthNegotiator\OAuth2Middleware;
use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use Illuminate\Container\Container;
use Illuminate\Contracts\Config\Repository;

/**
 * Generic product/service.
 */
abstract class Product
{
    /**
     * Product.
     *
     * @var string
     */
    const PRODUCT = null;

    /**
     * Configuration.
     *
     * @var \Illuminate\Contracts\Config\Repository
     */
    protected $config;

    /**
     * HTTP client.
     *
     * @var \GuzzleHttp\ClientInterface
     */
    protected $client;

    /**
     * Base URI.
     *
     * @var string
     */
    protected $baseUri;

    /**
     * Token URI.
     *
     * @var string
     */
    protected $tokenUri;

    /**
     * Subscription key.
     *
     * @var string
     */
    protected $subscriptionKey;

    /**
     * Client ID.
     *
     * @var string
     */
    protected $clientId;

    /**
     * Client secret.
     *
     * @var string
     */
    protected $clientSecret;

    /**
     * Client callback URI.
     *
     * @var string
     */
    protected $clientCallbackUri;

    /**
     * Currency.
     *
     * @var string
     */
    protected $currency;

    /**
     * Environment.
     *
     * @var string
     */
    protected $environment;

    /**
     * Party ID type.
     *
     * @var string
     */
    protected $partyIdType;

    /**
     * Log file.
     *
     * @var string
     */
    protected $logFile;

    /**
     * @return \GuzzleHttp\ClientInterface
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * @param \GuzzleHttp\ClientInterface $client
     */
    public function setClient($client)
    {
        $this->client = $client;
    }

    /**
     * @return string
     */
    public function getBaseUri()
    {
        return $this->baseUri;
    }

    /**
     * @param string $baseUri
     */
    public function setBaseUri($baseUri)
    {
        $this->baseUri = $baseUri;
    }

    /**
     * @return string
     */
    public function getTokenUri()
    {
        return $this->tokenUri;
    }

    /**
     * @param string $tokenUri
     */
    public function setTokenUri($tokenUri)
    {
        $this->tokenUri = $tokenUri;
    }

    /**
     * @return string
     */
    public function getSubscriptionKey()
    {
        return $this->subscriptionKey;
    }

    /**
     * @param string $subscriptionKey
     */
    public function setSubscriptionKey($subscriptionKey)
    {
        $this->subscriptionKey = $subscriptionKey;
    }

    /**
     * @return string
     */
    public function getClientId()
    {
        return $this->clientId;
    }

    /**
     * @param string $clientId
     */
    public function setClientId($clientId)
    {
        $this->clientId = $clientId;
    }

    /**
     * @return string
     */
    public function getClientSecret()
    {
        return $this->clientSecret;
    }

    /**
     * @param string $clientSecret
     */
    public function setClientSecret($clientSecret)
    {
        $this->clientSecret = $clientSecret;
    }

    /**
     * @return string
     */
    public function getClientCallbackUri()
    {
        return $this->clientCallbackUri;
    }

    /**
     * @param string $clientCallbackUri
     */
    public function setClientCallbackUri($clientCallbackUri)
    {
        $this->clientCallbackUri = $clientCallbackUri;
    }

    /**
     * @return string
     */
    public function getCurrency()
    {
        return $this->currency;
    }

    /**
     * @param string $currency
     */
    public function setCurrency($currency)
    {
        $this->currency = $currency;
    }

    /**
     * @return string
     */
    public function getEnvironment()
    {
        return $this->environment;
    }

    /**
     * @param string $environment
     */
    public function setEnvironment($environment)
    {
        $this->environment = $environment;
    }

    /**
     * @return string
     */
    public function getPartyIdType()
    {
        return $this->partyIdType;
    }

    /**
     * @param string $partyIdType
     */
    public function setPartyIdType($partyIdType)
    {
        $this->partyIdType = $partyIdType;
    }

    /**
     * @return string
     */
    public function getLogFile()
    {
        return $this->logFile;
    }

    /**
     * @param string $logFile
     */
    public function setLogFile($logFile)
    {
        $this->logFile = $logFile;
    }

    /**
     * Constructor.
     *
     * @param array $headers
     * @param array $middleware
     * @param \GuzzleHttp\ClientInterface $client
     *
     * @throws \Exception
     */
    public function __construct($headers = [], $middleware = [], ClientInterface $client = null)
    {
        $this->config = Container::getInstance()->make(Repository::class);

        // Set defaults.
        $this->setConfigurations();

        if ($client) {
            $this->client = $client;

            return;
        }

        // Guzzle http request headers.
        $headers = array_merge([
            'Accept' => 'application/json',
            'Content-Type' => 'application/json',
            'Ocp-Apim-Subscription-Key' => $this->subscriptionKey,
        ], $headers);

        // Guzzle http client middleware.

        $handlerStack = HandlerStack::create();

        foreach ($middleware as $mw) {
            $handlerStack->push($mw);
        }

        $handlerStack->push($this->getAuthBroker($headers));

        $handlerStack = append_log_middleware($handlerStack);

        $options = array_merge([
            'handler' => $handlerStack,
            'base_uri' => $this->baseUri,
            'headers' => $headers,
        ], $this->config->get('mtn-momo.guzzle.options'));

        // Set http client.
        $this->client = new Client($options);
    }

    /**
     * Request access token.
     *
     * @return array
     */
    abstract public function getToken();

    /**
     * Setup default configurations.
     *
     * @uses \Illuminate\Contracts\Config\Repository
     *
     * @return void
     */
    private function setConfigurations()
    {
        $this->baseUri = $this->config->get('mtn-momo.api.base_uri');
        $this->currency = $this->config->get('mtn-momo.currency');
        $this->environment = $this->config->get('mtn-momo.environment');
        $this->logFile = $this->config->get('mtn-momo.log');
    }

    /**
     * Get authentication broker.
     *
     * @link https://momodeveloper.mtn.com/api-documentation/api-description/#oauth-2-0 Documentation
     *
     * @param  array $headers HTTP request headers
     *
     * @throws \Exception
     *
     * @return \Bmatovu\OAuthNegotiator\OAuth2Middleware
     */
    protected function getAuthBroker($headers)
    {
        $handlerStack = HandlerStack::create();

        $handlerStack = append_log_middleware($handlerStack);

        $options = array_merge([
            'base_uri' => $this->baseUri,
            'handler' => $handlerStack,
            'headers' => $headers,
            'json' => [
                'body',
            ],
        ], $this->config->get('mtn-momo.guzzle.options'));

        // Authorization client - this is used to request OAuth access tokens
        $client = new Client($options);

        $config = [
            'client_id' => $this->clientId,
            'client_secret' => $this->clientSecret,
            'token_uri' => $this->tokenUri,
        ];

        // This grant type is used to get a new Access Token and,
        // Refresh Token when no valid Access Token or Refresh Token is available
        $clientCredGrant = new ClientCredentials($client, $config);

        // Create token repository
        $tokenRepo = new TokenRepository(static::PRODUCT);

        // Tell the middleware to use both the client and refresh token grants
        return new OAuth2Middleware($clientCredGrant, null, $tokenRepo);
    }
}


1		<?php
2		/**
3		* Product.
4		*/
5
6		namespace Bmatovu\MtnMomo\Products;
7
8		use Bmatovu\MtnMomo\Repositories\TokenRepository;
9		use Bmatovu\OAuthNegotiator\GrantTypes\ClientCredentials;
10		use Bmatovu\OAuthNegotiator\OAuth2Middleware;
11		use GuzzleHttp\Client;
12		use GuzzleHttp\ClientInterface;
13		use GuzzleHttp\HandlerStack;
14		use GuzzleHttp\Middleware;
15		use Illuminate\Container\Container;
16		use Illuminate\Contracts\Config\Repository;
17
18		/**
19		* Generic product/service.
20		*/
21		abstract class Product
22		{
23		/**
24		* Product.
25		*
26		* @var string
27		*/
28		const PRODUCT = null;
29
30		/**
31		* Configuration.
32		*
33		* @var \Illuminate\Contracts\Config\Repository
34		*/
35		protected $config;
36
37		/**
38		* HTTP client.
39		*
40		* @var \GuzzleHttp\ClientInterface
41		*/
42		protected $client;
43
44		/**
45		* Base URI.
46		*
47		* @var string
48		*/
49		protected $baseUri;
50
51		/**
52		* Token URI.
53		*
54		* @var string
55		*/
56		protected $tokenUri;
57
58		/**
59		* Subscription key.
60		*
61		* @var string
62		*/
63		protected $subscriptionKey;
64
65		/**
66		* Client ID.
67		*
68		* @var string
69		*/
70		protected $clientId;
71
72		/**
73		* Client secret.
74		*
75		* @var string
76		*/
77		protected $clientSecret;
78
79		/**
80		* Client callback URI.
81		*
82		* @var string
83		*/
84		protected $clientCallbackUri;
85
86		/**
87		* Currency.
88		*
89		* @var string
90		*/
91		protected $currency;
92
93		/**
94		* Environment.
95		*
96		* @var string
97		*/
98		protected $environment;
99
100		/**
101		* Party ID type.
102		*
103		* @var string
104		*/
105		protected $partyIdType;
106
107		/**
108		* Log file.
109		*
110		* @var string
111		*/
112		protected $logFile;
113
114		/**
115		* @return \GuzzleHttp\ClientInterface
116		*/
117		public function getClient()
118		{
119		return $this->client;
120		}
121
122		/**
123		* @param \GuzzleHttp\ClientInterface $client
124		*/
125		public function setClient($client)
126		{
127		$this->client = $client;
128		}
129
130		/**
131		* @return string
132		*/
133		public function getBaseUri()
134		{
135		return $this->baseUri;
136		}
137
138		/**
139		* @param string $baseUri
140		*/
141		public function setBaseUri($baseUri)
142		{
143		$this->baseUri = $baseUri;
144		}
145
146		/**
147		* @return string
148		*/
149		public function getTokenUri()
150		{
151		return $this->tokenUri;
152		}
153
154		/**
155		* @param string $tokenUri
156		*/
157		public function setTokenUri($tokenUri)
158		{
159		$this->tokenUri = $tokenUri;
160		}
161
162		/**
163		* @return string
164		*/
165		public function getSubscriptionKey()
166		{
167		return $this->subscriptionKey;
168		}
169
170		/**
171		* @param string $subscriptionKey
172		*/
173		public function setSubscriptionKey($subscriptionKey)
174		{
175		$this->subscriptionKey = $subscriptionKey;
176		}
177
178		/**
179		* @return string
180		*/
181		public function getClientId()
182		{
183		return $this->clientId;
184		}
185
186		/**
187		* @param string $clientId
188		*/
189		public function setClientId($clientId)
190		{
191		$this->clientId = $clientId;
192		}
193
194		/**
195		* @return string
196		*/
197		public function getClientSecret()
198		{
199		return $this->clientSecret;
200		}
201
202		/**
203		* @param string $clientSecret
204		*/
205		public function setClientSecret($clientSecret)
206		{
207		$this->clientSecret = $clientSecret;
208		}
209
210		/**
211		* @return string
212		*/
213		public function getClientCallbackUri()
214		{
215		return $this->clientCallbackUri;
216		}
217
218		/**
219		* @param string $clientCallbackUri
220		*/
221		public function setClientCallbackUri($clientCallbackUri)
222		{
223		$this->clientCallbackUri = $clientCallbackUri;
224		}
225
226		/**
227		* @return string
228		*/
229		public function getCurrency()
230		{
231		return $this->currency;
232		}
233
234		/**
235		* @param string $currency
236		*/
237		public function setCurrency($currency)
238		{
239		$this->currency = $currency;
240		}
241
242		/**
243		* @return string
244		*/
245		public function getEnvironment()
246		{
247		return $this->environment;
248		}
249
250		/**
251		* @param string $environment
252		*/
253		public function setEnvironment($environment)
254		{
255		$this->environment = $environment;
256		}
257
258		/**
259		* @return string
260		*/
261		public function getPartyIdType()
262		{
263		return $this->partyIdType;
264		}
265
266		/**
267		* @param string $partyIdType
268		*/
269		public function setPartyIdType($partyIdType)
270		{
271		$this->partyIdType = $partyIdType;
272		}
273
274		/**
275		* @return string
276		*/
277		public function getLogFile()
278		{
279		return $this->logFile;
280		}
281
282		/**
283		* @param string $logFile
284		*/
285		public function setLogFile($logFile)
286		{
287		$this->logFile = $logFile;
288		}
289
290		/**
291		* Constructor.
292		*
293		* @param array $headers
294		* @param array $middleware
295		* @param \GuzzleHttp\ClientInterface $client
296		*
297		* @throws \Exception
298		*/
299	25	public function __construct($headers = [], $middleware = [], ClientInterface $client = null)
300		{
301	25	$this->config = Container::getInstance()->make(Repository::class);
302
303		// Set defaults.
304	25	$this->setConfigurations();
305
306	25	if ($client) {
307	22	$this->client = $client;
308
309	22	return;
310		}
311
312		// Guzzle http request headers.
313	3	$headers = array_merge([
314	3	'Accept' => 'application/json',
315	3	'Content-Type' => 'application/json',
316	3	'Ocp-Apim-Subscription-Key' => $this->subscriptionKey,
317	3	], $headers);
318
319		// Guzzle http client middleware.
320
321	3	$handlerStack = HandlerStack::create();
322
323	3	foreach ($middleware as $mw) {
324		$handlerStack->push($mw);
325		}
326
327	3	$handlerStack->push($this->getAuthBroker($headers));
328
329	3	$handlerStack = append_log_middleware($handlerStack);
330
331	3	$options = array_merge([
332	3	'handler' => $handlerStack,
333	3	'base_uri' => $this->baseUri,
334	3	'headers' => $headers,
335	3	], $this->config->get('mtn-momo.guzzle.options'));
336
337		// Set http client.
338	3	$this->client = new Client($options);
339		}
340
341		/**
342		* Request access token.
343		*
344		* @return array
345		*/
346		abstract public function getToken();
347
348		/**
349		* Setup default configurations.
350		*
351		* @uses \Illuminate\Contracts\Config\Repository
352		*
353		* @return void
354		*/
355	25	private function setConfigurations()
356		{
357	25	$this->baseUri = $this->config->get('mtn-momo.api.base_uri');
358	25	$this->currency = $this->config->get('mtn-momo.currency');
359	25	$this->environment = $this->config->get('mtn-momo.environment');
360	25	$this->logFile = $this->config->get('mtn-momo.log');
361		}
362
363		/**
364		* Get authentication broker.
365		*
366		* @link https://momodeveloper.mtn.com/api-documentation/api-description/#oauth-2-0 Documentation
367		*
368		* @param array $headers HTTP request headers
369		*
370		* @throws \Exception
371		*
372		* @return \Bmatovu\OAuthNegotiator\OAuth2Middleware
373		*/
374	3	protected function getAuthBroker($headers)
375		{
376	3	$handlerStack = HandlerStack::create();
377
378	3	$handlerStack = append_log_middleware($handlerStack);
379
380	3	$options = array_merge([
381	3	'base_uri' => $this->baseUri,
382	3	'handler' => $handlerStack,
383	3	'headers' => $headers,
384	3	'json' => [
385	3	'body',
386	3	],
387	3	], $this->config->get('mtn-momo.guzzle.options'));
388
389		// Authorization client - this is used to request OAuth access tokens
390	3	$client = new Client($options);
391
392	3	$config = [
393	3	'client_id' => $this->clientId,
394	3	'client_secret' => $this->clientSecret,
395	3	'token_uri' => $this->tokenUri,
396	3	];
397
398		// This grant type is used to get a new Access Token and,
399		// Refresh Token when no valid Access Token or Refresh Token is available
400	3	$clientCredGrant = new ClientCredentials($client, $config);
401
402		// Create token repository
403	3	$tokenRepo = new TokenRepository(static::PRODUCT);
404
405		// Tell the middleware to use both the client and refresh token grants
406	3	return new OAuth2Middleware($clientCredGrant, null, $tokenRepo);
407		}
408		}
409

mtvbrianking / laravel-mtn-momo

Push — master ( 015cf1...83dbe9 )

Product::getBaseUri() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like