foreman_webhooks 3.2.3 → 4.0.0

data/lib/foreman_webhooks/engine.rb

@@ -4,8 +4,6 @@ module ForemanWebhooks
   class Engine < ::Rails::Engine
     engine_name 'foreman_webhooks'
 
-    config.autoload_paths += Dir["#{config.root}/app/jobs"]
-
     # Add any db migrations
     initializer 'foreman_webhooks.load_app_instance_data' do |app|
       ForemanWebhooks::Engine.paths['db/migrate'].existent.each do |path|
@@ -13,76 +11,78 @@ module ForemanWebhooks
       end
     end
 
-    initializer 'foreman_webhooks.register_plugin', before: :finisher_hook do |_app|
-      Foreman::Plugin.register :foreman_webhooks do
-        requires_foreman '>= 3.7'
-        register_gettext
+    initializer 'foreman_webhooks.register_plugin', before: :finisher_hook do |app|
+      app.reloader.to_prepare do
+        Foreman::Plugin.register :foreman_webhooks do
+          requires_foreman '>= 3.13'
+          register_gettext
 
-        apipie_documented_controllers ["#{ForemanWebhooks::Engine.root}/app/controllers/api/v2/*.rb"]
-        ApipieDSL.configuration.sections += ['webhooks']
-        ApipieDSL.configuration.dsl_classes_matchers += [
-          "#{ForemanWebhooks::Engine.root}/app/lib/foreman_webhooks/renderer/**/*.rb"
-        ]
+          apipie_documented_controllers ["#{ForemanWebhooks::Engine.root}/app/controllers/api/v2/*.rb"]
+          ApipieDSL.configuration.sections += ['webhooks']
+          ApipieDSL.configuration.dsl_classes_matchers += [
+            "#{ForemanWebhooks::Engine.root}/app/lib/foreman_webhooks/renderer/**/*.rb"
+          ]
 
-        register_global_js_file 'routes'
+          register_global_js_file 'routes'
 
-        # Add permissions
-        security_block :foreman_webhooks do
-          permission :view_webhooks,    { webhooks: %i[index show auto_complete_search],
-                                          'api/v2/webhooks': %i[index show events] }, resource_type: 'Webhook'
-          permission :create_webhooks,  { webhooks: %i[new create],
-                                          'api/v2/webhooks': [:create] }, resource_type: 'Webhook'
-          permission :edit_webhooks,    { webhooks: %i[edit update],
-                                          'api/v2/webhooks': %i[update test] }, resource_type: 'Webhook'
-          permission :destroy_webhooks, { webhooks: [:destroy],
-                                          'api/v2/webhooks': [:destroy] }, resource_type: 'Webhook'
-          permission :view_webhook_templates, { webhook_templates: %i[index show auto_complete_search preview export],
-                                                'api/v2/webhook_templates': %i[index show export] },
-                     resource_type: 'WebhookTemplate'
-          permission :create_webhook_templates,   { webhook_templates: %i[new create clone_template],
-                                                    'api/v2/webhook_templates': %i[create clone import] },
-                     resource_type: 'WebhookTemplate'
-          permission :edit_webhook_templates,     { webhook_templates: %i[edit update],
-                                                    'api/v2/webhook_templates': %i[update import] },
-                     resource_type: 'WebhookTemplate'
-          permission :destroy_webhook_templates,  { webhook_templates: [:destroy],
-                                                    'api/v2/webhook_templates': [:destroy] },
-                     resource_type: 'WebhookTemplate'
-          permission :lock_webhook_templates,     { webhook_templates: %i[lock unlock],
-                                                    'api/v2/webhook_templates': %i[lock unlock] },
-                     resource_type: 'WebhookTemplate'
-        end
+          # Add permissions
+          security_block :foreman_webhooks do
+            permission :view_webhooks,    { webhooks: %i[index show auto_complete_search],
+                                            'api/v2/webhooks': %i[index show events] }, resource_type: 'Webhook'
+            permission :create_webhooks,  { webhooks: %i[new create],
+                                            'api/v2/webhooks': [:create] }, resource_type: 'Webhook'
+            permission :edit_webhooks,    { webhooks: %i[edit update],
+                                            'api/v2/webhooks': %i[update test] }, resource_type: 'Webhook'
+            permission :destroy_webhooks, { webhooks: [:destroy],
+                                            'api/v2/webhooks': [:destroy] }, resource_type: 'Webhook'
+            permission :view_webhook_templates, { webhook_templates: %i[index show auto_complete_search preview export],
+                                                  'api/v2/webhook_templates': %i[index show export] },
+                      resource_type: 'WebhookTemplate'
+            permission :create_webhook_templates,   { webhook_templates: %i[new create clone_template],
+                                                      'api/v2/webhook_templates': %i[create clone import] },
+                      resource_type: 'WebhookTemplate'
+            permission :edit_webhook_templates,     { webhook_templates: %i[edit update],
+                                                      'api/v2/webhook_templates': %i[update import] },
+                      resource_type: 'WebhookTemplate'
+            permission :destroy_webhook_templates,  { webhook_templates: [:destroy],
+                                                      'api/v2/webhook_templates': [:destroy] },
+                      resource_type: 'WebhookTemplate'
+            permission :lock_webhook_templates,     { webhook_templates: %i[lock unlock],
+                                                      'api/v2/webhook_templates': %i[lock unlock] },
+                      resource_type: 'WebhookTemplate'
+          end
 
-        role 'Webhooks Reader',
-             %i[view_webhooks view_webhook_templates]
+          role 'Webhooks Reader',
+              %i[view_webhooks view_webhook_templates]
 
-        role 'Webhooks Manager',
-             %i[view_webhooks create_webhooks edit_webhooks destroy_webhooks
-                view_webhook_templates create_webhook_templates
-                edit_webhook_templates destroy_webhook_templates
-                lock_webhook_templates]
+          role 'Webhooks Manager',
+              %i[view_webhooks create_webhooks edit_webhooks destroy_webhooks
+                 view_webhook_templates create_webhook_templates
+                 edit_webhook_templates destroy_webhook_templates
+                 lock_webhook_templates]
 
-        # add menu entry
-        divider :admin_menu, caption: N_('Webhook'), parent: :administer_menu
-        menu :admin_menu, :webhooks, url: '/webhooks',
-                                     url_hash: { controller: :webhooks, action: :index },
-                                     caption: N_('Webhooks'),
-                                     parent: :administer_menu
-        menu :admin_menu, :webhook_templates, url_hash: { controller: :webhook_templates, action: :index },
-                                              caption: N_('Webhook Templates'),
-                                              parent: :administer_menu
+          # add menu entry
+          divider :admin_menu, caption: N_('Webhook'), parent: :administer_menu
+          menu :admin_menu, :webhooks, url: '/webhooks',
+                                      url_hash: { controller: :webhooks, action: :index },
+                                      caption: N_('Webhooks'),
+                                      parent: :administer_menu
+          menu :admin_menu, :webhook_templates, url_hash: { controller: :webhook_templates, action: :index },
+                                                caption: N_('Webhook Templates'),
+                                                parent: :administer_menu
 
-        # add helpers to safe-mode
-        allowed_template_helpers :payload
+          # add helpers to safe-mode
+          allowed_template_helpers :payload
 
-        # subscribe to all events
-        subscribe(/.event.foreman$/, ::ForemanWebhooks::EventSubscriber)
+          # subscribe to all events
+          subscribe(/.event.foreman$/, ::ForemanWebhooks::EventSubscriber)
 
-        register_graphql_query_field :webhook, 'ForemanWebhooks::Types::Webhook', :record_field
-        register_graphql_query_field :webhooks, 'ForemanWebhooks::Types::Webhook', :collection_field
+          register_graphql_query_field :webhook, 'ForemanWebhooks::Types::Webhook', :record_field
+          register_graphql_query_field :webhooks, 'ForemanWebhooks::Types::Webhook', :collection_field
 
-        register_graphql_query_field :webhook_template, 'ForemanWebhooks::Types::WebhookTemplate', :record_field
-        register_graphql_query_field :webhook_templates, 'ForemanWebhooks::Types::WebhookTemplate', :collection_field
+          register_graphql_query_field :webhook_template, 'ForemanWebhooks::Types::WebhookTemplate', :record_field
+          register_graphql_query_field :webhook_templates, 'ForemanWebhooks::Types::WebhookTemplate', :collection_field
+        end
       end
     end
 

data/lib/foreman_webhooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanWebhooks
-  VERSION = "3.2.3"
+  VERSION = "4.0.0"
 end

data/locale/ca/foreman_webhooks.po

@@ -6,7 +6,6 @@
 # Translators:
 # Robert Antoni Buj i Gelonch <rbuj@fedoraproject.org>, 2023
 #
-#, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: foreman_webhooks 3.2.0\n"
@@ -107,6 +106,9 @@ msgstr ""
 msgid "Import a webhook template"
 msgstr ""
 
+msgid "In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object."
+msgstr ""
+
 msgid "List Webhooks"
 msgstr ""
 
@@ -131,6 +133,12 @@ msgstr ""
 msgid "Password"
 msgstr ""
 
+msgid "Payload"
+msgstr ""
+
+msgid "Please, note that this will not contain actual information or render the attached template."
+msgstr ""
+
 msgid "Proxy Authorization"
 msgstr ""
 
@@ -164,6 +172,18 @@ msgstr ""
 msgid "Template name"
 msgstr ""
 
+msgid "Test"
+msgstr ""
+
+msgid "Test a Webhook"
+msgstr ""
+
+msgid "Test payload will be sent as is. Cant be a JSON object"
+msgstr ""
+
+msgid "Test webhook"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr ""
 
@@ -194,12 +214,21 @@ msgstr ""
 msgid "Webhook"
 msgstr ""
 
+msgid "Webhook %s test was successful"
+msgstr ""
+
 msgid "Webhook %s was successfully deleted"
 msgstr ""
 
 msgid "Webhook Templates"
 msgstr ""
 
+msgid "Webhook template not found while firing webhook '%s'. Possible organization/location mismatch in the webhook template?"
+msgstr ""
+
+msgid "Webhook test failed: %s"
+msgstr ""
+
 msgid "Webhook was successfully created."
 msgstr ""
 
@@ -224,6 +253,9 @@ msgstr ""
 msgid "Whether or not the template is locked for editing"
 msgstr ""
 
+msgid "Will be sent as is"
+msgstr ""
+
 msgid "X509 Certification Authorities"
 msgstr ""
 
@@ -233,5 +265,11 @@ msgstr ""
 msgid "You are about to delete %s. Are you sure?"
 msgstr ""
 
+msgid "You are about to test %s webhook."
+msgstr ""
+
+msgid "You can specify below a custom payload to test the webhook with."
+msgstr ""
+
 msgid "is required"
 msgstr ""

data/locale/cs_CZ/foreman_webhooks.po

@@ -7,7 +7,6 @@
 # mhulan <mhulan@redhat.com>, 2023
 # Pavel Borecki <pavel.borecki@gmail.com>, 2023
 #
-#, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: foreman_webhooks 3.2.0\n"
@@ -110,6 +109,9 @@ msgstr ""
 msgid "Import a webhook template"
 msgstr ""
 
+msgid "In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object."
+msgstr ""
+
 msgid "List Webhooks"
 msgstr ""
 
@@ -134,6 +136,12 @@ msgstr ""
 msgid "Password"
 msgstr ""
 
+msgid "Payload"
+msgstr ""
+
+msgid "Please, note that this will not contain actual information or render the attached template."
+msgstr ""
+
 msgid "Proxy Authorization"
 msgstr ""
 
@@ -167,6 +175,18 @@ msgstr ""
 msgid "Template name"
 msgstr ""
 
+msgid "Test"
+msgstr ""
+
+msgid "Test a Webhook"
+msgstr ""
+
+msgid "Test payload will be sent as is. Cant be a JSON object"
+msgstr ""
+
+msgid "Test webhook"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr ""
 
@@ -197,12 +217,21 @@ msgstr "Ověřit SSL"
 msgid "Webhook"
 msgstr ""
 
+msgid "Webhook %s test was successful"
+msgstr ""
+
 msgid "Webhook %s was successfully deleted"
 msgstr ""
 
 msgid "Webhook Templates"
 msgstr ""
 
+msgid "Webhook template not found while firing webhook '%s'. Possible organization/location mismatch in the webhook template?"
+msgstr ""
+
+msgid "Webhook test failed: %s"
+msgstr ""
+
 msgid "Webhook was successfully created."
 msgstr ""
 
@@ -227,6 +256,9 @@ msgstr ""
 msgid "Whether or not the template is locked for editing"
 msgstr ""
 
+msgid "Will be sent as is"
+msgstr ""
+
 msgid "X509 Certification Authorities"
 msgstr "X509 certifikační autority"
 
@@ -236,5 +268,11 @@ msgstr ""
 msgid "You are about to delete %s. Are you sure?"
 msgstr ""
 
+msgid "You are about to test %s webhook."
+msgstr ""
+
+msgid "You can specify below a custom payload to test the webhook with."
+msgstr ""
+
 msgid "is required"
 msgstr ""

data/locale/de/foreman_webhooks.po

@@ -13,7 +13,6 @@
 # Lukáš Zapletal, 2023
 # Markus Bucher <bucher@atix.de>, 2023
 #
-#, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: foreman_webhooks 3.2.0\n"
@@ -114,6 +113,9 @@ msgstr ""
 msgid "Import a webhook template"
 msgstr ""
 
+msgid "In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object."
+msgstr ""
+
 msgid "List Webhooks"
 msgstr ""
 
@@ -138,6 +140,12 @@ msgstr ""
 msgid "Password"
 msgstr ""
 
+msgid "Payload"
+msgstr ""
+
+msgid "Please, note that this will not contain actual information or render the attached template."
+msgstr ""
+
 msgid "Proxy Authorization"
 msgstr ""
 
@@ -171,6 +179,18 @@ msgstr ""
 msgid "Template name"
 msgstr ""
 
+msgid "Test"
+msgstr ""
+
+msgid "Test a Webhook"
+msgstr ""
+
+msgid "Test payload will be sent as is. Cant be a JSON object"
+msgstr ""
+
+msgid "Test webhook"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr ""
 
@@ -201,12 +221,21 @@ msgstr "SSL überprüfen"
 msgid "Webhook"
 msgstr ""
 
+msgid "Webhook %s test was successful"
+msgstr ""
+
 msgid "Webhook %s was successfully deleted"
 msgstr ""
 
 msgid "Webhook Templates"
 msgstr ""
 
+msgid "Webhook template not found while firing webhook '%s'. Possible organization/location mismatch in the webhook template?"
+msgstr ""
+
+msgid "Webhook test failed: %s"
+msgstr ""
+
 msgid "Webhook was successfully created."
 msgstr ""
 
@@ -231,6 +260,9 @@ msgstr ""
 msgid "Whether or not the template is locked for editing"
 msgstr ""
 
+msgid "Will be sent as is"
+msgstr ""
+
 msgid "X509 Certification Authorities"
 msgstr "X509-Zertifizierungsstellen (CA)"
 
@@ -240,5 +272,11 @@ msgstr ""
 msgid "You are about to delete %s. Are you sure?"
 msgstr ""
 
+msgid "You are about to test %s webhook."
+msgstr ""
+
+msgid "You can specify below a custom payload to test the webhook with."
+msgstr ""
+
 msgid "is required"
 msgstr ""

data/locale/en/foreman_webhooks.po

@@ -104,6 +104,9 @@ msgstr ""
 msgid "Import a webhook template"
 msgstr ""
 
+msgid "In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object."
+msgstr ""
+
 msgid "List Webhooks"
 msgstr ""
 
@@ -131,6 +134,9 @@ msgstr ""
 msgid "Payload"
 msgstr ""
 
+msgid "Please, note that this will not contain actual information or render the attached template."
+msgstr ""
+
 msgid "Proxy Authorization"
 msgstr ""
 
@@ -215,6 +221,9 @@ msgstr ""
 msgid "Webhook Templates"
 msgstr ""
 
+msgid "Webhook template not found while firing webhook '%s'. Possible organization/location mismatch in the webhook template?"
+msgstr ""
+
 msgid "Webhook test failed: %s"
 msgstr ""
 
@@ -254,5 +263,11 @@ msgstr ""
 msgid "You are about to delete %s. Are you sure?"
 msgstr ""
 
+msgid "You are about to test %s webhook."
+msgstr ""
+
+msgid "You can specify below a custom payload to test the webhook with."
+msgstr ""
+
 msgid "is required"
 msgstr ""

data/locale/en_GB/foreman_webhooks.po

@@ -7,7 +7,6 @@
 # 0868a4d1af5275b3f70b0a6dac4c99a4, 2023
 # Andi Chandler <andi@gowling.com>, 2023
 #
-#, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: foreman_webhooks 3.2.0\n"
@@ -109,6 +108,9 @@ msgstr ""
 msgid "Import a webhook template"
 msgstr ""
 
+msgid "In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object."
+msgstr ""
+
 msgid "List Webhooks"
 msgstr ""
 
@@ -133,6 +135,12 @@ msgstr ""
 msgid "Password"
 msgstr ""
 
+msgid "Payload"
+msgstr ""
+
+msgid "Please, note that this will not contain actual information or render the attached template."
+msgstr ""
+
 msgid "Proxy Authorization"
 msgstr ""
 
@@ -166,6 +174,18 @@ msgstr ""
 msgid "Template name"
 msgstr ""
 
+msgid "Test"
+msgstr ""
+
+msgid "Test a Webhook"
+msgstr ""
+
+msgid "Test payload will be sent as is. Cant be a JSON object"
+msgstr ""
+
+msgid "Test webhook"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr ""
 
@@ -196,12 +216,21 @@ msgstr ""
 msgid "Webhook"
 msgstr ""
 
+msgid "Webhook %s test was successful"
+msgstr ""
+
 msgid "Webhook %s was successfully deleted"
 msgstr ""
 
 msgid "Webhook Templates"
 msgstr ""
 
+msgid "Webhook template not found while firing webhook '%s'. Possible organization/location mismatch in the webhook template?"
+msgstr ""
+
+msgid "Webhook test failed: %s"
+msgstr ""
+
 msgid "Webhook was successfully created."
 msgstr ""
 
@@ -226,6 +255,9 @@ msgstr ""
 msgid "Whether or not the template is locked for editing"
 msgstr ""
 
+msgid "Will be sent as is"
+msgstr ""
+
 msgid "X509 Certification Authorities"
 msgstr "X509 Certification Authorities"
 
@@ -235,5 +267,11 @@ msgstr ""
 msgid "You are about to delete %s. Are you sure?"
 msgstr ""
 
+msgid "You are about to test %s webhook."
+msgstr ""
+
+msgid "You can specify below a custom payload to test the webhook with."
+msgstr ""
+
 msgid "is required"
 msgstr ""

data/locale/es/foreman_webhooks.po

@@ -9,7 +9,6 @@
 # fe37ea014ea122db60df81cd86b163af_742ef71 <ba9f59c06b0be83ac3724b1834a4c14b_93939>, 2023
 # Lukáš Zapletal, 2023
 #
-#, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: foreman_webhooks 3.2.0\n"
@@ -111,6 +110,9 @@ msgstr ""
 msgid "Import a webhook template"
 msgstr ""
 
+msgid "In case you are using dynamic URL (ERB template), this will not be rendered correctly due to the absence of a real object."
+msgstr ""
+
 msgid "List Webhooks"
 msgstr ""
 
@@ -135,6 +137,12 @@ msgstr ""
 msgid "Password"
 msgstr ""
 
+msgid "Payload"
+msgstr ""
+
+msgid "Please, note that this will not contain actual information or render the attached template."
+msgstr ""
+
 msgid "Proxy Authorization"
 msgstr ""
 
@@ -168,6 +176,18 @@ msgstr ""
 msgid "Template name"
 msgstr ""
 
+msgid "Test"
+msgstr ""
+
+msgid "Test a Webhook"
+msgstr ""
+
+msgid "Test payload will be sent as is. Cant be a JSON object"
+msgstr ""
+
+msgid "Test webhook"
+msgstr ""
+
 msgid "This template is locked for editing."
 msgstr ""
 
@@ -198,12 +218,21 @@ msgstr "Verificar SSL"
 msgid "Webhook"
 msgstr ""
 
+msgid "Webhook %s test was successful"
+msgstr ""
+
 msgid "Webhook %s was successfully deleted"
 msgstr ""
 
 msgid "Webhook Templates"
 msgstr ""
 
+msgid "Webhook template not found while firing webhook '%s'. Possible organization/location mismatch in the webhook template?"
+msgstr ""
+
+msgid "Webhook test failed: %s"
+msgstr ""
+
 msgid "Webhook was successfully created."
 msgstr ""
 
@@ -228,6 +257,9 @@ msgstr ""
 msgid "Whether or not the template is locked for editing"
 msgstr ""
 
+msgid "Will be sent as is"
+msgstr ""
+
 msgid "X509 Certification Authorities"
 msgstr ""
 
@@ -237,5 +269,11 @@ msgstr ""
 msgid "You are about to delete %s. Are you sure?"
 msgstr ""
 
+msgid "You are about to test %s webhook."
+msgstr ""
+
+msgid "You can specify below a custom payload to test the webhook with."
+msgstr ""
+
 msgid "is required"
 msgstr "es necesario"