Skip to content

Commit c15c6d6

Browse files
author
Ramesh Mhetre
committed
Basic file structure
1 parent 1d3de9b commit c15c6d6

9 files changed

+532
-0
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
build
2+
composer.lock
3+
docs
4+
vendor

‎CHANGELOG.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
All Notable changes to `flysystem-backblaze` will be documented in this file.
4+
5+
Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
6+
7+
## NEXT - YYYY-MM-DD
8+
9+
### Added
10+
- Nothing
11+
12+
### Deprecated
13+
- Nothing
14+
15+
### Fixed
16+
- Nothing
17+
18+
### Removed
19+
- Nothing
20+
21+
### Security
22+
- Nothing

‎CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at `contact@thephpleague.com`. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/mhetreramesh/flysystem-backblaze).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
23+
24+
25+
## Running Tests
26+
27+
``` bash
28+
$ composer test
29+
```
30+
31+
32+
**Happy coding**!

‎ISSUE_TEMPLATE.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Provide a general summary of the issue in the Title above -->
2+
3+
## Detailed description
4+
5+
Provide a detailed description of the change or addition you are proposing.
6+
7+
Make it clear if the issue is a bug, an enhancement or just a question.
8+
9+
## Context
10+
11+
Why is this change important to you? How would you use it?
12+
13+
How can it benefit other users?
14+
15+
## Possible implementation
16+
17+
Not obligatory, but suggest an idea for implementing addition or change.
18+
19+
## Your environment
20+
21+
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
22+
23+
* Version used (e.g. PHP 5.6, HHVM 3):
24+
* Operating system and version (e.g. Ubuntu 16.04, Windows 7):
25+
* Link to your project:
26+
* ...
27+
* ...

‎PULL_REQUEST_TEMPLATE.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
5+
Describe your changes in detail.
6+
7+
## Motivation and context
8+
9+
Why is this change required? What problem does it solve?
10+
11+
If it fixes an open issue, please link to the issue here (if you write `fixes #num`
12+
or `closes #num`, the issue will be automatically closed when the pull is accepted.)
13+
14+
## How has this been tested?
15+
16+
Please describe in detail how you tested your changes.
17+
18+
Include details of your testing environment, and the tests you ran to
19+
see how your change affects other areas of the code, etc.
20+
21+
## Screenshots (if appropriate)
22+
23+
## Types of changes
24+
25+
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
26+
- [ ] Bug fix (non-breaking change which fixes an issue)
27+
- [ ] New feature (non-breaking change which adds functionality)
28+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
29+
30+
## Checklist:
31+
32+
Go over all the following points, and put an `x` in all the boxes that apply.
33+
34+
Please, please, please, don't send your pull request until all of the boxes are ticked.
35+
36+
- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
37+
- [ ] My pull request addresses exactly one patch/feature.
38+
- [ ] I have created a branch for this patch/feature.
39+
- [ ] Each individual commit in the pull request is meaningful.
40+
- [ ] I have added tests to cover my changes.
41+
- [ ] All new and existing tests passed.
42+
- [ ] If my change requires a change to the documentation, I have updated it accordingly.
43+
- [ ] My code follows the code style of this project.
44+
45+
If you're unsure about any of these, don't hesitate to ask. We're here to help!

‎README.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# flysystem-backblaze
2+
3+
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE.md)
5+
[![Build Status][ico-travis]][link-travis]
6+
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
7+
[![Quality Score][ico-code-quality]][link-code-quality]
8+
[![Total Downloads][ico-downloads]][link-downloads]
9+
10+
The Backblaze adapter gives the possibility to use the Flysystem filesystem abstraction library with backblaze. It uses the [Backblaze B2 SDK](https://github.com/cwhite92/b2-sdk-php) to communicate with the API.
11+
12+
## Install
13+
14+
Via Composer
15+
16+
``` bash
17+
$ composer require mhetreramesh/flysystem-backblaze
18+
```
19+
20+
## Usage
21+
22+
``` php
23+
$skeleton = new League\Skeleton();
24+
echo $skeleton->echoPhrase('Hello, League!');
25+
```
26+
27+
## Change log
28+
29+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
30+
31+
## Testing
32+
33+
``` bash
34+
$ composer test
35+
```
36+
37+
## Contributing
38+
39+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
40+
41+
## Security
42+
43+
If you discover any security related issues, please email mhetreramesh@gmail.com instead of using the issue tracker.
44+
45+
## Credits
46+
47+
- [Ramesh Mhetre][link-author]
48+
- [All Contributors][link-contributors]
49+
50+
## License
51+
52+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
53+
54+
[ico-version]: https://img.shields.io/packagist/v/mhetreramesh/flysystem-backblaze .svg?style=flat-square
55+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
56+
[ico-travis]: https://img.shields.io/travis/mhetreramesh/flysystem-backblaze /master.svg?style=flat-square
57+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/mhetreramesh/flysystem-backblaze .svg?style=flat-square
58+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/mhetreramesh/flysystem-backblaze .svg?style=flat-square
59+
[ico-downloads]: https://img.shields.io/packagist/dt/mhetreramesh/flysystem-backblaze .svg?style=flat-square
60+
61+
[link-packagist]: https://packagist.org/packages/mhetreramesh/flysystem-backblaze
62+
[link-travis]: https://travis-ci.org/mhetreramesh/flysystem-backblaze
63+
[link-scrutinizer]: https://scrutinizer-ci.com/g/mhetreramesh/flysystem-backblaze /code-structure
64+
[link-code-quality]: https://scrutinizer-ci.com/g/mhetreramesh/flysystem-backblaze
65+
[link-downloads]: https://packagist.org/packages/mhetreramesh/flysystem-backblaze
66+
[link-author]: https://github.com/mhetreramesh
67+
[link-contributors]: ../../contributors

‎composer.json

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"name": "mhetreramesh/flysystem-backblaze",
3+
"type": "library",
4+
"description": "Backblaze adapter for the flysystem filesystem abstraction library",
5+
"keywords": ["flysystem", "filesystem", "api", "backblaze", "client"],
6+
"homepage": "https://github.com/mhetreramesh/flysystem-backblaze",
7+
"license": "MIT",
8+
"authors": [
9+
{
10+
"name": "Ramesh Mhetre",
11+
"email": "mhetreramesh@gmail.com",
12+
"homepage": "https://about.me/rameshmhetre",
13+
"role": "Developer"
14+
}
15+
],
16+
"require": {
17+
"php": ">=5.4.0",
18+
"league/flysystem": "~1.0",
19+
"cwhite92/b2-sdk-php" : "^1.2"
20+
},
21+
"require-dev": {
22+
"phpunit/phpunit" : "~4.0||~5.0",
23+
"scrutinizer/ocular": "~1.1",
24+
"squizlabs/php_codesniffer": "~2.3"
25+
},
26+
"autoload": {
27+
"psr-4": {
28+
"mhetreramesh\\flysystem\backblaze\\": "src"
29+
}
30+
},
31+
"autoload-dev": {
32+
"psr-4": {
33+
"mhetreramesh\\flysystem-backblaze\\": "tests"
34+
}
35+
},
36+
"scripts": {
37+
"test": "phpunit",
38+
"format": "phpcbf --standard=psr2 src/"
39+
},
40+
"extra": {
41+
"branch-alias": {
42+
"dev-master": "1.0-dev"
43+
}
44+
},
45+
"config": {
46+
"sort-packages": true
47+
}
48+
}

0 commit comments

Comments
 (0)