Enable a way to provide a custom configured Tus library.

[cjsaylor]

This PR gives the ability to provide a TusClient factory to the Vimeo client. When performing an upload action the factory is used to create a TusClient instead of having a tus client created directly in a private method.

The developer if wanting to inject their own factory would need to implement the factory interface provided in this PR and pass into the Vimeo client constructor.

This allows customization of the TusClient by users of the Vimeo api client. For example, the default caching behavior of the TusClient library is a FileStore that creates temporary files within the vendor include directory. In my case, it is not desirable to allow write access to that directory from php runtime.

Example use:

<?php declare(strict_types = 1);

namespace My\Namespace;

use TusPhp\Cache\FileStore;
use Vimeo\Upload\TusClient;
use Vimeo\Upload\TusClientFactoryInterface;

class TusClientFactory implements TusClientFactoryInterface {

	/**
	 * @var \TusPhp\Cache\FileStore
	 */
	private $fileCache;

	/**
	 * Constructor.
	 */
	public function __construct() {
		$this->fileCache = new FileStore('/tmp');
	}

	/**
	 * Create a tus php client given a baes URL.
	 */
	public function fromBaseUrl(string $baseUrl) : TusClient {
		$client = new TusClient($baseUrl);
		$client->setCache($this->fileCache);
		return $client;
	}
}

Then, where I create a Vimeo client:

$client = new Vimeo(
	'client_id', 
	'client_secret', 
	'access_token',
	new \My\Namespace\TusClientFactory()
);

A default implementation that does what the library did before has been implemented and is utilized when the developer does not provide it to the constructor.

[kezek]

+1 , having the same issue.

The cacheDir is by default /vendor/ankitpokhrel/tus-php/.cache/, which is not writable in a sane environment.

[nyavo]

I have the same issue, with the cacheDir vendor/ankitpokhrel/tus-php/.cache/ not writable. So the tus upload failed everytime.
The ankitpokhrel/tus-php bundle works perfectly, il would be perfect if we can override this cache folder, or use Redis instead.

[IgorSuhorukov]

Same issue here - can't upload, due to /vendor/ankitpokhrel/tus-php/.cache/ is not writable and can't be changed.

[harpreetsb]

is there an update on this?

[aaronm67]

Thank you for the suggestion!

We modified this slightly to our standards, and added some examples and test for it, so going to close this, but we appreciate the contribution!