Flysystem adapter for Citrix ShareFile
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tests
.editorconfig
.gitattributes
.gitignore
.php_cs
.scrutinizer.yml
.styleci.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
README.md
composer.json
phpunit.xml.dist

README.md

Flysystem adapter for Citrix ShareFile

Latest Version on Packagist Build Status StyleCI Quality Score Total Downloads

This package contains a Flysystem adapter for Citrix ShareFile. Under the hood my Sharefile API package is used.

Installation

You can install the package via composer:

composer require kapersoft/flysystem-sharefile

Usage

The first thing you need to do is get an OAuth2 key. Go to the Get an API key section on the ShareFile API site to get this key.

With an OAuth2 key you can instantiate a Kapersoft\Sharefile\Client and setup the Flysystem adapter:

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.

Testing

In the /tests-folder are two tests defined

  • SharefileAdapterTest.php
  • SharefileAdapterFunctionalTest.php

To start both tests type in your terminal:

composer test

SharefileAdapterTest.php tests the Kapersoft\FlysystemSharefile\SharefileAdapter-class using phpspec prophecy and mock objects.

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).

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email kapersoft@gmail.com instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.