Skip to content

Commit 87cc3ac

Browse files
kylekzkylekz
committed
refactor dtos
1 parent 8616279 commit 87cc3ac

17 files changed

+969
-414
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ChallongePHP
2-
Package for interfacing with the [Challonge] API.
2+
PSR-18 compatible package for interfacing with the [Challonge] API.
33

44
You can find basic documentation in the wiki: https://github.com/teamreflex/ChallongePHP/wiki
55

‎composer.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"name": "team-reflex/challonge-php",
3-
"description": "Unofficial API to interface with the bracket generator Challonge.",
3+
"description": "PSR-18 compatible library to interface with the bracket generator Challonge.",
44
"require": {
5+
"ext-json": "*",
56
"php": "^7.4",
67
"psr/http-client": "^1.0",
7-
"ext-json": "*",
88
"illuminate/collections": "^8.11",
99
"spatie/data-transfer-object": "^2.5"
1010
},

‎src/Challonge/Challonge.php

+65-65
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
use Illuminate\Support\Collection;
66
use Psr\Http\Client\ClientInterface;
77
use Reflex\Challonge\DTO\Match;
8-
use Reflex\Challonge\Helpers\Guzzle;
98
use Reflex\Challonge\DTO\Tournament;
109
use Reflex\Challonge\DTO\Participant;
1110

@@ -96,95 +95,96 @@ public function fetchTournament(string $tournament): Tournament
9695

9796
/**
9897
* Retrieve a tournament's participant list.
99-
*
100-
* @param string $tournament
101-
* @return array
98+
* @param string $tournament
99+
* @return Collection
100+
* @throws Exceptions\InvalidFormatException
101+
* @throws Exceptions\NotFoundException
102+
* @throws Exceptions\ServerException
103+
* @throws Exceptions\UnauthorizedException
104+
* @throws Exceptions\UnexpectedErrorException
105+
* @throws Exceptions\ValidationException
106+
* @throws \JsonException
102107
*/
103-
public function getParticipants($tournament)
108+
public function getParticipants(string $tournament): Collection
104109
{
105-
$response = Guzzle::get("tournaments/{$tournament}/participants");
106-
107-
$participants = [];
108-
foreach ($response as $team) {
109-
$participant = new Participant($team->participant);
110-
$participant->tournament_slug = $tournament;
111-
$participants[] = $participant;
112-
}
113-
114-
return $participants;
110+
$response = $this->client->request('get', "tournaments/{$tournament}/participants");
111+
return Collection::make($response)
112+
->map(fn (array $participant) => Participant::fromResponse($this->client, $participant['participant']));
115113
}
116114

117115
/**
118116
* Randomize seeds among participants.
119-
*
120-
* @param string $tournament
121-
* @return array
117+
* @param string $tournament
118+
* @return Collection
119+
* @throws Exceptions\InvalidFormatException
120+
* @throws Exceptions\NotFoundException
121+
* @throws Exceptions\ServerException
122+
* @throws Exceptions\UnauthorizedException
123+
* @throws Exceptions\UnexpectedErrorException
124+
* @throws Exceptions\ValidationException
125+
* @throws \JsonException
122126
*/
123-
public function randomizeParticipants($tournament)
127+
public function randomizeParticipants(string $tournament): Collection
124128
{
125-
$response = Guzzle::post("tournaments/{$tournament}/participants/randomize");
126-
127-
$participants = [];
128-
foreach ($response as $team) {
129-
$participant = new Participant($team->participant);
130-
$participant->tournament_slug = $tournament;
131-
$participants[] = $participant;
132-
}
133-
134-
return $participants;
129+
$response = $this->client->request('post', "tournaments/{$tournament}/participants/randomize");
130+
return Collection::make($response)
131+
->map(fn (array $participant) => Participant::fromResponse($this->client, $participant['participant']));
135132
}
136133

137134
/**
138135
* Retrieve a single participant record for a tournament.
139-
*
140-
* @param string $tournament
141-
* @param string $participant
142-
* @return array
136+
* @param string $tournament
137+
* @param int $participant
138+
* @return Participant
139+
* @throws Exceptions\InvalidFormatException
140+
* @throws Exceptions\NotFoundException
141+
* @throws Exceptions\ServerException
142+
* @throws Exceptions\UnauthorizedException
143+
* @throws Exceptions\UnexpectedErrorException
144+
* @throws Exceptions\ValidationException
145+
* @throws \JsonException
143146
*/
144-
public function getParticipant($tournament, $participant)
147+
public function getParticipant(string $tournament, int $participant): Participant
145148
{
146-
$response = Guzzle::get("tournaments/{$tournament}/participants/{$participant}");
147-
148-
$participant = new Participant($response->participant);
149-
$participant->tournament_slug = $tournament;
150-
151-
return $participant;
149+
$response = $this->client->request('post', "tournaments/{$tournament}/participants/{$participant}");
150+
return Participant::fromResponse($this->client, $response['participant']);
152151
}
153152

154153
/**
155154
* Retrieve a tournament's match list.
156-
*
157-
* @param string $tournament
158-
* @return array
155+
* @param string $tournament
156+
* @return Collection
157+
* @throws Exceptions\InvalidFormatException
158+
* @throws Exceptions\NotFoundException
159+
* @throws Exceptions\ServerException
160+
* @throws Exceptions\UnauthorizedException
161+
* @throws Exceptions\UnexpectedErrorException
162+
* @throws Exceptions\ValidationException
163+
* @throws \JsonException
159164
*/
160-
public function getMatches($tournament)
165+
public function getMatches(string $tournament): Collection
161166
{
162-
$response = Guzzle::get("tournaments/{$tournament}/matches");
163-
164-
$matches = [];
165-
foreach ($response as $match) {
166-
$matchModel = new Match($match->match);
167-
$matchModel->tournament_slug = $tournament;
168-
$matches[] = $matchModel;
169-
}
170-
171-
return $matches;
167+
$response = $this->client->request('get', "tournaments/{$tournament}/matches");
168+
return Collection::make($response)
169+
->map(fn (array $match) => Match::fromResponse($this->client, $match['match']));
172170
}
173171

174172
/**
175173
* Retrieve a single match record for a tournament.
176-
*
177-
* @param string $tournament
178-
* @param string $match
179-
* @return array
174+
* @param string $tournament
175+
* @param int $match
176+
* @return Match
177+
* @throws Exceptions\InvalidFormatException
178+
* @throws Exceptions\NotFoundException
179+
* @throws Exceptions\ServerException
180+
* @throws Exceptions\UnauthorizedException
181+
* @throws Exceptions\UnexpectedErrorException
182+
* @throws Exceptions\ValidationException
183+
* @throws \JsonException
180184
*/
181-
public function getMatch($tournament, $match)
185+
public function getMatch(string $tournament, int $match): Match
182186
{
183-
$response = Guzzle::get("tournaments/{$tournament}/matches/{$match}");
184-
185-
$match = new Match($response->match);
186-
$match->tournament_slug = $tournament;
187-
188-
return $match;
187+
$response = $this->client->request('get', "tournaments/{$tournament}/matches/{$match}");
188+
return Match::fromResponse($this->client, $response['match']);
189189
}
190190
}

‎src/Challonge/DTO/Match.php

+51-8
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,63 @@
22

33
namespace Reflex\Challonge\DTO;
44

5-
use Reflex\Challonge\Model;
6-
use Reflex\Challonge\Helpers\Guzzle;
5+
use Reflex\Challonge\DtoClientTrait;
6+
use Spatie\DataTransferObject\DataTransferObject;
77

8-
class Match extends Model
8+
class Match extends DataTransferObject
99
{
10+
use DtoClientTrait;
11+
12+
public ?int $attachment_count;
13+
public ?string $completed_at;
14+
public string $created_at;
15+
public ?bool $forfeited;
16+
public ?int $group_id;
17+
public bool $has_attachment;
18+
public int $id;
19+
public string $identifier;
20+
public ?string $location;
21+
public ?int $loser_id;
22+
public ?string $open_graph_image_file_name;
23+
public ?string $open_graph_image_content_type;
24+
public ?string $open_graph_image_file_size;
25+
public bool $optional;
26+
public int $player1_id;
27+
public bool $player1_is_prereq_match_loser;
28+
public ?int $player1_prereq_match_id;
29+
public ?int $player1_votes;
30+
public ?int $player2_id;
31+
public bool $player2_is_prereq_match_loser;
32+
public ?int $player2_prereq_match_id;
33+
public ?int $player2_votes;
34+
public int $round;
35+
public ?int $rushb_id;
36+
public ?string $scheduled_time;
37+
public ?string $started_at;
38+
public string $state;
39+
public $suggested_play_order;
40+
public int $tournament_id;
41+
public ?string $underway_at;
42+
public string $updated_at;
43+
public ?int $winner_id;
44+
public ?string $prerequisite_match_ids_csv;
45+
public ?string $scores_csv;
46+
1047
/**
1148
* Update/submit the score(s) for a match.
12-
*
13-
* @param array $params
49+
* @param array $options
1450
* @return Match
51+
* @throws \JsonException
52+
* @throws \Reflex\Challonge\Exceptions\InvalidFormatException
53+
* @throws \Reflex\Challonge\Exceptions\NotFoundException
54+
* @throws \Reflex\Challonge\Exceptions\ServerException
55+
* @throws \Reflex\Challonge\Exceptions\UnauthorizedException
56+
* @throws \Reflex\Challonge\Exceptions\UnexpectedErrorException
57+
* @throws \Reflex\Challonge\Exceptions\ValidationException
1558
*/
16-
public function update($params = [])
59+
public function update(array $options = []): Match
1760
{
18-
$response = Guzzle::put("tournaments/{$this->tournament_slug}/matches/{$this->id}", $params);
19-
return $this->updateModel($response->match);
61+
$response = $this->client->request('put', "tournaments/{$this->tournament_id}/matches/{$this->id}", $options);
62+
return self::fromResponse($this->client, $response['match']);
2063
}
2164
}

‎src/Challonge/DTO/Participant.php

+64-11
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,83 @@
22

33
namespace Reflex\Challonge\DTO;
44

5-
use Reflex\Challonge\Model;
5+
use Reflex\Challonge\DtoClientTrait;
6+
use Spatie\DataTransferObject\DataTransferObject;
67

7-
class Participant extends Model
8+
class Participant extends DataTransferObject
89
{
10+
use DtoClientTrait;
11+
12+
public bool $active;
13+
public bool $check_in_open;
14+
public ?string $checked_in_at;
15+
public string $created_at;
16+
public $clinch;
17+
public $custom_field_response;
18+
public string $display_name;
19+
public ?int $final_rank;
20+
public ?int $group_id;
21+
public array $group_player_ids;
22+
public bool $has_irrelevant_seed;
23+
public ?string $icon;
24+
public int $id;
25+
public ?array $integration_uids;
26+
public ?int $invitation_id;
27+
public ?string $invite_email;
28+
public ?string $misc;
29+
public string $name;
30+
public bool $on_waiting_list;
31+
public int $seed;
32+
public int $tournament_id;
33+
public string $updated_at;
34+
public ?string $challonge_username;
35+
public ?string $challonge_email_address_verified;
36+
public $ranked_member_id;
37+
public bool $removable;
38+
public bool $participatable_or_invitation_attached;
39+
public bool $confirm_remove;
40+
public bool $invitation_pending;
41+
public string $display_name_with_invitation_email_address;
42+
public ?string $email_hash;
43+
public ?string $username;
44+
public ?string $attached_participatable_portrait_url;
45+
public bool $can_check_in;
46+
public bool $checked_in;
47+
public bool $reactivatable;
48+
949
/**
1050
* Update the attributes of a tournament participant.
11-
*
12-
* @param array $params
51+
* @param array $options
1352
* @return Participant
53+
* @throws \JsonException
54+
* @throws \Reflex\Challonge\Exceptions\InvalidFormatException
55+
* @throws \Reflex\Challonge\Exceptions\NotFoundException
56+
* @throws \Reflex\Challonge\Exceptions\ServerException
57+
* @throws \Reflex\Challonge\Exceptions\UnauthorizedException
58+
* @throws \Reflex\Challonge\Exceptions\UnexpectedErrorException
59+
* @throws \Reflex\Challonge\Exceptions\ValidationException
1460
*/
15-
public function update($params = [])
61+
public function update(array $options = []): Participant
1662
{
17-
$response = Guzzle::put("tournaments/{$this->tournament_slug}/participants/{$this->id}", $params);
18-
return $this->updateModel($response->participant);
63+
$response = $this->client->request('put', "tournaments/{$this->tournament_id}/participants/{$this->id}", $options);
64+
return self::fromResponse($this->client, $response['participant']);
1965
}
2066

2167
/**
2268
* If the tournament has not started, delete a participant, automatically filling in the abandoned seed number.
23-
*
24-
* @return boolean
69+
* @return bool
70+
* @throws \JsonException
71+
* @throws \Reflex\Challonge\Exceptions\InvalidFormatException
72+
* @throws \Reflex\Challonge\Exceptions\NotFoundException
73+
* @throws \Reflex\Challonge\Exceptions\ServerException
74+
* @throws \Reflex\Challonge\Exceptions\UnauthorizedException
75+
* @throws \Reflex\Challonge\Exceptions\UnexpectedErrorException
76+
* @throws \Reflex\Challonge\Exceptions\ValidationException
2577
*/
26-
public function delete()
78+
public function delete(): bool
2779
{
28-
$response = Guzzle::delete("tournaments/{$this->tournament_slug}/participants/{$this->id}");
80+
$response = $this->client->request('delete', "tournaments/{$this->tournament_id}/participants/{$this->id}");
81+
// TODO: validate response
2982
return true;
3083
}
3184
}

0 commit comments

Comments
 (0)