Add details endpoint to visualizer api (#38)

* implementation of REST api to get list of visualizers

* implementation of REST api to get list of visualizer settings

docs/api.rst

@@ -79,6 +79,83 @@ Output:
 
 
 
+GET /api/visualizers
+###############
+List all available visualizers
+
+.. code-block:: bash
+
+  curl "localhost:5000/api/visualizers" -b /path/to/cookie -c /path/to/cookie
+
+Output:
+
+.. code-block:: json
+
+  {
+    "visualizers": [
+      {
+        "name": "ClassProbabilities"
+      },
+      {
+        "name": "PartialOcclusion"
+      },
+      {
+        "name": "SaliencyMaps"
+      }
+    ]
+  }
+
+
+
+
+GET /api/visualizers/<vis_name>
+###############
+List all available settings for visualizer ``<viz_name>``
+
+.. code-block:: bash
+
+  curl "localhost:5000/api/visualizers/PartialOcclusion" -b /path/to/cookie -c /path/to/cookie
+
+Output:
+
+.. code-block:: json
+
+  {
+    "settings": {
+      "Occlusion": [
+        "grey",
+        "black",
+        "white"
+      ],
+      "Strides": [
+        "2",
+        "5",
+        "10",
+        "20",
+        "30"
+      ],
+      "Window": [
+        "0.50",
+        "0.40",
+        "0.30",
+        "0.20",
+        "0.10",
+        "0.05"
+      ]
+    }
+  }
+
+returns an empty settings object when no settings available:
+
+.. code-block:: json
+
+  {
+    "settings": {}
+  }
+
+
+
+
 GET /api/visualize
 ###################
 

picasso/interfaces/rest.py

@@ -74,6 +74,30 @@ def images():
         return jsonify(images=session['image_list'])
 
 
+@API.route('/visualizers', methods=['GET'])
+def visualizers():
+    """Get a list of available visualizers
+
+    Responses with a JSON list of available visualizers
+
+    """
+    list_of_visualizers = []
+    for visualizer in get_visualizations():
+        list_of_visualizers.append({'name': visualizer})
+    return jsonify(visualizers=list_of_visualizers)
+
+
+@API.route('/visualizers/<vis_name>', methods=['GET'])
+def visualizers_information(vis_name):
+    vis = get_visualizations()[vis_name]
+    if hasattr(vis, 'ALLOWED_SETTINGS'):
+        settings = vis.ALLOWED_SETTINGS
+    else:
+        settings = {}
+
+    return jsonify(settings=settings)
+
+
 @API.route('/visualize', methods=['GET'])
 def visualize():
     """Trigger a visualization via the REST API

tests/test_picasso.py

@@ -119,6 +119,16 @@ def test_end_session(self, client):
         response = client.get(url_for('api.reset'))
         assert response.status_code == 200
 
+    def test_visualizers(self, client):
+        response = client.get(url_for('api.visualizers'))
+        assert response.status_code == 200
+
+    @pytest.mark.parametrize("vis", _get_visualization_classes())
+    def test_visualizers_informations(self, client, vis):
+        response = client.get(url_for('api.visualizers_information', vis_name=vis.__name__))
+        assert response.status_code == 200
+
+
 
 class TestBaseModel: