dumbcli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6791be747b4c86c5138b4cbbd24e9b05e6fe3ee6
+  data.tar.gz: 015556c2860acfe1483d8a43b410bede61aa9e38
+SHA512:
+  metadata.gz: a267c62ac02053fc5111a6d6a6faec25fe489d52d6a3c59c304a4fcc08ca7662ecfcf1ed3d7a331056fc4abff21b88bcf0fd5ccc2c5d9f3a47e66e62d8b4dc48
+  data.tar.gz: ff52eb14a2ec11c4cf0559bfe2773bf615874b60e9f3d4687e410b6f0423ac920017111ae22ee2dcc2cae438704fcbbb9f74719c5a7f9db8606bea04c7d2f4a0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dumbcli.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Shintaro Kojima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# DumbCLI
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dumbcli`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dumbcli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dumbcli
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dumbcli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dumbcli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dumbcli.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dumbcli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dumbcli"
+  spec.version       = Dumbcli::VERSION
+  spec.authors       = ["Shintaro Kojima"]
+  spec.email         = ["goodies@codeout.net"]
+
+  spec.summary       = 'A scaffold of ruby wrapper of rancid xlogin'
+  spec.description   = "DumbCLI is a ruby wrapper of rancid xlogin that is a CLI handler of network devices. You can easily extends DumbCLI's scaffold classes to manage your devices."
+  spec.homepage      = 'https://github.com/codeout/dumbcli'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dumbcli/device/a10.rb

@@ -0,0 +1,33 @@
+module Dumbcli
+  module Device
+    class A10 < Base
+      def connect
+        super
+        flush
+        execute 'terminal length 0'
+      end
+
+      def execute(cmd)
+        super
+      end
+
+
+      private
+
+      def login_cmd
+        "#{Dumbcli::Device.login_cmd('cisco')} #{@host}"
+      end
+
+      def execute_exit
+        result = execute("exit\nexit\nY")
+        sleep 1
+        result << flush
+
+        unless result =~ /connection closed|Connection to \S+ closed\./i
+          sleep 1
+          execute "exit\nexit\nY"
+        end
+      end
+    end
+  end
+end

data/lib/dumbcli/device/arista.rb

@@ -0,0 +1,23 @@
+module Dumbcli
+  module Device
+    class Arista < Base
+      def connect
+        term = ENV['TERM']
+        ENV['TERM'] = 'vt100'
+
+        super
+        flush
+        execute 'terminal length 0'
+
+        ENV['TERM'] = term
+      end
+
+
+      private
+
+      def login_cmd
+        "#{Dumbcli::Device.login_cmd('arista')} #{@host}"
+      end
+    end
+  end
+end

data/lib/dumbcli/device/base.rb

@@ -0,0 +1,103 @@
+require 'net/telnet'
+
+module Dumbcli
+  module Device
+    class Base
+      def initialize(host, options={})
+        raise ArgumentError, 'host is required' unless host
+        @host = host
+        @options = options
+      end
+
+      def execute(cmd)
+        raise ArgumentError, 'cmd is required' unless cmd
+
+        connect unless established?
+
+        Dumbcli.logger.info "Executing: #{cmd}"
+        @connection.cmd(cmd).tap {|result|
+          Dumbcli.logger.debug result
+        }
+      end
+      alias exec execute
+
+      def established?
+        @connection && !@connection.sock.closed?
+      end
+
+      def connect
+        return if established?
+
+        Dumbcli.logger.info "Trying to connect #{@host}"
+        @connection = Net::Telnet.new('Prompt' => prompt,
+                                      'Proxy' => IO.popen(login_cmd, 'r+'),
+                                      'Timeout' => @options[:timeout] || 30)
+
+        begin
+          result = @connection.waitfor(prompt)
+          if result =~ error_code
+            @connection.close
+            raise $1
+          end
+        rescue
+          @connection.close
+          raise
+        end
+      end
+
+      def close
+        return unless established?
+
+        execute_exit
+      end
+
+
+      private
+
+      def login_cmd
+        raise 'Not implemented yet'
+      end
+
+      def prompt
+        p = /\S+(?:>|#)\s*/
+        /#{p}(?:[\n\r]+#{p})*/
+      end
+
+      def error_code
+        /^Error:\s*(.*)$/
+      end
+
+      def execute_exit
+        unless execute('exit') =~ /connection closed|Connection to \S+ closed\./i  # see clogin
+          sleep 1         # wait a bit until completely close
+          execute 'exit'  # even from 'configure terminal' mode. see clogin
+        end
+      end
+
+      def read
+        return unless established?
+        result = ''
+
+        begin
+          loop do
+            result << @connection.sock.read_nonblock(1024)
+          end
+        rescue Errno::EAGAIN, Errno::EINTR, EOFError
+        end
+
+        result
+      end
+
+      def flush
+        result = ''
+        sleep 0.5
+
+        until (remainder = read).empty?
+          result << remainder
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/dumbcli/device/cisco.rb

@@ -0,0 +1,22 @@
+module Dumbcli
+  module Device
+    class Cisco < Base
+      def connect
+        super
+        flush
+        execute 'terminal length 0'
+      end
+
+      def execute(cmd)
+        super + flush
+      end
+
+
+      private
+
+      def login_cmd
+        "#{Dumbcli::Device.login_cmd('cisco')} #{@host}"
+      end
+    end
+  end
+end

data/lib/dumbcli/device/cisco_asa.rb

@@ -0,0 +1,18 @@
+module Dumbcli
+  module Device
+    class CiscoAsa < Base
+      def connect
+        super
+        flush
+        execute 'terminal pager 0'
+      end
+
+
+      private
+
+      def login_cmd
+        "#{Dumbcli::Device.login_cmd('cisco')} #{@host}"
+      end
+    end
+  end
+end

data/lib/dumbcli/device/cisco_xr.rb

@@ -0,0 +1,18 @@
+module Dumbcli
+  module Device
+    class CiscoXr < Base
+      def connect
+        super
+        flush
+        execute 'terminal length 0'
+      end
+
+
+      private
+
+      def login_cmd
+        "#{Dumbcli::Device.login_cmd('cisco-xr')} #{@host}"
+      end
+    end
+  end
+end

data/lib/dumbcli/device/juniper.rb

@@ -0,0 +1,22 @@
+module Dumbcli
+  module Device
+    class Juniper < Base
+      def connect
+        super
+        flush
+        execute 'set cli screen-length 0'
+      end
+
+      def execute(cmd)
+        super + flush
+      end
+
+
+      private
+
+      def login_cmd
+        "#{Dumbcli::Device.login_cmd('juniper')} #{@host}"
+      end
+    end
+  end
+end

data/lib/dumbcli/device.rb

@@ -0,0 +1,58 @@
+require 'dumbcli/device/base.rb'
+require 'dumbcli/device/a10.rb'
+require 'dumbcli/device/arista.rb'
+require 'dumbcli/device/cisco.rb'
+require 'dumbcli/device/cisco_asa.rb'
+require 'dumbcli/device/cisco_xr.rb'
+require 'dumbcli/device/juniper.rb'
+
+module Dumbcli
+  module Device
+    def self.login_cmd(platform)
+      rancid_types = {
+        'adtran'      => 'clogin',
+        'alteon'      => 'alogin',
+        'arbor'       => 'anlogin',
+        'arista'      => 'clogin',
+        'avocent'     => 'avologin',
+        'baynet'      => 'blogin',
+        'cat5'        => 'clogin',
+        'cisco-nx'    => 'clogin',
+        'cisco-wlc4'  => 'wlogin',
+        'cisco-wlc5'  => 'wlogin',
+        'cisco-xr'    => 'clogin',
+        'cisco'       => 'clogin',
+        'compass'     => 'complogin',
+        'css'         => 'clogin',
+        'dell'        => 'dllogin',
+        'enterasys'   => 'rivlogin',
+        'erx'         => 'clogin',
+        'extreme'     => 'clogin',
+        'ezt3'        => 'elogin',
+        'f5'          => 'clogin',
+        'force10'     => 'clogin',
+        'fortigate'   => 'fnlogin',
+        'foundry'     => 'flogin',
+        'hitachi'     => 'htlogin',
+        'hp'          => 'hlogin',
+        'juniper-srx' => 'jlogin',
+        'juniper'     => 'jlogin',
+        'mikrotik'    => 'mtlogin',
+        'mrtd'        => 'clogin',
+        'mrv'         => 'mrvlogin',
+        'netopia'     => 'tlogin',
+        'netscaler'   => 'nslogin',
+        'netscreen'   => 'nlogin',
+        'paloalto'    => 'panlogin',
+        'procket'     => 'clogin',
+        'redback'     => 'clogin',
+        'riverstone'  => 'rivlogin',
+        'smc'         => 'hlogin',
+        'xirrus'      => 'xilogin',
+        'zebra'       => 'clogin',
+      }
+
+      rancid_types[platform]
+    end
+  end
+end

data/lib/dumbcli/logger.rb

@@ -0,0 +1,26 @@
+require 'logger'
+
+module Dumbcli
+  class Logger < ::Logger
+    CLEAR   = "\e[0m"
+    COLORS = {
+      'INFO'  => "\e[32m",  # green
+      'WARN'  => "\e[33m",  # yellow
+      'ERROR' => "\e[35m",  # magenta
+      'FATAL' => "\e[31m",  # red
+    }
+
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      super
+      @level = INFO
+    end
+
+    def format_message(severity, datetime, progname, msg)
+      if COLORS[severity]
+        "#{COLORS[severity]}#{super}#{CLEAR}"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/dumbcli/version.rb

@@ -0,0 +1,3 @@
+module Dumbcli
+  VERSION = '0.0.1'
+end

data/lib/dumbcli.rb

@@ -0,0 +1,30 @@
+require 'dumbcli/device'
+require 'dumbcli/logger'
+require 'dumbcli/version'
+
+module Dumbcli
+  @logger = Dumbcli::Logger.new(STDOUT).tap {|l| l.level = Dumbcli::Logger::Severity::INFO }
+
+  class << self
+    attr_accessor :logger
+
+    def Device(host, platform, options={})
+      case platform
+      when 'a10'
+        Dumbcli::Device::A10.new(host, options)
+      when 'arista'
+        Dumbcli::Device::Arista.new(host, options)
+      when 'cisco'
+        Dumbcli::Device::Cisco.new(host, options)
+      when 'cisco-asa'
+        Dumbcli::Device::CiscoAsa.new(host, options)
+      when 'cisco-xr'
+        Dumbcli::Device::CiscoXr.new(host, options)
+      when 'juniper'
+        Dumbcli::Device::Juniper.new(host, options)
+      else
+        raise ArgumentError, %(Unknown device type: "#{platform}" for host "#{host}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: dumbcli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shintaro Kojima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: DumbCLI is a ruby wrapper of rancid xlogin that is a CLI handler of network
+  devices. You can easily extends DumbCLI's scaffold classes to manage your devices.
+email:
+- goodies@codeout.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dumbcli.gemspec
+- lib/dumbcli.rb
+- lib/dumbcli/device.rb
+- lib/dumbcli/device/a10.rb
+- lib/dumbcli/device/arista.rb
+- lib/dumbcli/device/base.rb
+- lib/dumbcli/device/cisco.rb
+- lib/dumbcli/device/cisco_asa.rb
+- lib/dumbcli/device/cisco_xr.rb
+- lib/dumbcli/device/juniper.rb
+- lib/dumbcli/logger.rb
+- lib/dumbcli/version.rb
+homepage: https://github.com/codeout/dumbcli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A scaffold of ruby wrapper of rancid xlogin
+test_files: []
+has_rdoc: