potherca / flysystem-github
Flysystem adapter for Github
Requires
- php: >=5.4
- knplabs/github-api: ^1.4
- league/flysystem: ^1.0
Requires (Dev)
- php: >=5.5
- josegonzalez/dotenv: ~2.0
- phpunit/phpunit: ~4.8
- satooshi/php-coveralls: ~0.6
- scrutinizer/ocular: ~1.1
- whatthejeff/nyancat-phpunit-resultprinter: ~1.2
This package is auto-updated.
Last update: 2024-10-10 04:36:16 UTC
README
Install
Via Composer
$ composer require potherca/flysystem-github
Usage
The Github adapter can be used without credentials to do read-only actions on public repositories. To avoid reaching the Github API limit, to save changes, or to read from private repositories, credentials are required.
Caching can be utilized to save traffic or to postpone reaching the Github API limit.
Basic Usage
use Github\Client; use League\Flysystem\Filesystem; use Potherca\Flysystem\Github\Api; use Potherca\Flysystem\Github\GithubAdapter; use Potherca\Flysystem\Github\Settings; $project = 'thephpleague/flysystem'; $settings = new Settings($project); $api = new Api(new Client(), $settings); $adapter = new GithubAdapter($api); $filesystem = new Filesystem($adapter);
Authentication
use Github\Client; use League\Flysystem\Filesystem; use Potherca\Flysystem\Github\Api; use Potherca\Flysystem\Github\GithubAdapter; use Potherca\Flysystem\Github\Settings; $project = 'thephpleague/flysystem'; $credentials = [Settings::AUTHENTICATE_USING_TOKEN, '83347e315b8bb4790a48ed6953a5ad9e825b4e10']; // or $authentications = [Settings::AUTHENTICATE_USING_PASSWORD, $username, $password]; $settings = new Settings($project, $credentials); $api = new Api(new Client(), $settings); $adapter = new GithubAdapter($api); $filesystem = new Filesystem($adapter);
Cache Usage
use Github\Client; use Github\HttpClient\CachedHttpClient as CachedClient; use Github\HttpClient\Cache\FilesystemCache as Cache; use League\Flysystem\Filesystem; use Potherca\Flysystem\Github\Api; use Potherca\Flysystem\Github\GithubAdapter; use Potherca\Flysystem\Github\Settings; $project = 'thephpleague/flysystem'; $settings = new Settings($project); $cache = new Cache('/tmp/github-api-cache') $cacheClient = new CachedClient(); $cacheClient->setCache($cache); $api = new Api($cacheClient, $settings); $adapter = new GithubAdapter($api); $filesystem = new Filesystem($adapter);
Testing
The unit-tests can be run with the following command:
$ composer test
To run integration tests, which use the Github API, a Github API token might be needed (to stop the tests hitting the API Limit).
An API key can be added by setting it in the environment as GITHUB_API_KEY
or by creating an .env
file in the integration tests directory and setting it there.
See tests/integration-tests/.env.example
for an example.
To run the integration test, run the following command (this will also run the unit-tests):
$ composer test-all
Security
If you discover any security related issues, please email potherca@gmail.com instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Change Log
Please see CHANGELOG for details.
Credits
License
The MIT License (MIT). Please see License File for more information.