cloud_powers 0.2.7.23 → 1.0.0

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

@@ -1,47 +1,41 @@
+require 'cloud_powers/aws_resources'
+require 'cloud_powers/helpers'
+require 'cloud_powers/resource'
+require 'cloud_powers/synapse/queue'
+require 'cloud_powers/zenv'
+
 module Smash
   module CloudPowers
     module Synapse
       module Queue
-        # The Queue::Board class helps wrap up information and functionality of a Queue on SQS.
+        # The Queue::Resource class helps wrap up information and functionality of a Queue on SQS.
         # It is basically just an abstraction to make using SQS simpler
-        class Board
+        class Board < Smash::CloudPowers::Resource
           include Smash::CloudPowers::AwsResources
           include Smash::CloudPowers::Synapse::Queue
-          include Smash::CloudPowers::Helper
+          include Smash::CloudPowers::Helpers
           include Smash::CloudPowers::Zenv
 
           # The URL the Aws::SQS::Queue uses
-          attr_writer :address
-          # The name the Aws::SQS::Queue uses
-          attr_accessor :name
-          # An Aws::SQS::Client.  See +#Smash::CloudPowers::AwsResources.sqs()+
+          attr_accessor :address
+          # +Hash+ response from Aws SDK <tt>Aws::SQS::Client#create_resource()</tt>
+          attr_reader :response
+          # An Aws::SQS::Client.  See <tt>Smash::CloudPowers::AwsResources#sqs()<tt>
           attr_accessor :sqs
 
-          # Creates a Board object.
+          # Creates a Resource object.
           # The +#new()+ method is wrapped in +#build()+ and +#create!()+ but isn't private so
           # +#new()+ can be used instead of build.
-          # The Board doesn't create Queue(s) or any other API calls until it is instructed to.
+          # The Resource doesn't create Queue(s) or any other API calls until it is instructed to.
           #
           # Parameters
-          # * name +String+ - the name of the board can be used to find its arn/url etc
+          # * name +String+ - the name of the resource can be used to find its arn/url etc
           #
           # Returns
-          # +Queue::Board+
-          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 +String+ - the instance variable for this Board in string format
-          #
-          # Example
-          #   board = Board.new(:backlog)
-          #   Smash.instance_variable_get(board.i_var)
-          #   #=> Board <name: :backlog, ...>
-          def i_var
-            "@#{@name}"
+          # +Queue::Resource+
+          def initialize(name:, client: sqs, **config)
+            super
+            @sqs = client
           end
 
           # Gives the Queue address (URL).  First the environment is searched, using Zenv and if nothing is
@@ -50,58 +44,17 @@ module Smash
           # Returns
           #   * queue address <String>
           def address
-            zfind(@name) ||  best_guess_address
-          end
-
-          # Gives a best guess at the URL that points toward this Board's Queue.  It uses a couple params
-          # 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. This is
-          # handy if you need to use a Queue but you don't want to create any resources in AWS.
-          #
-          # Parameters name +String+
-          #
-          # Returns Queue::Board
-          #
-          # Example
-          #   exp_board = Board.build('exampleBoard')
-          #   puts exp_board.best_guess_address
-          #   # => 'https://sqs.us-west-2.amaz.....'
-          def self.build(name, this_sqs = nil)
-            new(name, this_sqs)
-          end
-
-          # Builds then Creates the Object and makes the API call to SQS to create the queue
-          #
-          # Parameters
-          # * name <String>
-          #
-          # Returns
-          # +Queue::Board+ with an actual Queue in SQS
-          #
-          # Example
-          #   exp_board = Board.create!('exampleBoard')
-          #   queue_search(exp_board.name)
-          #   # => ['https://sqs.us-west-2.amazonaws.com/81234567890/exampleBoard']
-          def self.create!(name, this_sqs = nil)
-            build(name, this_sqs).create_queue!
+            @address ||= best_guess_address(name)
           end
 
           # Creates an actual Queue in SQS using the standard format for <b><i>this</i></b> queue name (camel case)
           #
           # Returns
-          # +Queue::Board+
-          def create_queue!
+          # +Queue::Resource+
+          def create_resource
             begin
-              sqs.create_queue(queue_name: to_camel(@name))
+              @response = sqs.create_queue(queue_name: to_camel(@name))
+              yield self if block_given?
               self
             rescue Aws::SQS::Errors::QueueDeletedRecently
               sleep 5
@@ -114,19 +67,48 @@ module Smash
             sqs.delete_queue(queue_url: address)
           end
 
+          # Gives back a string representation of the instance variable for this resource.
+          #
+          # Returns +String+ - the instance variable for this Resource in string format
+          #
+          # Example
+          #   queue = Queue::Resource.new(:backlog)
+          #   Smash.instance_variable_get(resource.i_var)
+          #   #=> Resource <name: :backlog, ...>
+          def i_var
+            to_i_var(@name)
+          end
+
           # Predicate method to query SQS for the queue
           #
           # Example
-          #   board = Board.build('example')
-          #   board.exists?
+          #   queue = Queue::Resource.build('example')
+          #   queue.exists?
           #   # => false
-          #   board.save!
-          #   board.exists?
+          #   queue.save!
+          #   queue.exists?
           #   # => true
           def exists?
             queue_exists?(@name)
           end
 
+          def link
+            if exists?
+              urls = queue_search(call_name)
+
+              if urls.size > 1
+                logger.info sitrep(content: "multiple matching #{name} queues to link to")
+                return @linked = false
+              end
+
+              # @url = urls.first
+              @url = sqs.get_queue_url(queue_name: @name).queue_url
+            else
+              save!
+            end
+            @linked = @url.eql? urls.first
+          end
+
           # Gets the approximate message count for a Queue using the 'ApproximateMessageCount' attribute
           #
           # Returns
@@ -135,7 +117,7 @@ module Smash
             get_queue_message_count(address)
           end
 
-          # Gets a QueuePoller for the Queue attached to this Board instance.
+          # Gets a QueuePoller for the Queue attached to this Resource instance.
           #
           # Returns
           # +Aws::SQS::QueuePoller+
@@ -144,28 +126,12 @@ module Smash
           # * Provide an existing SQS Client if one exists.  This is used to sort out development
           # production work.
           def poller
-            args = @sqs.nil? ? address : [address, { client: sqs }]
-            @poller ||= Aws::SQS::QueuePoller.new(*args)
+            @poller ||= Aws::SQS::QueuePoller.new(queue_url: address, client: sqs)
           end
 
           # Retrieves a message from the Queue and deletes it from the Queue in SQS
           def pluck_message
-            pluck_queue_message(@name)
-          end
-
-          # This method creates the queue in SQS for the given Board instance
-          # It can be coupled with the #build() method in order to use a queue without
-          # making the call to create it on AWS
-          #
-          # Example
-          #   board = Board.build('example')
-          #   board.exists?
-          #   # => false
-          #   board.save!
-          #   board.exists?
-          #   # => true
-          def save!
-            create_queue!
+            pluck_queue_message(name)
           end
 
           # Sends the given message to the queue

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

@@ -0,0 +1,29 @@
+require 'cloud_powers/aws_resources'
+require 'cloud_powers/helpers'
+require 'cloud_powers/resource'
+require 'cloud_powers/synapse/queue'
+require 'cloud_powers/zenv'
+
+module Smash
+  module CloudPowers
+    module Synapse
+      module Queue
+        # The Queue::Resource class helps wrap up information and functionality of a Queue on SQS.
+        # It is basically just an abstraction to make using SQS simpler
+        class Poller < Smash::CloudPowers::Resource
+          attr_accessor :sqs
+
+          def initialize(name:, client: sqs, **config)
+            super
+            @sqs = client
+            @call_name = queue_poller_name(name)
+          end
+
+          def create_resource
+            @response = queue_poller(queue_url: address, client: sqs)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloud_powers/synapse/synapse.rb

@@ -1,9 +1,7 @@
-require_relative './broadcast/broadcast'
-require_relative './queue/board'
-require_relative './queue/queue'
-require_relative './pipe/pipe'
-require_relative './websocket/websocserver'
-require_relative './websocket/websocclient'
+require 'cloud_powers/synapse/broadcast'
+require 'cloud_powers/synapse/queue'
+require 'cloud_powers/synapse/pipe'
+require 'cloud_powers/synapse/web_soc'
 
 module Smash
   module CloudPowers
@@ -14,13 +12,13 @@ module Smash
       # Pipe is a module that is useful for sending large result sets, data to be processed
       # or loaded, logging info and any other high-throughput/data-centric application with
       include Smash::CloudPowers::Synapse::Pipe
-      # 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
+      # MessageBoard 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.  Messages on the board aren't ordered.
       include Smash::CloudPowers::Synapse::Queue
-      # WebSocClient ..._Faisal's turn_...
-      include Smash::CloudPowers::Synapse::WebSocClient
-      # WebSocServer ..._Faisal's turn_...
-      include Smash::CloudPowers::Synapse::WebSocServer
+      # Socket is a module that allows Nodes to make a direct connection while
+      # still allowing others to read messages.  Websockets are used
+      include Smash::CloudPowers::Synapse::WebSoc
     end
   end
 end

data/lib/cloud_powers/synapse/web_soc.rb

@@ -0,0 +1,13 @@
+require 'cloud_powers/synapse/web_soc/soc_client'
+require 'cloud_powers/synapse/web_soc/soc_server'
+
+module Smash
+  module CloudPowers
+    module Synapse
+      module WebSoc
+        include Smash::CloudPowers::Synapse::WebSoc::SocClient
+        include Smash::CloudPowers::Synapse::WebSoc::SocServer
+      end
+    end
+  end
+end

data/lib/cloud_powers/synapse/web_soc/soc_client.rb

@@ -0,0 +1,52 @@
+require 'websocket-eventmachine-client'
+
+module Smash
+  module CloudPowers
+    module Synapse
+      module WebSoc
+        module SocClient
+          def create_websoc_client(opts = {})
+            ws = {}
+            Thread.new(ws) do
+              EM.run do
+                ws = WebSocket::EventMachine::Client.connect(:uri => 'ws://' + opts[:host]  + ':' + opts[:port])
+
+                client_name = opts[:client] || 'default_client'
+
+                instance_variable_set(:"@#{client_name}",ws)
+
+                open_callback = opts[:on_open] || Proc.new do
+                  puts "Connected"
+                end
+
+                ws.onopen &open_callback
+
+                on_message_callback = opts[:on_message] || Proc.new do |msg, type|
+                  puts "Received message: #{msg}"
+                end
+
+                ws.onmessage &on_message_callback
+
+                on_error_callback = opts[:on_error] || Proc.new do |error|
+                  puts "Error ==> #{error}"
+                end
+
+                ws.onerror &on_error_callback
+
+                on_close_callback = opts[:on_close] || Proc.new do |code, reason|
+                  puts "Disconnected with status code: #{code}"
+                  puts "Disconnected with status message: #{reason}"
+                end
+
+                ws.onclose &on_close_callback
+
+              end
+
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/cloud_powers/synapse/web_soc/soc_server.rb

@@ -0,0 +1,48 @@
+require 'websocket-eventmachine-server'
+module Smash
+  module CloudPowers
+    module Synapse
+      module WebSoc
+        module SocServer
+          def create_websoc_server(opts = {})
+            channel = opts[:channel] || EM::Channel.new
+            Thread.new do
+              EM.run do
+                WebSocket::EventMachine::Server.start(:host => opts[:host], :port => opts[:port]) do |ws|
+                  sid = nil
+
+                  open_callback = opts[:on_open] || Proc.new do
+                    puts "Client connected"
+                    sid = channel.subscribe { |msg| ws.send msg }
+                  end
+                  ws.onopen &open_callback
+
+                  on_message_callback = opts[:on_message] || Proc.new do |msg, type|
+                    @current_websocket_message = msg
+                  end
+                  ws.onmessage &on_message_callback
+
+                  on_error_callback = opts[:on_error] || Proc.new do |error|
+                    puts "Error occured: #{error}"
+                  end
+                  ws.onerror &on_error_callback
+
+                  on_close_callback = opts[:on_close] || Proc.new do
+                    puts "Client disconnected"
+                    channel.unsubscribe(sid) unless channel.nil?
+                  end
+                  ws.onclose &on_close_callback
+                end
+              end
+            end
+            channel
+          end
+
+          def broadcast_message(channel, msg)
+            channel.push msg
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloud_powers/version.rb

@@ -1,3 +1,3 @@
 module CloudPowers
-  VERSION = '0.2.7.23'
+  VERSION = '1.0.0'
 end

data/lib/cloud_powers/zenv.rb

@@ -1,5 +1,5 @@
 require 'dotenv'
-require_relative 'helper'
+require 'cloud_powers/helpers'
 
 module Smash
   module CloudPowers
@@ -9,7 +9,7 @@ module Smash
     # 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 versions
     module Zenv
-      include Smash::CloudPowers::Helper
+      include Smash::CloudPowers::Helpers
 
       # Attempts to find a file by searching the current directory for the file
       # then walking up the file tree and searching at each stop all the way up
@@ -51,12 +51,16 @@ module Smash
       # Returns
       # the value of the +key+ searched for
       def i_vars(key = '')
+        name = to_i_var(key)
+
+        # if no key is given, return a +Hash+ of all i-var/value pairs
         if key.empty?
-          return self.instance_variables.inject({}) do |r,v|
-            r.tap { |h| h[to_snake(v)] = self.instance_variable_get(to_i_var(v)) }
+          return self.instance_variables.inject({}) do |r, v|
+            r.tap { |h| h[name] = self.instance_variable_get(name) }
           end
         end
-        self.instance_variable_get(to_i_var(key))
+
+        self.instance_variable_get(name)
       end
 
       # PROJECT_ROOT should be set as early as possible in this Node's initilize
@@ -119,6 +123,7 @@ module Smash
       # 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 = '')
+        name = to_snake(key).upcase
         if key.empty?
           # Separate key-value pairs from the large string received by `ENV`
           separate_pairs = `ENV`.split(/\n/).map do |string_pair|
@@ -131,14 +136,13 @@ module Smash
             res.tap { |h_res| h_res[pair.first] = pair.last unless (pair.first == pair.last) }
           end
         else
-          res = `printf "#{to_snake(key).upcase}"`
-          return res.empty? ? nil : res
+          Object::ENV.has_key?(name) ? Object::ENV.fetch(name) : nil
         end
       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.
+      #   locations for multiple jobs 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
@@ -154,10 +158,7 @@ module Smash
       # * 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
-          env_vars[to_snake(key).upcase] unless @project_root.nil?) or
-          system_vars[to_snake(key).upcase]
-        (res.nil? or res.empty?) ? nil : res
+        i_vars(key) || env_vars(key) || system_vars(key)
       end
     end
   end