[ BB2-1119 ] Settings configuration via JSON or YAML files (#4)

* Create SDK JSON configuration file functionality

- Create `Bb2` class methods for reading settings
  from JSON configuration files in `src/bb2.py`.

- Create `src/tests/test_configs.py` with
  configuration and JSON related file tests.

- Create JSON test files to be used in tests
  under `src/tests/test_configs/json/`.

- Create JSON sample configuration for SDK
  user in `bluebutton-sample-config.json`.

- Add SDK user config files to `.gitignore`

BB2-1119

* Add YAML format configuration file functionality

- Add `.yaml` file extension support to `Bb2` class methods in `src/bb2.py`.

- Add tests for YAML configuration files in `src/tests/test_configs.py`.

- Create YAML test files to be used in tests under `src/tests/test_configs/yaml/`.

- Create YAML sample configuration for SDK user in `bluebutton-sample-config.yaml`.

BB2-1119

* Update config and tests per PR review

* Rename Bb2 to BlueButton class

* Remove sample config file to be in readme later

Author: dtisza1

.gitignore

@@ -162,3 +162,7 @@ bb2_env/
 #.idea/
 
 # End of https://www.toptal.com/developers/gitignore/api/python
+#
+# BB2 ignores
+.bluebutton-config.json
+.bluebutton-config.yaml

README.md

@@ -112,3 +112,4 @@ $ pip install check-manifest  # If not already installed.
 $ check-manifest --create
 $ python setup.py sdist
 ```
+

bluebutton-sample-config.json

@@ -0,0 +1,7 @@
+{
+    "environment": "SANDBOX",
+    "client_id": "<your BB2 client_id here>",
+    "client_secret": "<your BB2 client_secret here.>",
+    "callback_url": "https://www.fake.com/your/callback/here",
+    "version": 2
+}

setup.py

@@ -25,7 +25,7 @@
         "Topic :: Software Development",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    py_modules=["bb2"],
+    py_modules=["blueButton"],
     package_dir={"": "src"},
     python_requires=">=3.6",
     install_requires=[

src/bb2.py

@@ -0,0 +1,85 @@
+"""
+Blue Button 2.0 SDK Class
+
+"""
+import json
+import os
+import pathlib
+import yaml
+
+ROOT_DIR = os.path.abspath(os.curdir) + "/"
+DEFAULT_CONFIG_FILE_LOCATION = ROOT_DIR + "./.bluebutton-config.json"
+
+ENVIRONMENT_URLS = {
+    "SANDBOX": "https://sandbox.bluebutton.cms.gov",
+    "PRODUCTION": "https://api.bluebutton.cms.gov",
+}
+
+
+class BlueButton:
+    name = "bb2"
+    verbose_name = "Blue Button 2.0 SDK Package"
+
+    def __init__(self, config=DEFAULT_CONFIG_FILE_LOCATION):
+        self.client_id = None
+        self.client_secret = None
+        self.callback_url = None
+        self.version = 2  # Default to BB2 version 2
+
+        self.base_url = None
+
+        self.set_configuration(config)
+
+    def _read_json(self, file_path):
+        with open(file_path, "r") as f:
+            data = json.load(f)
+            return data
+
+    def _read_yaml(self, file_path):
+        with open(file_path, "r") as f:
+            return yaml.safe_load(f)
+
+    def _read_config(self, config):
+        extension = pathlib.Path(config).suffix
+
+        if extension == ".json":
+            return self._read_json(config)
+        elif extension == ".yaml":
+            return self._read_yaml(config)
+        else:
+            raise ValueError(
+                "Error: Configuration file extension must be .json"
+                " or .yaml for: {}".format(config)
+            )
+
+    def set_configuration(self, config):
+        # Is config param a file path or dict?
+        if isinstance(config, str):
+            config_dict = self._read_config(config)
+        else:
+            config_dict = config
+
+        # Check environment setting
+        env = config_dict.get("environment", None)
+        if env in ["SANDBOX", "PRODUCTION"]:
+            self.base_url = ENVIRONMENT_URLS.get(env, None)
+        else:
+            raise ValueError(
+                "Error: Configuration environment must be set to"
+                " SANDBOX or PRODUCTION in: {}".format(config)
+            )
+
+        # Check other settings are provided
+        for s in ["client_id", "client_secret", "callback_url"]:
+            setting = config_dict.get(s, None)
+            if setting is None:
+                raise ValueError(
+                    'Error: Configuration setting "'
+                    + s
+                    + '" is missing in: {}'.format(config)
+                )
+
+        self.client_id = config_dict.get("client_id")
+        self.client_secret = config_dict.get("client_secret")
+        self.callback_url = config_dict.get("callback_url")
+        self.version = config_dict.get("version", 2)

src/bluebutton.py

@@ -0,0 +1,97 @@
+import pytest
+
+from bluebutton import BlueButton
+
+
+CONFIGS_DIR = "src/tests/test_configs/"
+
+
+def test_invalid_file_extension():
+    # Test extension not matching .json or .yaml
+    with pytest.raises(
+        ValueError,
+        match=r"Error: Configuration file extension"
+              " must be .json or .yaml for:.*",
+    ):
+        BlueButton(config="file.xxx")
+
+
+def test_read_config_json_equals_yaml():
+    bb = BlueButton(config=CONFIGS_DIR +
+             "json/bluebutton-sample-config-valid-sbx.json")
+
+    # Test dict's are equal for both JSON & YAML
+    assert bb._read_config(
+        config=CONFIGS_DIR + "json/bluebutton-sample-config-valid-sbx.json"
+    ) == bb._read_config(
+        config=CONFIGS_DIR + "yaml/bluebutton-sample-config-valid-sbx.yaml"
+    )
+
+
+def test_valid_config():
+    # valid config sbx
+    bb = BlueButton(config=CONFIGS_DIR +
+             "json/bluebutton-sample-config-valid-sbx.json")
+    assert bb.base_url == "https://sandbox.bluebutton.cms.gov"
+    assert bb.client_id == "<your BB2 client_id here>"
+    assert bb.client_secret == "<your BB2 client_secret here>"
+    assert bb.callback_url == "https://www.fake-sandbox.com/your/callback/here"
+    assert bb.version == 1
+
+    # valid config prod
+    bb = BlueButton(config=CONFIGS_DIR +
+             "json/bluebutton-sample-config-valid-prod.json")
+    assert bb.base_url == "https://api.bluebutton.cms.gov"
+    assert bb.client_id == "<your BB2 client_id here>"
+    assert bb.client_secret == "<your BB2 client_secret here>"
+    assert bb.callback_url == "https://www.fake-prod.com/your/callback/here"
+    assert bb.version == 1
+
+    # valid config from a dictionary
+    config_dict = {
+        "environment": "PRODUCTION",
+        "client_id": "<your BB2 client_id here>",
+        "client_secret": "<your BB2 client_secret here>",
+        "callback_url": "https://www.fake-prod.com/your/callback/here",
+        "version": 1,
+    }
+    bb = BlueButton(config_dict)
+    assert bb.base_url == "https://api.bluebutton.cms.gov"
+    assert bb.client_id == "<your BB2 client_id here>"
+    assert bb.client_secret == "<your BB2 client_secret here>"
+    assert bb.callback_url == "https://www.fake-prod.com/your/callback/here"
+    assert bb.version == 1
+
+
+def test_config_setting_environment():
+    for file_name in [
+        "json/bluebutton-sample-config-environment-missing.json",
+        "json/bluebutton-sample-config-environment-wrong.json",
+    ]:
+        with pytest.raises(
+            ValueError,
+            match=r"Error: Configuration environment must"
+            " be set to SANDBOX or PRODUCTION in:.*",
+        ):
+            BlueButton(config=CONFIGS_DIR + file_name)
+
+
+def test_config_setting_missing():
+    for setting, file_name in [
+        ["client_id", "json/bluebutton-sample-config-missing-id.json"],
+        ["client_secret", "json/bluebutton-sample-config-missing-secret.json"],
+        ["callback_url",
+         "json/bluebutton-sample-config-missing-callback.json"],
+    ]:
+        with pytest.raises(
+            ValueError,
+            match=r"Error: Configuration setting \"{}\""
+            " is missing in:.*".format(setting),
+        ):
+            BlueButton(config=CONFIGS_DIR + file_name)
+
+
+def test_config_version_missing_defaults_to_v2():
+    bb = BlueButton(config=CONFIGS_DIR +
+             "json/bluebutton-sample-config-missing-version.json")
+    assert bb.version == 2

src/test_bb2.py

@@ -0,0 +1,6 @@
+{
+    "client_id": "<your BB2 client_id here>",
+    "client_secret": "<your BB2 client_secret here>",
+    "callback_url": "https://www.fake-sandbox.com/your/callback/here",
+    "version": 1
+}

src/tests/test_configs.py

@@ -0,0 +1,7 @@
+{
+    "environment": "WRONG",
+    "client_id": "<your BB2 client_id here>",
+    "client_secret": "<your BB2 client_secret here>",
+    "callback_url": "https://www.fake-sandbox.com/your/callback/here",
+    "version": 1
+}