d8-contrib-modules / cloudflarephpsdk Goto Github PK

Business Requirements

• As a developer I want a stable release of the SDK for inclusion in my application

Technical Requirements

• Pin Guzzle to a specific version
• Tag a release
• Confirm that a non-dev release tag is pushed to packagist (Don't want to pull down all the dev dependencies).
• Confirm that the readme is up-to-date.

@see https://github.com/cloudflare/cloudflare-php

Requirements

• Read API documentation here: https://api.cloudflare.com/#custom-ssl-for-a-zone-properties
• Read API documentation here: https://api.cloudflare.com/#keyless-ssl-for-a-zone-properties
• Implement SSL zone settings following the pattern established for zone api endpoint.
• Provide phpunit tests to ensure that the code works.

• Upgrade module to use Guzzle 6.

The original implementation was built using guzzle5. With D8 beta13 the default version of guzzle became guzzle6. This broke a lot.

Requirements

• Read API documentation here: https://api.cloudflare.com/#railgun-properties
• Implement RailGun Api following the pattern established for zone api endpoint.
• Provide phpunit tests to ensure that the code works.

Endpoint is

"zones/{$zone['id']}/settings/waf"

Business Requirements

• As the SDK creator I would like the core object model and design validated.

Technical Requirements

• Review the code
• Suggest changes that should be made
• Work with the module maintainer to create an architecture document with UML diagram of the object model
• Work with the module maintainer to create follow up issue to enact changes/cleanup

Currently there is a rudimentary set of PHPUnit tests. There were written by a first time PHP unit noob. There is ample opportunity for improvement. Goal is to reach 100% test coverage. We want high coverage but also meaningful coverage. So tests that don't just simply result in the code being executed but that tests the outputs as much as possible.

Business Requirements

• As a use of the PHP SDK I want to get meaningful and typed exceptions thrown when a request does not succeed as expected.

Background

The PHP SDK attempts to consolidate as much exception handling into a central location here:
https://github.com/d8-contrib-modules/cloudflarephpsdk/blob/master/src/ApiEndpoints/CloudFlareAPI.php#L123

The code is designed to throw typed exceptions when a problem happens and expects the implementing code to handle these exceptions:
https://github.com/d8-contrib-modules/cloudflarephpsdk/tree/master/src/Exceptions

Technical Requirements

• Review the exceptions that Guzzle can throw when misconfigured or endpoint is unreachable. Confirm that these exceptions are handled and if not fix/add exceptions.
• Review the cloudflare API here and look for the different exceptions. If any are not handled add them
• Review the existing PHPUnit tests here:
  https://github.com/d8-contrib-modules/cloudflarephpsdk/blob/master/tests/ApiEndpoints/ZoneApiTest.php
  and
  https://github.com/d8-contrib-modules/cloudflarephpsdk/blob/master/tests/ApiEndpoints/ZoneSettingsApiTest.php
• Add automated tests to cover these new edge cases.

Business Requirements

• As a developer I want to use a php sdk that uses PHP best practices.

Technical Requirements

• Research Symphony and Drupal Services. See if it makes sense to implement API endpoints as symphony services
• If it makes sense then implement symphony services.
• Update phpunit tests as necessary to fix breaking tests.
• Add any phpunit tests as necessary.

Cloudflare JUST rolled out purging with cache tags. Should be a quick and easy addition.
https://support.cloudflare.com/hc/en-us/articles/206596608-How-to-Purge-Cache-Using-Cache-Tags

Different endpoints have different rate limits. We should account for this somehow.

https://api.cloudflare.com/

I have the need to increase the per_page limit to be 1000, to which decreases by application's report time significantly.

Currently the method listZones does not allow overriding this value, and the other more raw method makeListingRequest is protected.

Ideal solution

per_page is allowed to be set by the application, and not the library.

The library should not set the parameter for any other request type apart from GET.

https://packagist.org/packages/d8-contrib-modules/cloudflarephpsdk

Following along with the examples in the README.md file, the loadZone method no longer exists.

$zone = $api->loadZone($zoneId);
$zone_settings = $zone-> getSettings();

Seems like getSettings is directly on the ZoneApi class:

$zone_settings = $api->getZoneSettings($zoneId);

Requirements

• Read API documenration here: https://api.cloudflare.com/#firewall-access-rule-for-a-zone-properties
• Implement Firewall Zone Api following the pattern established for zone api endpoint.
• Provide phpunit tests to ensure that the code works.

Requirements

[ ] As a maintainer of the SDK I want to ensure that the code has sufficient test coverage.
[ ] Add a test to the travis ci builds that runs the php unit tests with coverage and fails the build if code coverage drops below 80%.
[ ] Provide meaningful output to the user if the build fails due to insufficient code coverage.

I'm getting errors from the Cloudflare purger at times due to the client set timeout. I've verified API limits have not been breached but instead this is simply because Cloudflare had not responded in a timely manor.

Reported Error:

purger_cloudflare_055f11ff77: cURL error 28: Operation timed out after 3000 milliseconds with 0 bytes received (see http://curl.haxx.se/libcurl/c/libcurl-errors.html)

Whats unclear to me, is why, even after three seconds waiting for a response, no purging takes place. My default thought would be to extend the timeout to see if cloudflare timeouts to the API reduce.

I'm not familiar with phing. I wonder if it makes sense to swap out the current tools with Drupal TI, https://github.com/LionsAd/drupal_ti.