cloud_powers 0.1.5 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5276c7479f1dfcdc4d59aaffa8841d5ab4839180
-  data.tar.gz: 9dcab0fc49c1c0bd9e13fd259719ef697f209429
+  metadata.gz: f7b6c2d878907d4b7d3d61633e5cbb656aaf60e4
+  data.tar.gz: d2719ee9fc973f91e847e19958db96f2bc0daf81
 SHA512:
-  metadata.gz: b5c3f428b50af4dd03c40521d461ed4bc7c23c28b598557b3495bfe85ee63a1571d6f863c0d1203ba9a309214344222b073a232cd340e67c6841ed30863ae65c
-  data.tar.gz: 6bbac08f878d73345f023fde38ffbde8ab92c53a134c828fe4721d176363126ad99e028672e4c3383837afe935da5b32b2f4bffa73a06506710f6e58fa22f29c
+  metadata.gz: c44f2215f31bba48d510f1ac0f780c50d79e85911cf0c1dffd83135d35d19087319718f4446cc9cb22d4c54846dc80eb28f3c12eae5067f4b90bf51758f212ba
+  data.tar.gz: 27f3870cd67688ce00c0c021e49c0f6517609d31c26bf453466963fbeef3c16469e23cd6a47ea194d2b4411e5fbc1c799062d70df5f2cb57af9192c8b02364da

data/Gemfile.lock

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

data/cloud_powers.gemspec

@@ -12,8 +12,12 @@ Gem::Specification.new do |spec|
   spec.summary                =       %q{Cloud providers wrapper.  Currently only AWS is supported.}
   spec.description            =       <<-EOF
     CloudPowers is a wrapper around AWS and other cloud services.
-    This wrapper was developed specifically for the Brain project
-    but can be used in any other ruby project.
+    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.1.5 has a little EC2, S3, SQS and
+    Kinesis.  This project is actively being developed, so more additions, specs
+    and docs will be updated frequently.  I always welcome input.
+    Enjoy!
   EOF
   spec.homepage               =       'https://github.com/adam-phillipps/cloud_powers'
   spec.license                =       'MIT'

data/lib/cloud_powers/aws_resources.rb

@@ -1,14 +1,16 @@
 require_relative 'auth'
 require_relative 'helper'
+require_relative 'zenv'
 
 module Smash
   module CloudPowers
     module AwsResources
       include Smash::CloudPowers::Auth
       include Smash::CloudPowers::Helper
+      include Smash::CloudPowers::Zenv
 
       def region
-        env('Aws Region')
+        zfind('Aws Region')
       end
 
       def ec2

data/lib/cloud_powers/helper.rb

@@ -14,12 +14,12 @@ module Smash
         keys.map do |attr|
           key = to_i_var(attr)
           value = yield key if block_given?
-          instance_variable_set(key, value)
+          instance_variable_set(key, value) unless instance_variable_get(to_i_var(key))
         end
       end
 
-      def env(key)
-        ENV[to_snake(key).upcase]
+      def called_from
+        File.expand_path(File.dirname($0))
       end
 
       def create_logger
@@ -45,7 +45,7 @@ module Smash
       # Gets the path from the environment and sets @log_file using the path
       # @returns @log_file path <String>
       def log_file
-        @log_file ||= env('LOG_FILE')
+        @log_file ||= zfind('LOG_FILE')
       end
 
       # @returns: An instance of Logger, cached as @logger
@@ -107,7 +107,8 @@ module Smash
       end
 
       def to_i_var(var)
-        "@#{to_snake(var)}"
+        var = var.to_s unless var.kind_of? String
+        /^\W*@\w+/ =~ var ? to_snake(var) : "@#{to_snake(var)}"
       end
 
       def to_pascal(var)
@@ -122,7 +123,6 @@ module Smash
       def to_snake(var)
         var = var.to_s unless var.kind_of? String
 
-        # var.gsub(/\W/, '_').downcase
         var.gsub(/:{2}|\//, '_').
           gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
           gsub(/([a-z\d])([A-Z])/,'\1_\2').

data/lib/cloud_powers/self_awareness.rb

@@ -4,6 +4,7 @@ require 'httparty'
 require_relative 'aws_resources'
 require_relative 'helper'
 require_relative './synapse/synapse'
+require_relative 'zenv'
 
 module Smash
   module CloudPowers
@@ -12,14 +13,15 @@ module Smash
       extend Smash::CloudPowers::Synapse::Pipe
       extend Smash::CloudPowers::Synapse::Queue
       include Smash::CloudPowers::AwsResources
+      include Smash::CloudPowers::Zenv
 
-      # gets the instance time or the time it was called and as seconds from
+      # Gets the instance time or the time it was called and as seconds from
       # epoch
       # TODO: use time codes
       def boot_time
         begin
           @boot_time ||=
-            ec2.describe_instances(dry_run: env('testing'), instance_ids:[@instance_id]).
+            ec2.describe_instances(dry_run: zfind('testing'), instance_ids:[@instance_id]).
               reservations[0].instances[0].launch_time.to_i
         rescue Aws::EC2::Errors::DryRunOperation => e
           logger.info "dry run for testing: #{e}"
@@ -47,7 +49,7 @@ module Smash
         end
         send_logs_to_s3
         begin
-          ec2.terminate_instances(dry_run: env('testing'), ids: [@instance_id])
+          ec2.terminate_instances(dry_run: zfind('testing'), ids: [@instance_id])
         rescue Aws::EC2::Error::DryRunOperation => e
           logger.info "dry run testing in die! #{format_error_message(e)}"
           @instance_id
@@ -80,7 +82,7 @@ module Smash
 
       # Gets and sets the public hostname of the instance
       def instance_url
-        @instance_url ||= if env('TESTING')
+        @instance_url ||= if zfind('TESTING')
           'https://test-url.com'
         else
           hostname_uri = 'http://169.254.169.254/latest/meta-data/public-hostname'
@@ -93,10 +95,11 @@ module Smash
       # particular key from the metadata
       # @param: [key <String>]
       def metadata_request(key = '')
-        unless env('TESTING')
+        unless zfind('TESTING')
           metadata_uri = "http://169.254.169.254/latest/meta-data/#{key}"
           HTTParty.get(metadata_uri).parsed_response.split("\n")
         else
+
           @z ||= ['i-9254d106', 'ami-id', 'ami-launch-index', 'ami-manifest-path', 'network/thing']
           if key == ''
             @boogs = ['instance-id', 'ami-id', 'ami-launch-index', 'ami-manifest-path', 'network/interfaces/macs/mac/device-number']
@@ -125,10 +128,10 @@ module Smash
 
       def status(id = @instance_id)
         begin
-          ec2.describe_instances(dry_run: env('testing'), instance_ids: [id]).
+          ec2.describe_instances(dry_run: zfind('TESTING'), instance_ids: [id]).
             reservations[0].instances[0].state.name
         rescue Aws::EC2::Errors::DryRunOperation => e
-          logger.info "Dry run flag set for testing: #{format_error_message(e)}"
+          logger.info "Dry run flag set for testing: #{e}"
           'testing'
         end
       end

data/lib/cloud_powers/storage.rb

@@ -8,7 +8,7 @@ module Smash
 
       def source_task(file)
         # TODO: better path management
-        bucket = env('task storage')
+        bucket = zfind('task storage')
         unless task_path(file).exist?
           objects = s3.list_objects(bucket: bucket).contents.select do |f|
             /#{Regexp.escape file}/i =~ f.key

data/lib/cloud_powers/version.rb

@@ -1,3 +1,3 @@
 module CloudPowers
-  VERSION = "0.1.5"
+  VERSION = "0.2"
 end

data/lib/cloud_powers/zenv.rb

@@ -0,0 +1,94 @@
+require 'dotenv'
+require_relative 'helper'
+module Smash
+  module CloudPowers
+    # This module provides some environment variable management and functionality
+    # System ENV, dotenv ENV and instance variables are considered for now but this
+    # will also use elasticache/redis...some other stuff too, in the coming weeks
+    module Zenv
+      include Smash::CloudPowers::Helper
+      # ZFind looks for the key in a preditermined order of importance:
+      #   * i-vars are considered first becuase they might be tracking different
+      #     locations for multiple tasks or something like that.
+      #   * dotenv files are second because they were manually set, so for sure
+      #     it's important
+      #   * System Env[@] variables are up next.  Hopefully by this time we've found
+      #     our information but if not, it should "search" through the system env too.
+      # @params: key <String>: The key to search for
+      # @return: <String>
+      #   TODO: implement a search for all 3 that can find close matches
+      def zfind(key)
+        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
+      end
+
+      # Search through the instance variables for a key or if no key is given,
+      # return all the i-vars and their values
+      # @params: [key <String]:  The key to search for
+      # @return:
+      def i_vars(key = '')
+        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)) }
+          end
+        end
+        self.instance_variable_get(to_i_var(key))
+      end
+
+      # Search through the .env variables for a key or if no key is given,
+      # return all the .env-vars and their values
+      def env_vars(key = '')
+        return ENV if key.empty?
+        ENV[to_snake(key).upcase]
+      end
+
+      # Search through the system environment variables for a key or if no key
+      # is given, return all the system-env-vars and their values
+      # @params: [key <String>]:  The key to search for
+      # @return: Value <String> for the given key or if no key was given, a
+      # Hash with { key => value, ... } is returned for all keys with a value.
+      # Keys with no value are ommitted from the result.
+      def system_vars(key = '')
+        if key.empty?
+          # Separate key-value pairs from the large string received by `ENV`
+          separate_pairs = `ENV`.split(/\n/).map do |string_pair|
+            string_pair.split('=')
+          end
+          # Separate key-value pairs from each other into a hash of
+          # { key => value, other_key => other_value }
+          #   * keys with no value are removed
+          separate_pairs.inject({}) do |res, pair|
+            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
+        end
+      end
+
+      # PROJECT_ROOT should be set as early as possible in this Node's initilize
+      # method.  This method tries to search for it, using #zfind() and if a `nil`
+      # result is returned from that search, `pwd` is used as the PROJECT_ROOT.
+      # @return: Path to the project root or where ever `pwd` resolves to <Pathname>
+      # TODO: improve this...it needs to find the gem's method's caller's project
+      # root or at least the gem's method's caller's file's location.
+      def project_root
+        if @project_root.nil?
+          pr = (PROJECT_ROOT rescue nil) or zfind('PROJECT_ROOT') or system('pwd')
+          @project_root = Pathname.new(pr)
+        else
+          @project_root
+        end
+      end
+
+      # Manually set the `@project_root` i-var as a `Pathname` object.
+      # @param: New path to the project root <String|Pathname>
+      # @return: @project_root <Pathname>
+      def project_root=(var)
+        @project_root = Pathname.new(var)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud_powers
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: '0.2'
 platform: ruby
 authors:
 - Adam Phillipps
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport-core-ext
@@ -152,8 +152,12 @@ dependencies:
         version: '3.0'
 description: |2
       CloudPowers is a wrapper around AWS and other cloud services.
-      This wrapper was developed specifically for the Brain project
-      but can be used in any other ruby project.
+      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.1.5 has a little EC2, S3, SQS and
+      Kinesis.  This project is actively being developed, so more additions, specs
+      and docs will be updated frequently.  I always welcome input.
+      Enjoy!
 email: adam.phillipps@gmail.com
 executables: []
 extensions: []
@@ -184,6 +188,7 @@ files:
 - lib/cloud_powers/synapse/synapse.rb
 - lib/cloud_powers/version.rb
 - lib/cloud_powers/workflow.rb
+- lib/cloud_powers/zenv.rb
 homepage: https://github.com/adam-phillipps/cloud_powers
 licenses:
 - MIT