cloud_powers 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc966e1561d2a202cfa35dd2cf3147d4ef2b840
-  data.tar.gz: d371b86048fef80382f4bc6cd61a3a4a5a7d16bf
+  metadata.gz: 0eca6befe5c9eec2c6467c012fbe341e0152728e
+  data.tar.gz: 8e6e169a6ed75c5c3da387d49e4c635f501e72ef
 SHA512:
-  metadata.gz: 2125004e0684f341d86a5c04ad62edeafb44ee8de978a7487518d319594e0ac165296170cdb1930a6e1928814198c9dd67729a9d0ba8cb10d8604a072b94c78a
-  data.tar.gz: 8fc1f114aa0be9caedd619e611d3e3014ac31c3f55113b0ba661a50f1b014e3996c711c8a108601673044c0b4aca22307b2f308fae73679119a724de192c2b0d
+  metadata.gz: d1a9e681a605063b21d71c5b449d5a9385caa655e68304e017dca1e05e02ec0ee500358e5415bcd8cdaff9755250d9f8b5e2a541f732b3b1b26907366bca84fd
+  data.tar.gz: 2d1fb49aa5756d5163163585977a75ed6d2281d7dc1271615cc8f529e4ac44f85e4343b3d2df43c2373ef0b6b4375c0b45685a1dfb4454309342774f2ade951a

data/.gitignore

@@ -10,7 +10,6 @@
 **/tmp/
 **/*.env
 **/.byebug_history
-**/lib/cloud_powers/synapse/.DS_Store
-**/.DS_Store
-**/./**/.DS_Store
+**/.DS_Store*
 **/*.swp
+**/*zlib

data/.test.env.example

@@ -17,6 +17,7 @@ STATUS_STREAM="e.g. kinesis stream name"
 
 # Aws s3 buckets etc
 JOB_STORAGE="e.g. s3 object name"
+JOBS_STORAGE="same as JOB_STORAGE"
 
 # Aws sqs queue addresses
 BACKLOG_QUEUE_ADDRESS=""

data/cloud_powers.gemspec

@@ -41,8 +41,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_runtime_dependency       'websocket-eventmachine-server', '~> 1.0.1'
+  spec.add_runtime_dependency       'websocket-eventmachine-client', '~> 1.2.0'
   spec.add_runtime_dependency       'workflow'
 
   spec.add_development_dependency   'bundler', '~> 1.14.3'

data/lib/cloud_powers/creatable.rb

@@ -83,8 +83,9 @@ module Smash
 
       module AfterHooks
         # Alternative to <tt>save!()</tt>.  This predicate method is based off
-        # the <tt>@linked</tt> i-var and is set to true after it has been confirmed
-        # that this resource is a good map to the resource in the cloud.
+        # the <tt>@linked</tt> i-var and is set to true after it has been
+        # confirmed that this resource is a good map to the resource in the
+        # cloud.
         #
         # Returns
         # * +Boolean+
@@ -92,18 +93,24 @@ module Smash
           !!@linked
         end
 
-        # An +after_hook+ style method that sends a reqeust to your custom implementation
-        # of the <tt>create_resource</tt> methodallows you to do things after you
-        # create the resource, in the cloud.  This method relies on you having
-        # a <tt>create_resource</tt> method that can handle every aspect of creating
-        # your resource.  If this piece of the contract isn't obeyed, you will
-        # receive a <tt>NoMethodError</tt>.
+        # An +after_hook+ style method that sends a reqeust to your custom
+        # implementation of the <tt>create_resource</tt> methodallows you to do
+        # things after you create the resource, in the cloud.  This method
+        # relies on you having a <tt>create_resource</tt> method that can handle
+        # every aspect of creating your resource.  If this piece of the contract
+        # isn't obeyed, you will receive a <tt>NoMethodError</tt>.
         #
         # Returns
         # +Boolean+ - +true+ if the resource
+        #
+        # Notes:
+        # * This method relies on you implementing a method called
+        #   +create_resource+ in your class.  If you don't, this code will still
+        #   execute without errors but +@saved+ will remain +false+
         def save!
           resp = create_resource if self.respond_to? :create_resource
           @saved = !resp.nil?
+          resp
         end
 
         # Find out if the resource was created
@@ -117,6 +124,3 @@ module Smash
     end
   end
 end
-
-
-

data/lib/cloud_powers/example_objects.rb

@@ -0,0 +1,88 @@
+
+
+
+'Hey,'.kind_of? Object &&
+  'you guuyyys!'.is_a? String
+#=> true
+
+
+
+
+1.kind_of? Object &&
+  1.is_a? Numeric
+#=> true
+
+
+
+
+person_hash = {
+  name: 'Fredward Mc',
+  nationality: "'MERCA"
+}
+person_hash.kind_of? Object &&
+  person_hash.kind_of? Enumerable
+# => true
+
+
+
+
+class Person
+  self
+end
+
+fredward = Person.new
+fredward.kind_of? Object &&
+  fredward.is_a? Person
+#=> true, probably
+
+
+
+
+system('compress', 'this.rb', 'and.sh', 'that.js', fredward, -> { some_method })
+
+
+
+
+
+fredward
+
+
+
+fredward.cats.select do |cat|
+  cat.pays_rent?
+end
+
+
+class Person
+  attr_accessor :name
+
+  def initialize(**opts)
+    @name = opts[:name]
+  end
+
+  def speak(words)
+    "Hi, I'm #{@name} and #{words}"
+  end
+end
+
+batman = Person.new(name: 'Bruce')
+
+
+batman.speak("I'm Batman")
+=> "Hi, I'm Bruce and I'm Batman"
+
+
+class Yokl < Person
+  attr_accessor :cats
+
+  def initialize(**opts)
+    super
+    @cats = opts[:cats]
+  end
+
+  def speak(words)
+    "#{super(words).upcase}, YA'LL"
+  end
+end
+
+fredward = Yokl.new(name: 'Fredward Mc', cats: ['bud', 'icehouse', 'miller', 'modelo', 'pabst'])

data/lib/cloud_powers/helpers/lang_help.rb

@@ -1,7 +1,6 @@
 module Smash
   module CloudPowers
     module LangHelp
-
       # Allows you to modify all keys, including nested, with a block that you pass.
       # If no block is passed, a copy is returned.
       #
@@ -50,6 +49,33 @@ module Smash
         end
       end
 
+      # Take an Enumerable apart based on a block.  This method works like
+      # Array#reject! except it creates 2 new Enumerables of the same type you
+      # started with; One has the rejected elements and the other has the kept.
+      #
+      # Parameters
+      # * +Enumerable+ - The Enumerable object to start with
+      #
+      # Returns
+      # * +Enumerable+ - The extracted elements in the same type of Enumerable
+      #   passed as a parameter
+      #
+      # Notes:
+      # * This modifies the Object passed as a parameter and returns another
+      def extract!(enumerable)
+        return enumerable if enumerable.nil?
+
+        if block_given?
+          copy = enumerable.dup
+
+          enumerable.reject! { |k,v| yield k,v }
+
+          copy.respond_to?(:-) ? (copy - enumerable) : copy.keep_if { |k,v| !enumerable.has_key? k }
+        else
+          enumerable
+        end
+      end
+
       # Search through a +Hash+ without knowing if the key is a +String+ or
       # +Symbol+.  A +String+ modification that _normalizes_ each value to compare
       # is used that is case insensitive.  It only leaves word characters, not
@@ -198,13 +224,12 @@ module Smash
       # Change strings into an i-var format
       #
       # Parameters
-      # * var +String+
+      # * key +String+
       #
       # Returns
       # +String+
-      def to_i_var(var)
-        var = var.to_s unless var.kind_of? String
-        /^\W*@\w+/ =~ var ? to_snake(var) : "@#{to_snake(var)}"
+      def to_i_var(key)
+        "@#{to_snake(key.to_s)}"
       end
 
       # Change strings into PascalCase
@@ -232,7 +257,7 @@ module Smash
       # * includes ruby file extension
       # * see #to_snake()
       def to_ruby_file_name(name)
-        return name if /\w+\.rb$/ =~ name
+        return name if /\w+\.rb$/ =~ name.to_s
         "#{to_snake(name)}.rb"
       end
 
@@ -249,9 +274,8 @@ module Smash
       # * will not have file extensions
       # * see #to_ruby_file_name()
       def to_snake(var)
-        var = var.to_s unless var.kind_of? String
-
-        var.gsub(/:{2}|\//, '_').
+        var.to_s.gsub(/^\W*([A-Z|a-z]*)/,'\1').
+          gsub(/:{2}|\//, '_').
           gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
           gsub(/([a-z\d])([A-Z])/,'\1_\2').
           gsub(/\s+/, '_').

data/lib/cloud_powers/helpers/logic_help.rb

@@ -23,16 +23,15 @@ module Smash
       #
       #   puts @bar
       #   # => 'bar:1475434059'
-      def attr_map(attributes)
+      def attr_map(attributes = self.i_vars)
         attributes = [attributes, nil] unless attributes.respond_to? :map
 
         attributes.inject(self) do |this, (attribute, before_value)|
-          first_place, second_place = yield attribute, before_value if block_given?
-
-          results = if second_place.nil?
-            [attribute, first_place]
+          results = if block_given?
+            first_place, second_place = yield attribute, before_value
+            second_place.nil? ? [attribute, first_place] : [first_place, second_place]
           else
-            [first_place, second_place]
+            [attribute, before_value]
           end
 
           this.instance_variable_set(to_i_var(results.first), results.last)
@@ -45,12 +44,31 @@ module Smash
       # project root is etc.
       #
       # Returns
-      # +String+
+      # * +Pathname+
       #
       # Notes
-      # * Uses +$0+ to figure out what the current file is
+      # * Uses <tt>::#caller()</tt> to figure out where the request came from
       def called_from
-        File.expand_path(File.dirname($0))
+        sanitized_path_string = caller.first.gsub(/:.*/,'')
+        calling_file = File.expand_path(sanitized_path_string)
+        to_realpath(calling_file).parent
+      end
+
+      # Gather up this object's instance variables and create a +Hash+ from the
+      # name/value pairs
+      #
+      # Returns
+      # * +Hash+
+      #
+      # Example
+      #   5class A; attr_accessor :eh; end
+      #   a.i_var_hash
+      #   => { eh: nil }
+      def i_var_hash
+        self.instance_variables.inject({}) do |hash, (k,v)|
+          hash[k.to_s.gsub('@', '')] = self.instance_variable_get to_i_var(k)
+          hash
+        end
       end
 
       # Create an <tt>attr_accessor</tt> feeling getter and setter for an instance
@@ -138,6 +156,7 @@ module Smash
           opts = {}
           opts[:extraInfo] = { message: update }
         end
+
         updated_extra_info = opts.delete(:extraInfo) || {}
 
         {

data/lib/cloud_powers/helpers/path_help.rb

@@ -6,45 +6,52 @@ module Smash
   module CloudPowers
     module PathHelp
 
-      # Gives a common home for jobs to live so they can be easily grouped and
-      # found.  This method will create nested directories, based on the
-      # <tt>#project_root()</tt> method and an additional 'lib/jobs' directory.
-      # If no project root has been set by the time this method is called, a new
-      # directory will be created relative to the gem's project root.
+      # Offer a common "path" delimiter.  This is designed to allow Storage keep
+      # a common delimiter.  It's not required but it makes things a little more
+      # human friendly
       #
       # Returns
       # +String+
-      #
-      # Notes
-      # * # If no project root has been set by the time this method is called, a new
-      # directory will be created relative to the gem's project root.  This might
-      # have deeper implications than you want to deal with so it's always a good
-      # idea to set your project root as soon as you can.
-      # * TODO: find a way to have this method figure out the actual project's
-      #   root, as opposed to just making common <i>"good"</i> assumptions.
-      def job_home
-        string_th = FileUtils.mkdir_p("#{project_root}/lib/jobs/").first
-        @job_home ||= Pathname.new(string_th).realpath.to_s
+      def common_delimiter
+        '/'.freeze
       end
 
-      # Gives the path from the project root to lib/jobs[/#{file}.rb]
+      # Expand a +Pathname variable
       #
       # Parameters
-      # * file +String+ (optional) (default is '') - name of a file
+      # * arg +String+
       #
       # Returns
-      # * path/file +String+ if +file+ parameter is given.  return has
-      #   '.rb' extension included
-      # * file +String+ if +file+ parameter is not given it will return the
-      #   <tt>#job_require_path()</tt>
+      # * +Pathname+ - Absolute path
       #
-      # Notes
-      # * See <tt>#job_home</tt>
-      def job_path(file = '')
-       return job_home if file.empty?
-        Pathname.new("#{job_home}/#{file}").to_s
+      # Notes:
+      # * This method doesn't guarantee that the path actually exists; It just
+      #   gives you a correct, absolute path
+      def expand_path(arg)
+        to_pathname(arg).expand_path
       end
 
+      # Check if the URL exists
+      #
+      # Parameters
+      # * file +String+
+      #
+      # Returns
+      # +Boolean+
+      def file_exists?(*args)
+        File.exist?(*args.join('/').to_s)
+      end
+
+      # Determine if this path or name seems like a file or a directory
+      #
+      # Parameters
+      # * +Pathname+|+String+
+      #
+      # Returns
+      # * +Boolean+
+      def filename?(pathname)
+        !!(/[A-Za-z]*\.[A-Za-z]+$/ =~ pathname.to_s)
+      end
 
       # Check if the job file exists in the job directory
       #
@@ -55,14 +62,28 @@ module Smash
       # +Boolean+
       #
       # Notes
-      # * See +#job_home()+
+      # * See <tt>#job_home()</tt>
+      # * See <tt>#path_exists?()</tt>
       def job_exist?(file)
-        begin
-          File.new("#{job_home}/#{file}")
-          true
-        rescue Errno::ENOENT
-          false
-        end
+        file_exists?(job_home, file)
+      end
+
+      # Gives the path from the project root to lib/jobs[/#{file}.rb]
+      #
+      # Parameters
+      # * file +String+ (optional) (default is '') - name of a file
+      #
+      # Returns
+      # * path/file +String+ if +file+ parameter is given.  return has
+      #   '.rb' extension included
+      # * file +String+ if +file+ parameter is not given it will return the
+      #   <tt>#job_require_path()</tt>
+      #
+      # Notes
+      # * See <tt>#job_home</tt>
+      def job_path(file = '')
+        return job_home if file.empty?
+        to_pathname(job_home, file)
       end
 
       # Gives the path from the project root to lib/jobs[/file]
@@ -78,6 +99,7 @@ module Smash
       # * Neither path nor file will have a file extension
       # * See <tt>#job_home</tt>
       def job_require_path(file_name = '')
+        # TODO: refactor to use Pathname as much as possible
         begin
           file_sans_extension = File.basename(file_name, '.*')
           (Pathname.new(job_home) + file_sans_extension).to_s
@@ -85,6 +107,194 @@ module Smash
           nil
         end
       end
+
+      # Find all <i>directories</i> that match the given string.
+      #
+      # Returns
+      # * +Pathname+ - absolute path
+      #
+      # Notes
+      # * This method is su-looooOOOOOOOw but it's pretty thorough.  Fixing that
+      #   while keeping it thorough is a high priority but it works.  Your best
+      #   bet is to try to set the location for things you're looking for, before
+      #   you use them.  Another alternative is to use a jailed root to run your
+      #   project from.
+      def file_search(name, scope = '/**')
+        Pathname.glob("#{scope}/#{name}").select(&:exist?).reject(&:directory?).map(&:realpath)
+      end
+
+
+      def paths_lcd(*paths)
+        unpacked_paths = paths.map { |path| path.to_s.split('/') }.sort
+        shortest_path_dirs = unpacked_paths.first.count # this is the shortest path
+        common_path = []
+
+        (0..shortest_path_dirs).each do |i|
+          if unpacked_paths.first[i] == unpacked_paths.last[i]
+            common_path << unpacked_paths.first[i]
+          end
+        end
+
+        to_pathname(common_path.join('/'))
+      end
+
+      def paths_gcd(*paths)
+        start_from = paths_lcd(*paths)
+        paths.sort.last.relative_path_from(start_from)
+      end
+
+      # Find all <i>directories</i> that match the given string.
+      #
+      # Returns
+      # * +Pathname+ - absolute path
+      #
+      # Notes
+      # * This method is su-looooOOOOOOOw but it's pretty thorough.  Fixing that
+      #   while keeping it thorough is a high priority but it works.  Your best
+      #   bet is to try to set the location for things you're looking for, before
+      #   you use them.  Another alternative is to use a jailed root to run your
+      #   project from.
+      def path_search(name, scope = default_scope)
+        Pathname.glob("#{scope}/#{name}").select(&:exist?).select(&:directory?).map(&:realpath)
+      end
+
+      # Convert a list of arguments to a path-like +String+ object.
+      #
+      # Parameters
+      # * [+Object+[,...]]
+      #
+      # Returns
+      # * +String+
+      def to_path(*args)
+        to_pathname(*args).to_s
+      end
+
+      # Convert a list of arguments to a +Pathname+ object.
+      #
+      # Parameters
+      # * [+String+[,...]]
+      #
+      # Returns
+      # * +Pathname+
+      def to_pathname(*args)
+        args = args.flatten.compact
+        # #join() will create a path that looks like this `//your/path` if the
+        # first argument is the same as the path seperator on your system.
+        first = /^\/+\W*$/ =~ args.first.to_s ? args.shift : ''
+        path_string = args.join('/')
+        path_string = first + path_string
+        Pathname.new(path_string)
+      end
+
+      # Create and/or get the full path to the argument(s)
+      #
+      # Parameters
+      # * +String+(s) - a path or chunks of a path, in order, as +String+s
+      #
+      # Returns
+      # * +Pathname+
+      #
+      # Notes:
+      # * !This method creates paths, even nested paths, if they don't exist!
+      # * !Use <tt>expand_path</tt> if you don't want to create anything but still
+      #   need the full path
+      # * See <tt>#to_pathname</tt>
+      # * See <tt>#touch</tt>
+      def to_realpath(*args)
+        begin
+          pathname = to_pathname(*args)
+          pathname.realpath
+        rescue Errno::ENOENT => e
+          logger.debug("#to_realpath(#{pathname}) called from " +
+            "#{caller.first} but the path doesn't exist")
+          to_realpath(touch(pathname))
+        end
+      end
+
+      # Create a file or directory.  You don't have to worry if the path exists.
+      #
+      # Parameters
+      # * path +Pathname+|+String+ - path that you would like created
+      #
+      # Returns
+      # * +Pathname+ - path to your new object
+      #
+      # Notes:
+      # * This method assumes you are careful enough not to break your machine
+      #   because you might accidentally over-write an existing, important path
+      #   with an empty file or directory. That's no different than any other
+      #   library, like +FileUtils+ or +Pathname+ but it's worht being said,
+      #   just for good measure.
+      def touch(path)
+        pathname = to_pathname(path)
+        filename?(pathname) ? ::FileUtils.touch(pathname) : ::FileUtils.mkdir_p(pathname)
+        to_realpath(pathname)
+      end
+
+      # Offer a common place to operate from, so <tt>CloudPowers</tt> stays tidy.
+      # This method will find out if your project responds to a method called
+      # 'project_root'.  If the method exist, it uses it, otherwise, your new
+      # files etc. will be places at <tt>`pwd`/zlib</tt>.
+      #
+      # Returns
+      # * +Pathname+
+      #
+      # Notes:
+      # * See <tt>to_realpath</tt>
+      def zlib_path(object = '')
+        return zlib_home if (object.nil? || object.empty?)
+        to_path(zlib_home, object)
+      end
+
+      private
+      def has_project_root_defined?
+        self.respond_to? :project_root
+      end
+
+      # Gives a common home for jobs to live so they can be easily grouped and
+      # found.  This method will create nested directories, based on the
+      # <tt>#project_root()</tt> method and an additional 'lib/jobs' directory.
+      # If no project root has been set by the time this method is called, a new
+      # directory will be created relative to the gem's project root.
+      #
+      # Returns
+      # +Pathname+
+      def job_home
+        path_string = "#{zlib_path}/jobs"
+        @job_home ||= path_search(path_string).first || to_realpath(path_string)
+      end
+
+      # Gives a common home for this project to store or read from.  This method
+      # will create nested directories, based on the <tt>#project_root</tt>
+      # method if it exists, or it will create the +zlib+ directory wherever this
+      # method was called from.
+      #
+      # Returns
+      # * +Pathname+
+      #
+      # Notes
+      # * # If no project root has been set by the time this method is called, a new
+      # directory will be created relative to the gem's project root.  This might
+      # have deeper implications than you want to deal with so it's always a good
+      # idea to set your project root as soon as you can.
+      # * TODO: find a way to have this method figure out the actual project's
+      #   root, as opposed to just making common <i>"good"</i> assumptions.
+      def zlib_home
+       @zlib_home ||= to_realpath(
+          has_project_root_defined? ? project_root + 'zlib' : './zlib'
+        )
+      end
+
+      private
+      def default_scope
+        if self.respond_to? :origin
+          origin
+        elsif self.respond_to? :project_root
+          project_root || proc_cwd || ps_cwd
+        else
+          to_realpath(called_from).parent
+        end
+      end
     end
   end
 end

data/lib/cloud_powers/resource.rb

@@ -19,9 +19,11 @@ module Smash
       attr_accessor :name
       # whether or not a call has been made to the cloud to back this resource
       attr_accessor :linked
+      # metadata, i.e. tracking on the remote resource that maps to this resource
+      attr_accessor :meta
       # the ID in the cloud; e.g. ARN for AWS, etc
       attr_accessor :remote_id
-      # tracking on the remote resource that maps to this resource
+      # @tags will be deprecated in V2.  Please use @meta
       attr_accessor :tags
       # the type of resource this was instantiated as
       attr_accessor :type
@@ -30,14 +32,16 @@ module Smash
       # inherits from this class.  The initialize method follows the method
       # signature for the active record-like pattern being followed throughout
       # the code
-      def initialize(name:, client: nil, **config)
+      def initialize(name:, **config)
         @linked = false
         @saved = false
-        @client = client
-        @type = to_snake(self.class.name.split('::').last)
+        @client = config[:client]
+        @type = to_snake(config[:named_type] || config[:type] || self.class.name.split('::').last)
         @call_name = to_snake("#{name}_#{@type}")
         @name = name
-        @tags = Array.new
+        @meta = Array.new # TODO: create a Meta resource and use it here
+        @tags = @meta
+        logger.debug '@tags will be deprecated in V2.  Please use @meta'
       end
     end
   end