net-netconf 0.4.1 → 0.4.2

data/lib/net/netconf/telnet.rb

@@ -1,52 +1,49 @@
 require 'net/telnet'
 
 module Netconf
-  
   class Telnet < Netconf::Transport
-                
-    def initialize( args, trans_args = nil, &block )
-      os_type = args[:os_type] || Netconf::DEFAULT_OS_TYPE            
+    def initialize(args, trans_args = nil, &block)
+      os_type = args[:os_type] || Netconf::DEFAULT_OS_TYPE
       @args = args.clone
-            
+
       # extend this instance with the capabilities of the specific console
       # type; it needs to define #login and #start_netconf session
       begin
-        extend Netconf::const_get( os_type )::TransTelnet        
+        extend Netconf.const_get(os_type).TransTelnet
       rescue NameError
         # no extensions available ...
-      end     
-      
+      end
+
       my_trans_args = {}
-      my_trans_args["Host"] = @args[:target]
-      my_trans_args["Port"] = @args[:port] if @args[:port]
-      
-      @trans = Net::Telnet.new( my_trans_args )
-      
+      my_trans_args['Host'] = @args[:target]
+      my_trans_args['Port'] = @args[:port] if @args[:port]
+
+      @trans = Net::Telnet.new(my_trans_args)
+
       @trans_timeout = @args[:timeout] || Netconf::DEFAULT_TIMEOUT
-      @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO      
-     
-      super( &block )      
-    end      
-        
-    def trans_open( &block )
-      trans_login()
-      trans_start_netconf() 
+      @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO
+
+      super(&block)
+    end
+
+    def trans_open(&block)
+      trans_login
+      trans_start_netconf
       self
     end
-        
+
     def trans_close
       @trans.write Netconf::RPC::MSG_CLOSE_SESSION
       @trans.close
     end
-    
-    def trans_send( cmd_str )
-      @trans.write( cmd_str )
+
+    def trans_send(cmd_str)
+      @trans.write cmd_str
     end
-    
-    def trans_receive      
-      rsp = @trans.waitfor( Netconf::RPC::MSG_END_RE )
-      rsp.chomp!( Netconf::RPC::MSG_END + "\n" )      
+
+    def trans_receive
+      rsp = @trans.waitfor(Netconf::RPC::MSG_END_RE)
+      rsp.chomp!(Netconf::RPC::MSG_END + "\n")
     end
-    
   end # class: Serial
 end # module: Netconf

data/lib/net/netconf/transport.rb

@@ -12,24 +12,21 @@
 
 module Netconf
   class Transport
-
     attr_reader :rpc, :state, :session_id, :capabilities
     attr_writer :timeout, :waitio
 
-    def initialize( &block )
-
+    def initialize(&block)
       @state = :NETCONF_CLOSED
       @os_type = @args[:os_type] || Netconf::DEFAULT_OS_TYPE
 
-      @rpc = Netconf::RPC::Executor.new( self, @os_type )
+      @rpc = Netconf::RPC::Executor.new(self, @os_type)
       @rpc_message_id = 1
 
       if block_given?
-        open( &block = nil )      # do not pass this block to open()
+        open(&block = nil)      # do not pass this block to open()
         yield self
-        close()
+        close
       end
-
     end # initialize
 
     def open?
@@ -40,25 +37,24 @@ module Netconf
       @state == :NECONF_CLOSED
     end
 
-    def open( &block ) # :yield: specialized transport open, generally not used
-
+    def open(&block) # :yield: specialized transport open, generally not used
       raise Netconf::StateError if @state == :NETCONF_OPEN
 
       # block is used to deal with special open processing ...
       # this is *NOT* the block passed to initialize()
-      raise Netconf::OpenError unless trans_open( &block )
+      raise Netconf::OpenError unless trans_open(&block)
 
       # read the <hello> from the server and parse out
       # the capabilities and session-id
 
-      hello_rsp = Nokogiri::XML( trans_receive_hello() )
+      hello_rsp = Nokogiri::XML(trans_receive_hello)
       hello_rsp.remove_namespaces!
 
-      @capabilities = hello_rsp.xpath('//capability').map{ |c| c.text }
+      @capabilities = hello_rsp.xpath('//capability').map { |c| c.text }
       @session_id = hello_rsp.xpath('//session-id').text
 
       # send the <hello>
-      trans_send_hello()
+      trans_send_hello
 
       @state = :NETCONF_OPEN
       self
@@ -69,27 +65,27 @@ module Netconf
     end
 
     def trans_send_hello
-      trans_send( Netconf::RPC::MSG_HELLO )
-      trans_send( RPC::MSG_END )
+      trans_send(Netconf::RPC::MSG_HELLO)
+      trans_send(RPC::MSG_END)
     end
 
-    def has_capability?( capability )
-      @capabilities.select{|c| c.include? capability }.pop
+    def has_capability?(capability)
+      @capabilities.select { |c| c.include? capability }.pop
       # note: the caller could also simply use #grep on @capabilities
     end
 
     def close
       raise Netconf::StateError unless @state == :NETCONF_OPEN
-      trans_close()
+      trans_close
       @state = :NETCONF_CLOSED
       self
     end
 
     # string in; string out
-    def send_and_receive( cmd_str )
-      trans_send( cmd_str )
-      trans_send( RPC::MSG_END )
-      trans_receive()
+    def send_and_receive(cmd_str)
+      trans_send(cmd_str)
+      trans_send(RPC::MSG_END)
+      trans_receive
     end
 
     def rpc_exec( cmd_nx )
@@ -106,7 +102,7 @@ module Netconf
       # receive the response; then covert it to a Nokogiri XML
       # object so we can process it.
 
-      rsp_nx = Nokogiri::XML( send_and_receive( cmd_nx.to_xml ))
+      rsp_nx = Nokogiri::XML(send_and_receive(cmd_nx.to_xml))
 
       # the following removes only the default namespace (xmlns)
       # definitions from the document.  This is an alternative
@@ -115,7 +111,7 @@ module Netconf
       # nice "compromise" ... just don't know what it does
       # performance-wise on large datasets.
 
-      rsp_nx.traverse{ |n| n.namespace = nil }
+      rsp_nx.traverse { |n| n.namespace = nil }
 
       # set the response context to the root node; <rpc-reply>
 
@@ -137,9 +133,9 @@ module Netconf
         # or if the caller wants to raise if severity == 'warning'
         # then generate the exception
 
-        if(( sev_err.count > 0 ) || Netconf::raise_on_warning )
-          exception = Netconf::RPC.get_exception( cmd_nx )
-          raise exception.new( self, cmd_nx, rsp_nx )
+        if (sev_err.count > 0) || Netconf.raise_on_warning
+          exception = Netconf::RPC.get_exception(cmd_nx)
+          raise exception.new(self, cmd_nx, rsp_nx)
         end
       end
 
@@ -149,9 +145,6 @@ module Netconf
       # @@@/JLS: the generic case.
 
       rsp_nx.first_element_child
-
     end
-
-
   end #--class: Transport
 end #--module: Netconf

data/lib/net/netconf/version.rb

@@ -1,3 +1,3 @@
 module Netconf
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-netconf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Kevin Kirsche
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Updated and maintained fork of the Juniper Ruby NetConf client
+description: Updated and maintained fork of the Juniper Ruby NetConf client. This
+  is used to manage Junos OS devices.
 email: kev.kirsche@gmail.com
 executables: []
 extensions: []