cloud_powers 0.2.7.3 → 0.2.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 835648789bfd7165185fd1682e2a7698b2ef85aa
-  data.tar.gz: ea6df440b7d4ef9829f11ef006bc16835ee63cef
+  metadata.gz: 8b712a5dc3c312be905609c2a43d9ff32052b4a8
+  data.tar.gz: 70740c2e6ef22d80e42a4498b3e32cd63b0839ce
 SHA512:
-  metadata.gz: 6fa74220a8dab3735f0bd232a4d6d4cfb2f77ba217bda99798848198ed2b1a69931dd80d1f519a9b8dd8d0cd614a8b804b812683e8cb31986ea1ff80c5d23dfe
-  data.tar.gz: 29768d527166da29d65589e95c33e6bbb63e230fdbe0c50d4e7f14b3b42e3cc70d166b71240b87b243c9a509acaa1634e0fc4ad93c8893898a451aa7f8f6c53d
+  metadata.gz: 7fbf9e1557670cc4b141a95a40d250cb159bead6af7e05304a6e3e93c9b1f278936327b84ff4d46160edf68c58b0a5a62f04c4e15b9cce4e13afa22efbdfde33
+  data.tar.gz: 217462f8c359440603e8ecf925ff13006755a55d9d86db0ecd55628007938b596ebb07b6fba5dcafec20bc97d2ca0b0d608a15a6816d1f49bed0f973023e300e

data/Gemfile.lock

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

data/lib/cloud_powers/delegator.rb

@@ -6,12 +6,37 @@ require_relative 'storage'
 
 module Smash
   module CloudPowers
+    # The Delegator module is a way to dynamically source and use
+    # Ruby source code.  You pass a message or something that can
+    # respond to +#body()+ and give back a String.  The String should
+    # be the name of the class you're trying to instantiate and use
     module Delegator
       extend Smash::CloudPowers::Auth
-      include Smash::CloudPowers::AwsResources
+      include Smash::CloudPowaters::AwsResources
       include Smash::CloudPowers::Helper
       include Smash::CloudPowers::Storage
 
+      # responsible for sourcing, loading into the global namespace
+      # and use of Ruby source code, through the +#new()+ method on
+      # that class
+      #
+      # Parameters
+      # * id +String+ - the instance id of the calling node.  This gets
+      #   used in communication tools etc.
+      # * msg - Anything that responds to +#body()+ and returns a String
+      #   that can be used in the search for the file in your local and S3
+      #   bucket locations
+      #
+      # Returns
+      # +Object+ - a newly instantiated object of the class that matches
+      # the name retrieved from the +msg+ parameter
+      #
+      # Example
+      #   class Job; include Smash::CloudPowers::Delegator; end
+      #   job = Job.new
+      #   # the message responds to +#body()+ with "ExampleTask"
+      #   job.build('abc-1234', Aws::SQS::Message)
+      #   # => +ExampleTask:Object+
       def build(id, msg)
         body = JSON.parse(msg.body)
         begin
@@ -30,8 +55,17 @@ module Smash
         end
       end
 
+      # Predicate method to return true for valid job titles and false for invalid ones
+      #
+      # Parameters
+      # * name +String+ (optional) - name of the task in snake_case
+      #
+      # Returns
+      # +Boolean+
+      #
+      # Notes
+      # * TODO: needs improvement
       def approved_task?(name = nil)
-        # TODO: improve this
         ['demo', 'testinz'].include? to_snake(name)
       end
     end

data/lib/cloud_powers/version.rb

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

data/lib/cloud_powers/zenv.rb

@@ -91,9 +91,11 @@ module Smash
 
       # Manually set the +@project_root+ i-var as a +Pathname+ object.
       #
-      # Parameters New path to the project root +String+|+Pathname+
+      # Parameters
+      # * +String+|+Pathname+ - new path to the project root
       #
-      # Returns +Pathname+ - +@project_root+
+      # Returns
+      # +Pathname+ - +@project_root+
       #
       # Example
       #   project_root
@@ -108,7 +110,8 @@ module Smash
       # Search through the system environment variables for a key or if no key
       # is given, return all the system-env-vars and their values
       #
-      # Parameters [key <String>]:  The key to search for
+      # Parameters
+      # * key +String+ - the key to search for
       #
       # Returns
       # * if a +key+ is given as a parameter, +String+
@@ -145,7 +148,7 @@ module Smash
       # * key +String+|+Symbol+ - the key to search for
       #
       # Returns
-      # +String+
+      # * +String+
       #
       # Notes
       # * TODO: implement a search for all 3 that can find close matches

metadata

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