xlogin 0.11.6 → 0.11.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65379601a175fd8c600a374e312c4a03bb5ffeba056bab55f4b68414319c3507
-  data.tar.gz: 70ee6c3eabc2bd6d982d0e583b3402156dad0651ae8c4932c7608b9b93af188f
+  metadata.gz: 6fb6b0b2b1b8ca4e21cabb2b4888092cf2d0858da9a69aa050c77a97b7a018f7
+  data.tar.gz: e30fe43223d680c1c7ca1c404a60cffceb5748832ada7db4b30d5e49a5a47267
 SHA512:
-  metadata.gz: 40e15b65f6890bd6721260fafaacc0194b7f737c5a0377ad7d08a59fcb068be90896db242d333f67eea9cb05d7f1e1319a741ee9f6243ac351b221b1123c6c3e
-  data.tar.gz: a3ada3ee5ff44393fec79e87da1746d09b608ac6428700a6bf4530f27e76107cc612e098a7b8c890c648e64a42b4f7445ca334acf907937fd1de4ef3a0955ae3
+  metadata.gz: 68cf84fc489f32734d16dec2e99e7760a976cbed54846dacd1ba9131aa717c8f864b63f3f5174a4a7495caa26f881625f9da4ffb5e2ec3fc5b461eb1f960c8bc
+  data.tar.gz: 79654b10f48a5e02254adc9b394f8a456ea32af5aef6575972e2749ced574011c3f5dbfd4aa4f213646f77b2548274c79e5ee9f98301c04530f383f83bc448b4

data/README.md

@@ -1,34 +1,63 @@
 # xlogin
-rancid clogin alternative.
+
+rancid clogin alternative.  
+xlogin is a tool to login devices and execute series of tasks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xlogin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xlogin
 
 ## Usage
 
-ネットワークデバイスへのログイン処理を自動化するツール群。  
-`~/.xlogin.d/`にファームウェア毎のログイン仕様(template)を記述することで自働化対象機器を任意に設定可能。
-templateの記述例は[lib/xlogin/templates](https://github.com/haccht/xlogin/tree/master/lib/xlogin/templates)を参照のこと。
+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:
 
-各個別装置毎のログインのための認証情報は`~/.xloginrc`へ記述する。  
-`.xloginrc`のフォーマットはDSL形式で下記の通り。
+```ruby
+prompt(/[$#] (?:\e\[K)?\z/n)
 
-~~~
-#hosttype	hostname	telnet_uri_scheme	options
+login do |username, password|
+  waitfor(/login:\s/)    && puts(username)
+  waitfor(/Password:\s/) && puts(password)
+  waitfor
+end
+```
+
+Some other example are in [lib/xlogin/templates](https://github.com/haccht/xlogin/tree/master/lib/xlogin/templates).
+
+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.
+
+```
+#hosttype	hostname	uri scheme
 vyos	'vyos01',	'telnet://vagrant:vagrant@127.0.0.1:2200'
 vyos	'vyos02',	'telnet://vagrant:vagrant@127.0.0.1:2201'
-~~~
+```
 
-下記コマンドでvyos01へ自動ログインし、プロンプトをユーザに渡す。
+Now you can login any device in your `.xloginrc` file with a command:
 
-~~~sh
-xlogin vyos01
-~~~
+```sh
+$ xlogin vyos01
+```
 
-また下記コマンドでvyos01,vyos02へ同時に自動ログインし、コマンドを一括投入する。
+And execute multiple operations with just a single command:
 
 ~~~sh
-xlogin 'vyos*' -e 'show configuration command | no-more; exit' -j 2
+$ xlogin 'vyos*' -e 'show configuration command | no-more; exit' -j 2
 ~~~
 
-その他のオプションは下記の通り。
+Some other commandline options are:
 
 ~~~sh
 $ xlogin -h
@@ -40,28 +69,11 @@ xlogin HOST_PATTERN [Options]
     -l, --list                       List all available devices.
     -e, --exec                       Execute commands and quit.
     -t, --tty                        Allocate a pseudo-tty.
-    -p, --port NUM                   Run as server on specified port(default: 8080).
     -j, --jobs NUM                   The NUM of jobs to execute in parallel(default: 1).
     -E, --enable                     Try to gain enable priviledge.
-    -y, --assume-yes                 Automatically answer yes to prompts.
+    -y, --assume-yes                 Automatically answer yes to any confirmation prompts.
 ~~~
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'xlogin'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install xlogin
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/xlogin.rb

@@ -1,5 +1,6 @@
 $:.unshift File.dirname(__FILE__)
 
+require 'net/http'
 require 'xlogin/factory'
 require 'xlogin/version'
 
@@ -58,7 +59,7 @@ module Xlogin
 
     def source(*source_files, &block)
       return source_file(*source_files) unless block
-      factory.instance_eval(&block) unless source_files.empty?
+      factory.instance_eval(&block) if source_files.empty?
     end
 
     def source_file(*source_files)
@@ -69,17 +70,33 @@ module Xlogin
     end
 
     def template(name, *args, &block)
-      return template_dir(name, *args) unless block
+      unless block
+        return template_url(name, *args) if name =~ URI.regexp(['http', 'https'])
+        return template_dir(name, *args)
+      end
 
       raise ArgumentError.new('missing template name') unless name
       factory.set_template(name, &block)
     end
 
+    def template_url(*template_urls)
+      template_urls.compact.each do |url|
+        uri = URI(url.to_s)
+        name = File.basename(uri.path, '.rb').scan(/\w+/).join('_')
+        text = Net::HTTP.get(uri)
+        if text =~ /\w+.rb$/
+          uri.path = File.join(File.dirname(uri.path), text.lines.first.chomp)
+          text = Net::HTTP.get(uri)
+        end
+        factory.set_template(name, text)
+      end
+    end
+
     def template_file(*template_files)
       template_files.compact.each do |file|
         raise TemplateError.new("Template file not found: #{file}") unless File.exist?(file)
         name = File.basename(file, '.rb').scan(/\w+/).join('_')
-        factory.set_template(name, IO.read(file)) if File.exist?(file)
+        factory.set_template(name, IO.read(file))
       end
     end
 

data/lib/xlogin/version.rb

@@ -1,3 +1,3 @@
 module Xlogin
-	VERSION = "0.11.6"
+	VERSION = "0.11.7"
 end

data/xlogin.gemspec

@@ -37,6 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "parallel"
   spec.add_dependency "addressable"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlogin
 version: !ruby/object:Gem::Version
-  version: 0.11.6
+  version: 0.11.7
 platform: ruby
 authors:
 - haccht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-telnet
@@ -98,30 +98,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: login to any devices with ease.
 email:
 - haccht@users.noreply.github.com