netscaler-cli 0.2.3 → 0.3.0

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gem 'log4r', '~> 1.1'
+gem 'savon', '~> 0.7'
+gem 'highline', '>= 1.6'
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    highline (1.6.1)
+    log4r (1.1.9)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    savon (0.7.9)
+      builder (>= 2.1.2)
+      crack (>= 0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  highline (>= 1.6)
+  log4r (~> 1.1)
+  rspec
+  savon (~> 0.7)

data/README.markdown

@@ -12,9 +12,12 @@ The command line tools can be installed with:
 
 The following commands are currently a part of the system:
 
-  * *netscaler-vserver* -- An interface for enabling, disabling, and binding responder policies to a specific virtual server.
-  * *netscaler-service* -- An interface for enabling, disabling, and binding virtual servers to specific service.
+  * *netscaler-vserver* -- An interface for enabling, disabling, querying, and binding responder policies to a specific virtual server.
+  * *netscaler-service* -- An interface for enabling, disabling, querying, and binding servers to specific services.
+  * *netscaler-server*  -- An interface for enabling, disabling, querying, and binding servers to virtual servers.
   
+Each command requires at least the --netscaler flag (which can be the full netscaler host name in the configuration file, or its alias, see below).
+
 # Configuration
 
 All of the commands rely upon a configuration file in the YAML format.  By default, it looks for a file in your home directory
@@ -23,8 +26,9 @@ All of the commands rely upon a configuration file in the YAML format.  By defau
 
 Each load balancer requires an entry in the file in the form:
 
-    netscaler.loadbalancer.somecompany.com
+    netscaler.loadbalancer.somecompany.com:
        username: 'some.username'
        password: 'super!duper!secret!'
+       alias:  prod
 
-Multiple entries can be in the file; the password setting is not required.  If it is not given in the file, the tool will ask you for it.
+Multiple entries can be in the file; the password and the alias settings are not required.  An alias can be used as a shortcut name on the command line for a particular netscaler server.  However, if no password is given in the file for a given configuration, the tool will ask you for it.

data/Rakefile

@@ -28,11 +28,11 @@ begin
     gem.homepage       = 'http://github.com/gabemc/netscaler-cli'
     gem.files          = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
     
-    gem.add_dependency    'highline',   '>=1.5.2'
-    gem.add_dependency    'log4r',      '>=1.1.7'
+    gem.add_dependency    'log4r',      '>=1.1.9'
     gem.add_dependency    'savon',      '>=0.7.9'
+    gem.add_dependency    'highline',   '>=1.6'
     
-    gem.add_development_dependency 'rspec', '>=2.0.1'
+    gem.add_development_dependency 'rspec', '>=2.2.0'
   end
 rescue LoadError
   puts "Jeweler or dependencies are not available.  Install it with: sudo gem install jeweler"

data/lib/netscaler/baseexecutor.rb

@@ -4,7 +4,7 @@ module Netscaler
   class BaseExecutor
     include Netscaler::Logging
 
-    attr_reader :host, :client
+    attr_reader :host, :client, :json
 
     def initialize(host, client)
       @host = host
@@ -32,16 +32,14 @@ module Netscaler
       log.debug(result)
       
       response = result.to_hash["#{name.to_s}_response".to_sym]
-      if block_given?
+      msg = response[:return][:message]
+      if msg !~ /^Done$/
+        log.error(response[:return][:message])
+        exit(1)
+      elsif block_given?
         yield response
-      else 
-        msg = response[:return][:message]
-        if msg !~ /^Done$/
-          log.error(response[:return][:message])
-          exit(1)
-        else
-          log.debug(msg)
-        end
+      else
+        log.debug(msg)
       end
 
       result

data/lib/netscaler/clitemplate.rb

@@ -78,6 +78,10 @@ module Netscaler
               "Prints extra debug information") do |d|
         options[:debug] = d
       end
+      opts.on('--json',
+              "Prints out JSON data instead of textual output.") do |j|
+        options[:json] = j
+      end
       opts.on('-v', '--version',
               "Show the version information") do |v|
         puts "#{File.basename($0)} version: #{Netscaler::Version.to_s}"

data/lib/netscaler/config.rb

@@ -10,17 +10,22 @@ module Netscaler
       @servers = read_config_file(file)
     end
 
-    def [](host)
-      found = @servers[host]
-      if found.nil?
-        raise Netscaler::ConfigurationError.new("The specified Netscaler host was not found")
+    def [](name)
+      # First, try the aliases
+      @servers.each_key do |lbname|
+        found = @servers[lbname]
+        if found['alias'] == name
+          return create_config(lbname, found)
+        end
       end
 
-      if found['username'].nil?
-        raise Netscaler::ConfigurationError.new("No username was specified for the given Netscaler host")
+      # Next, check the actual server names
+      found = @servers[name]
+      if found.nil?
+        raise Netscaler::ConfigurationError.new("The specified Netscaler host was not found")
       end
 
-      Configuration.new(host, found['username'], found['password'])
+      return create_config(name, found)
     end
 
     def load_balancers
@@ -28,6 +33,14 @@ module Netscaler
     end
 
     private
+    def create_config(lbname, yaml)
+      if yaml['username'].nil?
+        raise Netscaler::ConfigurationError.new("No username was specified for the given Netscaler host")
+      end
+
+      Configuration.new(lbname, yaml['username'], yaml['password'], yaml['alias'])
+    end
+
     def read_config_file(file)
       if file.nil?
         file = File.expand_path(".netscaler-cli.yml", Etc.getpwuid.dir)
@@ -47,12 +60,13 @@ module Netscaler
   end
 
   class Configuration
-    attr_reader :host, :username, :password
+    attr_reader :host, :username, :password, :alias
 
-    def initialize(host, username, password=nil)
+    def initialize(host, username, password=nil, nalias=nil)
       @host = host
       @username = username
       @password = password
+      @alias = nalias
 
       query_password
     end

data/lib/netscaler/server/executor.rb

@@ -17,11 +17,59 @@ module Netscaler::Server
 
     def status(options)
       send_request('getserver', @params) do |response|
-        info = response[:return][:list][:item]
-        puts "Name:       #{info[:name]}"
-        puts "IP Address: #{info[:ipaddress]}"
-        puts "State:      #{info[:state]}"
+        resp = Response.new(response)
+        if options[:json]
+          puts resp.to_json
+        else
+          puts resp.to_s
+        end
       end
     end
   end
+
+  class Response
+    attr_reader :raw_response, :info
+
+    def initialize(raw_response)
+      @raw_response = raw_response
+      @info = raw_response[:return][:list][:item]
+    end
+
+    def name
+      info[:name]
+    end
+
+    def ip_address
+      info[:ipaddress]
+    end
+
+    def state
+      info[:state]
+    end
+
+    def services
+      info[:servicename][:item]
+    end
+
+    def to_s
+      base = "Name:\t#{name}\nIP Address:\t#{ip_address}\nState:\t#{state}\nServices:\n"
+      services.each do |service|
+        base << "\t#{service}\n"
+      end
+      base
+    end
+
+    def to_json
+      base = "{ 'name': '#{name}', 'ip_address': '#{ip_address}', 'state': '#{state}', 'services': ["
+
+      services.each_with_index do |service, i|
+        base << "'#{service}'"
+        if i != services.length - 1
+          base << ", "
+        end
+      end
+
+      base << "] }"
+    end
+  end
 end

data/lib/netscaler/service/executor.rb

@@ -19,25 +19,12 @@ module Netscaler::Service
       send_request('disableservice', params)
     end
 
-    def status(options)
-      send_request('getservice', @params) do |response|
-        info = response[:return][:list][:item]
-        puts "Name:       #{info[:name]}"
-        puts "IP Address: #{info[:ipaddress]}"
-        puts "Port:       #{info[:port]}"
-        puts "State:      #{info[:svrstate]}"
-      end
-    end
-
     def bind(options)
       params = {
         :name => options[:vserver],
         :servicename => host
       }
-      send_request('bindlbvserver_service', params) do |response|
-        #require 'pp'
-        #pp response
-      end
+      send_request('bindlbvserver_service', params)
     end
 
     def unbind(options)
@@ -45,10 +32,51 @@ module Netscaler::Service
         :name => options[:vserver],
         :servicename => host
       }
-      send_request('unbindlbvserver_service', params) do |response|
-        #require 'pp'
-        #pp response
+      send_request('unbindlbvserver_service', params)
+    end
+
+    def status(options)
+      send_request('getservice', @params) do |response|
+        resp = Response.new(response)
+        if options[:json]
+          puts resp.to_json
+        else
+          puts resp.to_s
+        end
       end
     end
   end
+
+  class Response
+    attr_reader :raw_response, :info
+
+    def initialize(raw_response)
+      @raw_response = raw_response
+      @info = raw_response[:return][:list][:item]
+    end
+
+    def name
+      info[:name]
+    end
+
+    def ip_address
+      info[:ipaddress]
+    end
+
+    def state
+      info[:svrstate]
+    end
+
+    def port
+      info[:port]
+    end
+    
+    def to_s
+      "Name:\t#{name}\nIP:\t#{ip_address}\nState:\t#{state}\nPort:\t#{port}"
+    end
+
+    def to_json
+      "{ 'name': '#{name}', 'ip_address': '#{ip_address}', 'state': '#{state}', 'port': #{port} }"
+    end
+  end
 end

data/lib/netscaler/version.rb

@@ -2,7 +2,7 @@ require 'scanf'
 
 module Netscaler
   class Version
-    CURRENT = File.read(File.dirname(__FILE__) + '/../VERSION')
+    CURRENT = File.read(File.join(File.dirname(__FILE__), '..', '..', 'etc', 'Version'))
     MAJOR, MINOR, TINY = CURRENT.scanf('%d.%d.%d')
 
     def self.to_s

data/lib/netscaler/vserver/executor.rb

@@ -21,13 +21,15 @@ module Netscaler::VServer
     def status(options)
       send_request('getlbvserver', @params) do |response|
         begin
-          info = response[:return][:list][:item]
-          puts "Name:       #{info[:name]}"
-          puts "IP Address: #{info[:svcipaddress][:item]}"
-          puts "Port:       #{info[:svcport][:item]}"
-          puts "State:      #{info[:svcstate][:item]}"
+          resp = Response.new(response)
+          if options[:json]
+            puts resp.to_json
+          else
+            puts resp.to_s
+          end
         rescue Exception => e
           log.fatal "Unable to lookup any information for host: #{host}"
+          puts e
           exit(1)
         end
       end
@@ -54,4 +56,104 @@ module Netscaler::VServer
       send_request('unbindlbvserver_policy', params)
     end
   end
+
+  class Response
+    attr_reader :raw_response, :info
+
+    def initialize(raw_response)
+      @raw_response = raw_response
+      @info = raw_response[:return][:list][:item]
+    end
+
+    def name
+      info[:name]
+    end
+
+    def ip_address
+      if info[:ipaddress] =~ /0\.0\.0\.0/
+        info[:ipaddress2]
+      else
+        info[:ipaddress]
+      end
+    end
+
+    def type
+      info[:servicetype]
+    end
+
+    def port
+      info[:port]
+    end
+
+    def state
+      info[:state]
+    end
+
+    def servers
+      @parsed_servers ||= []
+      if !@parsed_servers.empty?
+        return @parsed_servers
+      end
+
+      info[:servicename][:item].each do |name|
+        srv = ServerInfo.new
+        srv.name = name
+        @parsed_servers << srv
+      end
+
+      info[:svcstate][:item].each_with_index do |state, i|
+        @parsed_servers[i].state = state
+      end
+
+      info[:svcport][:item].each_with_index do |port, i|
+        @parsed_servers[i].port = port
+      end
+
+      info[:svcipaddress][:item].each_with_index do |ip_address, i|
+        @parsed_servers[i].ip_address = ip_address
+      end
+
+      info[:svctype][:item].each_with_index do |type, i|
+        @parsed_servers[i].type = type
+      end
+
+      @parsed_servers
+    end
+
+    def to_s
+      base = "Name:\t#{name}\nIP:\t#{ip_address}\nState:\t#{state}\nPort:\t#{port}\nType:\t#{type}\nServers:\n"
+      servers.each do |server|
+        base << server.to_s
+        base << "\n\n"
+      end
+      base
+    end
+
+    def to_json
+      base = "{ 'name': '#{name}', 'ip_address': '#{ip_address}', 'state': '#{state}', 'port': '#{port}', 'type': #{type}, 'servers': [\n    "
+
+      servers.each_with_index do |server, i|
+        base << server.to_json
+        if i != servers.length - 1
+          base << ",\n    "
+        else
+          base << "\n"
+        end
+      end
+
+      base << "] }"
+    end
+  end
+
+  class ServerInfo
+    attr_accessor :name, :ip_address, :state, :port, :type
+
+    def to_s
+ "\tName:\t#{name}\n\tIP:\t#{ip_address}\n\tState:\t#{state}\n\tPort:\t#{port}\n\tType:\t#{type}"
+    end
+
+    def to_json
+      "{ 'name': '#{name}', 'ip_address': '#{ip_address}', 'state': '#{state}', 'port': #{port}, 'type': '#{type}' }"
+    end
+  end
 end

data/spec/config_spec.rb

@@ -16,7 +16,7 @@ module Netscaler
 
     describe "when reading an existing file" do
       it "should be able to load the basic config file" do
-        reading('simple-config.yml').load_balancers.length.should eql(1)
+        reading('simple-config.yml').load_balancers.length.should eql(2)
       end
 
       it "should set the username and password correctly when set in the file." do
@@ -24,6 +24,12 @@ module Netscaler
         config.username.should eql('some_user')
         config.password.should eql('somepass')
       end
+
+      it "should load via an alias" do
+        config = reading('simple-config.yml')['else']
+        config.alias.should eql('else')
+        config.username.should eql('here')
+      end
     end
 
     describe "when reading a non-existent or bad file" do

data/spec/configs/simple-config.yml

@@ -1,3 +1,7 @@
 something.goes.here:
   username: some_user
-  password: somepass
+  password: somepass
+something.else:
+  username: here
+  alias: else
+  password: blah

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: netscaler-cli
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Gabe McArthur
@@ -15,45 +15,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 -08:00
+date: 2010-12-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: highline
+  name: log4r
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 13
         segments: 
         - 1
-        - 5
-        - 2
-        version: 1.5.2
+        - 1
+        version: "1.1"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: log4r
+  name: savon
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 3
         segments: 
         - 1
+        - 6
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
         - 1
-        - 7
-        version: 1.1.7
+        - 1
+        - 9
+        version: 1.1.9
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: savon
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -65,23 +94,38 @@ dependencies:
         - 9
         version: 0.7.9
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 7
         segments: 
         - 2
+        - 2
         - 0
-        - 1
-        version: 2.0.1
+        version: 2.2.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id007
 description: This gem installs several simple command line utilities locally.  It uses the NSConfig.wsdl SOAP interface for remote access.
 email: 
 - madeonamac@gmail.com
@@ -94,12 +138,13 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
+- Gemfile
+- Gemfile.lock
 - README.markdown
 - Rakefile
 - bin/netscaler-server
 - bin/netscaler-service
 - bin/netscaler-vserver
-- lib/VERSION
 - lib/netscaler/baseexecutor.rb
 - lib/netscaler/clitemplate.rb
 - lib/netscaler/config.rb
@@ -126,8 +171,8 @@ homepage: http://github.com/gabemc/netscaler-cli
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -156,8 +201,8 @@ signing_key:
 specification_version: 3
 summary: Simple command line utilities for interacting remotely with a Netscaler load balancer.
 test_files: 
-- spec/vserver/cli_spec.rb
+- spec/config_spec.rb
 - spec/helpers.rb
 - spec/server/cli_spec.rb
 - spec/service/cli_spec.rb
-- spec/config_spec.rb
+- spec/vserver/cli_spec.rb

data/lib/VERSION

@@ -1 +0,0 @@
-0.2.3