Started work on data script upload support, added MIT License

Author: kk415kk

api/controllers/AnalyticController.js

@@ -38,6 +38,7 @@ var UPLOAD_PATH = sails.config.paths.UPLOAD_PATH,
     STORED_SCAFFOLDS_PATH = sails.config.paths.STORED_SCAFFOLDS_PATH,
     ANALYTICS_ASSETS_PATH = sails.config.paths.ANALYTICS_ASSETS_PATH,
     ANALYTICS_REWRITE_PATH = sails.config.paths.ANALYTICS_REWRITE_PATH,
+    ANALYTICS_DATA_SCRIPTS_PATH = sails.config.paths.ANALYTICS_SCRIPT_PATH,
     MAIN_FILE = 'main.html',
     ARCHIVE_TYPES = ['zip'];
 
@@ -149,6 +150,8 @@ function linkAssets(html, type, userID, analyticID) {
       }
     }
   }
+
+  // TODO: Parse and remove common classes, such as "container" or "wrapper" or "banner"
   return $.html();
 }
 
@@ -248,6 +251,11 @@ function scaffoldAnalytics(pathToFile, type, fileName, userID, analyticID, next)
   }
 }
 
+// TODO
+function moveDataScripts(pathToExtractedFile, moveToFolder) {
+  // Move the "preprocessing" folder to "moveToFolder"
+}
+
 module.exports = {
 
   /**
@@ -256,7 +264,7 @@ module.exports = {
    */
   _config: {},
 
-  // Approve a analytic
+  // Approve an analytic module
   approve: function(req, res) {
     Analytic.findOne(req.param('id')).populate('owner').exec(function (err, analytic) {
       if (err) {
@@ -283,6 +291,10 @@ module.exports = {
       }
 
       var pathToExtractedFile = path.join(EXTRACT_PATH, type, userID, noExtFileName);
+
+      // TODO: Move data scripts to run, include a README for data scripts
+      //moveDataScripts(pathToExtractedFile, ANALYTICS_DATA_SCRIPTS_PATH)
+
       scaffoldAnalytics(pathToExtractedFile, type, MAIN_FILE, userID, analytic.id, function (err, success) {
         if (success) {
           sails.log('Success during scaffold');

api/controllers/HomeController.js

@@ -55,6 +55,12 @@ module.exports = {
     })
   },
 
+  license: function(req, res) {
+    res.view({
+      title: 'MIT License'
+    })
+  },
+
   contact: function(req, res) {
     res.view({
       title: 'Contact'

bin/setup/setup.sh

@@ -12,15 +12,18 @@ echo ""
 SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 DATASET_FOLDERS=( "encrypted" "extracted" "available" "available/non_pii" "available/pii" )
-ANALYTIC_FOLDERS=(tmp archives)
+ANALYTIC_FOLDERS=("tmp" "archives")
 LOG_FILES=(production.log development.log)
+DATA_SCRIPTS=( "analytics" )
 
 DATABASE_SETUP=db_setup.sql
 
 ERRORS=0
 
 for folder in "${DATASET_FOLDERS[@]}"; do CREATE="$SCRIPT_PATH/../../../datasets/${folder}"; echo "[x] Creating $CREATE"; mkdir -p "$CREATE"; done
 for folder in "${ANALYTIC_FOLDERS[@]}"; do CREATE="$SCRIPT_PATH/../../../analytics/${folder}"; echo "[x] Creating $CREATE"; mkdir -p "$CREATE"; done
+for folder in "${DATA_SCRIPTS[@]}"; do CREATE="$SCRIPT_PATH/../../../data_scripts/${folder}"; echo "[x] Creating $CREATE"; mkdir -p "$CREATE"; done
+
 
 mkdir -p "$SCRIPT_PATH/../../logs"
 

config/paths.js

@@ -7,6 +7,9 @@ module.exports.paths = {
     EXTRACT_PATH: path.resolve('..', 'analytics', 'tmp'),
     PUBLIC_SHARE_PATH: path.resolve('views', 'analyticdisplay', 'share'),
 
+    // Data scripts
+    ANALYTICS_SCRIPTS_PATH: path.resolve('..', 'data_scripts', 'analytics'),
+
     // Stored Scaffolds Folder
     STORED_SCAFFOLDS_PATH: path.resolve('assets', 'scaffolds'),
 

config/routes.js

@@ -52,6 +52,11 @@ module.exports.routes = {
     action: 'privacy'
   },
 
+  '/license': {
+    controller: 'home',
+    action: 'license'
+  },
+
   '/contact': {
     controller: 'home',
     action: 'contact'

views/home/license.ejs

@@ -0,0 +1,39 @@
+<div class="mini-banner auto">
+  <div class="container">
+    <h2>License</h2>
+  </div>
+</div>
+<div class="sub-banner">
+  <div class="container">
+    <h2>MIT License</h2>
+  </div>
+</div>
+<div class="container wrapper">
+  <p>
+    The MIT License (MIT)
+  </p>
+  <p>
+    Copyright (c) 2014-2015 moocRP.
+  </p>
+  <p>
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+  </p>
+  <p>
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+  </p>
+  <p>
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.
+  </p>
+</div>

views/layout.ejs

@@ -123,7 +123,7 @@
           <p>Find a bug? Report it <a href="/contact">here</a>!</p>
         </div>
         <div class="pull-right">
-          <div>MIT License - <a href="/tos">Terms of Use</a> - <a href="/privacy">Privacy Policy</a> - <a href="/contact">Contact</a></div>
+          <div><a href="/license">MIT License</a> - <a href="/tos">Terms of Use</a> - <a href="/privacy">Privacy Policy</a> - <a href="/contact">Contact</a></div>
         </div>
         <br>
         <div class="pull-right">