Replace GitHub rate limit functionality with HTTP API rate limit functionality

[gudmdharalds]

This pull request replaces the previous GitHub rate limit functionality with generic HTTP API rate limit functionality. This means that the functionality can cover other types of HTTP APIs. Furthermore, this new functionality is passive, meaning it does not make HTTP requests (saving resources), but rather records incoming HTTP response headers and keeps a record internally.

TODO:

• Add new HTTP API rate limit function (vipgoci_http_api_rate_limit_usage()):
  • Record response headers from GitHub API.
  • Record response headers from WPScan API.
• Remove GitHub API rate limit function (vipgoci_github_rate_limit_usage()).
• Rename function vipgoci_http_api_rate_limits_check() to vipgoci_http_api_rate_limit_check() for consistency.
• Switch to using vipgoci_http_api_rate_limit_usage() in main.php
• Update tests:
  • Remove tests/integration/GitHubRateLimitUsageTest.php.
  • Add tests/unit/HttpApiRateLimitUsageTest.php for new function.
  • Update tests/unit/HttpFunctionsHttpApiRateLimitsCheckTest.php.
• Check status of automated tests
• Ensure PHPDoc comments are up to date for functions added or altered
• Changelog entry (for VIP) [ Changelog for version 1.3.3 #312 ]
• Update vip-go-compatibility-scanner [ Replace GitHub rate limit function with HTTP API rate limit function vip-go-compatibility-scanner#46 ]

[wpcomvip-vipgoci-bot]

Code analysis identified issues

VIP Code Analysis Bot has identified potential problems in this pull request during automated scanning. We recommend reviewing the issues noted and that they are resolved.

phpcs scanning turned up:

🚫 1 error

---

This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

---

Scan run detail

Software versions vip-go-ci version: 1.3.2 PHP runtime version for vip-go-ci: 8.1.11 PHP runtime for linting: PHP 8.1: 8.1.11 PHP runtime version for PHPCS: 7.4.32 PHPCS version: 3.7.1 PHP runtime version for SVG scanner: 7.4.32 Options file (.vipgoci_options) Options file enabled: true Configurable options: skip-execution skip-draft-prs lint-modified-files-only phpcs phpcs-severity phpcs-sniffs-include phpcs-sniffs-exclude report-no-issues-found review-comments-sort review-comments-include-severity post-generic-pr-support-comments review-comments-sort scan-details-msg-include svg-checks autoapprove autoapprove-php-nonfunctional-changes Options altered: phpcs-severityset to1 phpcs-sniffs-includeset toGeneric.PHP.DisallowShortOpenTag, Squiz.PHP.CommentedOutCode phpcs-sniffs-excludeset toWordPress.Security.EscapeOutput, WordPress.PHP.DevelopmentFunctions, WordPress.WP.AlternativeFunctions, WordPress.PHP.DiscouragedPHPFunctions, WordPress.Files.FileName, Squiz.Commenting.FileComment, Generic.PHP.Syntax skip-draft-prsset to

PHP lint options PHP lint files enabled: true Lint modified files only: true Directories not PHP linted: None SVG configuration SVG scanning enabled: true Auto-approval configuration Auto-approvals enabled: true Non-functional changes auto-approved: true Auto-approved file-types: css csv eot gif gz ico ini jpeg jpg json less map md mdown mo mp4 otf pcss pdf po pot png sass scss styl ttf txt woff woff2 yml

PHPCS configuration PHPCS scanning enabled: true PHPCS severity level: 1 Standard(s) used: PHPCompatibility PHPCompatibilityParagonieRandomCompat PHPCompatibilityParagonieSodiumCompat VariableAnalysis WordPress Runtime set: testVersion 8.1- Custom sniffs included: Generic.PHP.DisallowShortOpenTag Squiz.PHP.CommentedOutCode Custom sniffs excluded: WordPress.Security.EscapeOutput WordPress.PHP.DevelopmentFunctions WordPress.WP.AlternativeFunctions WordPress.PHP.DiscouragedPHPFunctions WordPress.Files.FileName Squiz.Commenting.FileComment Generic.PHP.Syntax Directories not PHPCS scanned: tests/unit WPScan API configuration WPScan API scanning enabled: false

Dismissing review as all inline comments are obsolete by now

[wpcomvip-vipgoci-bot]

No issues were found to report when scanning latest commit (commit-ID: 175a8c3)

---

This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

---

---

Scan run detail

Software versions vip-go-ci version: 1.3.2 PHP runtime version for vip-go-ci: 8.1.11 PHP runtime for linting: PHP 8.1: 8.1.11 PHP runtime version for PHPCS: 7.4.32 PHPCS version: 3.7.1 PHP runtime version for SVG scanner: 7.4.32 Options file (.vipgoci_options) Options file enabled: true Configurable options: skip-execution skip-draft-prs lint-modified-files-only phpcs phpcs-severity phpcs-sniffs-include phpcs-sniffs-exclude report-no-issues-found review-comments-sort review-comments-include-severity post-generic-pr-support-comments review-comments-sort scan-details-msg-include svg-checks autoapprove autoapprove-php-nonfunctional-changes Options altered: phpcs-severityset to1 phpcs-sniffs-includeset toGeneric.PHP.DisallowShortOpenTag, Squiz.PHP.CommentedOutCode phpcs-sniffs-excludeset toWordPress.Security.EscapeOutput, WordPress.PHP.DevelopmentFunctions, WordPress.WP.AlternativeFunctions, WordPress.PHP.DiscouragedPHPFunctions, WordPress.Files.FileName, Squiz.Commenting.FileComment, Generic.PHP.Syntax skip-draft-prsset to

PHP lint options PHP lint files enabled: true Lint modified files only: true Directories not PHP linted: None SVG configuration SVG scanning enabled: true Auto-approval configuration Auto-approvals enabled: true Non-functional changes auto-approved: true Auto-approved file-types: css csv eot gif gz ico ini jpeg jpg json less map md mdown mo mp4 otf pcss pdf po pot png sass scss styl ttf txt woff woff2 yml

PHPCS configuration PHPCS scanning enabled: true PHPCS severity level: 1 Standard(s) used: PHPCompatibility PHPCompatibilityParagonieRandomCompat PHPCompatibilityParagonieSodiumCompat VariableAnalysis WordPress Runtime set: testVersion 8.1- Custom sniffs included: Generic.PHP.DisallowShortOpenTag Squiz.PHP.CommentedOutCode Custom sniffs excluded: WordPress.Security.EscapeOutput WordPress.PHP.DevelopmentFunctions WordPress.WP.AlternativeFunctions WordPress.PHP.DiscouragedPHPFunctions WordPress.Files.FileName Squiz.Commenting.FileComment Generic.PHP.Syntax Directories not PHPCS scanned: tests/unit WPScan API configuration WPScan API scanning enabled: false