flask-dance

• Added ORCID and ORCID sandbox provider

• Switched from setuptools to flit_ for packaging

• Switched from setup.cfg to pyproject.toml

• Added an "install_required" marker to the tests that require this project to be installed before the tests can pass. To run all tests _except_ those, run pytest -m "not install_required".

• Switched from deprecated flask._app_ctx_stack to storing app state on flask.g instead. This should support Flask 2.3.0.

• Added OpenStreetMap (OSM) provider

• Added support for Flask 2.1 and Werkzeug 2.1
• Minimum supported version of Flask is now 2.0.3
• Codebase is now linted using isort

• Added Fitbit pre-set configuration

This release adds support for Flask 2.0, and drops support for versions of Flask below 1.0.4.

This release drops support for Python 2.7! It also adds support for SQLAlchemy 1.4.

• Added hostname option to the make_salesforce_blueprint

• Added is_sandbox option to the make_salesforce_blueprint

• Changed base url for make_salesforce_blueprint

• Added Atlassian pre-set configuration

• Added Salesforce pre-set configuration

• Added offline option to make_dropbox_blueprint

• Added prompt option to make_discord_blueprint

• Added subdomain option to make_slack_blueprint

Added Digital Ocean pre-set configuration

• Updated Discord to use the new discord.com instead of the old discordapp.com

• Add Strava pre-set configuration

• Updated Meetup and Nylas pre-set configurations to include the client_id in the OAuth token request.

• Removed Okta pre-set configuration, since it doesn't add any value over using OAuth2ConsumerBlueprint directly.

• Updated Azure to allow defining authorization_url_params

• Added Heroku pre-set configuration

• Flask-Dance now provides a betamax_record_flask_dance testing fixture, for recording and replaying HTTP requests using Betamax_. See the testing documentation for more information.

• Added LinkedIn pre-set configuration

Changed (backwards incompatible)

• The backwards-compatible references to "backend" have been removed. Use "storage" instead.

• The columns defined in OAuthConsumerMixin now set nullable=False. If you are using the SQLAlchemy storage and are upgrading from a previous version of Flask-Dance, you may want to do a database migration.

• Previously, Flask-Dance had an undocumented feature where it would automatically redirect based on a next parameter in the URL. This undocumented feature has been removed.

• All pre-set configurations now use a consistent naming scheme for pulling client IDs and client secrets from the app config. The following configurations have changed: Dropbox, Meetup, Twitter, and Zoho.

• Replace lazy dependency with werkzeug.utils.cached_property

Changed

• "Backends" are now called "Storages", since the word "backend" means something different in the context of web development. This release is fully backwards-compatible, but deprecation warnings have been added anywhere that you import and use a backend (rather than a storage).

Added

• Add oauth_before_login signal

• Add reprompt_select_account parameter to google blueprint

Added

• Add authorization_required decorator

• Added Authentiq pre-set configuration

Added

• Added rerequest_declined_permissions argument to facebook blueprint

• Added Reddit pre-set configuration

Added

• Added tenant argument to make_azure_blueprint

• Added hosted_domain argument to make_google_blueprint

• Added Okta pre-set configuration

• Added Zoho pre-set configuration

Fixed

• Updated Azure AD default scopes. See `issue 149`_.

• Only set auto_refresh_url in make_google_blueprint if a token of type offline is requested. See issues `#143`_, `#144`_ and `#161`_ for background.

• Flask-Cache is deprecated. Switch to Flask-Caching.

• When using the OAuth 1 blueprint with the SQLAlchemy backend and the user_required argument set to True, the backend was trying to load tokens before any were set, causing an exception in the backend. Now, the backend will not attempt to load tokens until the OAuth dance is complete.

• Added exception handler around parse_authorization_response in OAuth1

• Accessing the access_token property on an instance of the OAuth2Session class will now query the token backend, instead of checking the client on the instance.

• Pre-set configuration for GitLab provider

• sphinxcontrib-napoleon is no longer required to build the Flask-Dance documentation.

• Added Spotify pre-set configuration

• Added Discord pre-set configuration

• Added an optional user_required argument to the SQLAlchemy backend. When this is enabled, trying to set an OAuth object without an associated user will raise an error.

• Updated the Dropbox configuration to use the v2 authentication URLs
• Added the "require_role" authentication parameter for Dropbox
• Documented all authentication parameters for Dropbox

• Changed Nylas configuration to refer to "client_id" and "client_secret" rather than "api_id" and "api_secret".

Added Nylas configuration.

• Fixed make_google_blueprint to include auto_refresh_url so that token renewal is automatically handled by requests-oauthlib

• Added the Azure AD pre-set configuration

• Improve OAuth 2 token auto-refresh

• Allowed an oauth_authorized event handler to return a flask.Response instance. If so, that response will be sent to the requesting user.

• Fixed an error that occurred if you were running an unreleased version of Flask, due to the version comparison code. See `issue 53`_. Thanks, @ThiefMaster!

• If the OAuth 1 token request is denied on accessing the login view, Flask-Dance will now redirect the user and fire the oauth_error signal. This matches the behavior of how Flask-Dance handles OAuth 2 errors.

• Fixed a typo in the Slack configuration, where it would load the OAuth 2 client secret from a config variable named "SLLACK_OAUTH_CLIENT_SECRET" instead of "SLACK_OAUTH_CLIENT_SECRET"

• Added the Slack pre-set configuration

• Fixed a subtle bug where setting the client_id property on an instance of OAuth2ConsumerBlueprint did not update the value that the oauthlib library uses to create the redirect URL in the login step. client_id is now a dynamic property on OAuth2ConsumerBlueprint, which sets the client_id property on the wrapped oauthlib client automatically.

• Added some debug log statements to OAuth2ConsumerBlueprint

• You can now define a session_created method on subclasses of OAuth2ConsumerBlueprint. If you do, it will be called when a Requests session is dynamically created, so that the session can be modified before it is returned.

• Removed the Dictective utility class, and replaced it with werkzeug.datastructures.CallbackDict. It does the same thing, but it's better tested, and already a part of one of Flask-Dance's dependencies.

• If the user hits the authorized view without having a "state" variable set in the browser cookies, Flask-Dance will now redirect the user back to the login view to start the OAuth dance all over again, rather than raising a KeyError.

• Flask-Dance no longer checks for the existence of a X-Forwarded-Proto header to determine if generated URLs should use a https:// scheme. If you are running your application behind a TLS termination proxy, use Werkzeug's ProxyFix middleware to inform Flask of that.

Added Facebook, Dropbox, and Meetup

Bugfix to make authorized property on OAuth1Session and OAuth2Session dynamically load tokens from the backend.

• Redesigned token storage backend system: it now uses objects

Warning

This release is not backwards-compatible, due to the changes to how backends work. If you are using the SQLAlchemy backend, read the documentation to see how it works now!

• Added documentation about OAuth protocol

• Added quickstarts for Google, and for a multi-user SQLAlchemy system

• Added reprompt_consent parameter to Google pre-set configuration

• Added oauth_error signal

• If there is an error with the OAuth 2 authorization process, Flask-Dance will now redirect the user anyway rather than letting the error bubble up and cause a 500 status code. The oauth_error signal will be fired with information about the error.

• OAuth2ConsumerBlueprint now accepts two new arguments to its constructor: authorization_url_params and token_url_params

• When using the Google pre-set configuration, you can now request offline access for your OAuth token by passing offline=True to the make_google_blueprint function

• Added anon_user argument to set_token_storage_sqlalchemy() method

• Fire oauth_authorized signal before setting token, so that a signal handler can set the logged-in user

• You can now indicate that an OAuth token should not be stored by returning False from any receiver function that is connected to the oauth_authorized signal

• OAuth1SessionWithBaseURL has been renamed to OAuth1Session. The old name still exists as an alias, for backwards compatibility.

• OAuth2SessionWithBaseURL has been renamed to OAuth2Session. The old name still exists as an alias, for backwards compatibility.

• You can now pass a user or user_id object to blueprint.load_token.

• OAuth1Session and OAuth2Session now store a reference to the blueprint, so that you can also call session.load_token, which is proxied to the blueprint. This method also takes user or user_id arguments.

• Renamed assign_token_to_session to load_token

• Added a from_config dict to OAuthConsumerBlueprint objects. The info in that dict is used to dynamically populate information on the blueprint at runtime from the configuration of the app that the blueprint is bound to. Also set up sensible configuration variable names for the pre-set configurations.

• If neither redirect_url nor redirect_to are specified, default to redirecting the user to the root of the website (/). Previously, specifying one of these two options was required.

• Added a the Google pre-set configuration.

• Added a new session_class parameter, so that you can specify a custom requests.Session subclass with custom behavior.

• Changed OAuthConsumerMixin.created_on to OAuthConsumerMixin.created_at, to reflect the fact that it is a DateTime, not a Date. If you are upgrading from an older version of Flask-Dance and using OAuthConsumerMixin, this will require a database migration.

• Renamed OAuthMixin to OAuthConsumerMixin

• Changed event sender from app to blueprint, to match docs

• Fixed packaging problems

• Added SQLAlchemy support

• Added Sphinx-based documentation

• Added support for Flask-Login and Flask-Cache

• Switch from login_callback decorator to blinker signals

• Initial release