Merge pull request #11 from CMSgov/ajshred/BB2-1322-headers-include-version-number

[BB2-1322] Added version number to headers.

Author: ajshred

.gitignore

@@ -159,7 +159,9 @@ bb2_env/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#  NOTE:  Using this option is fine in this case as we don't use other JetBrains tools in
+#  this codebase.
+.idea/
 
 # End of https://www.toptal.com/developers/gitignore/api/python
 #

cms_bluebutton/auth.py

@@ -7,7 +7,7 @@
 import urllib
 from requests_toolbelt.multipart.encoder import MultipartEncoder
 
-from .constants import SDK_HEADER, SDK_HEADER_KEY
+from .constants import SDK_HEADERS
 
 
 class AuthorizationToken:
@@ -58,9 +58,7 @@ def refresh_auth_token(bb, auth_token):
         "refresh_token": auth_token.refresh_token,
     }
 
-    headers = {
-        SDK_HEADER_KEY: SDK_HEADER,
-    }
+    headers = SDK_HEADERS
 
     token_response = requests.post(
         url=bb.auth_token_url,
@@ -132,10 +130,12 @@ def get_access_token_from_code(bb, auth_data, callback_code):
     }
 
     mp_encoder = MultipartEncoder(data)
+    headers = SDK_HEADERS
+    headers["content-type"] = mp_encoder.content_type
     token_response = requests.post(
         url=bb.auth_token_url,
         data=mp_encoder,
-        headers={"content-type": mp_encoder.content_type, SDK_HEADER_KEY: SDK_HEADER},
+        headers=headers
     )
     token_response.raise_for_status()
     token_dict = token_response.json()

cms_bluebutton/constants.py

@@ -1,5 +1,9 @@
-SDK_HEADER = "python"
-SDK_HEADER_KEY = "X-BLUEBUTTON-SDK"
+SDK_VERSION = "0.1.0"
+
+SDK_HEADERS = {
+    "X-BLUEBUTTON-SDK": "python",
+    "X-BLUEBUTTON-SDK-VERSION": SDK_VERSION
+}
 
 REFRESH_TOKEN_ENDPOINT = "/o/token/"
 

cms_bluebutton/fhir_request.py

@@ -1,7 +1,7 @@
 import requests
 from requests.adapters import HTTPAdapter, Retry
 
-from .constants import SDK_HEADER, SDK_HEADER_KEY
+from .constants import SDK_HEADERS
 
 
 def fhir_request(bb, config):
@@ -15,10 +15,8 @@ def fhir_request(bb, config):
         total=3, backoff_factor=5, status_forcelist=[500, 502, 503, 504]
     )
     full_url = "{}/v{}/{}".format(bb.base_url, bb.version, config["url"])
-    headers = {
-        "Authorization": "Bearer " + auth_token.access_token,
-        SDK_HEADER_KEY: SDK_HEADER,
-    }
+    headers = SDK_HEADERS
+    headers["Authorization"] = "Bearer " + auth_token.access_token
     adapter = HTTPAdapter(max_retries=retry_config)
     sesh = requests.Session()
     sesh.mount("https://", adapter)