Implements geometry support, fixes #24

Signed-off-by: Daniel Kastl <[email protected]>

Author: dkastl

app/controllers/subscription_issues_controller.rb

@@ -18,6 +18,35 @@ def create
     @issue.priority = @subscription_template.issue_priority
     @issue.fixed_version = @subscription_template.version
 
+    logger.info "################################################################################"
+    logger.info "################################################################################"
+    logger.info "Request received to create a new issue based on a subscription template"
+    logger.info "Request parameters: #{params}"
+    logger.info "################################################################################"
+
+    # If the redmine_gtt plugin is installed and enabled, and geometry data is provided,
+    # try to convert it to an RGeo geometry object
+    if Redmine::Plugin.installed?(:redmine_gtt) && @subscription_template.project.module_enabled?('gtt') && params[:geometry]
+      begin
+        @issue.geom = RedmineGtt::Conversions.to_geom(params[:geometry].to_json)
+      rescue => e
+        logger.warn "Failed to convert geometry data: #{e.message}"
+      end
+    end
+
+    logger.info "################################################################################"
+    logger.info "Create issue key/value:"
+    @issue.attributes.each do |key, value|
+      logger.info "#{key}: #{value}"
+    end
+    logger.info "################################################################################"
+    logger.info "Subscription template key/value pairs:"
+    @subscription_template.attributes.each do |key, value|
+      logger.info "#{key}: #{value}"
+    end
+    logger.info "################################################################################"
+    logger.info "################################################################################"
+
     if @issue.save
       # Respond with the newly created issue and a 201 status code
       render json: @issue.as_json(include: [:status, :tracker, :author, :assigned_to]), status: :created

app/controllers/subscription_templates_controller.rb

@@ -110,6 +110,7 @@ def unpublish
   def prepare_payload
     @subscription_template = SubscriptionTemplate.find(params[:id])
     @broker_url = URI.join(@subscription_template.broker_url, "/v2/subscriptions").to_s
+    @entity_url = URI.join(@subscription_template.broker_url, "/v2/entities").to_s
     @member = Member.find(@subscription_template.member_id)
 
     httpCustom = {
@@ -121,8 +122,12 @@ def prepare_payload
       },
       method: "POST",
       json: {
+        entity: "#{@entity_url}/${id}?type=${type}",
         subject: @subscription_template.subject,
-        description: @subscription_template.description
+        description: @subscription_template.description,
+        attachments: @subscription_template.attachments,
+        notes: @subscription_template.notes,
+        geometry: @subscription_template.geometry
       }
     }
 
@@ -208,7 +213,7 @@ def get_issue_priorities
 
   def subscription_template_params
     params[:subscription_template][:alteration_types] ||= []
-    params.require(:subscription_template).permit(:standard, :broker_url, :fiware_service, :fiware_servicepath, :subscription_id, :name, :expires, :status, :context, :entities_string, :attrs, :expression_query, :expression_georel, :expression_geometry, :expression_coords, :notify_on_metadata_change, :subject, :description, :attachments_string, :is_private, :project_id, :tracker_id, :version_id, :issue_status_id, :issue_category_id, :issue_priority_id, :member_id, :comment, alteration_types: [])
+    params.require(:subscription_template).permit(:standard, :broker_url, :fiware_service, :fiware_servicepath, :subscription_id, :name, :expires, :status, :context, :entities_string, :attrs, :expression_query, :expression_georel, :expression_geometry, :expression_coords, :notify_on_metadata_change, :subject, :description, :attachments_string, :is_private, :project_id, :tracker_id, :version_id, :issue_status_id, :issue_category_id, :issue_priority_id, :member_id, :comment, :threshold_create, :threshold_create_hours, :notes, :geometry, :geometry_string, alteration_types: [])
   end
 
 end

app/models/subscription_template.rb

@@ -30,18 +30,35 @@ class SubscriptionTemplate < ActiveRecord::Base
 
   validate :name_uniqueness
   validate :take_json_entities
+  validate :take_json_geometry
   validate :take_json_attachments
   validate :attrs_must_be_array_of_strings
   validate :geo_query_fields_must_be_all_or_none
 
   before_save :serialize_alteration_types
   after_find :deserialize_alteration_types
 
+  attr_accessor :threshold_create_hours
+  # Override the getter for threshold_create_hours
+  def threshold_create_hours
+    threshold_create / 3600 if threshold_create
+  end
+
+  # Override the setter for threshold_create_hours
+  def threshold_create_hours=(hours)
+    self.threshold_create = hours.to_i * 3600
+  end
+
   attr_writer :entities_string
   def entities_string
     @entities_string ||= entities.present? ? JSON.pretty_generate(entities) : ''
   end
 
+  attr_writer :geometry_string
+  def geometry_string
+    @geometry_string ||= geometry.present? ? JSON.pretty_generate(geometry) : ''
+  end
+
   attr_writer :attachments_string
   def attachments_string
     @attachments_string ||= attachments.present? ? JSON.pretty_generate(attachments) : ''
@@ -63,6 +80,12 @@ def take_json_entities
     errors.add :entities_string, I18n.t(:error_invalid_json)
   end
 
+  def take_json_geometry
+    self.geometry = JSON.parse(geometry_string)
+  rescue JSON::ParserError
+    errors.add :geometry_string, I18n.t(:error_invalid_json)
+  end
+
   def take_json_attachments
     return if attachments_string.blank?
 

app/views/gtt_fiware/_settings.html.erb

@@ -15,7 +15,7 @@
 
 <p>
   <%= content_tag(:label, l(:field_fiware_broker_subscription_throttling)) %>
-  <%= number_field_tag 'settings[request_timeout]',
+  <%= number_field_tag 'settings[fiware_broker_subscription_throttling]',
     @settings['fiware_broker_subscription_throttling'], :min => 0, :step => 1 %>
 </p>
 

app/views/subscription_templates/_form.html.erb

@@ -94,6 +94,13 @@
   <p><%= f.text_field :subject, required: true, size: 75, placeholder: l(:field_subscription_template_subject_placeholder) %></p>
   <p><%= f.text_area :description, required: true, rows: 6, class: 'wiki-edit', placeholder: l(:field_subscription_template_description_placeholder) %></p>
 
+  <p><%= f.text_area :notes, rows: 4, class: 'wiki-edit', placeholder: l(:field_subscription_template_notes_placeholder) %></p>
+  <p><%= f.number_field :threshold_create_hours, min: 0, step: 1 %> <em><%= l(:field_subscription_template_threshold_create_hours_hint) %></em></p>
+
+  <p><%= f.text_area :geometry_string, rows: 4,
+        placeholder: JSON.pretty_generate(JSON.parse(l(:field_subscription_template_geometry_placeholder))),
+        value: (@subscription_template.geometry.presence ? JSON.pretty_generate(@subscription_template.geometry) : '') %></p>
+
   <p><%= f.text_area :attachments_string, rows: 6,
         placeholder: JSON.pretty_generate(JSON.parse(l(:field_subscription_template_attachments_placeholder))),
         value: (@subscription_template.attachments.presence ? JSON.pretty_generate(@subscription_template.attachments) : '') %></p>
@@ -127,3 +134,4 @@
 </div>
 
 <%= wikitoolbar_for 'subscription_template_description' %>
+<%= wikitoolbar_for 'subscription_template_notes' %>

config/locales/en.yml

@@ -63,6 +63,12 @@ en:
   field_subscription_template_attachments_string: "Attachments (array of)"
   field_subscription_template_attachments_placeholder: "[{\"filename\": \"image.jpg\", \"url\": \"https://example.com/image.jpg\"}]"
   field_subscription_template_notification_user: "Sent from user"
+  field_subscription_template_threshold_create_hours: "Threshold (h)"
+  field_subscription_template_threshold_create_hours_hint: "Threshold to create new issue in hours."
+  field_subscription_template_notes: "Issue notes"
+  field_subscription_template_notes_placeholder: "Post an issue note instead of creating a new issue if an issue has been created within the threshold."
+  field_subscription_template_geometry_string: "Issue geometry (GeoJSON)"
+  field_subscription_template_geometry_placeholder: "{\"type\": \"Feature\", \"geometry\": \"${location}\"}"
 
   link_to_insert_project_geometry: "Insert project boundary"
   link_to_insert_project_geometry_hint: "This will use the project boundary as the geospatial query for the subscription"

config/locales/ja.yml

@@ -63,6 +63,12 @@ en:
   field_subscription_template_attachments_string: "Attachments (array of)"
   field_subscription_template_attachments_placeholder: "[{\"filename\": \"image.jpg\", \"url\": \"https://example.com/image.jpg\"}]"
   field_subscription_template_notification_user: "Sent from user"
+  field_subscription_template_threshold_create_hours: "Threshold (h)"
+  field_subscription_template_threshold_create_hours_hint: "Threshold to create new issue in hours."
+  field_subscription_template_notes: "Issue notes"
+  field_subscription_template_notes_placeholder: "Post an issue note instead of creating a new issue if an issue has been created within the threshold."
+  field_subscription_template_geometry_string: "Issue geometry (GeoJSON)"
+  field_subscription_template_geometry_placeholder: "{\"type\": \"Feature\", \"geometry\": \"${location}\"}"
 
   link_to_insert_project_geometry: "Insert project boundary"
   link_to_insert_project_geometry_hint: "This will use the project boundary as the geospatial query for the subscription"

db/migrate/20240425141120_create_subscription_templates.rb

@@ -22,7 +22,9 @@ def change
 
       t.string :subject, null: false
       t.text :description
+      t.text :notes
       t.jsonb :attachments
+      t.jsonb :geometry
       t.boolean :is_private, default: false
 
       t.references :project, index: true, foreign_key: true, null: false
@@ -34,6 +36,7 @@ def change
       t.references :member, index: true, foreign_key: true, null: false
 
       t.text :comment
+      t.integer :threshold_create, default: 0
       t.timestamps null: false
     end
   end

init.rb

@@ -21,7 +21,7 @@
   settings(
     default: {
       'ngsi_ld_format' => false,
-      'fiware_broker_subscription_throttling' => '60',
+      'fiware_broker_subscription_throttling' => '10',
     },
     partial: 'gtt_fiware/settings'
   )