separate models and helpers in two separate modules (and add some documentation on job helper)

Author: yllieth

dist/predicsis-jsSDK.js

@@ -0,0 +1,34 @@
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/jobsHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/jobsHelper.js#L25" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">jobsHelper</code>
+<div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
+</span>
+</div>
+</h1>
+<div><div class="member method"><h2 id="methods">Methods</h2>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/jobsHelper.js#L47" class="view-source icon-eye-open"> </a><h3 id="methods_listen">listen(jobId)</h3>
+<div class="listen"><div class="listen-page"><p>Active pulling on a job waiting for its termination</p>
+<p><b>Important notes:</b></p>
+<ul>
+  <li>You can <em>listen</em>only one job at a time</li>
+  <li>a <kbd>GET /jobs/:jobId</kbd> is going to be sent every 3 second the first minute, and every minute after</li>
+</ul></div><h5 id="methods_listen_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>jobId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="listen-page"><p>The id of the job api resource you want to wait termination</p>
+</div></td></tr></tbody></table><h5 id="methods_listen_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-promise">Promise</a></td><td><div class="listen-page"><p>A promise resolved only when the job succeeds</p>
+</div></td></tr></table></div>
+</li>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/jobsHelper.js#L120" class="view-source icon-eye-open"> </a><h3 id="methods_wrapasyncpromise">wrapAsyncPromise(promise)</h3>
+<div class="wrapasyncpromise"><div class="wrapasyncpromise-page"><p>Transform an async promise into the same promise resolving only when job is completed</p>
+<p>Usage example:
+<pre class="prettyprint linenums">
+return jobsHelper
+  .wrapAsyncPromise(datasets().post({dataset: params}))
+  .then(function(dataset) {
+    // do something with you completely created new dataset
+    // ...
+  });
+</pre>
+</div><h5 id="methods_wrapasyncpromise_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>promise</td><td><a href="" class="label type-hint type-hint-promise">Promise</a><a href="" class="label type-hint type-hint-array">Array</a></td><td><div class="wrapasyncpromise-page"><p>or list of jobs (the last one will be listened)</p>
+</div></td></tr></tbody></table><h5 id="methods_wrapasyncpromise_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-promise">Promise</a></td><td><div class="wrapasyncpromise-page"><p>See above example</p>
+</div></td></tr></table></div>
+</li>
+</ul>
+</div>
+</div>

dist/predicsis-jsSDK.min.js

@@ -1,23 +1,23 @@
-<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/modelHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/modelHelper.js#L13" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">modelHelper</code>
-<div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK</code>
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/modelHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/modelHelper.js#L13" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">modelHelper</code>
+<div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
 </h1>
 <div><h2 id="dependencies">Dependencies</h2>
 <ul class="dependencies"><li><code ng:non-bindable=""><a href="#/api/ng.$injector">$injector</a></code>
-<div class="predicsis-jssdk-modelhelper-page"><ul>
-<li><a href="#/api/predicsis.jsSDK.Datasets">Datasets</a></li>
-<li><a href="#/api/predicsis.jsSDK.Models">Models</a></li>
-<li><a href="#/api/predicsis.jsSDK.Reports">Reports</a></li>
-<li><a href="#/api/predicsis.jsSDK.Projects">Projects</a></li>
-<li><a href="#/api/predicsis.jsSDK.PreparationRules">PreparationRules</a></li>
+<div class="predicsis-jssdk-helpers-modelhelper-page"><ul>
+<li><a href="#/api/predicsis.jsSDK.models.Datasets">Datasets</a></li>
+<li><a href="#/api/predicsis.jsSDK.models.Models">Models</a></li>
+<li><a href="#/api/predicsis.jsSDK.models.Reports">Reports</a></li>
+<li><a href="#/api/predicsis.jsSDK.models.Projects">Projects</a></li>
+<li><a href="#/api/predicsis.jsSDK.models.PreparationRules">PreparationRules</a></li>
 <li>$q</li>
 <li>$rootScope</li>
 </ul>
 </div></li>
 </ul>
 <div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/modelHelper.js#L61" class="view-source icon-eye-open"> </a><h3 id="methods_learn">learn(project)</h3>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/modelHelper.js#L62" class="view-source icon-eye-open"> </a><h3 id="methods_learn">learn(project)</h3>
 <div class="learn"><div class="learn-page"><p>Learn a model</p>
 <p>This function wraps the following requests:</p>
 <ul>
@@ -36,7 +36,7 @@
 <p>To do so, what we really use are the following parameters:</p>
 <ul>
   <li><kbd>project.learning_dataset_id</kbd> to find the training partition of the input dataset</li>
-  <li><kbd>project.target_variable_id</kbd> to create a valid <a href="#/api/predicsis.jsSDK.PreparationRules">PreparationRules</a></li>
+  <li><kbd>project.target_variable_id</kbd> to create a valid <a href="#/api/predicsis.jsSDK.models.PreparationRules">PreparationRules</a></li>
   <li><kbd>project.id</kbd> to store preparation rules set, classifier and reports ids.</li>
 </ul>
 
@@ -50,8 +50,8 @@
   <li>jsSDK.learn.start-learning</li>
   <li>jsSDK.learn.start-generating-reports</li>
   <li>jsSDK.learn.start-updating-project</li>
-</ul></div><h5 id="methods_learn_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>project</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="learn-page"><p>Instance of a valid <a href="#/api/predicsis.jsSDK.Projects">Project</a></p>
-</div></td></tr></tbody></table><h5 id="methods_learn_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="learn-page"><p>Instance of a complete <a href="#/api/predicsis.jsSDK.Models">Models</a></p>
+</ul></div><h5 id="methods_learn_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>project</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="learn-page"><p>Instance of a valid <a href="#/api/predicsis.jsSDK.models.Projects">Project</a></p>
+</div></td></tr></tbody></table><h5 id="methods_learn_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="learn-page"><p>Instance of a complete <a href="#/api/predicsis.jsSDK.models.Models">Models</a></p>
 </div></td></tr></table></div>
 </li>
 </ul>

dist/predicsis-jsSDK.min.js.map

@@ -1,42 +1,42 @@
-<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/projectsHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L6" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">projectsHelper</code>
-<div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK</code>
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/projectsHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L6" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">projectsHelper</code>
+<div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
 </h1>
 <div><div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L61" class="view-source icon-eye-open"> </a><h3 id="methods_addlearningdataset">addLearningDataset(project, datasetId)</h3>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L62" class="view-source icon-eye-open"> </a><h3 id="methods_addlearningdataset">addLearningDataset(project, datasetId)</h3>
 <div class="addlearningdataset"><div class="addlearningdataset-page"><p>Simply adds an entry to <code>learning_dataset_id</code> project&#39;s property.</p>
 <p><span class="badge patch">patch</span><code>/projects/:projectId</code></p>
 </div><h5 id="methods_addlearningdataset_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>project</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="addlearningdataset-page"><p><a href="#/api/API.model.Projects">Projects model</a></p>
 </div></td></tr><tr><td>datasetId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="addlearningdataset-page"><p>Id of the dataset which will be used for learning</p>
 </div></td></tr></tbody></table><h5 id="methods_addlearningdataset_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="addlearningdataset-page"><p>Promise of an updated project</p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L96" class="view-source icon-eye-open"> </a><h3 id="methods_addscoreset">addScoreset(project, datasetId)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L97" class="view-source icon-eye-open"> </a><h3 id="methods_addscoreset">addScoreset(project, datasetId)</h3>
 <div class="addscoreset"><div class="addscoreset-page"><p>Simply adds an entry to <code>scoreset_ids</code> project&#39;s array.</p>
 <p><span class="badge patch">patch</span><code>/projects/:projectId</code></p>
 </div><h5 id="methods_addscoreset_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>project</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="addscoreset-page"><p><a href="#/api/API.model.Projects">Projects model</a></p>
 </div></td></tr><tr><td>datasetId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="addscoreset-page"><p>Id of the dataset which will store score results</p>
 </div></td></tr></tbody></table><h5 id="methods_addscoreset_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="addscoreset-page"><p>Promise of an updated project</p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L77" class="view-source icon-eye-open"> </a><h3 id="methods_addscoringdataset">addScoringDataset(project, datasetId)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L78" class="view-source icon-eye-open"> </a><h3 id="methods_addscoringdataset">addScoringDataset(project, datasetId)</h3>
 <div class="addscoringdataset"><div class="addscoringdataset-page"><p>Simply adds an entry to <code>scoring_dataset_ids</code> project&#39;s array.</p>
 <p><span class="badge patch">patch</span><code>/projects/:projectId</code></p>
 </div><h5 id="methods_addscoringdataset_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>project</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="addscoringdataset-page"><p><a href="#/api/API.model.Projects">Projects model</a></p>
 </div></td></tr><tr><td>datasetId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="addscoringdataset-page"><p>Id of the dataset which will be used for score</p>
 </div></td></tr></tbody></table><h5 id="methods_addscoringdataset_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="addscoringdataset-page"><p>Promise of an updated project</p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L43" class="view-source icon-eye-open"> </a><h3 id="methods_isdictionaryverified">isDictionaryVerified(project)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L44" class="view-source icon-eye-open"> </a><h3 id="methods_isdictionaryverified">isDictionaryVerified(project)</h3>
 <div class="isdictionaryverified"><div class="isdictionaryverified-page"><p>Tells if the user checked its project&#39;s dictionary.</p>
 <p> A dictionary contains a description of each variable used (or unused) of the model. That&#39;s why scenario forces
  the user to check generated dictionaries.</p>
 </div><h5 id="methods_isdictionaryverified_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>project</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="isdictionaryverified-page"><p><a href="#/api/API.model.Projects">Projects model</a></p>
 </div></td></tr></tbody></table><h5 id="methods_isdictionaryverified_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">boolean</a></td><td><div class="isdictionaryverified-page"><p><code>true</code> / <code>false</code></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L27" class="view-source icon-eye-open"> </a><h3 id="methods_ismodeldone">isModelDone(project)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L28" class="view-source icon-eye-open"> </a><h3 id="methods_ismodeldone">isModelDone(project)</h3>
 <div class="ismodeldone"><div class="ismodeldone-page"><p>Tells if there is a model for the given project.</p>
 <p> <b>Note:</b> A project can have only one Model. It means that you can go back to the first steps of the scenario
  if your current project already has a model attached. If you want to change a parameter, you have to create a new
@@ -45,15 +45,15 @@
 </div></td></tr></tbody></table><h5 id="methods_ismodeldone_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-boolean">boolean</a></td><td><div class="ismodeldone-page"><p><code>true</code> / <code>false</code></p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L143" class="view-source icon-eye-open"> </a><h3 id="methods_removedependencies">removeDependencies(projectId)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L144" class="view-source icon-eye-open"> </a><h3 id="methods_removedependencies">removeDependencies(projectId)</h3>
 <div class="removedependencies"><div class="removedependencies-page"><p>Removes linked resources prior to being able to remove the project</p>
 <div><span class="badge get">get</span><code>/projects/:projectId</code></div>
 <div><span class="badge delete">delete</span><code>/dictionaries/:project.dictionary_id</code></div>
 <div><span class="badge delete">delete</span><code>/model/:project.classifier_id</code></div></div><h5 id="methods_removedependencies_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>projectId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="removedependencies-page"><p>Id of the project you want to update</p>
 </div></td></tr></tbody></table><h5 id="methods_removedependencies_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="removedependencies-page"><p>Promise of an updated project</p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/ce774c5/lib/helper/projectsHelper.js#L121" class="view-source icon-eye-open"> </a><h3 id="methods_resetdictionary">resetDictionary(projectId)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/95d5aca/lib/helper/projectsHelper.js#L122" class="view-source icon-eye-open"> </a><h3 id="methods_resetdictionary">resetDictionary(projectId)</h3>
 <div class="resetdictionary"><div class="resetdictionary-page"><p>Simply set to <code>null</code> the following project&#39;s properties:</p>
 <ul>
   <li><code>dictionary_id</code></li>