sloe 0.4.0 → 0.5.0

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 This gem augments the functionality of Netconf::SSH, Net::SCP and SNMP gems. Please refer to those gem's documentation or detailed instruction on how to use this gem.
 
-All Netconf methods are accessed via the rpc() method. All Net::SCP methods are access via the scp() method. All SNMP methods are accessed via the snmp() method. For example:
+All Netconf methods are accessed via the `rpc()` method. All Net::SCP methods are access via the `scp()` method. All SNMP methods are accessed via the `snmp()` method. For example:
 
     require 'sloe'
 
@@ -54,16 +54,30 @@ An alternate way to use this module is:
     puts device.snmp.get_value('sysDescr.0')
     
 
-All options supported by Netconf, Net::SCP and SNMP are supported in this gem too. The :target option is aliased to the SNMP :host option so there is no need to duplicate that option key.
+All options supported by Netconf, Net::SCP and SNMP are supported in this gem too. The `:target` Netconf::SSH option is aliased to the SNMP `:host` option so there is no need to duplicate that option key.
 
 ## Vendor specific Netconf extensions
 
-Sloe supports vendor specific Netconf extensions. To add that vendor specific support call new() on one of the supported classes. Sloe supports the following:
+Sloe supports vendor specific Netconf extensions. To add that vendor specific support call `new()` on one of the supported classes. Sloe supports the following:
 
 *Sloe::Device - no vendor specific Netconf extensions added
 *Sloe::Junos - Junos vendor specific Netconf extensions added
 
-Just simply call Sloe::Junos.new() to get the Junos extensions added
+Just simply call `Sloe::Junos.new()` to get the Junos extensions added
+
+### Junos specific extension
+
+For Junos specific Netconf extensions please refer to the [Juniper webiste](http://www.juniper.net/techpubs/en_US/junos12.3/information-products/topic-collections/netconf-guide/index.html)
+
+As well as supporting Junos specific Netconf RPCs Sloe::Junos also supports the `cli()` method. This method allows you to execute CLI commands on the Juniper device. For example
+
+    device.cli("show version")
+    device.cli("show ospf interfaces")
+
+By default this call will respond with an XML result tree fragment, a Nokogiri::XML object. To get what you would see on the CLI modify the `cli()` call with the `:format => 'text'` attribute and chain the Nokogiri `text()` method. Here is an example that will return just the output from "show version"
+
+    device.cli("show version", :format => 'text').text
+
 
 ## SUPPORT
 

data/lib/sloe/junos.rb

@@ -4,20 +4,12 @@ require 'sloe/common'
 module Sloe
   class Junos < Sloe::Common
 
-    # attr_reader :snmp
-
     def initialize(args, &block)
-      # @snmp_args = {:host => args[:target], :mib_dir => args[:mib_dir], :mib_modules => args[:mib_modules]}
-      # @snmp = SNMP::Manager.new(@snmp_args)
-      
-      # if block_given?
         super( args, &block )
-        # return
-      # else
-        # super(args)
-        # self.open
-        # self
-      # end
+    end
+
+    def cli(cmd_str, attrs = nil)
+      self.rpc.command(cmd_str, attrs)
     end
   end
 end

data/lib/sloe/version.rb

@@ -1,3 +1,3 @@
 module Sloe
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/methods_spec.rb

@@ -13,7 +13,7 @@ describe Sloe do
       :mib_modules => ["SNMPv2-SMI", "SNMPv2-MIB", "IF-MIB", "IP-MIB", "TCP-MIB", "UDP-MIB"].concat(@jnx_mibs)
     }
 
-    @dut = Sloe::Device.new(@args)
+    @dut = Sloe::Junos.new(@args)
   end
 
   context "SNMP API" do
@@ -64,4 +64,13 @@ describe Sloe do
       File.delete('/var/tmp/test')
     end
   end
+
+  context "CLI API" do
+    it "cli.('show version') functions without error" do
+      lambda { @dut.cli("show version") }.should_not raise_error
+    end
+    it "cli.('show version') contains OS information" do
+      @dut.cli("show version").text.should =~ /JUNOS Base OS/
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sloe
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors: