Merge pull request google#110 from ismailbaskin/master

Add hostname property to Response

Author: rowan-m

README.md

@@ -83,6 +83,8 @@ $recaptcha = new \ReCaptcha\ReCaptcha($secret);
 $resp = $recaptcha->verify($gRecaptchaResponse, $remoteIp);
 if ($resp->isSuccess()) {
     // verified!
+    // if Domain Name Validation turned off don't forget to check hostname field
+    // if($resp->getHostName() === $_SERVER['SERVER_NAME']) {  }
 } else {
     $errors = $resp->getErrorCodes();
 }

src/ReCaptcha/Response.php

@@ -43,6 +43,12 @@ class Response
      */
     private $errorCodes = array();
 
+    /**
+     * the hostname of the site where the reCAPTCHA was solved
+     * @var string
+     */
+    private $hostName = '';
+
     /**
      * Build the response from the expected JSON returned by the service.
      *
@@ -58,7 +64,7 @@ public static function fromJson($json)
         }
 
         if (isset($responseData['success']) && $responseData['success'] == true) {
-            return new Response(true);
+            return new Response(true, array(), isset($responseData['hostname']) ? $responseData['hostname'] : '');
         }
 
         if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
@@ -73,11 +79,13 @@ public static function fromJson($json)
      *
      * @param boolean $success
      * @param array $errorCodes
+     * @param string $hostname
      */
-    public function __construct($success, array $errorCodes = array())
+    public function __construct($success, array $errorCodes = array(), $hostname = '')
     {
         $this->success = $success;
         $this->errorCodes = $errorCodes;
+        $this->hostName = $hostname;
     }
 
     /**
@@ -99,4 +107,12 @@ public function getErrorCodes()
     {
         return $this->errorCodes;
     }
+
+    /**
+     * @return string
+     */
+    public function getHostName()
+    {
+        return $this->hostName;
+    }
 }

tests/ReCaptcha/ResponseTest.php

@@ -57,6 +57,9 @@ public function testIsSuccess()
 
         $response = new Response(false);
         $this->assertFalse($response->isSuccess());
+
+        $response = new Response(true, array(), 'example.com');
+        $this->assertEquals('example.com', $response->getHostName());
     }
 
     public function testGetErrorCodes()