cloud_powers 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d02a1e6e07212386a014c0c8855065e29b6be6ea
-  data.tar.gz: 317ca03ffc825961ff980d7d7b25824b13da97b7
+  metadata.gz: 87b0d2d0b422a079bb6f136b7629e583ebaeb88e
+  data.tar.gz: 5f4313c4ca1aab96ef5550e1f5048a43900f6b4c
 SHA512:
-  metadata.gz: 977411458b0021e684834bdf33791b6e39c6e84beebd41760d6a85c8d7451a84a6dd61dc7839f19c1322c415a64e9fa55f801eb660357f061f6c4160ffa279ca
-  data.tar.gz: 2d2e4a52a63d0e3bb52f9f6e5838dd0bfc336952929c6d7333bb3c87d46b9700402f7da5c5e20ab775314938685b70ba8acde7ff0e3fb2b6a919b3a2402fde26
+  metadata.gz: aa4816ebb01b5457e2dea8ea60914c08eb34cb0be5b88df46c301b6c146e6ef2954f676746d19600f05558e439a97f6cb00509fc31072e031b522017cf2d6fd5
+  data.tar.gz: fee80d3368a5dcc9acacb7ebf2924e1be611c07daa6204b0984208c480e4881ca32b6fc71998c150032807bd9fab39e96b0e05c7982ad8fb2377fcb0f36b0d2f

data/Gemfile.lock

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

data/cloud_powers.gemspec

@@ -14,11 +14,14 @@ Gem::Specification.new do |spec|
     CloudPowers is a wrapper around AWS and in the future, other cloud service Providers.
     It was developed specifically for the Brain project but hopefully can be used
     in any other ruby project that needs to use cloud service providers' resources.
-    Version 0.2.6 has a little EC2, S3, SQS, SNS, Kinesis, websockets and a few other
+
+    Version 0.2.7 has a little EC2, S3, SQS, SNS, Kinesis, websockets and a few other
     features you can find in the docs.  There is also limitted support for stubbing
     AWS RESTful API calls.  That can come in handy for local testing and extra setup on
     AWS resource clients.
+
     The next versions will have more Kinesis, Workflow integration and IoT.
+
     This project is actively being developed, so more additions, specs and docs
     will be added and updated frequently with new funcionality but the gem will
     follow good practices for versioning.  Input is always welcome.

data/lib/cloud_powers.rb

@@ -19,6 +19,5 @@ module Smash
     include Smash::CloudPowers::Storage
     include Smash::CloudPowers::Synapse
     include Smash::CloudPowers::Node
-    Smash::CloudPowers::CLOUDPOWERS_SPECS_ROOT = File.absolute_path(`pwd`.gsub("\n", '/spec/'))
   end
 end

data/lib/cloud_powers/aws_resources.rb

@@ -9,10 +9,42 @@ module Smash
       include Smash::CloudPowers::Helper
       include Smash::CloudPowers::Zenv
 
+      # Get the region from the environment/context or use a default region for AWS API calls.
+      # === @returns String
       def region
         zfind(:aws_region) || 'us-west-2'
       end
 
+      # Get or create an EC2 client and cache that client so that a Context is more well tied together
+      # === @params: 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: AWS::EC2 client
+      # === Sample Usage
+      #     ```
+      #       config = stub_responses: {
+      #         run_instances: {
+      #           instances: [
+      #             { instance_id: 'asd-1234', launch_time: Time.now, state: { name: 'running' }
+      #         ] }
+      #         describe_instances: {
+      #           reservations: [
+      #             { instances: [
+      #               { instance_id: 'asd-1234', state: { code: 200, name: 'running' } },
+      #           ] }] },
+      #         describe_images: {
+      #           images: [
+      #             { image_id: 'asdf', state: 'available' }
+      #         ] }
+      #       }
+      #
+      #       ec2(config) # sets and gets an EC2 client
+      #
+      #       images = ec2.describe_images
+      #       images.first[:image_id]
+      #       # => 'asdf'
+      #     ```
       def ec2(opts = {})
         config = {
           stub_responses: false,
@@ -24,6 +56,14 @@ module Smash
         @ec2 ||= Aws::EC2::Client.new(config)
       end
 
+      # Get an image using a name and filters functionality from EC2.  The name is required but the filter defaults
+      # to search for the tag with the key `aminame` because this is the key that most Nodes will search for, when
+      # they gather an AMI to start with.
+      # === @params: 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: AMI
       def image(name, opts = {})
         config = {
           filters: [{ name: 'tag:aminame', values: [name.to_s] }]
@@ -33,6 +73,37 @@ module Smash
         ec2(opts).describe_images(config).images.first
       end
 
+      # Get or create an Kinesis client and cache that client so that a Context is more well tied together
+      # === @params: 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: AWS::Kinesis client
+      # === Sample Usage
+      #     ```
+      #       config = {
+      #         stub_responses: {
+      #           create_stream: {},
+      #             put_record: {
+      #               shard_id: opts[:shard_id] || 'idididididididid',
+      #               sequence_number: opts[:sequence_number] || Time.now.to_i.to_s
+      #             },
+      #             describe_stream: {
+      #               stream_description: {
+      #                 stream_name: opts[:name] || 'somePipe',
+      #                 stream_arn:  'arnarnarnarnar',
+      #                 stream_status: 'ACTIVE',
+      #               }
+      #             }
+      #           }
+      #         }
+      #       }
+      #
+      #       kinesis(config) # sets and gets an Kinesis client
+      #
+      #       pipe_to('somePipe') { update_body(status: 'waHoo') }
+      #       # => sequence_number: '1676151970'
+      #     ```
       def kinesis(opts = {})
         config = {
           stub_responses: false,
@@ -44,6 +115,22 @@ module Smash
         @kinesis ||= Aws::Kinesis::Client.new(config)
       end
 
+      # Get or create an S3 client and cache that client so that a Context is more well tied together
+      # === @params: 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: AWS::S3 client
+      # === Sample Usage
+      #     ```
+      #       config = {
+      #         stub_responses: {
+      #
+      #         }
+      #       }
+      #
+      #     ```
+
       def s3(opts = {})
         config = {
           stub_responses: false,
@@ -55,6 +142,29 @@ module Smash
         @s3 ||= Aws::S3::Client.new(config)
       end
 
+      # Get or create an SNS client and cache that client so that a Context is more well tied together
+      # === @params: 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: AWS::SNS client
+      # === Sample Usage
+      #     ```
+      #       config = {
+      #         stub_responses: {
+      #           create_topic: {},
+      #           delete_topic: {},
+      #           list_topics: [],
+      #           publish: {},
+      #           subscribe: {}
+      #         }
+      #       }
+      #
+      #       sns(config) # sets and gets an Kinesis client
+      #
+      #       create_channel!('testBroadcast')
+      #       # => true
+      #     ```
       def sns(opts = {})
         config = {
           stub_responses: false,
@@ -66,10 +176,31 @@ module Smash
         @sns ||= Aws::SNS::Client.new(config)
       end
 
+      # Get or create an SQS client and cache that client so that a Context is more well tied together
+      # === @params: 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: AWS::SQS client
+      # === Sample Usage
+      #     ```
+      #       config = stub_responses: {
+      #         create_queue: {
+      #           queue_url: "https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"
+      #         }
+      #       }
+      #
+      #       sqs(config) # sets and gets an Kinesis client
+      #
+      #       create_queue('someQueue')
+      #     ```
       def sqs(opts = {})
         config = {
+          stub_responses: false,
           credentials: Auth.creds
-        }.merge(opts)
+        }
+        config = config.merge(opts.select { |k| config.key?(k) })
+
         @sqs ||= Aws::SQS::Client.new(config)
       end
     end

data/lib/cloud_powers/helper.rb

@@ -282,6 +282,7 @@ module Smash
         # TODO: Better implementation of merging message bodies and config needed
         unless opts.kind_of? Hash
           update = opts.to_s
+          opts = {}
           opts[:extraInfo] = { message: update }
         end
         updated_extra_info = opts.delete(:extraInfo) || {}

data/lib/cloud_powers/node.rb

@@ -1,5 +1,6 @@
 require_relative 'auth'
 require_relative 'helper'
+require_relative 'self_awareness'
 require_relative 'zenv'
 
 module Smash
@@ -7,6 +8,7 @@ module Smash
     module Node
       include Smash::CloudPowers::Auth
       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.
       # @params [opts <Hash>]

data/lib/cloud_powers/self_awareness.rb

@@ -99,7 +99,7 @@ module Smash
             metadata_uri = "http://169.254.169.254/latest/meta-data/#{key}"
             HTTParty.get(metadata_uri).parsed_response.split("\n")
           else
-            require_relative "#{Smash::CloudPowers::CLOUDPOWERS_SPECS_ROOT}/stubs/aws_stubs"
+            require_relative '../stubs/aws_stubs'
             stubbed_metadata = Smash::CloudPowers::AwsStubs::INSTANCE_METADATA_STUB
 
             key.empty? ? stubbed_metadata.keys : stubbed_metadata[to_hyph(key)]

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

@@ -28,21 +28,21 @@ module Smash
         # end
 
         # Creates a point to connect to for information about a given topic
-        # @params: name <String>: the name of the Channel/Topic to be created
-        # @returns: Broadcast::Channel representing the created channel
+        # === @params: name String: the name of the Channel/Topic to be created
+        # === @returns: Broadcast::Channel representing the created channel
         def create_channel!(name)
           resp = sns.create_topic(name: name)
           Channel.new(nil, resp.topic_arn)
         end
 
         # Deletes a topic from SNS-land
-        # @params: channel <Broadcast::Channel>
+        # === @params: channel <Broadcast::Channel>
         def delete_channel!(channel)
           sns.delete_topic(topic_arn: channel.arn)
         end
 
         # Creates a connection to the Broadcast so that new messages will be picked up
-        # @params: channel <Broadcast::Channel>
+        # === @params: channel <Broadcast::Channel>
         def listen_on(channel)
           sns.subscribe(
             topic_arn:    channel.arn,
@@ -52,7 +52,7 @@ module Smash
         end
 
         # Lists the created topics in SNS.
-        # @returns results <Array
+        # === @returns results <Array
         def real_channels
           results = []
           next_token = ''
@@ -66,7 +66,7 @@ module Smash
         end
 
         # Send a message to a Channel using SNS#publish
-        # @params: [opts <Hash>]:
+        # === @params: [opts <Hash>]:
         #   this includes all the keys AWS uses but for now it only has defaults
         #   for topic_arn and the message
         def send_broadcast(opts = {})

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

@@ -1,20 +1,21 @@
-require_relative '../../helper'
-
 module Smash
   module CloudPowers
     module Synapse
-      include Smash::CloudPowers::Helper
-
       module Pipe
+        include Smash::CloudPowers::AwsResources
+        include Smash::CloudPowers::Helper
+        include Smash::CloudPowers::Zenv
+
         # Create a Kinesis stream or wait until the stream with the given name is
         # through being created.
         # === @params: name String
         # === @returns: Boolean or nil
-        #     * returns true or false if the request was successful
-        #     * returns false
+        #     * returns true or false if the request was successful or not
+        #     * returns true if the stream has already been created
+        #     * returns false if the stream was not created
         def create_stream(name)
           begin
-            config = stream_config(stream_name: env(name))
+            config = stream_config(stream_name: name)
             resp = kinesis.create_stream(config)
             kinesis.wait_until(:stream_exists, stream_name: config[:stream_name])
             resp.successful? # (http request successful && stream created)?
@@ -24,7 +25,7 @@ module Smash
               return if stream_status(name) == 'ACTIVE'
               logger.info "Not ready for traffic.  Wait for 30 seconds..."
               sleep 1
-              nil # no request -> no response
+              true # acts like it would if it had to create the stream
             else
               error_message = format_error_message(e)
               logger.error error_message
@@ -73,9 +74,9 @@ module Smash
         #     See #instance_id()
         def pipe_message_body(opts = {})
           {
-            stream_name:      env(opts[:stream_name]) || env('status_stream'),
+            stream_name:      zfind(opts[:stream_name]) || zfind('status_stream'),
             data:             opts[:data] || update_message_body(opts),
-            partition_key:    opts[:partition_key] || @instance_id
+            partition_key:    opts[:partition_key] || @instance_id || 'unk'
           }
         end
 
@@ -106,7 +107,7 @@ module Smash
         #     * stream_name:
         def stream_config(opts = {})
           config = {
-            stream_name: opts[:stream_name] || env('status_stream'),
+            stream_name: opts[:stream_name] || zfind(:status_stream),
             shard_count: opts[:shard_count] || 1
           }
         end
@@ -116,7 +117,7 @@ module Smash
         # === @returns: Boolean
         def stream_exists?(name)
           begin
-            kinesis.describe_stream(stream_name: env(name))
+            kinesis.describe_stream(stream_name: name)
             true
           rescue Aws::Kinesis::Errors::ResourceNotFoundException => e
             false
@@ -128,7 +129,7 @@ module Smash
         # === @returns: stream status, one of:
         #       CREATING, DELETING, ACTIVE, UPDATING
         def stream_status(name)
-          kinesis.describe_stream(name).stream_description.stream_status
+          kinesis.describe_stream(stream_name: name).stream_description.stream_status
         end
       end
     end

data/lib/cloud_powers/synapse/synapse.rb

@@ -13,7 +13,7 @@ module Smash
     #     or loaded, logging info and any other high-throughput/data-centric application with
     # - Queue is a module that is primarily used for asynchronous communications between a sender
     #     and any number of users or apps that _might_ need to use it
-    # - WebSocServer ...._Faisal's turn_...
+    # - WebSocServer ..._Faisal's turn_...
     module Synapse
       include Smash::CloudPowers::Synapse::Broadcast
       include Smash::CloudPowers::Synapse::Pipe

data/lib/cloud_powers/version.rb

@@ -1,3 +1,3 @@
 module CloudPowers
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/stubs/aws_stubs.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+require 'spec_helper'
+
+module Smash
+  module CloudPowers
+    module AwsStubs
+
+      INSTANCE_METADATA_STUB = {
+        'ami-id' => 'ami-1234',
+        'ami-launch-index' => '1',
+        'ami-manifest-path' => '',
+        'block-device-mapping/' => '',
+        'hostname' => '',
+        'instance-action' => '',
+        'instance-id' => 'asd-1234',
+        'instance-type' => 't2.nano',
+        'kernel-id' => '',
+        'local-hostname' => 'ip-10-251-50-12.ec2.internal',
+        'local-ipv4' => '',
+        'mac network/' => '',
+        'placement/' => 'boogers',
+        'public-hostname' => 'ec2-203-0-113-25.compute-1.amazonaws.com',
+        'public-ipv4' => 'adsfasdfasfd',
+        'public-keys/' => 'jfakdsjfkdlsajfkldsajflkasjdfklajsdflkajsldkfjalsdfjaklsdjflasjfklasjdfkals',
+        'public-keys/0' => 'asdjfkasdjfkasdjflasjdfklsajdlkfjaldkgfjalkdfgjklsdfjgklsdjfklsjlkdfjakdlfjalskdfjlas',
+        'reservation-id' => 'r-fea54097',
+        'security-groups' => 'groupidygroupgroupgroup',
+        'services/' => ''
+      }
+
+      def self.node_stub(opts = {})
+        {
+          stub_responses: {
+            create_tags: {},
+            run_instances: {
+              instances: [
+                { instance_id: 'asd-1234', launch_time: Time.now, state: { name: 'running' } },
+                { instance_id: 'qwe-4323', launch_time: Time.now, state: { name: 'running' } },
+                { instance_id: 'tee-4322', launch_time: Time.now, state: { name: 'running' } },
+                { instance_id: 'bbf-6969', launch_time: Time.now, state: { name: 'running' } },
+                { instance_id: 'lkj-0987', launch_time: Time.now, state: { name: 'running' } },
+            ]},
+            describe_instances: {
+              reservations: [
+                { instances: [
+                  { instance_id: 'asd-1234', state: { code: 200, name: 'running' } },
+                  { instance_id: 'qwe-4323', state: { code: 200, name: 'running' } },
+                  { instance_id: 'tee-4322', state: { code: 200, name: 'running' } },
+                  { instance_id: 'bbf-6969', state: { code: 200, name: 'running' } },
+                  { instance_id: 'lkj-0987', state: { code: 200, name: 'running' } }
+            ] }] },
+            describe_images: {
+              images: [
+                { image_id: 'asdf', state: 'available' },
+                { image_id: 'fdas', state: 'available' },
+                { image_id: 'fdadg', state: 'available' },
+                { image_id: 'aswre', state: 'available' },
+                { image_id: 'fsnkv', state: 'available' },
+              ]
+            }
+          }
+        }
+      end
+
+      def self.broadcast_stub(opts = {})
+        arn = "arn:aws:sns:us-west-2:8123456789:#{opts[:name] || 'testChannel'}"
+       stub = {
+          stub_responses: {
+            create_topic: { topic_arn: arn },
+            delete_topic: {},
+            list_topics: { topics: [{ topic_arn: arn }], next_token: '1234asdf' },
+            publish: { message_id: 'msgidmsgidmsgidmsgid' },
+            subscribe: { subscription_arn: 'subarnsubarnsubarn' }
+          }
+        }
+        stub.merge(opts.select { |k,v| stub.key? k })
+      end
+
+      def self.pipe_stub(opts = {})
+        stub = {
+          stub_responses: {
+            create_stream: {},
+            put_record: {
+              shard_id: opts[:shard_id] || 'idididididididid',
+              sequence_number: opts[:sequence_number] || '1234'
+            },
+            describe_stream: {
+              stream_description: {
+                stream_name: opts[:name] || 'testPipe',
+                stream_arn:  'arnarnarnarnar',
+                stream_status: 'ACTIVE',
+                shards: [
+                  { shard_id: '1',
+                    parent_shard_id: 'wowza',
+                    hash_key_range: {
+                      starting_hash_key: 'starting',
+                      ending_hash_key: 'ending'
+                    },
+                    sequence_number_range: {
+                      starting_sequence_number: '1'
+                    }
+                  }
+                ],
+                has_more_shards: true,
+                retention_period_hours: 1,
+                enhanced_monitoring: []
+              }
+            }
+          }
+        }
+        stub.merge(opts.select { |k| stub.key?(k) })
+      end
+
+      def self.queue_stub(opts = {})
+        {
+          stub_responses: {
+            create_queue: {
+              queue_url: "https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"
+            },
+            delete_message: {}, # #delete_message() returns nothing
+            delete_queue: {}, # #delete_queue() returns nothing
+            get_queue_attributes: {
+              attributes: { 'ApproximateNumberOfMessages' => rand(1..10).to_s }
+            },
+            get_queue_url: {
+              queue_url: "https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"
+            },
+            list_queues: {
+              queue_urls: ["https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"]
+            },
+            receive_message: {
+              messages: [
+                {
+                  attributes: {
+                    "ApproximateFirstReceiveTimestamp" => "1442428276921",
+                    "ApproximateReceiveCount" => "5",
+                    "SenderId" => "AIDAIAZKMSNQ7TEXAMPLE",
+                    "SentTimestamp" => "1442428276921"
+                  },
+                  body: "{\"foo\":\"bar\"}",
+                  md5_of_body: "51b0a325...39163aa0",
+                  md5_of_message_attributes: "00484c68...59e48f06",
+                  message_attributes: {
+                    "City" => {
+                      data_type: "String",
+                      string_value: "Any City"
+                    },
+                    "PostalCode" => {
+                      data_type: "String",
+                      string_value: "ABC123"
+                    }
+                  },
+                  message_id: "da68f62c-0c07-4bee-bf5f-7e856EXAMPLE",
+                  receipt_handle: "AQEBzbVv...fqNzFw=="
+                }
+              ]
+            },
+            send_message: {
+              md5_of_message_attributes: "00484c68...59e48f06",
+              md5_of_message_body: "51b0a325...39163aa0",
+              message_id: "da68f62c-0c07-4bee-bf5f-7e856EXAMPLE"
+            }
+          }
+        }.merge(opts)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_powers
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Adam Phillipps
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport-core-ext
@@ -183,11 +183,14 @@ description: |2
       CloudPowers is a wrapper around AWS and in the future, other cloud service Providers.
       It was developed specifically for the Brain project but hopefully can be used
       in any other ruby project that needs to use cloud service providers' resources.
-      Version 0.2.6 has a little EC2, S3, SQS, SNS, Kinesis, websockets and a few other
+
+      Version 0.2.7 has a little EC2, S3, SQS, SNS, Kinesis, websockets and a few other
       features you can find in the docs.  There is also limitted support for stubbing
       AWS RESTful API calls.  That can come in handy for local testing and extra setup on
       AWS resource clients.
+
       The next versions will have more Kinesis, Workflow integration and IoT.
+
       This project is actively being developed, so more additions, specs and docs
       will be added and updated frequently with new funcionality but the gem will
       follow good practices for versioning.  Input is always welcome.
@@ -233,6 +236,7 @@ files:
 - lib/cloud_powers/version.rb
 - lib/cloud_powers/workflow.rb
 - lib/cloud_powers/zenv.rb
+- lib/stubs/aws_stubs.rb
 homepage: https://github.com/adam-phillipps/cloud_powers
 licenses:
 - MIT