Migrate to ReCaptcha's v2 API

.travis.yml

@@ -10,21 +10,20 @@ cache:
 matrix:
   fast_finish: true
   include:
-    - php: 5.5
     - php: 5.6
       env:
         - EXECUTE_CS_CHECK=true
-    - php: 7
-    - php: hhvm 
+    - php: 7.0
+    - php: 7.1
+    - php: hhvm
   allow_failures:
-    - php: 7
     - php: hhvm
 
 before_install:
   - composer self-update
 
 install:
-  - travis_retry composer install --no-interaction --ignore-platform-reqs --prefer-source
+  - travis_retry composer install --no-interaction --prefer-source
   - composer info -i
 
 script:

README.md

@@ -2,11 +2,9 @@
 
 ## Install
 
-You can install using:
+You can install using [Composer][1]:
 
 ```
-curl -s https://getcomposer.org/installer | php
-php composer.phar install
 composer require zendframework/zendservice-recaptcha
 ```
 
@@ -17,4 +15,8 @@ usage of the component.
 
 Documentation is on the Zend Framework website:
 
-- http://framework.zend.com/manual/current/en/modules/zendservice.re-captcha.html
+- [http://framework.zend.com/manual/current/en/modules/zendservice.re-captcha.html][2]
+
+
+[1]: https://getcomposer.org/download/
+[2]: http://framework.zend.com/manual/current/en/modules/zendservice.re-captcha.html

composer.json

@@ -18,22 +18,16 @@
             "ZendServiceTest\\ReCaptcha\\": "test/"
         }
     },
-    "repositories": [
-        {
-            "type": "composer",
-            "url": "http://packages.zendframework.com/"
-        }
-    ],
     "require": {
-        "php": ">=5.5",
-        "zendframework/zend-config": "~2.0",
-        "zendframework/zend-http": "~2.0",
-        "zendframework/zend-json": "~2.0"
+        "php": "^5.6 || ^7.0",
+        "zendframework/zend-http": "^2.5.4",
+        "zendframework/zend-json": "^2.6.1 || ^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~4.0",
-        "squizlabs/php_codesniffer": "^2.3",
-        "zendframework/zend-validator": "~2.0"
+        "phpunit/phpunit": "^5.7 || ^6.0",
+        "zendframework/zend-coding-standard": "~1.0.0",
+        "zendframework/zend-config": "^2.0",
+        "zendframework/zend-validator": "^2.8.2"
     },
     "suggest": {
         "zendframework/zend-validator": "~2.0, if using ReCaptcha's Mailhide API"

phpcs.xml

@@ -1,21 +1,12 @@
 <?xml version="1.0"?>
-<ruleset name="Zend Framework coding standard">
-    <description>Zend Framework coding standard</description>
+<ruleset name="Zend Framework Coding Standard">
+   <rule ref="./vendor/zendframework/zend-coding-standard/ruleset.xml"/>
 
     <!-- display progress -->
     <arg value="p"/>
     <arg name="colors"/>
 
-    <!-- inherit rules from: -->
-    <rule ref="PSR2"/>
-    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
-    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
-        <properties>
-            <property name="ignoreBlankLines" value="false"/>
-        </properties>
-    </rule>
-
-    <!-- Paths to check -->
-    <file>src</file>
-    <file>test</file>
+   <!-- Paths to check -->
+   <file>src</file>
+   <file>test</file>
 </ruleset>

phpunit.xml.dist

@@ -15,8 +15,9 @@
         <ini name="date.timezone" value="UTC"/>
 
         <!-- ZendService\ReCaptcha online test env variables -->
-        <env name="TESTS_ZEND_SERVICE_RECAPTCHA_PUBLIC_KEY" value="public key"/>
-        <env name="TESTS_ZEND_SERVICE_RECAPTCHA_PRIVATE_KEY" value="private key"/>
+        <!-- Change these if you want to use your own keys -->
+        <env name="TESTS_ZEND_SERVICE_RECAPTCHA_SITE_KEY" value="6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI"/>
+        <env name="TESTS_ZEND_SERVICE_RECAPTCHA_SECRET_KEY" value="6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe"/>
         <env name="TESTS_ZEND_SERVICE_RECAPTCHA_MAILHIDE_PUBLIC_KEY" value="public mailhide key"/>
         <env name="TESTS_ZEND_SERVICE_RECAPTCHA_MAILHIDE_PRIVATE_KEY" value="private mailhide key"/>
     </php>

src/MailHide.php

@@ -132,7 +132,7 @@ public function setEmailValidator(ValidatorInterface $validator)
      */
     protected function requireMcrypt()
     {
-        if (!extension_loaded('mcrypt')) {
+        if (! extension_loaded('mcrypt')) {
             throw new MailHideException(sprintf(
                 'Use of the %s component requires the mcrypt extension to be enabled in PHP',
                 __CLASS__
@@ -177,23 +177,65 @@ public function getDefaultOptions()
     }
 
     /**
-     * Override the setPrivateKey method
+     * Set the private key property
      *
      * Override the parent method to store a binary representation of the private key as well.
      *
+     * Note that we use the nomenclature "private key" as this is what MailHide's API
+     * uses, even though the parent ReCaptcha API uses "secret key"
+     *
      * @param string $privateKey
      * @return MailHide
      */
     public function setPrivateKey($privateKey)
     {
-        parent::setPrivateKey($privateKey);
+        parent::setSecretKey($privateKey);
 
         /* Pack the private key into a binary string */
-        $this->privateKeyPacked = pack('H*', $this->privateKey);
+        $this->privateKeyPacked = pack('H*', $this->getSecretKey());
 
         return $this;
     }
 
+    /**
+     * get the private key property
+     *
+     * Note that we use the nomenclature "private key" as this is what MailHide's API
+     * uses, even though the parent ReCaptcha API uses "secret key"
+     *
+     * @return string
+     */
+    public function getPrivateKey()
+    {
+        return parent::getSecretKey();
+    }
+
+    /**
+     * set the public key property
+     *
+     * Note that we use the nomenclature "public key" as this is what MailHide's API
+     * uses, even though the parent ReCaptcha API uses "site key"
+     *
+     * @param string $publicKey
+     */
+    public function setPublicKey($publicKey)
+    {
+        return parent::setSiteKey($publicKey);
+    }
+
+    /**
+     * Get the public key property
+     *
+     * Note that we use the nomenclature "public key" as this is what MailHide's API
+     * uses, even though the parent ReCaptcha API uses "site key"
+     *
+     * @return string
+     */
+    public function getPublicKey()
+    {
+        return parent::getSiteKey();
+    }
+
     /**
      * Set the email property
      *
@@ -207,7 +249,7 @@ public function setEmail($email)
         $this->email = $email;
 
         $validator = $this->getEmailValidator();
-        if (!$validator->isValid($email)) {
+        if (! $validator->isValid($email)) {
             throw new MailHideException('Invalid email address provided');
         }
 
@@ -273,11 +315,11 @@ public function getHtml($email = null)
             throw new MailHideException('Missing email address');
         }
 
-        if ($this->publicKey === null) {
+        if ($this->getPublicKey() === null) {
             throw new MailHideException('Missing public key');
         }
 
-        if ($this->privateKey === null) {
+        if ($this->getPrivateKey() === null) {
             throw new MailHideException('Missing private key');
         }
 
@@ -330,7 +372,7 @@ protected function getUrl()
         return sprintf(
             '%s?k=%s&c=%s',
             self::MAILHIDE_SERVER,
-            $this->publicKey,
+            $this->getSiteKey(),
             strtr(base64_encode($emailEncrypted), '+/', '-_')
         );
     }