Merge pull request google#125 from xthiago/hostname

Add hostname attribute to Response object to allow server-side validation

Author: rowan-m

src/ReCaptcha/Response.php

@@ -44,10 +44,10 @@ class Response
     private $errorCodes = array();
 
     /**
-     * the hostname of the site where the reCAPTCHA was solved
+     * The hostname of the site where the reCAPTCHA was solved.
      * @var string
      */
-    private $hostName = '';
+    private $hostname;
 
     /**
      * Build the response from the expected JSON returned by the service.
@@ -63,15 +63,17 @@ public static function fromJson($json)
             return new Response(false, array('invalid-json'));
         }
 
+        $hostname = isset($responseData['hostname']) ? $responseData['hostname'] : null;
+
         if (isset($responseData['success']) && $responseData['success'] == true) {
-            return new Response(true, array(), isset($responseData['hostname']) ? $responseData['hostname'] : '');
+            return new Response(true, array(), $hostname);
         }
 
         if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
-            return new Response(false, $responseData['error-codes']);
+            return new Response(false, $responseData['error-codes'], $hostname);
         }
 
-        return new Response(false);
+        return new Response(false, array(), $hostname);
     }
 
     /**
@@ -81,11 +83,11 @@ public static function fromJson($json)
      * @param array $errorCodes
      * @param string $hostname
      */
-    public function __construct($success, array $errorCodes = array(), $hostname = '')
+    public function __construct($success, array $errorCodes = array(), $hostname = null)
     {
         $this->success = $success;
         $this->errorCodes = $errorCodes;
-        $this->hostName = $hostname;
+        $this->hostname = $hostname;
     }
 
     /**
@@ -109,10 +111,12 @@ public function getErrorCodes()
     }
 
     /**
+     * Get hostname.
+     *
      * @return string
      */
-    public function getHostName()
+    public function getHostname()
     {
-        return $this->hostName;
+      return $this->hostname;
     }
 }

tests/ReCaptcha/ResponseTest.php

@@ -32,21 +32,26 @@ class ResponseTest extends \PHPUnit_Framework_TestCase
     /**
      * @dataProvider provideJson
      */
-    public function testFromJson($json, $success, $errorCodes)
+    public function testFromJson($json, $success, $errorCodes, $hostname)
     {
         $response = Response::fromJson($json);
         $this->assertEquals($success, $response->isSuccess());
         $this->assertEquals($errorCodes, $response->getErrorCodes());
+        $this->assertEquals($hostname, $response->getHostname());
     }
 
     public function provideJson()
     {
         return array(
-            array('{"success": true}', true, array()),
-            array('{"success": false, "error-codes": ["test"]}', false, array('test')),
-            array('{"success": true, "error-codes": ["test"]}', true, array()),
-            array('{"success": false}', false, array()),
-            array('BAD JSON', false, array('invalid-json')),
+            array('{"success": true}', true, array(), null),
+            array('{"success": true, "hostname": "google.com"}', true, array(), 'google.com'),
+            array('{"success": false, "error-codes": ["test"]}', false, array('test'), null),
+            array('{"success": false, "error-codes": ["test"], "hostname": "google.com"}', false, array('test'), 'google.com'),
+            array('{"success": true, "error-codes": ["test"]}', true, array(), null),
+            array('{"success": true, "error-codes": ["test"], "hostname": "google.com"}', true, array(), 'google.com'),
+            array('{"success": false}', false, array(), null),
+            array('{"success": false, "hostname": "google.com"}', false, array(), 'google.com'),
+            array('BAD JSON', false, array('invalid-json'), null),
         );
     }
 
@@ -68,4 +73,12 @@ public function testGetErrorCodes()
         $response = new Response(true, $errorCodes);
         $this->assertEquals($errorCodes, $response->getErrorCodes());
     }
+
+    public function testGetHostname()
+    {
+      $hostname = 'google.com';
+      $errorCodes = array();
+      $response = new Response(true, $errorCodes, $hostname);
+      $this->assertEquals($hostname, $response->getHostname());
+    }
 }