cloud_powers 0.2.7.1 → 0.2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f93298a530fa939a15a4e6631b7cda3bc64e558d
-  data.tar.gz: 6f0498a0f808e3aa52cfefe4a58878a6393ae929
+  metadata.gz: 2903624136e4fac9b36e82f2374ba9f9dc640661
+  data.tar.gz: 6baf7a5cbcdff6352d626e8fd709025f8fd246fc
 SHA512:
-  metadata.gz: 1516b53957f5229ef3ea64ac37f639262060a0337dbcdbae46ff584c5f03f23018cc284097b34f7813186d5fa0f3cbd76b0a5d1100662eeacc65532789e340dc
-  data.tar.gz: 0ab5d2c4213506152e93c21cbcc76153a10c967df3283531615e43898898f8ec8f66816c4be115675856fe67ec2f78f98cf4fb454b02046677c280d570d2bf6b
+  metadata.gz: 63905c6b21fee990c6e5d92c89c603866f5d4bee8ec545615c9172d3a684a462ca969fb0fb0b0318bfd50eff3723f6fe49a8992427aec00a4f3c9ac5273a2c61
+  data.tar.gz: 75788dace7b21879318c8b0a666bba446823cc3616b135a9b29bc7fb98d90dd355708743a72e37b08eb09e4e5d7215227a031c002952c68dc0c5e0bd73e648be

data/Gemfile.lock

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

data/lib/cloud_powers/auth.rb

@@ -13,12 +13,16 @@ module Smash
       # resources in the account that zfind searches for, using the <tt>ACCOUNT_NUMBER</tt>
       # key.
       #
-      # === Returns
+      # Returns
       # <tt>Aws::Credentials</tt>
       #
-      # === Example
+      # Example
       #   Auth.creds
-      #   => Aws::Credentials
+      #   => Aws::Credentials # can be used to authenticate to AWS
+      #
+      # Notes
+      # * This method relies on +#zfind()+ to locate the key/secret strings
+      # * See +Smash::CloudPowers::Zenv#zfind()+
       def self.creds
         @creds ||= Aws::Credentials.new(
           zfind(:aws_access_key_id),
@@ -29,10 +33,10 @@ module Smash
       # This method is able to be called before an object is instantiated in order
       # to provide a region in AWS-landia.
       #
-      # === Returns
+      # Returns
       # The region set in configuration or a <tt>'us-west-2'</tt> default <tt>String</tt>
       #
-      # === Example
+      # Example
       #   Auth.region
       #   => 'us-east-1'
       def self.region

data/lib/cloud_powers/aws_resources.rb

@@ -11,7 +11,7 @@ module Smash
 
       # Get the region from the environment/context or use a default region for AWS API calls.
       #
-      # === Returns
+      # Returns
       # +String+
       def region
         zfind(:aws_region) || 'us-west-2'
@@ -25,10 +25,10 @@ module Smash
       # * * region - defaulted to use the <tt>#region()</tt> method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
-      # <tt>AWS::EC2::Client</tt>
+      # Returns
+      # +AWS::EC2::Client+
       #
-      # === Sample Usage
+      # Example
       #   images = ec2.describe_images
       #   images.first[:image_id]
       #   # => 'asdf'
@@ -53,7 +53,7 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # Aws::EC2::Image
       def image(name, opts = {})
         config = {
@@ -65,16 +65,17 @@ module Smash
       end
 
       # Get or create an Kinesis client and cache that client so that a Context is more well tied together
+      #
       # Parameters
       # * opts <tt>Hash</tt>
       # * * stub_responses: defaulted to false but it can be overriden with the desired responses for local testing
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
-      # AWS::Kinesis client
+      # Returns
+      # +AWS::Kinesis client+
       #
-      # === Example
+      # Example
       #   pipe_to('somePipe') { update_body(status: 'waHoo') } # uses Aws::Kinesis::Client.put_recor()
       #   # => sequence_number: '1676151970'
       def kinesis(opts = {})
@@ -96,12 +97,12 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
-      # AWS::S3 client
+      # Returns
+      # +AWS::S3 client+
       #
-      # === Example
-      #   expect(s3.head_bucket).to be_empty
-      #   # passing expectation
+      # Example
+      #   expect(s3.head_bucket('exampleBucket')).to be_empty
+      #   # passing test
       def s3(opts = {})
         config = {
           stub_responses: false,
@@ -120,10 +121,10 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
-      # AWS::SNS client
+      # Returns
+      # +AWS::SNS client+
       #
-      # === Example
+      # Example
       #   create_channel!('testBroadcast') # uses Aws::SNS::Client
       #   # => true
       def sns(opts = {})
@@ -145,10 +146,10 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
-      # AWS::SQS client
+      # Returns
+      # +AWS::SQS client+
       #
-      # === Example
+      # Example
       #   create_queue('someQueue') # Uses Aws::SQS::Client
       def sqs(opts = {})
         config = {

data/lib/cloud_powers/self_awareness.rb

@@ -96,7 +96,7 @@ module Smash
       # Parameters
       # * <tt>key</tt> - +String+ (optional)
       #
-      # === Returns
+      # Returns
       # * +Array+ if key is blank
       # * +String+ if key is given
       def metadata_request(key = '')

data/lib/cloud_powers/storage.rb

@@ -6,6 +6,38 @@ module Smash
     module Storage
       include Smash::CloudPowers::AwsResources
 
+      # Searches a local task storage location for the given +file+ name
+      # if it exists - exit the method
+      # if it does <i>not</i> exist - get the file from s3 and place it in
+      # the directory that was just searched bucket using +#zfind()+
+      #
+      # Parameters
+      # * file +String+ - the name of the file we're searching for
+      #
+      # Returns
+      # nothing
+      #
+      # Example
+      # * file tree
+      #     project_root- |
+      #                   |_sub_directory
+      #                   |              |_current_file.rb
+      #                   |_task_storage
+      #                   |             |_demorific.rb
+      #                   |             |_foobar.rb
+      # * code:
+      #     source_task('demorific')
+      #     # file tree doesn't change because this file exists
+      #     source_task('custom_greetings')
+      #     # file tree now looks like this
+      # * new file tree
+      #     project_root- |
+      #                   |_sub_directory
+      #                   |              |_current_file.rb
+      #                   |_task_storage
+      #                   |             |_demorific.rb
+      #                   |             |_foobar.rb
+      #                   |             |_custom_greetings.js # could be an after effects JS script
       def source_task(file)
         # TODO: better path management
         bucket = zfind('task storage')
@@ -19,17 +51,33 @@ module Smash
         end
       end
 
+      # Search through a bucket to find a file, based on a regex
+      #
+      # Parameters
+      # * bucket +String+ - the bucket to search through in AWS
+      # * pattern +Regex+ - the Regex pattern you want to use for the
+      #   search
+      #
+      # Example
+      #   matches = search('neuronTasks', /[Dd]emo\w*/)
+      #   # => ['Aws::S3::Type::ListObjectOutPut','Aws::S3::Type::ListObjectOutPut',...] # anything that matched that regex
+      #   matches.first.contents.size
+      #   # => 238934 # integer representation of the file size
       def search(bucket, pattern)
         s3.list_objects(bucket: bucket).contents.select do |o|
           o.key =~ pattern
         end
       end
 
+      # Send the log files to the S3 log file bucket
+      #
+      # Returns
+      # +Aws::S3::Type::PutObjectOutput+
       def send_logs_to_s3
         File.open(log_file) do |file|
           s3.put_object(
             bucket: log_bucket,
-            key: @instance_id,
+            key: instance_id,
             body: file
           )
         end

data/lib/cloud_powers/synapse/broadcast/broadcast.rb

@@ -29,6 +29,7 @@ module Smash
         #################
 
         # Creates a connection point for 1..N nodes to create a connection with the Broadcast
+        # <b>Not Implimented</b>
         #
         # Parameters
         # * channel +String+
@@ -60,6 +61,7 @@ module Smash
         end
 
         # Creates a connection to the Broadcast so that new messages will be picked up
+        #
         # Parameters channel <Broadcast::Channel>
         def listen_on(channel)
           sns.subscribe(
@@ -70,6 +72,7 @@ module Smash
         end
 
         # Lists the created topics in SNS.
+        #
         # Returns results <Array
         def real_channels
           results = []
@@ -84,9 +87,13 @@ module Smash
         end
 
         # Send a message to a Channel using SNS#publish
-        # Parameters [opts <Hash>]:
-        #   this includes all the keys AWS uses but for now it only has defaults
+        #
+        # Parameters
+        # * opts +Hash+ - this includes all the keys AWS uses but for now it only has defaults
         #   for topic_arn and the message
+        # * * +:topic_arn+ - the ARN for the topic in AWS
+        # * * +:message+ - the message that should be broadcasted to whoever is listening on this
+        #     Channel (AWS Topic)
         def send_broadcast(opts = {})
           msg = opts.delete(:message) || ""
 

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

@@ -38,6 +38,7 @@ module Smash
         end
 
         # Use the KCL and LangDaemon to read from a stream
+        #
         # Parameters stream String
         #
         # Notes
@@ -70,6 +71,7 @@ module Smash
         end
 
         # Read messages from the Pipe without using the KCL
+        #
         # Parameters stream String
         #
         # Notes

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

@@ -10,7 +10,14 @@ module Smash
           include Smash::CloudPowers::Helper
           include Smash::CloudPowers::Zenv
 
-          attr_accessor :address, :name, :poller, :sqs
+          # The URL the Aws::SQS::Queue uses
+          attr_accessor :address
+          # The name the Aws::SQS::Queue uses
+          attr_accessor :name
+          # An Aws::SQS::QueuePoller for this Board/SQS::Queue
+          attr_accessor :poller
+          # An Aws::SQS::Client.  See +#Smash::CloudPowers::AwsResources.sqs()+
+          attr_accessor :sqs
 
           # Creates a Board object.
           # The +#new()+ method is wrapped in +#build()+ and +#create!()+ but isn't private so
@@ -22,7 +29,7 @@ module Smash
           #
           # Returns
           # +Queue::Board+
-          def initialize(name, this_sqs)# = sqs)
+          def initialize(name, this_sqs = sqs)
             @sqs = this_sqs
             @name = name
           end

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

@@ -11,13 +11,24 @@ module Smash
         # A simple Struct that acts as a Name to URL map
         #
         # Parameters
-        # * <tt>:set_name</tt> - name of the Queue +String+
-        # * <tt>:set_url</tt> - the url for the Queue +String+
+        # * :set_name +String+ (optional) - An optional name.  It should be the same name as the
+        #   the Board and/or Queue you're working with, or else this Struct isn't that useful
+        # * :set_url +String+ (optional) - An optional URL.  It should be the same URL as the
+        #   the Board and/or Queue you're working with, or else this Struct isn't that useful
+        #
+        # Attributes
+        # * name +String+ - the +:set_name+ or parse the +#address()+ for the name
+        # * url +String+ - the +:set_url+ or add the name to the end of a best guess at the URL
         #
         # Example
-        #  name_url_map = NUMap.new(nil, 'https://sqs.us-west-53.amazonaws.com/001101010010/fooBar')
-        #  name_url_map.name
-        #  # => 'fooBar'
+        #   name_url_map = NUMap.new(nil, 'https://sqs.us-west-53.amazonaws.com/001101010010/fooBar')
+        #   name_url_map.name
+        #   # => 'fooBar'
+        #
+        #   # and now in reverse
+        #   url_name_map = NUMap.new('snargleBargle')
+        #   url_name_map.address
+        #   # => 'https://sqs.us-west-53.amazonaws.com/001101010010/snargleBargle'
         NUMap = Struct.new(:set_name, :set_url) do
           # Gives you back the name, even if it hasn't been set
           #

data/lib/cloud_powers/version.rb

@@ -1,3 +1,3 @@
 module CloudPowers
-  VERSION = "0.2.7.1"
+  VERSION = "0.2.7.2"
 end

data/lib/cloud_powers/zenv.rb

@@ -1,17 +1,25 @@
 require 'dotenv'
 require_relative 'helper'
+
 module Smash
   module CloudPowers
     # This module provides some environment variable management and functionality
+    # Hopefully it should provide us with some "Zen", when dealing with normally
+    # annoying env issues.  Meh, it probably won't but I like the name, so it stays :}
     # System ENV, dotenv ENV and instance variables are considered for now but this
-    # will also use elasticache/redis...some other stuff too, in the coming weeks
+    # will also use elasticache/redis...some other stuff too, in the coming versions
     module Zenv
       include Smash::CloudPowers::Helper
 
       # Attempts to find a file by searching the current directory for the file
-      # then walking up the file tree and searching at each stop
-      # Parameters name <String>: name of the file or directory to find
-      # Returns Pathname: path to the file or directory given as the `name` param
+      # then walking up the file tree and searching at each stop all the way up
+      # to the root directory
+      #
+      # Parameters
+      # * name +String+ - name of the file or directory to find
+      #
+      # Returns
+      # +Pathname+ - path to the file or directory given as the +name+ parameter
       def file_tree_search(name)
         next_dir = Pathname.new(`pwd`.strip).parent
         current_dir = Pathname.new(`pwd`.strip)
@@ -24,8 +32,12 @@ module Smash
         return nil
       end
 
-      # Search through the .env variables for a key or if no key is given,
-      # return all the .env-vars and their values
+      # Search through the {Dotenv}[https://github.com/bkeepers/dotenv]
+      # variables for a key or if no key is given, return all the .env-vars
+      # and their values
+      #
+      # Parameters
+      # * key +String+ -
       def env_vars(key = '')
         return ENV if key.empty?
         ENV[to_snake(key).upcase]
@@ -33,8 +45,11 @@ module Smash
 
       # Search through the instance variables for a key or if no key is given,
       # return all the i-vars and their values
+      #
       # Parameters [key <String]:  The key to search for
+      #
       # Returns
+      # the value of the +key+ searched for
       def i_vars(key = '')
         if key.empty?
           return self.instance_variables.inject({}) do |r,v|
@@ -47,9 +62,23 @@ module Smash
       # PROJECT_ROOT should be set as early as possible in this Node's initilize
       # method.  This method tries to search for it, using #zfind() and if a `nil`
       # result is returned from that search, `pwd` is used as the PROJECT_ROOT.
-      # Returns Path to the project root or where ever `pwd` resolves to <Pathname>
-      # TODO: improve this...it needs to find the gem's method's caller's project
+      #
+      # Returns
+      # +Pathname+ - path to the project root or where ever <tt>`pwd`</tt> resolves
+      # to for the caller
+      #
+      # Notes
+      # * TODO: improve this...it needs to find the gem's method's caller's project
       # root or at least the gem's method's caller's file's location.
+      #
+      # Example
+      #   # called from cerebrum/cerebrum.rb in /home/ubuntu
+      #   project_root
+      #   # => '/home/ubuntu/cerebrum/'
+      #   # or
+      #   # called from go_nuts.rb#begin_going_crazy():(line -999999999.9) in /Users/crazyman/.ssh/why/all/the/madness/
+      #   project_root
+      #   # => '/Users/crazyman/.ssh/why/all/the/madness/'
       def project_root
         if @project_root.nil?
           file_home = Pathname.new(
@@ -60,18 +89,31 @@ module Smash
         @project_root
       end
 
-      # Manually set the `@project_root` i-var as a `Pathname` object.
-      # Parameters New path to the project root <String|Pathname>
-      # Returns @project_root <Pathname>
+      # Manually set the +@project_root+ i-var as a +Pathname+ object.
+      #
+      # Parameters New path to the project root +String+|+Pathname+
+      #
+      # Returns +Pathname+ - +@project_root+
+      #
+      # Example
+      #   project_root
+      #   # => '/home/ubuntu/cerebrum/'
+      #   project_root = Pathname.new(`pwd`)
+      #   project_root == `pwd`
+      #   # => true
       def project_root=(var)
         @project_root = Pathname.new(var)
       end
 
       # 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
-      # Returns Value <String> for the given key or if no key was given, a
-      # Hash with { key => value, ... } is returned for all keys with a value.
+      #
+      # Returns
+      # * if a +key+ is given as a parameter, +String+
+      # * if no +key+ is given as a parameter, +Hash+
+      # with this structure +{ key => value, ... }+ is returned for all keys with a value.
       # Keys with no value are ommitted from the result.
       def system_vars(key = '')
         if key.empty?
@@ -92,15 +134,21 @@ module Smash
       end
 
       # ZFind looks for the key in a preditermined order of importance:
-      #   * i-vars are considered first becuase they might be tracking different
-      #     locations for multiple tasks or something like that.
-      #   * dotenv files are second because they were manually set, so for sure
-      #     it's important
-      #   * System Env[@] variables are up next.  Hopefully by this time we've found
-      #     our information but if not, it should "search" through the system env too.
-      # Parameters key <String>: The key to search for
-      # Returns <String>
-      #   TODO: implement a search for all 3 that can find close matches
+      # * i-vars are considered first becuase they might be tracking different
+      #   locations for multiple tasks or something like that.
+      # * dotenv files are second because they were manually set, so for sure
+      #   it's important
+      # * System Env[@] variables are up next.  Hopefully by this time we've found
+      #   our information but if not, it should "search" through the system env too.
+      #
+      # Parameters
+      # * key +String+|+Symbol+ - the key to search for
+      #
+      # Returns
+      # +String+
+      #
+      # Notes
+      # * TODO: implement a search for all 3 that can find close matches
       def zfind(key)
         project_root if @project_root.nil?
         res = (i_vars[to_snake(key).upcase] or

data/lib/stubs/aws_stubs.rb

@@ -35,9 +35,10 @@ module Smash
       # * * region - defaulted to use the <tt>#region()</tt> method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # <tt>AWS::EC2::Client</tt>
-      # === Sample Usage
+      #
+      # Example
       #   config = stub_responses: {
       #     run_instances: {
       #       instances: [{ instance_id: 'asd-1234', launch_time: Time.now, state: { name: 'running' }]
@@ -91,16 +92,17 @@ module Smash
       end
 
       # Stub data for a SNS client
+      #
       # Parameters
       # * opts +Hash+
       # * * stub_responses: defaulted to false but it can be overriden with the desired responses for local testing
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::SNS client
       #
-      # === Example
+      # Example
       #   config = {
       #     stub_responses: {
       #       create_topic: {},
@@ -136,10 +138,10 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::Kinesis client
       #
-      # === Example
+      # Example
       #   config = {
       #     stub_responses: {
       #       create_stream: {},
@@ -205,10 +207,10 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::S3 client
       #
-      # === Example
+      # Example
       #   config = {
       #     stub_responses: {
       #       head_bucket: {}
@@ -234,10 +236,10 @@ module Smash
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::SQS client
       #
-      # === Example
+      # Example
       #   create_queue('someQueue') # uses AWS::SQS
       #   some_queue_url = queue_search('someQueue').first # uses AWS::SQS
       def self.queue_stub(opts = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_powers
 version: !ruby/object:Gem::Version
-  version: 0.2.7.1
+  version: 0.2.7.2
 platform: ruby
 authors:
 - Adam Phillipps
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport-core-ext