CP-9044/api-key-as-environment-variable (#6)

ericvautour-quandl · web-flow · commit 3478b48ec23c · 2021-12-07T12:04:54.000-05:00
* CP-9044/api-key-as-environment-variable: Checking for environment variable before files
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@
 .idea/*
 venv
 /.DS_Store
+/test/.nasdaq-config
diff --git a/README.md b/README.md
@@ -36,6 +36,10 @@ By default, SSL verification is enabled. To bypass SSL verification
 nasdaqdatalink.ApiConfig.verify_ssl = False
 ```
 
+### Local API Key Environment Variable
+
+If you wish to store your API as an environment variable, you can do so by setting `NASDAQ_DATA_LINK_API_KEY`.  If set, NASDAQ_DATA_LINK_API_KEY will take precedence over the API Key file mentioned below.
+
 ### Local API Key file
 
 The default configuration file location is `~/.nasdaq/data_link_apikey`.  The
@@ -60,7 +64,6 @@ import nasdaqdatalink
 nasdaqdatalink.read_key(filepath="/data/.corporatenasdaqdatalinkapikey")
 ```
 
-
 ## Retrieving Data
 
 There are two methods for retrieving data in Python: the Quick method and the Detailed method. The latter is more suitable to application programming. Both methods work with Nasdaq Data Link's two types of data structures: time-series (dataset) data and non-time series (datatable).
@@ -124,7 +127,7 @@ We recommend the following tools for testing any changes:
 
 The following are instructions for running our tests:
 
-1. Make sure a version of python 2.7 or python 3.x is installed locally in your system. To avoid permission issues on OSX we recommend installing the packages from: https://www.python.org/downloads/
+1. Make sure a version of 3.x is installed locally in your system. To avoid permission issues on OSX we recommend installing the packages from: https://www.python.org/downloads/
 2. Install `virtualenv` and `tox` using:
     `pip install tox virtualenv`
 3. Run following command (you may notice slow performance the first time):
diff --git a/nasdaqdatalink/__init__.py b/nasdaqdatalink/__init__.py
@@ -17,5 +17,4 @@
 from .get_point_in_time import get_point_in_time
 
 
-if api_config.default_config_file_exists():
-    read_key()
+read_key()
diff --git a/nasdaqdatalink/api_config.py b/nasdaqdatalink/api_config.py
@@ -1,5 +1,7 @@
 import os
 
+NASDAQ_DATA_LINK_API_KEY = "NASDAQ_DATA_LINK_API_KEY"
+
 
 class ApiConfig:
     api_key = None
@@ -36,9 +38,11 @@ def default_config_filename():
     return os.path.expanduser(config_file)
 
 
-def default_config_file_exists():
-    config_filename = default_config_filename()
-    return os.path.isfile(config_filename)
+def config_file_exists(filename=None):
+    if filename is None:
+        filename = default_config_filename()
+
+    return os.path.isfile(filename)
 
 
 def save_key(apikey, filename=None):
@@ -56,7 +60,7 @@ def raise_empty_file(config_filename):
     raise ValueError("File '{:s}' is empty.".format(config_filename))
 
 
-def read_key(filename=None):
+def read_key_from_file(filename=None):
     if filename is None:
         filename = default_config_filename()
 
@@ -70,3 +74,18 @@ def read_key(filename=None):
         raise_empty_file(filename)
 
     ApiConfig.api_key = apikey
+
+
+def api_key_environment_variable_exists():
+    return NASDAQ_DATA_LINK_API_KEY in os.environ
+
+
+def read_key_from_environment_variable():
+    ApiConfig.api_key = os.environ.get(NASDAQ_DATA_LINK_API_KEY)
+
+
+def read_key(filename=None):
+    if api_key_environment_variable_exists():
+        read_key_from_environment_variable()
+    elif config_file_exists(filename):
+        read_key_from_file(filename)
diff --git a/test/test_api_config.py b/test/test_api_config.py
@@ -0,0 +1,76 @@
+# flake8: noqa
+
+import os
+from unittest import TestCase, mock
+from nasdaqdatalink.api_config import *
+
+TEST_KEY_FILE = os.path.join(
+  os.path.dirname(os.path.realpath(__file__)), ".nasdaq-config", "testkeyfile"
+)
+
+TEST_DEFAULT_FILE = os.path.join(
+  os.path.dirname(os.path.realpath(__file__)), ".nasdaq-config", "defaultkeyfile"
+)
+
+
+class ApiConfigTest(TestCase):
+    def setUp(self):
+        if not os.path.exists(os.path.dirname(TEST_KEY_FILE)):
+            try:
+                os.makedirs(os.path.dirname(TEST_KEY_FILE))
+            except OSError as exc: # Guard against race condition
+                if exc.errno != errno.EEXIST:
+                    raise
+
+    def tearDown(self):
+        if NASDAQ_DATA_LINK_API_KEY in os.environ:
+            del os.environ['NASDAQ_DATA_LINK_API_KEY']
+
+        if os.path.exists(TEST_KEY_FILE):
+            os.remove(TEST_KEY_FILE)
+
+        if os.path.exists(TEST_DEFAULT_FILE):
+            os.remove(TEST_DEFAULT_FILE)
+
+
+    def test_read_key_when_environment_variable_set(self):
+        os.environ['NASDAQ_DATA_LINK_API_KEY'] = 'setinenv'
+        ApiConfig.api_key = None
+        read_key()
+        self.assertEqual(ApiConfig.api_key, "setinenv")
+
+
+    def test_read_key_environment_variable_takes_precedence(self):
+        os.environ['NASDAQ_DATA_LINK_API_KEY'] = 'setinenvprecedence'
+        save_key("keyforfilenot", TEST_KEY_FILE)
+        ApiConfig.api_key = None
+        read_key()
+        self.assertEqual(ApiConfig.api_key, "setinenvprecedence")
+
+
+    def test_read_key_when_environment_variable_not_set(self):
+        save_key("keyforfile", TEST_KEY_FILE)
+        ApiConfig.api_key = None # Set None, we are not testing save_key
+        read_key(TEST_KEY_FILE)
+        self.assertEqual(ApiConfig.api_key, 'keyforfile')
+
+
+    def test_read_key_when_files_not_set(self):
+        ApiConfig.api_key = None
+        with mock.patch("nasdaqdatalink.api_config.default_config_filename") as mock_default_config_filename:
+             mock_default_config_filename.return_value = TEST_DEFAULT_FILE
+             read_key()
+
+        mock_default_config_filename.assert_called_once
+        self.assertEqual(ApiConfig.api_key, None)
+
+
+    def test_read_key_when_default_file_set(self):
+        save_key("keyfordefaultfile", TEST_DEFAULT_FILE)
+        ApiConfig.api_key = None # Set None, we are not testing save_key
+
+        with mock.patch("nasdaqdatalink.api_config.default_config_filename") as mock_default_config_filename:
+             mock_default_config_filename.return_value = TEST_DEFAULT_FILE
+             read_key()
+
+        self.assertEqual(ApiConfig.api_key, 'keyfordefaultfile')
