Merge pull request #156 from gtt-project/ftr/api-map-config

Ftr/api map config

Author: dkastl

README.md

@@ -56,7 +56,8 @@ Before restarting Redmine, you need to set `postgis` adapter instead of `postgre
 After restarting Redmine, you should be able to see the Redmine GTT plugin in the Plugins page.
 
 More information on installing (and uninstalling) Redmine plugins can be found here: http://www.redmine.org/wiki/redmine/Plugins
-
+## API
+[Redmine GTT API](doc/api.md)
 ## How to use
 
 1. Go to plugin configuration for global settings

app/controllers/gtt_configuration_controller.rb

@@ -0,0 +1,74 @@
+class GttConfigurationController < ApplicationController
+
+    before_action :find_optional_project_and_authorize
+
+    accept_api_auth :default_setting_configuration
+
+    def default_setting_configuration
+        gtt_map_config = build_default_setting_config
+        respond_to do |format|
+          format.api { render json: build_default_setting_config}
+        end
+    end
+
+    def build_default_setting_config
+        default_tracker_icon = []
+        default_status_color = []
+        gtt_tile_source = []
+
+        Tracker.all.sort.each {|tracker|
+            default_tracker_icon.append({
+                trackerID: tracker.id,
+                trackerName: tracker.name,
+                icon: Setting.plugin_redmine_gtt['tracker_'+tracker.id.to_s]
+            })
+        }
+        IssueStatus.all.sort.each {|status|
+            default_status_color.append({
+                statusID: status.id,
+                statusName: status.name,
+                color: Setting.plugin_redmine_gtt['status_'+status.id.to_s]
+            })
+        }
+        GttTileSource.where(global: true).sort.each {|tileSource|
+            gtt_tile_source.append({
+                id: tileSource.id,
+                name: tileSource.name,
+                type: tileSource.type,
+                options: tileSource.options
+            })
+        }
+
+        mapConfig = {
+            gttDefaultSetting: {
+                defaultTrackerIcon: default_tracker_icon,
+                defaultStatusColor: default_status_color,
+                defaultMapSetting: {
+                    centerLng: Setting.plugin_redmine_gtt['default_map_center_longitude'],
+                    centerLat: Setting.plugin_redmine_gtt['default_map_center_latitude']
+                },
+                geometrySetting: {
+                    geometryTypes: Setting.plugin_redmine_gtt['editable_geometry_types_on_issue_map'],
+                    GeoJsonUpload: (Setting.plugin_redmine_gtt['enable_geojson_upload_on_issue_map'] == 'true'),
+                },
+                geocoderSetting: {
+                    enableGeocodingOnMap: (Setting.plugin_redmine_gtt['enable_geocoding_on_map'] == 'true'),
+                    geocoderOptions: Setting.plugin_redmine_gtt['default_geocoder_options']
+                },
+            },
+            gttLayer: gtt_tile_source,
+        }
+        return mapConfig
+    end
+
+    private
+
+    def find_optional_project_and_authorize
+        if params[:project_id]
+            @project = Project.find params[:project_id]
+            authorize
+        else
+            authorize_global
+        end
+    end
+end

app/views/projects/show.api.rsb

@@ -14,6 +14,10 @@ api.project do
     api.geojson ""
   end
 
+  if @project.gtt_tile_sources.present?
+    api.gttLayer @project.gtt_tile_sources
+  end
+
   render_api_custom_values @project.visible_custom_field_values, api
   render_api_includes(@project, api)
 

config/routes.rb

@@ -5,3 +5,7 @@
 put 'projects/:id/settings/gtt',
   to: 'projects#update_gtt_configuration',
   as: :update_gtt_configuration
+
+scope 'gtt' do
+  get 'settings', to: 'gtt_configuration#default_setting_configuration', as: :default_setting_configuration
+end

doc/api.md

@@ -0,0 +1,124 @@
+# GTT API
+
+## Global Level API Endpoint
+### API Endpoint
+```
+GET /gtt/settings.json
+```
+Get all the GTT default settings and also all the global GTT layers data.
+
+***Request***
+```
+http://localhost:3000/gtt/settings.json
+```
+
+***Response***
+```json
+{
+    "gttDefaultSetting": {
+        "defaultTrackerIcon": [
+            {
+                "trackerID": "1",
+                "trackerName": "Task",
+                "icon": "maki-square"
+            },
+        ],
+        "defaultStatusColor": [
+            {
+                "statusID": "1",
+                "statusName": "New",
+                "color": "#00ff00"
+            },
+        ],
+        "defaultMapSetting": {
+            "centerLng": "135.35740",
+            "centerLat": "34.74701"
+        },
+        "geometrySetting": {
+            "geometryTypes": [
+                "Point",
+                "LineString",
+                "Polygon"
+            ],
+            "GeoJsonUpload": null
+        },
+        "geocoderSetting": {
+            "enableGeocodingOnMap": "true",
+            "geocoderOptions": "{}"
+        }
+    },
+    "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>"
+         },
+      },
+      {
+         "id": 2,
+         "name": "GIS Satellite Map",
+         "type": "ol.source.XYZ",
+         "options": {
+             "url": "https://cyberjapandata.gsi.go.jp/xyz/seamlessphoto/{z}/{x}/{y}.jpg",
+             "maxZoom": 18,
+             "minZoom": 0,
+             "attributions": "<a href=\"https://portal.cyberjapan.jp/help/termsofuse.html\" target=\"_blank\">GISSateliteMap</a>"
+         },
+       }
+    ]
+}
+```
+
+## Project Level API Endpoint
+### API Endpoint
+```
+GET /projects/{project_identifier}.json
+```
+Get project and selected GTT layer data of a specific project.
+
+***Request***
+```
+http://localhost:3000/projects/1.json
+```
+***Response***
+```json
+{
+    "project": {
+        "id": 1,
+        "name": "first testing project ",
+        "identifier": "first-testing-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"
+    }
+}
+```
+

init.rb

@@ -16,6 +16,9 @@
     permission :manage_gtt_settings, {
       projects: [ :update_gtt_configuration ]
     }, require: :member
+    permission :view_gtt_settings, {
+      gtt_configuration: %i( default_setting_configuration )
+    }, require: :member, read: true
   end
 
   settings(