Cloudflare WP API

, _(*1)

WordPress HTTP API replacement of the jamesryanbell/cloudflare package., _(*2)

, _(*3)

Why use WP HTTP API instead of curl?
Install
Usage
- Successful responses
- Error responses
Start Developing
Running the Tests
Feedback
Change log
Contributing
Security
Credits
License

Why use `WP HTTP API` instead of `curl`?

curl is great. However, it is not always available on every hosts, especially shared hosting. Using WordPress HTTP API lets WordPress figure out the best way to make HTTP requests. It could be curl or something else. You don't need to care about it. See WordPress codex., _(*4)

Install

Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/., _(*5)

``` bash $ composer require typisttech/cloudflare-wp-api, _(*6)


Since the [jamesryanbell/cloudflare](https://packagist.org/packages/jamesryanbell/cloudflare) package doesn't provide a way to inject client objects,
we have to rename ``Cloudflare\Api`` to ``Cloudflare\BaseApi``. And, use our [``Api``](src/Api.php) class instead 

``` bash
$ vendor/bin/cfwp build

You have to run the command on every composer install and composer update. A better way to do so is to add this command to composer.json like so:, _(*7)

``` json "scripts": { "post-install-cmd": "cfwp build", "post-update-cmd": "cfwp build" }, _(*8)



## Usage

Once ``$ cfwp build`` is done, you can use it exactly the same as the original package. 

See [jamesryanbell/cloudflare](https://github.com/jamesryanbell/cloudflare) for more details about the original package.

### Successful responses

Decode **body** array from ``wp_remote_request``.

### Error responses

``WP_Error`` object. Maybe returned from ``wp_remote_request``, or one of the followings:

| Code                  | Message                                       | Data      |
|:--------------------- |:--------------------------------------------- |:--------- |
| authentication-error  | Authentication information must be provided   |           |
| authentication-error  | Email is not valid                            |           |
| decode-error          | Response errors is not an array               | response  |

Or, one of the Coudlfare defined error codes, here is some example:

| Code  | Message                                                   | Data      |
|:----- |:--------------------------------------------------------- |:--------- |
| 1012  | Request must contain one of 'purge_everything' or 'files' | response  |
| 1210  | That operation is no longer allowed for that domain       | response  |

## Start Developing

This command will clone the project source code from GitHub and install its dependencies. 

``` bash
$ composer create-project --no-install --prefer-source --keep-vcs typisttech/cloudflare-wp-api:dev-master
$ cd cloudflare-wp-api
$ composer install

Running the Tests

Cloudflare WP API run tests on Codeception and relies wp-browser to provide WordPress integration. Before testing, you have to install WordPress locally and add a codeception.yml file. See codeception.example.yml for a Varying Vagrant Vagrants configuration example., _(*9)

Actually run the tests:, _(*10)

bash $ composer test, _(*11)

We also test all PHP files against PSR-2: Coding Style Guide and part of the WordPress coding standard., _(*12)

Check the code style with $ composer check-style and fix it with $ composer fix-style., _(*13)

Feedback

Please provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small., _(*14)