phergie / phergie-irc-plugin-http
Phergie plugin for Provide HTTP functionality to other plugins
Installs: 1 231
Dependents: 4
Suggesters: 0
Security: 0
Stars: 4
Watchers: 4
Forks: 5
Open Issues: 0
Requires
- php: ^7.0||^5.6
- phergie/phergie-irc-bot-react: ~2.0
- phergie/phergie-irc-plugin-dns: ^4.0
- wyrihaximus/react-guzzle-ring: ^1.0
Requires (Dev)
This package is auto-updated.
Last update: 2020-04-15 03:42:18 UTC
README
Phergie plugin for Provide HTTP functionality to other plugins.
Install
To install via Composer, use the command below, it will automatically detect the latest version and bind it with ~
.
composer require phergie/phergie-irc-plugin-http
See Phergie documentation for more information on installing and enabling plugins.
Requirements
The HTTP plugin requires the DNS plugin to be setup for DNS resolving.
Configuration
return [ 'plugins' => [ // dependency new \Phergie\Plugin\Dns\Plugin, // Needed to do DNS lookups new \Phergie\Plugin\Http\Plugin([ // All configuration is optional 'dnsResolverEvent' => 'dns.resolver', // Event for retrieving the DNS resolver, defaults to 'dns.resolver' 'guzzleClientOptions' => [], // Array with options passed into the Guzzle Client constructor (don't set a handler in here it will be overwritten) ]), ] ];
Usage
Get Guzzle HTTP Client
$this->emitter->emit('http.client', [ function (GuzzleHttp\Client $client) { // Make HTTP requests as documented on the Guzzle docs: http://guzzle.readthedocs.org/en/latest/clients.html#asynchronous-requests // When making requests make sure to pass the future flag as documented: http://guzzle.readthedocs.org/en/latest/faq.html#can-guzzle-send-asynchronous-requests }, ]);
Make a HTTP request
$this->emitter->emit('http.request', [new \Phergie\Plugin\Http\Request([ 'url' => 'https://github.com/', // Required 'resolveCallback' => function($response) { // Required // Data received do something with it }, 'method' => 'GET', // Optional, request method 'headers' => array(), // Optional, headers for the request 'body' => '', // Optional, request body to write after the headers 'rejectCallback' => function($error) {}, // Optional, callback that gets triggered on connection errors ])]);
A note about resolveCallback
and rejectCallback
. rejectCallback
will only fire on a socket error. So resolveCallback
will be called no matter what HTTP status code
as the request has been successful on a connection level. Choosing the appropriate response to a status code is up to the event callee.
Tests
To run the unit test suite:
curl -s https://getcomposer.org/installer | php
php composer.phar install
cd tests
../vendor/bin/phpunit
License
Released under the MIT License. See LICENSE
.