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

Filter Projects

Author: biglovisa

CHANGELOG.md

@@ -10,6 +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
 
 ### Changed
 

README.md

@@ -144,6 +144,11 @@ Patch::Estimate.retrieve_estimates(page: page)
 ### Projects
 Projects are the ways Patch takes CO2 out of the air. They can represent reforestation, enhanced weathering, direct air carbon capture, etc. When you place an order via Patch, it is allocated to a project.
 
+When fetching Projects, you can add filters to the query to narrow the result. Currently supported filters are:
+
+- `country`
+- `type`
+
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
 #### Examples
@@ -155,6 +160,14 @@ Patch::Project.retrieve_project(project_id)
 # Retrieve a list of projects
 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
+Patch::Project.retrieve_projects(country: country)
+
+# Retrieve a all biomass projects
+type = 'biomass' # Pass in the type of Projects you'd like to get
+Patch::Project.retrieve_projects(type: type)
 ```
 
 ### Preferences

lib/patch_ruby/api/projects_api.rb

@@ -90,6 +90,8 @@ def retrieve_project_with_http_info(id, opts = {})
     # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
@@ -100,6 +102,8 @@ def retrieve_projects(opts = {})
     # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
     # @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
@@ -111,6 +115,8 @@ def retrieve_projects_with_http_info(opts = {})
       # query parameters
       query_params = opts[:query_params] || {}
       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?
 
       # header parameters
       header_params = opts[:header_params] || {}

spec/integration/projects_spec.rb

@@ -22,6 +22,20 @@
     expect(retrieve_project_response.data.id).to eq project_id
   end
 
+  it 'supports filtering projects' do
+    country = 'US'
+    projects = Patch::Project.retrieve_projects(country: country)
+    projects.data.map do |project|
+      expect(project.country).to eq country
+    end
+
+    type = 'dac'
+    projects = Patch::Project.retrieve_projects(type: type)
+    projects.data.map do |project|
+      expect(project.type).to eq type
+    end
+  end
+
   describe 'returned fields' do
     before do
       @project = Patch::Project.retrieve_projects(page: 1).data.first