Add filtering for remaining inventory (#25)

Author: biglovisa

CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Adds Sustainable Development Goals (SDGs) field to projects
-- Adds filtering to Projects on type, country
+- Adds filtering to Projects on type, country, minimum_available_mass
 
 ### Changed
 

README.md

@@ -145,6 +145,7 @@ When fetching Projects, you can add filters to the query to narrow the result. C
 
 - `country`
 - `type`
+- `minimumAvailableMass`
 
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
@@ -166,6 +167,10 @@ patch.projects.retrieveProjects({ country });
 // Retrieve a filtered list of projects
 const type = 'biomass'; // Pass in the project type you'd like to filter by
 patch.projects.retrieveProjects({ type });
+
+// Retrieve a filtered list of projects
+const minimumAvailableMass = 100; // Pass in the minimum available inventory the projects should have
+patch.projects.retrieveProjects({ minimumAvailableMass });
 ```
 
 ### Preferences

src/api/ProjectsApi.js

@@ -75,7 +75,9 @@ export default class ProjectsApi {
 
       country: opts['country'],
 
-      type: opts['type']
+      type: opts['type'],
+
+      minimum_available_mass: opts['minimumAvailableMass']
     };
     let headerParams = {};
     let formParams = {};

test/integration/preferences.test.js

@@ -30,7 +30,6 @@ describe('Preferences Integration', async function () {
       const createdPreference = await patch.preferences.createPreference({
         project_id: projectId
       });
-      console.log(createdPreference);
 
       expect(createdPreference.data.projectId).to.eq(projectId);
 

test/integration/projects.test.js

@@ -30,4 +30,14 @@ describe('Project Integration', function () {
       expect(project.type).to.equal(type);
     });
   });
+
+  it('supports fetching all projects with more than 100 grams of available inventory', async function () {
+    const minimumAvailableMass = 100;
+    const { data } = await patch.projects.retrieveProjects({
+      minimumAvailableMass
+    });
+    data.map((project) => {
+      expect(project.remaining_mass_g >= minimumAvailableMass).to.be.true;
+    });
+  });
 });