Skip to content

Commit 76c3a27

Browse files
nicekiwinicekiwi
committed
Update docs, code BP
1 parent 99fa2d3 commit 76c3a27

File tree

18 files changed

+128
-101
lines changed

18 files changed

+128
-101
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1+
/.idea
12
/vendor
23
composer.phar
34
.DS_Store
45
ocular.phar
56
uploadTests.sh
67
.env
7-
.phpunit.*
8+
.phpunit.*

‎composer.json‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "syntax/steam-api",
33
"description": "A steam-api client for Laravel 5.8+",
4-
"version": "2.1.0",
4+
"version": "2.1.2",
55
"license": "MIT",
66
"authors": [
77
{
@@ -12,7 +12,12 @@
1212
"require": {
1313
"php": "^7.2.0",
1414
"laravel/framework": ">=5.8.0",
15-
"guzzlehttp/guzzle": "^6.0"
15+
"guzzlehttp/guzzle": "^6.0",
16+
"ext-bcmath": "*",
17+
"ext-simplexml": "*",
18+
"ext-libxml": "*",
19+
"ext-curl": "*",
20+
"ext-json": "*"
1621
},
1722
"require-dev": {
1823
"phpunit/phpunit": "^8.0",
@@ -24,12 +29,12 @@
2429
"Syntax\\SteamApi\\": "src/Syntax/SteamApi"
2530
}
2631
},
27-
"extra": {
28-
"laravel": {
29-
"providers": [
30-
"Syntax\\SteamApi\\SteamApiServiceProvider"
31-
]
32-
}
33-
},
32+
"extra": {
33+
"laravel": {
34+
"providers": [
35+
"Syntax\\SteamApi\\SteamApiServiceProvider"
36+
]
37+
}
38+
},
3439
"minimum-stability": "stable"
3540
}

‎src/Syntax/SteamApi/Client.php‎

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,36 @@
22

33
namespace Syntax\SteamApi;
44

5+
use GuzzleHttp\Exception\GuzzleException;
6+
use Illuminate\Support\Collection;
7+
use Illuminate\Support\Facades\Config;
58
use stdClass;
69
use GuzzleHttp\Client as GuzzleClient;
710
use GuzzleHttp\Psr7\Request;
811
use Exception;
9-
use GuzzleHttp\Exception\ClientErrorResponseException;
10-
use GuzzleHttp\Exception\ServerErrorResponseException;
12+
use GuzzleHttp\Exception\ClientException;
13+
use GuzzleHttp\Exception\ServerException;
14+
use Syntax\SteamApi\Exceptions\ApiArgumentRequired;
1115
use Syntax\SteamApi\Exceptions\ApiCallFailedException;
1216
use Syntax\SteamApi\Exceptions\ClassNotFoundException;
17+
use Syntax\SteamApi\Steam\App;
18+
use Syntax\SteamApi\Steam\Group;
19+
use Syntax\SteamApi\Steam\Item;
20+
use Syntax\SteamApi\Steam\News;
21+
use Syntax\Steamapi\Steam\Package;
22+
use Syntax\SteamApi\Steam\Player;
23+
use Syntax\SteamApi\Steam\User;
24+
use Syntax\SteamApi\Steam\User\Stats;
1325

1426
/**
15-
* @method \Syntax\SteamApi\Steam\News news()
16-
* @method \Syntax\SteamApi\Steam\Player player($steamId)
17-
* @method \Syntax\SteamApi\Steam\User user($steamId)
18-
* @method \Syntax\SteamApi\Steam\User\Stats userStats($steamId)
19-
* @method \Syntax\SteamApi\Steam\App app()
20-
* @method \Syntax\Steamapi\Steam\Package package()
21-
* @method \Syntax\SteamApi\Steam\Group group()
22-
* @method \Syntax\SteamApi\Steam\Item item($appId)
27+
* @method News news()
28+
* @method Player player($steamId)
29+
* @method User user($steamId)
30+
* @method Stats userStats($steamId)
31+
* @method App app()
32+
* @method Package package()
33+
* @method Group group()
34+
* @method Item item($appId)
2335
*/
2436
class Client
2537
{
@@ -45,12 +57,15 @@ class Client
4557

4658
protected $isService = false;
4759

60+
protected $responseBody;
61+
4862
public function __construct()
4963
{
5064
$apiKey = $this->getApiKey();
5165

5266
$this->client = new GuzzleClient();
5367
$this->apiKey = $apiKey;
68+
$this->responseBody = null;
5469

5570
// Set up the Ids
5671
$this->setUpFormatted();
@@ -73,6 +88,7 @@ public function getSteamId()
7388
*
7489
* @throws ApiArgumentRequired
7590
* @throws ApiCallFailedException
91+
* @throws GuzzleException
7692
*/
7793
protected function setUpService($arguments = null)
7894
{
@@ -140,7 +156,6 @@ protected function setUpXml(array $arguments = [])
140156
$parameters = http_build_query($arguments);
141157

142158
// Pass the results back
143-
return simplexml_load_file($steamUrl . '?' . $parameters);
144159
libxml_use_internal_errors(true);
145160
$result = simplexml_load_file($steamUrl . '?' . $parameters);
146161

@@ -165,10 +180,11 @@ public function getRedirectUrl()
165180
}
166181

167182
/**
168-
* @param \GuzzleHttp\Psr7\Request $request
183+
* @param Request $request
169184
*
170-
* @return \stdClass
171-
* @throws \Syntax\SteamApi\Exceptions\ApiCallFailedException
185+
* @return stdClass
186+
* @throws ApiCallFailedException
187+
* @throws GuzzleException
172188
*/
173189
protected function sendRequest(Request $request)
174190
{
@@ -179,9 +195,9 @@ protected function sendRequest(Request $request)
179195
$result = new stdClass();
180196
$result->code = $response->getStatusCode();
181197
$result->body = json_decode($response->getBody(true));
182-
} catch (ClientErrorResponseException $e) {
198+
} catch (ClientException $e) {
183199
throw new ApiCallFailedException($e->getMessage(), $e->getResponse()->getStatusCode(), $e);
184-
} catch (ServerErrorResponseException $e) {
200+
} catch (ServerException $e) {
185201
throw new ApiCallFailedException('Api call failed to complete due to a server error.', $e->getResponse()->getStatusCode(), $e);
186202
} catch (Exception $e) {
187203
throw new ApiCallFailedException($e->getMessage(), $e->getCode(), $e);
@@ -236,7 +252,7 @@ public function __call($name, $arguments)
236252
/**
237253
* @param Collection $objects
238254
*
239-
* @return $this
255+
* @return Collection
240256
*/
241257
protected function sortObjects($objects)
242258
{
@@ -260,9 +276,7 @@ protected function getServiceResponse($arguments)
260276
$arguments = json_encode($arguments);
261277

262278
// Get the client
263-
$client = $this->setUpService($arguments)->response;
264-
265-
return $client;
279+
return $this->setUpService($arguments)->response;
266280
}
267281

268282
/**
@@ -271,7 +285,7 @@ protected function getServiceResponse($arguments)
271285
*/
272286
protected function getApiKey()
273287
{
274-
$apiKey = \Config::get('steam-api.steamApiKey');
288+
$apiKey = Config::get('steam-api.steamApiKey');
275289

276290
if ($apiKey == 'YOUR-API-KEY') {
277291
throw new Exceptions\InvalidApiKeyException();

‎src/Syntax/SteamApi/Containers/App.php‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace Syntax\SteamApi\Containers;
44

55
use Illuminate\Support\Collection;
6+
use stdClass;
67

78
class App extends BaseContainer
89
{
@@ -95,37 +96,37 @@ public function __construct($app)
9596

9697
protected function getFakeMetacriticObject()
9798
{
98-
$object = new \stdClass();
99+
$object = new stdClass();
99100
$object->url = null;
100101
$object->score = 'No Score';
101102
return $object;
102103
}
103104

104105
protected function getFakePriceObject()
105106
{
106-
$object = new \stdClass();
107+
$object = new stdClass();
107108
$object->final = 'No price found';
108109
return $object;
109110
}
110111

111112
protected function getFakeFullgameObject()
112113
{
113-
$object = new \stdClass();
114+
$object = new stdClass();
114115
$object->appid = null;
115116
$object->name = 'No parent game found';
116117
return $object;
117118
}
118119

119120
protected function getFakeRecommendationsObject()
120121
{
121-
$object = new \stdClass();
122+
$object = new stdClass();
122123
$object->total = 0;
123124
return $object;
124125
}
125126

126127
protected function getFakeAchievementsObject()
127128
{
128-
$object = new \stdClass();
129+
$object = new stdClass();
129130
$object->total = 0;
130131
return $object;
131132
}

‎src/Syntax/SteamApi/Containers/Group.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Syntax\SteamApi\Containers;
44

5+
use SimpleXMLElement;
56
use Syntax\SteamApi\Client;
67
use Illuminate\Support\Collection;
78
use Syntax\SteamApi\Containers\Group\Details;
@@ -20,7 +21,7 @@ class Group
2021
public $members;
2122

2223
/**
23-
* @param \SimpleXMLElement $group
24+
* @param SimpleXMLElement $group
2425
*/
2526
function __construct($group)
2627
{

‎src/Syntax/SteamApi/Containers/Package.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ class Package extends BaseContainer
1414
public $price;
1515
public $platforms;
1616
public $release;
17+
private $controller;
1718

1819
public function __construct($package, $id)
1920
{

‎src/Syntax/SteamApi/Containers/Player.php‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,19 +120,30 @@ protected function convertPersonaState($personaState)
120120
{
121121
switch ($personaState) {
122122
case 0:
123-
return '<span class="text-error">Offline</span>';
123+
$state = '<span class="text-error">Offline</span>';
124+
break;
124125
case 1:
125-
return '<span class="text-success">Online</span>';
126+
$state = '<span class="text-success">Online</span>';
127+
break;
126128
case 2:
127-
return '<span class="text-warning">Busy</span>';
129+
$state = '<span class="text-warning">Busy</span>';
130+
break;
128131
case 3:
129-
return '<span class="text-warning">Away</span>';
132+
$state = '<span class="text-warning">Away</span>';
133+
break;
130134
case 4:
131-
return '<span class="text-warning">Snooze</span>';
135+
$state = '<span class="text-warning">Snooze</span>';
136+
break;
132137
case 5:
133-
return 'Looking to Trade';
138+
$state = 'Looking to Trade';
139+
break;
134140
case 6:
135-
return 'Looking to Play';
141+
$state = 'Looking to Play';
142+
break;
143+
default:
144+
$state = 'Unknown';
136145
}
146+
147+
return $state;
137148
}
138149
}

‎src/Syntax/SteamApi/Exceptions/ApiCallFailedException.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
class ApiCallFailedException extends \Exception
66
{
77
/**
8-
* @param string $message
8+
* @param string $message
9+
* @param $code
910
* @param \Exception $previous
1011
*/
1112
public function __construct($message, $code, $previous = null)

‎src/Syntax/SteamApi/Exceptions/UnrecognizedId.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ class UnrecognizedId extends \Exception
66
{
77
/**
88
* @param string $message
9+
* @param int $code
10+
* @param null $previous
911
*/
1012
public function __construct($message, $code = 0, $previous = null)
1113
{

‎src/Syntax/SteamApi/Steam/App.php‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,25 @@
88

99
class App extends Client
1010
{
11-
public function __construct()
11+
/**
12+
* @var bool
13+
*/
14+
private $collection;
15+
16+
public function __construct($collection = false)
1217
{
1318
parent::__construct();
1419
$this->url = 'http://store.steampowered.com/';
1520
$this->interface = 'api';
21+
$this->collection = $collection;
1622
}
1723

24+
/**
25+
* @param $appIds
26+
* @param null $country
27+
* @param null $language
28+
* @return Collection
29+
*/
1830
public function appDetails($appIds, $country = null, $language = null)
1931
{
2032
// Set up the api details
@@ -30,9 +42,8 @@ public function appDetails($appIds, $country = null, $language = null)
3042

3143
// Get the client
3244
$client = $this->setUpClient($arguments);
33-
$apps = $this->convertToObjects($client);
3445

35-
return $apps;
46+
return $this->convertToObjects($client);
3647
}
3748

3849
public function GetAppList()

0 commit comments

Comments
 (0)