Merge branch 'rest_server'

Author: carlosperate

.appveyor.yml

@@ -55,8 +55,11 @@ install:
   # Install Python packages
   - cmd: "%PIP3% install pyinstaller"
   - cmd: "%PIP3% install mkdocs"
+  #- cmd: "%PIP3% install pydocstyle"
   - cmd: "%PIP3% install coverage"
+  - cmd: "%PIP3% install requests"
   - cmd: "%PIP% install coverage"
+  - cmd: "%PIP% install requests"
   - cmd: "%PIP% install mock"
   - cmd: "%PIP% freeze"
   - cmd: "%PIP3% freeze"
@@ -82,6 +85,7 @@ test_script:
   - cmd: "%PYTHON%\\python -m coverage report"
   - cmd: "%PYTHON3%\\python -m coverage run ardublocklyserver\\tests\\run_all.py"
   - cmd: "%PYTHON3%\\python -m coverage report"
+  #- cmd: pydocstyle ardublocklyserver --match-dir='ardublocklyserver'
 
 # Push artefact to S3 bucket and list all
 before_deploy:

.coveragerc

@@ -0,0 +1,16 @@
+[run]
+branch = False
+cover_pylib = False
+source = ardublocklyserver/
+omit =
+    ardublocklyserver/tests/*
+    ardublocklyserver/local-packages/*
+    ardublocklyserver/pyserialports/*
+
+[report]
+show_missing = True
+skip_covered = False
+exclude_lines =
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

.travis.yml

@@ -36,8 +36,11 @@ before_install:
   # Install Python packages (built with Python 3, tests for 2 and 3)
   - sudo python -m pip install mock
   - sudo python -m pip install coverage
+  - sudo python -m pip install requests
   - pip3 install coverage
+  - pip3 install requests
   - pip3 install coveralls
+  #- pip3 install pydocstyle
   - pip3 install mkdocs
   - pip3 install pyinstaller
 
@@ -77,6 +80,7 @@ script:
   - python -m coverage report
   - python3 -m coverage run ardublocklyserver/tests/run_all.py
   - python3 -m coverage report
+  #- pydocstyle ardublocklyserver --match-dir='ardublocklyserver'
 
 after_success:
   - coveralls

ardublockly/ardublockly.js

@@ -26,8 +26,8 @@ Ardublockly.init = function() {
   Ardublockly.bindActionFunctions();
   Ardublockly.bindBlocklyEventListeners();
 
-  // Check if not running locally
-  if (document.location.hostname != 'localhost') {
+  // Hackish way to check if not running locally
+  if (document.location.hostname != '127.0.0.1') {
     Ardublockly.openNotConnectedModal();
   }
 };
@@ -92,12 +92,16 @@ Ardublockly.bindActionFunctions = function() {
 
   // Settings modal input field listeners
   Ardublockly.bindClick_('settings_compiler_location', function() {
-    ArdublocklyServer.requestNewCompilerLocation(
-        Ardublockly.setCompilerLocationHtml);
+    ArdublocklyServer.requestNewCompilerLocation(function(jsonObj) {
+      Ardublockly.setCompilerLocationHtml(
+          ArdublocklyServer.jsonToHtmlTextInput(jsonObj));
+    });
   });
   Ardublockly.bindClick_('settings_sketch_location', function() {
-    ArdublocklyServer.requestNewSketchLocation(
-        Ardublockly.setSketchLocationHtml);
+    ArdublocklyServer.requestNewSketchLocation(function(jsonObj) {
+      Ardublockly.setSketchLocationHtml(
+          ArdublocklyServer.jsonToHtmlTextInput(jsonObj));
+    });
   });
 };
 
@@ -154,14 +158,9 @@ Ardublockly.initialiseIdeButtons = function() {
       Ardublockly.getLocalStr('verifySketch');
   document.getElementById('button_ide_large').title =
       Ardublockly.getLocalStr('uploadSketch');
-  ArdublocklyServer.requestIdeOptions(function(jsonResponse) {
-    if (jsonResponse != null) {
-      var parsedJson = JSON.parse(jsonResponse);
-      // "response_type" : "settings_board",
-      //   "element" : "dropdown",
-      //   "options" : [ {"value" : "XXX", "text" : "XXX"}, ...]
-      //   "selected": "selected key"}
-      Ardublockly.changeIdeButtons(parsedJson.selected);
+  ArdublocklyServer.requestIdeOptions(function(jsonObj) {
+    if (jsonObj != null) {
+      Ardublockly.changeIdeButtons(jsonObj.selected);
     } // else Null: Ardublockly server is not running, do nothing
   });
 };
@@ -325,12 +324,25 @@ Ardublockly.saveTextFileAs = function(fileName, content) {
  * and opens the Settings modal dialog.
  */
 Ardublockly.openSettings = function() {
-  ArdublocklyServer.requestCompilerLocation(
-      Ardublockly.setCompilerLocationHtml);
-  ArdublocklyServer.requestSketchLocation(Ardublockly.setSketchLocationHtml);
-  ArdublocklyServer.requestArduinoBoards(Ardublockly.setArduinoBoardsHtml);
-  ArdublocklyServer.requestSerialPorts(Ardublockly.setSerialPortsHtml);
-  ArdublocklyServer.requestIdeOptions(Ardublockly.setIdeHtml);
+  ArdublocklyServer.requestCompilerLocation(function(jsonObj) {
+    Ardublockly.setCompilerLocationHtml(
+        ArdublocklyServer.jsonToHtmlTextInput(jsonObj));
+  });
+  ArdublocklyServer.requestSketchLocation(function(jsonObj) {
+    Ardublockly.setSketchLocationHtml(
+        ArdublocklyServer.jsonToHtmlTextInput(jsonObj));
+  });
+  ArdublocklyServer.requestArduinoBoards(function(jsonObj) {
+    Ardublockly.setArduinoBoardsHtml(
+        ArdublocklyServer.jsonToHtmlDropdown(jsonObj));
+  });
+  ArdublocklyServer.requestSerialPorts(function(jsonObj) {
+    Ardublockly.setSerialPortsHtml(
+        ArdublocklyServer.jsonToHtmlDropdown(jsonObj));
+  });
+  ArdublocklyServer.requestIdeOptions(function(jsonObj) {
+    Ardublockly.setIdeHtml(ArdublocklyServer.jsonToHtmlDropdown(jsonObj));
+  });
   // Language menu only set on page load within Ardublockly.initLanguage()
   Ardublockly.openSettingsModal();
 };
@@ -340,11 +352,11 @@ Ardublockly.openSettings = function() {
  * @param {element} jsonResponse JSON data coming back from the server.
  * @return {undefined} Might exit early if response is null.
  */
-Ardublockly.setCompilerLocationHtml = function(jsonResponse) {
-  if (jsonResponse === null) return Ardublockly.openNotConnectedModal();
-  var newEl = ArdublocklyServer.createElementFromJson(jsonResponse);
+Ardublockly.setCompilerLocationHtml = function(newEl) {
+  if (newEl === null) return Ardublockly.openNotConnectedModal();
+
   var compLocIp = document.getElementById('settings_compiler_location');
-  if (compLocIp != null) {
+  if (compLocIp != null && newEl.value) {
     compLocIp.value = newEl.value;
   }
 };
@@ -354,9 +366,9 @@ Ardublockly.setCompilerLocationHtml = function(jsonResponse) {
  * @param {element} jsonResponse JSON data coming back from the server.
  * @return {undefined} Might exit early if response is null.
  */
-Ardublockly.setSketchLocationHtml = function(jsonResponse) {
-  if (jsonResponse === null) return Ardublockly.openNotConnectedModal();
-  var newEl = ArdublocklyServer.createElementFromJson(jsonResponse);
+Ardublockly.setSketchLocationHtml = function(newEl) {
+  if (newEl === null) return Ardublockly.openNotConnectedModal();
+
   var sketchLocIp = document.getElementById('settings_sketch_location');
   if (sketchLocIp != null) {
     sketchLocIp.value = newEl.value;
@@ -366,12 +378,12 @@ Ardublockly.setSketchLocationHtml = function(jsonResponse) {
 /**
  * Replaces the Arduino Boards form data with a new HTMl element.
  * Ensures there is a change listener to call 'setSerialPort' function
- * @param {element} jsonResponse JSON data coming back from the server.
+ * @param {element} jsonObj JSON data coming back from the server.
  * @return {undefined} Might exit early if response is null.
  */
-Ardublockly.setArduinoBoardsHtml = function(jsonResponse) {
-  if (jsonResponse === null) return Ardublockly.openNotConnectedModal();
-  var newEl = ArdublocklyServer.createElementFromJson(jsonResponse);
+Ardublockly.setArduinoBoardsHtml = function(newEl) {
+  if (newEl === null) return Ardublockly.openNotConnectedModal();
+
   var boardDropdown = document.getElementById('board');
   if (boardDropdown !== null) {
     // Restarting the select elements built by materialize
@@ -391,9 +403,10 @@ Ardublockly.setArduinoBoardsHtml = function(jsonResponse) {
 Ardublockly.setBoard = function() {
   var el = document.getElementById('board');
   var boardValue = el.options[el.selectedIndex].value;
-  //TODO: Check how ArdublocklyServer deals with invalid data and sanitise
-  ArdublocklyServer.setArduinoBoard(
-      boardValue, Ardublockly.setArduinoBoardsHtml);
+  ArdublocklyServer.setArduinoBoard(boardValue, function(jsonObj) {
+    var newEl = ArdublocklyServer.jsonToHtmlDropdown(jsonObj);
+    Ardublockly.setArduinoBoardsHtml(newEl);
+  });
   Ardublockly.changeBlocklyArduinoBoard(
       boardValue.toLowerCase().replace(/ /g, '_'));
 };
@@ -404,9 +417,9 @@ Ardublockly.setBoard = function() {
  * @param {element} jsonResponse JSON data coming back from the server.
  * @return {undefined} Might exit early if response is null.
  */
-Ardublockly.setSerialPortsHtml = function(jsonResponse) {
-  if (jsonResponse === null) return Ardublockly.openNotConnectedModal();
-  var newEl = ArdublocklyServer.createElementFromJson(jsonResponse);
+Ardublockly.setSerialPortsHtml = function(newEl) {
+  if (newEl === null) return Ardublockly.openNotConnectedModal();
+
   var serialDropdown = document.getElementById('serial_port');
   if (serialDropdown !== null) {
     // Restarting the select elements built by materialize
@@ -424,9 +437,10 @@ Ardublockly.setSerialPortsHtml = function(jsonResponse) {
 Ardublockly.setSerial = function() {
   var el = document.getElementById('serial_port');
   var serialValue = el.options[el.selectedIndex].value;
-  //TODO: check how ArdublocklyServer deals with invalid data and sanitise
-  ArdublocklyServer.setSerialPort(
-      serialValue, Ardublockly.setSerialPortsHtml);
+  ArdublocklyServer.setSerialPort(serialValue, function(jsonObj) {
+    var newEl = ArdublocklyServer.jsonToHtmlDropdown(jsonObj);
+    Ardublockly.setSerialPortsHtml(newEl);
+  });
 };
 
 /**
@@ -435,9 +449,9 @@ Ardublockly.setSerial = function() {
  * @param {element} jsonResponse JSON data coming back from the server.
  * @return {undefined} Might exit early if response is null.
  */
-Ardublockly.setIdeHtml = function(jsonResponse) {
-  if (jsonResponse === null) return Ardublockly.openNotConnectedModal();
-  var newEl = ArdublocklyServer.createElementFromJson(jsonResponse);
+Ardublockly.setIdeHtml = function(newEl) {
+  if (newEl === null) return Ardublockly.openNotConnectedModal();
+
   var ideDropdown = document.getElementById('ide_settings');
   if (ideDropdown !== null) {
     // Restarting the select elements built by materialize
@@ -466,8 +480,9 @@ Ardublockly.setIdeSettings = function(e, preset) {
     var ideValue = el.options[el.selectedIndex].value;
   }
   Ardublockly.changeIdeButtons(ideValue);
-  //TODO: check how ArdublocklyServer deals with invalid data and sanitise here
-  ArdublocklyServer.setIdeOptions(ideValue, Ardublockly.setIdeHtml);
+  ArdublocklyServer.setIdeOptions(ideValue, function(jsonObj) {
+    Ardublockly.setIdeHtml(ArdublocklyServer.jsonToHtmlDropdown(jsonObj));
+  });
 };
 
 /**
@@ -483,10 +498,10 @@ Ardublockly.sendCode = function() {
    * @param {element} jsonResponse JSON data coming back from the server.
    * @return {undefined} Might exit early if response is null.
    */
-  var sendCodeReturn = function(jsonResponse) {
+  var sendCodeReturn = function(jsonObj) {
     Ardublockly.largeIdeButtonSpinner(false);
-    if (jsonResponse === null) return Ardublockly.openNotConnectedModal();
-    var dataBack = ArdublocklyServer.createElementFromJson(jsonResponse);
+    if (jsonObj === null) return Ardublockly.openNotConnectedModal();
+    var dataBack = ArdublocklyServer.jsonToIdeModal(jsonObj);
     Ardublockly.arduinoIdeOutput(dataBack);
   };
 
@@ -639,7 +654,7 @@ Ardublockly.importExtraBlocks = function() {
   };
   // Reads the JSON data containing all block categories from ./blocks directory
   // TODO: Now reading a local file, to be replaced by server generated JSON
-  Ardublockly.getJsonData('../blocks/blocks_data.json', jsonDataCb);
+  ArdublocklyServer.getJson('../blocks/blocks_data.json', jsonDataCb);
 };
 
 /** Opens a modal with a list of categories to add or remove to the toolbox */
@@ -675,7 +690,7 @@ Ardublockly.openExtraCategoriesSelect = function() {
   };
   // Reads the JSON data containing all block categories from ./blocks directory
   // TODO: Now reading a local file, to be replaced by server generated JSON
-  Ardublockly.getJsonData('../blocks/blocks_data.json', jsonDataCb);
+  ArdublocklyServer.getJson('../blocks/blocks_data.json', jsonDataCb);
 };
 
 /** Informs the user that the selected function is not yet implemented. */

ardublockly/ardublockly_lang.js

@@ -124,7 +124,7 @@ Ardublockly.injectLanguageJsSources = function(langKey) {
 
   // Retrieve and inject Ardublockly translations synchronously
   var appLangJsLoad = document.createElement('script');
-  var request = ArdublocklyServer.createAjaxRequest();
+  var request = ArdublocklyServer.createRequest();
   var appLangJdPath = 'msg/' + langKey + '.js';
   try {
     request.open('GET', appLangJdPath, false);