[ BB2-1152 ] Updates from utilizing the SDK in the sample app (#7)

* Improve packaging per sample app testing

* Fix bug with callback in auth url

* Update README.md

* Add get/set methods to AuthorizationToken class

- Add `get_dict()` to `AuthorizationToken` class for SDK user to
  get auth token config dictionary in a format that is nice from
  them to store. expires_at is in an ISO date/time string format.
- Add `set_dict()` to `AuthorizationToken` class for SDK user to
  be able to configurate a class instance with their stored
  configuration values.
- Add related tests to `test_auth.py`.

BB2-1152

* Fix call to refresh_auth_token() method

* Fix url issue if version is integer

Author: dtisza1

MANIFEST.in

@@ -1 +1,11 @@
-recursive-include src *.py
+recursive-include . *.py
+
+include *.json
+recursive-include cms_bluebutton *.json
+recursive-include cms_bluebutton *.yaml
+
+exclude .bluebutton-config.json
+
+include .flake8
+exclude requirements/*
+

README.md

@@ -26,31 +26,20 @@ Introduction goes here!
   $ source bb2_env/bin/activate
   # Perform install and commands after sourcing the venv.
   ```
-
-## Build
-
-To build the cms_bluebutton package do the following:
-
-- Build the package:
-
-  ```
-  # From repository root directory:
-  $ python setup.py bdist_wheel
-  ```
-
 ## Installation
 
-To install the package locally do the following:
+To install the package file do the following:
 
 ```
 # From repository root directory:
-$ pip install -e .
+$ pip install <package file name>
 ```
 
 ## Usage
 
 Usage goes here!
 
+
 ## Developing the Blue Button 2.0 SDK (for BB2 team SDK developers)
 
 ### Install Development
@@ -63,12 +52,14 @@ From the repository base directory:
 $ pip install -e .[dev]
 ```
 
+### Running tests
+
 To run the tests, use the following commands:
 
 From the package base directory:
 
 ```
-$ cd src/cms_bluebutton
+$ cd cms_bluebutton
 
 $ # To run all tests:
 $ pytest
@@ -88,26 +79,59 @@ $ coverage run -m pytest
 $ coverage report -m
 ```
 
-### Create Distribution
+## Packaging and Publishing
 
-To create a distribution run the following command:
 
-From the repository base directory:
+### Create or Update Manifest
+
+If check-manifest is not yet installed run the following:
 
 ```
-$ python setup.py sdist
+$ pip install check-manifest  # If not already installed.
 ```
 
-The resulting distribution files with be created in the `sdist/` directory.
+If MANIFEST.in does not yet exist, run the following to create it:
 
-### Create Manifest
-
-Note that the previous distribution did not include the license.txt or test files. This requires creating a manifest.
+```
+$ check-manifest --create
+```
 
-To create a MANIFEST.in file run the following commands:
+To help with updating MANIFEST.in run the following to get information:
 
 ```
-$ pip install check-manifest  # If not already installed.
-$ check-manifest --create
-$ python setup.py sdist
-```
+$ check-manifest
+# This creates the following directory: cms_bluebutton.egg-info
+```
+
+### Build Packages
+
+To build the cms_bluebutton packages do the following:
+
+- Build a wheel distribution package (.whl):
+
+  ```
+  # From repository root directory:
+  $ rm -rf build/
+  $ python setup.py bdist_wheel
+  ```
+
+- Build a distribution package (.tar.gz):
+
+  ```
+  # From repository root directory:
+  $ rm -rf build/
+  $ python setup.py sdist
+  ```
+
+- Build a source package:
+
+  ```
+  # From repository root directory:
+  $ rm -rf build/
+  $ python setup.py sdist
+  ```
+
+The resulting distribution files with be created in the `dist/` directory.
+
+
+### Publishing

src/cms_bluebutton/__init__.py cms_bluebutton/__init__.pysrc/cms_bluebutton/__init__.py renamed to cms_bluebutton/__init__.py

@@ -11,23 +11,45 @@
 
 
 class AuthorizationToken:
-    def __init__(self, auth_token):
-        self.access_token = auth_token.get("access_token")
-        self.expires_in = auth_token.get("expires_in")
-        self.expires_at = (
-            auth_token.get("expires_at")
-            if auth_token.get("expires_at")
-            else datetime.datetime.now(datetime.timezone.utc)
-            + datetime.timedelta(seconds=self.expires_in)
-        )
-        self.patient = auth_token.get("patient")
-        self.refresh_token = auth_token.get("refresh_token")
-        self.scope = auth_token.get("scope")
-        self.token_type = auth_token.get("token_type")
+    def __init__(self, auth_token_dict):
+        self.set_dict(auth_token_dict)
 
     def access_token_expired(self):
         return self.expires_at < datetime.datetime.now(datetime.timezone.utc)
 
+    def get_dict(self):
+        return {
+            "access_token": self.access_token,
+            "expires_in": self.expires_in,
+            "expires_at": self.expires_at.astimezone(datetime.timezone.utc)
+            .replace(microsecond=0)
+            .isoformat(),
+            "patient": self.patient,
+            "refresh_token": self.refresh_token,
+            "scope": self.scope,
+            "token_type": self.token_type,
+        }
+
+    def set_dict(self, auth_token_dict):
+        self.access_token = auth_token_dict.get("access_token")
+        self.expires_in = auth_token_dict.get("expires_in")
+
+        if auth_token_dict.get("expires_at"):
+            if type(auth_token_dict.get("expires_at")) == datetime.datetime:
+                self.expires_at = auth_token_dict.get("expires_at")
+            else:
+                self.expires_at = datetime.datetime.fromisoformat(
+                    auth_token_dict.get("expires_at")
+                ).astimezone(datetime.timezone.utc)
+        else:
+            self.expires_at = datetime.datetime.now(datetime.timezone.utc)
+            +datetime.timedelta(seconds=self.expires_in)
+
+        self.patient = auth_token_dict.get("patient")
+        self.refresh_token = auth_token_dict.get("refresh_token")
+        self.scope = auth_token_dict.get("scope")
+        self.token_type = auth_token_dict.get("token_type")
+
 
 def refresh_auth_token(bb, auth_token):
     data = {
@@ -54,7 +76,7 @@ def refresh_auth_token(bb, auth_token):
 def generate_authorize_url(bb, auth_data):
     params = {
         "client_id": bb.client_id,
-        "redirect_uri": bb.client_secret,
+        "redirect_uri": bb.callback_url,
         "state": auth_data["state"],
         "response_type": "code",
         "code_challenge_method": "S256",

src/cms_bluebutton/auth.py cms_bluebutton/auth.pysrc/cms_bluebutton/auth.py renamed to cms_bluebutton/auth.py

@@ -14,7 +14,7 @@ def fhir_request(bb, config):
     retry_config = Retry(
         total=3, backoff_factor=5, status_forcelist=[500, 502, 503, 504]
     )
-    full_url = bb.base_url + "/v" + bb.version + "/" + config["url"]
+    full_url = "{}/v{}/{}".format(bb.base_url, bb.version, config["url"])
     headers = {
         "Authorization": "Bearer " + auth_token.access_token,
         SDK_HEADER_KEY: SDK_HEADER,
@@ -30,6 +30,6 @@ def fhir_request(bb, config):
 
 def handle_expired(bb, auth_token):
     if auth_token.access_token_expired():
-        return bb.refresh_auth_token(bb, auth_token)
+        return bb.refresh_auth_token(auth_token)
     else:
         return None

src/cms_bluebutton/cms_bluebutton.py cms_bluebutton/cms_bluebutton.pysrc/cms_bluebutton/cms_bluebutton.py renamed to cms_bluebutton/cms_bluebutton.py

@@ -1,8 +1,9 @@
+import datetime
 import pytest
 import requests_mock
 from urllib.parse import urlparse, parse_qs
 
-from cms_bluebutton import BlueButton
+from cms_bluebutton import BlueButton, AuthorizationToken
 from .fixtures.token_response import TOKEN_RESPONSE, REFRESH_TOKEN_RESPONSE
 
 
@@ -36,7 +37,10 @@ def test_auth_url_v1():
     assert parsed_url.path == "/v1/o/authorize"
     qps = parse_qs(parsed_url.query)
     assert bb.client_id in qps["client_id"]
+    assert bb.callback_url in qps["redirect_uri"]
+    assert "code" in qps["response_type"]
     assert auth_data["state"] in qps["state"]
+    assert "S256" in qps["code_challenge_method"]
     assert auth_data["code_challenge"] in qps["code_challenge"]
 
 
@@ -100,6 +104,28 @@ def test_get_authorization_token_callback():
         assert auth_token.expires_in == TOKEN_RESPONSE.get("expires_in")
         assert not auth_token.access_token_expired()
 
+        # Test .get_dict() method
+        token_dict = auth_token.get_dict()
+
+        # Test .set_dict() method where auth_token2 should be the same
+        auth_token2 = AuthorizationToken(token_dict)
+        auth_token2.set_dict(token_dict)
+
+        assert auth_token2 is not None
+        assert auth_token2.access_token == TOKEN_RESPONSE.get("access_token")
+        assert auth_token2.refresh_token == TOKEN_RESPONSE.get("refresh_token")
+        assert auth_token2.patient == TOKEN_RESPONSE.get("patient")
+        assert auth_token2.expires_in == TOKEN_RESPONSE.get("expires_in")
+        assert not auth_token2.access_token_expired()
+
+        # Test expired token
+        token_dict = auth_token.get_dict()
+        token_dict["expires_at"] = datetime.datetime.now(
+            datetime.timezone.utc
+        ) - datetime.timedelta(seconds=10)
+        auth_token2.set_dict(token_dict)
+        assert auth_token2.access_token_expired() is True
+
 
 def test_refresh_access_token_without_refreshtoken():
     bb = BlueButton(BB2_CONFIG_V1)