joomla-framework / oauth1

src/Client.php

Doc Comments +4 added lines, -4 removed lines

@@ -58,7 +58,7 @@ 
 	/**
 	 * Constructor.
 	 *
-	 * @param   array                   $options      OAuth1 Client options array.
+	 * @param   \Joomla\Registry\Registry                   $options      OAuth1 Client options array.
 	 * @param   Http                    $client       The HTTP client object.
 	 * @param   Input                   $input        The input object
 	 * @param   AbstractWebApplication  $application  The application object
@@ -249,7 +249,7 @@ 
 	 * @param   mixed   $data        The POST request data.
 	 * @param   array   $headers     An array of name-value pairs to include in the header of the request
 	 *
-	 * @return  object  The Response object.
+	 * @return  \Joomla\Http\Response  The Response object.
 	 *
 	 * @since   1.0
 	 * @throws  \DomainException
@@ -318,7 +318,7 @@ 
 	 * Method to validate a response.
 	 *
 	 * @param   string    $url       The request URL.
-	 * @param   Response  $response  The response to validate.
+	 * @param   \Joomla\Http\Response  $response  The response to validate.
 	 *
 	 * @return  void
 	 *
@@ -565,7 +565,7 @@ 
 	 * Set an option for the OAuth1 Client instance.
 	 *
 	 * @param   string  $key    The name of the option to set
-	 * @param   mixed   $value  The option value to set
+	 * @param   string   $value  The option value to set
 	 *
 	 * @return  Client  This object for method chaining
 	 *

Spacing +10 added lines, -10 removed lines

@@ -197,12 +197,12 @@ 
 	 */
 	private function authorise()
 	{
-		$url = $this->getOption('authoriseURL') . '?oauth_token=' . $this->token['key'];
+		$url = $this->getOption('authoriseURL').'?oauth_token='.$this->token['key'];
 
 		if ($this->getOption('scope'))
 		{
 			$scope = \is_array($this->getOption('scope')) ? implode(' ', $this->getOption('scope')) : $this->getOption('scope');
-			$url .= '&scope=' . urlencode($scope);
+			$url .= '&scope='.urlencode($scope);
 		}
 
 		if ($this->getOption('sendheaders'))
@@ -343,11 +343,11 @@ 
 		{
 			if (!strcmp($header, 'OAuth '))
 			{
-				$header .= $key . '="' . $this->safeEncode($value) . '"';
+				$header .= $key.'="'.$this->safeEncode($value).'"';
 			}
 			else
 			{
-				$header .= ', ' . $key . '="' . $value . '"';
+				$header .= ', '.$key.'="'.$value.'"';
 			}
 		}
 
@@ -374,11 +374,11 @@ 
 				{
 					if (strpos($url, '?') === false)
 					{
-						$url .= '?' . $key . '=' . $v;
+						$url .= '?'.$key.'='.$v;
 					}
 					else
 					{
-						$url .= '&' . $key . '=' . $v;
+						$url .= '&'.$key.'='.$v;
 					}
 				}
 			}
@@ -391,11 +391,11 @@ 
 
 				if (strpos($url, '?') === false)
 				{
-					$url .= '?' . $key . '=' . $value;
+					$url .= '?'.$key.'='.$value;
 				}
 				else
 				{
-					$url .= '&' . $key . '=' . $value;
+					$url .= '&'.$key.'='.$value;
 				}
 			}
 		}
@@ -520,7 +520,7 @@ 
 		$rand = random_bytes(16);
 
 		// The md5s look nicer than numbers.
-		return md5($mt . $rand);
+		return md5($mt.$rand);
 	}
 
 	/**
@@ -532,7 +532,7 @@ 
 	 */
 	private function prepareSigningKey()
 	{
-		return $this->safeEncode($this->getOption('consumer_secret')) . '&' . $this->safeEncode(($this->token) ? $this->token['secret'] : '');
+		return $this->safeEncode($this->getOption('consumer_secret')).'&'.$this->safeEncode(($this->token) ? $this->token['secret'] : '');
 	}
 
 	/**

Braces +9 added lines, -18 removed lines

@@ -93,8 +93,7 @@ 
 			if ($response)
 			{
 				return $this->token;
-			}
-			else
+			} else
 			{
 				$this->token = null;
 			}
@@ -104,8 +103,7 @@ 
 		if (strcmp($this->version, '1.0a') === 0)
 		{
 			$verifier = $this->input->get('oauth_verifier');
-		}
-		else
+		} else
 		{
 			$verifier = $this->input->get('oauth_token');
 		}
@@ -163,8 +161,7 @@ 
 			$parameters = array(
 				'oauth_callback' => $this->getOption('callback'),
 			);
-		}
-		else
+		} else
 		{
 			$parameters = array();
 		}
@@ -270,8 +267,7 @@ 
 		if (isset($headers['Content-Type']) && strpos($headers['Content-Type'], 'multipart/form-data') !== false || !\is_array($data))
 		{
 			$oauthHeaders = $parameters;
-		}
-		else
+		} else
 		{
 			// Use all parameters for the signature.
 			$oauthHeaders = array_merge($parameters, $data);
@@ -344,8 +340,7 @@ 
 			if (!strcmp($header, 'OAuth '))
 			{
 				$header .= $key . '="' . $this->safeEncode($value) . '"';
-			}
-			else
+			} else
 			{
 				$header .= ', ' . $key . '="' . $value . '"';
 			}
@@ -375,14 +370,12 @@ 
 					if (strpos($url, '?') === false)
 					{
 						$url .= '?' . $key . '=' . $v;
-					}
-					else
+					} else
 					{
 						$url .= '&' . $key . '=' . $v;
 					}
 				}
-			}
-			else
+			} else
 			{
 				if (strpos($value, ' ') !== false)
 				{
@@ -392,8 +385,7 @@ 
 				if (strpos($url, '?') === false)
 				{
 					$url .= '?' . $key . '=' . $value;
-				}
-				else
+				} else
 				{
 					$url .= '&' . $key . '=' . $value;
 				}
@@ -456,8 +448,7 @@ 
 					$v    = $this->safeEncode($v);
 					$kv[] = "{$key}={$v}";
 				}
-			}
-			else
+			} else
 			{
 				$value = $this->safeEncode($value);
 				$kv[]  = "{$key}={$value}";

Tests/stubs/ClientInspector.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
 	/**
 	 * Mimic verifing credentials.
 	 *
-	 * @return void
+	 * @return boolean
 	 *
 	 * @since 1.0
 	 */

Tests/ClientTest.php

Indentation +12 added lines, -12 removed lines

@@ -99,12 +99,12 @@ 
 	}
 
 	/**
-	* Provides test data.
-	*
-	* @return array
-	*
-	* @since 1.0
-	*/
+	 * Provides test data.
+	 *
+	 * @return array
+	 *
+	 * @since 1.0
+	 */
 	public function seedAuthenticate()
 	{
 		// Token, fail and oauth version.
@@ -258,12 +258,12 @@ 
 	}
 
 	/**
-	* Provides test data.
-	*
-	* @return array
-	*
-	* @since  1.0
-	*/
+	 * Provides test data.
+	 *
+	 * @return array
+	 *
+	 * @since  1.0
+	 */
 	public function seedOauthRequest()
 	{
 		// Method

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 use Joomla\Test\TestHelper;
 use PHPUnit\Framework\TestCase;
 
-require_once __DIR__ . '/stubs/ClientInspector.php';
+require_once __DIR__.'/stubs/ClientInspector.php';
 
 /**
  * Test class for OAuth1 Client.

Braces +4 added lines, -8 removed lines

@@ -134,8 +134,7 @@ 
 			$this->object->setToken($token);
 			$result = $this->object->authenticate();
 			$this->assertEquals($result, $token);
-		}
-		else
+		} else
 		{
 			$this->object->setOption('requestTokenURL', 'https://example.com/request_token');
 			$this->object->setOption('authoriseURL', 'https://example.com/authorize');
@@ -173,8 +172,7 @@ 
 			{
 				TestHelper::setValue($this->object, 'version', $version);
 				$data = array('oauth_verifier' => 'verifier', 'oauth_token' => 'token');
-			}
-			else
+			} else
 			{
 				TestHelper::setValue($this->object, 'version', $version);
 				$data = array('oauth_token' => 'token');
@@ -203,8 +201,7 @@ 
 				if (method_exists($this, 'expectException'))
 				{
 					$this->expectException('DomainException');
-				}
-				else
+				} else
 				{
 					$this->setExpectedException('DomainException');
 				}
@@ -309,8 +306,7 @@ 
 				$this->object->oauthRequest('www.example.com', $method, array('oauth_token' => '1235'), $data, array('Content-Type' => 'multipart/form-data')),
 				$this->equalTo($returnData)
 				);
-		}
-		else
+		} else
 		{
 			$this->client->expects($this->at(0))
 				->method($method)