Adds highlights to projects response (#51)

* Adds highlights to projects response

* update a to an

* Use docker for build stage

* Tweak

* Reran make build after merging in pc/docker branch

* Add icon_url

Co-authored-by: Paul Cothenet <[email protected]>

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.15.2] - 2021-11-08
+
+### Added
+
+- Adds highlights to project responses
+
 ## [1.15.1] - 2021-11-04
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "1.15.1",
+  "version": "1.15.2",
   "description": "Node.js wrapper for the Patch API",
   "license": "MIT",
   "repository": {

src/ApiClient.js

@@ -16,7 +16,7 @@ class ApiClient {
     };
 
     this.defaultHeaders = {
-      'User-Agent': 'patch-node/1.15.1'
+      'User-Agent': 'patch-node/1.15.2'
     };
 
     /**

src/model/Highlight.js

@@ -0,0 +1,47 @@
+/**
+ * Patch API V1
+ * The core API used to integrate with Patch's service
+ *
+ * Contact: [email protected]
+ */
+
+import ApiClient from '../ApiClient';
+
+class Highlight {
+  constructor(slug, title, iconUrl) {
+    Highlight.initialize(this, slug, title, iconUrl);
+  }
+
+  static initialize(obj, slug, title, iconUrl) {
+    obj['slug'] = slug;
+    obj['title'] = title;
+    obj['icon_url'] = iconUrl;
+  }
+
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new Highlight();
+
+      if (data.hasOwnProperty('slug')) {
+        obj['slug'] = ApiClient.convertToType(data['slug'], 'String');
+      }
+
+      if (data.hasOwnProperty('title')) {
+        obj['title'] = ApiClient.convertToType(data['title'], 'String');
+      }
+
+      if (data.hasOwnProperty('icon_url')) {
+        obj['icon_url'] = ApiClient.convertToType(data['icon_url'], 'String');
+      }
+    }
+    return obj;
+  }
+}
+
+Highlight.prototype['slug'] = undefined;
+
+Highlight.prototype['title'] = undefined;
+
+Highlight.prototype['icon_url'] = undefined;
+
+export default Highlight;

src/model/Project.js

@@ -6,6 +6,7 @@
  */
 
 import ApiClient from '../ApiClient';
+import Highlight from './Highlight';
 import Photo from './Photo';
 import Sdg from './Sdg';
 import Standard from './Standard';
@@ -21,7 +22,8 @@ class Project {
     developer,
     averagePricePerTonneCentsUsd,
     remainingMassG,
-    technologyType
+    technologyType,
+    highlights
   ) {
     Project.initialize(
       this,
@@ -33,7 +35,8 @@ class Project {
       developer,
       averagePricePerTonneCentsUsd,
       remainingMassG,
-      technologyType
+      technologyType,
+      highlights
     );
   }
 
@@ -47,7 +50,8 @@ class Project {
     developer,
     averagePricePerTonneCentsUsd,
     remainingMassG,
-    technologyType
+    technologyType,
+    highlights
   ) {
     obj['id'] = id;
     obj['production'] = production;
@@ -58,6 +62,7 @@ class Project {
     obj['average_price_per_tonne_cents_usd'] = averagePricePerTonneCentsUsd;
     obj['remaining_mass_g'] = remainingMassG;
     obj['technology_type'] = technologyType;
+    obj['highlights'] = highlights;
   }
 
   static constructFromObject(data, obj) {
@@ -153,6 +158,12 @@ class Project {
           data['technology_type']
         );
       }
+
+      if (data.hasOwnProperty('highlights')) {
+        obj['highlights'] = ApiClient.convertToType(data['highlights'], [
+          Highlight
+        ]);
+      }
     }
     return obj;
   }
@@ -196,4 +207,6 @@ Project.prototype['tagline'] = undefined;
 
 Project.prototype['technology_type'] = undefined;
 
+Project.prototype['highlights'] = undefined;
+
 export default Project;

test/integration/projects.test.js

@@ -20,6 +20,7 @@ describe('Project Integration', function () {
     expect(projectResponse.data.mechanism).to.be.a('string');
     expect(projectResponse.data.latitude).to.be.a('number');
     expect(projectResponse.data.longitude).to.be.a('number');
+    expect(projectResponse.data.highlights).to.be.an('array');
 
     const technology_type = projectResponse.data.technology_type;
     expect(technology_type.slug).to.be.a('string');