Add support for domain research endpoint (#237)

Author: juankuquintana

src/main/java/com/dnsimple/data/DomainResearchStatus.java

@@ -0,0 +1,52 @@
+package com.dnsimple.data;
+
+import java.util.List;
+
+/**
+ * Domain research status result.
+ *
+ * @see <a href="https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus">Get Domains Research Status</a>
+ */
+public class DomainResearchStatus {
+    private final String requestId;
+    private final String domain;
+    private final String availability;
+    private final List<String> errors;
+
+    public DomainResearchStatus(String requestId, String domain, String availability, List<String> errors) {
+        this.requestId = requestId;
+        this.domain = domain;
+        this.availability = availability;
+        this.errors = errors;
+    }
+
+    /**
+     * UUID identifier for this research request.
+     */
+    public String getRequestId() {
+        return requestId;
+    }
+
+    /**
+     * The domain name that was researched.
+     */
+    public String getDomain() {
+        return domain;
+    }
+
+    /**
+     * The availability status (e.g. "available", "unavailable").
+     *
+     * @see <a href="https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus">API documentation</a>
+     */
+    public String getAvailability() {
+        return availability;
+    }
+
+    /**
+     * Array of error messages if the domain cannot be researched.
+     */
+    public List<String> getErrors() {
+        return errors;
+    }
+}

src/main/java/com/dnsimple/endpoints/Domains.java

@@ -1,6 +1,11 @@
 package com.dnsimple.endpoints;
 
-import com.dnsimple.data.*;
+import com.dnsimple.data.DelegationSignerRecord;
+import com.dnsimple.data.Domain;
+import com.dnsimple.data.DomainPush;
+import com.dnsimple.data.DomainResearchStatus;
+import com.dnsimple.data.Dnssec;
+import com.dnsimple.data.EmailForward;
 import com.dnsimple.http.HttpEndpointClient;
 import com.dnsimple.request.DSRecordOptions;
 import com.dnsimple.request.ListOptions;
@@ -320,4 +325,25 @@ public EmptyResponse acceptPush(Number account, Number push, Number contactId) {
     public EmptyResponse rejectPush(Number account, Number push) {
         return client.empty(DELETE, account + "/pushes/" + push, ListOptions.empty(), null);
     }
+
+    /**
+     * Research a domain name for availability and registration status information.
+     * 
+     * This endpoint provides information about a domain's availability status, including whether it's
+     * available for registration, already registered, or has other restrictions.
+     *
+     * @param account     The account ID
+     * @param domainName  The domain name to research
+     * @return The domain research status response
+     * @see <a href="https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus">https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus</a>
+     */
+    public SimpleResponse<DomainResearchStatus> getDomainResearchStatus(Number account, String domainName) {
+        return client.simple(
+                GET,
+                account + "/domains/research/status",
+                ListOptions.empty().setOtherOption("domain", domainName),
+                null,
+                DomainResearchStatus.class
+        );
+    }
 }

src/test/java/com/dnsimple/endpoints/DomainsResearchTest.java

@@ -0,0 +1,63 @@
+package com.dnsimple.endpoints;
+
+import com.dnsimple.data.DomainResearchStatus;
+import com.dnsimple.response.SimpleResponse;
+import com.dnsimple.tools.DnsimpleTestBase;
+import org.junit.Test;
+
+import java.util.List;
+
+import static com.dnsimple.http.HttpMethod.GET;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.*;
+
+/**
+ * Tests for the domain research status endpoint.
+ */
+public class DomainsResearchTest extends DnsimpleTestBase {
+
+    @Test
+    public void testGetDomainResearchStatusBuildsCorrectRequest() {
+        server.stubFixtureAt("getDomainsResearchStatus/success-unavailable.http");
+        client.domains.getDomainResearchStatus(1010, "taken.com");
+
+        assertThat(server.getRecordedRequest().getMethod(), is(GET));
+        assertThat(server.getRecordedRequest().getPath(), is("/v2/1010/domains/research/status?domain=taken.com"));
+    }
+
+    @Test
+    public void testGetDomainResearchStatusReturnsDomainResearchStatus() {
+        server.stubFixtureAt("getDomainsResearchStatus/success-unavailable.http");
+
+        SimpleResponse<DomainResearchStatus> response = client.domains.getDomainResearchStatus(1010, "taken.com");
+
+        assertThat(response, is(notNullValue()));
+        DomainResearchStatus data = response.getData();
+        assertThat(data, is(notNullValue()));
+        assertThat(data.getRequestId(), is("25dd77cb-2f71-48b9-b6be-1dacd2881418"));
+        assertThat(data.getDomain(), is("taken.com"));
+        assertThat(data.getAvailability(), is("unavailable"));
+        assertThat(data.getErrors(), is(empty()));
+    }
+
+    @Test
+    public void testGetDomainResearchStatusWithAvailableDomain() {
+        server.stubFixtureAt("getDomainsResearchStatus/success-available.http");
+
+        SimpleResponse<DomainResearchStatus> response = client.domains.getDomainResearchStatus(1010, "available.com");
+
+        assertThat(response.getData(), is(notNullValue()));
+        assertThat(response.getData().getAvailability(), is("available"));
+        assertThat(response.getData().getDomain(), is("available.com"));
+    }
+
+    @Test
+    public void testGetDomainResearchStatusWithUnsupportedTld() {
+        server.stubFixtureAt("getDomainsResearchStatus/success-unsupported-tld.http");
+
+        SimpleResponse<DomainResearchStatus> response = client.domains.getDomainResearchStatus(1010, "example.unsupported");
+
+        assertThat(response.getData(), is(notNullValue()));
+        assertThat(response.getData().getErrors(), is(not(empty())));
+    }
+}