ref gnello#50 decouple from pimple

Author: akuzia

README.md

@@ -2,7 +2,7 @@
 
 [![Latest Stable Version][7]][8] [![Scrutinizer Code Quality][5]][6] [![Total Downloads][11]][12]
 
-The PHP Driver to interact with the [Mattermost Web Service API][4].  
+The PHP Driver to interact with the [Mattermost Web Service API][4].
 
 Please read [the api documentation][1] for further information on using this application.
 
@@ -31,64 +31,33 @@ composer require gnello/php-mattermost-driver:1.*
 
 #### Login id and password
 ```php
- use \Gnello\Mattermost\Driver;
- 
- $container = new \Pimple\Container([
-     'driver' => [
-         'url' => 'your_chat_url',
-         'login_id' => 'your_login_id',
-         'password' => 'your_password',
-     ]
- ]);
- 
- $driver = new Driver($container);
- $result = $driver->authenticate();
- ```
+use \Gnello\Mattermost\Driver;
+
+// construct your own GuzzleHttp client instance
+$guzzle = new GuzzleHttp/Client(...);
+
+$driver = new Driver($guzzle, [
+    'url' => 'your_chat_url',
+    'login_id' => 'your_login_id',
+    'password' => 'your_password',
+]);
+$result = $driver->authenticate();
+```
 
 #### Token
 ```php
  use \Gnello\Mattermost\Driver;
- 
- $container = new \Pimple\Container([
-     'driver' => [
-         'url' => 'your_chat_url',
-         'token' => 'your_token',
-     ]
- ]);
- 
- $driver = new Driver($container);
- $result = $driver->authenticate();
- ```
-
-### Options
-Below a list of all the Driver available options, for the Guzzle options
-please refer to its [official documentation][13].
-
-| Option   | Default value | Description                                                                                |
-|:---------|:--------------|:-------------------------------------------------------------------------------------------|
-| scheme   | "https"       | The URI scheme.                                                                            |
-| basePath | "/api/v4"     | The base path of the API endpoint.                                                         |
-| url      | "localhost"   | The URL of the Mattermost server, without the scheme (es. "www.mydomain.com").             |
-| login_id | null          | The account username to use with the API.                                                  |
-| password | null          | The account password to use with the API.                                                  |
-| token    | null          | The account token to use with the API, if specified it override the login_id and password. |
-
-You can specify the options as shown in the following example:
-```php
- use \Gnello\Mattermost\Driver;
- 
- $container = new \Pimple\Container([
-     'driver' => [
-         //put here any options for the driver
-     ],
-     'guzzle' => [
-         //put here any options for Guzzle
-     ]
- ]);
- 
- $driver = new Driver($container);
- $result = $driver->authenticate();
- ```
+
+ // construct your own GuzzleHttp client instance
+$guzzle = new GuzzleHttp/Client(...);
+
+$driver = new Driver($guzzle, [
+    'url' => 'your_chat_url',
+    'token' => 'your_token',
+]);
+
+$result = $driver->authenticate();
+```
 
 ### Check results
 This Driver follows the [PSR-7][2] document therefore any response is a ResponseInterface type:
@@ -106,8 +75,8 @@ if ($result->getStatusCode() == 200) {
 ```php
 //Add a new user
 $result = $driver->getUserModel()->createUser([
-    'email'    => '[email protected]', 
-    'username' => 'test', 
+    'email'    => '[email protected]',
+    'username' => 'test',
     'password' => 'testpsw'
 ]);
 
@@ -180,7 +149,7 @@ $result = $driver->getPreferenceModel('user_id')->getUserPreference();
 //Please read the PreferenceModel class or refer to the api documentation for a complete list of available methods.
 ```
 
-## Endpoints supported  
+## Endpoints supported
 
 - [Bleve](https://api.mattermost.com/#tag/bleve)
 - [Bots](https://api.mattermost.com/#tag/bots)

composer.json

@@ -18,7 +18,6 @@
         "php": ">=5.5.0",
         "ext-json": "*",
         "psr/http-message" : "^1.0",
-        "pimple/pimple"    : "~3.0",
         "guzzlehttp/guzzle": "^6.2|^7.4"
     },
     "require-dev": {

src/Client.php

@@ -20,7 +20,6 @@
 use GuzzleHttp\Psr7\Response;
 use GuzzleHttp\RequestOptions;
 use Psr\Http\Message\ResponseInterface;
-use Pimple\Container;
 
 /**
  * Class Client
@@ -44,20 +43,10 @@ class Client
      */
     private $client;
 
-    /**
-     * Client constructor.
-     *
-     * @param Container $container
-     */
-    public function __construct(Container $container)
+    /** @param array<string, ?string> $options */
+    public function __construct(GuzzleClient $guzzle, array $options)
     {
-        $guzzleOptions = [];
-        if (isset($container['guzzle'])) {
-            $guzzleOptions = $container['guzzle'];
-        }
-        $this->client = new GuzzleClient($guzzleOptions);
-
-        $options = $container['driver'];
+        $this->client = $guzzle;
         $this->baseUri = $options['scheme'] . '://' . $options['url'] . $options['basePath'];
     }
 

src/Driver.php

@@ -38,8 +38,8 @@
 use Gnello\Mattermost\Models\ThreadModel;
 use Gnello\Mattermost\Models\UserModel;
 use Gnello\Mattermost\Models\WebhookModel;
+use GuzzleHttp\Client as Guzzle;
 use GuzzleHttp\Psr7\Response;
-use Pimple\Container;
 use Psr\Http\Message\ResponseInterface;
 
 /**
@@ -54,7 +54,7 @@ class Driver
      *
      * @var array
      */
-    private $defaultOptions = [
+    private const DEFAULT_OPTIONS = [
         'scheme' => 'https',
         'basePath' => '/api/v4',
         'url' => 'localhost',
@@ -63,57 +63,49 @@ class Driver
         'token' => null,
     ];
 
-    /**
-     * @var Container
-     */
-    private $container;
+    /** @var array<string, ?string> */
+    private $driverOptions;
+
+    /** @var Client */
+    private $client;
 
     /**
      * @var array
      */
     private $models = [];
 
-    /**
-     * Driver constructor.
-     *
-     * @param Container $container
-     */
-    public function __construct(Container $container)
+    public function __construct(
+        Guzzle $guzzle,
+        array $driverOptions
+    )
     {
-        $driverOptions = $this->defaultOptions;
-
-        if (isset($container['driver'])) {
-            $driverOptions = array_merge($driverOptions, $container['driver']);
-        }
-
-        $container['driver'] = $driverOptions;
-        $container['client'] = new Client($container);
-
-        $this->container = $container;
+        $this->driverOptions = array_merge(self::DEFAULT_OPTIONS, $driverOptions);
+        $this->client = new Client(
+            $guzzle,
+            $driverOptions
+        );
     }
 
     /**
      * @return ResponseInterface
      */
     public function authenticate()
     {
-        $driverOptions = $this->container['driver'];
-
-        if (isset($driverOptions['token'])) {
+        if (isset($this->driverOptions['token'])) {
 
-            $this->container['client']->setToken($driverOptions['token']);
+            $this->client->setToken($this->driverOptions['token']);
             $response = $this->getUserModel()->getAuthenticatedUser();
 
-        } else if (isset($driverOptions['login_id']) && isset($driverOptions['password'])) {
+        } else if (isset($this->driverOptions['login_id']) && isset($this->driverOptions['password'])) {
 
             $response = $this->getUserModel()->loginToUserAccount([
-                'login_id' => $driverOptions['login_id'],
-                'password' => $driverOptions['password']
+                'login_id' => $this->driverOptions['login_id'],
+                'password' => $this->driverOptions['password']
             ]);
 
             if ($response->getStatusCode() == 200) {
                 $token = $response->getHeader('Token')[0];
-                $this->container['client']->setToken($token);
+                $this->client->setToken($token);
             }
 
         } else {
@@ -138,7 +130,7 @@ public function authenticate()
     private function getModel($className)
     {
         if (!isset($this->models[$className])) {
-            $this->models[$className] = new $className($this->container['client']);
+            $this->models[$className] = new $className($this->client);
         }
 
         return $this->models[$className];