Add streaming API

[clue]

Refs #4

[adamlc]

Looks good!

[clue]

Thanks for your feedback!

In order to get this in faster, this PR will only address adding a streaming API for existing endpoints, it is not about adding additional endpoints.

This PR lacks some documentation.

The existing endpoints containerExport() and containerCopy() return streams in the TAR file format and afaict there's no easy way to consume these via React PHP. As such, I've looked into creating a library over at https://github.com/clue/php-tar-react . We won't necessarily have to include this here, but we should provide some documentation. This PR will be postponed for now.

[clue]

I've looked into creating a library over at https://github.com/clue/php-tar-react . We won't necessarily have to include this here, but we should provide some documentation. This PR will be postponed for now.

I've just released an early v0.1.0 of clue/tar-react, so I can now continue looking into this PR :)

[clue]

Remaining TODOs:

• Streaming API for containerPush endpoint
• Documentation

[clue]

I've just added caret notation encoding to the copy/export example, so that dumping binary files does not screw up your terminal.

Now getting back to the last missing tests..

[clue]

There you go, I've just completed the last TODOs and removed the WIP marker.

Any feedback is very much appreciated! 👍

[adamlc]

Awesome! I'll try and give it a whirl over the next couple of days!

[clue]

Awesome! I'll try and give it a whirl over the next couple of days!

Awesome, let me know if you get to this!

Two remaining issues:

• Remove Promise progress API (see Parse streaming responses #4 for discussion)
• Reject Promise if progress messages indicate an error (see Reject streaming API endpoints if message indicates an error #21 for background)

[clue]

I think this is finally completed 👏

This is a non-trivial feature addition, so this can probably use another review :)

[clue]

This is a non-trivial feature addition, so this can probably use another review :)

Either way, let's get this in