Merge pull request #202 from gtt-project/fix/projects-api-geometry-and-layers

Fix projects api "include=geometry,layers" case issue

Author: sanak

app/views/projects/show.api.rsb

@@ -9,7 +9,7 @@ api.project do
   api.is_public   @project.is_public?
 
   if @project.geom
-    api.geojson @project.geojson
+    api.geojson @project.geojson.to_json
   else
     api.geojson ""
   end

doc/api.md

@@ -78,57 +78,3 @@ http://localhost:3000/gtt/settings.json
     ]
 }
 ```
-
-## Project Level API Endpoint
-
-### Project settings API Endpoint
-
-```text
-GET /projects/{project_identifier}.json
-```
-
-Get project and selected GTT layer data of a specific project.
-
-***Request***
-
-```text
-http://localhost:3000/projects/1.json
-```
-
-***Response***
-
-```json
-{
-    "project": {
-        "id": 1,
-        "name": "My Project ",
-        "identifier": "my-project",
-        "description": "",
-        "homepage": "",
-        "status": 1,
-        "is_public": false,
-        "geojson": "",
-        "gttLayer": [
-            {
-                "id": 1,
-                "name": "OSM",
-                "type": "ol.source.OSM",
-                "options": {
-                    "url": "https://tile.openstreetmap.jp/{z}/{x}/{y}.png",
-                    "custom": "17/34.74701/135.35740",
-                    "crossOrigin": null,
-                    "attributions": "<a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a>"
-                },
-                "created_at": "2022-06-29T09:07:12.574Z",
-                "updated_at": "2022-07-05T07:33:09.237Z",
-                "global": true,
-                "default": true,
-                "position": 0,
-                "baselayer": true
-            }
-        ],
-        "created_on": "2022-06-29T09:08:38Z",
-        "updated_on": "2022-06-29T09:08:38Z"
-    }
-}
-```

lib/redmine_gtt/patches/projects_controller_patch.rb

@@ -12,7 +12,7 @@ def index
           format.api {
             retrieve_project_query
             scope = project_scope
-            @include_geometry = params[:include] == 'geometry'
+            @include_geometry = include_in_api_response?('geometry')
             if @include_geometry || params[:contains].present?
               query = RedmineGtt::SpatialProjectsQuery.new(
                 contains: params[:contains],

test/integration/projects_api_test.rb

@@ -167,11 +167,13 @@ class ProjectsApiTest < Redmine::IntegrationTest
   test 'GET /projects.xml with include=layers should return layers' do
     ts = RedmineGtt::Actions::CreateTileSource.(type: 'ol.source.OSM', name: 'default', default: true).tile_source
     @project.gtt_tile_sources = [ts]
+    @subproject1.gtt_tile_sources = [ts]
     get '/projects.xml?include=layers'
     assert_response :success
     xml = xml_data
     assert projects = xml.xpath('/projects/project')
     assert layer = projects.xpath('layers/layer').first
+    assert layer.present?
     assert_equal 'ol.source.OSM', layer['type']
   end
 
@@ -183,12 +185,69 @@ class ProjectsApiTest < Redmine::IntegrationTest
     xml = xml_data
     assert project = xml.xpath('/project')
     assert layer = project.xpath('layers/layer').first
+    assert layer.present?
+    assert_equal 'ol.source.OSM', layer['type']
+  end
+
+  test 'GET /projects.xml with include=geometry,layers should return both geojson and layers' do
+    ts = RedmineGtt::Actions::CreateTileSource.(type: 'ol.source.OSM', name: 'default', default: true).tile_source
+    @project.gtt_tile_sources = [ts]
+    @subproject1.gtt_tile_sources = [ts]
+    geo = {
+      'type' => 'Feature',
+      'geometry' => {
+        'type' => 'Polygon',
+        'coordinates' => [
+          [[123.269691,9.305099], [123.279691,9.305099],[123.279691,9.405099],[123.269691,9.405099], [123.269691,9.305099]]
+        ]
+      }
+    }
+    geojson = geo.to_json
+
+    @project.update_attribute :geojson, geojson
+    @subproject1.update_attribute :geojson, geojson
+
+    get '/projects.xml?include=geometry,layers'
+    assert_response :success
+    xml = xml_data
+    assert projects = xml.xpath('/projects/project')
+    assert json = projects.xpath('geojson').first.text
+    assert json.present?
+    assert_equal geo['geometry'], JSON.parse(json)['geometry'], json
+    assert layer = projects.xpath('layers/layer').first
+    assert layer.present?
+    assert_equal 'ol.source.OSM', layer['type']
+  end
+
+  test 'GET /projects/1.xml with include=geometry,layers should return both geojson and layers' do
+    ts = RedmineGtt::Actions::CreateTileSource.(type: 'ol.source.OSM', name: 'default', default: true).tile_source
+    @project.gtt_tile_sources = [ts]
+    geo = {
+      'type' => 'Feature',
+      'geometry' => {
+        'type' => 'Polygon',
+        'coordinates' => [
+          [[123.269691,9.305099], [123.279691,9.305099],[123.279691,9.405099],[123.269691,9.405099], [123.269691,9.305099]]
+        ]
+      }
+    }
+    geojson = geo.to_json
+
+    @project.update_attribute :geojson, geojson
+
+    get '/projects/1.xml?include=geometry,layers'
+    assert_response :success
+    xml = xml_data
+    assert project = xml.xpath('/project')
+    assert json = project.xpath('geojson').first.text
+    assert json.present?
+    assert_equal geo['geometry'], JSON.parse(json)['geometry'], json
+    assert layer = project.xpath('layers/layer').first
+    assert layer.present?
     assert_equal 'ol.source.OSM', layer['type']
   end
 
   def xml_data
     Nokogiri::XML(@response.body)
   end
 end
-
-