Extracted the endpoint handling to the common PHP Url Util project.

Author: Martin Brecht-Precht

README.md

@@ -216,18 +216,23 @@ $message->addHeader(new Header('Custom-Header', array('CustomHeaderValue')));
 $message->addAdditionalHeader(new Header('Custom-Header', array('AnotherCustomHeaderValue')));
 ```
 
-#### Configuring a Request instance and perform the HTTP request
+#### Configuring an endpoints URL, build the Request instance and perform the HTTP request
+
+For more information about the usage of the URL object please take a look at the [PHP URL project](https://github.com/markenwerk/php-url-util).
 
 ```{php}
 use BasicHttpClient\Request\Authentication\BasicAuthentication;
 use BasicHttpClient\Request\Request;
+use Url\Url;
+
+// Setting up the endpoints URL
+$url = new Url('https://john:[email protected]:443/path/to/resource?arg1=123#fragment');
 
 // Configuring and performing a Request
 $request = new Request();
 $request
 	->setUserAgent('PHP Basic HTTP Client Test 1.0')
-	->setEndpoint('https://yourapihere-com-98yq3775xff0.runscope.net/')
-	->setPort(443)
+	->setUrl($url)
 	->addAuthentication(new BasicAuthentication('username', 'password'))
 	->setQueryParameters(
 		array(
@@ -244,7 +249,7 @@ $request
 The resulting HTTP request would be the following.
 
 ```{http}
-POST /?paramName1=paramValue1&paramName2=paramValue2 HTTP/1.1
+POST /?arg1=123#fragment HTTP/1.1
 Host: yourapihere-com-98yq3775xff0.runscope.net
 Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
 User-Agent: PHP Basic HTTP Client Test 1.0

composer.json

@@ -27,6 +27,7 @@
   "require": {
     "php": ">=5.3",
     "lib-curl": "*",
+    "markenwerk/url-util": "~1.0",
     "markenwerk/common-exceptions": "~2.0"
   },
   "require-dev": {

detaild.php

@@ -9,6 +9,7 @@
 use BasicHttpClient\Request\Message\Message;
 use BasicHttpClient\Request\Request;
 use BasicHttpClient\Request\Transport\HttpsTransport;
+use Url\Url;
 
 require_once('vendor/autoload.php');
 
@@ -38,29 +39,22 @@
 
 $message = new Message();
 $message
-	->addHeader(new Header('Content-Type', array('application/json')))
-	->addHeader(new Header('Accept', array('application/json', 'text/*')))
-	->addHeader(new Header('Runscope-Bucket-Auth', array('7a64dde7-74d5-4eed-b170-a2ab406eff08')))
+	->setHeader(new Header('Content-Type', array('application/json')))
+	->setHeader(new Header('Accept', array('application/json', 'text/*')))
+	->setHeader(new Header('Runscope-Bucket-Auth', array('7a64dde7-74d5-4eed-b170-a2ab406eff08')))
 	->addCookie(new Cookie('PHPSESSID', '<MY_SESSION_ID>'))
 	->setBody($messageBody);
 
-$message->addHeader(new Header('Custom-Header', array('CustomHeaderValue')));
-$message->addAdditionalHeader(new Header('Custom-Header', array('AnotherCustomHeaderValue')));
+$message->setHeader(new Header('Custom-Header', array('CustomHeaderValue')));
+$message->addHeader(new Header('Custom-Header', array('AnotherCustomHeaderValue')));
+
+$url = new Url('https://john:[email protected]:443/path/to/resource?arg1=123#fragment');
 
 $request = new Request();
 $request
 	->setUserAgent('PHP Basic HTTP Client Test 1.0')
-	->setEndpoint('https://yourapihere-com-98yq3775xff0.runscope.net/')
-	->setPort(443)
+	->setUrl($url)
 	->addAuthentication(new BasicAuthentication('username', 'password'))
-	->setQueryParameters(
-		array(
-			'paramName1' => 'paramValue1',
-			'paramName2' => 'paramValue2',
-			'paramName3' => true,
-			'paramName4' => 42,
-		)
-	)
 	->setMethod(Request::REQUEST_METHOD_POST)
 	->setTransport($transport)
 	->setMessage($message)
@@ -85,5 +79,5 @@
 echo print_r($request->getEffectiveEndpoint(), true) . PHP_EOL;
 echo print_r($request->getEffectiveStatus(), true) . PHP_EOL;
 echo print_r($request->getEffectiveRawHeader(), true) . PHP_EOL;
-echo print_r($request->getEffectiveHeaders(), true) . PHP_EOL.PHP_EOL;
+echo print_r($request->getEffectiveHeaders(), true) . PHP_EOL . PHP_EOL;
 

src/BasicHttpClient.php

@@ -9,7 +9,7 @@
 use BasicHttpClient\Request\Transport\HttpsTransport;
 use BasicHttpClient\Request\Transport\HttpTransport;
 use BasicHttpClient\Response\ResponseInterface;
-use BasicHttpClient\Util\UrlUtil;
+use Url\Url;
 
 /**
  * Class BasicHttpClient
@@ -35,16 +35,16 @@ public function __construct($endpoint)
 			$argumentType = (is_object($endpoint)) ? get_class($endpoint) : gettype($endpoint);
 			throw new \InvalidArgumentException('Expected the endpoint as string. Got ' . $argumentType);
 		}
-		$urlUtil = new UrlUtil();
+		$url = new Url($endpoint);
 		$transport = new HttpTransport();
-		if ($urlUtil->getScheme($endpoint) == 'HTTPS') {
+		if (mb_strtoupper($url->getScheme()) == 'HTTPS') {
 			$transport = new HttpsTransport();
 		}
 		$this->request = new Request();
 		$this->request
 			->setTransport($transport)
 			->setMessage(new Message())
-			->setEndpoint($endpoint);
+			->setUrl(new Url($endpoint));
 	}
 
 	/**
@@ -65,8 +65,9 @@ public function get(array $queryParameters = null)
 	{
 		$this->request
 			->setMethod(RequestInterface::REQUEST_METHOD_GET)
-			->setQueryParameters($queryParameters)
-			->perform();
+			->getUrl()
+			->setQueryParametersFromArray($queryParameters);
+		$this->request->perform();
 		return $this->request->getResponse();
 	}
 
@@ -80,8 +81,9 @@ public function head(array $queryParameters = null)
 	{
 		$this->request
 			->setMethod(RequestInterface::REQUEST_METHOD_HEAD)
-			->setQueryParameters($queryParameters)
-			->perform();
+			->getUrl()
+			->setQueryParametersFromArray($queryParameters);
+		$this->request->perform();
 		return $this->request->getResponse();
 	}
 
@@ -152,8 +154,9 @@ public function delete(array $queryParameters = null)
 	{
 		$this->request
 			->setMethod(RequestInterface::REQUEST_METHOD_DELETE)
-			->setQueryParameters($queryParameters)
-			->perform();
+			->getUrl()
+			->setQueryParametersFromArray($queryParameters);
+		$this->request->perform();
 		return $this->request->getResponse();
 	}
 

src/Request/AbstractRequest.php

@@ -10,10 +10,10 @@
 use BasicHttpClient\Request\Transport\HttpsTransport;
 use BasicHttpClient\Request\Transport\HttpTransport;
 use BasicHttpClient\Response\ResponseInterface;
-use BasicHttpClient\Util\UrlUtil;
 use CommonException\NetworkException\Base\NetworkException;
 use CommonException\NetworkException\ConnectionTimeoutException;
 use CommonException\NetworkException\CurlException;
+use Url\UrlInterface;
 
 /**
  * Class Request
@@ -28,25 +28,15 @@ abstract class AbstractRequest implements RequestInterface
 	 */
 	private $userAgent = 'PHP Basic HTTP Client 1.0';
 
-	/**
-	 * @var string
-	 */
-	private $endpoint;
-
-	/**
-	 * @var int
-	 */
-	private $port;
-
 	/**
 	 * @var string
 	 */
 	private $method = self::REQUEST_METHOD_GET;
 
 	/**
-	 * @var string[]
+	 * @var UrlInterface
 	 */
-	private $queryParameters = array();
+	private $url;
 
 	/**
 	 * @var TransportInterface
@@ -114,54 +104,6 @@ public function setUserAgent($userAgent)
 		return $this;
 	}
 
-	/**
-	 * @return string
-	 */
-	public function getEndpoint()
-	{
-		return $this->endpoint;
-	}
-
-	/**
-	 * @param string $endpoint
-	 * @return $this
-	 */
-	public function setEndpoint($endpoint)
-	{
-		$urlUtil = new UrlUtil();
-		if (!$urlUtil->validateUrl($endpoint)) {
-			throw new \InvalidArgumentException('The given endpoint is not a valid URL');
-		}
-		$this->endpoint = $endpoint;
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getPort()
-	{
-		return $this->port;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasPort()
-	{
-		return !is_null($this->port);
-	}
-
-	/**
-	 * @param int $port
-	 * @return $this
-	 */
-	public function setPort($port)
-	{
-		$this->port = $port;
-		return $this;
-	}
-
 	/**
 	 * @return string
 	 */
@@ -181,60 +123,20 @@ public function setMethod($method)
 	}
 
 	/**
-	 * @return string[]
-	 */
-	public function getQueryParameters()
-	{
-		return $this->queryParameters;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasQueryParameters()
-	{
-		return count($this->queryParameters) > 0;
-	}
-
-	/**
-	 * @param string $parameterName
-	 * @param string $parameterValue
-	 * @return $this
-	 */
-	public function addQueryParameter($parameterName, $parameterValue)
-	{
-		if (!is_string($parameterName) || !is_string($parameterValue)) {
-			throw new \InvalidArgumentException('Query parameter names and values have to be a string.');
-		}
-		$this->queryParameters[$parameterName] = $parameterValue;
-		return $this;
-	}
-
-	/**
-	 * @param string[] $queryParameters
-	 * @return $this
+	 * @return UrlInterface
 	 */
-	public function setQueryParameters($queryParameters)
+	public function getUrl()
 	{
-		foreach ($queryParameters as &$queryParameter) {
-			if (!is_scalar($queryParameter)) {
-				$argumentType = (is_object($queryParameter)) ? get_class($queryParameter) : gettype($queryParameter);
-				throw new \InvalidArgumentException(
-					'Expected the query parameters as array of scalar values. Got ' . $argumentType
-				);
-			}
-			$queryParameter = (string)$queryParameter;
-		}
-		$this->queryParameters = $queryParameters;
-		return $this;
+		return $this->url;
 	}
 
 	/**
+	 * @param UrlInterface $url
 	 * @return $this
 	 */
-	public function removeQueryParameters()
+	public function setUrl(UrlInterface $url)
 	{
-		$this->queryParameters = array();
+		$this->url = $url;
 		return $this;
 	}
 
@@ -364,8 +266,8 @@ public function configureCurl($curl)
 		curl_setopt($curl, CURLINFO_HEADER_OUT, true);
 		curl_setopt($curl, CURLOPT_USERAGENT, $this->getUserAgent());
 		curl_setopt($curl, CURLOPT_URL, $this->calculateEndpoint());
-		if ($this->hasPort()) {
-			curl_setopt($curl, CURLOPT_PORT, $this->getPort());
+		if ($this->getUrl()->hasPort()) {
+			curl_setopt($curl, CURLOPT_PORT, $this->getUrl()->getPort());
 		}
 		// Request method
 		curl_setopt($curl, CURLOPT_HTTPGET, true);
@@ -469,12 +371,7 @@ public function getEffectiveHeaders()
 	 */
 	protected function calculateEndpoint()
 	{
-		$endpoint = $this->getEndpoint();
-		if ($this->hasQueryParameters()) {
-			$glueCharacter = (strpos($endpoint, '?') === false) ? '?' : '&';
-			$endpoint .= $glueCharacter . http_build_query($this->getQueryParameters());
-		}
-		return $endpoint;
+		return $this->getUrl()->buildUrl();
 	}
 
 	/**
@@ -483,8 +380,10 @@ protected function calculateEndpoint()
 	 */
 	protected function prePerform()
 	{
-		$urlUtil = new UrlUtil();
-		if ($urlUtil->getScheme($this->getEndpoint()) == 'HTTPS' && !$this->getTransport() instanceof HttpsTransport) {
+		if (
+			mb_strtoupper($this->getUrl()->getScheme()) == 'HTTPS'
+			&& !$this->getTransport() instanceof HttpsTransport
+		) {
 			throw new HttpRequestException('Transport misconfiguration. Use HttpsTransport for HTTPS requests.');
 		}
 	}

src/Request/Message/Message.php

@@ -96,7 +96,7 @@ public function setHeaders(array $headers)
 	 * @param HeaderInterface $header
 	 * @return $this
 	 */
-	public function addAdditionalHeader(HeaderInterface $header)
+	public function addHeader(HeaderInterface $header)
 	{
 		$this->headers[] = $header;
 		return $this;
@@ -106,7 +106,7 @@ public function addAdditionalHeader(HeaderInterface $header)
 	 * @param HeaderInterface $header
 	 * @return $this
 	 */
-	public function addHeader(HeaderInterface $header)
+	public function setHeader(HeaderInterface $header)
 	{
 		$this->removeHeadersByName($header->getName());
 		$this->headers[] = $header;

src/Request/Message/MessageInterface.php

@@ -47,13 +47,13 @@ public function setHeaders(array $headers);
 	 * @param HeaderInterface $header
 	 * @return $this
 	 */
-	public function addAdditionalHeader(HeaderInterface $header);
+	public function addHeader(HeaderInterface $header);
 
 	/**
 	 * @param HeaderInterface $header
 	 * @return $this
 	 */
-	public function addHeader(HeaderInterface $header);
+	public function setHeader(HeaderInterface $header);
 
 	/**
 	 * @param string $name