mumuki-laboratory 5.0.12 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20a23b43e3c91f95ce461111eda22e97e96ab825aee08ec6a2b6186ddaa2869
-  data.tar.gz: d20f260a0e52cfa8b7f5addb7b2206cd53b6cd018abfb2341777b23961a27022
+  metadata.gz: d22efc547d00b460a2f4e60d581454ee76f496d11deee257be13a766c3761fec
+  data.tar.gz: 14a468c0685dab2f527a3b8f3296b073c54ff20a3066fe4fb33c790efb2e272c
 SHA512:
-  metadata.gz: d4b49d99b38e97e7991e46fcddc9312b9cad1e2868858776a4bf129ce8f8decdd006eb677b2d4ffbfd2b0b375dae2022ac32e9c90bfc878fb06ee344f263ef0f
-  data.tar.gz: f28a32cf10fa13d7dbfabc6dbac25129fa633557fc5841d104e34c66a669bd24f77ac736a16e2093aff8470d45b5989dae3fa5a96fc8c0afa2fa4501b81b9a07
+  metadata.gz: 7af06b906467bf004ee6f37bbdca54d5467301090d84bb7e7f77ae2926cf66fac49030ccb10cf77779010df6859fa7f4f50e7634c9022349475fe8c27564d5e5
+  data.tar.gz: 609bc2c1250aecf90ba2ab188e2068824366603f5e32f9dc2573b1d402b0bd04b0822fd86d0ab351dbe4392c9c26f8f29c97da634e965c30e28d9547c108d5f7

data/README.md

@@ -130,6 +130,345 @@ rails s
 bundle exec rspec
 ```
 
+## API Docs
+
+Before using the API, you must create an `ApiClient` using `rails c`, which will generate a private JWT. Use it to authenticate API calls in any Platform application within a `Authorizaion: Bearer <TOKEN>`.
+
+Before using the API, take a look to the roles hierarchy:
+
+![roles hierarchy](https://yuml.me/diagram/plain/class/[Owner]%5E-[Janitor],%20[Janitor]%5E-[Headmaster],%20[Headmaster]%5E-[Teacher],%20[Teacher]%5E-[Student],%20,%20[Owner]%5E-[Editor],%20[Editor]%5E-[Writer]).
+
+Permissions are bound to a scope, that states in which context the operation can be performed. Scopes are simply two-level contexts, expressed as slugss `<first>/<second>`, without any explicit semantic. They exact meaning depends on the role:
+
+  * student: `organization/course`
+  * teacher and headmaster: `organization/course`
+  * writer and editor: `organization/content`
+  * janitor: `organization/_`
+  * owner: `_/_`
+
+### Users
+
+#### Create single user
+
+This is a generic user creation request.
+
+**Minimal permission**: `janitor`
+
+```
+POST /users
+```
+
+Sample request body:
+
+```json
+{
+  "first_name": "María",
+  "last_name": "Casas",
+  "email": "maryK345@foobar.edu.ar",
+  "permissions": {
+     "student": "cpt/*:rte/*",
+     "teacher": "ppp/2016-2q"
+  }
+}
+```
+
+#### Update single user
+
+This is a way of updating user basic data. Permissions are ignored.
+
+**Minimal permission**: `janitor`
+
+```
+PUT /users/:uid
+```
+
+Sample request body:
+
+```json
+{
+  "first_name": "María",
+  "last_name": "Casas",
+  "email": "maryK345@foobar.edu.ar",
+  "uid": "maryK345@foobar.edu.ar"
+}
+```
+
+#### Add student to course
+
+Creates the student if necessary, and updates her permissions.
+
+**Minimal permission**: `janitor`
+
+```
+POST /courses/:organization/:course/students
+```
+
+```json
+{
+  "first_name": "María",
+  "last_name": "Casas",
+  "email": "maryK345@foobar.edu.ar",
+  "uid": "maryK345@foobar.edu.ar"
+}
+```
+**Response**
+```json
+{
+  "uid": "maryK345@foobar.edu.ar",
+  "first_name": "María",
+  "last_name": "Casas",
+  "email": "maryK345@foobar.edu.ar"
+}
+```
+**Forbidden Response**
+```json
+{
+  "status": 403,
+  "error": "Exception"
+}
+```
+
+#### Detach student from course
+
+Remove student permissions from a course.
+
+**Minimal permission**: `janitor`
+
+```
+POST /courses/:organization/:course/students/:uid/detach
+```
+
+**Response**: status code: 200
+
+
+**Not Found Response**
+```json
+{
+  "status": 404,
+  "error": "Couldn't find User"
+}
+```
+
+#### Attach student to course
+
+Add student permissions to a course.
+
+**Minimal permission**: `janitor`
+
+```
+POST /courses/:organization/:course/students/:uid/attach
+```
+**Response**: status code: 200
+
+**Not Found Response**
+```json
+{
+  "status": 404,
+  "error": "Couldn't find User"
+}
+```
+
+
+#### Add teacher to course
+
+Creates the teacher if necessary, and updates her permissions.
+
+**Minimal permission**: `headmaster`, `janitor`
+
+```
+POST /course/:id/teachers
+```
+
+```json
+{
+  "first_name": "Erica",
+  "last_name": "Gonzalez",
+  "email": "egonzalez@foobar.edu.ar",
+  "uid": "egonzalez@foobar.edu.ar"
+}
+```
+
+#### Add a batch of users to a course
+
+Creates every user if necesssary, an updates permissions.
+
+**Minimal permission**: `janitor`
+
+```
+POST /course/:id/batches
+```
+
+```json
+{
+  "students": [
+    {
+      "first_name": "Tupac",
+      "last_name": "Lincoln",
+      "email": "tliconln@foobar.edu.ar",
+      "uid": "tliconln@foobar.edu.ar"
+    }
+  ],
+  "teachers": [
+    {
+      "first_name": "Erica",
+      "last_name": "Gonzalez",
+      "email": "egonzalez@foobar.edu.ar",
+      "uid": "egonzalez@foobar.edu.ar"
+    }
+  ]
+}
+```
+
+#### Detach student from course
+
+**Minimal permission**: `janitor`
+
+```
+DELETE /course/:id/students/:uid
+```
+
+#### Detach teacher from course
+
+**Minimal permission**: `janitor`
+
+```
+DELETE /course/:id/teachers/:uid
+```
+
+#### Destroy single user
+
+**Minimal permission**: `owner`
+
+```
+DELETE /users/:uid
+```
+
+### Courses
+
+#### Create single course
+
+**Minimal permission**: `janitor`
+
+```
+POST /organization/:id/courses/
+```
+
+```json
+{
+   "name":"....",
+}
+```
+
+#### Archive single course
+
+**Minimal permission**: `janitor`
+
+```
+DELETE /organization/:id/courses/:id
+```
+
+#### Destroy single course
+
+**Minimal permission**: `owner`
+
+```
+DELETE /courses/:id
+```
+
+
+### Organizations
+
+#### Model
+
+### Mandatory fields
+```json
+{
+  "name": "academy",
+  "contact_email": "issues@mumuki.io",
+  "books": [
+    "MumukiProject/mumuki-libro-metaprogramacion"
+  ],
+  "locale": "es-AR"
+}
+```
+
+### Optional fields
+```json
+{
+  "public": false,
+  "description": "...",
+  "login_methods": [
+    "facebook", "twitter", "google"
+  ],
+  "logo_url": "http://mumuki.io/logo-alt-large.png",
+  "terms_of_service": "Al usar Mumuki aceptás que las soluciones de tus ejercicios sean registradas para ser corregidas por tu/s docente/s...",
+  "theme_stylesheet": ".theme { color: red }",
+  "extension_javascript": "doSomething = function() { }"
+}
+```
+
+- If you set `null` to `public`, `login_methods`, the values will be `false` and `["user_pass"].
+- If you set `null` to `description`, the value will be `null`.
+- If you set `null` to the others, it will be inherited from an organization called `"base"` every time you query the API.
+
+
+### Generated fields
+```json
+{
+  "theme_stylesheet_url": "stylesheets/academy-asjdf92j1jd8.css",
+  "extension_javascript_url": "javascripts/academy-jd912j8jdj19.js"
+}
+```
+
+#### List all organizations
+
+```
+get /organizations
+```
+
+Sample response body:
+
+```json
+{
+  "organizations": [
+    { "name": "academy", "contact_email": "a@a.com", "locale": "es-AR", "login_methods": ["facebook"], "books": ["libro"], "public": true, "logo_url":"http://..." },
+    { "name": "alcal", "contact_email": "b@b.com", "locale": "en-US", "login_methods": ["facebook", "github"], "books": ["book"], "public": false }
+  ]
+}
+```
+**Minimal permission**: None for public organizations, `janitor` for user's private organizations.
+
+#### Get single organization by name
+
+```
+get /organizations/:name
+```
+
+Sample response body:
+
+```json
+{ "name": "academy", "contact_email": "a@a.com", "locale": "es-AR", "login_methods": ["facebook"], "books": ["libro"], "public": true, "logo_url":"http://..." }
+```
+**Minimal permission**: `janitor` of the organization.
+
+#### Create organization
+
+```
+post /organizations
+```
+... with at least the required fields.
+
+**Minimal permission**: `owner` of that organization
+
+#### Update organization
+
+```
+put /organizations/:name
+```
+... with a partial update.
+
+**Minimal permission**: `owner` of `:name`
+
 
 ## Authentication Powered by Auth0
 

data/app/assets/javascripts/application/bridge.js

@@ -1,19 +1,48 @@
 var mumuki = mumuki || {};
+
 (function (mumuki) {
+  var lastSubmission = {};
 
   function Laboratory(exerciseId){
     this.exerciseId = exerciseId;
   }
 
+  function asString(json){
+    return JSON.stringify(json);
+  }
+
+  function sameAsLastSolution(newSolution){
+    return asString(lastSubmission.content) === asString(newSolution);
+  }
+
+  function lastSubmissionFinishedSuccessfully(){
+    return lastSubmission.result && lastSubmission.result.status !== 'aborted';
+  }
+
+  function sendNewSolution(solution){
+    var token = new mumuki.CsrfToken();
+    var request = token.newRequest({
+      type: 'POST',
+      url: window.location.origin + window.location.pathname + '/solutions',
+      data: solution
+    });
+
+    return $.ajax(request).done(function (result) {
+      lastSubmission = { content: solution, result: result };
+    });
+  }
+
+  mumuki.load(function () {
+    lastSubmission = {};
+  });
+
   Laboratory.prototype = {
     runLocalTests: function (solution) {
-      var token = new mumuki.CsrfToken();
-      var request = token.newRequest({
-        type: 'POST',
-        url: window.location.origin + window.location.pathname + '/solutions',
-        data: solution
-      });
-      return $.ajax(request)
+      if(lastSubmissionFinishedSuccessfully() && sameAsLastSolution(solution)){
+        return $.Deferred().resolve(lastSubmission.result);
+      } else {
+        return sendNewSolution(solution);
+      }
     },
     runTests: function(content) {
       return this.runLocalTests({ solution: content });

data/app/assets/javascripts/application/kids.js

@@ -6,7 +6,7 @@ mumuki.load(function () {
 
     var gbsBoard = $('.mu-kids-state');
 
-    var dimension = gbsBoard.height() - margin * 2;
+    var dimension = gbsBoard.height() * 1.25 - fullMargin;
     gbsBoard.width(dimension);
 
     var $muKidsExercise = $('.mu-kids-exercise');
@@ -50,7 +50,7 @@ mumuki.load(function () {
   }
 
   var $speechTabs = $('.mu-kids-character-speech-bubble-tabs > li:not(.separator)');
-  var $bubble = $('.mu-kids-character-speech-bubble');
+  var $bubble = $('.mu-kids-character-speech-bubble').children('.mu-kids-character-speech-bubble-normal');
   var $texts = $bubble.children('.description, .hint');
 
   $speechTabs.each(function (i) {
@@ -91,19 +91,104 @@ mumuki.load(function () {
     if ($speechParagraphs.length - 1 === currentParagraphIndex) $nextSpeech.hide();
   }
 
-  mumuki.getKidsResultsModal = function () {
-    return $('#kids-results');
+  mumuki.kids = {
+
+    getResultsModal: function () {
+      return $('#kids-results');
+    },
+
+    getCharaterImage: function () {
+      return $('.mu-kids-character > img');
+    },
+
+    getCharacterBubble: function () {
+      return $('.mu-kids-character-speech-bubble');
+    },
+
+    getSubmissionResult: function () {
+      return $('.submission-results');
+    },
+
+    getOverlay: function () {
+      return $('.mu-kids-overlay');
+    },
+
+    showResult: function (data) {  // This function is called by the custom runner
+      mumuki.updateProgressBarAndShowModal(data);
+      if (data.guide_finished_by_solution) return;
+      mumuki.kids.resultAction[data.status](data);
+    },
+
+    restart: function () {  // This function is called by the custom runner
+      mumuki.kids._hideFailedMessage();
+      var $bubble = mumuki.kids.getCharacterBubble();
+      Object.keys(mumuki.kids.resultAction).forEach($bubble.removeClass.bind($bubble));
+      mumuki.kids.getCharaterImage().attr('src', '/anim_amarillo.svg');
+    },
+
+    _hideFailedMessage: function () {
+      var $bubble = mumuki.kids.getCharacterBubble();
+      $bubble.find('.mu-kids-character-speech-bubble-tabs').show();
+      $bubble.find('.mu-kids-character-speech-bubble-normal').show();
+      $bubble.find('.mu-kids-character-speech-bubble-failed').hide();
+      Object.keys(mumuki.kids.resultAction).forEach($bubble.removeClass.bind($bubble));
+      mumuki.kids.getOverlay().hide();
+    },
+
+    _showFailedMessage: function (data) {
+      var $bubble = mumuki.kids.getCharacterBubble();
+      $bubble.find('.mu-kids-character-speech-bubble-tabs').hide();
+      $bubble.find('.mu-kids-character-speech-bubble-normal').hide();
+      $bubble.find('.mu-kids-character-speech-bubble-failed').show().html(data.title_html);
+      $bubble.addClass(data.status);
+      mumuki.kids.getOverlay().show();
+    },
+
+    _showOnPopup: function (data) {
+      mumuki.kids.getSubmissionResult().html(data.html);
+      mumuki.kids.getCharaterImage().attr('src', '/amarillo_exito.svg');
+      mumuki.kids._showFailedMessage(data);
+      setTimeout(function () {
+        var results_kids_modal = mumuki.kids.getResultsModal();
+        if (results_kids_modal) {
+          results_kids_modal.modal({
+            backdrop: 'static',
+            keyboard: false
+          });
+          results_kids_modal.find('.modal-header').first().html(data.title_html);
+          results_kids_modal.find('.modal-footer').first().html(data.button_html);
+        }
+      }, 1000 * 4);
+    },
+
+    _showOnCharacterBubble: function (data) {
+      mumuki.kids.getCharaterImage().attr('src', '/amarillo_fracaso.svg');
+      mumuki.kids._showFailedMessage(data);
+    },
+
+    resultAction: {}
+
   };
 
   mumuki.showKidsResult = function (data) {
     mumuki.updateProgressBarAndShowModal(data);
     if (data.guide_finished_by_solution) return;
-    $(".submission-results").html(data.html);
+    mumuki.kids.getSubmissionResult().html(data.html);
 
-    var results_kids_modal = this.getKidsResultsModal();
+    var results_kids_modal = mumuki.kids.getResultsModal();
     if (results_kids_modal) {
       results_kids_modal.modal();
       results_kids_modal.find('.modal-header').first().html(data.title_html);
+      results_kids_modal.find('.modal-footer').first().html(data.button_html);
     }
-  }
+  };
+
+  mumuki.kids.resultAction.passed = mumuki.kids._showOnPopup;
+  mumuki.kids.resultAction.aborted = mumuki.kids._showOnPopup;
+  mumuki.kids.resultAction.passed_with_warnings = mumuki.kids._showOnPopup;
+
+  mumuki.kids.resultAction.failed = mumuki.kids._showOnCharacterBubble;
+  mumuki.kids.resultAction.errored = mumuki.kids._showOnCharacterBubble;
+  mumuki.kids.resultAction.pending = mumuki.kids._showOnCharacterBubble;
+
 });