Start cacheing graph reference.

theengineear · theengineear · commit f375701a06d8 · 2015-09-03T14:46:28.000+07:00
diff --git a/plotly/files.py b/plotly/files.py
@@ -4,6 +4,7 @@
 PLOTLY_DIR = os.path.join(os.path.expanduser("~"), ".plotly")
 CREDENTIALS_FILE = os.path.join(PLOTLY_DIR, ".credentials")
 CONFIG_FILE = os.path.join(PLOTLY_DIR, ".config")
+GRAPH_REFERENCE_FILE = os.path.join(PLOTLY_DIR, ".graph_reference")
 TEST_DIR = os.path.join(os.path.expanduser("~"), ".test")
 TEST_FILE = os.path.join(PLOTLY_DIR, ".permission_test")
 
diff --git a/plotly/graph_reference.py b/plotly/graph_reference.py
@@ -0,0 +1,52 @@
+"""
+This module handles accessing, storing, and managing the graph reference.
+
+"""
+from __future__ import absolute_import
+
+import json
+import requests
+
+from plotly import exceptions, files, utils
+
+GRAPH_REFERENCE_PATH = '/plot-schema.json'
+
+def get_graph_reference():
+    """
+    Attempts to load local copy of graph reference or makes GET request if DNE.
+
+    :return: (dict) The graph reference.
+    :raises: (PlotlyError) When graph reference DNE and GET request fails.
+
+    """
+    if files.check_file_permissions():
+        graph_reference = utils.load_json_dict(files.GRAPH_REFERENCE_FILE)
+        config = utils.load_json_dict(files.CONFIG_FILE)
+        plotly_domain = config['plotly_domain']
+    else:
+        graph_reference = {}
+        plotly_domain = files.FILE_CONTENT[files.CONFIG_FILE]['plotly_domain']
+
+    if not graph_reference:
+
+        graph_reference_url = plotly_domain + GRAPH_REFERENCE_PATH
+
+        try:
+            response = requests.get(graph_reference_url)
+            response.raise_for_status()
+        except requests.exceptions.RequestException:
+            raise exceptions.PlotlyError(
+                "The schema used to validate Plotly figures has never been "
+                "downloaded to your computer. You'll need to connect to a "
+                "Plotly server at least once to do this.\n"
+                "You're seeing this error because the attempt to download "
+                "the schema from '{}' failed.".format(graph_reference_url)
+            )
+
+        # TODO: Hash this so we don't have to load it every time. The server
+        #       will need to accept a hash query param as well.
+        graph_reference = json.loads(response.content)
+
+    return utils.decode_unicode(graph_reference)
+
+GRAPH_REFERENCE = get_graph_reference()
diff --git a/plotly/tools.py b/plotly/tools.py
@@ -9,7 +9,6 @@
 """
 from __future__ import absolute_import
 
-import os.path
 import warnings
 
 import six
@@ -19,6 +18,7 @@
 
 from plotly import utils
 from plotly import exceptions
+from plotly import graph_reference
 from plotly import session
 from plotly.files import (CONFIG_FILE, CREDENTIALS_FILE, FILE_CONTENT,
                           GRAPH_REFERENCE_FILE, check_file_permissions)
@@ -64,8 +64,6 @@ def get_config_defaults():
     return dict(FILE_CONTENT[CONFIG_FILE])  # performs a shallow copy
 
 
-
-
 def ensure_local_plotly_files():
     """Ensure that filesystem is setup/filled out in a valid way"""
     if check_file_permissions():
@@ -81,7 +79,14 @@ def ensure_local_plotly_files():
                 if key not in FILE_CONTENT[fn]:
                     del contents[key]
             utils.save_json_dict(fn, contents)
-        ensure_graph_reference_file()
+
+        # make a request to get graph reference if DNE.
+        utils.ensure_file_exists(GRAPH_REFERENCE_FILE)
+        graph_reference_dict = utils.load_json_dict(GRAPH_REFERENCE_FILE)
+
+        if not graph_reference_dict:
+            utils.save_json_dict(GRAPH_REFERENCE_FILE,
+                                 graph_reference.GRAPH_REFERENCE)
     else:
         warnings.warn("Looks like you don't have 'read-write' permission to "
                       "your 'home' ('~') directory or to our '~/.plotly' "
@@ -225,6 +230,14 @@ def reset_config_file():
     ensure_local_plotly_files()  # put the defaults back
 
 
+### graph reference tools ###
+
+def reset_graph_reference_file():
+    """Temporary until we can use local hash in request for graph reference."""
+    utils.ensure_file_exists(GRAPH_REFERENCE_FILE)
+    utils.save_json_dict(GRAPH_REFERENCE_FILE, {})
+
+
 ### embed tools ###
 
 def get_embed(file_owner_or_url, file_id=None, width="100%", height=525):
