netconf 0.2.5 → 0.3.0

data/lib/net/netconf/rpc_std.rb

@@ -1,134 +1,133 @@
-module Netconf  
-  module RPC
-    
-    MSG_END = "]]>]]>"
-    MSG_END_RE = /\]\]>\]\]>[\r\n]*$/
-    MSG_CLOSE_SESSION = '<rpc><close-session/></rpc>'       
-    MSG_HELLO = <<-EOM
-<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
-  <capabilities>
-    <capability>urn:ietf:params:netconf:base:1.0</capability>
-  </capabilities>
-</hello>
-]]>]]>
-EOM
-
-  module Standard
-    
-    def lock( target )      
-      rpc = Nokogiri::XML( "<rpc><lock><target><#{target}/></target></lock></rpc>" ).root
-      Netconf::RPC.set_exception( rpc, Netconf::LockError )
-      @trans.rpc_exec( rpc )      
-    end
-    
-    def unlock( target )
-      rpc = Nokogiri::XML( "<rpc><unlock><target><#{target}/></target></unlock></rpc>" ).root
-      @trans.rpc_exec( rpc )          
-    end
-    
-    def validate( source )
-      rpc = Nokogiri::XML( "<rpc><validate><source><#{source}/></source></validate></rpc>" ).root
-      Netconf::RPC.set_exception( rpc, Netconf::ValidateError )      
-      @trans.rpc_exec( rpc )          
-    end
-    
-    def commit
-      rpc = Nokogiri::XML( "<rpc><commit/></rpc>" ).root
-      Netconf::RPC.set_exception( rpc, Netconf::CommitError )      
-      @trans.rpc_exec( rpc )                
-    end
-    
-    def delete_config( target )
-      rpc = Nokogiri::XML( "<rpc><delete-config><target><#{target}/></target></delete-config></rpc>" ).root
-      @trans.rpc_exec( rpc )          
-    end
-    
-    def get_config( *args ) # :yeield: filter_builder
-      
-      source = 'running'    # default source is 'running'
-      filter = nil          # no filter by default
-      
-      while arg = args.shift
-        case arg.class.to_s
-        when /^Nokogiri/ 
-          filter = case arg
-            when Nokogiri::XML::Builder  then arg.doc.root
-            when Nokogiri::XML::Document then arg.root
-            else arg
-            end    
-        when 'Hash' then attrs = arg
-        when 'String' then source = arg
-        end
-      end
-      
-      rpc = Nokogiri::XML("<rpc><get-config><source><#{source}/></source></get-config></rpc>").root
-      
-      if block_given?
-        Nokogiri::XML::Builder.with( rpc.at( 'get-config' )){ |xml|
-          xml.filter( :type => 'subtree' ) {
-            yield( xml )
-          }
-        }
-      end
-      
-      if filter
-        f_node = Nokogiri::XML::Node.new( 'filter', rpc )
-        f_node['type'] = 'subtree'
-        f_node << filter.dup   # copy filter, don't mess with the original since it may be re-used
-        rpc.at('get-config') <<  f_node
-      end             
-            
-      @trans.rpc_exec( rpc )      
-    end
-
-    def edit_config( *args ) # :yeield: config_builder
-      
-      toplevel = 'config'   # default toplevel config element
-      target = 'candidate'  # default source is 'candidate'  @@@/JLS hack; need to fix this
-      config = nil
-      options = {}
-      
-      while arg = args.shift
-        case arg.class.to_s
-        when /^Nokogiri/ 
-          config = case arg
-            when Nokogiri::XML::Builder  then arg.doc.root
-            when Nokogiri::XML::Document then arg.root
-            else arg
-            end    
-        when 'Hash' then options = arg
-        when 'String' then target = arg
-        end
-      end
-      
-      toplevel = options[:toplevel] if options[:toplevel]
-
-      rpc_str = <<-EO_RPC
-<rpc>
-<edit-config>
-   <target><#{target}/></target>
-   <#{toplevel}/>
-</edit-config>
-</rpc>
-EO_RPC
-
-      rpc = Nokogiri::XML( rpc_str ).root
-      
-      if block_given?
-        Nokogiri::XML::Builder.with(rpc.at( toplevel )){ |xml|
-          yield( xml )
-        }
-      elsif config
-        rpc.at( toplevel ) << config.dup
-      else
-        raise ArgumentError, "You must specify edit-config data!"    
-      end                    
-      
-      Netconf::RPC.set_exception( rpc, Netconf::EditError )    
-      @trans.rpc_exec( rpc )      
-    end    
-        
-  end
-
-  end # module: RPC  
-end # module: Netconf
+module Netconf  
+  module RPC
+    
+    MSG_END = "]]>]]>"
+    MSG_END_RE = /\]\]>\]\]>[\r\n]*$/
+    MSG_CLOSE_SESSION = '<rpc><close-session/></rpc>'       
+    MSG_HELLO = <<-EOM
+<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
+  <capabilities>
+    <capability>urn:ietf:params:netconf:base:1.0</capability>
+  </capabilities>
+</hello>
+EOM
+
+  module Standard
+    
+    def lock( target )      
+      rpc = Nokogiri::XML( "<rpc><lock><target><#{target}/></target></lock></rpc>" ).root
+      Netconf::RPC.set_exception( rpc, Netconf::LockError )
+      @trans.rpc_exec( rpc )      
+    end
+    
+    def unlock( target )
+      rpc = Nokogiri::XML( "<rpc><unlock><target><#{target}/></target></unlock></rpc>" ).root
+      @trans.rpc_exec( rpc )          
+    end
+    
+    def validate( source )
+      rpc = Nokogiri::XML( "<rpc><validate><source><#{source}/></source></validate></rpc>" ).root
+      Netconf::RPC.set_exception( rpc, Netconf::ValidateError )      
+      @trans.rpc_exec( rpc )          
+    end
+    
+    def commit
+      rpc = Nokogiri::XML( "<rpc><commit/></rpc>" ).root
+      Netconf::RPC.set_exception( rpc, Netconf::CommitError )      
+      @trans.rpc_exec( rpc )                
+    end
+    
+    def delete_config( target )
+      rpc = Nokogiri::XML( "<rpc><delete-config><target><#{target}/></target></delete-config></rpc>" ).root
+      @trans.rpc_exec( rpc )          
+    end
+    
+    def get_config( *args ) # :yeield: filter_builder
+      
+      source = 'running'    # default source is 'running'
+      filter = nil          # no filter by default
+      
+      while arg = args.shift
+        case arg.class.to_s
+        when /^Nokogiri/ 
+          filter = case arg
+            when Nokogiri::XML::Builder  then arg.doc.root
+            when Nokogiri::XML::Document then arg.root
+            else arg
+            end    
+        when 'Hash' then attrs = arg
+        when 'String' then source = arg
+        end
+      end
+      
+      rpc = Nokogiri::XML("<rpc><get-config><source><#{source}/></source></get-config></rpc>").root
+      
+      if block_given?
+        Nokogiri::XML::Builder.with( rpc.at( 'get-config' )){ |xml|
+          xml.filter( :type => 'subtree' ) {
+            yield( xml )
+          }
+        }
+      end
+      
+      if filter
+        f_node = Nokogiri::XML::Node.new( 'filter', rpc )
+        f_node['type'] = 'subtree'
+        f_node << filter.dup   # copy filter, don't mess with the original since it may be re-used
+        rpc.at('get-config') <<  f_node
+      end             
+            
+      @trans.rpc_exec( rpc )      
+    end
+
+    def edit_config( *args ) # :yeield: config_builder
+      
+      toplevel = 'config'   # default toplevel config element
+      target = 'candidate'  # default source is 'candidate'  @@@/JLS hack; need to fix this
+      config = nil
+      options = {}
+      
+      while arg = args.shift
+        case arg.class.to_s
+        when /^Nokogiri/ 
+          config = case arg
+            when Nokogiri::XML::Builder  then arg.doc.root
+            when Nokogiri::XML::Document then arg.root
+            else arg
+            end    
+        when 'Hash' then options = arg
+        when 'String' then target = arg
+        end
+      end
+      
+      toplevel = options[:toplevel] if options[:toplevel]
+
+      rpc_str = <<-EO_RPC
+<rpc>
+<edit-config>
+   <target><#{target}/></target>
+   <#{toplevel}/>
+</edit-config>
+</rpc>
+EO_RPC
+
+      rpc = Nokogiri::XML( rpc_str ).root
+      
+      if block_given?
+        Nokogiri::XML::Builder.with(rpc.at( toplevel )){ |xml|
+          yield( xml )
+        }
+      elsif config
+        rpc.at( toplevel ) << config.dup
+      else
+        raise ArgumentError, "You must specify edit-config data!"    
+      end                    
+      
+      Netconf::RPC.set_exception( rpc, Netconf::EditError )    
+      @trans.rpc_exec( rpc )      
+    end    
+        
+  end
+
+  end # module: RPC  
+end # module: Netconf

data/lib/net/netconf/serial.rb

@@ -1,135 +1,135 @@
-require 'serialport'
-
-module Netconf
-  
-  class Serial < Netconf::Transport
-    
-    DEFAULT_BAUD = 9600
-    DEFAULT_DATABITS = 8
-    DEFAULT_STOPBITS = 1
-    DEFAULT_PARITY = SerialPort::NONE
-    DEFAULT_RDBLKSZ = (1024*1024)
-    
-    attr_reader :args
-        
-    def initialize( args_h, &block )
-      os_type = args_h[:os_type] || Netconf::DEFAULT_OS_TYPE
-      
-      raise Netconf::InitError, "Missing 'port' param" unless args_h[:port]
-      raise Netconf::InitError, "Missing 'username' param" unless args_h[:username]
-      
-      @args = args_h.clone
-      @args[:prompt] ||= /([%>])\s+$/
-        
-      # extend this instance with the capabilities of the specific console
-      # type; it needs to define #trans_start_netconf session
-      # this must be provided! if the caller does not, this will 
-      # throw a NameError exception.
-      
-      extend Netconf::const_get( os_type )::TransSerial        
-      
-      @trans_timeout = @args[:timeout] || Netconf::DEFAULT_TIMEOUT
-      @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO
-
-      super( &block )      
-    end      
-    
-    def login
-      
-      begin
-        puts
-        waitfor(/ogin:/)
-      rescue Timeout::Error
-        puts
-        waitfor(/ogin:/)
-      end
-      
-      puts @args[:username]
-      
-      waitfor(/assword:/)
-      puts @args[:password]
-      
-      waitfor( @args[:prompt] )
-    end
-    
-    def trans_open # :yield: self
-      
-      baud = @args[:speed] || DEFAULT_BAUD
-      data_bits = @args[:bits] || DEFAULT_DATABITS
-      stop_bits = @args[:stop] || DEFAULT_STOPBITS
-      parity = @args[:parity] || DEFAULT_PARITY
-      
-      @trans = SerialPort.new( @args[:port], baud, data_bits, stop_bits, parity )            
-            
-      got = login()      
-      yield self if block_given?      
-      trans_start_netconf( got )      
-      
-      self
-    end
-    
-    def trans_receive_hello
-      hello_str = trans_receive()
-      so_xml = hello_str.index("\n") + 1
-      hello_str.slice!(0, so_xml)
-      hello_str
-    end
-    
-    def trans_send_hello
-      nil
-    end
-    
-    def trans_close
-      @trans.write Netconf::RPC::MSG_CLOSE_SESSION
-      @trans.close
-    end
-    
-    def trans_send( cmd_str )
-      @trans.write( cmd_str )
-    end
-    
-    def trans_receive
-      got = waitfor( Netconf::RPC::MSG_END_RE )
-      msg_end = got.rindex( Netconf::RPC::MSG_END )
-      got[msg_end .. -1] = ''
-      got
-    end
-        
-    def puts( str = nil )
-      @trans.puts str 
-    end
-        
-    def waitfor( this_re = nil )      
-      on_re = this_re || @args[:prompt]
-      
-      time_out = @trans_timeout
-      wait_io = @trans_waitio
-
-      time_out = nil if time_out == false
-      done = false
-      rx_buf = ''      
-                  
-      until( rx_buf.match( on_re ) and not IO::select( [@trans], nil, nil, wait_io ) )
-              
-        unless IO::select( [@trans], nil, nil, time_out )
-          raise TimeoutError, "Netconf IO timed out while waiting for more data"
-        end
-      
-        begin                   
-          
-          rx_some = @trans.readpartial( DEFAULT_RDBLKSZ )                       
-          
-          rx_buf += rx_some
-          break if rx_buf.match( on_re )
-          
-        rescue EOFError # End of file reached
-          rx_buf = nil if rx_buf == ''
-          break   # out of outer 'until' loop
-        end        
-        
-      end      
-      rx_buf
-    end     
-    
-  end # class: Serial
-end # module: Netconf
+require 'serialport'
+
+module Netconf
+  
+  class Serial < Netconf::Transport
+    
+    DEFAULT_BAUD = 9600
+    DEFAULT_DATABITS = 8
+    DEFAULT_STOPBITS = 1
+    DEFAULT_PARITY = SerialPort::NONE
+    DEFAULT_RDBLKSZ = (1024*1024)
+    
+    attr_reader :args
+        
+    def initialize( args_h, &block )
+      os_type = args_h[:os_type] || Netconf::DEFAULT_OS_TYPE
+      
+      raise Netconf::InitError, "Missing 'port' param" unless args_h[:port]
+      raise Netconf::InitError, "Missing 'username' param" unless args_h[:username]
+      
+      @args = args_h.clone
+      @args[:prompt] ||= /([%>])\s+$/
+        
+      # extend this instance with the capabilities of the specific console
+      # type; it needs to define #trans_start_netconf session
+      # this must be provided! if the caller does not, this will 
+      # throw a NameError exception.
+      
+      extend Netconf::const_get( os_type )::TransSerial        
+      
+      @trans_timeout = @args[:timeout] || Netconf::DEFAULT_TIMEOUT
+      @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO
+
+      super( &block )      
+    end      
+    
+    def login
+      
+      begin
+        puts
+        waitfor(/ogin:/)
+      rescue Timeout::Error
+        puts
+        waitfor(/ogin:/)
+      end
+      
+      puts @args[:username]
+      
+      waitfor(/assword:/)
+      puts @args[:password]
+      
+      waitfor( @args[:prompt] )
+    end
+    
+    def trans_open # :yield: self
+      
+      baud = @args[:speed] || DEFAULT_BAUD
+      data_bits = @args[:bits] || DEFAULT_DATABITS
+      stop_bits = @args[:stop] || DEFAULT_STOPBITS
+      parity = @args[:parity] || DEFAULT_PARITY
+      
+      @trans = SerialPort.new( @args[:port], baud, data_bits, stop_bits, parity )            
+            
+      got = login()      
+      yield self if block_given?      
+      trans_start_netconf( got )      
+      
+      self
+    end
+    
+    def trans_receive_hello
+      hello_str = trans_receive()
+      so_xml = hello_str.index("\n") + 1
+      hello_str.slice!(0, so_xml)
+      hello_str
+    end
+    
+    def trans_send_hello
+      nil
+    end
+    
+    def trans_close
+      @trans.write Netconf::RPC::MSG_CLOSE_SESSION
+      @trans.close
+    end
+    
+    def trans_send( cmd_str )
+      @trans.write( cmd_str )
+    end
+    
+    def trans_receive
+      got = waitfor( Netconf::RPC::MSG_END_RE )
+      msg_end = got.rindex( Netconf::RPC::MSG_END )
+      got[msg_end .. -1] = ''
+      got
+    end
+        
+    def puts( str = nil )
+      @trans.puts str 
+    end
+        
+    def waitfor( this_re = nil )      
+      on_re = this_re || @args[:prompt]
+      
+      time_out = @trans_timeout
+      wait_io = @trans_waitio
+
+      time_out = nil if time_out == false
+      done = false
+      rx_buf = ''      
+                  
+      until( rx_buf.match( on_re ) and not IO::select( [@trans], nil, nil, wait_io ) )
+              
+        unless IO::select( [@trans], nil, nil, time_out )
+          raise TimeoutError, "Netconf IO timed out while waiting for more data"
+        end
+      
+        begin                   
+          
+          rx_some = @trans.readpartial( DEFAULT_RDBLKSZ )                       
+          
+          rx_buf += rx_some
+          break if rx_buf.match( on_re )
+          
+        rescue EOFError # End of file reached
+          rx_buf = nil if rx_buf == ''
+          break   # out of outer 'until' loop
+        end        
+        
+      end      
+      rx_buf
+    end     
+    
+  end # class: Serial
+end # module: Netconf