Buzz - Scripted HTTP browser
[](https://github.com/kriswallsmith/Buzz/releases)
[](https://scrutinizer-ci.com/g/kriswallsmith/Buzz)
[](https://scrutinizer-ci.com/g/kriswallsmith/Buzz)
[](https://packagist.org/packages/kriswallsmith/buzz)
[](https://packagist.org/packages/kriswallsmith/buzz)
Buzz is a lightweight (<1000 lines of code) PHP 7.1 library for issuing HTTP requests. The library includes three
clients: `FileGetContents`, `Curl` and `MultiCurl`. The `MultiCurl` supports batch requests and HTTP2 server push.
## Installation
Install by running:
```bash
composer require kriswallsmith/buzz
```
You do also need to install a PSR-17 request/response factory. Buzz uses that factory
to create PSR-7 requests and responses. Install one from [this list](https://packagist.org/providers/psr/http-factory-implementation).
Example:
```bash
composer require nyholm/psr7
```
## Usage
This page will just show you the basics, please [read the full documentation](doc/).
```php
use Buzz\Browser;
use Buzz\Client\FileGetContents;
$client = new FileGetContents(new Psr17ResponseFactory());
$browser = new Browser($client, new Psr17RequestFactory());
$response = $browser->get('https://www.google.com');
echo $browser->getLastRequest()."\n";
// $response is a PSR-7 object.
echo $response->getStatusCode();
```
You can also use the low-level HTTP classes directly.
```php
use Buzz\Client\FileGetContents;
$request = new PSR7Request('GET', 'https://google.com/foo');
$client = new FileGetContents(new Psr17ResponseFactory());
$response = $client->sendRequest($request, ['timeout' => 4]);
echo $response->getStatusCode();
```
### Note
The two `new Psr17ResponseFactory()` and `new Psr17RequestFactory()` are placeholders
for whatever PSR-17 factory you choose. If you use `nyholm/psr7` then the example above
would start like:
```php
use Buzz\Browser;
use Buzz\Client\FileGetContents;
use Nyholm\Psr7\Factory\Psr17Factory;
$client = new FileGetContents(new Psr17Factory());
$browser = new Browser($client, new Psr17Factory());
$response = $browser->get('https://www.google.com');
```
### HTTP2 server push
Buzz MultiCurl client support HTTP2 server push.
```php
use Buzz\Client\MultiCurl;
use Nyholm\Psr7\Factory\Psr17Factory;
use Nyholm\Psr7\Request;
$client = new MultiCurl(new Psr17Factory());
$start = microtime(true);
$response = $client->sendRequest(new Request('GET', 'https://http2.golang.org/serverpush', [], null, '2.0'));
$timeFirstRequest = microtime(true) - $start;
// Parse response to find asset version.
$body = $response->getBody()->__toString();
$id = null;
if (preg_match('#/serverpush/static/style.css\?([0-9]+)#sim', $body, $matches)) {
$id = $matches[1];
}
// Make two new requests
$start = microtime(true);
$client->sendRequest(new Request('GET', 'https://http2.golang.org/serverpush/static/style.css?'.$id));
$client->sendRequest(new Request('GET', 'https://http2.golang.org/serverpush/static/playground.js?'.$id));
$timeOtherRequests = microtime(true) - $start;
echo 'First: '.$timeFirstRequest."\n";
echo 'Other: '.$timeOtherRequests."\n";
```
Since the two other requests was pushed, we spend no time fetching those.
```
First: 1.04281
Other: 0.00027
```
You can configure what request you want to accept as pushed with the `push_function_callback` option.
## The Idea of Buzz
Buzz was created by Kris Wallsmith back in 2010. The project grown very popular over the years with more than 7 million
downloads.
Since August 2017 [Tobias Nyholm](http://tnyholm.se) is maintaining this library. The idea of Buzz will still be the same,
we should have a simple API and mimic browser behavior for easy testing. We should not reinvent the wheel and we should
not be as powerful and flexible as other clients (ie Guzzle). We do, however, take performance very seriously.
We do love PSRs and this is a wish list of what PSR we would like to support:
* PSR-1 (Code style)
* PSR-2 (Code style)
* PSR-4 (Auto loading)
* PSR-7 (HTTP messages)
* PSR-17 (HTTP factories)
* PSR-18 (HTTP client)
## The goal
Since the release of 1.0 Buzz has reached its goal of being a lightweight client that covers 90% of all use cases. There
are no plans to actively develop new features or change the existing API. There are alternatives for people that wants
an more actively maintained HTTP clients. One that is particularly popular and got a big community behind it is the
[Symfony HTTP Client](https://github.com/symfony/http-client).
## Contribute
Buzz is great because it is small, simple and yet flexible. We are always happy to receive bug reports and bug fixes. We
are also looking forward to review a pull request with a new middleware, especially if the middleware covers a common
use case.
We will probably not accept any configuration option or feature to any of the clients or the Browser.
## Backwards Compatibility Promise
We take backwards compatibility very seriously as you should do with any open source project. We strictly follow [Semver](https://semver.org/).
Please note that Semver works a bit different prior version 1.0.0. Minor versions prior 1.0.0 are allow to break backwards
compatibility.
Being greatly inspired by [Symfony's bc promise](https://symfony.com/doc/current/contributing/code/bc.html), we have adopted
their method of deprecating classes, interfaces and functions.
## Running the tests
There are 2 kinds of tests for this library; unit tests and integration tests. They can be run separably by:
```bash
./vendor/bin/phpunit --testsuite Unit
./vendor/bin/phpunit --testsuite Integration
```
The integration tests makes real HTTP requests to a webserver. There are two different
webservers used by our integration tests. A real Nginx server and PHP's built in webserver.
The tests that runs with PHP's webserver are provided by `php-http/client-integration-tests`.
To start the server, open terminal A and run:
```bash
./vendor/bin/http_test_server
```
The other type of integration tests are using Nginx. We use Docker to start the
Nginx server.
```bash
docker build -t buzz/tests .
docker run -d -p 127.0.0.1:8022:80 buzz/tests
```
You are now ready to run the integration tests
```bash
./vendor/bin/phpunit --testsuite Integration
```
### Test Server Push
To use HTTP/2 server push you need to run the very latest PHP version. PHP also need to use cUrl > 7.61.1
and be compiled with libnghttp2.
You can use docker:
```bash
composer update
docker run -it --rm --name php-latest -v "$PWD":/usr/src/myapp -w /usr/src/myapp tommymuehle/docker-alpine-php-nightly \
php vendor/bin/phpunit tests/Integration/MultiCurlServerPushTest.php
```