Merge pull request #113 from renderforest/implement-GET-project-API

implement GET project API

Author: AlbertHambardzumyan

README.md

@@ -140,6 +140,24 @@ Renderforest.getTrialProject(payload)
 [See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/examples/projects/get-trial-project.js)
 
 
+### Get a Specific Project
+
+Gets a specific project.
+```js
+const Renderforest = require('@renderforest/sdk-node')
+
+const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
+
+const payload = {
+  projectId: 5000295
+}
+renderforest.getProject(payload)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/examples/projects/get-project.js)
+
+
 ### Update the Project - partial update
 
 Updates the project (partial update).

examples/projects/apply-template-preset-on-project.js

@@ -11,7 +11,7 @@ const Renderforest = require('../../src/lib/renderforest')
 const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
-  projectId: 6154178,
+  projectId: 5000658,
   presetId: 55
 }
 renderforest.applyTemplatePresetOnProject(payload)

examples/projects/delete-project.js

@@ -11,7 +11,7 @@ const Renderforest = require('../../src/lib/renderforest')
 const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
-  projectId: 6154178
+  projectId: 5000658
 }
 renderforest.deleteProject(payload)
   .then(console.log) // handle the success

examples/projects/duplicate-project.js

@@ -11,7 +11,7 @@ const Renderforest = require('../../src/lib/renderforest')
 const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
-  projectId: 6154178
+  projectId: 5000658
 }
 renderforest.duplicateProject(payload)
   .then(console.log) // handle the success

examples/projects/get-project.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2018-present, Renderforest, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory.
+ */
+
+const Renderforest = require('../../src/lib/renderforest')
+
+const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
+
+const payload = {
+  projectId: 5000295
+}
+renderforest.getProject(payload)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error

examples/projects/render-project.js

@@ -11,8 +11,8 @@ const Renderforest = require('../../src/lib/renderforest')
 const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
-  projectId: 7015342,
-  quality: 0
+  projectId: 5000658,
+  quality: 1080
 }
 renderforest.renderProject(payload)
   .then(console.log) // handle the success

examples/projects/update-project-partial.js

@@ -11,7 +11,7 @@ const Renderforest = require('../../src/lib/renderforest')
 const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
-  projectId: 6154178,
+  projectId: 5000658,
   customTitle: 'Graduation'
 }
 renderforest.updateProjectPartial(payload)

package.json

@@ -10,6 +10,10 @@
     {
       "name": "Albert Hambardzumyan",
       "email": "hambardzumyan.albert@gmail.com"
+    },
+    {
+      "name": "Anahit Vardanyan",
+      "email": "vardanian.anahit@gmail.com"
     }
   ],
   "dependencies": {

src/lib/renderforest.js

@@ -71,6 +71,15 @@ class Renderforest {
     return Projects.getTrialProject(payload)
   }
 
+  /**
+   * @param {Object} payload
+   * @returns {Promise.<Object>}
+   * @description Get a Specific Project.
+   */
+  getProject (payload) {
+    return Projects.getProject(payload)
+  }
+
   /**
    * @param {Object} payload
    * @returns {Promise.<Object>}

src/lib/resources/projects.js

@@ -57,6 +57,20 @@ class Projects {
     return Http.unauthorizedRequest(options)
   }
 
+  /**
+   * @param {Object} payload
+   * @returns {Promise.<Object>}
+   * @description Get a Specific Project.
+   */
+  static getProject (payload) {
+    const projectId = Params.destructURLParam(payload, 'projectId')
+
+    const options = {
+      endpoint: `${Projects.API_PREFIX}/projects/${projectId}`
+    }
+    return Http.authorizedRequest(options)
+  }
+
   /**
    * @param {Object} payload
    * @returns {Promise.<Object>}