php-mqtt
diff --git a/‎.github/workflows/tests.yml
+11-6 b/‎.github/workflows/tests.yml
+11-6
diff --git a/‎.github/workflows/verify-code-style.yml
+2-2 b/‎.github/workflows/verify-code-style.yml
+2-2
diff --git a/‎.phpcs.xml
-1 b/‎.phpcs.xml
-1
diff --git a/‎README.md
+46-33 b/‎README.md
+46-33
diff --git a/‎composer.json
+22-5 b/‎composer.json
+22-5
@@ -1,24 +1,29 @@
 name: Tests
 
-on: [push]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
 
 jobs:
   test-all:
+    name: Test PHP ${{ matrix.php-version }} on ${{ matrix.operating-system }}
+
     runs-on: ${{ matrix.operating-system }}
 
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: [7.2, 7.3, 7.4]
-
-    name: PHP ${{ matrix.php-versions }} tests on ${{ matrix.operating-system }}
+        php-version: ['7.2', '7.3', '7.4']
 
     steps:
       - uses: actions/checkout@v2
 
       - uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: ${{ matrix.php-version }}
           tools: phpunit:8.5.8
           coverage: pcov
 
@@ -47,4 +52,4 @@ jobs:
         uses: Namoshek/[email protected]
 
       - name: Run phpunit tests
-        run: phpunit
+        run: composer test
@@ -1,6 +1,6 @@
-name: 'PR: Verify Code Style'
+name: 'Verify Code Style'
 
-on: pull_request
+on: [push, pull_request]
 
 jobs:
   phpcs:
 
@@ -81,7 +81,6 @@
     <rule ref="Zend.Files.ClosingTag"/>
 
     <file>src</file>
-    <file>tests</file>
 
     <arg name="colors"/>
     <arg value="sp"/>
 
@@ -1,13 +1,14 @@
 # php-mqtt/client
 
-[![Latest Stable Version](https://poser.pugx.org/php-mqtt/client/v)](//packagist.org/packages/php-mqtt/client)
-[![Total Downloads](https://poser.pugx.org/php-mqtt/client/downloads)](//packagist.org/packages/php-mqtt/client)
-![Tests](https://github.com/php-mqtt/client/workflows/Tests/badge.svg)
-[![License](https://poser.pugx.org/php-mqtt/client/license)](//packagist.org/packages/php-mqtt/client)
+[![Latest Stable Version](https://poser.pugx.org/php-mqtt/client/v)](https://packagist.org/packages/php-mqtt/client)
+[![Total Downloads](https://poser.pugx.org/php-mqtt/client/downloads)](https://packagist.org/packages/php-mqtt/client)
+[![Tests](https://github.com/php-mqtt/client/workflows/Tests/badge.svg)](https://github.com/php-mqtt/client/actions?query=workflow%3ATests)
+[![License](https://poser.pugx.org/php-mqtt/client/license)](https://packagist.org/packages/php-mqtt/client)
 
-[`php-mqtt/client`](https://packagist.org/packages/php-mqtt/client) was created by, and is maintained by [Namoshek](https://github.com/namoshek).
+[`php-mqtt/client`](https://packagist.org/packages/php-mqtt/client) was created by, and is maintained
+by [Namoshek](https://github.com/namoshek).
 It allows you to connect to an MQTT broker where you can publish messages and subscribe to topics.
-The implementation supports all QoS levels ([with limitations](#limitations)).
+The current implementation supports all QoS levels ([with limitations](#limitations)).
 
 ## Installation
 
@@ -28,7 +29,7 @@ $server   = 'some-broker.example.com';
 $port     = 1883;
 $clientId = 'test-publisher';
 
-$mqtt = new \PhpMqtt\Client\MQTTClient($server, $port, $clientId);
+$mqtt = new \PhpMqtt\Client\MqttClient($server, $port, $clientId);
 $mqtt->connect();
 $mqtt->publish('php-mqtt/client/test', 'Hello World!', 0);
 $mqtt->close();
@@ -45,7 +46,7 @@ Subscribing is a little more complex than publishing as it requires to run an ev
 ```php
 $clientId = 'test-subscriber';
 
-$mqtt = new \PhpMqtt\Client\MQTTClient($server, $port, $clientId);
+$mqtt = new \PhpMqtt\Client\MqttClient($server, $port, $clientId);
 $mqtt->connect();
 $mqtt->subscribe('php-mqtt/client/test', function ($topic, $message) {
     echo sprintf("Received message on topic [%s]: %s\n", $topic, $message);
@@ -61,7 +62,7 @@ pcntl_async_signals(true);
 
 $clientId = 'test-subscriber';
 
-$mqtt = new \PhpMqtt\Client\MQTTClient($server, $port, $clientId);
+$mqtt = new \PhpMqtt\Client\MqttClient($server, $port, $clientId);
 pcntl_signal(SIGINT, function (int $signal, $info) use ($mqtt) {
     $mqtt->interrupt();
 });
@@ -75,8 +76,9 @@ $mqtt->close();
 
 ### Client Settings
 
-As shown in the examples above, the `MQTTClient` takes the server, port and client id as first, second and third parameter.
-As fourth parameter, the path to a CA file can be passed which will enable TLS and is used to verify the peer.
+As shown in the examples above, the `MqttClient` takes the server, port and client id as first, second and third parameter.
+As fourth parameter, the protocol level can be passed. Currently supported is MQTT v3.1,
+available as constant `MqttClient::MQTT_3_1`.
 A fifth parameter allows passing a repository (currently, only a `MemoryRepository` is available by default).
 Lastly, a logger can be passed as sixth parameter. If none is given, a null logger is used instead.
 
@@ -86,45 +88,56 @@ $mqtt = new \PhpMqtt\Client\MQTTClient(
     $server, 
     $port, 
     $clientId,
-    '/path/to/ca/file',
+    \PhpMqtt\Client\MqttClient::MQTT_3_1,
     new \PhpMqtt\Client\Repositories\MemoryRepository(),
     new Logger()
 );
 ```
 
-The logger must implement the `Psr\Log\LoggerInterface`.
+The `Logger` must implement the `Psr\Log\LoggerInterface`.
 
 ### Connection Settings
 
-The `connect()` method of the `MQTTClient` takes four optional parameters:
-1. Username
-2. Password
-3. A `ConnectionSettings` instance
-4. A `boolean` flag indicating whether a clean session should be requested (a random client id does this implicitly)
+The `connect()` method of the `MQTTClient` takes two optional parameters:
+1. A `ConnectionSettings` instance
+2. A `boolean` flag indicating whether a clean session should be requested (a random client id does this implicitly)
 
 Example:
 ```php
 $mqtt = new \PhpMqtt\Client\MQTTClient($server, $port, $clientId);
 
 $connectionSettings = new \PhpMqtt\Client\ConnectionSettings();
-$mqtt->connect($username, $password, $connectionSettings, true);
+$mqtt->connect($connectionSettings, true);
 ```
 
-The `ConnectionSettings` class has the following constructor and defaults:
+The `ConnectionSettings` class provides a few settings through a fluent interface. The type itself is immutable,
+and a new `ConnectionSettings` instance will be created for each added option.
+This also prevents changes to the connection settings after a connection has been established.
+
+The following is a complete list of options with their respective default:
 ```php
-public function __construct(
-    int $qualityOfService = 0,
-    bool $retain = false,
-    bool $blockSocket = false,
-    int $socketTimeout = 5,
-    int $keepAlive = 10,
-    int $resendTimeout = 10,
-    string $lastWillTopic = null,
-    string $lastWillMessage = null,
-    bool $useTls = false,
-    bool $tlsVerifyPeer = true,
-    bool $tlsVerifyName = true
-) { ... }
+$connectionSettings = (new \PhpMqtt\Client\ConnectionSettings())
+
+    // The QoS level 
+    ->setUsername(null)
+    ->setPassword(null)
+    ->setConnectTimeout(60)
+    ->setSocketTimeout(5)
+    ->setKeepAliveInterval(10)
+    ->setResendTimeout(10)
+    ->setLastWillTopic(null)
+    ->setLastWillMessage(null)
+    ->setLastWillQualityOfService(0)
+    ->setRetainLastWill(false)
+    ->setUseTls(false)
+    ->setTlsVerifyPeer(true)
+    ->setTlsVerifyPeerName(true)
+    ->setTlsSelfSignedAllowed(false)
+    ->setTlsCertificateAuthorityFile(null)
+    ->setTlsCertificateAuthorityPath(null)
+    ->setTlsClientCertificateFile(null)
+    ->setTlsClientCertificateKeyFile(null)
+    ->setTlsClientCertificatePassphrase(null);
 ```
 
 ## Features
 
@@ -21,17 +21,34 @@
             "PhpMqtt\\Client\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
     "require": {
         "php": "^7.2",
-        "psr/log": "^1.1"
+        "psr/log": "^1.1",
+        "myclabs/php-enum": "^1.7",
+        "opis/closure": "^3.5"
     },
     "require-dev": {
+        "phpunit/php-invoker": "^3.0",
         "phpunit/phpunit": "^8.0",
-        "squizlabs/php_codesniffer": "^3.5",
-        "phpunit/php-invoker": "^3.0"
+        "squizlabs/php_codesniffer": "^3.5"
+    },
+    "suggest": {
+        "ext-redis": "Required for the RedisRepository"
     },
     "scripts": {
-        "test:cs": "vendor/bin/phpcs src tests",
-        "fix:cs": "vendor/bin/phpcbf src tests"
+        "fix:cs": "vendor/bin/phpcbf",
+        "test": [
+            "@test:cs",
+            "@test:unit",
+            "@test:feature"
+        ],
+        "test:cs": "vendor/bin/phpcs",
+        "test:feature": "vendor/bin/phpunit --testdox --testsuite Feature",
+        "test:unit": "vendor/bin/phpunit --testdox --testsuite Unit"
     }
 }