httpd_configmap_generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 269f3519101488e9580699f67f1fa479f1db78f6
-  data.tar.gz: 3224b233aedc0c5ae68cb0299d2438e165b2b7f5
+  metadata.gz: 97e1e062ab6b1f55d36ffe1de318f82892c78d8e
+  data.tar.gz: 7a88bb96641736bb254238122b722547b61c5ec2
 SHA512:
-  metadata.gz: a0d1935e46028b58c93d019e38b1133d2653414ae77d4bc0e33182a7d1d1230c43bdf12dd5cccd233c381bf6aa8c9fe3a632c37bd220dd3a2ec8cc820b3d1301
-  data.tar.gz: 7d85650f7f2b59dc7db1345e48e0486687fea752482232d3d1cccbde9b20e273b455003cbc45eaadff9bbd62a58b11d243abed5f23debcd57374b35da60f987e
+  metadata.gz: a2476f19b3e2ec40ce2a14cee8946850db609d2dbd5e215129fed1981d807cf34985bf13bc37c31277c0214ce3f97b10761ec4d13b17fb6ac757909acf9777d8
+  data.tar.gz: 2b34b65675ab369a0821723e08259d06efa1619b168a3e80d019f696eb091dd8301e910454d14afe06611b6202afbdbfd884fe91360ffdbf128c0f584ed8dc05

data/.gitignore

@@ -1,3 +1,4 @@
+Dockerfile.devel
 .rubocop-*
 /bundle/
 /.bundle/

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-- '2.3.5'
+- '2.3.1'
 - '2.4.2'
 sudo: false
 cache: bundler

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Leverage the httpd_configmap_generator.gemspec
 gemspec
+
+# Load other additional Gemfiles
+#   Developers can create a file ending in .rb under bundler.d/ to specify additional development dependencies
+Dir.glob(File.join(__dir__, 'bundler.d/*.rb')).each { |f| eval_gemfile(File.expand_path(f, __dir__)) }

data/README-active-directory.md

@@ -8,21 +8,17 @@ by joining an Active Directory domain.
 
 ```
 $ httpd_configmap_generator active-directory --help
-httpd_configmap_generator 0.1.0 - External Authentication Configuration script
-
-Usage: httpd_configmap_generator auth_type | update | export [--help | options]
-
-httpd_configmap_generator options are:
-  -V, --version              Version of the httpd_configmap_generator command
-  -h, --host=<s>             Application Domain (default: )
-  -o, --output=<s>           Configuration map file to create (default: )
-  -a, --ad-domain=<s>        Active Directory Domain (default: )
-  -u, --ad-server=<s>        Active Directory User (default: )
-  -p, --ad-password=<s>      Active Directory Password (default: )
-  -f, --force                Force configuration if configured already
-  -d, --debug                Enable debugging
-  -r, --ad-realm=<s>         Active Directory Realm (default: )
-  -e, --help                 Show this message
+Options:
+  -h, --host=<s>           Application Domain
+  -o, --output=<s>         Configuration map file to create
+  -a, --ad-domain=<s>      Active Directory Domain
+  -u, --ad-user=<s>        Active Directory User
+  -p, --ad-password=<s>    Active Directory Password
+  -f, --force              Force configuration if configured already
+  -d, --debug              Enable debugging
+  -r, --ad-realm=<s>       Active Directory Realm
+  -s, --ad-server=<s>      Active Directory Server
+  -e, --help               Show this message
 ```
 
 ### Example:

data/README-ipa.md

@@ -8,21 +8,16 @@ for an IPA server.
 
 ```
 $ httpd_configmap_generator ipa --help
-httpd_configmap_generator 0.1.0 - External Authentication Configuration script
-
-Usage: httpd_configmap_generator auth_type | update | export [--help | options]
-
-httpd_configmap_generator options are:
-  -V, --version              Version of the httpd_configmap_generator command
-  -h, --host=<s>             Application Domain (default: )
-  -o, --output=<s>           Configuration map file to create (default: )
-  -i, --ipa-server=<s>       IPA Server Fqdn (default: )
-  -p, --ipa-password=<s>     IPA Server Password (default: )
+Options:
+  -h, --host=<s>             Application Domain
+  -o, --output=<s>           Configuration map file to create
+  -i, --ipa-server=<s>       IPA Server FQDN
+  -p, --ipa-password=<s>     IPA Server Password
   -f, --force                Force configuration if configured already
   -d, --debug                Enable debugging
   -a, --ipa-principal=<s>    IPA Server Principal (default: admin)
-  -m, --ipa-domain=<s>       Domain of IPA Server (default: )
-  -r, --ipa-realm=<s>        Realm of IPA Server (default: )
+  -m, --ipa-domain=<s>       Domain of IPA Server
+  -r, --ipa-realm=<s>        Realm of IPA Server
   -e, --help                 Show this message
 ```
 

data/README-saml.md

@@ -6,19 +6,14 @@ This documents how to run the httpd\_configmap\_generator tool to configure the
 
 ```
 $ httpd_configmap_generator saml --help
-httpd_configmap_generator 0.1.0 - External Authentication Configuration script
-
-Usage: httpd_configmap_generator auth_type | update | export [--help | options]
-
-httpd_configmap_generator options are:
-  -V, --version                  Version of the httpd_configmap_generator command
-  -h, --host=<s>                 Application Domain (default: )
-  -o, --output=<s>               Configuration map file to create (default: )
+Options:
+  -h, --host=<s>                 Application Domain
+  -o, --output=<s>               Configuration map file to create
   -f, --force                    Force configuration if configured already
   -d, --debug                    Enable debugging
   -k, --keycloak-add-metadata    Download and add the Keycloak metadata file
-  -e, --keycloak-server=<s>      Keycloak Server Fqdn or IP (default: )
-  -y, --keycloak-realm=<s>       Keycloak Realm for this client (default: )
+  -e, --keycloak-server=<s>      Keycloak Server FQDN or IP
+  -y, --keycloak-realm=<s>       Keycloak Realm for this client
   -l, --help                     Show this message
 ```
 

data/README.md

@@ -23,10 +23,16 @@ gem install httpd_configmap_generator
 Generating an auth-config map can be done by running the httpd\_configmap\_generator tool
 
 ```
-$ httpd_configmap_generator
+$ httpd_configmap_generator --help
+httpd_configmap_generator 0.1.1 - External Authentication Configuration script
 
 Usage: httpd_configmap_generator auth_type | update | export [--help | options]
-Supported auth_type: active-directory, ipa, saml
+
+supported auth_type: active-directory, ipa, saml
+
+httpd_configmap_generator options are:
+  -V, --version    Version of the httpd_configmap_generator command
+  -h, --help       Show this message
 ```
 
 Showing the usage for each authentication type or sub-command as follows:
@@ -53,17 +59,12 @@ map as per the following usage:
 
 ```
 $ httpd_configmap_generator update --help
-httpd_configmap_generator 0.1.0 - External Authentication Configuration script
-
-Usage: httpd_configmap_generator auth_type | update | export [--help | options]
-
-httpd_configmap_generator options are:
-  -V, --version         Version of the httpd_configmap_generator command
-  -i, --input=<s>       Input config map file (default: )
-  -o, --output=<s>      Output config map file (default: )
+Options:
+  -i, --input=<s>       Input config map file
+  -o, --output=<s>      Output config map file
   -f, --force           Force configuration if configured already
   -d, --debug           Enable debugging
-  -a, --add-file=<s>    Add file to config map (default: )
+  -a, --add-file=<s>    Add file to config map
   -h, --help            Show this message
 ```
 
@@ -143,15 +144,10 @@ map as per the following usage:
 
 ```
 $ httpd_configmap_generator export --help
-httpd_configmap_generator 0.1.0 - External Authentication Configuration script
-
-Usage: httpd_configmap_generator auth_type | update | export [--help | options]
-
-httpd_configmap_generator options are:
-  -V, --version       Version of the httpd_configmap_generator command
-  -i, --input=<s>     Input config map file (default: )
-  -l, --file=<s>      Config map file to export (default: )
-  -o, --output=<s>    The output file being exported (default: )
+Options:
+  -i, --input=<s>     Input config map file
+  -l, --file=<s>      Config map file to export
+  -o, --output=<s>    The output file being exported
   -f, --force         Force configuration if configured already
   -d, --debug         Enable debugging
   -h, --help          Show this message

data/bin/httpd_configmap_generator

@@ -7,7 +7,7 @@
 # -o filename: for the generated auth-config map.
 #
 
-require "bundler/setup"
+Dir.chdir(__dir__) { require "bundler/setup" }
 require "trollop"
 require "httpd_configmap_generator"
 
@@ -20,62 +20,63 @@ end
 
 module HttpdConfigmapGenerator
   class Cli
-    def parse_arguments(auth_config)
-      opts = Trollop.options do
+    SUB_COMMANDS = [HttpdConfigmapGenerator.supported_auth_types] | %w(update export)
+
+    def run
+      Trollop.options do
         version("#{CMD} #{HttpdConfigmapGenerator::VERSION} - External Authentication Configuration script")
         banner <<-EOS
 #{version}
 
 Usage: #{CMD} auth_type | update | export [--help | options]
 
+supported auth_type: #{HttpdConfigmapGenerator.supported_auth_types.join(', ')}
+
 #{CMD} options are:
       EOS
         opt :version, "Version of the #{CMD} command",
             :default => false, :short => "-V"
-        auth_config.required_options.each do |key, key_options|
-          opt key, key_options[:description], HttpdConfigmapGenerator::Cli.options_for(key_options, true)
-        end
-        auth_config.optional_options.each do |key, key_options|
-          opt key, key_options[:description], HttpdConfigmapGenerator::Cli.options_for(key_options)
-        end
-      end
-      opts
-    end
-
-    def run_configure(auth_type)
-      begin
-        auth_config = HttpdConfigmapGenerator.new_config(auth_type)
-      rescue => err
-        error_msg(err.to_s)
+        stop_on(SUB_COMMANDS)
       end
 
-      auth_config.run_configure(parse_arguments(auth_config))
-    end
+      auth_type = ARGV.shift
+      Trollop.die "Must specify an authentication type" if auth_type.nil?
 
-    def run_update
       begin
-        auth_config = HttpdConfigmapGenerator::Update.new
+        auth_config =
+          case auth_type
+          when "update" then HttpdConfigmapGenerator::Update.new
+          when "export" then HttpdConfigmapGenerator::Export.new
+          else HttpdConfigmapGenerator.new_config(auth_type)
+          end
       rescue => err
         error_msg(err.to_s)
       end
 
-      auth_config.update(parse_arguments(auth_config))
-    end
-
-    def run_export
-      begin
-        auth_config = HttpdConfigmapGenerator::Export.new
-      rescue => err
-        error_msg(err.to_s)
+      params = Trollop.options do
+        auth_config.required_options.each do |key, key_options|
+          opt key, key_options[:description], HttpdConfigmapGenerator::Cli.options_for(key_options, true)
+        end
+        auth_config.optional_options.each do |key, key_options|
+          opt key, key_options[:description], HttpdConfigmapGenerator::Cli.options_for(key_options)
+        end
       end
 
-      auth_config.export(parse_arguments(auth_config))
+      case auth_type
+      when "update" then auth_config.update(params)
+      when "export" then auth_config.export(params)
+      else auth_config.run_configure(params)
+      end
     end
 
     def self.options_for(key_options, required = false)
       options = {}
-      options[:default] = key_options.key?(:default) ? key_options[:default] : ""
-      options[:required] = true if required
+      if key_options[:default].nil?
+        options[:type] = key_options[:type] || :string
+      else
+        options[:default] = key_options[:default]
+      end
+      options[:required] = required
       options[:short]    = key_options[:short] if key_options[:short]
       options[:multi]    = key_options[:multi] if key_options[:multi]
       options
@@ -83,19 +84,4 @@ Usage: #{CMD} auth_type | update | export [--help | options]
   end
 end
 
-if ARGV.empty?
-  error_msg("
-Usage: #{CMD} auth_type | update | export [--help | options]
-Supported auth_type: #{HttpdConfigmapGenerator.supported_auth_types.join(', ')}
-")
-else
-  auth_type = ARGV.shift
-  case auth_type
-  when "update"
-    HttpdConfigmapGenerator::Cli.new.run_update
-  when "export"
-    HttpdConfigmapGenerator::Cli.new.run_export
-  else
-    HttpdConfigmapGenerator::Cli.new.run_configure(auth_type)
-  end
-end
+HttpdConfigmapGenerator::Cli.new.run

data/lib/httpd_configmap_generator/ipa.rb

@@ -9,7 +9,7 @@ module HttpdConfigmapGenerator
 
     def required_options
       super.merge(
-        :ipa_server   => { :description => "IPA Server Fqdn"     },
+        :ipa_server   => { :description => "IPA Server FQDN"     },
         :ipa_password => { :description => "IPA Server Password" }
       )
     end

data/lib/httpd_configmap_generator/saml.rb

@@ -17,7 +17,7 @@ module HttpdConfigmapGenerator
       super.merge(
         :keycloak_add_metadata => { :description => "Download and add the Keycloak metadata file",
                                     :default     => false },
-        :keycloak_server       => { :description => "Keycloak Server Fqdn or IP" },
+        :keycloak_server       => { :description => "Keycloak Server FQDN or IP" },
         :keycloak_realm        => { :description => "Keycloak Realm for this client"}
       )
     end

data/lib/httpd_configmap_generator/version.rb

@@ -1,3 +1,3 @@
 module HttpdConfigmapGenerator
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpd_configmap_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Httpd Auth Config Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -172,7 +172,6 @@ files:
 - lib/httpd_configmap_generator/base/sssd.rb
 - lib/httpd_configmap_generator/export.rb
 - lib/httpd_configmap_generator/ipa.rb
-- lib/httpd_configmap_generator/options.rb
 - lib/httpd_configmap_generator/saml.rb
 - lib/httpd_configmap_generator/update.rb
 - lib/httpd_configmap_generator/version.rb

data/lib/httpd_configmap_generator/options.rb

@@ -1,13 +0,0 @@
-module HttpdConfigmapGenerator
-  def self.required_options
-    {
-      :host => { :description => "Application Domain" }
-    }
-  end
-
-  def self.optional_options
-    {
-      :force => { :description => "Force configuration if configured already", :default => false }
-    }
-  end
-end