extends the projects REST API to support the contains parameter #87

- https://<redmine>/projects.[xml|json]?contains=POINT(135.264123%2034.684302)

Author: jkraemer

lib/redmine_gtt/patches/projects_controller_patch.rb

@@ -6,6 +6,22 @@ def self.apply
         ProjectsController.prepend self unless ProjectsController < self
       end
 
+      # overrides index action to add spatial filtering to projects API listing
+      def index
+        respond_to do |format|
+          format.api {
+            scope = RedmineGtt::SpatialProjectsQuery.new(
+              contains: params[:contains],
+              projects: Project.visible.sorted
+            ).scope
+            @project_count = scope.count
+            @offset, @limit = api_offset_and_limit
+            @projects = scope.offset(@offset).limit(@limit).to_a
+          }
+          format.any { super }
+        end
+      end
+
       def show
         respond_to do |format|
           format.geojson { send_data(

lib/redmine_gtt/spatial_projects_query.rb

@@ -0,0 +1,24 @@
+module RedmineGtt
+  class SpatialProjectsQuery
+    def initialize(contains: nil, projects: Project.active.visible)
+      @contains = contains.presence
+      @projects = projects
+    end
+
+    QUERY_SQL = (<<-SQL
+      #{Project.table_name}.geom IS NOT NULL AND
+      ST_Intersects(#{Project.table_name}.geom, ST_GeomFromText('%s', 4326))
+    SQL
+                ).freeze
+
+    def scope
+      if @contains
+        @projects = @projects.where(
+          Project.send(:sanitize_sql_array, [ QUERY_SQL, @contains ])
+        )
+      end
+      @projects
+    end
+
+  end
+end

test/integration/projects_api_test.rb

@@ -0,0 +1,58 @@
+require_relative '../test_helper'
+
+class ProjectsApiTest < Redmine::IntegrationTest
+  fixtures :users, :email_addresses, :roles, :projects, :members, :member_roles
+
+  setup do
+    User.current = nil
+    @project = Project.find 'ecookbook'
+    @project.enabled_modules.create name: 'gtt'
+  end
+
+  test 'should should filter projects by geometry' do
+    get '/projects.xml'
+    assert_response :success
+    xml = xml_data
+    assert projects = xml.xpath('/projects/project')
+    assert projects.any?
+    assert_equal Project.visible.count, projects.size
+
+    get '/projects.xml', contains: 'POINT(123.271 9.35)'
+    assert_response :success
+    xml = xml_data
+    assert projects = xml.xpath('/projects/project')
+    assert_equal 0, projects.size
+
+    @project.update_attribute :geojson, {
+      'type' => 'Feature',
+      'geometry' => {
+        'type' => 'Polygon',
+        'coordinates' => [
+          [[123.269691,9.305099], [123.279691,9.305099],[123.279691,9.405099],[123.269691,9.405099]]
+        ]
+      }
+    }.to_json
+
+    assert @project.visible?
+
+    get '/projects.xml', contains: 'POINT(123.271 9.55)'
+    assert_response :success
+    xml = xml_data
+    assert projects = xml.xpath('/projects/project')
+    assert_equal 0, projects.size
+
+    get '/projects.xml', contains: 'POINT(123.271 9.35)'
+    assert_response :success
+    xml = xml_data
+    assert projects = xml.xpath('/projects/project')
+    assert_equal 1, projects.size, xml.to_s
+    assert_equal 'ecookbook', projects.xpath('identifier').text
+
+  end
+
+  def xml_data
+    Nokogiri::XML(@response.body)
+  end
+end
+
+