cloud_powers 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56d3873e3042a66d3fd0b284b3b5fe88f49803fb
-  data.tar.gz: dd5d52611cc92cd66c52a08ecb905e0bc0d28788
+  metadata.gz: d02a1e6e07212386a014c0c8855065e29b6be6ea
+  data.tar.gz: 317ca03ffc825961ff980d7d7b25824b13da97b7
 SHA512:
-  metadata.gz: f72cd7f864047a6b1c5060b31fb2d2f75a17df0b22ca72bdc6c545c39091a0e622d94d5db42e2f65840e29c0efd86b5bf2ac98501c7bafa5db4c4466db00f87a
-  data.tar.gz: b0403c5ae413ecbf7b94e0c4296384427b38e96381bf2d6c471cf1e8ae8190225e0e6439de7a66ab5b7a20ce83094e369cf5dc593af2355e875f02c2a0e141f9
+  metadata.gz: 977411458b0021e684834bdf33791b6e39c6e84beebd41760d6a85c8d7451a84a6dd61dc7839f19c1322c415a64e9fa55f801eb660357f061f6c4160ffa279ca
+  data.tar.gz: 2d2e4a52a63d0e3bb52f9f6e5838dd0bfc336952929c6d7333bb3c87d46b9700402f7da5c5e20ab775314938685b70ba8acde7ff0e3fb2b6a919b3a2402fde26

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in cloud_powers.gemspec
 gemspec

data/Gemfile.lock

@@ -1,27 +1,30 @@
 PATH
   remote: .
   specs:
-    cloud_powers (0.2.5)
+    cloud_powers (0.2.6)
       activesupport-core-ext (~> 4)
       aws-sdk (~> 2)
       dotenv (~> 2.1)
       httparty (~> 0.14)
       rubyzip (~> 1.2)
+      websocket-eventmachine-client
+      websocket-eventmachine-server
       zip-zip (~> 0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     activesupport-core-ext (4.0.0.3)
-    aws-sdk (2.6.3)
-      aws-sdk-resources (= 2.6.3)
-    aws-sdk-core (2.6.3)
+    aws-sdk (2.6.6)
+      aws-sdk-resources (= 2.6.6)
+    aws-sdk-core (2.6.6)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.6.3)
-      aws-sdk-core (= 2.6.3)
-    byebug (9.0.5)
+    aws-sdk-resources (2.6.6)
+      aws-sdk-core (= 2.6.6)
+    byebug (9.0.6)
     diff-lcs (1.2.5)
     dotenv (2.1.1)
+    eventmachine (1.2.0.1)
     httparty (0.14.0)
       multi_xml (>= 0.5.2)
     jmespath (1.3.1)
@@ -31,7 +34,7 @@ GEM
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -41,6 +44,16 @@ GEM
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
     rubyzip (1.2.0)
+    websocket (1.2.3)
+    websocket-eventmachine-base (1.2.0)
+      eventmachine (~> 1.0)
+      websocket (~> 1.0)
+      websocket-native (~> 1.0)
+    websocket-eventmachine-client (1.2.0)
+      websocket-eventmachine-base (~> 1.0)
+    websocket-eventmachine-server (1.0.1)
+      websocket-eventmachine-base (~> 1.0)
+    websocket-native (1.0.0)
     zip-zip (0.3)
       rubyzip (>= 1.0.0)
 
@@ -55,4 +68,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.12.5
+   1.13.2

data/Gemfile.lock_b

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    cloud_powers (0.2.4)
+      activesupport-core-ext (~> 4)
+      aws-sdk (~> 2)
+      dotenv (~> 2.1)
+      httparty (~> 0.14)
+      rubyzip (~> 1.2)
+      zip-zip (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport-core-ext (4.0.0.3)
+    aws-sdk (2.6.3)
+      aws-sdk-resources (= 2.6.3)
+    aws-sdk-core (2.6.3)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.6.3)
+      aws-sdk-core (= 2.6.3)
+    byebug (9.0.5)
+    diff-lcs (1.2.5)
+    dotenv (2.1.1)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    jmespath (1.3.1)
+    multi_xml (0.5.5)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubyzip (1.2.0)
+    zip-zip (0.3)
+      rubyzip (>= 1.0.0)
+    websocket (>= 1.2.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  byebug (~> 9)
+  cloud_powers!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/cloud_powers.gemspec

@@ -7,19 +7,21 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version  =     '~> 2.3.0'
   spec.name                   =     'cloud_powers'
   spec.version                =     CloudPowers::VERSION
-  spec.author                 =     'Adam Phillipps'
-  spec.email                  =     'adam.phillipps@gmail.com'
+  spec.authors                =     ['Adam Phillipps', 'Faisal Irfan']
+  spec.email                  =     ['adam.phillipps@gmail.com', 'Faisal@smashanalytics.com']
   spec.summary                =     %q{Cloud providers wrapper.  Currently only AWS is supported.}
   spec.description            =     <<-EOF
     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.5 has a little EC2, S3, SQS, SNS and Kinesis and some a few other
-    features you can find in the docs.
-    The next versions will have websockets, IoT, more Kinesis and Workflow integration.
+    Version 0.2.6 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.  I always welcome input.
+    follow good practices for versioning.  Input is always welcome.
     Enjoy!
   EOF
   spec.homepage               =     'https://github.com/adam-phillipps/cloud_powers'
@@ -36,6 +38,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency       'httparty', '~> 0.14'
   spec.add_runtime_dependency       'rubyzip', '~> 1.2'
   spec.add_runtime_dependency       'zip-zip', '~> 0.3'
+  spec.add_runtime_dependency       'websocket-eventmachine-server'
+  spec.add_runtime_dependency       'websocket-eventmachine-client'
 
   spec.add_development_dependency   'bundler', '~> 1.12'
   spec.add_development_dependency   'byebug', '~> 9'

data/lib/cloud_powers/auth.rb

@@ -9,6 +9,7 @@ module Smash
 
       # This method is able to be called before an object is instantiated in order
       # to provide a region in AWS-land.
+      # === @returns: The region set in configuration or a 'us-west-2' default String
       def self.region
         zfind(:aws_region) || 'us-west-2'
       end

data/lib/cloud_powers/aws_resources.rb

@@ -67,10 +67,10 @@ module Smash
       end
 
       def sqs(opts = {})
-        @sqs ||= Aws::SQS::Client.new({
-            credentials: Auth.creds
-          }.merge(opts)
-        )
+        config = {
+          credentials: Auth.creds
+        }.merge(opts)
+        @sqs ||= Aws::SQS::Client.new(config)
       end
     end
   end

data/lib/cloud_powers/context.rb

@@ -91,7 +91,7 @@ module Smash
       #    `<Array|List <Enumerable>`
       #    e.g.
       #      flat
-      #      ```
+      #      ```Ruby
       #      [
       #        object_name_1, config_1a, config_2a, ...,
       #        object_2, config_1b, etc,
@@ -100,16 +100,16 @@ module Smash
       #      ```
       #      grouped
       #      or
-      #      ```
+      #      ```Ruby
       #      [
       #        [object_name_1, config_1a, config_2a, ...],
       #        [object_2, config_1b, etc],
       #        ...
       #      ]
       #      ```
-      #      structured
       #      or
-      #      ```
+      #      structured
+      #      ```Ruby
       #      [
       #        [object_name_1, [config_1a, config_2a, ...]],
       #        [object_2, [config_1b, etc]],
@@ -117,7 +117,7 @@ module Smash
       #      ]
       #      ```
       #      returns
-      #      ```
+      #      ```Ruby
       #      {
       #        object_1: [config_1a, config_2a, ...],
       #        object_2: [config_1b, ...],
@@ -133,7 +133,7 @@ module Smash
       # Translates an Array into a valid @structure Hash
       # === @param arr <Array>
       #   e.g.
-      #   ```
+      #   ```Ruby
       #   [:task, 'demo', :queue, 'name1', {other config hash},...,:pipe, 'name1']
       #   ```
       # === @returns Hash
@@ -190,6 +190,8 @@ module Smash
       # class _should_ exist in.  It can be a vanilla version, where the @structure
       # is a Hash, structured correctly or it can be serialized into JSON or it can
       # be an Array
+      # === @params: args String
+      # === @returns: Boolean
       def valid_args?(args)
         case args
         when Hash

data/lib/cloud_powers/helper.rb

@@ -88,9 +88,7 @@ module Smash
                 key = yield k
 
                 value = if v.kind_of?(Hash)
-                    deep_modify_keys_with(v) do |new_key|
-                      Proc.new.call(new_key)
-                    end
+                    deep_modify_keys_with(v) { |new_key| Proc.new.call(new_key) }
                   else
                     v
                   end
@@ -108,11 +106,6 @@ module Smash
         end
       end
 
-      def errors
-        # TODO: wow...needs work
-        $errors ||= SmashError.instance
-      end
-
       # Join the message and backtrace into a String with line breaks
       def format_error_message(error)
         begin
@@ -129,7 +122,7 @@ module Smash
         @log_file ||= zfind('LOG_FILE')
       end
 
-      # @returns: An instance of Logger, cached as @logger
+      # === @returns: An instance of Logger, cached as @logger
       def logger
         @logger ||= create_logger
       end

data/lib/cloud_powers/self_awareness.rb

@@ -74,12 +74,16 @@ module Smash
       end
 
       # Gets and sets the public hostname of the instance
+      # === @returns String
+      # === 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
       def instance_url
-        @instance_url ||= if zfind('TESTING')
-          'abc-1234'
-        else
-          hostname_uri = 'http://169.254.169.254/latest/meta-data/instance-id'
+        @instance_url ||= unless zfind('TESTING')
+          hostname_uri = 'http://169.254.169.254/latest/meta-data/public-hostname'
           HTTParty.get(hostname_uri).parsed_response
+        else
+          'http://ec2-000-0-000-00.compute-0.amazonaws.com'
         end
       end
 
@@ -95,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 '../../spec/stubs/aws_stubs'
+            require_relative "#{Smash::CloudPowers::CLOUDPOWERS_SPECS_ROOT}/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/pipe/pipe.rb

@@ -6,6 +6,12 @@ module Smash
       include Smash::CloudPowers::Helper
 
       module Pipe
+        # 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
         def create_stream(name)
           begin
             config = stream_config(stream_name: env(name))
@@ -15,13 +21,11 @@ module Smash
           rescue Exception => e
             if e.kind_of? Aws::Kinesis::Errors::ResourceInUseException
               logger.info "#{name} already created"
-              stream_status = kinesis.describe_stream(name).stream_description.stream_status
-              return if stream_status == 'ACTIVE'
+              return if stream_status(name) == 'ACTIVE'
               logger.info "Not ready for traffic.  Wait for 30 seconds..."
-              sleep 30
+              sleep 1
               nil # no request -> no response
             else
-              # TODO: make the errors thing work
               error_message = format_error_message(e)
               logger.error error_message
               false # the request was not successful
@@ -29,11 +33,14 @@ module Smash
           end
         end
 
+        # Use the KCL and LangDaemon to read from a stream
+        # === @params: stream String
         def flow_from_pipe(stream)
           throw NotImplementedError
         end
 
         def flow_to_pipe(stream)
+          throw NotImplementedError
           create_stream(stream) unless stream_exists? stream
           records = yield if block_given?
           body = message_body_collection(records)
@@ -44,8 +51,10 @@ module Smash
           # TODO: what to return? true?
         end
 
+        # Read messages from the Pipe without using the KCL
+        # === @params: stream String
         def from_pipe(stream)
-          # implemented get_records and/or other consuming app stuff
+          # implement get_records and/or other consuming app stuff
           throw NotImplementedError
         end
 
@@ -53,6 +62,15 @@ module Smash
           throw NotImplementedError
         end
 
+        # Default message package.  This method yields the basic configuration
+        # and message body for a stream and all options can be changed.
+        # === @params: opts Hash (optional)
+        #     * stream_name:    String name of the stream to pipe to
+        #     * data:           String message to send
+        #     * partition_key:  String defaults to  @instance_id
+        # === @returns: Hash
+        # === Notes:
+        #     See #instance_id()
         def pipe_message_body(opts = {})
           {
             stream_name:      env(opts[:stream_name]) || env('status_stream'),
@@ -61,7 +79,20 @@ module Smash
           }
         end
 
+        # Use Kinesis streams to send a message.  The message is given to the method
+        # through a block that gets passed to the method.
+        # === @params: stream String
+        # === block: a block that generates a string that will be used in the message body
+        # === @returns: the sequence_number from the sent message.
+        # === Example use
+        #     ```Ruby
+        #     pipe_to(:status_stream) do
+        #       # the return from the inner method is what is sent
+        #       do_some_stuff_to_generate_a_message()
+        #     end
+        #     ```
         def pipe_to(stream)
+          message = ''
           create_stream(stream) unless stream_exists? stream
           message = yield if block_given?
           body = update_message_body(message)
@@ -70,6 +101,9 @@ module Smash
           @last_sequence_number = resp.sequence_number
         end
 
+        # New stream config with sensible defaults
+        # === @params: opts Hash
+        #     * stream_name:
         def stream_config(opts = {})
           config = {
             stream_name: opts[:stream_name] || env('status_stream'),
@@ -77,13 +111,25 @@ module Smash
           }
         end
 
+        # Find out if the stream already exists.
+        # === @params: name String
+        # === @returns: Boolean
         def stream_exists?(name)
           begin
             kinesis.describe_stream(stream_name: env(name))
+            true
           rescue Aws::Kinesis::Errors::ResourceNotFoundException => e
             false
           end
         end
+
+        # Get the status name for this stream
+        # === @params: name String
+        # === @returns: stream status, one of:
+        #       CREATING, DELETING, ACTIVE, UPDATING
+        def stream_status(name)
+          kinesis.describe_stream(name).stream_description.stream_status
+        end
       end
     end
   end

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

@@ -10,7 +10,7 @@ module Smash
           include Smash::CloudPowers::Helper
           include Smash::CloudPowers::Zenv
 
-          attr_accessor :address, :name, :poller
+          attr_accessor :address, :name, :poller, :sqs
 
           # Takes a `name` and creates a Board object.
           # The #new method is wrapped in #build() and #create!() but isn't labeled private so
@@ -18,24 +18,29 @@ module Smash
           # The Board doesn't create Queue(s) or any other API calls until it is instructed to.
           # @params: name <String>: the name of the board can be used to find its arn/url etc
           # @returns: Queue::Board
-          # not.new
-          def initialize(name)
+          # not `#new()`
+          def initialize(name, this_sqs)# = sqs)
+            @sqs = this_sqs
             @name = name
           end
 
           # Gives back a string representation of the instance variable for this board.
-          # @returns: instance_variable <String>: the instance variable for this Board in string format
-          # Example:
+          # === @returns: String
+          #   *the instance variable for this Board in string format
+          # === Example:
+          #   ```Ruby
           #   board = Board.new(:backlog)
           #   Smash.instance_variable_get(board.i_var)
           #   #=> Board <name: :backlog ...>
+          #   ```
           def i_var
             "@#{@name}"
           end
 
           # Gives the Queue address (URL).  First the environment is searched, using Zenv and if nothing is
           # found, the best guess attempt at the correct address is used.
-          # @returns: queue address <String>
+          # === @returns:
+          #   * queue address <String>
           def address
             zfind(@name) ||  best_guess_address
           end
@@ -44,27 +49,28 @@ module Smash
           # to build a standard URL for SQS.  The only problem with using this last resort is you may need
           # to use a Queue from a different region, account or name but it can be a handy catch-all for the URLs
           # for most cases.
+          # === @returns String
+          #     * exp. "https://sqs.us-west-2.amazonaws.com/12345678/fooBar"
           def best_guess_address
             "https://sqs.#{zfind(:aws_region)}.amazonaws.com/#{zfind(:account_number)}/#{@name}"
           end
 
           # Builds a Queue::Board object and returns it.  No API calls are sent using this method
-          # @params: name <String>
-          # @returns: Queue::Board
-          def self.build(name)
-            new(name)
+          # === @params: name <String>
+          # === @returns: Queue::Board
+          def self.build(name, this_sqs)#)
+            new(name, this_sqs)
           end
 
           # Builds then Creates the Object and makes the API call to SQS to create the queue
-          # @params: name <String>
-          # @returns: Queue::Board with an actual queue in SQS
-          def self.create!(name)
-            built_board = build(name)
-            built_board.create_queue!
+          # === @params: name <String>
+          # === @returns: Queue::Board with an actual queue in SQS
+          def self.create!(name, this_sqs)# = nil)
+            build(name, this_sqs).create_queue!
           end
 
           # Creates an actual Queue in SQS using the standard format for a queue name (camel case)
-          # @returns: Queue::Board
+          # === @returns: Queue::Board
           def create_queue!
             begin
               sqs.create_queue(queue_name: to_camel(@name))
@@ -91,8 +97,12 @@ module Smash
           end
 
           # Gets a QueuePoller for the Queue attached to this Board instance
+          # === @returns Aws::SQS::QueuePoller
           def poller
-            @poller ||= Aws::SQS::QueuePoller.new(address)
+            # Provide an existing SQS Client if one exists.
+            # This sets up stubbing and other stuff for later
+            args = @sqs.nil? ? address : [address, { client: sqs }]
+            @poller ||= Aws::SQS::QueuePoller.new(*args)
           end
 
           # Retrieves a message from the Queue and deletes it from the Queue in SQS
@@ -108,10 +118,12 @@ module Smash
           end
 
           # Sends the given message to the queue
-          # @params: message, which is either used as JSON or converted into it
+          # === @params: message, which is either used as JSON or converted into it
           def send_message(message)
             send_queue_message(
-              address, (valid_json?(message) ? message : message.to_json)
+              address,
+              (valid_json?(message) ? message : message.to_json),
+              sqs
             )
           end
         end

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

@@ -5,8 +5,8 @@ module Smash
   module CloudPowers
     module Synapse
       module Queue
-        include Smash::CloudPowers::Helper
         include Smash::CloudPowers::AwsResources
+        include Smash::CloudPowers::Helper
 
         # A simpl Struct that acts as a Name to URL map
         NUMap = Struct.new(:set_name, :set_url) do
@@ -21,31 +21,38 @@ module Smash
 
         # This method can be used to parse a queue name from its address.  It can be handy if you need the name
         # of a queue but you don't want the overhead of creating a Board object.
+        # === @params: url String
+        # === @returns: String
+        # === Example:
+        #     ```Ruby
+        #      board_name('https://sqs.us-west-53.amazonaws.com/001101010010/fooBar')
+        #      => fooBar
+        #     ```
         def board_name(url)
           url.to_s.split('/').last
         end
 
+        # This method builds a Queue::Board object for you to use but doesn't
+        # invoke the #create! method, so no API call is made to create the queue
+        # on SQS.  This can be used if the board already exists.
+        # === @params: name <String>: name of the queue you want to interact with
+        # === @returns: Queue::Board
+        def build_queue(name)
+          Smash::CloudPowers::Queue::Board.build(to_camel(name), sqs)
+        end
+
         # This method allows you to create a queue on SQS without explicitly creating a Board object
         # === @params: name <String>: The name of the queue to be created
         # === @returns: Queue::Board
         def create_queue!(name)
           begin
-            Smash::CloudPowers::Queue::Board.create!(to_camel(name))
+            Smash::CloudPowers::Queue::Board.create!(to_camel(name), sqs)
           rescue Aws::SQS::Errors::QueueDeletedRecently => e
             sleep 5
             retry
           end
         end
 
-        # This method builds a Queue::Board object for you to use but doesn't
-        # invoke the #create! method, so no API call is made to create the queue
-        # on SQS.  This can be used if the board already exists.
-        # === @params: name <String>: name of the queue you want to interact with
-        # === @returns: Queue::Board
-        def build_queue(name)
-          Smash::CloudPowers::Queue::Board.build(to_camel(name))
-        end
-
         # Deletes a queue message without caring about reading/interacting with the message.
         # This is usually used for progress tracking, ie; a Neuron takes a message from the Backlog, moves it to
         # WIP and deletes it from Backlog.  Then repeats these steps for the remaining States in the Workflow
@@ -81,12 +88,12 @@ module Smash
         # Polls the given board with the given options hash and a block that interacts with
         # the message that is retrieved from the queue
         # === @params: board <String>[, opts <Hash>]
-        #   board is the name of the queue you want to poll
-        #   opts can have any AWS::SQS polling option
-        #   &block is the block that is used to interact with the message that was retrieved
+        #   * `board` is the name of the queue you want to poll
+        #   * `opts` can have any AWS::SQS polling option
+        #   * `&block` is the block that is used to interact with the message that was retrieved
         # === @returns the results from the `message` and the `block` that interacts with the message(s)
-        def poll(board, opts = {})
-          this_poller = queue_poller(board)
+        def poll(board_name, opts = {})
+          this_poller = queue_poller(board_name)
           results = nil
           this_poller.poll(opts) do |msg|
             results = yield msg, this_poller if block_given?
@@ -102,25 +109,26 @@ module Smash
         # === @params: board_name <String>: name of the Queue you want to gain a QueuePoller for
         # === @returns: @<board_name:Queue::Board>
         def queue_poller(board_name)
-          board = Smash::CloudPowers::Queue::Board.create!(board_name)
+          board = Smash::CloudPowers::Queue::Board.create!(board_name, sqs)
 
           unless instance_variable_defined?(board.i_var)
-            instance_variable_set(
-              board.i_var,
-              board
-            )
+            instance_variable_set(board.i_var, board)
           end
           instance_variable_get(board.i_var).poller
         end
 
-        # Checks SQS for the existence of this queue
+        # Checks SQS for the existence of this queue using the #queue_search() method
+        # === @params: name String
+        # === @returns: Boolean
+        # === Notes:
+        #     * see #queue_search()
         def queue_exists?(name)
-          !sqs.list_queues(queue_name_prefix: name).queue_urls.empty?
+          !queue_search(name).empty?
         end
 
         # Searches for a queue based on the name
-        # === @params: name <String>
-        # === @returns: queue_urls <Array>
+        # === @params: name String
+        # === @returns: queue_urls [String]
         def queue_search(name)
           sqs.list_queues(queue_name_prefix: name).queue_urls
         end
@@ -128,11 +136,8 @@ module Smash
         # Sends a given message to a given queue
         # === @params: address <String>: address of the queue you want to interact with
         # === @returns: queue_urls <Array<String>> # TODO: verify this.  maybe it was late...
-        def send_queue_message(address, message)
-          sqs.send_message(
-            queue_url: address,
-            message_body: message
-          )
+        def send_queue_message(address, message, this_sqs = sqs)
+          this_sqs.send_message(queue_url: address, message_body: message)
         end
       end
     end

data/lib/cloud_powers/synapse/synapse.rb

@@ -2,6 +2,8 @@ require_relative './broadcast/broadcast'
 require_relative './queue/board'
 require_relative './queue/queue'
 require_relative './pipe/pipe'
+require_relative './websocket/websocserver'
+require_relative './websocket/websocclient'
 
 module Smash
   module CloudPowers
@@ -11,10 +13,13 @@ 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_...
     module Synapse
       include Smash::CloudPowers::Synapse::Broadcast
       include Smash::CloudPowers::Synapse::Pipe
       include Smash::CloudPowers::Synapse::Queue
+      include Smash::CloudPowers::Synapse::WebSocClient
+      include Smash::CloudPowers::Synapse::WebSocServer
     end
   end
 end

data/lib/cloud_powers/synapse/websocket/websocclient.rb

@@ -0,0 +1,37 @@
+require 'websocket-eventmachine-client'
+
+module Smash
+  module CloudPowers
+    module Synapse
+      module WebSocClient
+        def create_websoc_client( host, port )
+          EM.run do
+
+            ws = WebSocket::EventMachine::Client.connect(:uri => 'ws://' + host  + ':' + port)
+
+            ws.onopen do
+              puts "Connected"
+            end
+
+            ws.onmessage do |msg, type|
+              puts "Received message: #{msg}"
+            end
+        
+            ws.onerror do |error|
+              puts "Error ==> #{error}"
+            end
+
+            ws.onclose do |code, reason|
+              puts "Disconnected with status code: #{code}"
+              puts "Disconnected with status message: #{reason}"
+            end
+
+            EventMachine.next_tick do
+              ws.send "Hello Server!"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloud_powers/synapse/websocket/websocserver.rb

@@ -0,0 +1,43 @@
+require 'websocket-eventmachine-server'
+
+module Smash
+  module CloudPowers
+    module Synapse
+      module WebSocServer
+        def create_websoc_server( host, port )
+          @channel = EM::Channel.new
+          Thread.new do
+            EM.run do
+              WebSocket::EventMachine::Server.start(:host => host, :port => port) do |ws|
+                sid = nil
+
+                ws.onopen do
+                  puts "Client connected"
+                  sid = @channel.subscribe { |msg| ws.send msg }
+                end
+
+                ws.onmessage do |msg, type|
+                  puts "Received message: #{msg}"
+                  @channel.push "<#{sid}>: #{msg}"
+                end
+
+                ws.onerror do |error|
+                  puts "Error occured: #{error}"
+                end
+
+                ws.onclose do
+                  puts "Client disconnected"
+                  @channel.unsubscribe(sid) unless @channel.nil?
+                end
+              end
+            end
+          end
+        end
+
+        def send( msg )
+          @channel.push "#{msg}" unless @channel.nil? nil
+        end
+      end
+    end
+  end
+end

data/lib/cloud_powers/version.rb

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

data/lib/cloud_powers.rb

@@ -19,5 +19,6 @@ 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

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cloud_powers
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Adam Phillipps
+- Faisal Irfan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport-core-ext
@@ -94,6 +95,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -154,14 +183,18 @@ 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.5 has a little EC2, S3, SQS, SNS and Kinesis and some a few other
-      features you can find in the docs.
-      The next versions will have websockets, IoT, more Kinesis and Workflow integration.
+      Version 0.2.6 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.  I always welcome input.
+      follow good practices for versioning.  Input is always welcome.
       Enjoy!
-email: adam.phillipps@gmail.com
+email:
+- adam.phillipps@gmail.com
+- Faisal@smashanalytics.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -173,6 +206,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Gemfile.lock_b
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -194,6 +228,8 @@ files:
 - lib/cloud_powers/synapse/queue/board.rb
 - lib/cloud_powers/synapse/queue/queue.rb
 - lib/cloud_powers/synapse/synapse.rb
+- lib/cloud_powers/synapse/websocket/websocclient.rb
+- lib/cloud_powers/synapse/websocket/websocserver.rb
 - lib/cloud_powers/version.rb
 - lib/cloud_powers/workflow.rb
 - lib/cloud_powers/zenv.rb