redipress 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7e665f99ad7e65f8e7a770bb89bac107f18f4e6
-  data.tar.gz: 5cc3cd1b8e45d9d2e9695dc2aa830ae712d789b9
+  metadata.gz: 5c2e37489ceb11c694ea9f30235bd11ea7851606
+  data.tar.gz: 3cab0d8cff4698e51f41404e608cd4b14ad12fd2
 SHA512:
-  metadata.gz: bab2878d07607c672a8965d10214bd3db1b886dd8e88ed9a4704560ba80b4cc8d992ac265d8329edaca343f898aba93eee0c73f30ba842a4f9821a04c5aab2e5
-  data.tar.gz: ad7b794fbcf2a16fe31c29a3b2fa2b9f5371a2d23ee0d7dd73abfc9bc4f199a62302b3a1259124cf48a5bdf31e591c92185045b599e4429e67e4b933734217d5
+  metadata.gz: a4ee018f270c481ef65b7b41caa97aafd7e40c160919c96a49619ce1466bbb6120f4dedb563625098727257568abe7f7a8c756024e593cbfd46c5abdde3cb18b
+  data.tar.gz: 2f0a25992565743ae1bf9f05d4221fecf1d153a8a607ad5bf920c6e0edfc2a2c0bbfa6966f08446d4e84407d7fd4c04c436ea227dae7ef4ded31bc32a59aafee

data/lib/redipress/cli/configurations.rb

@@ -174,6 +174,9 @@ module RediPress
           if password
             # Set the password on the host
             host.password = password
+          else
+            # Load all ssh keys
+            RediPress::SSHKeys.load_ssh_keys
           end
 
           host
@@ -232,7 +235,7 @@ module RediPress
           configuration.parameters.each do |parameter|
             if :text == parameter.type
               options[parameter.slug] = prompt.ask(" #{parameter.name}:") do |q|
-                q.required(true)
+                q.required(parameter.required)
                 q.validate(parameter.validation) if parameter.validation
                 q.default(parameter.default) if parameter.default
               end

data/lib/redipress/cli/helper.rb

@@ -12,9 +12,6 @@ module RediPress
       #   => nil
       #
       def prepare
-        # Load all ssh keys
-        RediPress::SSHKeys.load_ssh_keys
-
         # Set the SSH Kit output verbosity to debug if verbose is enabled
         SSHKit.config.output_verbosity = Logger::DEBUG if options[:verbose]
 

data/lib/redipress/configuration/base.rb

@@ -23,11 +23,21 @@ module RediPress
         #   >>   name "Test"
         #   >> end
         #
-        def name(name = nil)
-          name.nil? ? @name : @name = name
+        def name(name)
+          @name = name
         end
 
-        # Add a parameter
+        # Get the name of the configuration
+        #
+        # Example:
+        #   >> configuration.class._name
+        #   => "Test"
+        #
+        def _name
+          @name
+        end
+
+        # Add a parameter to the configuration
         #
         # Arguments:
         #   slug: (String)
@@ -40,16 +50,28 @@ module RediPress
         #   >>   end
         #   >> end
         #
-        def parameter(slug = nil, &block)
+        def parameter(slug, &block)
+          return nil if slug.nil?
+
           @parameters ||= []
 
-          return @parameters if slug.nil?
+          return @parameters if @parameters.map { |p| p.slug }.include?(slug)
 
           parameter = RediPress::Parameter.new(slug)
           parameter.instance_eval(&block) if block_given?
 
           @parameters << parameter
         end
+
+        # Get the array of parameters for the configuration
+        #
+        # Example:
+        #   >> configuration.class._parameters
+        #   => [#<RediPress::Configuration::Parameter:0x00000000000000>]
+        #
+        def _parameters
+          @parameters
+        end
       end
 
       # Get the slug of the configuration
@@ -69,17 +91,17 @@ module RediPress
       #   => "Test"
       #
       def name
-        self.class.name
+        self.class._name
       end
 
       # Get the parameters for the configuration
       #
       # Example:
       #   >> configuration.parameters
-      #   => nil
+      #   => [#<RediPress::Configuration::Parameter:0x00000000000000>]
       #
       def parameters
-        self.class.parameter
+        self.class._parameters
       end
 
       # Convert the class to a string
@@ -117,10 +139,13 @@ module RediPress
       #
       # Example:
       #   >> configuration.configure(host, options)
-      #   => {}
+      #   => nil
+      #
+      # Raises:
+      #   RediPress::ConfigurationNotImplemented: If this method is not overriden
       #
       def configure(host, options)
-        raise RediPress::SetupNotImplemented
+        raise RediPress::ConfigurationNotImplemented
       end
 
       # Fail with an error
@@ -133,7 +158,7 @@ module RediPress
       #   => nil
       #
       # Raises:
-      #   RediPress::ConfigurationFailed: When this function is called
+      #   RediPress::ConfigurationFailed: When this method is called
       #
       def fail(error)
         raise RediPress::ConfigurationFailed.new(self, error)

data/lib/redipress/errors.rb

@@ -25,11 +25,11 @@ module RediPress
     end
   end
 
-  # A RuntimeError subclass for when the setup function has not been implemented.
+  # A NotImplementedError subclass for when the 'configure' method has not been implemented by a Configuration.
   #
-  class SetupNotImplemented < RuntimeError
+  class ConfigurationNotImplemented < NotImplementedError
     def to_s
-      "The setup function has not been implemented by the configuration."
+      "The 'configure' method has not been implemented by the configuration."
     end
   end
 

data/lib/redipress/parameter.rb

@@ -6,22 +6,29 @@ module RediPress
   # This class holds all paramaters required by a configuration.
   #
   class Parameter
-    attr_reader :slug, :options
+    attr_reader :slug, :required, :options
 
     # Setup an instance of the parameters class.
     #
+    # Arguments:
+    #   slug: (String|Symbol)
+    #
     # Example:
     #   >> RediPress::Parameter.new(:username)
-    #   => #<RediPress::Parameter:0x00000000000000 @slug=:username, @name="username">
+    #   => #<RediPress::Parameter:0x00000000000000>
     #
     def initialize(slug)
       @slug = slug
       @name = slug.to_s
+      @required = true
       @type = :text
     end
 
     # Set the name of the parameter
     #
+    # Arguments:
+    #   name: (String)
+    #
     # Example:
     #   >> parameter.name("Username")
     #   => "Username"
@@ -30,8 +37,27 @@ module RediPress
       name.nil? ? @name : @name = name
     end
 
+    # Set the parameter to required
+    #
+    # Available With Types:
+    #   :text
+    #
+    # Arguments:
+    #   required: (Boolean)
+    #
+    # Example:
+    #   >> parameter.required(true)
+    #   => true
+    #
+    def required(required = nil)
+      required.nil? ? @required : @required = required
+    end
+
     # Set the type of the parameter
     #
+    # Arguments:
+    #   type: (Symbol)
+    #
     # Example:
     #   >> parameter.type(:text)
     #   => :text
@@ -45,6 +71,9 @@ module RediPress
     # Available With types:
     #   :text
     #
+    # Arguments:
+    #   default: (String)
+    #
     # Example:
     #   >> parameter.default('rediwebhosting')
     #   => "rediwebhosting"
@@ -58,6 +87,9 @@ module RediPress
     # Available With types:
     #   :text
     #
+    # Arguments:
+    #   validation: (Regex)
+    #
     # Example:
     #   >> parameter.validation(/^[a-z]{4,}$/)
     #   => /^[a-z]{4,}$/
@@ -72,6 +104,9 @@ module RediPress
     #   :select
     #   :multi_select
     #
+    # Arguments:
+    #   option: (String)
+    #
     # Example:
     #   >> parameter.option('rediweb')
     #   => nil

data/lib/redipress/ssh.rb

@@ -32,7 +32,7 @@ module RediPress
       		keys: ssh_keys,
 
       		# Set the authentication methods
-      		auth_methods: %w(publickey password)
+      		auth_methods: %w(publickey)
       	}
       end
 

data/lib/redipress/variables.rb

@@ -1,5 +1,5 @@
 module RediPress
   # The current version of the gem.
   #
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redipress
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Rediweb Hosting
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor