Merge pull request #39 from Colin-b/develop

Release 4.1.0

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: master
+    hooks:
+      - id: black

CHANGELOG.md

@@ -1,72 +1,96 @@
-# Requests Authentication Changelog #
-
-List all changes in various categories:
-* Release notes: Contains all worth noting changes (breaking changes mainly)
-* Enhancements
-* Bug fixes
-* Known issues
-
-## 4.0.1 (2018-12-16) ##
-
-### Bug fixes ###
-
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [4.1.0] - 2019-11-13
+### Added
+- module version is now publicly available.
+- multiple authentication is now possible using "+" sign.
+- OktaAuthorizationCode is now available.
+- OktaClientCredentials is now available.
+- OAuth2AuthorizationCodePKCE is now available.
+- OktaAuthorizationCodePKCE is now available.
+- Exception classes defined in requests_auth.errors are now available via requests_auth.
+
+### Deprecated
+- Auths class will be considered as internal in the future and should not be used anymore. Use "+" instead.
+- This is the latest release to support Python 2.7, next release will be 3.6+ only.
+- requests_auth.errors will be renamed into requests_auth.exceptions in the future.
+- str representation of authentication classes will be removed in the future.
+- requests_auth.oauth2 function will be removed in the future. Use specific class instead.
+- requests_auth.aad function will be removed in the future. Use specific class instead.
+- requests_auth.okta function will be removed in the future. Use specific class instead.
+
+### Fixed
+- Avoid fixing dependencies to a specific version.
+- Expiry is now properly computed for access token.
+- It is not possible to provide an empty OKTA authorization_server anymore.
+
+### Changed
+- OKTA default value for authorization_server is now default.
+
+## [4.0.1] - 2018-12-16
+### Changed
 - Update requests dependency to the latest version.
-- Update the packaging to render Markdown on pypi.
 
-## 4.0.0 (2018-12-16) ##
-
-### Release notes ###
+### Fixed
+- Update the packaging to render Markdown on pypi.
 
+## [4.0.0] - 2018-12-16
+### Changed
 - str representation of authentication classes are not prefixed by "authentication." anymore.
 - [OAuth2] Implicit flow is now expecting token in access_token field by default (or id_token if response_type is id_token). This can be overridden thanks to new token_field_name parameter. Previous behavior was to expect a token named the same way than response_type (or token)
 - [OAuth2] Authorization code flow provides a new code_field_name parameter to know in what field code should be expected. Default value is code. Previous behavior was to expect a code named the same way than response_type (or code)
 - [Azure AD] Implicit class now provides Access Token by default. Use new IdToken class to request OpenID Connect ID Token.
 - [Okta] Implicit class now provides Access Token by default. Use new IdToken class to request OpenID Connect ID Token.
 
-### Bug fixes ###
-
+### Fixed
 - [OAuth2] Implicit flow is now ensuring that response_type is set in query. Default value is token.
 - [OAuth2] Authorization code flow is now ensuring that response_type is set in query. Default value is token.
 - [Azure AD] Allow to override response_type.
 - [Azure AD] Allow to override expected token name.
 - [Okta] Allow to override expected token name.
 
-## 3.0.0 (2018-11-13) ##
-
-### Release notes ###
-
+## [3.0.0] - 2018-11-13
+### Changed
 - All previously existing OAuth2 related classes renamed to state that it corresponds to implicit flow.
 - [Okta] scopes parameter merged with scope.
 
-### Bug fixes ###
-
+### Fixed
 - Update requests dependency to latest version (2.20.1)
 - [OAuth2] Remove unused redirect_uri_port_availability_timeout parameter
 
-## 2.0.0 (2018-10-09) ##
-
-### Release notes ###
-
+## [2.0.0] - 2018-10-09
+### Changed
 - OAuth2 token is now provided by default in Authorization header.
 - Auths does not take a list anymore but a var args instead.
 - MicrosoftOAuth2 renamed into AzureActiveDirectory.
 - Nonce is not a mandatory parameter anymore for MicrosoftOAuth2.
 
-### Enhancements ###
-
+### Added
 - Authentication classes can now be imported from requests_auth.
 - JSONTokenFileCache can now be imported from requests_auth.
 - Okta authentication is now available (thanks to Sebastien De Menten).
 
-### Bug fixes ###
-
+### Fixed
 - Oauth2 authentication was not working with Python 2.7
 - Update requests to 2.19.1 (latest version)
 - OAuth2 authentication now supports GET on token reception (thanks to Sebastien De Menten).
 - Extra parameters were not handled when using MicrosoftOAuth2 (now AzureActiveDirectory)
 
-## 1.0.2 (2018-01-19) ##
-
-### Release notes ###
+## [1.0.2] - 2018-01-19
 
+### Added
 - Public release
+
+[Unreleased]: https://github.com/Colin-b/requests_auth/compare/v4.1.0...HEAD
+[4.1.0]: https://github.com/Colin-b/requests_auth/compare/v4.0.1...v4.1.0
+[4.0.1]: https://github.com/Colin-b/requests_auth/compare/v4.0.0...v4.0.1
+[4.0.0]: https://github.com/Colin-b/requests_auth/compare/v3.0.0...v4.0.0
+[3.0.0]: https://github.com/Colin-b/requests_auth/compare/v2.0.0...v3.0.0
+[2.0.0]: https://github.com/Colin-b/requests_auth/compare/v1.0.2...v2.0.0
+[1.0.2]: https://github.com/Colin-b/requests_auth/releases/tag/v1.0.2

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# How to contribute
+
+Everyone is free to contribute on this project.
+
+There are two ways to contribute:
+
+- Submit an issue.
+- Submit a pull request.
+
+## Submitting an issue
+
+Before creating an issue please make sure that it was not already reported.
+
+### When?
+
+- You encountered an issue.
+- You have a change proposal.
+- You have a feature request.
+
+### How?
+
+1) Go to the *Issues* tab and click on the *New issue* button.
+2) Title should be a small sentence describing the request.
+3) The comment should contains as much information as possible
+    * Actual behavior (including the version you used)
+    * Expected behavior
+    * Steps to reproduce
+
+## Submitting a pull request
+
+### When?
+
+- You fixed an issue.
+- You changed something.
+- You added a new feature.
+
+### How?
+
+#### Code
+
+1) Create a new branch based on *develop* branch.
+2) Add your changes.
+3) Follow [Black](https://black.readthedocs.io/en/stable/) code formatting.
+    * Install pre-commit python module using pip: **python -m pip install pre-commit**
+    * To add the pre-commit hook, after the installation run: **pre-commit install**
+4) Add at least one test case.
+    * Unless it is an internal refactoring request or a documentation update.
+5) Increment [version number](https://semver.org) and add related [changelog entry](https://keepachangelog.com/en/1.0.0/).
+    * Unless it is a documentation update.
+
+##### Changelog entry
+
+Once the changelog entry is added, please don't forget to also add the link to the proper tag at the end of the changelog.
+
+#### Enter pull request
+
+1) Go to the *Pull requests* tab and click on the *New pull request* button.
+2) *base* should always be set to development and it should be compared to your branch.
+3) Title should be a small sentence describing the request.
+3) The comment should contains as much information as possible
+    * Actual behavior (before the new code)
+    * Expected behavior (with the new code)
+    * Steps to reproduce (with and without the new code to see the difference)