BearerAuth Bearer Authentication Handler

[bmos]

What is this change?

• Requests authentication handlers can be a useful way to handle common authorization solutions, and we have multiple connectors that all use header-based authentication tokens. Many with the exact same "Authorization": "Bearer API_KEY" format.

• Add generic authentication handler for requests to support header-based token authentication without manually editing headers. Example:

  import requests
  from parsons.utilities.bearer_auth import BearerAuth
  
  auth = BearerAuth("YOUR API KEY HERE")
  res = requests.get("https://api.example.com/", auth=auth)
  
  print(res.request.headers["Authorization"])  # Output is "Bearer YOUR API KEY HERE"

• Update existing connectors that use header-based token authentication to use this requests-native approach.

Considerations for discussion

• Are we happy with the name BearerAuth or should it be something else since not all implementations use "Bearer" as the token name?

How to test the changes (if needed)

• CI tests should be adequate

Breaking Changes

Breaking changes are changes to our public API which may require existing users to change their code. If there are no breaking changes, any existing parsons user should not need to do anything after updating their parsons version.

Does this PR introduce breaking changes?

• label: Breaking change — This PR introduces one or more breaking changes.
• label: Non-breaking change — This PR does not introduce one or more breaking changes.

Details (if needed)

• All class properties that aren't used anymore have been marked as deprecated, with their functionality preserved.
• The only edge-case where a breaking change could be interpreted to have occurred would be if a user was manually extracting the api key/token from where it was previously hard-coded into a headers dictionary, although I would not say this is a part of our public API.

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
parsons/actblue
actblue.py
parsons/action_builder
action_builder.py
parsons/action_kit
action_kit.py
parsons/action_network
action_network.py
parsons/airmeet
airmeet.py
parsons/auth0
auth0.py					81, 138-139, 141, 162, 194
parsons/bloomerang
bloomerang.py					62
parsons/community
community.py					50
parsons/empower
empower.py
parsons/formstack
formstack.py					36
parsons/freshdesk
freshdesk.py
parsons/github
github.py
parsons/hustle
hustle.py					53, 75-76, 95, 110-114
parsons/mobilecommons
mobilecommons.py					50
parsons/mobilize_america
ma.py					45
parsons/nation_builder
nation_builder.py
parsons/pdi
pdi.py					73, 78, 111-115, 126-132
parsons/quickbase
quickbase.py
parsons/quickbooks
quickbookstime.py					40
parsons/redash
redash.py
parsons/shopify
shopify.py					54, 56
parsons/sisense
sisense.py
parsons/targetsmart
targetsmart_api.py
parsons/turbovote
turbovote.py
parsons/utilities
bearer_auth.py
Project Total

The report is truncated to 25 files out of 29. To see the full report, please visit the workflow summary page.

This report was generated by python-coverage-comment-action