Adds script and endpoint to register subscriptions via script, fixes #23

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

Author: dkastl

app/controllers/subscription_templates_controller.rb

@@ -1,11 +1,13 @@
 class SubscriptionTemplatesController < ApplicationController
   layout 'base'
 
-  before_action :find_project_by_project_id, except: [:index]
+  before_action :find_project_by_project_id, except: [:index, :set_subscription_id]
   before_action :get_issue_statuses, only: [:new, :create, :edit, :update]
   before_action :get_issue_priorities, only: [:new, :create, :edit, :update]
   before_action :get_issue_categories, only: [:new, :create, :edit, :update]
-  before_action :authorize
+
+  accept_api_auth :set_subscription_id
+  before_action :authorize, except: [:set_subscription_id]
 
   helper_method :index_path
 
@@ -52,6 +54,26 @@ def update_subscription_id
     end
   end
 
+  def set_subscription_id
+    # Check if a valid API key is provided
+    unless User.current.logged?
+      render json: { error: 'API key is missing or invalid' }, status: :unauthorized
+      return
+    end
+
+    @subscription_template = SubscriptionTemplate.find(params[:subscription_template_id])
+
+    # Check if the user has permissions to manage subscription templates
+    unless User.current.allowed_to?(:manage_subscription_templates, @subscription_template.project)
+      render json: { error: 'You do not have permission to manage subscription templates' }, status: :forbidden
+      return
+    end
+
+    @subscription_template.update(subscription_id: params[:subscription_id])
+
+    render json: { message: 'Subscription ID updated successfully' }, status: :ok
+  end
+
   def destroy
     @subscription_template = find_subscription_template
     @subscription_template.destroy
@@ -94,7 +116,8 @@ def prepare_payload
       url: URI.join(request.base_url, "/fiware/subscription_template/#{@subscription_template.id}/notification").to_s,
       headers: {
         "Content-Type": "application/json",
-        "X-Redmine-API-Key": User.find(@member.user_id).api_key
+        "X-Redmine-API-Key": User.find(@member.user_id).api_key,
+        "X-Redmine-GTT-Subscription-Template-URL": URI.join(request.base_url, "/fiware/subscription_template/#{@subscription_template.id}/registration/").to_s
       },
       method: "POST",
       json: {
@@ -159,11 +182,6 @@ def index_path
     settings_project_path(@project, tab: 'subscription_templates')
   end
 
-  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: [])
-  end
-
   def find_subscription_template
     subscription_template_scope.find params[:id]
   end
@@ -173,7 +191,7 @@ def find_project_by_project_id
   end
 
   def subscription_template_scope
-    SubscriptionTemplate.order(name: :asc).where(project_id: @project.id)
+    SubscriptionTemplate.where(project_id: @project.id).order(name: :asc)
   end
 
   def get_issue_statuses
@@ -188,4 +206,9 @@ def get_issue_priorities
     @issue_priorities = IssuePriority.all.sorted
   end
 
+  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: [])
+  end
+
 end

app/views/subscription_templates/unpublish.js.erb

@@ -11,10 +11,24 @@ var deleteRequestOptions = {
 // Send the DELETE request to the Orion broker
 fetch('<%= @broker_url %>', deleteRequestOptions)
   .then(response => {
+    // Get the notification box
+    var notification = document.getElementById('temporaryNotification');
+
     if (!response.ok) {
-      throw new Error('Network response was not ok');
+      console.warn('Warning: Network response was not ok');
+      notification.textContent = "<%= l(:subscription_unpublished_warning) %>";
+    } else {
+      notification.textContent = "<%= l(:subscription_unpublished) %>";
     }
 
+    // Show the notification box
+    notification.classList.add('visible');
+
+    // Hide the notification box after 3 seconds
+    setTimeout(function() {
+      notification.classList.remove('visible');
+    }, 3000);
+
     // Send the PATCH request to update the subscription_id
     return fetch('<%= update_subscription_id_project_subscription_template_path(@project, @subscription_template) %>', {
       method: 'PATCH',
@@ -30,19 +44,5 @@ fetch('<%= @broker_url %>', deleteRequestOptions)
     // Update the subscription template list
     var subscriptionTemplateList = document.getElementById('subscriptionTemplateList');
     subscriptionTemplateList.innerHTML = result;
-
-    // Get the notification box
-    var notification = document.getElementById('temporaryNotification');
-
-    // Change the text of the notification box
-    notification.textContent = "<%= l(:subscription_unpublished) %>";
-
-    // Show the notification box
-    notification.classList.add('visible');
-
-    // Hide the notification box after 3 seconds
-    setTimeout(function() {
-      notification.classList.remove('visible');
-    }, 3000);
   })
   .catch(error => console.log('error', error));

config/locales/en.yml

@@ -73,6 +73,7 @@ en:
   link_to_unpublish: "Unpublish"
   link_to_unpublish_hint: "Unpublish subscription to broker"
   subscription_unpublished: "Subscription unpublished from broker"
+  subscription_unpublished_warning: "There was a problem unpublishing the subscription from the broker"
 
   gtt_fiware:
     attachement_not_found: "Attachment not found"

config/locales/ja.yml

@@ -73,6 +73,7 @@ en:
   link_to_unpublish: "Unpublish"
   link_to_unpublish_hint: "Unpublish subscription to broker"
   subscription_unpublished: "Subscription unpublished from broker"
+  subscription_unpublished_warning: "There was a problem unpublishing the subscription from the broker"
 
   gtt_fiware:
     attachement_not_found: "Attachment not found"

config/routes.rb

@@ -33,6 +33,7 @@
 # Define route for creating issues with a notification template
 scope 'fiware/subscription_template/:subscription_template_id' do
   post 'notification', to: 'subscription_issues#create'
+  get 'registration/:subscription_id', to: 'subscription_templates#set_subscription_id'
 end
 
 # Define a route for FIWARE broker subscription templates

doc/scripts/delete_all_subscriptions.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# The base URL for your Orion Context Broker
+ORION_URL=${ORION_URL:-"http://app.local:1026"}
+
+# Fetch all subscription IDs using a GET request
+# Include additional headers as needed, e.g., for multi-tenant setups or authentication
+subscription_ids=$(curl -s -X GET "${ORION_URL}/v2/subscriptions" \
+-H "Accept: application/json" | jq -r '.[].id')
+
+# Check if there are any subscriptions to delete
+if [ -z "$subscription_ids" ]; then
+    echo "No subscriptions to delete."
+    exit 0
+fi
+
+# Loop through the subscription IDs and delete each one
+for id in $subscription_ids; do
+    curl -X DELETE "${ORION_URL}/v2/subscriptions/${id}" \
+    -H "Accept: application/json"
+    echo "Deleted subscription $id"
+done
+
+echo "All subscriptions have been deleted."
+

doc/scripts/register_all_subscriptions.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# The API key for Redmine
+REDMINE_API_KEY=${REDMINE_API_KEY:-$1}
+
+# Check if API key is provided
+if [ -z "$REDMINE_API_KEY" ]
+then
+  echo "No API key provided. Usage: ./register_all_subscriptions.sh <api_key> or set the REDMINE_API_KEY environment variable."
+  exit 1
+fi
+
+# The base URL for your Orion Context Broker
+ORION_URL=${ORION_URL:-"http://app.local:1026"}
+
+# Fetch all subscriptions using a GET request
+subscriptions=$(curl -s -X GET "${ORION_URL}/v2/subscriptions" -H "Accept: application/json")
+
+# Use jq to parse the JSON response and filter subscriptions with the "X-Redmine-GTT-Subscription-Template-URL" header
+filtered_subscriptions=$(echo "$subscriptions" | jq -c '.[] | select(.notification.httpCustom.headers."X-Redmine-GTT-Subscription-Template-URL" != null)')
+
+# Check if there are any filtered subscriptions
+if [ -z "$filtered_subscriptions" ]; then
+  echo "No subscriptions with the 'X-Redmine-GTT-Subscription-Template-URL' header found."
+  exit 0
+fi
+
+# Loop through the filtered subscriptions
+echo "$filtered_subscriptions" | while read -r subscription; do
+  # Extract the URL and append the subscription id
+  url=$(echo "$subscription" | jq -r '(.notification.httpCustom.headers."X-Redmine-GTT-Subscription-Template-URL" + .id)')
+
+  # Execute a GET request to the URL
+  response=$(curl -s -X GET "$url" -H "X-Redmine-API-Key: $REDMINE_API_KEY")
+
+  # Print a log message
+  echo "GET request to $url completed with response: $response"
+done

init.rb

@@ -32,7 +32,7 @@
       context: %i( index )
     }, read: true
     permission :manage_subscription_templates, {
-      subscription_templates: %i( new edit update create destroy copy publish unpublish update_subscription_id),
+      subscription_templates: %i( new edit update create destroy copy publish unpublish update_subscription_id set_subscription_id),
       projects: %i( manage_subscription_templates )
     }, require: :member
   end