Merge pull request #25 from patch-technology/lovisa/filter-projects

Filter Projects by remaining inventory

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 by country, type
+- Adds filtering to Projects by country, type, minimum_available_mass
 
 ### Changed
 

README.md

@@ -148,6 +148,7 @@ When fetching Projects, you can add filters to the query to narrow the result. C
 
 - `country`
 - `type`
+- `minimum_available_mass`
 
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
@@ -161,13 +162,17 @@ Patch::Project.retrieve_project(project_id)
 page = 1 # Pass in which page of projects you'd like
 Patch::Project.retrieve_projects(page: page)
 
-# Retrieve a all projects from the United States
-country = 'US' # Pass in the country code of the country you'd like to get Projects from
+# Retrieve all projects from the United States
+country = 'US'
 Patch::Project.retrieve_projects(country: country)
 
-# Retrieve a all biomass projects
-type = 'biomass' # Pass in the type of Projects you'd like to get
+# Retrieve all biomass projects
+type = 'biomass'
 Patch::Project.retrieve_projects(type: type)
+
+# Retrieve a list of projects with at least 100 grams of available offsets
+minimum_available_mass = 100
+Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
 ```
 
 ### Preferences

lib/patch_ruby/api/projects_api.rb

@@ -92,6 +92,7 @@ def retrieve_project_with_http_info(id, opts = {})
     # @option opts [Integer] :page 
     # @option opts [String] :country 
     # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
@@ -104,6 +105,7 @@ def retrieve_projects(opts = {})
     # @option opts [Integer] :page 
     # @option opts [String] :country 
     # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @return [Array<(ProjectListResponse, Integer, Hash)>] ProjectListResponse data, response status code and response headers
     def retrieve_projects_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -117,6 +119,7 @@ def retrieve_projects_with_http_info(opts = {})
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
       query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'minimum_available_mass'] = opts[:'minimum_available_mass'] if !opts[:'minimum_available_mass'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

spec/integration/projects_spec.rb

@@ -34,6 +34,12 @@
     projects.data.map do |project|
       expect(project.type).to eq type
     end
+
+    minimum_available_mass = 100
+    projects = Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
+    projects.data.map do |project|
+      expect(project.remaining_mass_g >= minimum_available_mass).to be true
+    end
   end
 
   describe 'returned fields' do