AuthenticationMiddleware::createOAuthHeaders() - Code Metrics - Inspection of "Splitting up the larger function createHeaders" - cmpayments/guzzle-psp-authentication-middleware - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 76e678...34610a )

by Michel

created 2017-06-01 16:41 UTC

AuthenticationMiddleware::createOAuthHeaders() A

↳ Parent: AuthenticationMiddleware

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace CMPayments\GuzzlePSPAuthenticationMiddleware;

use Psr\Http\Message\RequestInterface;

/**
 * Class ConnectionMiddleware
 *
 * @package CMPayments\GuzzlePSPAuthenticationMiddleware
 */
class AuthenticationMiddleware
{
    /**
     * @var string
     */
    private $key;

    /**
     * @var string
     */
    private $secret;

    /**
     * @var NonceGeneratorInterface
     */
    private $nonceGenerator;

    /**
     * @var TimestampGeneratorInterface
     */
    private $timestampGenerator;

    /**
     * AuthenticationMiddleware constructor.
     *
     * @param string $key    OAuth-Consumer-Key
     * @param string $secret OAuth-Consumer-Secret
     */
    public function __construct($key, $secret)
    {
        $this->key = $key;
        $this->secret = $secret;

        $this->nonceGenerator = new RandomNonceGenerator();
        $this->timestampGenerator = new RandomTimestampGenerator();
    }

    /**
     * Overwrite the nonceGenerator-class. Used for the unit-test
     *
     * @param NonceGeneratorInterface $nonceGenerator
     */
    public function setNonceGenerator($nonceGenerator)
    {
        $this->nonceGenerator = $nonceGenerator;
    }

    /**
     * Overwrite the timestampGenerator-class. Used for the unit-test
     *
     * @param TimestampGeneratorInterface $timestampGenerator
     */
    public function setTimestampGenerator($timestampGenerator)
    {
        $this->timestampGenerator = $timestampGenerator;
    }


    /**
     * This function is called by Guzzle in order to initiate the middleware.
     *
     * @param callable $handler Representation of an outgoing, client-side request.
     *
     * @return \Closure
     */
    public function __invoke($handler)
    {
        return function ($request, array $options) use ($handler) {
            $request = $this->onBefore($request);

            return $handler($request, $options);
        };
    }

    /**
     * Before executing the request, add the extra headers
     *
     * @param RequestInterface $request
     *
     * @return RequestInterface
     */
    private function onBefore(RequestInterface $request)
    {
        $headers = $this->createHeaders($request);
        foreach ($headers as $headerKey => $headerValue) {
            $request = $request->withHeader($headerKey, $headerValue);
        }

        return $request;
    }

    /**
     * Calculate/determine the required headers for the request.
     *
     * @param RequestInterface $request
     *
     * @return string[] The headers for the request

     */
    private function createHeaders(RequestInterface $request)
    {
        $nonce = $this->nonceGenerator->generate();
        $timestamp = $this->timestampGenerator->generate();

        /** @var array $data */
        $data = $this->createDataElement($request, $nonce, $timestamp);

        $payload = $request->getMethod() .
            '&' . rawurlencode((string)$request->getUri()) .
            '&' . implode(rawurlencode('&'), $data);

        $signkey = rawurlencode($this->key) . '&' . rawurlencode($this->secret);
        $hash = rawurlencode(base64_encode(hash_hmac('sha256', $payload, $signkey)));

        /** @var array $oauth_header */
        $oauth_header = $this->createOAuthHeaders($nonce, $timestamp, $hash);

        $header = [];
        $header['Content-type'] = 'application/json';
        $header['Authorization'] = 'OAuth ' . implode(', ', $oauth_header);

        return $header;
    }

    /**
     * Create the data array for the payload
     *
     * @param RequestInterface $request
     * @param string           $nonce The none which is generated
     * @param int              $timestamp The timestamp which is generated
     *
     * @return array The data-array

     */
    private function createDataElement(RequestInterface $request, string $nonce, int $timestamp)
    {
        $data = [];
        if ($request->getMethod() === 'POST') {
            $data[] = rawurlencode($request->getBody()->getContents());
        }
        $data[] = rawurlencode('oauth_consumer_key=' . $this->key);
        $data[] = rawurlencode('oauth_nonce=' . $nonce);
        $data[] = rawurlencode('oauth_signature_method=HMAC-SHA256');
        $data[] = rawurlencode('oauth_timestamp=' . $timestamp);
        $data[] = rawurlencode('oauth_version=1.0');

        return $data;
    }

    /**
     * Create the oAuth headers
     *
     * @param string $nonce The generated nonce
     * @param int    $timestamp The generated timestamp
     * @param string $hash The created hash
     *
     * @return array The headers for the request

     */
    private function createOAuthHeaders(string $nonce, int $timestamp, string $hash)
    {
        $oauth_header = [];
        $oauth_header[] = 'oauth_consumer_key="' . $this->key . '"';
        $oauth_header[] = 'oauth_nonce="' . $nonce . '"';
        $oauth_header[] = 'oauth_signature="' . $hash . '"';
        $oauth_header[] = 'oauth_signature_method="HMAC-SHA256"';
        $oauth_header[] = 'oauth_timestamp="' . $timestamp . '"';
        $oauth_header[] = 'oauth_version="1.0"';
        return $oauth_header;
    }
}


1		<?php
2
3		namespace CMPayments\GuzzlePSPAuthenticationMiddleware;
4
5		use Psr\Http\Message\RequestInterface;
6
7		/**
8		* Class ConnectionMiddleware
9		*
10		* @package CMPayments\GuzzlePSPAuthenticationMiddleware
11		*/
12		class AuthenticationMiddleware
13		{
14		/**
15		* @var string
16		*/
17		private $key;
18
19		/**
20		* @var string
21		*/
22		private $secret;
23
24		/**
25		* @var NonceGeneratorInterface
26		*/
27		private $nonceGenerator;
28
29		/**
30		* @var TimestampGeneratorInterface
31		*/
32		private $timestampGenerator;
33
34		/**
35		* AuthenticationMiddleware constructor.
36		*
37		* @param string $key OAuth-Consumer-Key
38		* @param string $secret OAuth-Consumer-Secret
39		*/
40	2	public function __construct($key, $secret)
41		{
42	2	$this->key = $key;
43	2	$this->secret = $secret;
44
45	2	$this->nonceGenerator = new RandomNonceGenerator();
46	2	$this->timestampGenerator = new RandomTimestampGenerator();
47	2	}
48
49		/**
50		* Overwrite the nonceGenerator-class. Used for the unit-test
51		*
52		* @param NonceGeneratorInterface $nonceGenerator
53		*/
54	2	public function setNonceGenerator($nonceGenerator)
55		{
56	2	$this->nonceGenerator = $nonceGenerator;
57	2	}
58
59		/**
60		* Overwrite the timestampGenerator-class. Used for the unit-test
61		*
62		* @param TimestampGeneratorInterface $timestampGenerator
63		*/
64	2	public function setTimestampGenerator($timestampGenerator)
65		{
66	2	$this->timestampGenerator = $timestampGenerator;
67	2	}
68
69
70		/**
71		* This function is called by Guzzle in order to initiate the middleware.
72		*
73		* @param callable $handler Representation of an outgoing, client-side request.
74		*
75		* @return \Closure
76		*/
77		public function __invoke($handler)
78		{
79	2	return function ($request, array $options) use ($handler) {
80	2	$request = $this->onBefore($request);
81
82	2	return $handler($request, $options);
83	2	};
84		}
85
86		/**
87		* Before executing the request, add the extra headers
88		*
89		* @param RequestInterface $request
90		*
91		* @return RequestInterface
92		*/
93	2	private function onBefore(RequestInterface $request)
94		{
95	2	$headers = $this->createHeaders($request);
96	2	foreach ($headers as $headerKey => $headerValue) {
97	2	$request = $request->withHeader($headerKey, $headerValue);
98	2	}
99
100	2	return $request;
101		}
102
103		/**
104		* Calculate/determine the required headers for the request.
105		*
106		* @param RequestInterface $request
107		*
108		* @return string[] The headers for the request
		0 ignored issues – show Documentation introduced 2017-06-01 16:27 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,string>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
109		*/
110	2	private function createHeaders(RequestInterface $request)
111		{
112	2	$nonce = $this->nonceGenerator->generate();
113	2	$timestamp = $this->timestampGenerator->generate();
114	2
115	2	/** @var array $data */
116	1	$data = $this->createDataElement($request, $nonce, $timestamp);
117	1
118	2	$payload = $request->getMethod() .
119	2	'&' . rawurlencode((string)$request->getUri()) .
120	2	'&' . implode(rawurlencode('&'), $data);
121	2
122	2	$signkey = rawurlencode($this->key) . '&' . rawurlencode($this->secret);
123		$hash = rawurlencode(base64_encode(hash_hmac('sha256', $payload, $signkey)));
124	2
125	2	/** @var array $oauth_header */
126	2	$oauth_header = $this->createOAuthHeaders($nonce, $timestamp, $hash);
127
128	2	$header = [];
129	2	$header['Content-type'] = 'application/json';
130		$header['Authorization'] = 'OAuth ' . implode(', ', $oauth_header);
131	2
132	2	return $header;
133	2	}
134	2
135	2	/**
136	2	* Create the data array for the payload
137	2	*
138		* @param RequestInterface $request
139	2	* @param string $nonce The none which is generated
140	2	* @param int $timestamp The timestamp which is generated
141	2	*
142		* @return array The data-array
		0 ignored issues – show Documentation introduced 2017-06-01 16:43 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `string[]`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
143	2	*/
144		private function createDataElement(RequestInterface $request, string $nonce, int $timestamp)
145		{
146		$data = [];
147		if ($request->getMethod() === 'POST') {
148		$data[] = rawurlencode($request->getBody()->getContents());
149		}
150		$data[] = rawurlencode('oauth_consumer_key=' . $this->key);
151		$data[] = rawurlencode('oauth_nonce=' . $nonce);
152		$data[] = rawurlencode('oauth_signature_method=HMAC-SHA256');
153		$data[] = rawurlencode('oauth_timestamp=' . $timestamp);
154		$data[] = rawurlencode('oauth_version=1.0');
155
156		return $data;
157		}
158
159		/**
160		* Create the oAuth headers
161		*
162		* @param string $nonce The generated nonce
163		* @param int $timestamp The generated timestamp
164		* @param string $hash The created hash
165		*
166		* @return array The headers for the request
		0 ignored issues – show Documentation introduced 2017-06-01 16:43 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `string[]`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
167		*/
168		private function createOAuthHeaders(string $nonce, int $timestamp, string $hash)
169		{
170		$oauth_header = [];
171		$oauth_header[] = 'oauth_consumer_key="' . $this->key . '"';
172		$oauth_header[] = 'oauth_nonce="' . $nonce . '"';
173		$oauth_header[] = 'oauth_signature="' . $hash . '"';
174		$oauth_header[] = 'oauth_signature_method="HMAC-SHA256"';
175		$oauth_header[] = 'oauth_timestamp="' . $timestamp . '"';
176		$oauth_header[] = 'oauth_version="1.0"';
177		return $oauth_header;
178		}
179		}
180

cmpayments / guzzle-psp-authentication-middleware

GitHub Access Token became invalid

Push — master ( 76e678...34610a )

AuthenticationMiddleware::createOAuthHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like