Merge pull request #43 from utopia-php/fix-opensrs-issues

loks0n · web-flow · commit d5f903e93c10 · 2025-10-03T12:58:53.000+01:00
chore: update suggestions method to return prices
diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ $domain = 'yourname.com';
 
 $available = $reg->available($domain);
 $purchase = $reg->purchase($domain, $contact); 
-$suggest = $reg->suggest(['yourname', 'yourname1.com'], ['com', 'net', 'org']);
+$suggest = $reg->suggest(['yourname', 'yourname1.com'], ['com', 'net', 'org'], 10, 10000, 100);
 $domainDetails = $reg->getDomain($domain);
 $renew = $reg->renew($domain, 1);
 $transfer = $reg->transfer($domain, [$contact]);
@@ -128,7 +128,7 @@ $transfer = $reg->transfer($domain, [$contact]);
 ## Library Registrar API
 * **available(string $domain): bool** - Checks to see if a domain is available for registration.
 * **purchase(string $domain, array $contacts, array $nameservers = []): array** - Purchase a domain name.
-* **suggest(array $query, array $tlds = [], $minLength = 1, $maxLength = 100): array** - Suggest or search for domain names.
+* **suggest(array $query, array $tlds = [], int|null $limit = null, int|null $priceMax = null, int|null $priceMin = null): array** - Suggest or search for domain names.
 * **getDomain(string $domain): array** - Get domain details.
 * **renew(string $domain, int $years): array** - Renew a domain name.
 * **transfer(string $domain, array $contacts, array $nameservers = []): array** - Transfer a domain name.
diff --git a/composer.json b/composer.json
@@ -32,5 +32,11 @@
       "laravel/pint": "1.2.*",
       "phpstan/phpstan": "1.9.x-dev"
   },
-  "minimum-stability": "stable"
+  "minimum-stability": "stable",
+  "config": {
+    "allow-plugins": {
+      "php-http/discovery": true,
+      "tbachert/spi": true
+    }
+  }
 }
diff --git a/src/Domains/Registrar.php b/src/Domains/Registrar.php
@@ -23,9 +23,9 @@ public function purchase(string $domain, array $contacts, array $nameservers = [
         return $this->adapter->purchase($domain, $contacts, $nameservers);
     }
 
-    public function suggest(array $query, array $tlds = [], $minLength = 1, $maxLength = 100): array
+    public function suggest(array $query, array $tlds = []): array
     {
-        return $this->adapter->suggest($query, $tlds, $minLength, $maxLength);
+        return $this->adapter->suggest($query, $tlds);
     }
 
     public function tlds(): array
diff --git a/src/Domains/Registrar/Adapter.php b/src/Domains/Registrar/Adapter.php
@@ -23,11 +23,12 @@ abstract public function purchase(string $domain, array $contacts, array $namese
     /**
      * @param  array  $query
      * @param  array  $tlds
-     * @param  int  $minLength
-     * @param  int  $maxLength
+     * @param  int|null $limit
+     * @param  int|null $priceMax
+     * @param  int|null $priceMin
      * @return array
      */
-    abstract public function suggest(array|string $query, array $tlds = [], $minLength = 1, $maxLength = 100): array;
+    abstract public function suggest(array|string $query, array $tlds = [], int|null $limit = null, int|null $priceMax = null, int|null $priceMin = null): array;
 
     /**
      * @return array
diff --git a/src/Domains/Registrar/OpenSRS.php b/src/Domains/Registrar/OpenSRS.php
@@ -16,22 +16,20 @@ class OpenSRS extends Adapter
      * Instantiate a new adapter.
      *
      * @param  string  $apiKey
-     * @param  string  $apiSecret
      * @param  string  $username
      * @param  string  $password
      * @param  array  $defaultNameservers
      * @param  bool  $production
      * @return void
      */
-    public function __construct(string $apiKey, string $apiSecret, string $username, string $password, array $defaultNameservers, bool $production = false)
+    public function __construct(string $apiKey, string $username, string $password, array $defaultNameservers, bool $production = false)
     {
         $this->endpoint =
           $production === false
           ? 'https://horizon.opensrs.net:55443'
           : 'https://rr-n1-tor.opensrs.net:55443';
 
         $this->apiKey = $apiKey;
-        $this->apiSecret = $apiSecret;
         $this->defaultNameservers = $defaultNameservers;
 
         $this->user = [
@@ -41,7 +39,7 @@ public function __construct(string $apiKey, string $apiSecret, string $username,
 
         $this->headers = [
             'Content-Type:text/xml',
-            'X-Username:'.$this->apiSecret,
+            'X-Username: ' . $username,
         ];
     }
 
@@ -227,23 +225,82 @@ public function cancelPurchase(): bool
         return $successful;
     }
 
-    public function suggest(array|string $query, array $tlds = [], $minLength = 1, $maxLength = 100): array
+    /**
+     * Suggest domain names based on search query
+     *
+     * @param array|string $query Search terms to generate suggestions from
+     * @param array $tlds Top-level domains to search within (e.g., ['com', 'net', 'org'])
+     * @param int|null $limit Maximum number of results to return
+     * @param int|null $priceMax Maximum price for premium domains
+     * @param int|null $priceMin Minimum price for premium domains
+     * @return array Domains with metadata: `available` (bool), `price` (float|null), `type` (string)
+     */
+    public function suggest(array|string $query, array $tlds = [], int|null $limit = null, int|null $priceMax = null, int|null $priceMin = null): array
     {
         $query = is_array($query) ? $query : [$query];
 
+        // Determine which services to use based on parameters
+        $hasPriceFilter = $priceMax !== null || $priceMin !== null;
+
+        if ($hasPriceFilter) {
+            $services = ['premium'];
+        } elseif ($limit) {
+            $services = ['lookup', 'suggestion'];
+        } else {
+            $services = ['suggestion', 'premium', 'lookup'];
+        }
+
         $message = [
             'object' => 'DOMAIN',
             'action' => 'name_suggest',
             'attributes' => [
-                'services' => [
-                    'suggestion',
-                ],
+                'services' => $services,
                 'searchstring' => implode(' ', $query),
-                'tlds' => $tlds,
+                'skip_registry_lookup' => 1,
             ],
         ];
 
-        $xpath = implode('/', [
+        if (!empty($tlds)) {
+            $message['attributes']['tlds'] = $tlds;
+        }
+
+        if ($limit || $hasPriceFilter) {
+            $formattedTlds = !empty($tlds) ? array_map(fn ($tld) => '.' . ltrim($tld, '.'), $tlds) : [];
+
+            if ($hasPriceFilter) {
+                $message['attributes']['service_override']['premium'] = [];
+
+                if (!empty($formattedTlds)) {
+                    $message['attributes']['service_override']['premium']['tlds'] = $formattedTlds;
+                }
+
+                if ($limit) {
+                    $message['attributes']['service_override']['premium']['maximum'] = $limit;
+                }
+
+                if ($priceMin !== null) {
+                    $message['attributes']['service_override']['premium']['price_min'] = $priceMin;
+                }
+
+                if ($priceMax !== null) {
+                    $message['attributes']['service_override']['premium']['price_max'] = $priceMax;
+                }
+            } elseif ($limit) {
+                $message['attributes']['service_override']['suggestion']['maximum'] = $limit;
+
+                if (!empty($formattedTlds)) {
+                    $message['attributes']['service_override']['suggestion']['tlds'] = $formattedTlds;
+                    $message['attributes']['service_override']['lookup']['tlds'] = $formattedTlds;
+                }
+            }
+        }
+
+        $result = $this->send($message);
+        $result = $this->sanitizeResponse($result);
+
+        $items = [];
+
+        $suggestionXpath = implode('/', [
             '//body',
             'data_block',
             'dt_assoc',
@@ -255,19 +312,67 @@ public function suggest(array|string $query, array $tlds = [], $minLength = 1, $
             'dt_array',
             'item',
         ]);
+        $suggestionElements = $result->xpath($suggestionXpath);
+        foreach ($suggestionElements as $element) {
+            $domainNode = $element->xpath('dt_assoc/item[@key="domain"]');
+            $statusNode = $element->xpath('dt_assoc/item[@key="status"] | dt_assoc/item[@key="availability"]');
+            $domain = isset($domainNode[0]) ? (string) $domainNode[0] : null;
+            $status = isset($statusNode[0]) ? strtolower((string) $statusNode[0]) : '';
+            if ($domain) {
+                $items[$domain] = [
+                    'available' => in_array($status, ['available', 'true', '1'], true),
+                    'price' => null,
+                    'type' => 'suggestion'
+                ];
+            }
+        }
 
-        $result = $this->send($message);
-        $result = $this->sanitizeResponse($result);
-        $elements = $result->xpath($xpath);
+        $premiumXpath = implode('/', [
+            '//body',
+            'data_block',
+            'dt_assoc',
+            'item[@key="attributes"]',
+            'dt_assoc',
+            'item[@key="premium"]',
+            'dt_assoc',
+            'item[@key="items"]',
+            'dt_array',
+            'item',
+        ]);
 
-        $items = [];
+        $premiumElements = $result->xpath($premiumXpath);
 
-        foreach ($elements as $element) {
+        foreach ($premiumElements as $element) {
             $item = $element->xpath('dt_assoc/item');
-            $domain = (string) $item[0];
-            $available = (string) $item[1] === 'available';
 
-            $items[$domain] = $available;
+            $domain = null;
+            $available = false;
+            $price = null;
+
+            foreach ($item as $field) {
+                $key = (string) $field['key'];
+                $value = (string) $field;
+
+                switch ($key) {
+                    case 'domain':
+                        $domain = $value;
+                        break;
+                    case 'status':
+                        $available = $value === 'available';
+                        break;
+                    case 'price':
+                        $price = is_numeric($value) ? (float) $value : null;
+                        break;
+                }
+            }
+
+            if ($domain) {
+                $items[$domain] = [
+                    'available' => $available,
+                    'price' => $price,
+                    'type' => 'premium'
+                ];
+            }
         }
 
         return $items;
@@ -284,8 +389,8 @@ public function getDomain(string $domain): array
         $message = [
             'object' => 'domain',
             'action' => 'get',
+            'domain' => $domain,
             'attributes' => [
-                'domain' => $domain,
                 'type' => 'all_info',
                 'clean_ca_subset' => 1,
             ],
@@ -437,6 +542,48 @@ private function createArray(string $key, array $ary): string
         return implode(PHP_EOL, $result);
     }
 
+    private function createAssoc(string $key, array $assoc): string
+    {
+        $result = [
+            '<item key="'.$key.'">',
+            '<dt_assoc>',
+        ];
+
+        foreach ($assoc as $itemKey => $itemValue) {
+            if (is_array($itemValue)) {
+                if (array_keys($itemValue) === range(0, count($itemValue) - 1)) {
+                    $result[] = $this->createArray($itemKey, $itemValue);
+                } else {
+                    $result[] = $this->createAssoc($itemKey, $itemValue);
+                }
+            } else {
+                $result[] = $this->createEnvelopItem($itemKey, $itemValue);
+            }
+        }
+
+        $result[] = '</dt_assoc>';
+        $result[] = '</item>';
+
+        return implode(PHP_EOL, $result);
+    }
+
+    private function createServiceOverride(array $overrides): string
+    {
+        $result = [
+            '<item key="service_override">',
+            '<dt_assoc>',
+        ];
+
+        foreach ($overrides as $serviceName => $serviceConfig) {
+            $result[] = $this->createAssoc($serviceName, $serviceConfig);
+        }
+
+        $result[] = '</dt_assoc>';
+        $result[] = '</item>';
+
+        return implode(PHP_EOL, $result);
+    }
+
     private function createEnvelopItem(string $key, string|int|array $value): string
     {
         if (is_array($value)) {
@@ -567,7 +714,7 @@ private function createNamespaceAssign(array $nameservers): string
         return implode(PHP_EOL, $result);
     }
 
-    private function buildEnvelop(string $object, string $action, array $attributes, string $domain = null): string
+    private function buildEnvelop(string $object, string $action, array $attributes, ?string $domain = null): string
     {
         $result = [
             '<?xml version="1.0" encoding="UTF-8" standalone="no"?>',
@@ -604,6 +751,9 @@ private function buildEnvelop(string $object, string $action, array $attributes,
                 case 'remove_ns':
                     $result[] = $this->createNamespaceAssign($value);
                     break;
+                case 'service_override':
+                    $result[] = $this->createServiceOverride($value);
+                    break;
                 default:
                     $result[] =
                       is_array($value)
diff --git a/tests/OpenSRSTest.php b/tests/OpenSRSTest.php

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ public function purchase(string $domain, array $contacts, array $nameservers = [`
`23`	`23`	`return $this->adapter->purchase($domain, $contacts, $nameservers);`
`24`	`24`	`}`
`25`	`25`
`26`		`- public function suggest(array $query, array $tlds = [], $minLength = 1, $maxLength = 100): array`
	`26`	`+ public function suggest(array $query, array $tlds = []): array`
`27`	`27`	`{`
`28`		`- return $this->adapter->suggest($query, $tlds, $minLength, $maxLength);`
	`28`	`+ return $this->adapter->suggest($query, $tlds);`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`public function tlds(): array`