kreait/tape-recorder-subscriber

This package is abandoned and no longer maintained. No replacement package was suggested.

Record HTTP interactions to replay them later with the Tape Recorder Subscriber for the Ivory HTTP Adapter

3.0.2 2016-07-16 08:46 UTC

Requires

• egeloen/http-adapter: ^0.8|^1.0
• symfony/event-dispatcher: ^2.6|^3.0
• symfony/yaml: ^2.6|^3.0

Requires (Dev)

• fabpot/php-cs-fixer: ^1.6
• phpunit/phpunit: ^4.6

MIT

• Jérôme Gamez

README

The Tape Recorder Subscriber for the Ivory HTTP Adapter works similarly to the php-vcr and also uses similar wordings :).

With it, it is possible to record the HTTP interactions, e.g. in Unit Tests, store them as Fixture files and replay them in future runs.

An example fixture (actually used for such a test) can be found here: Example fixture.

Usage

use Ivory\HttpAdapter\EventDispatcherHttpAdapter;
use Ivory\HttpAdapter\HttpAdapterFactory;
use Kreait\Ivory\HttpAdapter\Event\Subscriber\TapeRecorderSubscriber;
use Symfony\Component\EventDispatcher\EventDispatcher;

$recorder = new TapeRecorderSubscriber(__DIR__.'/fixtures');

$eventDispatcher = new EventDispatcher();
$eventDispatcher->addSubscriber($this->recorder);

$http = new EventDispatcherHttpAdapter(
    HttpAdapterFactory::guess(),
    $eventDispatcher
);       

$recorder->insertTape('my_tape');
$recorder->startRecording();
$httpAdapter->get(...); // This interaction will be stored as a track.
$recorder->stopRecording;
$httpAdapter->get(...); // This interaction will not be stored.
$recorder->eject(); // Stores the tape to the file system

Recording modes

$recorder->setRecordingMode(...);

The following recording modes can be set when using the Tape Recorder:

Mode	Description
RECORDING_MODE_ONCE	(default) Performs a real request and stores it to a fixture, unless a fixture already exists.
RECORDING_MODE_OVERWRITE	Always performs a real request and overwrites the fixture.
RECORDING_MODE_NEVER	Always performs a real request and does not write a fixture.

Usage example in Unit Tests

namespace My\Application\Tests;

use Ivory\HttpAdapter\EventDispatcherHttpAdapter;
use Ivory\HttpAdapter\HttpAdapterFactory;
use Kreait\Ivory\HttpAdapter\Event\Subscriber\TapeRecorderSubscriber;
use Symfony\Component\EventDispatcher\EventDispatcher;

class MyTest extends extends \PHPUnit_Framework_TestCase
{
    /** @var \Ivory\HttpAdapter\HttpAdapterInterface **/
    protected $http;
    
    /** @var TapeRecorderSubscriber */
    protected $recorder;

    protected function setUp()
    {
        $this->recorder = new TapeRecorderSubscriber(__DIR__.'/fixtures');

        $http = HttpAdapterFactory::guess();

        $eventDispatcher = new EventDispatcher();
        $eventDispatcher->addSubscriber($this->recorder);

        $this->http = new EventDispatcherHttpAdapter(
            $http, $eventDispatcher
        );
    }

    protected function tearDown()
    {
        $this->recorder->eject();
    }

    protected function testRequest()
    {
        // This will result in the file 'fixtures/testRequest.yml'
        $this->recorder->insertTape(__FUNCTION__);
        $this->recorder->startRecording();
        $this->http->get(...);
    }
}