Merge pull request #45 from gtt-project/ftr/add-configuration-setting

Ftr/add configuration setting

Author: sanak

README.md

@@ -58,6 +58,12 @@ http://localhost:3000/projects/(project_id)/smash/tags.json
 http://localhost:3000/smash/tags.json 
 ```
 
+**Default tracker setting API endpoint**
+
+```
+http://localhost:3000/smash/settings.json
+```
+
 ## Contributing and Support
 
 The GTT Project appreciates any [contributions](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md)! Feel free to contact us for [reporting problems and support](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md).

app/controllers/smash_tags_controller.rb

@@ -2,7 +2,7 @@ class SmashTagsController < ApplicationController
 
   before_action :find_optional_project_and_authorize
 
-  accept_api_auth :project_tags, :global_tags
+  accept_api_auth :project_tags, :global_tags, :default_notes_tags
 
   def project_tags
     smash_tags = build_tags
@@ -18,6 +18,13 @@ def global_tags
     end
   end
 
+  def default_notes_tags
+    smash_tags = build_default_notes_tags
+    respond_to do |format|
+      format.api { render json: smash_tags}
+    end
+  end
+
   private
 
   def find_optional_project_and_authorize
@@ -117,6 +124,7 @@ def build_tags
     end
     # Trackers
     tracker_project_ids = valid_tracker_project_ids()
+
     Tracker.where(id: tracker_project_ids.keys).sort.each do |tracker|
       # Projects
       project_ids = tracker_project_ids[tracker.id]
@@ -335,4 +343,89 @@ def build_tags
     end
     return smash_tags
   end
+
+  def build_default_notes_tags
+    simple_notes = Tracker.where(id: Setting.plugin_redmine_gtt_smash['tracker_simple_notes'])
+    photo_notes = Tracker.where(id: Setting.plugin_redmine_gtt_smash['tracker_photo_notes'])
+    gps_logs = Tracker.where(id: Setting.plugin_redmine_gtt_smash['tracker_gps_logs'])
+    default_subject = Setting.plugin_redmine_gtt_smash['default_subject']
+
+    # Trackers
+    tracker_project_ids = valid_tracker_project_ids()
+
+    simple_notes_projects = []
+    photo_notes_projects = []
+    gps_logs_projects = []
+    
+    if simple_notes.length() > 0
+      project_ids = tracker_project_ids[simple_notes[0].id]
+      if @project.blank? and project_ids.present?
+        Project.where(id: project_ids).sort.each {|project|
+          simple_notes_projects.append({
+              id: project.id.to_s,
+              name: project.name
+          })
+        }
+      end
+
+      simple_notes = {
+        id: simple_notes[0].id.to_s,
+        name: simple_notes[0].name
+      }
+    end
+    if photo_notes.length() > 0
+      project_ids = tracker_project_ids[photo_notes[0].id]
+      if @project.blank? and project_ids.present?
+        Project.where(id: project_ids).sort.each {|project|
+          photo_notes_projects.append({
+              id: project.id.to_s,
+              name: project.name
+          })
+        }
+      end
+
+      photo_notes = {
+        id: photo_notes[0].id.to_s,
+        name: photo_notes[0].name
+      }
+    end
+    if gps_logs.length() > 0
+      project_ids = tracker_project_ids[gps_logs[0].id]
+      if @project.blank? and project_ids.present?
+        Project.where(id: project_ids).sort.each {|project|
+          gps_logs_projects.append({
+              id: project.id.to_s,
+              name: project.name
+          })
+        }
+      end
+
+      gps_logs = {
+        id: gps_logs[0].id.to_s,
+        name: gps_logs[0].name
+      }
+    end
+
+    section = {
+      notes: {
+          simple: {
+            tracker: simple_notes,
+            projects: simple_notes_projects
+          },
+          photo: {
+            tracker: photo_notes,
+            projects: photo_notes_projects
+          },
+          gps: {
+            tracker: gps_logs,
+            projects: gps_logs_projects
+          }
+      },
+      defaults: {
+        subject: default_subject
+      }
+    }
+
+    return section
+  end
 end

app/views/gtt_smash/_settings.html.erb

@@ -0,0 +1,32 @@
+<div class="box tabular settings">
+  <%
+    @options = ["None"]
+    Tracker.all.sort.each do |t|
+      @options.push([t.name,t.id])
+    end
+  %>
+  <h3><%= l(:setting_message) %></h3>
+
+  <p>
+    <%= content_tag(:label, l(:field_tracker_simple_note)) %>
+    <%= select_tag "settings[tracker_simple_notes]",
+      options_for_select(@options, @settings['tracker_simple_notes']) %>
+  </p>
+
+  <p>
+    <%= content_tag(:label, l(:field_tracker_photo_note)) %>
+    <%= select_tag "settings[tracker_photo_notes]",
+      options_for_select(@options, @settings['tracker_photo_notes']) %>
+  </p>
+
+  <p>
+    <%= content_tag(:label, l(:field_tracker_gps_log)) %>
+    <%= select_tag "settings[tracker_gps_logs]",
+      options_for_select(@options, @settings['tracker_gps_logs']) %>
+  </p>
+
+  <p>
+    <%= content_tag(:label, l(:field_default_subject)) %>
+    <%= text_field_tag 'settings[default_subject]', @settings['default_subject'], :size => 30 %>
+  </p>
+</div>

config/locales/en.yml

@@ -1,3 +1,10 @@
 en:
   permission_view_gtt_smash: "View GTT SMASH"
   project_module_gtt_smash: "GTT SMASH"
+
+  field_tracker_simple_note: "Tracker for Simple Notes"
+  field_tracker_photo_note: "Tracker for Photo Notes"
+  field_tracker_gps_log: "Tracker for GPS Logs"
+  field_default_subject: "Default subject"
+  
+  setting_message: "Caution: ensure that selected trackers do not have required custom fields!"

config/locales/ja.yml

@@ -1,3 +1,10 @@
 ja:
   permission_view_gtt_smash: "GTT SMASHの閲覧"
   project_module_gtt_smash: "GTT SMASH"
+
+  tracker_simple_note: "Tracker for Simple Notes"
+  tracker_photo_note: "Tracker for Photo Notes"
+  tracker_gps_log: "Tracker for GPS Logs"
+  default_subject: "Default subject"
+
+  setting_message: "Caution: ensure that selected trackers do not have required custom fields!"

config/routes.rb

@@ -3,6 +3,7 @@
 
 scope 'smash' do
   get 'tags', to: 'smash_tags#global_tags', as: :smash_tags
+  get 'settings', to: 'smash_tags#default_notes_tags', as: :default_notes_smash_tags
 end
 
 scope 'projects/:project_id' do

doc/getting-started.md

@@ -8,19 +8,26 @@ SMASH is a digital field mapping application developed to perform fast qualitati
 
 You can install the SMASH app from the app stores:
 
-* *SMASH Digital field mapping* for iOS devices on the [Apple store](https://apps.apple.com/us/app/smash-digital-field-mapping/id1475079936).
+* *SMASH Digital field mapping* for iOS devices on the [Apple Store](https://apps.apple.com/us/app/smash-digital-field-mapping/id1475079936).
 * *SMASH field mapping* for Android devices on the [Google Play store](https://play.google.com/store/apps/details?id=eu.hydrologis.smash&hl=en).
 
-The following plugin documentation gives a brief introduction in how to use SMASH with Redmine.
+The following plugin documentation gives a brief introduction to how to use SMASH with Redmine.
 
 SMASH provides additional functionality that is available in the [SMASH User Manual](https://www.geopaparazzi.org/smash/index.html).
 
 ## Integration in Redmine GTT
 
-To get projects connected with SMASH mobile application make sure to enable the **GTT SMASH** module in your Redmine project settings.
+To get projects connected with the SMASH mobile application make sure to enable the **GTT SMASH** module in your Redmine project settings.
 
 ![Project Modules](project_modules.png)
 
+
+Set the trackers and default subject for the notes or logs in the plugin setting of **Redmine GTT SMASH** so that the issue can be created based on the setting.
+
+![GTT SMASH Setting](gtt_smash_setting.png)
+
+
+
 ## Connect SMASH mobile application to Redmine
 
 ### Connect Redmine account
@@ -35,15 +42,15 @@ In SMASH mobile application top menu go to **Export** or **Import**. Click on th
 
 ### Import Redmine projects
 
-In menu again go to **Import** → **GTT** → Select Project → Click **Import**
+In menu again go to **Import** → **GTT** → Click **Import**
 
 ![GTT Import](gtt_import.png)
 
 This will import your project's form configuration to mobile storage.
 
 ### Create issue
 
-In SMASH application you can create Simple Notes, Form Notes, etc. Form Notes can be exported to your Redmine project as **issue**.
+In the SMASH application you can create Simple Notes, Form Notes, etc. Form Notes can be exported to your Redmine project as **issue**.
 
 :::caution
 Only *Form Notes* are currently supported in combination with Redmine GTT!
@@ -52,8 +59,8 @@ Only *Form Notes* are currently supported in combination with Redmine GTT!
 Follow these steps to upload your notes as issues or synchronize changes:
 
 1. Go to top menu **Export** → **GTT**
-2. It will inidicate if there is new data to be uploaded
-3. Choose a project for creating the issue(s)
+2. It will indicate if there is new data to be uploaded
+3. Choose a project for each note or GPS log to create the issue(s) *(unselected will be ignored)*
 4. Click on **Upload** to export the issue(s)
 
 ![GTT Export](gtt_export.png)