refactor: some design changes

Author: ecastro98

README.md

@@ -34,11 +34,11 @@ require_once('vendor/autoload.php');
 
 use MultiTheftAuto\Sdk\Mta;
 use MultiTheftAuto\Sdk\Model\Server;
-use MultiTheftAuto\Sdk\Authentication\Credential;
+use MultiTheftAuto\Sdk\Model\Authentication;
 
 $server = new Server('127.0.0.1', 22005);
-$credential = new Credential('myUser', 'myPassword');
-$mta = new Mta($server, $credential);
+$auth = new Authentication('myUser', 'myPassword');
+$mta = new Mta($server, $auth);
 
 $response = $mta->getResource('someResource')->call('callableFunction', $arg1, $arg2, $arg3, ...);
 //or

composer.json

@@ -8,13 +8,16 @@
     "require": {
         "php": "^7.1",
         "ext-json": "^1.5",
+        "php-http/client-implementation": "^1.0",
         "php-http/httplug": "^2.0",
-        "php-http/client-implementation": "^1.0"
+        "psr/http-factory": "^1.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.13",
         "guzzlehttp/psr7": "^1.5",
+        "http-interop/http-factory-guzzle": "^1.0",
         "php-http/mock-client": "^1.1",
+        "phpspec/prophecy": "~1.0",
         "phpstan/phpstan": "^0.10.7",
         "phpunit/phpunit": "^7"
     },
@@ -30,8 +33,8 @@
         }
     },
     "scripts": {
-        "fixer": "php-cs-fixer fix --verbose --show-progress=estimating",
-        "fixer:check": [
+        "lint": "php-cs-fixer fix --verbose --show-progress=estimating",
+        "lint:check": [
             "php-cs-fixer fix --dry-run --verbose --show-progress=estimating"
         ],
         "phpunit": "phpunit tests",

examples/ajax/ajax_interface.php

@@ -1,7 +1,7 @@
 <?php
 
 use MultiTheftAuto\Sdk\Mta;
-use MultiTheftAuto\Sdk\Authentication\CredentialTest;
+use MultiTheftAuto\Sdk\Model\Authentication;
 use MultiTheftAuto\Sdk\Model\Server;
 
 // =============================
@@ -27,8 +27,8 @@
 	}
 
 	$server = new Server($host, $port);
-	$credential = new CredentialTest($http_username, $http_password);
-    $mta = new Mta($server, $credential);
+	$auth = new Authentication($http_username, $http_password);
+	$mta = new Mta($server, $auth);
 
 	$val = explode(",", $val);
 	$json_data = json_encode($val);

src/Authentication/Credential.php renamed to src/Model/Authentication.php

@@ -12,9 +12,9 @@
 
 declare(strict_types=1);
 
-namespace MultiTheftAuto\Sdk\Authentication;
+namespace MultiTheftAuto\Sdk\Model;
 
-class Credential
+class Authentication
 {
     /**
      * @var string

src/Model/Element.php

@@ -14,22 +14,36 @@
 
 namespace MultiTheftAuto\Sdk\Model;
 
-class Element
+use JsonSerializable;
+
+class Element implements JsonSerializable
 {
+    /**
+     * @var string
+     */
     protected $id;
 
+    public const SERVER_PREFIX = '^E^';
+
     public function __construct(string $id)
     {
         $this->id = $id;
     }
 
+    public static function fromServer(string $value): self
+    {
+        $id = substr($value, 3);
+
+        return new static($id);
+    }
+
     public function getId(): string
     {
         return $this->id;
     }
 
-    public function __toString()
+    public function jsonSerialize(): string
     {
-        return '^E^' . $this->id;
+        return self::SERVER_PREFIX . $this->id;
     }
 }

src/Model/Resource.php

@@ -15,9 +15,10 @@
 namespace MultiTheftAuto\Sdk\Model;
 
 use Exception;
+use JsonSerializable;
 use MultiTheftAuto\Sdk\Mta;
 
-class Resource
+class Resource implements JsonSerializable
 {
     /**
      * @var string
@@ -29,12 +30,20 @@ class Resource
      */
     private $mta;
 
+    public const SERVER_PREFIX = '^R^';
+
     public function __construct(string $name, Mta $mta = null)
     {
         $this->name = $name;
         $this->mta = $mta;
     }
 
+    public static function fromServer(string $value): self
+    {
+        $name = substr($value, 3);
+        return new static($name);
+    }
+
     public function getName()
     {
         return $this->name;
@@ -55,8 +64,8 @@ public function __call($name, $arguments)
         return call_user_func_array([$this, 'call'], $arguments);
     }
 
-    public function __toString()
+    public function jsonSerialize(): string
     {
-        return '^R^' . $this->name;
+        return self::SERVER_PREFIX . $this->name;
     }
 }

src/Model/Server.php

@@ -33,6 +33,7 @@ public function __construct(string $host, int $httpPort)
         if (!filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
             throw new InvalidArgumentException('Invalid IP');
         }
+
         $this->host = $host;
         $this->httpPort = $httpPort;
     }

src/Mta.php

@@ -14,19 +14,21 @@
 
 namespace MultiTheftAuto\Sdk;
 
+use GuzzleHttp\Psr7\Stream;
 use Http\Client\HttpClient;
 use Http\Discovery\HttpClientDiscovery;
-use Http\Discovery\MessageFactoryDiscovery;
+use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Message\Authentication\BasicAuth;
-use Http\Message\MessageFactory;
-use MultiTheftAuto\Sdk\Authentication\Credential;
+use MultiTheftAuto\Sdk\Model\Authentication;
 use MultiTheftAuto\Sdk\Model\Resource as MtaResource;
 use MultiTheftAuto\Sdk\Model\Resources;
 use MultiTheftAuto\Sdk\Model\Server;
 use MultiTheftAuto\Sdk\Response\HandleResponse;
 use MultiTheftAuto\Sdk\Response\HttpStatusVerification;
+use MultiTheftAuto\Sdk\Utils\ElementTransformer;
 use MultiTheftAuto\Sdk\Utils\Input;
-use MultiTheftAuto\Sdk\Utils\Translator;
+use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\StreamFactoryInterface;
 
 class Mta
 {
@@ -36,9 +38,9 @@ class Mta
     protected $server;
 
     /**
-     * @var Credential
+     * @var Authentication
      */
-    protected $credential;
+    protected $auth;
 
     /**
      * @var Resources
@@ -51,20 +53,27 @@ class Mta
     protected $httpClient;
 
     /**
-     * @var MessageFactory
+     * @var RequestFactoryInterface
      */
-    protected $messageFactory;
+    protected $requestFactory;
+
+    /**
+     * @var StreamFactoryInterface
+     */
+    protected $streamFactory;
 
     public function __construct(
         Server $server,
-        Credential $credential,
+        Authentication $auth,
         HttpClient $httpClient = null,
-        MessageFactory $messageFactory = null
+        RequestFactoryInterface $requestFactory = null,
+        StreamFactoryInterface $streamFactory = null
     ) {
         $this->server = $server;
-        $this->credential = $credential;
-        $this->httpClient = $httpClient?? HttpClientDiscovery::find();
-        $this->messageFactory = $messageFactory?? MessageFactoryDiscovery::find();
+        $this->auth = $auth;
+        $this->httpClient = $httpClient ?? HttpClientDiscovery::find();
+        $this->requestFactory = $requestFactory ?? Psr17FactoryDiscovery::findRequestFactory();
+        $this->streamFactory = $streamFactory ?? Psr17FactoryDiscovery::findStreamFactory();
 
         $this->resources = new Resources();
     }
@@ -86,33 +95,41 @@ public function getResource(string $resourceName): MtaResource
      */
     public static function getInput(): ?array
     {
-        return Translator::fromServer(Input::get())?? null;
+        return ElementTransformer::fromServer(Input::get()) ?? null;
     }
 
     public static function doReturn(...$arguments): void
     {
-        echo Translator::toServer($arguments);
+        echo ElementTransformer::toServer($arguments);
     }
 
-    public function callFunction(string $resourceName, string $function, array $arguments = null): ?array
+    public function callFunction(string $resourceName, string $functionName, array $arguments = null): ?array
     {
-        $json_output = $arguments? Translator::toServer($arguments) : '';
-        $path = sprintf('%s/call/%s', $resourceName, $function);
-        $result = $this->do_post_request($path, $json_output);
-        $out = Translator::fromServer($result);
+        $requestData = $arguments ? ElementTransformer::toServer($arguments) : '';
+        $path = sprintf('%s/call/%s', $resourceName, $functionName);
 
-        return $out?? null;
+        $responseBody = $this->executeRequest($path, $requestData);
+        $convertedResponse = ElementTransformer::fromServer($responseBody);
+
+        return $convertedResponse ?? null;
     }
 
-    public function __get($name)
+    public function __get(string $name): MtaResource
     {
         return $this->getResource($name);
     }
 
-    protected function do_post_request($path, $json_data): string
+    protected function executeRequest(string $path, string $body): string
     {
-        $request = $this->messageFactory->createRequest('POST', sprintf('%s/%s', $this->server->getBaseUri(), $path), [], $json_data);
-        $auth = new BasicAuth($this->credential->getUser(), $this->credential->getPassword());
+        $request = $this->requestFactory->createRequest(
+            'POST',
+            sprintf('%s/%s', $this->server->getBaseUri(), $path)
+        );
+
+        $streamBody = $this->streamFactory->createStream($body);
+        $request->withBody($streamBody);
+
+        $auth = new BasicAuth($this->auth->getUser(), $this->auth->getPassword());
         $request = $auth->authenticate($request);
 
         $response = $this->httpClient->sendRequest($request);

src/Response/HttpStatusVerification.php

@@ -23,23 +23,27 @@ class HttpStatusVerification
 
     public static function validateStatus(ResponseInterface $response): void
     {
-        if (HandleResponse::getBody($response) == self::ERROR_NOT_FOUND) {
-            throw new Exception('Attempted function call was not found');
-        }
-
         $statusCode = $response->getStatusCode();
 
         switch ($statusCode) {
             case 401:
-                throw new Exception('Access Denied. This server requires authentication. Please ensure that a valid username and password combination is provided.');
-                break;
+                {
+                    throw new Exception('Access Denied. This server requires authentication. Please ensure that a valid username and password combination is provided.');
+                    break;
+                }
             case 404:
-                throw new Exception('There was a problem with the request. Ensure that the resource exists and that the name is spelled correctly.');
-                break;
+                {
+                    throw new Exception('There was a problem with the request. Ensure that the resource exists and that the name is spelled correctly.');
+                    break;
+                }
         }
 
         if ($statusCode != 200) {
             throw new Exception(sprintf('Something went wrong. HTTP Status Code: %s | Body: %s', $statusCode, HandleResponse::getBody($response)));
         }
+
+        if (HandleResponse::getBody($response) == self::ERROR_NOT_FOUND) {
+            throw new Exception('Attempted function call was not found');
+        }
     }
 }

src/Utils/ElementFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+/*****************************************************************************
+ *
+ *  PROJECT:     MTA PHP SDK
+ *  LICENSE:     See LICENSE in the top level directory
+ *  FILE:        ElementFactory.php
+ *
+ *  Multi Theft Auto is available from http://www.multitheftauto.com/
+ *
+ *****************************************************************************/
+
+declare(strict_types=1);
+
+namespace MultiTheftAuto\Sdk\Utils;
+
+use MultiTheftAuto\Sdk\Model\Element;
+use MultiTheftAuto\Sdk\Model\Resource;
+
+class ElementFactory
+{
+    public static function fromServer(string $value)
+    {
+        $valuePrefix = substr($value, 0, 3);
+
+        switch ($valuePrefix) {
+            case Element::SERVER_PREFIX: {
+                return Element::fromServer($value);
+            }
+            case Resource::SERVER_PREFIX: {
+                return Resource::fromServer($value);
+            }
+        }
+
+        return $value;
+    }
+}