Update docs

phpfui · phpfui · commit 0f479392e507 · 2025-01-09T16:53:28.000-05:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -13,16 +13,16 @@ about: Report an issue with the PHP client library
  * OS name and version:
  * PHP version:
  * Web server name and version:
- * `google/recaptcha` version:
+ * `phpfui/recaptcha` version:
  * Browser name and version:
 
 **Reproducing the issue**
 <!-- Where possible link to a URL where the problem can be seen or show code that causes it -->
 
   * URL (optional): <!-- if your integration is already deployed and the issue is visible -->
   * Code (optional): <!-- share a link to the code you're using or an example in a Gist -->
-  
+
   ***User steps***
   <!-- Detail the necessary steps to reproduce the issue. Include the output of any error messages. -->
-  
+
     1. Visit page...
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
@@ -5,7 +5,6 @@ secret key, specify any additional validation rules, and then call `verify()`
 with the reCAPTCHA response and user's IP address. For example:
 
 ```php
-<?php
 $recaptcha = new \ReCaptcha\ReCaptcha($secret);
 $resp = $recaptcha->setExpectedHostname('recaptcha-demo.appspot.com')
                   ->verify($gRecaptchaResponse, $remoteIp);
@@ -31,14 +30,12 @@ For example, if you want to use [cURL](https://secure.php.net/curl) instead you
 can do this:
 
 ```php
-<?php
 $recaptcha = new \ReCaptcha\ReCaptcha($secret, new \ReCaptcha\RequestMethod\CurlPost());
 ```
 
 Alternatively, you can also use a [socket](https://secure.php.net/fsockopen):
 
 ```php
-<?php
 $recaptcha = new \ReCaptcha\ReCaptcha($secret, new \ReCaptcha\RequestMethod\SocketPost());
 ```
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,49 +1,19 @@
 # Contributing
 
-Want to contribute? Great! First, read this page (including the small print at
-the end).
-
-## Contributor License Agreement
-
-Before we can use your code, you must sign the [Google Individual Contributor
-License
-Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
-(CLA), which you can do online. The CLA is necessary mainly because you own the
-copyright to your changes, even after your contribution becomes part of our
-codebase, so we need your permission to use and distribute your code. We also
-need to be sure of various other things—for instance that you'll tell us if you
-know that your code infringes on other people's patents. You don't have to sign
-the CLA until after you've submitted your code for review (a link will be
-automatically added to your Pull Request) and a member has approved it, but you
-must do it before we can put your code into our codebase. Before you start
-working on a larger contribution, you should get in touch with us first through
-the issue tracker with your idea so that we can help out and possibly guide you.
-Coordinating up front makes it much easier to avoid frustration later on.
+Want to contribute? Great! First, read this page.
 
 ## Linting and testing
 
-We use PHP Coding Standards Fixer to maintain coding standards and PHPUnit to
-run our tests. For convenience, there are Composer scripts to run each of these:
+We use PHP Coding Standards Fixer to maintain coding standards and PHPUnit to run our tests. For convenience, there are Composer scripts to run each of these:
 
 ```sh
 composer run-script lint
+composer run-script lint-fix
 composer run-script test
 ```
 
-These are run automatically by [Travis
-CI](https://travis-ci.org/google/recaptcha) against your Pull Request, but it's
-a good idea to run them locally before submission to avoid getting things
-bounced back. That said, tests can be a little daunting so feel free to submit
-your PR and ask for help.
+These are run automatically by [GitHub Actions](https://github.com/phpfui/recaptcha/actions) against your Pull Request, but it's a good idea to run them locally before submission to avoid getting things bounced back. That said, tests can be a little daunting so feel free to submit your PR and ask for help.
 
 ## Code reviews
 
-All submissions, including submissions by project members, require review.
-Reviews are conducted on the Pull Requests. The reviews are there to ensure and
-improve code quality, so treat them like a discussion and opportunity to learn.
-Don't get disheartened if your Pull Request isn't just automatically approved.
-
-### The small print
-
-Contributions made by corporations are covered by a different agreement than the
-one above, the Software Grant and Corporate Contributor License Agreement.
+All submissions, including submissions by project members, require review. Reviews are conducted on the Pull Requests. The reviews are there to ensure and improve code quality, so treat them like a discussion and opportunity to learn. Don't get disheartened if your Pull Request isn't just automatically approved.
diff --git a/README.md b/README.md
@@ -1,82 +1,39 @@
-# reCAPTCHA PHP client library
+# Google's reCAPTCHA PHP client library
 
-[![Build Status](https://travis-ci.org/google/recaptcha.svg)](https://travis-ci.org/google/recaptcha)
-[![Coverage Status](https://coveralls.io/repos/github/google/recaptcha/badge.svg)](https://coveralls.io/github/google/recaptcha)
-[![Latest Stable Version](https://poser.pugx.org/google/recaptcha/v/stable.svg)](https://packagist.org/packages/google/recaptcha)
-[![Total Downloads](https://poser.pugx.org/google/recaptcha/downloads.svg)](https://packagist.org/packages/google/recaptcha)
+[![Build Status](https://github.com/phpfui/recaptcha/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/recaptcha/actions?query=workflow%3Atests)
+[![Coverage Status](https://coveralls.io/repos/github/google/recaptcha/badge.svg)](https://coveralls.io/github/phpfui/recaptcha)
+[![Latest Stable Version](https://img.shields.io/packagist/v/phpfui/recaptcha.svg)](https://packagist.org/packages/phpfui/recaptcha)
+![](https://img.shields.io/badge/PHPStan-level%206-brightgreen.svg?style=flat)
 
-reCAPTCHA is a free CAPTCHA service that protects websites from spam and abuse.
-This is a PHP library that wraps up the server-side verification step required
-to process responses from the reCAPTCHA service. This client supports both v2
-and v3.
+reCAPTCHA is a free CAPTCHA service that protects websites from spam and abuse. This is a PHP library that wraps up the server-side verification step required to process responses from the reCAPTCHA service. This client supports both V2 and V3.
 
 - reCAPTCHA: https://www.google.com/recaptcha
-- This repo: https://github.com/google/recaptcha
+- This repo: https://github.com/phpfui/recaptcha
 - Hosted demo: https://recaptcha-demo.appspot.com/
-- Version: 1.3.0
+- Version: 2.0
 - License: BSD, see [LICENSE](LICENSE)
 
-## Installation
+### Notice: This is not an officially supported version of the Google Recaptcha package
 
-### Composer (recommended)
+It appears that Google is no longer interested in supporting their PHP Open Source packages for newer versions of PHP (8.4 and up). This package is an updated version of the original Google package. It has been updated to GitHub Actions and modern PHP standards. Every effort has been made to not change logic or behavior other than conformating to modern PHP standards.
 
-Use [Composer](https://getcomposer.org) to install this library from Packagist:
-[`google/recaptcha`](https://packagist.org/packages/google/recaptcha)
-
-Run the following command from your project directory to add the dependency:
-
-```sh
-composer require google/recaptcha "^1.3"
-```
-
-Alternatively, add the dependency directly to your `composer.json` file:
-
-```json
-"require": {
-    "google/recaptcha": "^1.3"
-}
-```
+This package will be retired if Google decides to support modern PHP versions.
 
 ### Support for earlier versions of PHP
 
-The 1.3 release moves to PHP 8 and up. For earlier versions, you will need to
-stay with the 1.2 releases.
-
-### Direct download
-
-Download the [ZIP file](https://github.com/google/recaptcha/archive/master.zip)
-and extract into your project. An autoloader script is provided in
-`src/autoload.php` which you can require into your script. For example:
-
-```php
-require_once '/path/to/recaptcha/src/autoload.php';
-$recaptcha = new \ReCaptcha\ReCaptcha($secret);
-```
+The 2.0 release allows for PHP 8.4. If you need only PHP 8.3 support and lower, you should continue to use the google/recaptcha package. For versions of PHP before 8.0, you will need to stay with the official Google 1.2 release on packagist (google/recaptcha).
 
-The classes in the project are structured according to the
-[PSR-4](https://www.php-fig.org/psr/psr-4/) standard, so you can also use your
-own autoloader or require the needed files directly in your code.
+The classes in the project are structured according to the [PSR-4](https://www.php-fig.org/psr/psr-4/) standard, so you can also use your own autoloader or require the needed files directly in your code.
 
 ## Usage
 
-First obtain the appropriate keys for the type of reCAPTCHA you wish to
-integrate for v2 at https://www.google.com/recaptcha/admin or v3 at
-https://g.co/recaptcha/v3.
+First obtain the appropriate keys for the type of reCAPTCHA you wish to integrate for v2 at https://www.google.com/recaptcha/admin or v3 at https://g.co/recaptcha/v3.
 
-Then follow the [integration guide on the developer
-site](https://developers.google.com/recaptcha/intro) to add the reCAPTCHA
-functionality into your frontend.
+Then follow the [integration guide on the developer site](https://developers.google.com/recaptcha/intro) to add the reCAPTCHA functionality into your frontend.
 
-This library comes in when you need to verify the user's response. On the PHP
-side you need the response from the reCAPTCHA service and secret key from your
-credentials. Instantiate the `ReCaptcha` class with your secret key, specify any
-additional validation rules, and then call `verify()` with the reCAPTCHA
-response (usually in `$_POST['g-recaptcha-response']` or the response from
-`grecaptcha.execute()` in JS which is in `$gRecaptchaResponse` in the example)
-and user's IP address. For example:
+This library comes in when you need to verify the user's response. On the PHP side you need the response from the reCAPTCHA service and secret key from your credentials. Instantiate the `ReCaptcha` class with your secret key, specify any additional validation rules, and then call `verify()` with the reCAPTCHA response (usually in `$_POST['g-recaptcha-response']` or the response from `grecaptcha.execute()` in JS which is in `$gRecaptchaResponse` in the example) and user's IP address. For example:
 
 ```php
-<?php
 $recaptcha = new \ReCaptcha\ReCaptcha($secret);
 $resp = $recaptcha->setExpectedHostname('recaptcha-demo.appspot.com')
                   ->verify($gRecaptchaResponse, $remoteIp);
@@ -101,11 +58,9 @@ The following methods are available:
 - `setChallengeTimeout($timeoutSeconds)`: set a timeout between the user passing
   the reCAPTCHA and your server processing it.
 
-Each of the `set`\*`()` methods return the `ReCaptcha` instance so you can chain
-them together. For example:
+Each of the `set`\*`()` methods return the `ReCaptcha` instance so you can chain them together. For example:
 
 ```php
-<?php
 $recaptcha = new \ReCaptcha\ReCaptcha($secret);
 $resp = $recaptcha->setExpectedHostname('recaptcha-demo.appspot.com')
                   ->setExpectedAction('homepage')
@@ -119,29 +74,22 @@ if ($resp->isSuccess()) {
 }
 ```
 
-You can find the constants for the libraries error codes in the `ReCaptcha`
-class constants, e.g. `ReCaptcha::E_HOSTNAME_MISMATCH`
+You can find the constants for the libraries error codes in the `ReCaptcha` class constants, e.g. `ReCaptcha::E_HOSTNAME_MISMATCH`
 
 For more details on usage and structure, see [ARCHITECTURE](ARCHITECTURE.md).
 
 ### Examples
 
-You can see examples of each reCAPTCHA type in [examples/](examples/). You can
-run the examples locally by using the Composer script:
+You can see examples of each reCAPTCHA type in [examples/](examples/). You can run the examples locally by using the Composer script:
 
 ```sh
 composer run-script serve-examples
 ```
 
-This makes use of the in-built PHP dev server to host the examples at
-http://localhost:8080/
+This makes use of the in-built PHP dev server to host the examples at http://localhost:8080/
 
-These are also hosted on Google AppEngine Flexible environment at
-https://recaptcha-demo.appspot.com/. This is configured by
-[`app.yaml`](./app.yaml) which you can also use to [deploy to your own AppEngine
-project](https://cloud.google.com/appengine/docs/flexible/php/download).
+These are also hosted on Google AppEngine Flexible environment at https://recaptcha-demo.appspot.com/. This is configured by [`app.yaml`](./app.yaml) which you can also use to [deploy to your own AppEngine project](https://cloud.google.com/appengine/docs/flexible/php/download).
 
 ## Contributing
 
-No one ever has enough engineers, so we're very happy to accept contributions
-via Pull Requests. For details, see [CONTRIBUTING](CONTRIBUTING.md)
+No one ever has enough engineers, so we're very happy to accept contributions via Pull Requests. Please run PHPCSFixer and PHPStan on all PRs.
diff --git a/examples/appengine-https.php b/examples/appengine-https.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BSD 3-Clause License
  * @copyright (c) 2019, Google Inc.
diff --git a/examples/recaptcha-v3-verify.php b/examples/recaptcha-v3-verify.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BSD 3-Clause License
  * @copyright (c) 2019, Google Inc.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`<?php`
	`2`	`+`
`2`	`3`	`/**`
`3`	`4`	`* BSD 3-Clause License`
`4`	`5`	`* @copyright (c) 2019, Google Inc.`