Merge branch 'best-practice-updates'

# Conflicts:
#	composer.json

Author: nicekiwi

.gitignore

@@ -1,7 +1,8 @@
+/.idea
 /vendor
 composer.phar
 .DS_Store
 ocular.phar
 uploadTests.sh
 .env
-.phpunit.*
+.phpunit.*

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "syntax/steam-api",
   "description": "A steam-api client for Laravel 5.8+",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "license": "MIT",
   "authors": [
     {
@@ -12,7 +12,12 @@
   "require": {
     "php": "^7.2.0",
     "laravel/framework": ">=5.8.0",
-    "guzzlehttp/guzzle": "^6.0"
+    "guzzlehttp/guzzle": "^6.0",
+    "ext-bcmath": "*",
+    "ext-simplexml": "*",
+    "ext-libxml": "*",
+    "ext-curl": "*",
+    "ext-json": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^8.0",
@@ -24,12 +29,12 @@
       "Syntax\\SteamApi\\": "src/Syntax/SteamApi"
     }
   },
-   "extra": {
-       "laravel": {
-           "providers": [
-               "Syntax\\SteamApi\\SteamApiServiceProvider"
-           ]
-       }
-   },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Syntax\\SteamApi\\SteamApiServiceProvider"
+      ]
+    }
+  },
   "minimum-stability": "stable"
 }

src/Syntax/SteamApi/Client.php

@@ -2,24 +2,36 @@
 
 namespace Syntax\SteamApi;
 
+use GuzzleHttp\Exception\GuzzleException;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Config;
 use stdClass;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Psr7\Request;
 use Exception;
-use GuzzleHttp\Exception\ClientErrorResponseException;
-use GuzzleHttp\Exception\ServerErrorResponseException;
+use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\ServerException;
+use Syntax\SteamApi\Exceptions\ApiArgumentRequired;
 use Syntax\SteamApi\Exceptions\ApiCallFailedException;
 use Syntax\SteamApi\Exceptions\ClassNotFoundException;
+use Syntax\SteamApi\Steam\App;
+use Syntax\SteamApi\Steam\Group;
+use Syntax\SteamApi\Steam\Item;
+use Syntax\SteamApi\Steam\News;
+use Syntax\Steamapi\Steam\Package;
+use Syntax\SteamApi\Steam\Player;
+use Syntax\SteamApi\Steam\User;
+use Syntax\SteamApi\Steam\User\Stats;
 
 /**
- * @method \Syntax\SteamApi\Steam\News       news()
- * @method \Syntax\SteamApi\Steam\Player     player($steamId)
- * @method \Syntax\SteamApi\Steam\User       user($steamId)
- * @method \Syntax\SteamApi\Steam\User\Stats userStats($steamId)
- * @method \Syntax\SteamApi\Steam\App        app()
- * @method \Syntax\Steamapi\Steam\Package    package()
- * @method \Syntax\SteamApi\Steam\Group      group()
- * @method \Syntax\SteamApi\Steam\Item       item($appId)
+ * @method News       news()
+ * @method Player     player($steamId)
+ * @method User       user($steamId)
+ * @method Stats      userStats($steamId)
+ * @method App        app()
+ * @method Package    package()
+ * @method Group      group()
+ * @method Item       item($appId)
  */
 class Client
 {
@@ -73,6 +85,7 @@ public function getSteamId()
      *
      * @throws ApiArgumentRequired
      * @throws ApiCallFailedException
+     * @throws GuzzleException
      */
     protected function setUpService($arguments = null)
     {
@@ -140,7 +153,6 @@ protected function setUpXml(array $arguments = [])
         $parameters = http_build_query($arguments);
 
         // Pass the results back
-        return simplexml_load_file($steamUrl . '?' . $parameters);
         libxml_use_internal_errors(true);
         $result = simplexml_load_file($steamUrl . '?' . $parameters);
 
@@ -165,10 +177,11 @@ public function getRedirectUrl()
     }
 
     /**
-     * @param \GuzzleHttp\Psr7\Request $request
+     * @param Request $request
      *
-     * @return \stdClass
-     * @throws \Syntax\SteamApi\Exceptions\ApiCallFailedException
+     * @return stdClass
+     * @throws ApiCallFailedException
+     * @throws GuzzleException
      */
     protected function sendRequest(Request $request)
     {
@@ -179,9 +192,9 @@ protected function sendRequest(Request $request)
             $result       = new stdClass();
             $result->code = $response->getStatusCode();
             $result->body = json_decode($response->getBody(true));
-        } catch (ClientErrorResponseException $e) {
+        } catch (ClientException $e) {
             throw new ApiCallFailedException($e->getMessage(), $e->getResponse()->getStatusCode(), $e);
-        } catch (ServerErrorResponseException $e) {
+        } catch (ServerException $e) {
             throw new ApiCallFailedException('Api call failed to complete due to a server error.', $e->getResponse()->getStatusCode(), $e);
         } catch (Exception $e) {
             throw new ApiCallFailedException($e->getMessage(), $e->getCode(), $e);
@@ -236,7 +249,7 @@ public function __call($name, $arguments)
     /**
      * @param Collection $objects
      *
-     * @return $this
+     * @return Collection
      */
     protected function sortObjects($objects)
     {
@@ -260,9 +273,7 @@ protected function getServiceResponse($arguments)
         $arguments = json_encode($arguments);
 
         // Get the client
-        $client = $this->setUpService($arguments)->response;
-
-        return $client;
+        return $this->setUpService($arguments)->response;
     }
 
     /**
@@ -271,7 +282,7 @@ protected function getServiceResponse($arguments)
      */
     protected function getApiKey()
     {
-        $apiKey = \Config::get('steam-api.steamApiKey');
+        $apiKey = Config::get('steam-api.steamApiKey');
 
         if ($apiKey == 'YOUR-API-KEY') {
             throw new Exceptions\InvalidApiKeyException();

src/Syntax/SteamApi/Containers/App.php

@@ -3,6 +3,7 @@
 namespace Syntax\SteamApi\Containers;
 
 use Illuminate\Support\Collection;
+use stdClass;
 
 class App extends BaseContainer
 {
@@ -95,37 +96,37 @@ public function __construct($app)
 
     protected function getFakeMetacriticObject()
     {
-        $object        = new \stdClass();
+        $object        = new stdClass();
         $object->url   = null;
         $object->score = 'No Score';
         return $object;
     }
 
     protected function getFakePriceObject()
     {
-        $object        = new \stdClass();
+        $object        = new stdClass();
         $object->final = 'No price found';
         return $object;
     }
 
     protected function getFakeFullgameObject()
     {
-        $object        = new \stdClass();
+        $object        = new stdClass();
         $object->appid = null;
         $object->name  = 'No parent game found';
         return $object;
     }
 
     protected function getFakeRecommendationsObject()
     {
-        $object        = new \stdClass();
+        $object        = new stdClass();
         $object->total = 0;
         return $object;
     }
 
     protected function getFakeAchievementsObject()
     {
-        $object        = new \stdClass();
+        $object        = new stdClass();
         $object->total = 0;
         return $object;
     }

src/Syntax/SteamApi/Containers/Group.php

@@ -2,6 +2,7 @@
 
 namespace Syntax\SteamApi\Containers;
 
+use SimpleXMLElement;
 use Syntax\SteamApi\Client;
 use Illuminate\Support\Collection;
 use Syntax\SteamApi\Containers\Group\Details;
@@ -20,7 +21,7 @@ class Group
     public $members;
 
     /**
-     * @param \SimpleXMLElement $group
+     * @param SimpleXMLElement $group
      */
     function __construct($group)
     {

src/Syntax/SteamApi/Containers/Package.php

@@ -14,6 +14,7 @@ class Package extends BaseContainer
     public $price;
     public $platforms;
     public $release;
+    private $controller;
 
     public function __construct($package, $id)
     {

src/Syntax/SteamApi/Containers/Player.php

@@ -120,19 +120,30 @@ protected function convertPersonaState($personaState)
     {
         switch ($personaState) {
             case 0:
-                return '<span class="text-error">Offline</span>';
+                $state = '<span class="text-error">Offline</span>';
+                break;
             case 1:
-                return '<span class="text-success">Online</span>';
+                $state = '<span class="text-success">Online</span>';
+                break;
             case 2:
-                return '<span class="text-warning">Busy</span>';
+                $state = '<span class="text-warning">Busy</span>';
+                break;
             case 3:
-                return '<span class="text-warning">Away</span>';
+                $state = '<span class="text-warning">Away</span>';
+                break;
             case 4:
-                return '<span class="text-warning">Snooze</span>';
+                $state = '<span class="text-warning">Snooze</span>';
+                break;
             case 5:
-                return 'Looking to Trade';
+                $state = 'Looking to Trade';
+                break;
             case 6:
-                return 'Looking to Play';
+                $state = 'Looking to Play';
+                break;
+            default:
+                $state = 'Unknown';
         }
+
+        return $state;
     }
 }

src/Syntax/SteamApi/Exceptions/ApiCallFailedException.php

@@ -5,7 +5,8 @@
 class ApiCallFailedException extends \Exception
 {
     /**
-     * @param string     $message
+     * @param string $message
+     * @param $code
      * @param \Exception $previous
      */
     public function __construct($message, $code, $previous = null)

src/Syntax/SteamApi/Exceptions/UnrecognizedId.php

@@ -6,6 +6,8 @@ class UnrecognizedId extends \Exception
 {
     /**
      * @param string $message
+     * @param int $code
+     * @param null $previous
      */
     public function __construct($message, $code = 0, $previous = null)
     {

src/Syntax/SteamApi/Steam/App.php

@@ -8,13 +8,23 @@
 
 class App extends Client
 {
+    /**
+     * @var bool
+     */
+
     public function __construct()
     {
         parent::__construct();
         $this->url       = 'http://store.steampowered.com/';
         $this->interface = 'api';
     }
 
+    /**
+     * @param $appIds
+     * @param null $country
+     * @param null $language
+     * @return Collection
+     */
     public function appDetails($appIds, $country = null, $language = null)
     {
         // Set up the api details
@@ -30,9 +40,8 @@ public function appDetails($appIds, $country = null, $language = null)
 
         // Get the client
         $client = $this->setUpClient($arguments);
-        $apps   = $this->convertToObjects($client);
 
-        return $apps;
+        return $this->convertToObjects($client);
     }
 
     public function GetAppList()