Migrate to ReCaptcha's v2 API #11

akrabat · 2017-02-09T20:02:12Z

Update @Lansoweb's PR (#8) to ensure MailHide still works with its v1 API as it's not been updated to v2 by Google.

Also ensure Travis tests on PHP 5.6, 7, and 7.1. For v2, Google provide test keys, so we can use them and let Travis test better.

Migrating to api v2

The private and public key properties have been renamed, so we have to update in this class. Introduce getPrivateKey(), getPublicKey() and setPublicKey() so as MailHide’s API is still v1.

Remove PHP 5.5 & add 7.1. Do not allow 7.0 to be a failure

Update to current standards with PHP 5.6 or above.

This helps Travis with PHP 5.6.

weierophinney

Noted a few additional changes. In particular, update the composer.json to require zendfamework/zend-coding-standard, as that has a few more rules which will pick up some of the CS issues I flagged. Additionally, maybe consider putting the Google test keys in the phpunit.xml.dist file as the default values.

Overall, looks great!

weierophinney · 2017-02-09T20:04:20Z

.travis.yml

@@ -10,21 +10,20 @@ cache:
 matrix:
  fast_finish: true
  include:
-    - php: 5.5


weierophinney · 2017-02-09T20:05:37Z

README.md

@@ -7,7 +7,7 @@ You can install using:
 ```
 curl -s https://getcomposer.org/installer | php
 php composer.phar install
-composer require zendframework/zendservice-recaptcha
+php composer.phar require zendframework/zendservice-recaptcha
 ```


Alternately, we point them to the Composer download page, and demonstrate using composer require (not usage of the phar file). Either way works, though we've been trending towards just saying composer require.

weierophinney · 2017-02-09T20:07:02Z

src/MailHide.php

+    public function getPublicKey()
+    {
+        return parent::getSiteKey();
+    }


Should these proxy methods maybe be marked deprecated now?

They aren't actually deprecated for MailHide as that's the correct wording for its API.

Okay, sounds good.

weierophinney · 2017-02-09T20:07:49Z

src/MailHide.php

@@ -273,11 +303,11 @@ public function getHtml($email = null)
            throw new MailHideException('Missing email address');
        }

-        if ($this->publicKey === null) {
+        if ($this->getPublicKey() === null) {


Why getPublicKey() and not getSiteKey()?

MailHide is still on v1's API which uses the nomenclature "public_key" and "private_key".

Seemed sensible to be consistent within this class.

Makes sense. Maybe add some verbiage indicating that, then?

weierophinney · 2017-02-09T20:08:04Z

src/MailHide.php

            throw new MailHideException('Missing public key');
        }

-        if ($this->privateKey === null) {
+        if ($this->getPrivateKey() === null) {


Why getPrivateKey() and not getSecretKey()?

MailHide is still on v1's API which uses the nomenclature "public_key" and "private_key".

weierophinney · 2017-02-09T20:13:57Z

composer.json

    },
    "require-dev": {
-        "phpunit/phpunit": "~4.0",
+        "phpunit/phpunit": "^5.7 || ^6.0",
        "squizlabs/php_codesniffer": "^2.3",


Change this dependency to "zendframework/zend-coding-standard": "~1.0.0", please, and then re-run phpcs and/or phpcbf; they'll pick up the various CS bits I've noticed.

weierophinney · 2017-02-09T20:15:19Z

src/Response.php

-     * @param string $errorCode
-     * @param HTTPResponse $httpResponse If this is set the content will override $status and $errorCode
+     * @param array $errorCodes
+     * @param \Zend\Http\Response $httpResponse If this is set the content will override $status and $errorCode


Use the same typehint as found in the signature; IDEs and phpdoc will expand them correctly.

weierophinney · 2017-02-09T20:15:34Z

src/Response.php

-     * @param string $status
-     * @return Response
+     * @param boolean $status
+     * @return \ZendService\ReCaptcha\Response


@return self

weierophinney · 2017-02-09T20:15:48Z

src/Response.php

@@ -57,16 +57,12 @@ public function __construct($status = null, $errorCode = null, HTTPResponse $htt
    /**
     * Set the status
     *
-     * @param string $status
-     * @return Response
+     * @param boolean $status


bool instead of boolean (internal consistency)

weierophinney · 2017-02-09T20:18:02Z

test/ReCaptchaTest.php

+        $this->secretKey = getenv('TESTS_ZEND_SERVICE_RECAPTCHA_SECRET_KEY');
+
+        if (empty($this->siteKey)) {
+            $this->siteKey = '6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI';


Maybe these should be in the phpunit.xml.dist as the default values, with a comment above indicating users should change them if they want to use their own keys? That would simplify the test code a bit.

- Simplify information about composer - Link to documentation

akrabat · 2017-02-09T21:00:05Z

@weierophinney Review items addressed

weierophinney

Changes look good!

Close zendframework#11

xorock · 2017-02-10T05:50:32Z

Hi guys. Some time ago I wrote full service for recaptcha v2 https://github.com/xorock/zend-service-recaptcha-v2. The only thing that is missing here are tests.

Leandro Silva and others added 14 commits September 22, 2015 08:03

ReCaptcha api migrated to v2

6197b44

Making composer instructions compatible with previous call

17af428

CS fixes

2d3b861

Fixing keys env vars for phpunit

e1cb18d

Removing unnecessary hard-coded id from div

a3a5ba0

Changing the api url to https

5df0b0a

Merge pull request zendframework#8 from Lansoweb/develop

414626a

Migrating to api v2

Update MailHide to work with updated Recaptcha

b66196c

The private and public key properties have been renamed, so we have to update in this class. Introduce getPrivateKey(), getPublicKey() and setPublicKey() so as MailHide’s API is still v1.

Update travis config

6f3ec60

Remove PHP 5.5 & add 7.1. Do not allow 7.0 to be a failure

Update unit tests for PHPUnit 5.7+

80e6011

Use test credentials for unit tests

3d57b08

Update composer.json

8fbdd9c

Update to current standards with PHP 5.6 or above.

Update travis command

b4ea9dc

Use CurlAdapter in tests

8c89395

This helps Travis with PHP 5.6.

akrabat mentioned this pull request Feb 9, 2017

Migrating to api v2 #8

Closed

akrabat requested a review from weierophinney February 9, 2017 20:02

weierophinney suggested changes Feb 9, 2017

View reviewed changes

akrabat added 5 commits February 9, 2017 20:40

Update README

e176722

- Simplify information about composer - Link to documentation

Add zend-coding-standard and fix issues

881c2ea

Update docblocks

5e603ae

Fix typo in comment

94a5cbb

Move test keys to phpunit.xml.dist

a336acd

weierophinney approved these changes Feb 9, 2017

View reviewed changes

Add a note about key names in MailHide vs ReCaptcha

7978e18

akrabat added a commit to akrabat/ZendService_ReCaptcha that referenced this pull request Feb 9, 2017

Merge branch 'feature/8' into develop

2ab361a

Close zendframework#11

akrabat merged commit 7978e18 into zendframework:develop Feb 9, 2017

This was referenced Feb 9, 2017

Fix dependencies for zf3 #10

Closed

Compatibility with Zend Framework 3 #9

Closed

New ReCaptcha #6

Closed

akrabat added this to the 3.0.0 milestone Feb 9, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to ReCaptcha's v2 API #11

Migrate to ReCaptcha's v2 API #11

akrabat commented Feb 9, 2017

weierophinney left a comment

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

akrabat Feb 9, 2017

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

akrabat Feb 9, 2017 •

edited

Loading

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

akrabat Feb 9, 2017

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

weierophinney Feb 9, 2017

akrabat commented Feb 9, 2017

weierophinney left a comment

xorock commented Feb 10, 2017

Migrate to ReCaptcha's v2 API #11

Migrate to ReCaptcha's v2 API #11

Conversation

akrabat commented Feb 9, 2017

weierophinney left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akrabat Feb 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akrabat commented Feb 9, 2017

weierophinney left a comment

Choose a reason for hiding this comment

xorock commented Feb 10, 2017

akrabat Feb 9, 2017 •

edited

Loading