level23 /
dynadot-api
| Total Complexity | 46 |
| Total Lines | 574 |
| Duplicated Lines | 0 % |
| Coverage | 93.28% |
| Changes | 5 | ||
| Bugs | 0 | Features | 0 |
Complex classes like DynadotApi often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use DynadotApi, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 29 | class DynadotApi |
||
| 30 | { |
||
| 31 | const DYNADOT_API_URL = 'https://api.dynadot.com/api3.xml'; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * This options array is used by Guzzle. |
||
| 35 | * |
||
| 36 | * We currently use it to set the Mock Handler in unit testing. |
||
| 37 | * |
||
| 38 | * @var array |
||
| 39 | */ |
||
| 40 | protected $guzzleOptions = []; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Dynadot's API key we should use for HTTP calls. |
||
| 44 | * |
||
| 45 | * @var string |
||
| 46 | */ |
||
| 47 | protected $apiKey; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Logger for writing debug info |
||
| 51 | * |
||
| 52 | * @var LoggerInterface|null |
||
| 53 | */ |
||
| 54 | protected $logger; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Changes boolean values like "no" and "yes" into false and true. |
||
| 58 | * |
||
| 59 | * @return bool |
||
| 60 | * @throws DynadotApiException |
||
| 61 | * @var \Closure |
||
| 62 | */ |
||
| 63 | protected $booleanDeserializer; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Return the contact id |
||
| 67 | * |
||
| 68 | * @param Reader $reader |
||
| 69 | * |
||
| 70 | * @return int |
||
| 71 | * @var \Closure |
||
| 72 | */ |
||
| 73 | protected $contactIdDeserializer; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * DynadotApi constructor. |
||
| 77 | * |
||
| 78 | * @param string $apiKey The API key we should use while communicating with the Dynadot API. |
||
| 79 | * @param \Psr\Log\LoggerInterface|null $logger |
||
| 80 | * |
||
| 81 | * @internal param $Logger |
||
| 82 | */ |
||
| 83 | 28 | public function __construct(string $apiKey, LoggerInterface $logger = null) |
|
| 134 | 28 | }; |
|
| 135 | } |
||
| 136 | |||
| 137 | /** |
||
| 138 | * @param array $optionsArray |
||
| 139 | */ |
||
| 140 | 28 | public function setGuzzleOptions(array $optionsArray): void |
|
| 143 | } |
||
| 144 | |||
| 145 | /** |
||
| 146 | * Get info about a domain |
||
| 147 | * |
||
| 148 | * @param string $domain |
||
| 149 | * |
||
| 150 | * @return DomainResponse\Domain |
||
| 151 | * @throws \Level23\Dynadot\Exception\ApiHttpCallFailedException |
||
| 152 | * @throws \Level23\Dynadot\Exception\DynadotApiException |
||
| 153 | * @throws \Sabre\Xml\ParseException |
||
| 154 | * @throws \GuzzleHttp\Exception\GuzzleException |
||
| 155 | */ |
||
| 156 | 7 | public function getDomainInfo(string $domain): DomainResponse\Domain |
|
| 157 | { |
||
| 158 | 7 | $this->log(LogLevel::INFO, 'Retrieve info for domain: ' . $domain); |
|
| 159 | |||
| 160 | 7 | $requestData = [ |
|
| 161 | 7 | 'domain' => $domain, |
|
| 162 | 7 | 'command' => 'domain_info', |
|
| 163 | 7 | ]; |
|
| 164 | |||
| 165 | // perform the API call |
||
| 166 | 7 | $response = $this->performRawApiCall($requestData); |
|
| 167 | |||
| 168 | // start parsing XML data using Sabre |
||
| 169 | 6 | $sabreService = new Service(); |
|
| 170 | |||
| 171 | // set mapping |
||
| 172 | 6 | $sabreService->elementMap = [ |
|
| 173 | 6 | '{}Registrant' => $this->contactIdDeserializer, |
|
| 174 | 6 | '{}Admin' => $this->contactIdDeserializer, |
|
| 175 | 6 | '{}Technical' => $this->contactIdDeserializer, |
|
| 176 | 6 | '{}Billing' => $this->contactIdDeserializer, |
|
| 177 | 6 | '{}isForSale' => $this->booleanDeserializer, |
|
| 178 | 6 | '{}Hold' => $this->booleanDeserializer, |
|
| 179 | 6 | '{}RegistrantUnverified' => $this->booleanDeserializer, |
|
| 180 | 6 | '{}UdrpLocked' => $this->booleanDeserializer, |
|
| 181 | 6 | '{}Disabled' => $this->booleanDeserializer, |
|
| 182 | 6 | '{}Locked' => $this->booleanDeserializer, |
|
| 183 | 6 | '{}WithAds' => $this->booleanDeserializer, |
|
| 184 | 6 | ]; |
|
| 185 | |||
| 186 | // map certain values to objects |
||
| 187 | 6 | $sabreService->mapValueObject('{}DomainInfoResponse', DomainInfoResponse\DomainInfoResponse::class); |
|
| 188 | 6 | $sabreService->mapValueObject('{}DomainInfoHeader', DomainInfoResponse\DomainInfoHeader::class); |
|
| 189 | 6 | $sabreService->mapValueObject('{}DomainInfoContent', DomainInfoResponse\DomainInfoContent::class); |
|
| 190 | 6 | $sabreService->mapValueObject('{}Domain', DomainResponse\Domain::class); |
|
| 191 | 6 | $sabreService->mapValueObject('{}NameServerSettings', DomainResponse\NameServerSettings::class); |
|
| 192 | 6 | $sabreService->mapValueObject('{}NameServer', DomainResponse\NameServer::class); |
|
| 193 | 6 | $sabreService->mapValueObject('{}Whois', DomainResponse\Whois::class); |
|
| 194 | 6 | $sabreService->mapValueObject('{}Folder', DomainResponse\Folder::class); |
|
| 195 | 6 | $sabreService->mapValueObject('{}Response', GeneralResponse\Response::class); |
|
| 196 | 6 | $sabreService->mapValueObject('{}ResponseHeader', GeneralResponse\ResponseHeader::class); |
|
| 197 | |||
| 198 | 6 | $this->log(LogLevel::DEBUG, 'Start parsing response XML'); |
|
| 199 | |||
| 200 | 6 | $contents = $response->getContents(); |
|
| 201 | |||
| 202 | // parse the data |
||
| 203 | 6 | $resultData = $sabreService->parse($contents); |
|
| 204 | |||
| 205 | 5 | if (!$resultData instanceof DomainInfoResponse\DomainInfoResponse) { |
|
| 206 | 2 | throw new DynadotApiException('We failed to parse the response'); |
|
| 207 | } |
||
| 208 | |||
| 209 | 3 | $code = $resultData->DomainInfoHeader->ResponseCode ?? $resultData->DomainInfoHeader->SuccessCode; |
|
|
Bug
introduced
by
|
|||
| 210 | 3 | if ($code != GeneralResponse\ResponseHeader::RESPONSECODE_OK) { |
|
| 211 | 1 | throw new DynadotApiException($resultData->DomainInfoHeader->Error); |
|
| 212 | } |
||
| 213 | |||
| 214 | 2 | if ($resultData->DomainInfoHeader !== null) { |
|
| 215 | /** |
||
| 216 | * Check if the API call was successful. If not, return the error |
||
| 217 | */ |
||
| 218 | 2 | $code = $resultData->DomainInfoHeader->SuccessCode; |
|
| 219 | 2 | if ($code != DomainInfoResponse\DomainInfoHeader::SUCCESSCODE_OK) { |
|
| 220 | throw new DynadotApiException($resultData->DomainInfoHeader->Error); |
||
| 221 | } |
||
| 222 | } |
||
| 223 | |||
| 224 | 2 | $this->log(LogLevel::DEBUG, 'Returning domain info'); |
|
| 225 | |||
| 226 | // Here we know our API call was succesful, return the domain info. |
||
| 227 | 2 | return $resultData->DomainInfoContent->Domain; |
|
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Log a message to our logger, if we have any. |
||
| 232 | * |
||
| 233 | * @param string $level |
||
| 234 | * @param string $message |
||
| 235 | */ |
||
| 236 | 27 | protected function log(string $level, string $message): void |
|
| 237 | { |
||
| 238 | 27 | if ($this->logger instanceof LoggerInterface) { |
|
| 239 | 1 | $this->logger->log($level, $message); |
|
| 240 | } |
||
| 241 | } |
||
| 242 | |||
| 243 | /** |
||
| 244 | * Performs the actual API call (internal method) |
||
| 245 | * |
||
| 246 | * @param array $requestData |
||
| 247 | * |
||
| 248 | * @return \Psr\Http\Message\StreamInterface |
||
| 249 | * @throws \GuzzleHttp\Exception\GuzzleException |
||
| 250 | * @throws \Level23\Dynadot\Exception\ApiHttpCallFailedException |
||
| 251 | */ |
||
| 252 | 26 | protected function performRawApiCall(array $requestData): StreamInterface |
|
| 253 | { |
||
| 254 | 26 | $this->log(LogLevel::DEBUG, 'Perform raw call: ' . var_export($requestData, true)); |
|
| 255 | |||
| 256 | // transform the request data into a valid query string |
||
| 257 | 26 | $requestDataHttp = http_build_query($requestData); |
|
| 258 | |||
| 259 | // spawn Guzzle |
||
| 260 | 26 | $client = new Client($this->guzzleOptions); |
|
| 261 | |||
| 262 | 26 | $url = self::DYNADOT_API_URL . |
|
| 263 | 26 | '?key=' . urlencode($this->getApiKey()) . |
|
| 264 | 26 | ($requestDataHttp ? '&' . $requestDataHttp : ''); |
|
| 265 | |||
| 266 | 26 | $this->log(LogLevel::DEBUG, 'Start new guzzle request with URL: ' . $url); |
|
| 267 | |||
| 268 | // start a request with out API key and optionally our request data |
||
| 269 | 26 | $response = $client->request('GET', $url); |
|
| 270 | |||
| 271 | 26 | $this->log(LogLevel::DEBUG, 'Received response with status code ' . $response->getStatusCode()); |
|
| 272 | |||
| 273 | // if we did not get a HTTP 200 response, our HTTP call failed (which is different from a failed API call) |
||
| 274 | 26 | if ($response->getStatusCode() != 200) { |
|
| 275 | 1 | $this->log(LogLevel::ALERT, 'Received wrong HTTP status code: ' . $response->getStatusCode()); |
|
| 276 | // not ok |
||
| 277 | 1 | throw new ApiHttpCallFailedException( |
|
| 278 | 1 | 'HTTP API call failed, expected 200 status, got ' . $response->getStatusCode() |
|
| 279 | 1 | ); |
|
| 280 | } |
||
| 281 | |||
| 282 | // Return the response body (which is a stream coming from Guzzle). |
||
| 283 | // Sabre XML semi-handles streams (it will just get the contents of the stream using stream_get_contents) so |
||
| 284 | // this should work! ;) |
||
| 285 | 25 | return $response->getBody(); |
|
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * @return string |
||
| 290 | */ |
||
| 291 | 27 | public function getApiKey(): string |
|
| 292 | { |
||
| 293 | 27 | return $this->apiKey; |
|
| 294 | } |
||
| 295 | |||
| 296 | /** |
||
| 297 | * @param string $apiKey |
||
| 298 | */ |
||
| 299 | 28 | public function setApiKey(string $apiKey): void |
|
| 300 | { |
||
| 301 | 28 | $this->apiKey = $apiKey; |
|
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Set nameservers for a domain (max 13). An exception will be thrown in case of an error. |
||
| 306 | * |
||
| 307 | * @param string $domain The domain where to set the nameservers for. |
||
| 308 | * @param array $nameservers |
||
| 309 | * |
||
| 310 | * @throws \GuzzleHttp\Exception\GuzzleException |
||
| 311 | * @throws \Level23\Dynadot\Exception\ApiHttpCallFailedException |
||
| 312 | * @throws \Level23\Dynadot\Exception\ApiLimitationExceededException |
||
| 313 | * @throws \Level23\Dynadot\Exception\DynadotApiException |
||
| 314 | * @throws \Sabre\Xml\ParseException |
||
| 315 | */ |
||
| 316 | 6 | public function setNameserversForDomain(string $domain, array $nameservers): void |
|
| 317 | { |
||
| 318 | 6 | $this->log(LogLevel::DEBUG, 'Set ' . sizeof($nameservers) . ' nameservers for domain ' . $domain); |
|
| 319 | 6 | $requestData = [ |
|
| 320 | 6 | 'command' => 'set_ns', |
|
| 321 | 6 | 'domain' => $domain, |
|
| 322 | 6 | ]; |
|
| 323 | |||
| 324 | 6 | if (sizeof($nameservers) > 13) { |
|
| 325 | // index starts at 0, so we should check if the index is greater than 12 (which is 13 nameservers) |
||
| 326 | 1 | throw new ApiLimitationExceededException( |
|
| 327 | 1 | 'Can not define more than 13 nameservers through the API' |
|
| 328 | 1 | ); |
|
| 329 | } |
||
| 330 | |||
| 331 | 5 | $idx = 0; |
|
| 332 | // check if there are more than 13 nameservers defined |
||
| 333 | 5 | foreach ($nameservers as $nameserver) { |
|
| 334 | 5 | $requestData['ns' . $idx++] = $nameserver; |
|
| 335 | } |
||
| 336 | |||
| 337 | // perform the API call |
||
| 338 | 5 | $response = $this->performRawApiCall($requestData); |
|
| 339 | |||
| 340 | 5 | $this->log(LogLevel::DEBUG, 'API call executed, parsing response...'); |
|
| 341 | |||
| 342 | // start parsing XML data using Sabre |
||
| 343 | 5 | $sabreService = new Service(); |
|
| 344 | |||
| 345 | // map certain values to objects |
||
| 346 | 5 | $sabreService->mapValueObject('{}SetNsResponse', SetNsResponse\SetNsResponse::class); |
|
| 347 | 5 | $sabreService->mapValueObject('{}SetNsHeader', SetNsResponse\SetNsHeader::class); |
|
| 348 | 5 | $sabreService->mapValueObject('{}Response', GeneralResponse\Response::class); |
|
| 349 | 5 | $sabreService->mapValueObject('{}ResponseHeader', GeneralResponse\ResponseHeader::class); |
|
| 350 | |||
| 351 | // parse the data |
||
| 352 | 5 | $resultData = $sabreService->parse($response->getContents()); |
|
| 353 | |||
| 354 | // General error, like incorrect api key |
||
| 355 | 4 | if ($resultData instanceof GeneralResponse\Response) { |
|
| 356 | 1 | $code = $resultData->ResponseHeader->ResponseCode; |
|
| 357 | 1 | if ($code != GeneralResponse\ResponseHeader::RESPONSECODE_OK) { |
|
| 358 | 1 | throw new DynadotApiException($resultData->ResponseHeader->Error); |
|
| 359 | } |
||
| 360 | } |
||
| 361 | |||
| 362 | 3 | if (!$resultData instanceof SetNsResponse\SetNsResponse) { |
|
| 363 | 1 | throw new DynadotApiException('We failed to parse the response'); |
|
| 364 | } |
||
| 365 | |||
| 366 | /** |
||
| 367 | * Check if the API call was successful. If not, return the error |
||
| 368 | */ |
||
| 369 | 2 | $code = $resultData->SetNsHeader->SuccessCode; |
|
| 370 | 2 | if ($code != SetNsResponse\SetNsHeader::SUCCESSCODE_OK) { |
|
| 371 | 1 | throw new DynadotApiException($resultData->SetNsHeader->Error); |
|
| 372 | } |
||
| 373 | |||
| 374 | 1 | $this->log(LogLevel::DEBUG, 'Received correct response. Everything is ok!'); |
|
| 375 | } |
||
| 376 | |||
| 377 | /** |
||
| 378 | * List all domains in the account. We will return an array with Domain objects |
||
| 379 | * |
||
| 380 | * @return DomainResponse\Domain[] |
||
| 381 | * @throws \GuzzleHttp\Exception\GuzzleException |
||
| 382 | * @throws \Level23\Dynadot\Exception\ApiHttpCallFailedException |
||
| 383 | * @throws \Level23\Dynadot\Exception\DynadotApiException |
||
| 384 | * @throws \Sabre\Xml\ParseException |
||
| 385 | */ |
||
| 386 | 5 | public function getDomainList(): array |
|
| 488 | } |
||
| 489 | |||
| 490 | /** |
||
| 491 | * Get contact information for a specific contact ID |
||
| 492 | * |
||
| 493 | * @param int $contactId The contact ID we should request |
||
| 494 | * |
||
| 495 | * @return GetContactResponse\Contact |
||
| 496 | * @throws \GuzzleHttp\Exception\GuzzleException |
||
| 497 | * @throws \Level23\Dynadot\Exception\ApiHttpCallFailedException |
||
| 498 | * @throws \Level23\Dynadot\Exception\DynadotApiException |
||
| 499 | * @throws \Sabre\Xml\ParseException |
||
| 500 | */ |
||
| 501 | 5 | public function getContactInfo(int $contactId): GetContactResponse\Contact |
|
| 502 | { |
||
| 503 | 5 | $this->log(LogLevel::DEBUG, 'Fetch contact details for id ' . $contactId); |
|
| 504 | |||
| 505 | 5 | $requestData = [ |
|
| 506 | 5 | 'command' => 'get_contact', |
|
| 507 | 5 | 'contact_id' => $contactId, |
|
| 508 | 5 | ]; |
|
| 509 | |||
| 510 | // perform the API call |
||
| 511 | 5 | $response = $this->performRawApiCall($requestData); |
|
| 512 | |||
| 513 | 5 | $this->log(LogLevel::DEBUG, 'Start parsing result'); |
|
| 514 | |||
| 515 | // start parsing XML data using Sabre |
||
| 516 | 5 | $sabreService = new Service(); |
|
| 517 | |||
| 518 | // map certain values to objects |
||
| 519 | 5 | $sabreService->mapValueObject('{}GetContactResponse', GetContactResponse\GetContactResponse::class); |
|
| 520 | 5 | $sabreService->mapValueObject('{}GetContactHeader', GetContactResponse\GetContactHeader::class); |
|
| 521 | 5 | $sabreService->mapValueObject('{}GetContactContent', GetContactResponse\GetContactContent::class); |
|
| 522 | 5 | $sabreService->mapValueObject('{}Contact', GetContactResponse\Contact::class); |
|
| 523 | 5 | $sabreService->mapValueObject('{}Response', GeneralResponse\Response::class); |
|
| 524 | 5 | $sabreService->mapValueObject('{}ResponseHeader', GeneralResponse\ResponseHeader::class); |
|
| 525 | |||
| 526 | // parse the data |
||
| 527 | 5 | $resultData = $sabreService->parse($response->getContents()); |
|
| 528 | |||
| 529 | // General error, like incorrect api key |
||
| 530 | 4 | if ($resultData instanceof GeneralResponse\Response) { |
|
| 531 | 1 | $code = $resultData->ResponseHeader->ResponseCode; |
|
| 532 | 1 | if ($code != GeneralResponse\ResponseHeader::RESPONSECODE_OK) { |
|
| 533 | 1 | throw new DynadotApiException($resultData->ResponseHeader->Error); |
|
| 534 | } |
||
| 535 | } |
||
| 536 | |||
| 537 | 3 | if (!$resultData instanceof GetContactResponse\GetContactResponse) { |
|
| 538 | 1 | throw new DynadotApiException('We failed to parse the response'); |
|
| 539 | } |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Check if the API call was successful. If not, return the error |
||
| 543 | */ |
||
| 544 | 2 | $code = $resultData->GetContactHeader->ResponseCode; |
|
| 545 | 2 | if ($code != GetContactResponse\GetContactHeader::RESPONSECODE_OK) { |
|
| 546 | 1 | throw new DynadotApiException($resultData->GetContactHeader->Error); |
|
| 547 | } |
||
| 548 | |||
| 549 | 1 | return $resultData->GetContactContent->Contact; |
|
| 550 | } |
||
| 551 | |||
| 552 | /** |
||
| 553 | * @throws \Level23\Dynadot\Exception\DynadotApiException |
||
| 554 | * @throws \Sabre\Xml\ParseException |
||
| 555 | * @throws \GuzzleHttp\Exception\GuzzleException |
||
| 556 | * @throws \Level23\Dynadot\Exception\ApiHttpCallFailedException |
||
| 557 | */ |
||
| 558 | 4 | public function setRenewOption(string $domain, string $renewOption): bool |
|
| 603 | } |
||
| 604 | } |
||
| 605 |
Loading history...