eco-helpers 3.0.14 → 3.0.16

data/lib/eco/api/session/config/apis/service_up.rb

@@ -0,0 +1,37 @@
+module Eco
+  module API
+    class Session
+      class Config
+        class Apis
+          module ServiceUp
+            class << self
+              def included(base)
+                target_class = Eco::API::Session::Config::Apis
+                msg  = "To be included in #{target_class}. "
+                msg << "Included in #{base}"
+                raise msg unless base <= target_class
+
+                super
+              end
+            end
+
+            def service_up?
+              @api_test ||=
+                Session::Config::Api.
+                  api_class(active_api.version).
+                  new(
+                    'foobar',
+                    host:   active_api.host,
+                    logger: ::Logger.new(IO::NULL)
+                  )
+
+              status = @api_test.client.get('/policy_groups').status
+              # 401 Unauthorized "Permission denied. API key may be invalid."
+              status == 401
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/session/config/apis/space_helpers.rb

@@ -0,0 +1,41 @@
+module Eco
+  module API
+    class Session
+      class Config
+        class Apis
+          module SpaceHelpers
+            def space_option?
+              SCR.get_arg('-space')
+            end
+
+            def space_option
+              :default.then do |default|
+                value = SCR.get_arg('-space', with_param: true)
+
+                value = nil             if value.to_s.strip.empty?
+                value = to_space(value) unless value.nil?
+                next default unless value
+
+                value
+              end
+            end
+
+            def set_options_space!(space)
+              ASSETS.cli.options.deep_merge!(api: {space: space})
+            end
+
+            private
+
+            def to_space(...)
+              Session::Config::Api.to_space(...)
+            end
+
+            def full_name(...)
+              Session::Config::Api.full_name(...)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/session/config/apis.rb

@@ -3,182 +3,131 @@ module Eco
     class Session
       class Config
         class Apis < BaseConfig
-          def apis
-            self["apis"] ||= {}
-          end
-
-          def apis?
-            apis.keys.length > 0
-          end
-
-          def enviros
-            apis.keys
-          end
+          class UndefinedApi < ArgumentError; end
+
+          require_relative 'apis/space_helpers'
+          require_relative 'apis/enviro_spaces'
+          require_relative 'apis/one_off'
+          require_relative 'apis/service_up'
+
+          include EnviroSpaces
+          include OneOff
+          include ServiceUp
+
+          def add(
+            name,
+            key:,
+            host:,
+            space:        nil,
+            version:      :internal,
+            mode:         :local,
+            user_key:     nil,
+            external_key: nil,
+            email:        nil,
+            pass:         nil,
+            org_id:       nil
+          )
+            # ensure that space_option isn't used
+            space = to_space(space)
+
+            msg = "WARNING: Overriding #{full_name(name, space: space)} API credentials"
+            puts msg if self.defined?(name, space: space)
+
+            apis(space)[name] = Session::Config::Api.new(
+              name,
+              space:        space,
+              key:          key,
+              host:         host,
+              version:      version,
+              mode:         mode,
+              root:         self,
+              user_key:     user_key,
+              external_key: external_key,
+              email:        email,
+              pass:         pass,
+              org_id:       org_id
+            )
 
-          def defined?(name)
-            apis.key?(name)
+            self
           end
 
-          def any_defined?(*names)
-            [names].flatten.any? do |name|
-              self.defined?(name)
-            end
+          # the active environment
+          def active_root_name
+            active_name
           end
 
-          def add(name, key:, host:, version: :internal,
-            mode: :local, user_key: nil, external_key: nil,
-            email: nil, pass: nil, org_id: nil)
-            apis[name] = Session::Config::Api.new(
-              name,
-              key:      key,
-              host:     host,
-              version:  version,
-              mode:     mode,
-              root:     self,
-              user_key: user_key,
-              external_key: external_key,
-              email:    email,
-              pass:     pass,
-              org_id:   org_id
-            )
-            self
+          def active_name
+            self['active-name']
           end
 
           def active_api
-            self["active-api"]
+            self['active-api']
           end
 
           def active_name=(name)
-            raise "'#{name}' Api environment not defined" if !apis[name]
-            self["active-name"] = name
-            self["active-api"]  = apis[name]
-            self
+            set_active_name(name)
           end
 
-          def active_name
-            self["active-name"]
-          end
+          def set_active_name(name, space: space_option)
+            space ||= space_option
 
-          # the active environment
-          def active_root_name
-            active_name
-          end
+            msg = missing_api_message(name, space: space)
+            raise UndefinedApi, msg unless self.api?(name, space: space)
 
-          def service_up?
-            @api_test ||= Session::Config::Api.api_class(active_api.version).new("foobar", host: active_api.host, logger: ::Logger.new(IO::NULL))
-            status = @api_test.client.get("/policy_groups").status
-            # 401 Unauthorized "Permission denied. API key may be invalid."
-            status == 401
+            self['active-name'] = name
+            self['active-api']  = apis(space)[name]
+            set_options_space!(active_space)
+
+            self
           end
 
           def api(logger = ::Logger.new(IO::NULL), version: nil)
-            unless active_api
-              raise "There's no 'active_api'. Use apis.active_name='api_enviro_name' to set the active api"
-            end
+            msg  = "There's no 'active_api'. "
+            msg << "To set the target environment, please use either of:\n"
+            msg << "  * apis.set_active_name('api_enviro_name', space: 'the-space')\n"
+            msg << "  * apis.active_name='api_enviro_name'\n"
+            raise msg unless active_api
+
             active_api.api(version: version, logger: logger)
           end
 
           def default_user_key=(key)
-            self["user_key"] = key
+            self['user_key'] = key
           end
 
           def default_user_key
-            self["user_key"]
+            self['user_key']
           end
 
           def default_email=(email)
-            self["default_email"] = email
+            self['default_email'] = email
           end
 
           def default_email
-            self["default_email"] || ENV['USER_EMAIL']
+            self['default_email'] || ENV['USER_EMAIL']
           end
 
           def default_pass=(pass)
-            self["default_pass"] = pass
+            self['default_pass'] = pass
           end
 
           def default_pass
-            self["default_pass"] || ENV['USER_PASS']
+            self['default_pass'] || ENV['USER_PASS']
           end
 
           # Method to support CLI one-off API requests
           def one_off
-            if one_off?
-              add(one_off_org, key: one_off_key, host: "#{one_off_enviro}.ecoportal.com")
-              return one_off_org
-            end
-          end
-
-          private
-
-          def one_off?
-            @is_one_off ||= SCR.get_arg("-api-key") || SCR.get_arg("-one-off")
-          end
+            return unless one_off?
 
-          def one_off_key
-            return @one_off_key if instance_variable_defined?(:@one_off_key)
-            if one_off?
-              Dotenv.load("./.env_one_off")
-              SCR.get_arg("-api-key", with_param: true).yield_self do |key|
-                 one_off_key_env(key)
-              end
-            end
-          end
-
-          def one_off_key_env(key)
-            if one_off?
-              if key
-                env_file_set_var("./.env_one_off", one_off_key_env_var, key)
-                key
-              else
-                Dotenv.load("./.env_one_off")
-                ENV[one_off_key_env_var].tap do |k|
-                  raise "At least the first time, you should provide the -api-key" unless k
-                end
-              end
-            end
-          end
-
-          def one_off_key_env_var
-            @one_off_key_env_var ||= "#{one_off_org}_KEY"
-          end
+            name = one_off_org
 
-          def one_off_org
-            return @one_off_org if instance_variable_defined?(:@one_off_org)
-            unless org = SCR.get_arg("-org", with_param: true)
-              raise("You should specify -org NAME when using -api-key or -one-off")
-            end
-            @one_off_org  ||= "#{org.downcase.split(/[^a-z]+/).join("_")}_#{one_off_enviro.gsub(".", "_")}".to_sym
-          end
-
-          def one_off_enviro
-            return @one_off_enviro if instance_variable_defined?(:@one_off_enviro)
-            enviro = SCR.get_arg("-enviro") ? SCR.get_arg("-enviro", with_param: true) : "live"
-            @one_off_enviro ||= enviro.downcase
-          end
+            add(
+              name,
+              key:  one_off_key,
+              host: "#{one_off_enviro}.ecoportal.com"
+            )
 
-          def env_file_set_var(file, var, value)
-            begin
-              pattern = /"#{var}=(?<value>[^ \r\n]+)"/
-              File.open(file, "w+") do |fd|
-                found = false
-                fd.each_line do |line|
-                  if match = line.match(pattern)
-                    found = true
-                    #  IO::SEEK_CUR => Seeks to _amount_ plus current position
-                    fd.seek(-(line.length + 1), IO::SEEK_CUR)
-                    fd.write line.gsub(match[:value], value)
-                  end
-                end
-
-                fd << "#{var}=#{value}" unless found
-              end
-            rescue StandardError => e
-              puts "#{e}"
-              return false
-            end
-            return true
+            name
           end
         end
       end

data/lib/eco/api/session/config.rb

@@ -97,18 +97,31 @@ module Eco
           apis.apis?
         end
 
+        ApiDefChain = Struct.new(:root, :name, :params) do
+          def add_space(space, **kargs, &block)
+            kargs = (params || {}).merge(kargs).merge(space: space)
+            root.add_api(name, **kargs, &block)
+          end
+        end
+
         # @param (see Eco::API::Session::Config::Apis#add)
         # @return [Eco::API::Session::Config] this configuration
         def add_api(name, **kargs)
           apis.add(name, **kargs)
-          self
+
+          if block_given?
+            params = kargs.merge({space: :sub_other})
+            yield(ApiDefChain.new(self, name, params))
+          end
+
+          ApiDefChain.new(self, name, {space: :other})
         end
 
         # Set the active api by `name`
         # @see Eco::API::Session::Config::Apis#active_api=
         # @return [Eco::API::Session::Config] this configuration
-        def active_api(name)
-          apis.active_name = name
+        def active_api(name, space: nil)
+          apis.set_active_name(name, space: space)
           self
         end
 
@@ -117,6 +130,11 @@ module Eco
           apis.active_root_name
         end
 
+        # @see Eco::API::Session::Config::Apis#active_space
+        def active_enviro_space
+          apis.active_space
+        end
+
         # @see Eco::API::Session::Config::Apis#api
         # @return [Eco::API::Session::Config::Api] the currently active api
         def api(logger = ::Logger.new(IO::NULL), version: nil)

data/lib/eco/api/usecases/default_cases/samples/sftp_case.rb

@@ -71,7 +71,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def to_remote_path(file)
-    File.join(remote_folder, file)
+    [remote_folder, file].compact.join('/')
   end
 
   def local_folder

data/lib/eco/api/usecases/graphql/helpers/base/error_handling.rb

@@ -3,7 +3,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
   module ErrorHandling
     include Eco::Language::AuxiliarLogger
 
-    attr_reader :exception
+    attr_reader :exception, :exiting
 
     private
 
@@ -19,6 +19,14 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
       exception && !interrupted?
     end
 
+    def exiting?
+      @exiting
+    end
+
+    def exception?
+      error_raised? || exiting?
+    end
+
     def rescued
       yield
     rescue StandardError => err
@@ -27,24 +35,27 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
       unless exception_already_captured?(err)
         log(:error) { err.patch_full_message }
       end
+    rescue SystemExit
+      @exiting = true
+      raise
     end
 
     def with_error_handling
       @exception = nil
       yield
-    rescue SystemExit => sext
-      @exception = sext
-      exit sext.status
-    rescue *interrupt_errors => int
+    rescue StandardError, SignalException => err
+      @exception = err
+      raise
+    rescue SystemExit
+      @exiting = true
+      raise
+    rescue *interrupt_errors
       @exception = int
       raise
     rescue SystemStackError
       puts $! # rubocop:disable Style/SpecialGlobalVars
       puts caller[0..100]
       raise
-    rescue StandardError, SignalException => err
-      @exception = err
-      raise
     end
 
     def interrupt_errors

data/lib/eco/api/usecases/graphql/helpers/base/graphql_env.rb

@@ -8,6 +8,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
     def graphql
       msg = "The credentials or basic graphql config are missing for the active environment"
       raise msg unless session.api?(version: :graphql)
+
       @graphql ||= session.api(version: :graphql)
     end
   end

data/lib/eco/api/usecases/graphql/samples/location/command/dsl.rb

@@ -49,15 +49,11 @@ class Eco::API::UseCases::GraphQL::Samples::Location
           end
 
           break if error
+        rescue StandardError => err
+          log(:error) { err.patch_full_message }
+          raise
         end
       end
-    rescue SystemStackError
-      puts $! # rubocop:disable Style/SpecialGlobalVars
-      puts caller[0..100]
-      raise
-    rescue StandardError => err
-      log(:error) { err.patch_full_message }
-      raise
     ensure
       rescued { self.tags_remap_csv_file = generate_tags_remap_csv }
       rescued { close_handling_tags_remap_csv }

data/lib/eco/api/usecases/graphql/samples/location/command/service/tree_update.rb

@@ -21,7 +21,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
             super
           end
         ensure
-          rescued { re_archive } unless error_raised?
+          rescued { re_archive } unless exception?
           rescued { email_digest('TagTree Update') }
         end
 
@@ -30,7 +30,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
         # @note this is an additional necessary step
         def re_archive
           return if simulate?
-          return if error_raised?
+          return if exception?
 
           stage = :rearchive
 
@@ -90,8 +90,12 @@ class Eco::API::UseCases::GraphQL::Samples::Location
 
           digest_msgs   = logger.cache.logs(level: %i[info error warn])
           str_exception = exception ? " - Exception!" : ''
+          str_exception = " - Aborted!" if exiting?
+
           subject       = "#{config.active_enviro} - #{title}#{str_exception}"
 
+          digest_msgs  << "\n#{exception.patch_full_message(trace_count: 3)}" if exception
+
           session.mail(subject: subject, body: digest_msgs.join).tap do
             options.deep_merge!({worfklow: {no_email: true}})
           end

data/lib/eco/cli/config/options_set.rb

@@ -21,9 +21,11 @@ module Eco
 
           ["The following are the available options#{refinement}:"].then do |lines|
             max_len = keys_max_len(options_args(spaces)) + indent
+
             spaces.each do |namespace|
               is_general = (namespace == :general)
               str_indent = is_general ? "" : " " * indent
+
               lines << help_line(namespace, "", max_len) unless is_general
 
               options_set(namespace).select do |_arg, option| # rubocop:disable Style/HashEachMethods
@@ -32,6 +34,7 @@ module Eco
                 lines << help_line("#{str_indent}#{option.name}", option.description, max_len)
               end
             end
+
             lines
           end.join("\n")
         end
@@ -63,13 +66,13 @@ module Eco
           raise "Missing block to define the options builder" unless block_given?
 
           opts = [option].flatten.compact
-          unless opts.empty?
-            callback = block
-            opts.each do |opt|
-              msg = "Overriding CLI option '#{option}' in '#{namespace}' CLI case / namespace"
-              puts msg if option_exists?(opt, namespace)
-              options_set(namespace)[opt] = OptConfig.new(opt, namespace, desc, callback)
-            end
+          return self if opts.empty?
+
+          callback = block
+          opts.each do |opt|
+            msg = "Overriding CLI option '#{option}' in '#{namespace}' CLI case / namespace"
+            puts msg if option_exists?(opt, namespace)
+            options_set(namespace)[opt] = OptConfig.new(opt, namespace, desc, callback)
           end
 
           self

data/lib/eco/cli/scripting/args_helpers.rb

@@ -78,15 +78,24 @@ module Eco
 
         # @return [String, Boolean] the argument value if `with_param` or a `Boolean` if not.
         def get_arg(key, with_param: false, valid: true)
-          # track what a known option looks like
-          known_argument(key, with_param: with_param)
-          return nil  unless (index = get_arg_index(key))
-          return true unless with_param
-
-          value  = argv[index + 1]
-          #puts "modifier argument: #{value}"
-          value  = nil if valid && is_modifier?(value)
-          value
+          case key
+          when Array
+            key.reduce(nil) do |value, k|
+              next value unless value.nil?
+
+              get_arg(k, with_param: with_param, valid: valid)
+            end
+          else
+            # track what a known option looks like
+            known_argument(key, with_param: with_param)
+            return nil  unless (index = get_arg_index(key))
+            return true unless with_param
+
+            value  = argv[index + 1]
+            #puts "modifier argument: #{value}"
+            value  = nil if valid && is_modifier?(value)
+            value
+          end
         end
 
         # @return [String] the filename.

data/lib/eco/cli_default/options.rb

@@ -153,6 +153,14 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       session.config.dry_run!
     end
 
+    desc  = "Specifies the target API key space (i.e. uat, dev, etc.). "
+    desc << "Use with CAUTION !!!"
+    options_set.add('-space', desc) do |options, session|
+      next unless space = SCR.get_arg('-space', with_param: true)
+
+      options.deep_merge!(api: {space: space.to_sym})
+    end
+
     desc = "It specifies the type of batch to be used (default: ':batch')"
     options_set.add("-batch-mode", desc) do |options, session|
       mode_in  = SCR.get_arg("-batch-mode", with_param: true)

data/lib/eco/cli_default/people.rb

@@ -23,7 +23,8 @@ ASSETS.cli.config do |cnf|
 
         msg  = "(Optimization) "
         msg << "Switching from partial to full people download. "
-        msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL (#{MAX_GET_PARTIAL}) entries."
+        msg << "Input (#{input.count}) surpases MAX_GET_PARTIAL "
+        msg << "(#{MAX_GET_PARTIAL}) entries."
         session.log(:info) { msg }
 
         options.deep_merge!(people: {
@@ -46,8 +47,6 @@ ASSETS.cli.config do |cnf|
     elsif get_by_file
       # -people-from-backup
       session.micro.people_load(get[:file], modifier: :file)
-      #people = JSON.parse(File.read(get[:file]))
-      #Eco::API::Organization::People.new(people)
     else
       options.deep_merge!(people: {
         get: {
@@ -67,6 +66,7 @@ ASSETS.cli.config do |cnf|
         })
         people = session.micro.people_cache
       end
+
       people
     end
   end

data/lib/eco/language/basic_logger.rb

@@ -24,6 +24,7 @@ module Eco
       def initialize(level: ::Logger::INFO, timestamp: false)
         @level             = level
         self.timestamp     = timestamp
+
         loggers[:console]  = ::Logger.new($stdout).tap do |logger|
           logger.formatter = format_proc(console: true)
           logger.level     = level
@@ -51,13 +52,14 @@ module Eco
       end
 
       def console_timestamp(datetime)
-        return nil unless timestamp?
+        return unless timestamp?
 
         timestamp(datetime)
       end
 
       def timestamp(datetime)
-        return nil unless datetime
+        return unless datetime
+
         str_date = datetime.strftime(self.class::TIMESTAMP_PATTERN)
         "#{str_date} > "
       end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.14'.freeze
+  VERSION = '3.0.16'.freeze
 end