cloud_powers 0.2.7.4 → 0.2.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b712a5dc3c312be905609c2a43d9ff32052b4a8
-  data.tar.gz: 70740c2e6ef22d80e42a4498b3e32cd63b0839ce
+  metadata.gz: fd1ef85d301fd73bf38db0132fcbe17db2bff9cf
+  data.tar.gz: 5c6dc0a78d34e694a66e3a77549d128eecc4b050
 SHA512:
-  metadata.gz: 7fbf9e1557670cc4b141a95a40d250cb159bead6af7e05304a6e3e93c9b1f278936327b84ff4d46160edf68c58b0a5a62f04c4e15b9cce4e13afa22efbdfde33
-  data.tar.gz: 217462f8c359440603e8ecf925ff13006755a55d9d86db0ecd55628007938b596ebb07b6fba5dcafec20bc97d2ca0b0d608a15a6816d1f49bed0f973023e300e
+  metadata.gz: bf6eb4c1cc74ed62eba6312d179914865a8e9ef2369d545c2e445a1152111a2e7f05650c6054c50dd4622b7072147d6e6c1ec9ce41917dc346e3879f1ce5201d
+  data.tar.gz: c1e07579e5e8b22719870a23d8782d7c2653476ced2e3fc3b2a358646ebf2fec8840f81bc5d91a7bad35f144908073664df43141e227b0bf22ea70202a7e0a3a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloud_powers (0.2.7.4)
+    cloud_powers (0.2.7.5)
       activesupport-core-ext (~> 4)
       aws-sdk (~> 2)
       dotenv (~> 2.1)

data/lib/cloud_powers/delegator.rb

@@ -12,7 +12,7 @@ module Smash
     # be the name of the class you're trying to instantiate and use
     module Delegator
       extend Smash::CloudPowers::Auth
-      include Smash::CloudPowaters::AwsResources
+      include Smash::CloudPowers::AwsResources
       include Smash::CloudPowers::Helper
       include Smash::CloudPowers::Storage
 

data/lib/cloud_powers/helper.rb

@@ -40,10 +40,12 @@ module Smash
 
       # This is a way to find out if you are trying to work with a resource
       # available to CloudPowers
+      #
       # Returns <Array>
-      #   * Use `.constants` to find all the modules and classes available.
-      # Notes:
-      #   TODO: make this smartly pick up all the objects, within reason and
+      # Use +.constants+ to find all the modules and classes available.
+      #
+      # Notes
+      # * TODO: make this smartly pick up all the objects, within reason and
       #   considering need, that we have access to
       def available_resources
         [:Task].concat(Smash::CloudPowers.constants)
@@ -52,32 +54,49 @@ module Smash
       # Does its best job at guessing where this method was called from, in terms
       # of where it is located on the file system.  It helps track down where a
       # project root is etc.
+      #
+      # Returns
+      # +String+
+      #
+      # Notes
+      # * Uses +$0+ to figure out what the current file is
       def called_from
         File.expand_path(File.dirname($0))
       end
 
       # creates a default logger
-      # Notes:
-      #   * TODO: at least make this have overridable defaults
-      def create_logger
-        logger = Logger.new(STDOUT)
+      #
+      # Parameters
+      # * log_to +String+ (optional) - location to send logging information to; default is STDOUT
+      #
+      # Returns
+      # +Logger+
+      #
+      # Notes
+      # * TODO: at least make this have overridable defaults
+      def create_logger(log_to = STDOUT)
+        logger = Logger.new(log_to)
         logger.datetime_format = '%Y-%m-%d %H:%M:%S'
         logger
       end
 
       # Allows you to modify all keys, including nested, with a block that you pass.
       # If no block is passed, a copy is returned.
+      #
       # Parameters
-      #   * params Hash|Array
-      # === @&block (optional)
-      #   * should modify the key and return that value so it can be used in the copy
+      # * params +Hash+|+Array+ - hash to be modified
+      # * +block+ (optional) - a block to be used to modify each key should
+      #   modify the key and return that value so it can be used in the copy
+      #
       # Returns
-      #   * a copy of the given Array or Hash, with all Hash keys modified
-      # === Sample use:
+      # +Hash+|+Array+ - a copy of the given Array or Hash, with all Hash keys modified
+      #
+      # Example
       #   hash = { 'foo' => 'v1', 'bar' => { fleep: { 'florp' => 'yo' } } }
       #   modify_keys_with(hash) { |key| key.to_sym }
       #   # => { foo: 'v1', bar: { fleep: { florp: 'yo' } } }
-      # Notes:
+      #
+      # Notes
       #   * see `#modify_keys_with()` for handling first-level keys
       #   * see `#pass_the_buck()` for the way nested structures are handled
       #   * case for different types taken from _MultiXML_ (multi_xml.rb)
@@ -110,6 +129,12 @@ module Smash
       end
 
       # Join the message and backtrace into a String with line breaks
+      #
+      # Parameters
+      # * error +Exception+
+      #
+      # Returns
+      # +String+
       def format_error_message(error)
         begin
           [error.message, error.backtrace.join("\n")].join("\n")
@@ -120,31 +145,45 @@ module Smash
       end
 
       # Gets the path from the environment and sets @log_file using the path
-      # Returns @log_file path <String>
+      #
+      # Returns
+      # @log_file +String+
+      #
+      # Notes
+      # * See +#zfind()+
       def log_file
         @log_file ||= zfind('LOG_FILE')
       end
 
-      # Returns An instance of Logger, cached as @logger
+      # Returns An instance of Logger, cached as @logger@log_file path <String>
+      #
+      # Returns
+      # +Logger+
+      #
+      # Notes
+      # * See +#create_logger+
       def logger
         @logger ||= create_logger
       end
 
       # Allows you to modify all first-level keys with a block that you pass.
       # If no block is passed, a copy is returned.
+      #
       # Parameters
-      #   * params Hash|Array
-      # === @&block (optional)
-      #   * should modify the key and return that value so it can be used in the copy
+      # * params +Hash+|+Array+
+      # * block (optional) - should modify the key and return that value so it can be used in the copy
+      #
       # Returns
-      #   * a copy of the given Array or Hash, with all Hash keys modified
-      # === Sample use:
+      # +Hash+|+Array+ - a copy of the given Array or Hash, with all Hash keys modified
+      #
+      # Example
       #   hash = { 'foo' => 'v1', 'bar' => { fleep: { 'florp' => 'yo' } } }
       #   modify_keys_with(hash) { |k| k.to_sym }
       #   # => { :foo => 'v1', :bar => { fleep: { 'florp' => 'yo' } } }
-      # Notes:
-      #   * see `#deep_modify_keys_with()` for handling nested keys
-      #   * case for different types taken from _MultiXML_ (multi_xml.rb)
+      #
+      # Notes
+      # * see +#deep_modify_keys_with()+ for handling nested keys
+      # * case for different types taken from _MultiXML_ (multi_xml.rb)
       def modify_keys_with(params)
         params.inject({}) do |carry, (k, v)|
           carry.tap do |h|
@@ -158,15 +197,17 @@ module Smash
       # until another bit of logic does what it's supposed to, kind of like
       # continuing to poll something and doing something when a package is ready
       # to be taken and processed.
+      #
       # Parameters
-      #   * [allowed_attempts] or Infinity(default) <Number>: The number of times
-      #       the loop should be allowed to...well, loop, before a failed retry occurs.
-      #   * &test <Block>: A predicate method or block of code that is callable
-      #       is used to test if the block being retried is successful yet.
-      #   * []
-      # Sample usage:
-      # check_stuff = lambda { |params| return true }
-      # smart_retry(3, check_stuff(params)) { do_stuff_that_needs_to_be_checked }
+      # * allowed_attempts +Number+|+Infinity(default)+ - The number of times
+      #   the loop should be allowed to...well, loop, before a failed retry occurs.
+      # * &test +Block+ - A predicate method or block of code that is callable
+      #   is used to test if the block being retried is successful yet.
+      # * []
+      #
+      # Example
+      #   check_stuff = lambda { |params| return true }
+      #   smart_retry(3, check_stuff(params)) { do_stuff_that_needs_to_be_checked }
       def smart_retry(test, allowed_attempts = Float::INFINITY)
         result = yield if block_given?
         tries = 1
@@ -178,32 +219,45 @@ module Smash
       end
 
       # Gives the path from the project root to lib/tasks[/#{file}.rb]
+      #
       # Parameters
-      #   * [file] <String>: name of a file
+      # * file +String+ (optional) (default is '') - name of a file
+      #
       # Returns
-      #   * path[/file] <String>
-      #   * If a `file` is given, it will have a '.rb' file extension
-      #   * If no `file` is given, it will return the `#task_require_path`
+      # * path/file +String+ if +file+ parameter is given.  return has
+      #   '.rb' extension included
+      # * file +String+ if +file+ parameter is not given it will return the <tt>#task_require_path()</tt>
+      #
+      # Notes
+      # * See <tt>#task_require_path()</tt>
       def task_path(file = '')
         return task_require_path if file.empty?
         Pathname(__FILE__).parent.dirname + 'tasks' + to_ruby_file_name(file)
       end
 
       # Gives the path from the project root to lib/tasks[/file]
+      #
       # Parameters String (optional)
-      #   * file_name name of a file
-      # ===  @returns:
-      #   * path[/file] String
-      #   * Neither path nor file will have a file extension
+      # * file_name name of a file
+      #
+      # Returns
+      # * path/file +String+ if +file_name+ was given
+      # * path to task_directory if +file_name+ was <i>not</i> given
+      #
+      # Notes
+      # * Neither path nor file will have a file extension
       def task_require_path(file_name = '')
         file = File.basename(file_name, File.extname(file_name))
         Pathname(__FILE__).parent.dirname + 'tasks' + file
       end
 
       # Change strings into camelCase
-      # Parameters var String
-      # Returns String
-      #     * givenString
+      #
+      # Parameters
+      # * var +String+
+      #
+      # Returns
+      # +String+
       def to_camel(var)
         var = var.to_s unless var.kind_of? String
         step_one = to_snake(var)
@@ -211,10 +265,13 @@ module Smash
         step_two[0, 1].downcase + step_two[1..-1]
       end
 
-      # Change strings hyphen-delimited-string
-      # Parameters var String
-      # Returns String
-      #     * given-string
+      # Change strings into a hyphen delimited phrase
+      #
+      # Parameters
+      # * var +String+
+      #
+      # Returns
+      # +String+
       def to_hyph(var)
         var = var.to_s unless var.kind_of? String
 
@@ -227,40 +284,58 @@ module Smash
           downcase
       end
 
-      # Change strings into snake_case and add '@' at the front
-      # Parameters var String
-      # Returns String
-      #     * @given_string
+      # Change strings into an i-var format
+      #
+      # Parameters
+      # * var +String+
+      #
+      # Returns
+      # +String+
       def to_i_var(var)
         var = var.to_s unless var.kind_of? String
         /^\W*@\w+/ =~ var ? to_snake(var) : "@#{to_snake(var)}"
       end
 
       # Change strings into PascalCase
-      # Parameters var String
-      # Returns String
-      #     * givenString
+      #
+      # Parameters
+      # * var +String+
+      #
+      # Returns
+      # +String+
       def to_pascal(var)
         var = var.to_s unless var.kind_of? String
         var.gsub(/^(.{1})|\W.{1}|\_.{1}/) { |s| s.gsub(/[^a-z0-9]+/i, '').capitalize }
       end
 
       # Change strings into a ruby_file_name with extension
-      # Parameters var String
-      # Returns String
-      #     * given_string.rb
-      #     * includes ruby file extension
-      #     * see #to_snake()
+      #
+      # Parameters
+      # * var +String+
+      #
+      # Returns
+      # +String+
+      #
+      # Notes
+      # * given_string.rb
+      # * includes ruby file extension
+      # * see #to_snake()
       def to_ruby_file_name(name)
         name[/\.rb$/].nil? ? "#{to_snake(name)}.rb" : "#{to_snake(name)}"
       end
 
-      # Change strings into snake_case
-      # Parameters var String
-      # Returns String
-      #     * given_string
-      #     * will not have file extensions
-      #     * see #to_ruby_file_name()
+      # Change strings into PascalCase
+      #
+      # Parameters
+      # * var +String+
+      #
+      # Returns
+      # +String+
+      #
+      # Notes
+      # * given_string
+      # * will not have file extensions
+      # * see #to_ruby_file_name()
       def to_snake(var)
         var = var.to_s unless var.kind_of? String
 
@@ -274,13 +349,15 @@ module Smash
 
       # This method provides a default overrideable message body for things like
       # basic status updates.
-      # Parameters Hash
-      #   - instanceId:
-      # Notes:
-      #   - camel casing is used on the keys because most other languages prefer
+      #
+      # Parameters
+      # * instanceId +Hash+
+      #
+      # Notes
+      # * camel casing is used on the keys because most other languages prefer
       #   that and it's not a huge problem in ruby.  Besides, there's some other
       #   handy methods in this module to get you through those issues, like
-      #   `#to_snake()` and or `#symbolize_keys_with()`
+      #   +#to_snake()+ and or +#modify_keys_with()+
       def update_message_body(opts = {})
         # TODO: Better implementation of merging message bodies and config needed
         unless opts.kind_of? Hash
@@ -298,6 +375,13 @@ module Smash
         }.merge(opts)
       end
 
+      # Predicate method to check if a String is parsable, as JSON
+      #
+      # Parameters
+      # * json +String+
+      #
+      # Returns
+      # +Boolean+
       def valid_json?(json)
         begin
           JSON.parse(json)
@@ -307,6 +391,13 @@ module Smash
         end
       end
 
+      # Predicate method to check if a String is a valid URL
+      #
+      # Parameters
+      # * url +String+
+      #
+      # Returns
+      # +Boolean+
       def valid_url?(url)
         url =~ /\A#{URI::regexp}\z/
       end

data/lib/cloud_powers/node.rb

@@ -10,9 +10,12 @@ module Smash
       include Smash::CloudPowers::Helper
       include Smash::CloudPowers::SelfAwareness
       include Smash::CloudPowers::Zenv
+
       # These are sensible defaults that can be overriden by providing a Hash as a param.
-      # Parameters [opts <Hash>]
-      #   the opts Hash should have values that should be used instead of the given
+      #
+      # Parameters
+      # * opts +Hash+ (optional)
+      #   the opts Hash should have values that should be used instead of the default
       #   configuration.
       def node_config(opts = {})
         {
@@ -30,13 +33,14 @@ module Smash
         }.merge(opts)
       end
 
-      # Uses `Aws::EC2#run_instances` to create nodes (Neurons or Cerebrums), at
+      # Uses +Aws::EC2#run_instances()+ to create nodes (Neurons or Cerebrums), at
       # a rate of 0..(n <= 100) at a time, until the required number of instances
       # has been started.  The #instance_config() method is used to create instance
       # configuration for the #run_instances method by using the opts hash that was
       # provided as a parameter.
       #
-      # Parameters opts Hash (optional)
+      # Parameters
+      # * opts +Hash+ (optional)
       #   an optional instance configuration hash can be passed, which will override
       #   the values in the default configuration returned by #instance_config()
       def spin_up_neurons(opts = {})

data/lib/cloud_powers/self_awareness.rb

@@ -17,8 +17,11 @@ module Smash
 
       # Gets the instance time or the time it was called and as seconds from
       # epoch
+      #
       # Returns Integer
-      # TODO: use time codes
+      #
+      # Notes
+      # * TODO: use time codes
       def boot_time
         begin
           @boot_time ||=
@@ -59,6 +62,14 @@ module Smash
 
       # Get resource metadata, public host, boot time and task name
       # and set them as instance variables
+      #
+      # Returns
+      # +Array+ of values, each from a separate key, set in the order
+      # in the Array
+      #
+      # Notes
+      # * See +#metadata_request()+
+      # * See +#attr_map!()+
       def get_awareness!
         keys = metadata_request
         attr_map!(keys) { |key| metadata_request(key) }
@@ -68,18 +79,21 @@ module Smash
       end
 
       # Assures there is always a valid instance id because many other Aws calls require it
-      # Returns String
+      #
+      # Returns
+      # +String+
       def instance_id
         @instance_id ||= metadata_request('instance_id')
       end
 
       # Gets and sets the public hostname of the instance
+      #
       # Returns
-      #   +String+
+      # +String+ - the Public Hostname for this instance
+      #
       # Notes
-      # When this is being called from somewhere other than an Aws instance,
-      # a hardcoded example URL is returned
-      # because of the way instance metadata is retrieved
+      # * When this is being called from somewhere other than an Aws instance,
+      #   a hardcoded example URL is returned because of the way instance metadata is retrieved
       def instance_url
         @instance_url ||= unless zfind('TESTING')
           hostname_uri = 'http://169.254.169.254/latest/meta-data/public-hostname'
@@ -94,11 +108,18 @@ module Smash
       # particular key from the metadata
       #
       # Parameters
-      # * <tt>key</tt> - +String+ (optional)
+      # * key +String+ (optional) (default is '') - the key for the metadata information
+      #   you want from this instance.
       #
       # Returns
       # * +Array+ if key is blank
       # * +String+ if key is given
+      #
+      # Example
+      #   metadata_request
+      #   # => a +Hash+ containing every key => value pair AWS provides
+      #   metadata_request('instance-id')
+      #   # => 'abc-1234'
       def metadata_request(key = '')
         key = to_hyph(key)
         begin
@@ -117,8 +138,11 @@ module Smash
       end
 
       # Return the time since boot_time
-      # Returns Integer
-      # Notes:
+      #
+      # Returns
+      # +Integer+
+      #
+      # Notes
       # * TODO: refactor to use valid time stamps for better tracking.
       # * reason -> separate regions or OSs etc.
       def run_time
@@ -126,6 +150,11 @@ module Smash
       end
 
       # Send a message on a Pipe at an interval
+      #
+      # Parameters
+      # * opts +Hash+ (optional)
+      # * * +:interval+ - how long to wait between sending updates
+      # * * +:stream_name+ - name of stream you want to use
       def send_frequent_status_updates(opts = {})
         sleep_time = opts.delete(:interval) || 10
         stream = opts.delete(:stream_name)
@@ -138,8 +167,10 @@ module Smash
       end
 
       # Get the instance status.
-      # Parameters id String (optional)
-      #     * if no id is given, self-instance ID is returned
+      #
+      # Parameters
+      # * id +String+ (optional) (default is @instance_id)
+      #
       # Returns String
       def status(id = @instance_id)
         begin
@@ -153,8 +184,13 @@ module Smash
 
       # Check self-tags for 'task' and act as an attr_accessor.
       # A different node's tag's can be checked for a task by passing
-      # the id param
-      # see also: SelfAwareness#task_names
+      # that instance's id as a parameter
+      #
+      # Parameters
+      # * id +String+ (optional) (default is @instance_id) - instance you want a tag from
+      #
+      # Returns
+      # +String+
       def task_name(id = @instance_id)
         # get @task_name
         return @task_name unless @task_name.nil?
@@ -171,6 +207,10 @@ module Smash
       # * The run time is more than 5 minutes
       # and
       # * The run time is 5 minutes from the hour mark from when the instance started
+      # and will return false otherwise
+      #
+      # Returns
+      # +Boolean+
       def time_is_up?
         an_hours_time = 60 * 60
         five_minutes_time = 60 * 5

data/lib/cloud_powers/synapse/pipe/pipe.rb

@@ -42,7 +42,7 @@ module Smash
         # Parameters stream String
         #
         # Notes
-        # This method is not implemented yet (V 0.2.7)
+        # * This method is not implemented yet (V 0.2.7)
         def flow_from_pipe(stream)
           throw NotImplementedError
         end
@@ -57,7 +57,7 @@ module Smash
         # @last_sequence_number +String+
         #
         # Notes
-        # This method is not implemented yet (V 0.2.7)
+        # * This method is not implemented yet (V 0.2.7)
         def flow_to_pipe(stream)
           throw NotImplementedError
           create_stream(stream) unless stream_exists? stream
@@ -75,7 +75,7 @@ module Smash
         # Parameters stream String
         #
         # Notes
-        # This method is not implemented yet (V 0.2.7)
+        # * This method is not implemented yet (V 0.2.7)
         def from_pipe(stream)
           # implement get_records and/or other consuming app stuff
           throw NotImplementedError
@@ -87,7 +87,7 @@ module Smash
         # * records
         #
         # Notes
-        # This method is not implemented yet (V 0.2.7)
+        # * This method is not implemented yet (V 0.2.7)
         def message_body_collection(records)
           throw NotImplementedError
         end
@@ -103,7 +103,7 @@ module Smash
         # Returns
         # +Hash+
         #
-        # Notes:
+        # Notes
         # * See +#zfind()+
         # * See +#instance_id()+
         # * See +#update_message_body()+
@@ -125,7 +125,7 @@ module Smash
         # Returns
         # the sequence_number from the sent message.
         #
-        # Example use
+        # Example
         #   pipe_to(:status_stream) do
         #     # the return from the inner method is what is sent
         #     do_some_stuff_to_generate_a_message()
@@ -174,8 +174,8 @@ module Smash
         # Parameters
         # *name +String+
         #
-        # Returns stream status, one of:
-        # CREATING, DELETING, ACTIVE, UPDATING
+        # Returns
+        # +String+ - stream status, one of: CREATING, DELETING, ACTIVE or UPDATING
         def stream_status(name)
           kinesis.describe_stream(stream_name: name).stream_description.stream_status
         end

data/lib/cloud_powers/synapse/queue/queue.rb

@@ -237,7 +237,7 @@ module Smash
         # Returns
         # Boolean
         #
-        # Notes:
+        # Notes
         #   * see <tt>#queue_search()</tt>
         def queue_exists?(name)
           !queue_search(name).empty?

data/lib/cloud_powers/version.rb

@@ -1,3 +1,3 @@
 module CloudPowers
-  VERSION = "0.2.7.4"
+  VERSION = "0.2.7.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_powers
 version: !ruby/object:Gem::Version
-  version: 0.2.7.4
+  version: 0.2.7.5
 platform: ruby
 authors:
 - Adam Phillipps