xlogin 0.10.6 → 0.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b76cd8edf7d600a84e2a767d4c8b82b9e10f4a4b23005945e2564b0044d3dd
-  data.tar.gz: 72a4be4e9695eee0e1d2bfd27ac7d1160c2ebb9b13d6fb0a55b7f6485d92dd3b
+  metadata.gz: a3f7a65ed48d5aa25928be4d31714657faa282f21fe317908c6da68f61ce9ab9
+  data.tar.gz: 4fc355338732d7df48ef787a152171460c334c3e9494c251e3472c4c892af84a
 SHA512:
-  metadata.gz: 9c8016bb18c5eb34c88bdaecc837545051764f3d62cda2b50e32de749024a07b9d478aff4d00e78ce6ed2a20a4f4a17405ac3a415a429234caa48ede5871709c
-  data.tar.gz: 145902d4170b96bb665c4e6513a6e024f55aaf68b71693ff759c7a5b25f40b5cdee5d77fce255aee20f9ec03c8db81eee07ab594d8a8edbbc49f3bfc7ed45be5
+  metadata.gz: 13df83043b60975e0e17a505b0568aec8c779ff321ba512fbecf1bc654a80d044a5221ca9b69db048c3f1b6412706da05cc013b9ec5ff8c82fcadbb76988202f
+  data.tar.gz: '063955b5da490638837d0bc04f35c867ba4fe4861d56862854a06939f11d56b94afafec329c0bebc339894e649b34ee509b94b95cb07dfe859c2de9d272f48e6'

data/lib/xlogin/delegator.rb

@@ -15,7 +15,7 @@ module Xlogin
 
         login    = @methods.fetch(:login)
         delegate = @methods.fetch(:delegate)
-        raise TemplateError.new("'login' and 'delegate' must be defined in the #{target_info[:type]} template.") unless login && delegate
+        raise TemplateError.new("'login' and 'delegate' methods must be defined in the #{target_info[:type]} template.") unless login && delegate
 
         relay_uri = Addressable::URI.parse(uri.to_s)
         userinfo_cache = relay_uri.userinfo.dup

data/lib/xlogin/factory.rb

@@ -1,5 +1,6 @@
 require 'addressable/uri'
 require 'singleton'
+require 'xlogin/session_pool'
 require 'xlogin/template'
 
 module Xlogin
@@ -13,9 +14,8 @@ module Xlogin
       @session_pool = Hash.new
     end
 
-    def set_inventory(**opts)
-      return unless name = opts[:name]
-      @inventory[name] = (get_inventory(name) || {}).merge(opts)
+    def set_inventory(name, **opts)
+      @inventory[name] = (get_inventory(name) || {name: name}).merge(opts)
     end
 
     def get_inventory(name)
@@ -34,14 +34,14 @@ module Xlogin
     end
 
     def set_template(name, text = nil, &block)
-      template = get_template(name)
+      template = get_template(name) || Xlogin::Template.new(name)
       template.instance_eval(text)   if text
       template.instance_eval(&block) if block
       @templates[name.to_s.downcase] = template
     end
 
     def get_template(name)
-      @templates[name.to_s.downcase] ||= Xlogin::Template.new(name)
+      @templates[name.to_s.downcase]
     end
 
     def list_templates
@@ -50,6 +50,8 @@ module Xlogin
 
     def build(type:, **opts)
       template = get_template(type)
+      raise TemplateError.new("Template not found: '#{type}'") unless template
+
       template.build(uri(opts), **opts)
     end
 
@@ -73,15 +75,16 @@ module Xlogin
 
     private
     def uri(**opts)
-      return opts[:uri].strip if opts.key?(:uri)
-      raise SessionError.new("Invalid target: '#{opts}'") unless opts[:scheme] && opts[:host]
+      return Addressable::URI.parse(opts[:uri].strip) if opts.key?(:uri)
 
       scheme   = opts[:scheme].strip
       address  = opts.values_at(:host, :port).compact.map(&:strip).join(':')
       userinfo = opts[:userinfo].strip
       userinfo ||= opts.values_at(:username, :password).compact.map(&:strip).join(':')
 
-      "#{scheme}://" + [userinfo, address].compact.join('@')
+      Addressable::URI.parse("#{scheme}://" + [userinfo, address].compact.join('@'))
+    rescue
+      raise SessionError.new("Invalid target - '#{opts}'")
     end
 
   end

data/lib/xlogin/rake_task.rb

@@ -5,21 +5,18 @@ require 'ostruct'
 require 'stringio'
 
 module Xlogin
-
   class RakeTask < Rake::TaskLib
 
     class << self
       include Rake::DSL
 
-      def generate(*target, **opts, &block)
-        hostnames = target.flat_map { |e| Xlogin.list(e) }.map { |e| e[:name] }
-
+      def generate(*patterns, **opts, &block)
         description = Rake.application.last_description
-        task 'all' => hostnames unless opts[:bundle] == false
+        hostnames   = Xlogin.list(*patterns).map { |e| e[:name] }
 
-        description = opts[:desc]
+        task 'all' => hostnames if !!opts[:all]
         hostnames.each do |hostname|
-          desc description
+          desc "#{description} - #{hostname}" if !!opts[:desc]
           RakeTask.new(hostname, &block)
         end
 
@@ -27,7 +24,6 @@ module Xlogin
     end
 
     attr_reader   :name
-    attr_reader   :taskname
     attr_accessor :lock
     attr_accessor :log
     attr_accessor :silent
@@ -37,9 +33,7 @@ module Xlogin
 
     def initialize(name)
       @name     = name
-      @taskname = [*Rake.application.current_scope.to_a.reverse, name].join(':')
       @runner   = nil
-      @config   = OpenStruct.new
       @silent ||= Rake.application.options.silent
       @fail_on_error = true
 
@@ -47,21 +41,17 @@ module Xlogin
       define
     end
 
-    def run(&block)
-      @runner = block
+    def name_with_scope
+      [*Rake.application.current_scope.to_a.reverse, name].join(':')
     end
 
-    def method_missing(name, *args, &block)
-      super(name, *args, &block) unless name.to_s =~ /^\w+=$/
-      @config.send(name, *args)
+    def run(&block)
+      @runner = block
     end
+    alias_method :start, :run
 
     private
     def define
-      description = Rake.application.last_description
-      description = "#{description} - #{name}" if description
-      desc description
-
       mkdir_p(File.dirname(log),  verbose: Rake.application.options.trace) if log
       mkdir_p(File.dirname(lock), verbose: Rake.application.options.trace) if lock
 
@@ -70,7 +60,6 @@ module Xlogin
         file(lock) do
           next if @@graceful_shutdown
           run_task
-          mkdir_p(File.dirname(lock), verbose: Rake.application.options.trace)
           touch(lock, verbose: Rake.application.options.trace)
         end
       else
@@ -88,18 +77,16 @@ module Xlogin
       loggers << buffer  if !silent &&  Rake.application.options.always_multitask
       loggers << $stdout if !silent && !Rake.application.options.always_multitask
 
-      begin
-        session = Xlogin.get(name, log: loggers, **@config.to_h)
-        @runner.call(session)
-        session.close if session
+      session = Xlogin.get(name, log: loggers)
+      @runner.call(session)
+      session.close rescue nil
 
-        printf($stdout, buffer.string) if !silent && Rake.application.options.always_multitask
-      rescue => e
-        output($stderr, buffer.string) if !silent && Rake.application.options.always_multitask
-        output($stderr, "[ERROR] Xlogin - #{e}\n")
+      printf($stdout, buffer.string) if !silent && Rake.application.options.always_multitask
+    rescue => e
+      output($stderr, buffer.string) if !silent && Rake.application.options.always_multitask
+      output($stderr, "[ERROR] #{e}\n")
 
-        @@graceful_shutdown = true if fail_on_error
-      end
+      @@graceful_shutdown = true if fail_on_error
     end
 
     def printf(fp, text)
@@ -112,5 +99,4 @@ module Xlogin
     end
 
   end
-
 end

data/lib/xlogin/session.rb

@@ -21,8 +21,6 @@ module Xlogin
                 when 'telnet' then 23
                 end
 
-      raise SessionError.new("Invalid URI - '#{uri}'") unless @host && @port
-
       @name     = opts[:name] || @host
       @config   = OpenStruct.new(opts)
       @template = template
@@ -54,6 +52,11 @@ module Xlogin
       @template.name
     end
 
+    def enable(*args)
+      return super(*args) unless args.empty?
+      super(@config.enable)
+    end
+
     def prompt
       cmd('').to_s.lines.last&.chomp
     end
@@ -63,17 +66,18 @@ module Xlogin
     end
 
     def puts(*args, &block)
-      args = [instance_exec(*args, &@template.interrupt)].flatten if @template.interrupt
-      super(*args, &block)
+      args = [instance_exec(*args, &@template.interrupt!)].flatten.compact if @template.interrupt!
+      super(*args, &block) unless args.empty?
     end
 
     def waitfor(*args, &block)
+      args = [Regexp.union(*@template.prompt.map(&:first))] if args.empty?
       @mutex.synchronize { _waitfor(*args, &block) }
     end
 
     def close
       @mutex.synchronize do
-        @loggers.values.each do |logger|
+        @loggers.each do |_, logger|
           next if logger.nil? || [$stdout, $stderr].include?(logger)
           logger.close
         end
@@ -101,10 +105,10 @@ module Xlogin
 
     private
     def _waitfor(*args, &block)
-      args << Regexp.union(*@template.prompt.map(&:first)) if args.empty?
-      line = method(:waitfor).super_method.call(*args) do |recv|
-        block.call(recv) if block
+      __waitfor = method(:waitfor).super_method
+      line = __waitfor.call(*args) do |recv|
         output_log(recv)
+        block.call(recv) if block
       end
 
       _, process = @template.prompt.find { |r, p| r =~ line && p }
@@ -116,6 +120,10 @@ module Xlogin
       return line
     end
 
+    def output_log(text)
+      @loggers.each { |_, logger| logger.syswrite(text) if logger }
+    end
+
     def ssh_tunnel(gateway)
       gateway_uri = Addressable::URI.parse(gateway)
       case gateway_uri.scheme
@@ -133,10 +141,6 @@ module Xlogin
       end
     end
 
-    def output_log(text)
-      @loggers.values.each { |logger| logger.syswrite(text) if logger }
-    end
-
     def build_logger(log)
       case log
       when String
@@ -149,5 +153,6 @@ module Xlogin
         log
       end
     end
+
   end
 end

data/lib/xlogin/session_pool.rb

@@ -2,7 +2,6 @@ require 'time'
 require 'thread'
 
 module Xlogin
-
   class SessionPool
 
     DEFAULT_POOL_SIZE = 1
@@ -14,14 +13,8 @@ module Xlogin
       @args = args
       @opts = opts
 
-      case @args
-      when String
-        @size = @opts.delete(:pool_size) || DEFAULT_POOL_SIZE
-        @idle = @opts.delete(:pool_idle) || DEFAULT_POOL_IDLE
-      when Hash
-        @size = @args.delete(:pool_size) || DEFAULT_POOL_SIZE
-        @idle = @args.delete(:pool_idle) || DEFAULT_POOL_IDLE
-      end
+      @size = DEFAULT_POOL_SIZE
+      @idle = DEFAULT_POOL_IDLE
 
       @mutex = Mutex.new
       @queue = Queue.new
@@ -39,7 +32,7 @@ module Xlogin
     def with
       session = deq
       begin
-        session.prompt
+        session.prompt # confirm that the session is still alive
       rescue IOError, EOFError, Errno::ECONNABORTED, Errno::ECONNREFUSED, Errno::ECONNRESET
         destroy session
         session = deq
@@ -94,5 +87,4 @@ module Xlogin
     end
 
   end
-
 end

data/lib/xlogin/spec.rb

@@ -1,5 +1,4 @@
 module Xlogin
-
   class ExpectationError < StandardError
 
     def initialize(expect, actual)
@@ -48,5 +47,4 @@ module Xlogin
     end
 
   end
-
 end

data/lib/xlogin/template.rb

@@ -1,4 +1,3 @@
-require 'addressable/uri'
 require 'xlogin/ssh'
 require 'xlogin/telnet'
 
@@ -10,7 +9,6 @@ module Xlogin
     RESERVED_METHODS = %i( login logout enable disable delegate )
 
     attr_reader :name
-    attr_reader :methods
 
     def initialize(name)
       @name    = name
@@ -35,20 +33,15 @@ module Xlogin
       @methods[name] = block
     end
 
-    def interrupt(&block)
+    def interrupt!(&block)
       return @interrupt unless block
       @interrupt = block
     end
 
     def build(uri, **opts)
-      uri   = Addressable::URI.parse(uri.to_s)
       klass = Class.new(Xlogin.const_get(uri.scheme.capitalize))
       klass.class_exec(@methods) do |methods|
         methods.each do |name, block|
-          if name == :enable
-            define_method(name) { |*args| instance_exec([*args, opts[name]].first, &block) }
-            next
-          end
           define_method(name, &block)
         end
       end
@@ -57,8 +50,9 @@ module Xlogin
     end
 
     def method_missing(name, *, &block)
-      super unless RESERVED_METHODS.include?(name) and block_given?
+      super unless RESERVED_METHODS.include?(name)
       bind(name) { |*args| instance_exec(*args, &block) }
     end
+
   end
 end

data/lib/xlogin/version.rb

@@ -1,3 +1,3 @@
 module Xlogin
-  VERSION = "0.10.6"
+  VERSION = "0.10.9"
 end

data/lib/xlogin.rb

@@ -1,7 +1,6 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'xlogin/factory'
-require 'xlogin/session_pool'
 require 'xlogin/version'
 
 module Xlogin
@@ -16,20 +15,21 @@ module Xlogin
       @factory ||= Xlogin::Factory.instance
     end
 
+    def list(*patterns)
+      factory.list_inventory(*patterns)
+    end
+
     def get(args, **opts, &block)
       session = case args
                 when Hash   then factory.build(**args.merge(**opts))
                 when String then factory.build_from_hostname(args, **opts)
+                else return
                 end
 
       return session unless block
       begin block.call(session) ensure session.close end
     end
 
-    def list(*patterns)
-      factory.list_inventory(*patterns)
-    end
-
     def get_pool(args, **opts, &block)
       pool = factory.build_pool(args, **opts)
 
@@ -56,10 +56,6 @@ module Xlogin
       @authorized = boolean == true || (block && block.call == true)
     end
 
-    def register(**args)
-      factory.set_inventory(**args)
-    end
-
     def source(*source_files, &block)
       return source_file(*source_files) unless block
       instance_eval(&block) unless source_files.empty?
@@ -99,7 +95,7 @@ module Xlogin
       opts = args[2] || {}
 
       super unless args.size == 2 || args.size == 3
-      register(type: type, name: name, uri: uri, **opts)
+      factory.set_inventory(name, type: type, uri: uri, **opts)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlogin
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 0.10.9
 platform: ruby
 authors:
 - haccht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-telnet