foreman_webhooks 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7eefadfce94e1499842423b790e8c387e4f62ce98a1e6b09fe8a9001718b9f1
-  data.tar.gz: ad0b5f62406983e72601d9a28aa7c8a84d364fb99b9984445b61b459f17446f0
+  metadata.gz: 24ca3b029befe6d1a5d05f89f7418861dfaf246e56ec07108d3e5cddbb87196d
+  data.tar.gz: 9801e362e3a140aeaec85b02e534069e5c1b3802a2ed970ef341de5ce3ffe1cf
 SHA512:
-  metadata.gz: 662cfadd46b2f4cf687623a2383b2d27304464606a19df2dd53825accb75668381edada4d3c614705940773cf390a5e31d53c10f2aa4171f94cf690e5023992b
-  data.tar.gz: 10a37322e66de2ca65a93313b9bfc60b53e35ee1cad0ff599c88ca68f5b888829c3f235747458b13f3735ce315164e117bda4dc5b018f7e050f276c0c84070a2
+  metadata.gz: 726f0cdf6c8f7a1c4f3e691020e0fc1e64c0ae76dc9f4bec8864d972025075b2c3f00d9b74360543de4a237ccbe1b8e5f8484cbae4b059c4f633afc32dec63da
+  data.tar.gz: 5617358f79addd62638f92dc6669a2088e44bf808997f8ce91853ea307d2d29fd6af5948841579340f17adf06b3266a8703ab4d47181ebdddb6be6c59acf17ee

data/app/controllers/api/v2/webhooks_controller.rb

@@ -6,7 +6,7 @@ module Api
       include Api::Version2
       include ForemanWebhooks::Controller::Parameters::Webhook
 
-      before_action :find_resource, only: %i[show update destroy]
+      before_action :find_resource, only: %i[show destroy]
 
       api :GET, '/webhooks/', N_('List Webhooks')
       param_group :search_and_pagination, ::Api::V2::BaseController
@@ -50,6 +50,7 @@ module Api
       param :id, :identifier, required: true
       param_group :webhook, as: :update
       def update
+        @webhook = Webhook.find(params[:id])
         process_response @webhook.update(webhook_params)
       end
 
@@ -58,6 +59,11 @@ module Api
       def destroy
         process_response @webhook.destroy
       end
+
+      api :GET, '/webhooks/events', N_('List available events for subscription')
+      def events
+        render json: Webhook.available_events.sort.map { |e| e.delete_suffix(Webhook::EVENT_POSTFIX) }.to_json
+      end
     end
   end
 end

data/app/controllers/concerns/foreman_webhooks/controller/parameters/webhook.rb

@@ -27,6 +27,7 @@ module ForemanWebhooks
         end
 
         def webhook_params
+          params['webhook']['event'] = params['event'] unless params['event'].blank?
           self.class.webhook_params_filter.filter_params(params, parameter_filter_context)
         end
       end

data/app/controllers/webhooks_controller.rb

@@ -4,30 +4,7 @@ class WebhooksController < ::ApplicationController
   include ForemanWebhooks::Controller::Parameters::Webhook
   include Foreman::Controller::AutoCompleteSearch
 
-  before_action :find_resource, only: %i[edit update destroy]
-
-  def new
-    @webhook = Webhook.new
-  end
-
-  def create
-    @webhook = Webhook.new(webhook_params)
-    if @webhook.save
-      process_success success_redirect: '/webhooks'
-    else
-      process_error
-    end
-  end
-
-  def edit; end
-
-  def update
-    if @webhook.update(webhook_params)
-      process_success success_redirect: '/webhooks'
-    else
-      process_error
-    end
-  end
+  before_action :find_resource, only: %i[destroy]
 
   def destroy
     if @webhook.destroy

data/app/services/foreman_webhooks/webhook_service.rb

@@ -95,7 +95,7 @@ module ForemanWebhooks
       uri = URI.parse(url)
 
       request = Object.const_get("Net::HTTP::#{http_method.to_s.capitalize}").new(uri.request_uri)
-      request.basic_auth(user, password) if user && password
+      request.basic_auth(user, password) if !user.blank? && !password.blank?
       request['Content-Type'] = content_type
       request['X-Request-Id'] = ::Logging.mdc['request'] || SecureRandom.uuid
       request['X-Session-Id'] = ::Logging.mdc['session'] || SecureRandom.uuid

data/app/views/foreman_webhooks/webhook_templates/remote_execution_-_host_job.erb

@@ -18,4 +18,3 @@ model: WebhookTemplate
 # Task ended at <%= @object.task.ended_at %>
 # Task resulted with <%= @object.task.result %>
 # Task state <%= @object.task.state %>
-# Task action output <%= @object.task.action_output %>

data/config/routes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  resources :webhooks, except: %i[index show] do
+  resources :webhooks, except: %i[index show new edit update] do
     collection do
       get 'auto_complete_search'
     end
@@ -14,7 +14,11 @@ Rails.application.routes.draw do
           defaults: { apiv: 'v2' },
           apiv: /v1|v2/,
           constraints: ApiConstraints.new(version: 2, default: true) do
-      resources :webhooks, only: %i[index show create update destroy]
+      resources :webhooks, only: %i[index show create update destroy] do
+        collection do
+          get :events
+        end
+      end
       resources :webhook_templates, except: %i[new edit] do
         member do
           post :clone

data/lib/foreman_webhooks/engine.rb

@@ -15,7 +15,7 @@ module ForemanWebhooks
 
     initializer 'foreman_webhooks.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_webhooks do
-        requires_foreman '>= 2.3'
+        requires_foreman '>= 2.5'
 
         apipie_documented_controllers ["#{ForemanWebhooks::Engine.root}/app/controllers/api/v2/*.rb"]
         ApipieDSL.configuration.sections += ['webhooks']
@@ -28,7 +28,7 @@ module ForemanWebhooks
         # Add permissions
         security_block :foreman_webhooks do
           permission :view_webhooks,    { webhooks: %i[index show auto_complete_search],
-                                          'api/v2/webhooks': %i[index show] }, resource_type: 'Webhook'
+                                          '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],

data/lib/foreman_webhooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanWebhooks
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/package.json

@@ -21,15 +21,15 @@
     "url": "https://projects.theforeman.org/projects/webhooks/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 4.15.1"
+    "@theforeman/vendor": ">= 8.4.1"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^4.15.1",
-    "@theforeman/stories": "^4.15.1",
-    "@theforeman/test": "^4.15.1",
-    "@theforeman/vendor-dev": "^4.15.1",
-    "@theforeman/eslint-plugin-foreman": "^4.15.1",
+    "@theforeman/builder": "^8.4.1",
+    "@theforeman/stories": "^8.4.1",
+    "@theforeman/test": "^8.4.1",
+    "@theforeman/vendor-dev": "^8.4.1",
+    "@theforeman/eslint-plugin-foreman": "^8.4.1",
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "eslint-plugin-spellcheck": "^0.0.17",

data/webpack/ForemanWebhooks/Routes/ForemanWebhooksRoutes.js

@@ -1,11 +1,11 @@
 import React from 'react';
-import WebhooksIndexPage from './Webhooks/WebhooksIndexPage';
+import ConnectedWebhooksIndexPage from './Webhooks/WebhooksIndexPage';
 
 const ForemanWebhooksRoutes = [
   {
     path: '/webhooks',
     exact: true,
-    render: props => <WebhooksIndexPage {...props} />,
+    render: props => <ConnectedWebhooksIndexPage {...props} />,
   },
 ];
 

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/ForemanFormikField.js

@@ -0,0 +1,117 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Field as FormikField } from 'formik';
+import { Spinner } from '@patternfly/react-core';
+import { TypeAheadSelect } from 'patternfly-react';
+import { filter } from 'lodash';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import FormField from 'foremanReact/components/common/forms/FormField';
+
+const ForemanFormikField = ({
+  name,
+  type,
+  required,
+  label,
+  labelHelp,
+  inputSizeClass,
+  labelSizeClass,
+  rows,
+  placeholder,
+  options,
+  isLoading,
+}) => (
+  <FormikField name={name}>
+    {({
+      field, // { name, value, onChange, onBlur }
+      form: { touched, errors, setFieldValue, setFieldTouched }, // also values, setXXXX, handleXXXX, dirty, isValid, status, etc.
+    }) => {
+      const defaultSelection = (fieldValue, initialOptions) => {
+        if (!fieldValue) return [];
+
+        return filter(initialOptions, o => o.value === fieldValue);
+      };
+      let content = null;
+      switch (type) {
+        case 'textarea':
+          content = (
+            <textarea
+              {...field}
+              className="form-control"
+              rows={rows}
+              placeholder={placeholder}
+            />
+          );
+          break;
+        case 'select':
+          content = isLoading ? (
+            <Spinner size="md" aria-label="loading icon" />
+          ) : (
+            <TypeAheadSelect
+              id={name}
+              options={options}
+              placeholder={__('Start typing to search')}
+              selected={defaultSelection(field.value, options)}
+              onChange={selected =>
+                setFieldValue(field.name, selected[0]?.value)
+              }
+              // onBlur={e => setFieldTouched(field.name, true)}
+            />
+          );
+          break;
+        default:
+          content = (
+            <input
+              {...field}
+              type={type}
+              checked={type === 'checkbox' ? field.value || '' : undefined}
+              className={type === 'checkbox' ? '' : 'form-control'}
+            />
+          );
+      }
+      return (
+        <FormField
+          {...field}
+          error={touched[name] ? errors[name] : undefined}
+          type={type}
+          inputSizeClass={inputSizeClass}
+          labelSizeClass={labelSizeClass}
+          required={required}
+          label={label}
+          labelHelp={labelHelp}
+          options={options}
+        >
+          {content}
+        </FormField>
+      );
+    }}
+  </FormikField>
+);
+
+ForemanFormikField.propTypes = {
+  name: PropTypes.string.isRequired,
+  type: PropTypes.string.isRequired,
+  required: PropTypes.bool,
+  label: PropTypes.string.isRequired,
+  labelHelp: PropTypes.string,
+  inputSizeClass: PropTypes.string,
+  labelSizeClass: PropTypes.string,
+  rows: PropTypes.number,
+  placeholder: PropTypes.string,
+  options: PropTypes.array,
+  isLoading: PropTypes.bool,
+};
+
+ForemanFormikField.defaultProps = {
+  required: false,
+  labelHelp: null,
+  inputSizeClass: 'col-md-8',
+  labelSizeClass: 'col-md-3',
+  rows: 1,
+  placeholder: '',
+  options: null,
+  isLoading: false,
+};
+
+export default ForemanFormikField;

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/WebhookFormTabs.css

@@ -0,0 +1,7 @@
+.webhook-form-tab-content {
+  padding-top: 3em;
+}
+
+.webhook-form-tab:focus {
+  outline: none;
+}

data/webpack/ForemanWebhooks/Routes/Webhooks/Components/WebhookForm/Components/WebhookFormTabs.js

@@ -0,0 +1,163 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Tabs, Tab, TabTitleText } from '@patternfly/react-core';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import ForemanFormikField from './ForemanFormikField';
+
+import './WebhookFormTabs.css';
+
+const WebhookFormTabs = ({
+  formProps,
+  disabled,
+  activeTab,
+  handleTabClick,
+  webhookTemplates,
+  httpMethods,
+  availableEvents,
+  isTemplatesLoading,
+  isEventsLoading,
+}) => (
+  <Tabs activeKey={activeTab} onSelect={handleTabClick} isFilled>
+    <Tab
+      className="webhook-form-tab"
+      eventKey={0}
+      title={<TabTitleText>{__('General')}</TabTitleText>}
+    >
+      <div className="webhook-form-tab-content">
+        <ForemanFormikField
+          name="event"
+          type="select"
+          label={__('Subscribe to')}
+          required
+          allowClear={false}
+          options={availableEvents}
+          isLoading={isEventsLoading}
+        />
+        <ForemanFormikField
+          name="name"
+          type="text"
+          required
+          label={__('Name')}
+        />
+        <ForemanFormikField
+          name="target_url"
+          type="text"
+          required
+          label={__('Target URL')}
+          labelHelp={__('Target URL that should be called by Foreman')}
+        />
+        <ForemanFormikField
+          name="webhook_template_id"
+          type="select"
+          label={__('Template')}
+          required
+          allowClear={false}
+          options={webhookTemplates}
+          isLoading={isTemplatesLoading}
+        />
+        <ForemanFormikField
+          name="http_method"
+          type="select"
+          label={__('HTTP Method')}
+          required
+          allowClear={false}
+          options={httpMethods}
+        />
+        <ForemanFormikField
+          name="enabled"
+          type="checkbox"
+          label={__('Enabled')}
+          labelHelp={__('If unchecked, the webhook will be inactive')}
+        />
+      </div>
+    </Tab>
+    <Tab
+      className="webhook-form-tab"
+      eventKey={1}
+      title={<TabTitleText>{__('Credentials')}</TabTitleText>}
+    >
+      <div className="webhook-form-tab-content">
+        <ForemanFormikField
+          name="user"
+          type="text"
+          label={__('User')}
+          labelHelp={__('Authentication credentials')}
+        />
+        <ForemanFormikField
+          name="password"
+          type="password"
+          label={__('Password')}
+          labelHelp={__('Authentication credentials')}
+        />
+        <ForemanFormikField
+          name="verify_ssl"
+          type="checkbox"
+          label={__('Verify SSL')}
+          labelHelp={__(
+            "Uncheck this option to disable validation of the receiver's SSL certificate"
+          )}
+        />
+        <ForemanFormikField
+          name="proxy_authorization"
+          type="checkbox"
+          label={__('Proxy Authorization')}
+          labelHelp={__(
+            'Authorize with Foreman client certificate and validate smart-proxy CA from Settings'
+          )}
+        />
+        <ForemanFormikField
+          name="ssl_ca_certs"
+          type="textarea"
+          label={__('X509 Certification Authorities')}
+          placeholder={__(
+            "Optional CAs in PEM format concatenated to verify the receiver's SSL certificate"
+          )}
+          inputSizeClass="col-md-8"
+          rows={8}
+        />
+      </div>
+    </Tab>
+    <Tab
+      className="webhook-form-tab"
+      eventKey={2}
+      title={<TabTitleText>{__('Additional')}</TabTitleText>}
+    >
+      <div className="webhook-form-tab-content">
+        <ForemanFormikField
+          name="http_content_type"
+          type="text"
+          label={__('HTTP Content Type')}
+        />
+        <ForemanFormikField
+          name="http_headers"
+          type="textarea"
+          label={__('Optional HTTP headers as JSON (ERB allowed)')}
+          placeholder='{\n"X-Shellhook-Arg-1": "value"\n}'
+          inputSizeClass="col-md-8"
+          rows={8}
+        />
+      </div>
+    </Tab>
+  </Tabs>
+);
+
+WebhookFormTabs.propTypes = {
+  formProps: PropTypes.object,
+  disabled: PropTypes.bool,
+  activeTab: PropTypes.number.isRequired,
+  handleTabClick: PropTypes.func.isRequired,
+  webhookTemplates: PropTypes.array.isRequired,
+  httpMethods: PropTypes.array.isRequired,
+  availableEvents: PropTypes.array.isRequired,
+  isTemplatesLoading: PropTypes.bool.isRequired,
+  isEventsLoading: PropTypes.bool.isRequired,
+};
+
+WebhookFormTabs.defaultProps = {
+  disabled: false,
+  formProps: {},
+};
+
+export default WebhookFormTabs;