net-netconf 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 882b8dffb9e72058c0cfc8d9d245d2a33c445e94
-  data.tar.gz: 6965b0162647568257b9d7f413faf8cc99952301
+  metadata.gz: 741e277664fb1c1660b55878c50a47e0b4d21887
+  data.tar.gz: 7b46a74d28874a65a1f346a9303b6e24744dcb61
 SHA512:
-  metadata.gz: f74d7e05706421321cc163259181dbb05321440787663a823af37c79c5b70e0b63737cd4cac6912a8ab69c0d4a42f701d93ea4afc4a5c95ac8a567a9b36595dc
-  data.tar.gz: f079cf1748209eb9df67c347c1c225fab5bb2a0d4aae43667dfa759b327e51fd5d1c21dc16edd48b929f553622d598950f5a54b4fa5ba1b8272af7ec8a571f6d
+  metadata.gz: 058610c26844ee71ffbfa832f300af0e9bc08e66be87325f53ade81730e0ea8a1feed488c4556aea3bab6504ce25e9e155cab5dfad4d5c088c42e1148ecb6e1e
+  data.tar.gz: ba146336a067d81baad536e725cf5c981ef1139c50ee78e5373458da9b1c1cd18cdc51a368eb15fefd620750282cb2bf596e561bfe5af800cabe6e3651e33737

data/lib/net/netconf.rb

@@ -17,8 +17,45 @@ module Netconf
   def self.raise_on_warning=( bool )
     @raise_on_warning = bool
   end
+
   def self.raise_on_warning
     @raise_on_warning
   end
 
+  def self.waitfor(on_re = nil)
+    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
+
+  def self.trans_receive
+    got = waitfor( Netconf::RPC::MSG_END_RE )
+    msg_end = got.rindex( Netconf::RPC::MSG_END )
+    got[msg_end .. -1] = ''
+    got
+  end
 end

data/lib/net/netconf/exception.rb

@@ -1,37 +1,37 @@
 module Netconf
-  
+
   class InitError < StandardError
   end
-  
+
   class StateError < StandardError
   end
-  
+
   class OpenError < StandardError
   end
-  
+
   class RpcError < StandardError
     attr_reader :trans
     attr_reader :cmd, :rsp
-    
+
     def initialize( trans, cmd, rsp )
       @trans = trans
-      @cmd = cmd; @rsp = rsp; 
+      @cmd = cmd; @rsp = rsp;
     end
-    
+
     def to_s
       "RPC command error: #{cmd.first_element_child.name}\n#{rsp.to_xml}"
     end
   end
-  
+
   class EditError < Netconf::RpcError
   end
-  
+
   class LockError < Netconf::RpcError
   end
-  
+
   class CommitError < Netconf::RpcError
   end
-  
+
   class ValidateError < Netconf::RpcError
   end
 

data/lib/net/netconf/ioproc.rb

@@ -1,88 +1,58 @@
 module Netconf
-  
+
   class IOProc < Netconf::Transport
-    
+
     DEFAULT_RDBLKSZ = (1024*1024)
-    
+
     attr_reader :args
-        
+
     def initialize( args_h = {}, &block )
       os_type = args_h[:os_type] || Netconf::DEFAULT_OS_TYPE
-            
+
       @args = args_h.clone
-      
+
       # an OS specific implementation must exist to support this transport type
-      extend Netconf::const_get( os_type )::IOProc        
-      
+      extend Netconf::const_get( os_type )::IOProc
+
       @trans_timeout = @args[:timeout] || Netconf::DEFAULT_TIMEOUT
       @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO
 
-      super( &block )      
-    end      
-        
+      super( &block )
+    end
+
     # the OS specific transport must implement this method
-    def trans_open # :yield: self      
+    def trans_open # :yield: self
       raise "Unsupported IOProc"
     end
-    
+
     def trans_receive_hello
       trans_receive()
     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
+      Netconf.trans_receive
     end
-        
+
     def puts( str = nil )
       @trans.puts( str )
     end
-        
-    def waitfor( on_re )      
-      
-      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     
-    
+
+    def waitfor( on_re )
+      Netconf.waitfor(on_re)
+    end
+
   end # class: IOProc
 end # module: Netconf

data/lib/net/netconf/jnpr.rb

@@ -6,4 +6,4 @@ module Netconf::Junos
   NETCONF_CLI = "junoscript netconf need-trailer"
   NETCONF_SHELL = "exec xml-mode netconf need-trailer"
 end
-  
+

data/lib/net/netconf/jnpr/ioproc.rb

@@ -5,8 +5,8 @@ require 'net/netconf/jnpr'
 module Netconf
   module Junos
     module IOProc
-      def trans_open   
-        @trans = IO.popen( "xml-mode netconf need-trailer", "r+")                             
+      def trans_open
+        @trans = IO.popen( "xml-mode netconf need-trailer", "r+")
         self
       end
     end

data/lib/net/netconf/jnpr/junos_config.rb

@@ -10,7 +10,7 @@ module Netconf
 
     DELETE = { :delete => 'delete' }
     REPLACE = { :replace => 'replace' }
- 
+
     attr_reader :doc
     attr_reader :collection
 

data/lib/net/netconf/jnpr/rpc.rb

@@ -1,6 +1,6 @@
 ## -----------------------------------------------------------------------
-## This file contains the Junos specific RPC methods that are generated 
-## specifically and different as generated by the Netconf::RPC::Builder 
+## This file contains the Junos specific RPC methods that are generated
+## specifically and different as generated by the Netconf::RPC::Builder
 ## module.  These are specifically the following:
 ##
 ##   get_configuration      - alternative NETCONF: 'get-config'
@@ -14,149 +14,148 @@
 
 module Netconf
   module RPC
-    module Junos            
-      
+    module Junos
+
       def lock_configuration
-        lock( 'candidate' )
-      end      
-      
+        lock('candidate')
+      end
+
       def check_configuration
-        validate( 'candidate' )
-      end            
-      
-      def commit_configuration( params = nil, attrs = nil )
-        rpc = Netconf::RPC::Builder.commit_configuration( params, attrs )
-        Netconf::RPC.set_exception( rpc, Netconf::CommitError )
-        @trans.rpc_exec( rpc )   
+        validate('candidate')
+      end
+
+      def commit_configuration(params = nil, attrs = nil)
+        rpc = Netconf::RPC::Builder.commit_configuration(params, attrs)
+        Netconf::RPC.set_exception(rpc, Netconf::CommitError)
+        @trans.rpc_exec(rpc)
+      end
+
+      def nokogiri_case(arg)
+        filter = case arg
+                 when Nokogiri::XML::Builder  then arg.doc.root
+                 when Nokogiri::XML::Document then arg.root
+                 else arg
       end
 
-      def get_configuration( *args )
-              
+      def get_configuration(*args)
         filter = nil
-        
+
         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 /^Nokogiri/
+            nokogiri_case(arg)
           when 'Hash' then attrs = arg
           end
         end
 
         rpc = Nokogiri::XML('<rpc><get-configuration/></rpc>').root
-        Netconf::RPC.add_attributes( rpc.first_element_child, attrs ) if attrs            
-        
+        Netconf::RPC.add_attributes(rpc.first_element_child, attrs) if attrs
+
         if block_given?
-          Nokogiri::XML::Builder.with(rpc.at( 'get-configuration' )){ |xml|
-            xml.configuration {
-              yield( xml )
-          }}
+          Nokogiri::XML::Builder.with(rpc.at('get-configuration')) do |xml|
+            xml.configuration do
+              yield(xml)
+            end
+          end
         elsif filter
           # filter must have toplevel = <configuration>
-          rpc.first_element_child << filter.dup   # *MUST* use the .dup so we don't disrupt the original filter
+          # *MUST* use the .dup so we don't disrupt the original filter
+          rpc.first_element_child << filter.dup
         end
-               
-        @trans.rpc_exec( rpc )
+
+        @trans.rpc_exec(rpc)
       end
-      
-      def load_configuration( *args )
-                
+
+      def load_configuration(*args)
         config = nil
-        
+
         # default format is XML
-        attrs = { :format => 'xml' }
-                
+        attrs = { format: 'xml' }
+
         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 /^Nokogiri/
+            nokogiri_case(arg)
           when 'Hash' then attrs.merge! arg
           when 'Array' then config = arg.join("\n")
           when 'String' then config = arg
           end
         end
-        
+
         case attrs[:format]
         when 'set'
           toplevel = 'configuration-set'
           attrs[:format] = 'text'
-          attrs[:action] = 'set'          
+          attrs[:action] = 'set'
         when 'text'
-          toplevel = 'configuration-text'          
+          toplevel = 'configuration-text'
         when 'xml'
-          toplevel = 'configuration'          
-        end                        
-        
+          toplevel = 'configuration'
+        end
+
         rpc = Nokogiri::XML('<rpc><load-configuration/></rpc>').root
         ld_cfg = rpc.first_element_child
-        Netconf::RPC.add_attributes( ld_cfg, attrs ) if attrs   
-        
+        Netconf::RPC.add_attributes(ld_cfg, attrs) if attrs
+
         if block_given?
           if attrs[:format] == 'xml'
-            Nokogiri::XML::Builder.with( ld_cfg ){ |xml|
-              xml.send( toplevel ) {
-                yield( xml )
-            }} 
+            Nokogiri::XML::Builder.with(ld_cfg) do |xml|
+              xml.send(toplevel) do
+                yield(xml)
+              end
+            end
           else
-            config = yield  # returns String | Array(of stringable)            
-            config = config.join("\n") if config.class == Array  
+            config = yield  # returns String | Array(of stringable)
+            config = config.join("\n") if config.class == Array
           end
         end
-        
+
         if config
           if attrs[:format] == 'xml'
-            # config assumes toplevel = <configuration> given            
-            ld_cfg << config.dup        # duplicate the config so as to not distrupt it            
+            # config assumes toplevel = <configuration> given
+            ld_cfg << config.dup # duplicate the config so as to not distrupt it
           else
-            # config is stringy, so just add it as the text node            
-            c_node = Nokogiri::XML::Node.new( toplevel, rpc )            
+            # config is stringy, so just add it as the text node
+            c_node = Nokogiri::XML::Node.new(toplevel, rpc)
             c_node.content = config
-            ld_cfg << c_node            
+            ld_cfg << c_node
           end
         end
-                                           
+
         # set a specific exception class on this RPC so it can be
         # properlly handled by the calling enviornment
-        
-        Netconf::RPC::set_exception( rpc, Netconf::EditError )    
-        @trans.rpc_exec( rpc )
+
+        Netconf::RPC.set_exception(rpc, Netconf::EditError)
+        @trans.rpc_exec(rpc)
       end # load_configuration
-      
-      def command( cmd_str, attrs = nil )
+
+      def command(cmd_str, attrs = nil)
         rpc = Nokogiri::XML("<rpc><command>#{cmd_str}</command></rpc>").root
-        Netconf::RPC.add_attributes( rpc.at('command'), attrs ) if attrs           
-        @trans.rpc_exec( rpc )
+        Netconf::RPC.add_attributes(rpc.at('command'), attrs) if attrs
+        @trans.rpc_exec(rpc)
       end
-      
+
       ## contributed by 'dgjnpr'
-      def request_pfe_execute( params = nil )
+      def request_pfe_execute(params = nil)
         raise ArgumentError, 'Manditorary argument :target missing' unless params[:target]
         raise ArgumentError, 'Manditorary argument :command missing' unless params[:command]
 
-        rpc_nx = Nokogiri::XML::Builder.new { |xml|
-          xml.rpc {
-            xml.send( 'request-pfe-execute' ) {
-              xml.send( 'target', params[:target] )
+        rpc_nx = Nokogiri::XML::Builder.new do |xml|
+          xml.rpc do
+            xml.send('request-pfe-execute') do
+              xml.send('target', params[:target])
               if params[:command].class.to_s =~ /^Array/
-                params[:command].each { |cmd|
-                  xml.send( 'command', cmd )
-                }
+                params[:command].each do |cmd|
+                  xml.send('command', cmd)
+                end
               elsif params[:command].class.to_s =~ /^String/
-                xml.send( 'command', params[:command] )
+                xml.send('command', params[:command])
               end
-            }
-          }
-        }
-        @trans.rpc_exec( rpc_nx )
+            end
+          end
+        end
+        @trans.rpc_exec(rpc_nx)
       end
-            
-    end # module: JUNOS    
+    end # module: JUNOS
   end # module: RPC
 end # module: Netconf