hammer_cli_foreman_webhooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0feb157669e6b414e8b3a9ac20b2a6f02bd1c070cf8e8c29a57c8e80e7c7420d
+  data.tar.gz: 51b5e1e238c9218dac0968f1127eb45ce2e1b52c51e08babda53d69241237efb
+SHA512:
+  metadata.gz: 25f6a72ed3e8d8b5c6ed21b2d5da48bdf49c2f2d56a35b479167832a88191a03d81e51f29d83f384c2b0e8fdda185a7d70033be397b3a78e5639a027e7b1c0bc
+  data.tar.gz: 5133fc734abaef5a43a5690b4929817c5e2c49cd606108966590c78d526824d606bb7b44ae809636b27633147de5abba57aac720f499549735ba9d68f80398d6

data/LICENSE

@@ -0,0 +1,5 @@
+This program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

data/README.md

@@ -0,0 +1,32 @@
+# Hammer CLI Foreman Webhooks
+
+This Hammer CLI plugin contains set of commands for [foreman_webhooks](
+  https://github.com/theforeman/foreman_webhooks
+), a plugin to Foreman for Webhooks management.
+
+## Versions
+
+This is the list of which version of Foreman Webhooks is needed to which version of this plugin.
+
+| hammer_cli_foreman_webhooks | v0.0.1 |  
+|-----------------------------|--------|
+|            foreman_webhooks | v0.0.1 |
+
+## Installation
+
+    $ gem install hammer_cli_foreman_webhooks
+
+    $ mkdir -p ~/.hammer/cli.modules.d/
+
+    $ cat <<EOQ > ~/.hammer/cli.modules.d/foreman_webhooks.yml
+    :foreman_webhooks:
+      :enable_module: true
+    EOQ
+
+    # to confirm things work, this should return useful output
+    hammer webhooks --help
+
+## More info
+
+See our [Hammer CLI installation and configuration instuctions](
+https://github.com/theforeman/hammer-cli/blob/master/doc/installation.md#installation).

data/config/foreman_webhooks.yml

@@ -0,0 +1,2 @@
+:foreman_webhooks:
+  :enable_module: true

data/lib/hammer_cli_foreman_webhooks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanWebhooks
+  require 'hammer_cli'
+  require 'hammer_cli_foreman'
+
+  require 'hammer_cli_foreman_webhooks/version'
+  require 'hammer_cli_foreman_webhooks/command_extensions'
+  require 'hammer_cli_foreman_webhooks/webhook'
+  require 'hammer_cli_foreman_webhooks/webhook_template'
+
+  HammerCLI::MainCommand.lazy_subcommand(
+    'webhook',
+    'Manage webhooks',
+    'HammerCLIForemanWebhooks::Webhook',
+    'hammer_cli_foreman_webhooks/webhook'
+  )
+  HammerCLI::MainCommand.lazy_subcommand(
+    'webhook-template',
+    'Manipulate webhook templates',
+    'HammerCLIForemanWebhooks::WebhookTemplate',
+    'hammer_cli_foreman_webhooks/webhook_template'
+  )
+end

data/lib/hammer_cli_foreman_webhooks/command_extensions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'hammer_cli_foreman_webhooks/command_extensions/webhook'

data/lib/hammer_cli_foreman_webhooks/command_extensions/webhook.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanWebhooks
+  module CommandExtensions
+    class Webhook < HammerCLI::CommandExtensions
+      option '--ssl-ca-certs', 'PATH_TO_CA_FILE',
+             _('File containing X509 Certification Authorities concatenated in PEM format'),
+             format: HammerCLI::Options::Normalizers::File.new
+      option '--http-headers', 'HTTP_HEADERS', '',
+             format: HammerCLI::Options::Normalizers::KeyValueList.new
+
+      before_print do |data|
+        data['http_headers'] = http_headers_from_json(data['http_headers'])
+      end
+
+      request_params do |params|
+        if params['webhook']['http_headers']
+          params['webhook']['http_headers'] = http_headers_to_json(params['webhook']['http_headers'])
+        end
+      end
+
+      def self.http_headers_to_json(headers)
+        return headers unless headers.is_a?(Hash)
+
+        require 'json'
+        JSON.dump(headers)
+      end
+
+      def self.http_headers_from_json(data)
+        return data unless data.is_a?(String)
+
+        require 'json'
+        begin
+          JSON.parse(data).each_pair.each_with_object([]) do |(key, value), result|
+            result << { name: key, value: value }
+          end
+        rescue JSON::ParserError
+          [{}]
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_webhooks/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanWebhooks
+  def self.version
+    @version ||= Gem::Version.new '0.0.1'
+  end
+end

data/lib/hammer_cli_foreman_webhooks/webhook.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanWebhooks
+  class Webhook < HammerCLIForeman::Command
+    resource :webhooks
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :target_url, _('Target URL')
+        field :enabled, _('Enabled'), Fields::Boolean
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output Webhook::ListCommand.output_definition do
+        field :event, _('Event')
+        field :http_method, _('HTTP Method')
+        field :http_content_type, _('HTTP Content Type')
+        custom_field Fields::Reference, label: _('Webhook Template'), path: [:webhook_template]
+        field :user, _('User'), Fields::Field, sets: %w[ADDITIONAL ALL]
+        field :verify_sll, _('Verify SSL'), Fields::Boolean, sets: %w[ADDITIONAL ALL]
+        field :ssl_ca_certs, _('X509 Certification Authorities'), Fields::Text, sets: %w[ADDITIONAL ALL]
+        collection :http_headers, _('HTTP Headers'), sets: %w[ADDITIONAL ALL] do
+          custom_field Fields::KeyValue
+        end
+        HammerCLIForeman::References.timestamps(self)
+      end
+
+      build_options
+
+      extend_with(HammerCLIForemanWebhooks::CommandExtensions::Webhook.new(only: :before_print))
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _('Webhook [%{name}] created.')
+      failure_message _('Could not create the webhook')
+
+      build_options without: %i[ssl_ca_certs http_headers]
+
+      extend_with(HammerCLIForemanWebhooks::CommandExtensions::Webhook.new(only: :options))
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _('Webhook [%{name}] updated.')
+      failure_message _('Could not update the webhook')
+
+      build_options without: %i[ssl_ca_certs http_headers]
+
+      extend_with(HammerCLIForemanWebhooks::CommandExtensions::Webhook.new(only: :options))
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Webhook [%{name}] deleted.')
+      failure_message _('Could not delete the webhook')
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman_webhooks/webhook_template.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module HammerCLIForemanWebhooks
+  class WebhookTemplate < HammerCLIForeman::Command
+    resource :webhook_templates
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output WebhookTemplate::ListCommand.output_definition do
+        field :description, _('Description'), Fields::Text
+        field :locked, _('Locked'), Fields::Boolean
+        field :default, _('Default'), Fields::Boolean
+        HammerCLIForeman::References.timestamps(self)
+        HammerCLIForeman::References.taxonomies(self)
+        collection :inputs, _('Template inputs') do
+          field :id, _('Id'), Fields::Id
+          field :name, _('Name')
+          field :description, _('Description')
+          field :required, _('Required'), Fields::Boolean
+          field :options, _('Options'), Fields::List, hide_blank: true
+        end
+      end
+
+      build_options
+    end
+
+    class CloneCommand < HammerCLIForeman::UpdateCommand
+      action :clone
+      command_name 'clone'
+
+      success_message _('Webhook template cloned.')
+      failure_message _('Could not clone the webhook template')
+
+      validate_options do
+        option(:option_new_name).required
+      end
+
+      build_options
+    end
+
+    class ImportCommand < HammerCLIForeman::Command
+      command_name 'import'
+      action :import
+
+      option '--file', 'PATH', _('Path to a file that contains the webhook template content including metadata'),
+             attribute_name: :option_template, format: HammerCLI::Options::Normalizers::File.new
+
+      validate_options do
+        all(:option_name, :option_template).required
+      end
+
+      success_message _('Imported webhook template successfully.')
+      failure_message _('Could not import the webhook template')
+
+      build_options without: %i[template]
+    end
+
+    class DumpCommand < HammerCLIForeman::InfoCommand
+      command_name 'dump'
+      desc _('View webhook template content')
+
+      def print_data(webhook_template)
+        puts webhook_template['template']
+      end
+
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _('Webhook template [%{name}] created.')
+      failure_message _('Could not create the webhook template')
+
+      build_options
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _('Webhook template [%{name}] updated.')
+      failure_message _('Could not update the webhook template')
+
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Webhook template [%{name}] deleted.')
+      failure_message _('Could not delete the webhook template')
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: hammer_cli_foreman_webhooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oleh Fedorenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hammer_cli_foreman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- ofedoren@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- config/foreman_webhooks.yml
+- lib/hammer_cli_foreman_webhooks.rb
+- lib/hammer_cli_foreman_webhooks/command_extensions.rb
+- lib/hammer_cli_foreman_webhooks/command_extensions/webhook.rb
+- lib/hammer_cli_foreman_webhooks/version.rb
+- lib/hammer_cli_foreman_webhooks/webhook.rb
+- lib/hammer_cli_foreman_webhooks/webhook_template.rb
+homepage: https://github.com/theforeman/hammer-cli-foreman-webhooks
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Foreman Webhooks plugin for Hammer CLI
+test_files: []