Merge pull request #1 from yllieth/upload-helper

yllieth · yllieth · commit 888c50bc70c0 · 2015-05-07T12:39:11.000+02:00
add uploadFileHelper
diff --git a/.jshintrc b/.jshintrc
@@ -19,6 +19,7 @@
   "trailing": true,
   "smarttabs": true,
   "globals": {
-    "angular": false
+    "angular": false,
+    "formFactory": true
   }
 }
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ angular.module('YourAngularApplication', ['predicsis.jsSDK'])
     predicsisAPIProvider.setBaseUrl('https://predicsis_api_host');
     predicsisAPIProvider.setOauthToken('4V83j2BWgcPONK8Xw8P7953yPvnTzz784V83j2BWgcPONK8Xw8P7953yPvnTzz78');
   })
-  
+
   .controller('ExampleCtrl', function(predicsisAPI) {
     var self = this;
     predicsisAPI.Datasets.all().then(function(datasetList) { self.datasets = datasetList; });
@@ -47,7 +47,7 @@ angular.module('YourAngularApplication', ['predicsis.jsSDK'])
   });
 ```
 
-Default values: 
+Default values:
 - api endpoint: `https://api.predicsis.com`
 - error handler: `throw Error(response);`
 - oauth access token: `no-token-defined`
@@ -79,13 +79,13 @@ return api.Datasets.getChildren(project.learning_dataset_id).then(function(child
       dataset_id: children.train.id
     });
   })
-  
+
   // create the model from preparation rules set
   .then(function(preparationRulesRet) {
     preparationRulesSet = preparationRulesRet
     return api.Models.createClassifier(preparationRulesRet.id);
   })
-  
+
   // generate reports
   .then(function(classifier) {
     classifier = classifier
@@ -95,7 +95,7 @@ return api.Datasets.getChildren(project.learning_dataset_id).then(function(child
       api.Reports.createUnivariateSupervisedReport(project)
     ]);
   })
-  
+
   //update project
   .then(function(reports) {
     return api.Projects.update(project.id, {
@@ -104,7 +104,7 @@ return api.Datasets.getChildren(project.learning_dataset_id).then(function(child
       report_ids: reportIds
     });
   })
-  
+
   //return classifier
   .then(function() {
     return classifier;
@@ -118,21 +118,42 @@ See the [SDK documentation](http://yllieth.github.io/predicsis_ml_sdk-javascript
 ## Available services
 API resources     | Helpers
 ------------------|---------
-Dataset           | 
-Dictionary        | 
-Jobs              | 
-Modality          | 
+Dataset           |
+Dictionary        |
+Jobs              |
+Modality          |
 Model             | Model helper
-Oauth token       | 
-Oauth application | 
-Preparation rules | 
+Oauth token       |
+Oauth application |
+Preparation rules |
 Project           | Project helper
-Report            | 
-Source            | 
-Upload            | 
-User              | 
-User settings     | 
-Variable          | 
+Report            |
+Source            |
+Upload            | S3 file helper
+User              |
+User settings     |
+Variable          |
+
+## Upload a file to S3
+
+```javascript
+//Get an HTML5 File instance
+fileInput.addEventListener('change', function(evt) {
+  var file = evt.target.files[0];
+  s3FileHelper
+    .upload(file, function progressHandler(event) {
+      //Update a progress bar using standard XMLHttpRequestProgressEvent
+    })
+    .then(function(params) {
+      //file successfully uploaded to s3
+      var filename = params.filename;
+      var key = params.key;//S3 key
+    })
+    .catch(function(err){
+
+    });
+});
+```
 
 ## Run this project locally
 
diff --git a/bower.json b/bower.json
@@ -2,7 +2,8 @@
   "name": "predicsis_ml_sdk-javascript",
   "version": "0.1.5",
   "authors": [
-    "Yllieth <sylvnimes@hotmail.com>"
+    "Yllieth <sylvnimes@hotmail.com>",
+    "Dehau"
   ],
   "description": "Javascript SDK for PredicSis ML API",
   "keywords": [
@@ -17,7 +18,8 @@
   "license": "MIT",
   "dependencies": {
     "angular": "1.3.14",
-    "restangular": "1.4.0"
+    "restangular": "1.4.0",
+    "formfactory": "~0.2.0"
   },
   "main": "dist/predicsis-jsSDK.js",
   "ignore": [
diff --git a/dist/predicsis-jsSDK.js b/dist/predicsis-jsSDK.js
@@ -58,6 +58,7 @@ angular.module('predicsis.jsSDK', ['restangular'])
         _restangular: Restangular,
         setOauthToken: function(token) {
           self.setOauthToken(token);
+          Restangular.setDefaultHeaders({ accept: 'application/json', Authorization: token });
         },
         setErrorHandler: function(handler) {
           self.setErrorHandler(handler);
@@ -771,7 +772,7 @@ angular.module('predicsis.jsSDK')
      * @return {Promise} New modalities set
      */
     this.create = function(params) {
-      return jobsHelper.wrapAsyncPromise(modalities().post({source: params}));
+      return jobsHelper.wrapAsyncPromise(modalities().post({modalities_set: params}));
     };
 
     /**
@@ -2774,13 +2775,13 @@ angular.module('predicsis.jsSDK')
      * </ul>
      */
     this.getCurrentState = function(project) {
-      if (project.scoreset_ids.length > 0) {
+      if (project.scoreset_ids && project.scoreset_ids.length) {
         //Scored files
         return {
           view: 'project.deploy-overview',
           properties: {projectId: project.id}
         };
-      } else if (project.scoring_dataset_ids.length > 0) {
+      } else if (project.scoring_dataset_ids && project.scoring_dataset_ids.length) {
         //Deploy
         return {
           view: 'project.format-score',
@@ -2983,3 +2984,61 @@ angular.module('predicsis.jsSDK')
         });
     };
   });
+
+/**
+ * @ngdoc service
+ * @name predicsis.jsSDK.s3FileHelper
+ * @require $injector
+ */
+angular.module('predicsis.jsSDK')
+  .service('s3FileHelper', function($injector) {
+    'use strict';
+
+    var Upload = $injector.get('Uploads');
+    var $q = $injector.get('$q');
+
+    /**
+     * @ngdoc function
+     * @methodOf predicsis.jsSDK.s3FileHelper
+     * @name upload
+     * @description upload a file to S3
+     *
+     * @param {Object} file html5 File instance
+     * @return {Promise}
+     */
+    this.upload = function(file, progressHandler) {
+      var deferred = $q.defer();
+      Upload.getCredentials('s3')
+        .then(function(credential) {
+          var key = credential.key.replace('${filename}', file.name);
+          var form = formFactory({
+            key: key,
+            AWSAccessKeyId: credential.aws_access_key_id,
+            'Content-Type': 'multipart/form-data',
+            success_action_status: 201,
+            acl: 'private',
+            policy: credential.policy,
+            signature: credential.signature
+          }, {
+            file: file
+          });
+          var xhr2 = new XMLHttpRequest();
+          xhr2.open('POST', credential.s3_endpoint, true);
+          if(progressHandler) {
+            xhr2.upload.addEventListener('progress', progressHandler);
+          }
+          xhr2.addEventListener('load', function() {
+            if(xhr2.status === 201) {
+              deferred.resolve({filename: file.name, key: key});
+            } else {
+              deferred.reject({status: xhr2.status, err: xhr2.responseText});
+            }
+          });
+          xhr2.addEventListener('error', function(err) {
+            deferred.reject(err);
+          });
+          xhr2.send(form);
+        });
+        return deferred.promise;
+    };
+  });
diff --git a/dist/predicsis-jsSDK.min.js b/dist/predicsis-jsSDK.min.js
diff --git a/dist/predicsis-jsSDK.min.js.map b/dist/predicsis-jsSDK.min.js.map
diff --git a/lib/helper/projectsHelper.js b/lib/helper/projectsHelper.js
@@ -63,13 +63,13 @@ angular.module('predicsis.jsSDK')
      * </ul>
      */
     this.getCurrentState = function(project) {
-      if (project.scoreset_ids.length > 0) {
+      if (project.scoreset_ids && project.scoreset_ids.length) {
         //Scored files
         return {
           view: 'project.deploy-overview',
           properties: {projectId: project.id}
         };
-      } else if (project.scoring_dataset_ids.length > 0) {
+      } else if (project.scoring_dataset_ids && project.scoring_dataset_ids.length) {
         //Deploy
         return {
           view: 'project.format-score',
diff --git a/lib/helper/s3FileHelper.js b/lib/helper/s3FileHelper.js
@@ -0,0 +1,57 @@
+/**
+ * @ngdoc service
+ * @name predicsis.jsSDK.s3FileHelper
+ * @require $injector
+ */
+angular.module('predicsis.jsSDK')
+  .service('s3FileHelper', function($injector) {
+    'use strict';
+
+    var Upload = $injector.get('Uploads');
+    var $q = $injector.get('$q');
+
+    /**
+     * @ngdoc function
+     * @methodOf predicsis.jsSDK.s3FileHelper
+     * @name upload
+     * @description upload a file to S3
+     *
+     * @param {Object} file html5 File instance
+     * @return {Promise}
+     */
+    this.upload = function(file, progressHandler) {
+      var deferred = $q.defer();
+      Upload.getCredentials('s3')
+        .then(function(credential) {
+          var key = credential.key.replace('${filename}', file.name);
+          var form = formFactory({
+            key: key,
+            AWSAccessKeyId: credential.aws_access_key_id,
+            'Content-Type': 'multipart/form-data',
+            success_action_status: 201,
+            acl: 'private',
+            policy: credential.policy,
+            signature: credential.signature
+          }, {
+            file: file
+          });
+          var xhr2 = new XMLHttpRequest();
+          xhr2.open('POST', credential.s3_endpoint, true);
+          if(progressHandler) {
+            xhr2.upload.addEventListener('progress', progressHandler);
+          }
+          xhr2.addEventListener('load', function() {
+            if(xhr2.status === 201) {
+              deferred.resolve({filename: file.name, key: key});
+            } else {
+              deferred.reject({status: xhr2.status, err: xhr2.responseText});
+            }
+          });
+          xhr2.addEventListener('error', function(err) {
+            deferred.reject(err);
+          });
+          xhr2.send(form);
+        });
+        return deferred.promise;
+    };
+  });
diff --git a/lib/model/Modalities.js b/lib/model/Modalities.js
@@ -60,7 +60,7 @@ angular.module('predicsis.jsSDK')
      * @return {Promise} New modalities set
      */
     this.create = function(params) {
-      return jobsHelper.wrapAsyncPromise(modalities().post({source: params}));
+      return jobsHelper.wrapAsyncPromise(modalities().post({modalities_set: params}));
     };
 
     /**
diff --git a/lib/predicsis-jsSDK.js b/lib/predicsis-jsSDK.js
@@ -58,6 +58,7 @@ angular.module('predicsis.jsSDK', ['restangular'])
         _restangular: Restangular,
         setOauthToken: function(token) {
           self.setOauthToken(token);
+          Restangular.setDefaultHeaders({ accept: 'application/json', Authorization: token });
         },
         setErrorHandler: function(handler) {
           self.setErrorHandler(handler);

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"trailing": true,`
`20`	`20`	`"smarttabs": true,`
`21`	`21`	`"globals": {`
`22`		`- "angular": false`
	`22`	`+ "angular": false,`
	`23`	`+ "formFactory": true`
`23`	`24`	`}`
`24`	`25`	`}`