Skip to content

Commit

Permalink
Updated v2.0
Browse files Browse the repository at this point in the history
* Bump minimum PHP version to 7.2
* Remove `random_compat` polyfill for PHP 5.6
* Introduce PHP Code Sniffer for proper code quality checks
* Introduce GitHub contributor documentation
* Add the Contributor Covenant as our official Code of Conduct
* Bump PHPUnit and Coveralls dependencies for local development
  • Loading branch information
ericmann committed Jan 26, 2019
1 parent 0080007 commit 40fb7b8
Show file tree
Hide file tree
Showing 17 changed files with 1,101 additions and 555 deletions.
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org

# WordPress Coding Standards
# https://make.wordpress.org/core/handbook/coding-standards/

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab

[{*.json,*.yml}]
indent_style = space
indent_size = 2

[{*.txt,wp-config-sample.php}]
end_of_line = crlf
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions .phpcs.xml.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0"?>
<ruleset name="PSR-1 and PSR-2 code sniffs">
<description>Generally-applicable sniffs for modern PHP development</description>

<rule ref="PSR1">
<exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
</rule>
<rule ref="PSR2">
<exclude name="PSR2.Classes.PropertyDeclaration.Underscore" />
</rule>


<!-- Check all PHP files in directory tree by default. -->
<arg name="extensions" value="php"/>
<file>.</file>

<!-- Show progress and sniff codes in all reports -->
<arg value="ps"/>

<exclude-pattern>*/vendor/*</exclude-pattern>
<exclude-pattern>*/tests/*</exclude-pattern>
<exclude-pattern>*/languages/*</exclude-pattern>
<exclude-pattern>*/deprecatded.php</exclude-pattern>
</ruleset>
32 changes: 16 additions & 16 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
language: php

php:
- 5.6
- 7.0
- 7.1
- 7.2
- nightly

matrix:
fast_finish: true
allow_failures:
- php: nightly
include:
- php: 7.2
- php: 7.3
- php: nightly
- php: 7.3
env: TRAVISCI=phpcs
allow_failures:
- php: nightly
- php: 7.3
env: TRAVISCI=phpcs

before_script:
- composer install --dev --no-interaction

after_script:
- php vendor/bin/coveralls -v


script:
- mkdir -p build/logs
- ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
- php vendor/bin/phpunit -c phpunit.xml.dist
- |
if [[ "$TRAVISCI" == "phpcs" ]] ; then
php vendor/bin/phpcs
fi
after_success:
- travis_retry php vendor/bin/coveralls
- travis_retry php vendor/bin/php-coveralls
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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 eric@displace.tech. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017 Eric Mann eric@eamann.com
Copyright (c) 2019 Eric Mann eric@eamann.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TOTP ![PHP 5.6+][php-image] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Packagist][packagist-image]][packagist-url]
# TOTP ![PHP 7.2+][php-image] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Packagist][packagist-image]][packagist-url]

A PHP library for generating one-time passwords according to [RFC-6238](http://tools.ietf.org/html/rfc6238) for time-based OTP generation.

Expand All @@ -25,7 +25,7 @@ if (EAMann\TOTP\is_valid_auth_code($token, $otp)) {
```


[php-image]: https://img.shields.io/badge/php-5.6%2B-green.svg
[php-image]: https://img.shields.io/badge/php-7.2%2B-green.svg
[packagist-image]: https://img.shields.io/packagist/dt/ericmann/totp.svg
[packagist-url]: https://packagist.org/packages/ericmann/totp
[travis-image]: https://travis-ci.org/ericmann/totp.svg?branch=master
Expand Down
17 changes: 8 additions & 9 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"name": "ericmann/totp",
"description": "PHP5.6+ compatible implementation of the TOTP protocol.",
"description": "PHP implementation of the TOTP protocol.",
"version": "2.0.0",
"type": "library",
"keywords": ["totp", "one-time password"],
"license": "MIT",
"authors": [
{
Expand All @@ -21,15 +23,12 @@
]
},
"require": {
"php": ">=5.6.3",
"paragonie/constant_time_encoding": "^1.0.0",
"paragonie/random_compat": "^2.0"
"php": ">=7.2",
"paragonie/constant_time_encoding": "^1.0.0"
},
"require-dev": {
"doctrine/instantiator": ">=1.0, <1.1",
"phpdocumentor/reflection-docblock": "<3.2.3",
"phpunit/php-token-stream": "^1.4",
"phpunit/phpunit": "^5.7",
"satooshi/php-coveralls": "^1.0"
"phpunit/phpunit": "^7.5",
"php-coveralls/php-coveralls": "^2.1",
"squizlabs/php_codesniffer": "^3.4"
}
}
Loading

0 comments on commit 40fb7b8

Please sign in to comment.