kapersoft/flysystem-sharefile

Flysystem Adapter for ShareFile

Flysystem adapter for Citrix ShareFile

, _(*1)

This package contains a Flysystem adapter for Citrix ShareFile. Under the hood my Sharefile API package is used., _(*2)

Installation

You can install the package via composer:, _(*3)

``` bash composer require kapersoft/flysystem-sharefile, <sub>(*4)</sub>

## Usage
The first thing you need to do is get an OAuth2 key. Go to the [Get an API key](https://api.sharefile.com/rest/oauth2-request.aspx) section on the [ShareFile API site](https://api.sharefile.com/) to get this key.

With an OAuth2 key you can instantiate a `Kapersoft\Sharefile\Client` and setup the Flysystem adapter:
``` php
use League\Flysystem\Filesystem;
use Kapersoft\Sharefile\Client;
use Kapersoft\FlysystemSharefile\SharefileAdapter;

$client = new Client('hostname', 'client_id', 'secret', 'username', 'password');

$adapter = new SharefileAdapter($client);

$filesystem = new Filesystem($adapter);

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*5)</sub>

Testing

In the /tests-folder are two tests defined - SharefileAdapterTest.php - SharefileAdapterFunctionalTest.php, <sub>(*6)</sub>

To start both tests type in your terminal: bash composer test, <sub>(*7)</sub>

SharefileAdapterTest.php tests the Kapersoft\FlysystemSharefile\SharefileAdapter-class using phpspec prophecy and mock objects., <sub>(*8)</sub>

SharefileAdapterFunctionalTest.php is a set of functional tests using an online ShareFile drive . To enable this test, fill in your ShareFile credentials under section <PHP> of the phpunit.xml.dist-file in the project root folder. Each test will create the folder named Flysystem-sharefile-test in your personal ShareFile drive for storing temporary test-files. When the test is completed, the Flysystem-sharefile-test-folder will be removed. A WebDav connection to your ShareFile drive is used to assert all tests. Note: Make sure WebDav is enabled for your ShareFile account (see https://support.citrix.com/article/CTX207863 for more information)., <sub>(*9)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*10)</sub>

Security

If you discover any security related issues, please email kapersoft@gmail.com instead of using the issue tracker., <sub>(*11)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*12)</sub>