xlogin 0.12.4 → 0.12.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40a19a8c4be89c5b57af233605e059b2cb835c293e8ad6db1a52ed568b1968c7
-  data.tar.gz: 96d9bda304dd69d4a1c2962336af11c68862924987b7661af417ebc566be39ab
+  metadata.gz: 81f206f9e13d4c7554c774e78b2f1922c38b2dbca8e159f4874f027a82c82c99
+  data.tar.gz: 03e07c95b87a97dd6865013b829c3da4468ee599d3262430f81a6e230551198f
 SHA512:
-  metadata.gz: 0f0720e0bb78e942f01d360e9a9e0cfb9fcaddcf4b324bac18052ef44d59a95e41e5925814b257be4604154cebed065b57589546d34a66c74f7aa1ab5e0a4b91
-  data.tar.gz: 89c7788c08960f365eacfdfc1c74b0e52a136faa84f60045da97939af8206b0d9739e7b19d51dfffb7de7bf771843c59156831f0c408f2d750047195ae451343
+  metadata.gz: 73af1ca92ea918891c286f1f1a5b9d0e5fbc6acf878cc4d823739350d6af9edfb85ad1da9b9e2bcbe1e3e75f51c907850c81c885c3243087e588cc7f1e38ed1b
+  data.tar.gz: 56835cfe13e9f94a41b3a20681cc6ba883b429276f7d1ec5665a5da040f6be8c1c4c9a342cb46809436d5d4771d1435d924e0726f1177874eda1bfc5b322e5df

data/README.md

@@ -1,7 +1,7 @@
 # xlogin
 
 rancid clogin alternative.  
-xlogin is a tool to login devices and execute series of tasks.
+xlogin is a tool to login devices and execute series of commands with ease.
 
 ## Installation
 
@@ -21,8 +21,9 @@ Or install it yourself as:
 
 ## Usage
 
-Write a template file that describe how to login to the specific type of device, and store it to `~/.xlogin.d/`.  
-Take vyos as an example, template file would be:
+Write a firmware template that describe how to manage the device, and store it to `~/.xlogin.d/`.  
+Be aware that the name of the template file should match the hosttype of the device in the inventory file.  
+Take vyos as an example, template file `vyos.rb` would be:
 
 ```ruby
 prompt(/[$#] (?:\e\[K)?\z/n)
@@ -34,11 +35,10 @@ login do |username, password|
 end
 ```
 
-Some other examples are in [lib/xlogin/templates](https://github.com/haccht/xlogin/tree/master/lib/xlogin/templates).  
+Some other example templates are in [lib/xlogin/templates](https://github.com/haccht/xlogin/tree/master/lib/xlogin/templates).  
 You can just load these built-in templates by adding `require "xlogin/template"` in your script.
 
-Beside template files, you need to prepare an inventory file `~/.xloginrc`.
-In this file, you need to write all information required to login each device.
+Besides template files, you need to prepare an inventory file `~/.xloginrc` that list all information required to login each devices.
 
 ```
 #hosttype	hostname	uri scheme
@@ -46,13 +46,13 @@ vyos	'vyos01',	'telnet://vagrant:vagrant@127.0.0.1:2200'
 vyos	'vyos02',	'telnet://vagrant:vagrant@127.0.0.1:2201'
 ```
 
-Now you can login any device in your `.xloginrc` file with a command:
+Now you can login the device in your `.xloginrc` file.
 
 ```sh
 $ xlogin vyos01
 ```
 
-And execute multiple operations with just a single command:
+And execute multiple operations with just a single command.
 
 ~~~sh
 $ xlogin 'vyos*' -e 'show configuration command | no-more; exit' -j 2

data/lib/xlogin/cli.rb

@@ -21,8 +21,8 @@ module Xlogin
     def self.getopts(args)
       config = OpenStruct.new(
         jobs: 1,
-        auth: false,
         task: [:tty, nil],
+        assume_yes:   false,
         inventory:    DEFAULT_INVENTORY_FILE,
         template_dir: DEFAULT_TEMPLATE_DIR,
       )
@@ -40,12 +40,12 @@ module Xlogin
       parser.on('-e COMMAND', '--exec', 'Execute commands and quit.') { |v| config.task = [:exec, v] }
 
       parser.on('-j NUM', '--jobs', Integer, 'The NUM of jobs to execute in parallel(default: 1).') { |v| config.jobs = v }
-      parser.on('-y',     '--assume-yes', TrueClass, 'Automatically answer yes to prompts.')        { |v| config.auth = v }
       parser.on('-E',     '--enable',     TrueClass, 'Try to gain enable priviledge.')              { |v| config.enable = v }
+      parser.on('-y',     '--assume-yes', TrueClass, 'Automatically answer yes to prompts.')        { |v| config.assume_yes = v }
 
       parser.parse!(args)
       Xlogin.configure do
-        authorize(config.auth)
+        assume_yes(true)
         source(File.expand_path(config.inventory, ENV['PWD']))
         template(File.expand_path(config.template_dir, ENV['PWD']))
       end

data/lib/xlogin/rake_task.rb

@@ -85,14 +85,6 @@ module Xlogin
       logger.push buffer  if !silent &&  Rake.application.options.always_multitask
 
       session = Xlogin.get(name, log: logger, timeout: timeout)
-      def session.msg(text, prefix: "[INFO]", chomp: false, **color)
-        default_color = { color: :green }
-
-        log("\n")
-        log(Time.now.iso8601.colorize(**color) + ' ') if !Rake.application.options.always_multitask
-        log("#{prefix} #{text}".colorize(**default_color.merge(color)))
-        cmd('') unless chomp
-      end
 
       @runner.call(session)
       $stdout.print format_log(buffer.string)
@@ -117,4 +109,15 @@ module Xlogin
     end
 
   end
+
+  module SessionModule
+    def msg(text, prefix: "[INFO]", chomp: false, **color)
+      default_color = { color: :green }
+
+      log("\n")
+      log(Time.now.iso8601.colorize(**color) + ' ') if !Rake.application.options.always_multitask
+      log("#{prefix} #{text}".colorize(**default_color.merge(color)))
+      cmd('') unless chomp
+    end
+  end
 end

data/lib/xlogin/session.rb

@@ -62,7 +62,7 @@ module Xlogin
 
     def puts(*args, &block)
       args = [instance_exec(*args, &@template.interrupt!)].flatten.compact if @template.interrupt!
-      super(*args, &block) unless args.empty?
+      args.empty? ? super('', &block) : super(*args, &block)
     end
 
     def waitfor(*args, &block)

data/lib/xlogin/version.rb

@@ -1,3 +1,3 @@
 module Xlogin
-	VERSION = "0.12.4"
+	VERSION = "0.12.5"
 end

data/lib/xlogin.rb

@@ -8,7 +8,6 @@ module Xlogin
 
   class SessionError       < StandardError; end
   class TemplateError      < StandardError; end
-  class AuthorizationError < StandardError; end
 
   class << self
 
@@ -46,8 +45,8 @@ module Xlogin
       instance_eval(&block)
     end
 
-    def authorized?
-      @authorized == true
+    def assume_yes?
+      @assume_yes == true
     end
 
     def generate_templates(dir)
@@ -57,8 +56,8 @@ module Xlogin
     end
 
     private
-    def authorize(boolean = true, &block)
-      @authorized = boolean == true || (block && block.call == true)
+    def assume_yes(boolean = true, &block)
+      @assume_yes = boolean == true || (block && block.call == true)
     end
 
     def source(*sources, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlogin
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.12.5
 platform: ruby
 authors:
 - haccht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-telnet