Merge pull request #1 from Zwartpet/php70-compat

Php70 compat

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/docs               export-ignore

.gitignore

@@ -0,0 +1,7 @@
+.idea
+build
+composer.lock
+vendor
+examples/keys
+certificates
+keys

.scrutinizer.yml

@@ -0,0 +1,23 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+
+tools:
+    external_code_coverage:
+        timeout: 600
+        runs: 2

.styleci.yml

@@ -0,0 +1 @@
+preset: psr2

.travis.yml

@@ -0,0 +1,34 @@
+dist: trusty
+language: php
+
+php:
+  - 7.0
+  - 7.1
+
+# This triggers builds to run on the new TravisCI infrastructure.
+# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
+
+## Cache composer
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+#matrix:
+#  include:
+#    - php: 5.6
+#      env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
+
+before_script:
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
+
+script:
+  - vendor/bin/phpcs --standard=psr2 src/
+  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
+
+after_script:
+  - |
+    if [[ "$TRAVIS_PHP_VERSION" != 'hhvm' && "$TRAVIS_PHP_VERSION" != '7.0' ]]; then
+      wget https://scrutinizer-ci.com/ocular.phar
+      php ocular.phar code-coverage:upload --format=php-clover coverage.clover
+    fi

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to `php-certificate-toolbox` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## 0.1.0 
+
+First release after major refactoring of [LEClient](https://github.com/yourivw/leclient) 
+to be composer installable and testable, as well as support for alternative storage
+systems.
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `[email protected]`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**. This page details how to 
+contribute and the expected code quality for all contributions.
+
+## Pull Requests
+
+We accept contributions via Pull Requests on [Github](https://github.com/lordelph/php-certificate-toolbox).
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **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.
+
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+## Exceptions
+
+* All exceptions thrown by code in this package MUST implement `LEClientException`
+* Custom exception classes SHOULD derive from standard base exceptions where appropriate
+* a `LogicException` SHOULD be used for invalid use of methods or classses which would be
+  fixable by the developer using the classes
+* a `RuntimeException` SHOULD be used for problems which arise from unexpected external 
+  conditions, such as an ACME API failure.
+* It is not necessary to add code coverage for runtime exceptions - such code paths SHOULD
+  be marked with `@codeCoverageIgnoreStart` / `@codeCoverageIgnoreEnd` markers
+
+## Logging
+
+The classes use a PSR-3 compatible logger. The following should be used as a guideline
+for appropriate logging levels:
+
+* `debug` is for maintainer use only. If an end-user has an issue, they should be asked to
+  submit a report which contains a log with debug enabled. This should allow the interactions
+  with the remote ACME API to be observed.
+* `info` should record a general interaction which an outside observer would find interesting,
+  typically, that a high level method of the main client class has been used.
+* `notice` should record some expected change of state, e.g. a new order, new certificate etc 
+* `warning` should record an unusual but handled problem, e.g. regenerating a private key
+* `error` should record an unusual but unhandled problem
+* `critical` should record any logic problem where the problem is likely correctable by the 
+  code using these classes. It will usually be followed by a `LogicException`
+* `alert` should record unexpected issues arising from ACME API interactions, and will
+  generally be followed by a `RuntimeException`
+* `emergency` should be used only when time is of the essence. This is not presently used
+  but one example might be failure to renew a certificate when an existing certificate is
+  known to be expiring soon
+
+
+
+
+**Happy coding**!

ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!-- Provide a general summary of the issue in the Title above -->
+
+## Detailed description
+
+Provide a detailed description of the change or addition you are proposing.
+
+Make it clear if the issue is a bug, an enhancement or just a question.
+
+## Context
+
+Why is this change important to you? How would you use it?
+
+How can it benefit other users?
+
+## Possible implementation
+
+Not obligatory, but suggest an idea for implementing addition or change.
+
+## Your environment
+
+Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
+
+* Version used (e.g. PHP 5.6, HHVM 3):
+* Operating system and version (e.g. Ubuntu 16.04, Windows 7):
+* Link to your project:
+* ...
+* ...