Merge branch '42-add-parameters-to-the-playground'

senpy/api.py

@@ -39,6 +39,14 @@ API_PARAMS = {
         "required": True,
         "options": ["filtered", "nested", "full"],
         "default": "full"
+    },
+    "help": {
+        "@id": "help",
+        "description": "Show additional help to know more about the possible parameters",
+        "aliases": ["help", "h"],
+        "required": True,
+        "options": ["True", "False"],
+        "default": "False"
     }
 }
 

senpy/blueprints.py

@@ -20,7 +20,7 @@ Blueprints for Senpy
 from flask import (Blueprint, request, current_app, render_template, url_for,
                    jsonify)
 from .models import Error, Response, Plugins, read_schema
-from .api import WEB_PARAMS, API_PARAMS, parse_params
+from .api import WEB_PARAMS, API_PARAMS, CLI_PARAMS, NIF_PARAMS, parse_params
 from .version import __version__
 from functools import wraps
 
@@ -43,7 +43,6 @@ def get_params(req):
         raise Error(message="Invalid data")
     return indict
 
-
 @demo_blueprint.route('/')
 def index():
     return render_template("index.html", version=__version__)
@@ -117,8 +116,14 @@ def basic_api(f):
 @api_blueprint.route('/', methods=['POST', 'GET'])
 @basic_api
 def api():
-    response = current_app.senpy.analyse(**request.params)
+    phelp = request.params.get('help')
-    return response
+    if phelp == "True":
+        dic = dict(API_PARAMS, **NIF_PARAMS)
+        response = Response(dic)
+        return response
+    else:
+        response = current_app.senpy.analyse(**request.params)
+        return response
 
 
 @api_blueprint.route('/plugins/', methods=['POST', 'GET'])

senpy/static/js/main.js

@@ -1,7 +1,7 @@
 var ONYX = "http://www.gsi.dit.upm.es/ontologies/onyx/ns#";
 var RDF_TYPE =  "http://www.w3.org/1999/02/22-rdf-syntax-ns#type";
 var plugins_params={};
-
+var default_params = JSON.parse($.ajax({type: "GET", url: "/api?help=True" , async: false}).responseText);
 function replaceURLWithHTMLLinks(text) {
     console.log('Text: ' + text);
     var exp = /(\b(https?|ftp|file):\/\/[-A-Z0-9+&@#\/%?=~_|!:,.;]*[-A-Z0-9+&@#\/%=~_|])/ig;
@@ -28,54 +28,68 @@ function hashchanged(){
 $(document).ready(function() {
     var response = JSON.parse($.ajax({type: "GET", url: "/api/plugins/" , async: false}).responseText);
     var defaultPlugin= JSON.parse($.ajax({type: "GET", url: "/api/plugins/default" , async: false}).responseText);
-    html="";
+	html="";
     var availablePlugins = document.getElementById('availablePlugins');
     plugins = response.plugins;
-    for (r in plugins){
+	gplugins = {};
-      plugin = plugins[r]
+	for (r in plugins){
-      if (plugin["name"]){
+	  ptype = plugins[r]['@type'];
-        if (plugin["name"] == defaultPlugin["name"]){
+	  if(gplugins[ptype] == undefined){
-          if (plugin["is_activated"]){
+		  gplugins[ptype] = [r]
-            html+= "<option value=\""+plugin["name"]+"\" selected=\"selected\">"+plugin["name"]+"</option>"
+	  }else{
-          }else{
+		  gplugins[ptype].push(r)
-            html+= "<option value=\""+plugin["name"]+"\" selected=\"selected\" disabled=\"disabled\">"+plugin["name"]+"</option>"
+	  }
-          }
+	}
-        }
+	for (g in gplugins){	
-        else{
+		html += "<optgroup label=\""+g+"\">"
-          if (plugin["is_activated"]){
+		for (r in gplugins[g]){
-            html+= "<option value=\""+plugin["name"]+"\">"+plugin["name"]+"</option>"
+		  plugin = plugins[r]
-          }
+		  if (plugin["name"]){
-          else{
+			if (plugin["name"] == defaultPlugin["name"]){
-            html+= "<option value=\""+plugin["name"]+"\" disabled=\"disabled\">"+plugin["name"]+"</option>"
+			  if (plugin["is_activated"]){
-          }
+				html+= "<option value=\""+plugin["name"]+"\" selected=\"selected\">"+plugin["name"]+"</option>"
-        }
+			  }else{
-      }
+				html+= "<option value=\""+plugin["name"]+"\" selected=\"selected\" disabled=\"disabled\">"+plugin["name"]+"</option>"
-      if (plugin["extra_params"]){
+			  }
-        plugins_params[plugin["name"]]={};
+			}
-        for (param in plugin["extra_params"]){
+			else{
-          if (typeof plugin["extra_params"][param] !="string"){
+			  if (plugin["is_activated"]){
-            var params = new Array();
+				html+= "<option value=\""+plugin["name"]+"\">"+plugin["name"]+"</option>"
-            var alias = plugin["extra_params"][param]["aliases"][0];
+			  }
-            params[alias]=new Array();
+			  else{
-            for (option in plugin["extra_params"][param]["options"]){
+				html+= "<option value=\""+plugin["name"]+"\" disabled=\"disabled\">"+plugin["name"]+"</option>"
-              params[alias].push(plugin["extra_params"][param]["options"][option])
+			  }
-            }
+			}
-            plugins_params[plugin["name"]][alias] = (params[alias])
+		  }
-          }
-        }
-      }
-      var pluginList = document.createElement('li');
 
-      newHtml = ""
+		 if (plugin["extra_params"]){
-      if(plugin.url) {
+			plugins_params[plugin["name"]]={};
-        newHtml= "<a href="+plugin.url+">" + plugin.name + "</a>";
+			for (param in plugin["extra_params"]){
-      }else {
+			  if (typeof plugin["extra_params"][param] !="string"){
-        newHtml= plugin["name"];
+				var params = new Array();
-      }
+				var alias = plugin["extra_params"][param]["aliases"][0];
-      newHtml += ": " + replaceURLWithHTMLLinks(plugin.description);
+				params[alias]=new Array();
-      pluginList.innerHTML = newHtml;
+				for (option in plugin["extra_params"][param]["options"]){
-      availablePlugins.appendChild(pluginList)
+				  params[alias].push(plugin["extra_params"][param]["options"][option])
-    }
+				}
+				plugins_params[plugin["name"]][alias] = (params[alias])
+			  }
+			}
+		  }
+		  var pluginList = document.createElement('li');
+		  
+		  newHtml = ""
+		  if(plugin.url) {
+			newHtml= "<a href="+plugin.url+">" + plugin.name + "</a>";
+		  }else {
+			newHtml= plugin["name"];
+		  }
+		  newHtml += ": " + replaceURLWithHTMLLinks(plugin.description);
+		  pluginList.innerHTML = newHtml;
+		  availablePlugins.appendChild(pluginList)
+		}
+	 html += "</optgroup>"
+	}
     document.getElementById('plugins').innerHTML = html;
     change_params();
   
@@ -88,8 +102,23 @@ $(document).ready(function() {
 
 function change_params(){
       var plugin = document.getElementById("plugins").options[document.getElementById("plugins").selectedIndex].value;
-
         html=""
+		for (param in default_params){
+		  if ((default_params[param]['options']) && (['help','conversion'].indexOf(param) < 0)){  
+			html+= "<label> "+param+"</label>"
+            html+= "<select id=\""+param+"\" name=\""+param+"\">"
+			for (option in default_params[param]['options']){
+				if (default_params[param]['options'][option] == default_params[param]['default']){  
+					html+="<option value \""+default_params[param]['options'][option]+"\" selected >"+default_params[param]['options'][option]+"</option>"
+				}
+				else{
+					html+="<option value \""+default_params[param]['options'][option]+"\">"+default_params[param]['options'][option]+"</option>"
+							
+				}
+			}
+			html+="</select><br>"
+		  }
+		}
         for (param in plugins_params[plugin]){
           if (param || plugins_params[plugin][param].length > 1){
             html+= "<label> Parameter "+param+"</label>"
@@ -120,15 +149,32 @@ function load_JSON(){
             }
         }
       }
-      var response = JSON.parse($.ajax({type: "GET", url: url , async: false}).responseText);
+
+      for (param in default_params){
+        if ((param != null) && (default_params[param]['options']) && (['help','conversion'].indexOf(param) < 0)){
+            var param_value = encodeURIComponent(document.getElementById(param).options[document.getElementById(param).selectedIndex].text);
+            if (param_value){
+              url+="&"+param+"="+param_value
+            }
+        }
+      }
+
+  var response =  $.ajax({type: "GET", url: url , async: false}).responseText;
+  rawcontainer.innerHTML = replaceURLWithHTMLLinks(response)
+
+  document.getElementById("input_request").innerHTML = "<a href='"+url+"'>"+url+"</a>"
+  document.getElementById("results-div").style.display = 'block';
+  try {
+    response = JSON.parse(response);
       var options = {
         mode: 'view'
       };
       var editor = new JSONEditor(container, options, response);
       editor.expandAll();
-      rawcontainer.innerHTML = replaceURLWithHTMLLinks(JSON.stringify(response, undefined, 2))
+  }
-      document.getElementById("input_request").innerHTML = "<a href='"+url+"'>"+url+"</a>"
+  catch(err){
-      document.getElementById("results-div").style.display = 'block';
+    console.log("Error decoding JSON (got turtle?)");
+  }
       
 
 }