redipress 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1cd5a369540a7fac84e4543d82e3676e120654e
-  data.tar.gz: 41b2088329ce194c4c07ee018a838a852d4c5836
+  metadata.gz: a66ae6d877c3fa7b777a481c27b4e689bca89fed
+  data.tar.gz: 996402566da246e8387c35452d0fdc0a04b2be20
 SHA512:
-  metadata.gz: 1c03498f350b079fdb90fef7de9394091e4b0fcdafc56ffc52922e5929a53fa753f78dd7543ee8def7bd64fc867674abf67c5cb2aef82453ad995dcc81ee90eb
-  data.tar.gz: c7fa1fccfb4b15c66fdeb7d2d931d8d0756470792566968ba6e76433e351ab8ba981f7c645fb241c5f3bd0af486ade6824cdf01b0166711d7212e27e355133e5
+  metadata.gz: dd7b12ffb774b49aa25650ca6c0971b849e3a2192019ece186215740596bdf4dc876cf049671661711dcf3a349140af9c987f5dbbc07b14b140313cc8086efc6
+  data.tar.gz: a400e6f7a8d9797f168fdef7634d6ed585e88167d38a52d6252d04e30cc18ba1134f3c824da614c1b7764b9600322522b65d8cb9f2128a93e43c9633c2ae28bc

data/lib/redipress/cli/configurations.rb

@@ -20,13 +20,19 @@ module RediPress
         new_line
 
         # Get the configuration
-        configuration = prompt_for_configuration
+        configurations = prompt_for_configurations
 
-        # Print a new line
-        new_line
+        # Create a Hash to hold the options
+        options = Hash.new
+
+        # Loop over each configuration
+        configurations.each do |configuration|
+          # Print a new line
+          new_line
 
-        # Get the configuration's options
-        options = prompt_for_configuration_options(configuration)
+          # Get the configuration's options
+          options[configuration.slug] = prompt_for_configuration_options(configuration)
+        end
 
         # Print a new line
         new_line
@@ -34,59 +40,96 @@ module RediPress
         # Prompt to continue
         exit(1) unless prompt.yes?("Proceed with the above settings?")
 
-        # Print a new line
-        new_line
-
-        begin
-          # Check if the configuration is compatible with the host
-          compatible = configuration.compatible?(host, options)
-        rescue => error
+        # Loop over each configuration
+        configurations.each do |configuration|
+          # Print a new line
           new_line
-          prompt.error("The configuration raised an error.")
-          prompt.error("See the error report below for more information:")
-          prompt.error("--------------------------------------------------")
 
-          raise error
-        end
+          begin
+            # Check if the configuration is compatible with the host
+            compatible = configuration.compatible?(host, options)
+          rescue => e
+            # Print a new line
+            new_line
 
-        # Check if the server is not compatible with the configuration
-        unless compatible
-          prompt.error("The configuration '#{configuration}' is not compatible with #{host.username}@#{host.hostname}")
+            # Print an error message
+            prompt.error("An exception was raised whilst running a configuration:")
+            prompt.error("-------------------------------------------------------")
 
-          exit 1
-        end
+            raise e
+          end
 
-        begin
-          # Perform the configuration on the server
-          result = configuration.configure(host, options)
-        rescue => error
-          new_line
-          prompt.error("The configuration raised an error.")
-          prompt.error("See the error report below for more information:")
-          prompt.error("--------------------------------------------------")
+          # Check if the configuration is not compatible
+          unless compatible
+            # Print a warning message
+            prompt.warning("'#{configuration.name}' is not compatible with #{host.username}@#{host.hostname}")
 
-          raise error
+            exit 1
+          end
         end
 
-        # Check if the result is nil
-        if result.nil?
-          # The server failed to configure
-          prompt.error("Oh dear. It looks like something went wrong whilst configuring the server.")
+        # Print a message
+        prompt.ok("The selected configurations appear to be compatible with #{host.username}@#{host.hostname}")
+
+        # Create a Hash to hold the results
+        results = Hash.new
 
-          exit 1
+        # Loop over each configuration
+        configurations.each do |configuration|
+          # Print a new line
+          new_line
+
+          # Print a message
+          prompt.ok("Configuring '#{configuration.name}' ...")
+          prompt.ok("------------------------------------------------------------")
+
+          begin
+            # Perform the configuration on the server
+            results[configuration.slug] = configuration.configure(host, options[configuration.slug])
+          rescue RediPress::ConfigurationFailed => e
+            # Print a new line
+            new_line
+
+            # Print an error message
+            prompt.error("Configuration '#{configuration.name}' failed:")
+            prompt.error("------------------------------------------------------------")
+            prompt.error(e.error)
+
+            exit 1
+          rescue => e
+            # Print a new line
+            new_line
+
+            # Print an error message
+            prompt.error("Configuration '#{configuration.name}' raised an error:")
+            prompt.error("------------------------------------------------------------")
+
+            raise e
+          end
         end
 
+        # Print a new line
+        new_line
+
         # The server has been configured
         prompt.ok("Woo hoo! Your server has been configured.")
 
-        # Print a new line
-        new_line
+        # Loop over each configuration
+        configurations.each do |configuration|
+          # Get the result
+          result = results[configuration.slug]
+
+          # Go next if there aren't any results to output
+          next if result.nil? || result.empty? || false == result.is_a?(Hash)
+
+          # Print a new line
+          new_line
 
-        # Check if there are any results to Show
-        unless result.empty?
           # Print a table containing the results
           puts TTY::Table.new(rows: result.map { |k, v| [" #{k} ", " #{v} "] }).render(:ascii)
         end
+
+        nil
       end
 
       # Set the default task to execute
@@ -132,25 +175,24 @@ module RediPress
           host
         end
 
-        # Prompt the user for the configuration to use.
+        # Prompt the user for the configurations to use
         #
         # Example:
-        #   >> prompt_for_configuration
-        #   => [#<Test:0x00000000000000>, { "username" => "test" }]
+        #   >> prompt_for_configurations
+        #   => [#<RediPress::Configuration::Test:0x00000000000000>]
         #
-        def prompt_for_configuration
+        def prompt_for_configurations
           # Print a short message to explain why we need the following information
-          prompt.ok("Pick the configuration you'd like to use:")
+          prompt.ok("Pick the configurations you'd like to use:")
 
           begin
             # Load the actual configuration classes
             configurations = RediPress::Configuration.all
-          rescue error
+          rescue e
             prompt.error("Unable to load one or more configurations.")
-            prompt.error("See the error report below for more information:")
             prompt.error("--------------------------------------------------")
 
-            raise error
+            raise e
           end
 
           # Ensure there is at least one configuration available
@@ -161,13 +203,13 @@ module RediPress
             raise RediPress::NoConfigurationsAvailable
           end
 
-          # Prompt for the configuration to use
-          configuration = prompt.select("Configuration:", configurations.values)
+          # Prompt for the configurations to use
+          configurations = prompt.multi_select("Configurations:", configurations.values)
 
-          configuration
+          configurations
         end
 
-        # Prompt the user for all options required by the specified configuration.
+        # Prompt the user for all options required by the specified configuration
         #
         # Example:
         #   >> prompt_for_configuration_options(configuration)
@@ -177,7 +219,7 @@ module RediPress
           return nil unless configuration.parameters && configuration.parameters.count > 0
 
           # Print a short message to explain why we need the following information
-          prompt.ok("These options are required by the configuration you chose:")
+          prompt.ok("Options for #{configuration.name}:")
 
           # Create an empty hash to store the configuration's options
           options = Hash.new
@@ -185,19 +227,22 @@ module RediPress
           # Loop through each parameter on the configuration
           configuration.parameters.each do |parameter|
             if :text == parameter.type
-              options[parameter.slug] = prompt.ask("#{parameter.name}:") do |q|
+              options[parameter.slug] = prompt.ask(" #{parameter.name}:") do |q|
                 q.required(true)
                 q.validate(parameter.validation) if parameter.validation
                 q.default(parameter.default) if parameter.default
               end
-            elsif :yesno == parameter.type
-              options[parameter.slug] = prompt.yes?("#{parameter.name}:")
+            elsif :yes == parameter.type
+              options[parameter.slug] = prompt.yes?(" #{parameter.name}:")
+            elsif :no == parameter.type
+              options[parameter.slug] = prompt.no?(" #{parameter.name}:")
             elsif :select == parameter.type
-              options[parameter.slug] = prompt.select("#{parameter.name}:", parameter.options)
+              options[parameter.slug] = prompt.select(" #{parameter.name}:", parameter.options)
             elsif :multi_select == parameter.type
-              options[parameter.slug] = prompt.multi_select("#{parameter.name}:", parameter.options)
+              options[parameter.slug] = prompt.multi_select(" #{parameter.name}:", parameter.options)
             else
-              prompt.error("The configuration requested an unknown parameter type.")
+              prompt.error("'#{parameter.name}' has an unknown type of '#{parameter.type}'.")
+
               exit 1
             end
           end

data/lib/redipress/configuration/base.rb

@@ -52,6 +52,16 @@ module RediPress
         end
       end
 
+      # Get the slug of the configuration
+      #
+      # Example:
+      #   >> configuration.slug
+      #   => "test"
+      #
+      def slug
+        RediPress::Configuration.slug_for(self.class)
+      end
+
       # Get the name of the configuration
       #
       # Example:
@@ -99,8 +109,7 @@ module RediPress
       end
 
       # Configure the server
-      # This method should return a hash (either empty or with info to display) on
-      # success and nil if an error occurs.
+      # This method should return a hash with info to display (if needed) or nil
       #
       # Arguments:
       #   host: (SSHKit::Host)
@@ -113,6 +122,22 @@ module RediPress
       def configure(host, options)
         raise RediPress::SetupNotImplemented
       end
+
+      # Fail with an error
+      #
+      # Arguments:
+      #   error: (String)
+      #
+      # Example:
+      #   >> configuration.fail("Test error")
+      #   => nil
+      #
+      # Raises:
+      #   RediPress::ConfigurationFailed: When this function is called
+      #
+      def fail(error)
+        raise RediPress::ConfigurationFailed.new(self, error)
+      end
     end
   end
 end

data/lib/redipress/configuration.rb

@@ -68,6 +68,24 @@ module RediPress
       "RediPress::Configuration::#{klass}"
     end
 
+    # Get the slug for a configuration class.
+    #
+    # Arguments:
+    #   klass: (Class)
+    #
+    # Example:
+    #   >> RediPress::Configuration.slug_for RediPress::Configuration::Test
+    #   => "test"
+    #
+    def self.slug_for(klass)
+      slug = klass.to_s.split("::").last
+      slug.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      slug.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      slug.tr!("-", "_")
+      slug.downcase!
+      slug
+    end
+
     # Load a configuration from the configurations directory.
     #
     # Arguments:

data/lib/redipress/errors.rb

@@ -32,4 +32,19 @@ module RediPress
       "The setup function has not been implemented by the configuration."
     end
   end
+
+  # A RuntimeError subclass for when a configuration fails.
+  #
+  class ConfigurationFailed < RuntimeError
+    attr_reader :configuration, :error
+
+    def initialize(configuration, error)
+      @configuration = configuration
+      @error = error
+    end
+
+    def to_s
+      "The configuration '#{@configuration.name}' failed: #{@error}"
+    end
+  end
 end

data/lib/redipress/variables.rb

@@ -1,9 +1,5 @@
 module RediPress
   # The current version of the gem.
   #
-  VERSION = '0.0.2'
-
-  # The directory where all configurations are stored.
-  #
-  CONFIGURATIONS_DIR = File.join(File.dirname(__FILE__), "configurations")
+  VERSION = '0.0.3'
 end

data/redipress.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |s|
 
 	s.executables << 'redipress'
 
-	s.add_runtime_dependency "thor", "~> 0.19", "0.19.1"
-	s.add_runtime_dependency "tty-prompt", "~> 0.3", "0.3.0"
-	s.add_runtime_dependency "tty-table", "~> 0.4", "0.4.0"
-	s.add_runtime_dependency "tty-spinner", "~> 0.1", "0.1.0"
-	s.add_runtime_dependency "sshkey", "~> 1.8", "1.8.0"
-	s.add_runtime_dependency "sshkit", "~> 1.8", "1.8.1"
+	s.add_runtime_dependency "thor", "~> 0.19", ">= 0.19.1"
+	s.add_runtime_dependency "tty-prompt", "~> 0.3", ">= 0.3.0"
+	s.add_runtime_dependency "tty-table", "~> 0.4", ">= 0.4.0"
+	s.add_runtime_dependency "tty-spinner", "~> 0.1", ">= 0.1.0"
+	s.add_runtime_dependency "sshkey", "~> 1.8", ">= 1.8.0"
+	s.add_runtime_dependency "sshkit", "~> 1.8", ">= 1.8.1"
 end

metadata

@@ -1,133 +1,133 @@
 --- !ruby/object:Gem::Specification
 name: redipress
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rediweb Hosting
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: tty-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: sshkey
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
 description: Automated server configuration!
@@ -137,7 +137,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - LICENSE
 - bin/redipress
 - lib/redipress.rb
@@ -161,12 +161,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []