Replaces fsockopen() with stream_socket_client(), adds more consisten…

…cy to connection parameters, #9

Changed

* Replaced methods `getHost()` and `getPort()` with `getSocketAddress()` in interface `hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection`
* The transport protocol `unix://` must be omitted for the first parameter of `hollodotme\FastCGI\SocketConnections\UnixDomainSocket`
  Only the socket path must be passed.
* Relaced `fsockopen()` with `stream_socket_client()` for connecting to php-fpm.

CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CHANGELOG](http://keepachangelog.com).
 
+## [1.3.0] - 2017-06-15
+
+### Changed
+
+* Replaced methods `getHost()` and `getPort()` with `getSocketAddress()` in interface `hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection` - [#9]
+* The transport protocol `unix://` must be omitted for the first parameter of `hollodotme\FastCGI\SocketConnections\UnixDomainSocket`  
+  Only the socket path must be passed. - [#9]
+* Relaced `fsockopen()` with `stream_socket_client()` for connecting to php-fpm. - [#9]
+
 ## [1.2.0] - 2017-05-27
 
 ### Added
@@ -88,6 +97,7 @@ Based on [Pierrick Charron](https://github.com/adoy)'s [PHP-FastCGI-Client](http
  * Getters/Setters for connect timeout, read/write timeout, keep alive, socket persistence from `Client` (now part of the socket connection)
  * Method `Client->getValues()`
 
+[1.3.0]: https://github.com/hollodotme/fast-cgi-client/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/hollodotme/fast-cgi-client/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/hollodotme/fast-cgi-client/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/hollodotme/fast-cgi-client/compare/v1.0.0...v1.0.1
@@ -97,3 +107,4 @@ Based on [Pierrick Charron](https://github.com/adoy)'s [PHP-FastCGI-Client](http
 [#2]: https://github.com/hollodotme/fast-cgi-client/issues/2
 [#5]: https://github.com/hollodotme/fast-cgi-client/issues/5
 [#6]: https://github.com/hollodotme/fast-cgi-client/issues/6
+[#9]: https://github.com/hollodotme/fast-cgi-client/issues/9

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/hollodotme/fast-cgi-client.svg?branch=master)](https://travis-ci.org/hollodotme/fast-cgi-client)
+[![Build Status](https://travis-ci.org/hollodotme/fast-cgi-client.svg?branch=1.x-stable)](https://travis-ci.org/hollodotme/fast-cgi-client)
 [![Tested PHP versions](https://php-eye.com/badge/hollodotme/fast-cgi-client/tested.svg?branch=1.x-stable)](https://php-eye.com/package/hollodotme/fast-cgi-client)
 [![Latest Stable Version](https://poser.pugx.org/hollodotme/fast-cgi-client/v/stable)](https://packagist.org/packages/hollodotme/fast-cgi-client) 
 [![Total Downloads](https://poser.pugx.org/hollodotme/fast-cgi-client/downloads)](https://packagist.org/packages/hollodotme/fast-cgi-client) 
@@ -16,6 +16,8 @@ You can find an experimental use-case in my related blog posts:
 * [Experimental async PHP vol. 1](http://bit.ly/eapv1)
 * [Experimental async PHP vol. 2](http://bit.ly/eapv2)
 
+You can also find slides of my talks about this project on [speakerdeck.com](https://speakerdeck.com/hollodotme).
+
 ---
 
 ## Installation
@@ -41,7 +43,7 @@ The following examples assume a that the content of `/path/to/target/script.php`
 ```php
 <?php declare(strict_types=1);
 
-sleep((int)$_REQUEST['sleep'] ?? 0);
+sleep((int)($_REQUEST['sleep'] ?? 0));
 echo $_REQUEST['key'] ?? '';
 ```
 
@@ -56,14 +58,16 @@ use hollodotme\FastCGI\Client;
 use hollodotme\FastCGI\SocketConnections\UnixDomainSocket;
 
 $connection = new UnixDomainSocket(
-	'unix:///var/run/php/php7.0-fpm.sock',  # Socket path to php-fpm
+	'/var/run/php/php7.0-fpm.sock',  # Socket path to php-fpm
 	5000,                                   # Connect timeout in milliseconds (default: 5000)
 	5000                                    # Read/write timeout in milliseconds (default: 5000)
 );
 
 $client = new Client( $connection );
 ```
 
+**PLEASE NOTE:** In versions before 1.3.0 you also need to provide the transport protocol `unix://` in the first parameter.
+
 ### Init client with a network socket connection
 
 ```php
@@ -95,7 +99,7 @@ use hollodotme\FastCGI\Client;
 use hollodotme\FastCGI\Requests\PostRequest;
 use hollodotme\FastCGI\SocketConnections\UnixDomainSocket;
 
-$client  = new Client( new UnixDomainSocket( 'unix:///var/run/php/php7.0-fpm.sock' ) );
+$client  = new Client( new UnixDomainSocket( '/var/run/php/php7.0-fpm.sock' ) );
 $content = http_build_query(['key' => 'value']);
 
 $request = new PostRequest('/path/to/target/script.php', $content);
@@ -652,4 +656,6 @@ Run a call through a network socket:
 
 Run a call through a Unix Domain Socket
 
-    bin/fcgiget unix:/var/run/php/php7.0-fpm.sock/status
+    bin/fcgiget /var/run/php/php7.0-fpm.sock/status
+
+This shows the response of the php-fpm status page, if enabled.

bin/fcgiget

@@ -50,7 +50,7 @@ if ( $_SERVER['argc'] < 2 )
 {
 	echo 'Usage: ' . $_SERVER['argv'][0] . "  URI\n\n";
 	echo 'Ex: ' . $_SERVER['argv'][0] . " localhost:9000/status\n";
-	echo 'Ex: ' . $_SERVER['argv'][0] . " unix:/var/run/php-fpm/web.sock/status\n";
+	echo 'Ex: ' . $_SERVER['argv'][0] . " /var/run/php-fpm/web.sock/status\n";
 	exit( 1 );
 }
 
@@ -90,8 +90,8 @@ else
 }
 if ( $sock )
 {
-	$client = new Client( new UnixDomainSocket( "unix://{$sock}" ) );
-	echo "Call: {$uri} on UDS {$sock}\n\n";
+	$client = new Client( new UnixDomainSocket( (string)$sock ) );
+	echo "Call: {$uri} on UDS unix://{$sock}\n\n";
 }
 else
 {

composer.json

@@ -41,7 +41,7 @@
 	"extra": {
 		"tools": {
 			"phpunit": {
-				"url": "https://phar.phpunit.de/phpunit-6.1.4.phar",
+				"url": "https://phar.phpunit.de/phpunit-6.2.2.phar",
 				"only-dev": true
 			},
 			"coveralls": {

src/Interfaces/ConfiguresSocketConnection.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types = 1);
+<?php declare(strict_types=1);
 /*
  * Copyright (c) 2010-2014 Pierrick Charron
  * Copyright (c) 2017 Holger Woltersdorf
@@ -29,9 +29,7 @@
  */
 interface ConfiguresSocketConnection
 {
-	public function getHost() : string;
-
-	public function getPort() : int;
+	public function getSocketAddress() : string;
 
 	public function getConnectTimeout() : int;
 

src/Socket.php

@@ -150,16 +150,10 @@ public function sendRequest( ProvidesRequestData $request )
 
 	private function connect()
 	{
-		if ( is_resource( $this->resource ) )
-		{
-			return;
-		}
-
 		try
 		{
-			$this->resource = @fsockopen(
-				$this->connection->getHost(),
-				$this->connection->getPort(),
+			$this->resource = @stream_socket_client(
+				$this->connection->getSocketAddress(),
 				$errorNumber,
 				$errorString,
 				$this->connection->getConnectTimeout() / 1000

src/SocketConnections/NetworkSocket.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types = 1);
+<?php declare(strict_types=1);
 /*
  * Copyright (c) 2010-2014 Pierrick Charron
  * Copyright (c) 2017 Holger Woltersdorf
@@ -56,14 +56,9 @@ public function __construct(
 		$this->readWriteTimeout = $readWriteTimeout;
 	}
 
-	public function getHost() : string
+	public function getSocketAddress() : string
 	{
-		return $this->host;
-	}
-
-	public function getPort() : int
-	{
-		return $this->port;
+		return sprintf( 'tcp://%s:%d', $this->host, $this->port );
 	}
 
 	public function getConnectTimeout() : int

src/SocketConnections/UnixDomainSocket.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types = 1);
+<?php declare(strict_types=1);
 /*
  * Copyright (c) 2010-2014 Pierrick Charron
  * Copyright (c) 2017 Holger Woltersdorf
@@ -32,10 +32,7 @@
 class UnixDomainSocket implements ConfiguresSocketConnection
 {
 	/** @var string */
-	private $host;
-
-	/** @var int */
-	private $port;
+	private $socketPath;
 
 	/** @var int */
 	private $connectTimeout;
@@ -49,20 +46,14 @@ public function __construct(
 		int $readWriteTimeout = Defaults::READ_WRITE_TIMEOUT
 	)
 	{
-		$this->host             = $socketPath;
-		$this->port             = -1;
+		$this->socketPath       = $socketPath;
 		$this->connectTimeout   = $connectTimeout;
 		$this->readWriteTimeout = $readWriteTimeout;
 	}
 
-	public function getHost() : string
-	{
-		return $this->host;
-	}
-
-	public function getPort() : int
+	public function getSocketAddress() : string
 	{
-		return $this->port;
+		return 'unix://' . $this->socketPath;
 	}
 
 	public function getConnectTimeout() : int

tests/Integration/UnixDomainSocketTest.php

@@ -38,7 +38,7 @@ final class UnixDomainSocketTest extends TestCase
 {
 	public function testCanSendAsyncRequestAndReceiveRequestId()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -51,7 +51,7 @@ public function testCanSendAsyncRequestAndReceiveRequestId()
 
 	public function testCanSendAsyncRequestAndReadResponse()
 	{
-		$connection       = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection       = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client           = new Client( $connection );
 		$content          = http_build_query( [ 'test-key' => 'unit' ] );
 		$request          = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -69,7 +69,7 @@ public function testCanSendAsyncRequestAndReadResponse()
 
 	public function testCanSendSyncRequestAndReceiveResponse()
 	{
-		$connection       = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection       = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client           = new Client( $connection );
 		$content          = http_build_query( [ 'test-key' => 'unit' ] );
 		$request          = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -88,7 +88,7 @@ public function testCanSendSyncRequestAndReceiveResponse()
 
 	public function testCanReceiveResponseInCallback()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -108,7 +108,7 @@ function ( ProvidesResponseData $response ) use ( $unitTest )
 
 	public function testCanHandleExceptionsInFailureCallback()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -136,7 +136,7 @@ function ( \Throwable $throwable ) use ( $unitTest )
 
 	public function testCanCheckForRequestIdsHavingResponses()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -151,7 +151,7 @@ public function testCanCheckForRequestIdsHavingResponses()
 
 	public function testCanReadResponses()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -187,7 +187,7 @@ public function testCanReadResponses()
 	 */
 	public function testReadingSyncResponseCanTimeOut()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock', Defaults::CONNECT_TIMEOUT, 1000 );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock', Defaults::CONNECT_TIMEOUT, 1000 );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/sleepWorker.php', $content );
@@ -204,7 +204,7 @@ public function testReadingSyncResponseCanTimeOut()
 
 	public function testCanHandleReadyResponses()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -228,7 +228,7 @@ function ( ProvidesResponseData $response ) use ( $unitTest )
 
 	public function testCanReadReadyResponses()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -248,7 +248,7 @@ public function testCanReadReadyResponses()
 
 	public function testCanWaitForResponse()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );
@@ -269,7 +269,7 @@ function ( ProvidesResponseData $response ) use ( $unitTest )
 
 	public function testReadResponsesSkipsUnknownRequestIds()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php-uds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php-uds.sock' );
 		$client     = new Client( $connection );
 		$content    = http_build_query( [ 'test-key' => 'unit' ] );
 		$request    = new PostRequest( __DIR__ . '/Workers/worker.php', $content );

tests/Unit/ClientTest.php

@@ -40,7 +40,7 @@ final class ClientTest extends TestCase
 	 */
 	public function testConnectAttemptToNotExistingSocketThrowsException()
 	{
-		$connection = new UnixDomainSocket( 'unix:///tmp/not/existing.sock', 2000, 2000, true, true );
+		$connection = new UnixDomainSocket( '/tmp/not/existing.sock', 2000, 2000, true, true );
 		$client     = new Client( $connection );
 
 		$client->sendRequest( new PostRequest( '/path/to/script.php', '' ) );
@@ -53,7 +53,7 @@ public function testConnectAttemptToInvalidSocketThrowsException()
 	{
 		$testSocket = realpath( __DIR__ . '/Fixtures/test.sock' );
 
-		$connection = new UnixDomainSocket( 'unix://' . $testSocket );
+		$connection = new UnixDomainSocket( '' . $testSocket );
 		$client     = new Client( $connection );
 
 		$client->sendRequest( new PostRequest( '/path/to/script.php', '' ) );
@@ -109,11 +109,11 @@ public function testHandlingUnknownRequestsThrowsException()
 
 	/**
 	 * @expectedException \hollodotme\FastCGI\Exceptions\ConnectException
-	 * @expectedExceptionMessageRegExp #^Unable to connect to FastCGI application#
+	 * @expectedExceptionMessageRegExp #.*unable to connect to.*#i
 	 */
 	public function testConnectAttemptToRestrictedUnixDomainSocketThrowsException()
 	{
-		$connection = new UnixDomainSocket( 'unix:///var/run/php7.1-ruds.sock' );
+		$connection = new UnixDomainSocket( '/var/run/php7.0-ruds.sock' );
 		$client     = new Client( $connection );
 
 		$client->sendRequest( new PostRequest( '/path/to/script.php', '' ) );

tests/Unit/SocketConnections/NetworkSocketTest.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types = 1);
+<?php declare(strict_types=1);
 /*
  * Copyright (c) 2010-2014 Pierrick Charron
  * Copyright (c) 2017 Holger Woltersdorf
@@ -40,8 +40,7 @@ public function testCanGetDefaultValues()
 	{
 		$connection = new NetworkSocket( 'localhost', 9000 );
 
-		$this->assertSame( 'localhost', $connection->getHost() );
-		$this->assertSame( 9000, $connection->getPort() );
+		$this->assertSame( 'tcp://localhost:9000', $connection->getSocketAddress() );
 		$this->assertSame( Defaults::CONNECT_TIMEOUT, $connection->getConnectTimeout() );
 		$this->assertSame( Defaults::READ_WRITE_TIMEOUT, $connection->getReadWriteTimeout() );
 	}
@@ -50,8 +49,7 @@ public function testCanGetSetValues()
 	{
 		$connection = new NetworkSocket( '127.0.0.1', 9001, 2000, 3000 );
 
-		$this->assertSame( '127.0.0.1', $connection->getHost() );
-		$this->assertSame( 9001, $connection->getPort() );
+		$this->assertSame( 'tcp://127.0.0.1:9001', $connection->getSocketAddress() );
 		$this->assertSame( 2000, $connection->getConnectTimeout() );
 		$this->assertSame( 3000, $connection->getReadWriteTimeout() );
 	}