netconf 0.2.5 → 0.3.0

data/lib/net/netconf/ssh.rb

@@ -1,77 +1,78 @@
-require 'net/ssh'
-
-module Netconf      
-  class SSH < Netconf::Transport
-    
-    NETCONF_PORT = 830
-    NETCONF_SUBSYSTEM = 'netconf'    
-    
-    def initialize( args_h, &block )      
-      @args = args_h.clone
-      @trans = Hash.new   
-      
-      super( &block )
-    end
-    
-    def trans_open( &block )
-      # open a connection to the NETCONF subsystem        
-      start_args = Hash.new
-      start_args[:password] ||= @args[:password]
-      start_args[:passphrase] = @args[:passphrase] || nil
-      start_args[:port] = @args[:port] || NETCONF_PORT
-      
-      @trans[:conn] = Net::SSH.start( @args[:target], @args[:username], start_args )     
-      @trans[:chan] = @trans[:conn].open_channel{ |ch| ch.subsystem( NETCONF_SUBSYSTEM ) }      
-    end
-    
-    def trans_close     
-      @trans[:chan].close if @trans[:chan]
-      @trans[:conn].close if @trans[:conn]
-    end
-        
-    def trans_receive
-      @trans[:rx_buf] = ''
-      @trans[:more] = true
-      
-      # collect the response data as it comes back ...
-      # the "on" functions must be set before calling
-      # the #loop method
-      
-      @trans[:chan].on_data do |ch, data|
-        if data.include?( RPC::MSG_END )
-          data.slice!( RPC::MSG_END )
-          @trans[:rx_buf] << data unless data.empty?
-          @trans[:more] = false
-        else
-          @trans[:rx_buf] << data
-        end
-      end
-      
-      # ... if there are errors ... 
-      @trans[:chan].on_extended_data do |ch, type, data|
-        @trans[:rx_err] = data
-        @trans[:more] = false
-      end
-      
-      # the #loop method is what actually performs
-      # ssh event processing ...
-      
-      @trans[:conn].loop { @trans[:more] }        
-      
-      return @trans[:rx_buf]      
-    end
-    
-    def trans_send( cmd_str )
-      @trans[:chan].send_data( cmd_str )                    
-    end
-    
-    # accessor to create an Net::SCP object so the caller can perform
-    # secure-copy operations (see Net::SCP) for details
-    def scp
-      @scp ||= Net::SCP.start( @args[:target], @args[:username], :password => @args[:password] )
-    end
-    
-  end # class: SSH
-end #module: Netconf
-
-require 'net/netconf/ssh'
+require 'net/ssh'
+
+module Netconf      
+  class SSH < Netconf::Transport
+    
+    NETCONF_PORT = 830
+    NETCONF_SUBSYSTEM = 'netconf'    
+    
+    def initialize( args_h, &block )      
+      @args = args_h.clone
+      @trans = Hash.new   
+      
+      super( &block )
+    end
+    
+    def trans_open( &block )
+      # open a connection to the NETCONF subsystem        
+      start_args = Hash.new
+      start_args[:password] ||= @args[:password]
+      start_args[:passphrase] = @args[:passphrase] || nil
+      start_args[:port] = @args[:port] || NETCONF_PORT
+      start_args.merge!(@args[:ssh_args]) if @args[:ssh_args]
+      
+      @trans[:conn] = Net::SSH.start( @args[:target], @args[:username], start_args )     
+      @trans[:chan] = @trans[:conn].open_channel{ |ch| ch.subsystem( NETCONF_SUBSYSTEM ) }      
+    end
+    
+    def trans_close     
+      @trans[:chan].close if @trans[:chan]
+      @trans[:conn].close if @trans[:conn]
+    end
+        
+    def trans_receive
+      @trans[:rx_buf] = ''
+      @trans[:more] = true
+      
+      # collect the response data as it comes back ...
+      # the "on" functions must be set before calling
+      # the #loop method
+      
+      @trans[:chan].on_data do |ch, data|
+        if data.include?( RPC::MSG_END )
+          data.slice!( RPC::MSG_END )
+          @trans[:rx_buf] << data unless data.empty?
+          @trans[:more] = false
+        else
+          @trans[:rx_buf] << data
+        end
+      end
+      
+      # ... if there are errors ... 
+      @trans[:chan].on_extended_data do |ch, type, data|
+        @trans[:rx_err] = data
+        @trans[:more] = false
+      end
+      
+      # the #loop method is what actually performs
+      # ssh event processing ...
+      
+      @trans[:conn].loop { @trans[:more] }        
+      
+      return @trans[:rx_buf]      
+    end
+    
+    def trans_send( cmd_str )
+      @trans[:chan].send_data( cmd_str )  
+    end
+    
+    # accessor to create an Net::SCP object so the caller can perform
+    # secure-copy operations (see Net::SCP) for details
+    def scp
+      @scp ||= Net::SCP.start( @args[:target], @args[:username], :password => @args[:password] )
+    end
+    
+  end # class: SSH
+end #module: Netconf
+
+require 'net/netconf/ssh'

data/lib/net/netconf/telnet.rb

@@ -1,52 +1,52 @@
-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            
-      @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        
-      rescue NameError
-        # no extensions available ...
-      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 )
-      
-      @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() 
-      self
-    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      
-      rsp = @trans.waitfor( Netconf::RPC::MSG_END_RE )
-      rsp.chomp!( Netconf::RPC::MSG_END + "\n" )      
-    end
-    
-  end # class: Serial
-end # module: Netconf
+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            
+      @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        
+      rescue NameError
+        # no extensions available ...
+      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 )
+      
+      @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() 
+      self
+    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      
+      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

@@ -32,6 +32,14 @@ module Netconf
       
     end # initialize
     
+    def open?
+      @state == :NETCONF_OPEN
+    end
+    
+    def closed?
+      @state == :NECONF_CLOSED
+    end
+    
     def open( &block ) # :yield: specialized transport open, generally not used
       
       raise Netconf::StateError if @state == :NETCONF_OPEN
@@ -79,6 +87,7 @@ module Netconf
     # string in; string out
     def send_and_receive( cmd_str )
       trans_send( cmd_str )
+      trans_send( RPC::MSG_END )
       trans_receive()
     end
     
@@ -111,12 +120,26 @@ module Netconf
       
       rsp_nx = rsp_nx.root
             
-      # the <rpc-error> could either be at the toplevel or 
-      # as a child element of toplevel. 
+      # check for rpc-error elements.  these could be
+      # located anywhere in the structured response
       
-      if rsp_nx.xpath( "rpc-error|*/rpc-error" )[0]     
-        exception = Netconf::RPC.get_exception( cmd_nx )       
-        raise exception.new( self, cmd_nx, rsp_nx )        
+      rpc_errs = rsp_nx.xpath('//self::rpc-error')
+      if rpc_errs.count > 0
+        
+        # look for rpc-errors that have a severity == 'error'
+        # in some cases the rpc-error is generated with
+        # severity == 'warning'
+        
+        sev_err = rpc_errs.xpath('error-severity[. = "error"]')
+        
+        # if there are rpc-error with severity == 'error'
+        # 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 )
+        end        
       end        
       
       # return the XML with context at toplevel element; i.e.

data/lib/net/netconf/version.rb

@@ -0,0 +1,3 @@
+module Netconf  
+  VERSION = "0.3.0" 
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netconf
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Jeremy Schulman
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -39,11 +35,24 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 description: Extensible Ruby-based NETCONF client
 email: jschulman@juniper.net
 executables: []
@@ -64,6 +73,7 @@ files:
 - lib/net/netconf/ssh.rb
 - lib/net/netconf/telnet.rb
 - lib/net/netconf/transport.rb
+- lib/net/netconf/version.rb
 - lib/net/netconf.rb
 - examples/confd/get-running.rb
 - examples/jnpr/edit-config-jnpr-set.rb
@@ -79,28 +89,27 @@ files:
 - examples/jnpr/get-inventory-telnet.rb
 - examples/jnpr/get-inventory.rb
 - examples/jnpr/scp.rb
-homepage: https://github.com/Juniper-Workflow/net-netconf
+homepage: https://github.com/Juniper/net-netconf
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: NETCONF client
 test_files: []