net-netconf 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b84dffc3bef4a7c78fa7c383945452a1319f186c
-  data.tar.gz: 850b49f0af7e175a8590f7ef447a3d712d81cc4b
+  metadata.gz: 882b8dffb9e72058c0cfc8d9d245d2a33c445e94
+  data.tar.gz: 6965b0162647568257b9d7f413faf8cc99952301
 SHA512:
-  metadata.gz: ee2f9173a0d140b1a1120b52ada2ea4f4fcc880ee83d1320ff569c10c069a81f17e0c8157247756b58ba7452d7888165311042905d2eafbd9e82a4709d488cfc
-  data.tar.gz: 9b2605221513738aa169b05c828b5dbbecc4578d1590a0ae8a8abf4a22eb70832d27e342492aef141cabd7f562c2817733d17be505c29a4e0b0fd91b103f30b2
+  metadata.gz: f74d7e05706421321cc163259181dbb05321440787663a823af37c79c5b70e0b63737cd4cac6912a8ab69c0d4a42f701d93ea4afc4a5c95ac8a567a9b36595dc
+  data.tar.gz: f079cf1748209eb9df67c347c1c225fab5bb2a0d4aae43667dfa759b327e51fd5d1c21dc16edd48b929f553622d598950f5a54b4fa5ba1b8272af7ec8a571f6d

data/lib/net/netconf/rpc_std.rb

@@ -1,9 +1,9 @@
-module Netconf  
+module Netconf
   module RPC
-    
-    MSG_END = "]]>]]>"
+
+    MSG_END = ']]>]]>'
     MSG_END_RE = /\]\]>\]\]>[\r\n]*$/
-    MSG_CLOSE_SESSION = '<rpc><close-session/></rpc>'       
+    MSG_CLOSE_SESSION = '<rpc><close-session/></rpc>'
     MSG_HELLO = <<-EOM
 <hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
   <capabilities>
@@ -13,55 +13,55 @@ module Netconf
 EOM
 
   module Standard
-    
-    def lock( target )      
+
+    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 )      
+      @trans.rpc_exec( rpc )
     end
-    
+
     def unlock( target )
       rpc = Nokogiri::XML( "<rpc><unlock><target><#{target}/></target></unlock></rpc>" ).root
-      @trans.rpc_exec( rpc )          
+      @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 )          
+      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 )                
+      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 )          
+      @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/ 
+        when /^Nokogiri/
           filter = case arg
             when Nokogiri::XML::Builder  then arg.doc.root
             when Nokogiri::XML::Document then arg.root
             else arg
-            end    
+            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' ) {
@@ -69,37 +69,37 @@ EOM
           }
         }
       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
+
+      @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/ 
+        when /^Nokogiri/
           config = case arg
             when Nokogiri::XML::Builder  then arg.doc.root
             when Nokogiri::XML::Document then arg.root
             else arg
-            end    
+            end
         when 'Hash' then options = arg
         when 'String' then target = arg
         end
       end
-      
+
       toplevel = options[:toplevel] if options[:toplevel]
 
       rpc_str = <<-EO_RPC
@@ -112,7 +112,7 @@ EOM
 EO_RPC
 
       rpc = Nokogiri::XML( rpc_str ).root
-      
+
       if block_given?
         Nokogiri::XML::Builder.with(rpc.at( toplevel )){ |xml|
           yield( xml )
@@ -120,14 +120,14 @@ EO_RPC
       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    
-        
+        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: RPC
 end # module: Netconf

data/lib/net/netconf/transport.rb

@@ -12,145 +12,146 @@
 
 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_message_id = 1
-      
+
       if block_given?
         open( &block = nil )      # do not pass this block to open()
         yield self
         close()
       end
-      
+
     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
-      
+
       # 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.remove_namespaces!
-            
+
       @capabilities = hello_rsp.xpath('//capability').map{ |c| c.text }
       @session_id = hello_rsp.xpath('//session-id').text
-            
-      # send the <hello> 
+
+      # send the <hello>
       trans_send_hello()
-      
-      @state = :NETCONF_OPEN            
-      self      
+
+      @state = :NETCONF_OPEN
+      self
     end
-    
+
     def trans_receive_hello
       trans_receive()
     end
-    
+
     def trans_send_hello
       trans_send( Netconf::RPC::MSG_HELLO )
+      trans_send( RPC::MSG_END )
     end
-    
+
     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         
+      raise Netconf::StateError unless @state == :NETCONF_OPEN
       trans_close()
-      @state = :NETCONF_CLOSED            
+      @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()
     end
-    
+
     def rpc_exec( cmd_nx )
-      raise Netconf::StateError unless @state == :NETCONF_OPEN         
-      
+      raise Netconf::StateError unless @state == :NETCONF_OPEN
+
       # add the mandatory message-id and namespace to the RPC
-      
+
       rpc_nx = cmd_nx.parent.root
       rpc_nx.default_namespace = Netconf::NAMESPACE
       rpc_nx['message-id'] = @rpc_message_id.to_s
       @rpc_message_id += 1
-      
-      # send the XML command through the transport and 
+
+      # send the XML command through the transport and
       # 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 ))
-      
+
       # the following removes only the default namespace (xmlns)
       # definitions from the document.  This is an alternative
       # to using #remove_namespaces! which would remove everything
-      # including vendor specific namespaces.  So this approach is a 
-      # nice "compromise" ... just don't know what it does 
+      # including vendor specific namespaces.  So this approach is a
+      # nice "compromise" ... just don't know what it does
       # performance-wise on large datasets.
 
       rsp_nx.traverse{ |n| n.namespace = nil }
-      
+
       # set the response context to the root node; <rpc-reply>
-      
+
       rsp_nx = rsp_nx.root
-            
+
       # check for rpc-error elements.  these could be
       # located anywhere in the structured response
-      
+
       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 )       
+          exception = Netconf::RPC.get_exception( cmd_nx )
           raise exception.new( self, cmd_nx, rsp_nx )
-        end        
-      end        
-      
+        end
+      end
+
       # return the XML with context at toplevel element; i.e.
       # after the <rpc-reply> element
       # @@@/JLS: might this be <ok> ? isn't for Junos, but need to check
       # @@@/JLS: the generic case.
-      
+
       rsp_nx.first_element_child
-      
+
     end
-    
 
-  end #--class: Transport  
+
+  end #--class: Transport
 end #--module: Netconf

data/lib/net/netconf/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-netconf
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kevin Kirsche
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Ruby NetConf client
+description: Updated and maintained fork of the Juniper Ruby NetConf client
 email: kev.kirsche@gmail.com
 executables: []
 extensions: []
@@ -112,5 +112,5 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: NetConf client
+summary: Updated NetConf client
 test_files: []