rbeapi 0.1.0 → 0.2.0

data/lib/rbeapi/api/staticroutes.rb

@@ -31,16 +31,17 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
     ##
     # The Staticroute class provides a configuration instance for working
     # with static routes in EOS.
     #
     class Staticroute < Entity
-
       ##
       # Returns the static routes configured on the node
       #
@@ -57,14 +58,14 @@ module Rbeapi
       #   there are no static routes configured, this method will return
       #   an empty hash
       def getall
-        regex = %r{
+        regex = /
           (?<=^ip\sroute\s)
           ([^\s]+)\s                # captures network
           ([^\s$]+)                 # captures next hop
           (?:\s\d+)                 # non-capture metric
           (?:\stag\s\d+)            # non-catpure route tag
           [\s|$]{1}(?:name\s(.+))?  # capture route name
-        }x
+        /x
 
         routes = config.scan(regex)
 

data/lib/rbeapi/api/stp.rb

@@ -31,17 +31,16 @@
 #
 
 ##
-# PuppetX is the toplevel namespace for working with Arista EOS nodes
+# Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Eos is module namesapce for working with the EOS command API
+  # Rbeapi::Api
   module Api
     ##
     # The Stp class provides a base class instance for working with
     # the EOS spanning-tree configuration
     #
     class Stp < Entity
-
       ##
       # get returns the current stp configuration parsed from the nodes
       # current running configuration.
@@ -65,7 +64,6 @@ module Rbeapi
         response
       end
 
-
       ##
       # parse_mode scans the nodes running configuration and extracts the
       # value of the spanning-tree mode.  The spanning tree mode is
@@ -135,8 +133,11 @@ module Rbeapi
         when true
           cmd = 'default spanning-tree mode'
         when false
-          cmd = (value ? "spanning-tree mode #{value}" : \
-                         'no spanning-tree mode')
+          if value
+            cmd = "spanning-tree mode #{value}"
+          else
+            cmd = 'no spanning-tree mode'
+          end
         end
         configure cmd
       end
@@ -147,7 +148,6 @@ module Rbeapi
     # spanning-tree instances in EOS
     #
     class StpInstances < Entity
-
       DEFAULT_STP_PRIORITY = '32768'
 
       ##
@@ -215,10 +215,7 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_priority(inst)
-        priority_re = %r{
-          (?<=^spanning-tree\smst\s#{inst}\spriority\s)
-          (.+$)
-        }x
+        priority_re = /(?<=^spanning-tree\smst\s#{inst}\spriority\s)(.+$)/x
         mdata = priority_re.match(config)
         { priority: mdata.nil? ? DEFAULT_STP_PRIORITY : mdata[1] }
       end
@@ -252,8 +249,11 @@ module Rbeapi
         when true
           cmd = "default spanning-tree mst #{inst} priority"
         when false
-          cmd = (value ? "spanning-tree mst #{inst} priority #{value}" : \
-                         "no spanning-tree mst #{inst} priority")
+          if value
+            cmd = "spanning-tree mst #{inst} priority #{value}"
+          else
+            cmd = "no spanning-tree mst #{inst} priority"
+          end
         end
         configure cmd
       end
@@ -264,7 +264,6 @@ module Rbeapi
     # spanning-tree insterfaces in EOS
     #
     class StpInterfaces < Entity
-
       ##
       # get returns the configured stp interfaces from the nodes running
       # configuration as a resource hash.  If the specified interface is not
@@ -284,6 +283,7 @@ module Rbeapi
         return nil if /no switchport$/ =~ config
         response = {}
         response.merge!(parse_portfast(config))
+        response.merge!(parse_portfast_type(config))
         response.merge!(parse_bpduguard(config))
         response
       end
@@ -325,6 +325,26 @@ module Rbeapi
       end
       private :parse_portfast
 
+      ##
+      # parse_portfast_type scans the supplied interface configuration block
+      # and parses the value stp portfast type.  The value of portfast type
+      # is either not set which implies normal (default), edge, or network.
+      #
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource hash attribute
+      def parse_portfast_type(config)
+        if /spanning-tree portfast network/ =~ config
+          value = 'network'
+        elsif /no spanning-tree portfast/ =~ config
+          value = 'normal'
+        else
+          value = 'edge'
+        end
+        { portfast_type: value }
+      end
+      private :parse_portfast_type
+
       ##
       # parse_bpduguard scans the supplied interface configuration block and
       # parses the value of stp bpduguard.  The value of bpduguard is either
@@ -337,6 +357,7 @@ module Rbeapi
         val = /spanning-tree bpduguard enable/ =~ config
         { bpduguard: !val.nil? }
       end
+      private :parse_bpduguard
 
       ##
       # Configures the interface portfast value
@@ -356,12 +377,47 @@ module Rbeapi
         when true
           cmds << 'default spanning-tree portfast'
         when false
-          cmds << (value ? 'spanning-tree portfast' :
-                           'no spanning-tree portfast')
+          if value
+            cmds << 'spanning-tree portfast'
+          else
+            cmds << 'no spanning-tree portfast'
+          end
         end
         configure(cmds)
       end
 
+      ##
+      # Configures the interface portfast type value
+      #
+      # @param [String] name The name of the interface to configure
+      # @param [Hash] opts The configuration parameters for portfast type
+      # @option opts [String] :value The value to set portfast type to.
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
+      def set_portfast_type(name, opts = {})
+        value = opts[:value]
+        default = opts[:default] || false
+
+        cmds = ["interface #{name}"]
+        case default
+        when true
+          cmds << 'default spanning-tree portfast normal'
+        when false
+          cmds << "spanning-tree portfast #{value}"
+        end
+        configure(cmds)
+      end
+
+      ##
+      # Configures the interface bpdu guard value
+      #
+      # @param [String] name The name of the interface to configure
+      # @param [Hash] opts The configuration parameters for bpduguard
+      # @option opts [Boolean] :value The value to set bpduguard
+      # @option opts [Boolean] :default The value should be set to default
+      #
+      # @return [Boolean] True if the commands succeed otherwise False
       def set_bpduguard(name, opts = {})
         value = opts[:value]
         default = opts[:default] || false
@@ -371,8 +427,11 @@ module Rbeapi
         when true
           cmds << 'default spanning-tree bpduguard'
         when false
-          cmds << (value ? 'spanning-tree bpduguard enable' :
-                           'spanning-tree bpduguard disable')
+          if value
+            cmds << 'spanning-tree bpduguard enable'
+          else
+            cmds << 'spanning-tree bpduguard disable'
+          end
         end
         configure(cmds)
       end

data/lib/rbeapi/api/switchports.rb

@@ -31,16 +31,17 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Eos is module namesapce for working with the EOS command API
+  # Api is module namesapce for working with the EOS command API
   module Api
     ##
     # The Switchport class provides a base class instance for working with
     # logical layer-2 interfaces.
     #
     class Switchports < Entity
-
       ##
       # Retrieves the properies for a logical switchport from the
       # running-config using eAPI
@@ -162,8 +163,11 @@ module Rbeapi
         when true
           cmds << 'default switchport mode'
         when false
-          cmds << (value.nil? ? 'no switchport mode' : \
-                                "switchport mode #{value}")
+          if value.nil?
+            cmds << 'no switchport mode'
+          else
+            cmds << "switchport mode #{value}"
+          end
         end
         configure(cmds)
       end
@@ -195,9 +199,7 @@ module Rbeapi
         value = opts[:value]
         default = opts[:default] || false
 
-        unless value.is_a?(Array)
-          raise ArgumentError, 'value must be an Array'
-        end
+        fail ArgumentError, 'value must be an Array' unless value.is_a?(Array)
 
         value = value.map(&:inspect).join(',') if value
 
@@ -210,7 +212,7 @@ module Rbeapi
             cmds << 'no switchport trunk allowed vlan'
           else
             cmds << 'switchport trunk allowed vlan none'
-            cmds << "switchport trunk allowed vlan add #{value}"
+            cmds << "switchport trunk allowed vlan #{value}"
           end
         end
         configure(cmds)
@@ -236,8 +238,11 @@ module Rbeapi
         when true
           cmds << 'default switchport trunk native vlan'
         when false
-          cmds << (value.nil? ? 'no switchport trunk native vlan' : \
-                                "switchport trunk native vlan #{value}")
+          if value.nil?
+            cmds << 'no switchport trunk native vlan'
+          else
+            cmds << "switchport trunk native vlan #{value}"
+          end
         end
         configure(cmds)
       end
@@ -262,8 +267,11 @@ module Rbeapi
         when true
           cmds << 'default switchport access vlan'
         when false
-          cmds << (value.nil? ? 'no switchport access vlan' : \
-                                "switchport access vlan #{value}")
+          if value.nil?
+            cmds << 'no switchport access vlan'
+          else
+            cmds << "switchport access vlan #{value}"
+          end
         end
         configure(cmds)
       end

data/lib/rbeapi/api/system.rb

@@ -31,15 +31,16 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
     ##
     # The System class configures the node system services such as
     # hostname and domain name
     class System < Entity
-
       ##
       # Returns the system settings
       #
@@ -50,7 +51,7 @@ module Rbeapi
       #
       # @return [Hash]  A Ruby hash objec that provides the system settings as
       #   key/value pairs.
-      def get()
+      def get
         response = {}
         response.merge!(parse_hostname(config))
         response
@@ -77,8 +78,7 @@ module Rbeapi
         when true
           cmds = ['default hostname']
         when false
-          cmds = (value.nil? ? 'no hostname' : \
-                               "hostname #{value}")
+          cmds = (value.nil? ? 'no hostname' : "hostname #{value}")
         end
         configure(cmds)
       end

data/lib/rbeapi/api/tacacs.rb

@@ -31,16 +31,16 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Eos is module namesapce for working with the EOS command API
+  # Api is module namesapce for working with the EOS command API
   module Api
-
     ##
     # Tacacs provides instance methods to retrieve and set tacacs configuration
     # values.
     class Tacacs < Entity
-
       DEFAULT_KEY_FORMAT = 0
       DEFAULT_KEY = nil
 
@@ -192,10 +192,13 @@ module Rbeapi
 
         case default
         when true
-            cmds = 'default tacacs-server timeout'
+          cmds = 'default tacacs-server timeout'
         when false
-            cmds = value ? "tacacs-server timeout #{value}" :
-                           'no tacacs-server timeout'
+          if value
+            cmds = "tacacs-server timeout #{value}"
+          else
+            cmds = 'no tacacs-server timeout'
+          end
         end
         configure cmds
       end

data/lib/rbeapi/api/varp.rb

@@ -31,15 +31,16 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
     ##
     # The Varp class provides an instance for working with the global
     # VARP configuration of the node
     class Varp < Entity
-
       ##
       # Returns the global VARP configuration from the node
       #
@@ -54,10 +55,8 @@ module Rbeapi
       def get
         response = {}
 
-        regex = %r{
-          (?<=^ip\svirtual-router\smac-address\s)
-          ((?:[a-f0-9]{2}:){5}[a-f0-9]{2})$
-        }x
+        regex = /(?<=^ip\svirtual-router\smac-address\s)
+          ((?:[a-f0-9]{2}:){5}[a-f0-9]{2})$/x
 
         mdata = regex.match(config)
         response['mac_address'] = mdata.nil? ? '' : mdata[1]
@@ -87,13 +86,19 @@ module Rbeapi
         when true
           cmds = ['default ip virtual-router mac-address']
         when false
-          cmds = (value ? "ip virtual-router mac-address #{value}" : \
-                          'no ip virtual-router mac-address')
+          if value
+            cmds = "ip virtual-router mac-address #{value}"
+          else
+            cmds = 'no ip virtual-router mac-address'
+          end
         end
         configure(cmds)
       end
     end
 
+    ##
+    # The VarpInterfaces class provides an instance for working with the global
+    # VARP interface configuration of the node
     class VarpInterfaces < Entity
       ##
       # Returns a single VARP interface configuration
@@ -165,7 +170,7 @@ module Rbeapi
             return result unless result
           end
         end
-        return true
+        true
       end
 
       def add_address(name, value)

data/lib/rbeapi/api/vlans.rb

@@ -31,12 +31,12 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
   ##
   # Api is module namesapce for working with the EOS command API
   module Api
-
     ##
     # The Vlan class provides a class implementation for working with the
     # collection of Vlans on the node.  This class presents an abstraction
@@ -44,7 +44,6 @@ module Rbeapi
     #
     # @eos_version 4.13.7M
     class Vlans < Entity
-
       ##
       # get returns the specified vlan resource Hash that represents the
       # nodes current vlan configuration.
@@ -106,7 +105,7 @@ module Rbeapi
       #
       # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_name(config)
-        mdata = /name (\w+)$/.match(config)
+        mdata = /name ([^\s]+)$/.match(config)
         { name: mdata[1] }
       end
       private :parse_name
@@ -236,7 +235,7 @@ module Rbeapi
         when true
           cmds << 'default name'
         when false
-          cmds << (value.nil? ?  'no name' : "name #{value}")
+          cmds << (value.nil? ? 'no name' : "name #{value}")
         end
         configure(cmds)
       end
@@ -278,7 +277,7 @@ module Rbeapi
         default = opts[:default] || false
 
         unless ['active', 'suspend', nil].include?(value)
-          raise ArgumentError, 'state must be active, suspend or nil'
+          fail ArgumentError, 'state must be active, suspend or nil'
         end
 
         cmds = ["vlan #{id}"]

data/lib/rbeapi/api.rb

@@ -31,20 +31,24 @@
 #
 require 'rbeapi/eapilib'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
+    ##
+    # The Entity class provides a base class implementation for building
+    # API modules.  The Entity class is typcially not instantiated directly
+    # but serves as a super class with convenience methods used to
+    # work with the node.
     class Entity
-
       attr_reader :error
       attr_reader :config
       attr_reader :node
 
       ##
-      # The instance class method is used to create a new instance of the
-      # object.  It works in conjunction with the Node.api loader method
-      # to make it easy to load classes derived from Entity
+      # Construct the node.
       #
       # @param [Node] :node An instance of Rbeapi::Client::Node used to
       #   send and receive eAPI messages
@@ -61,7 +65,7 @@ module Rbeapi
       # @param [Node] :node This should be an instance of Rbeapi::Client::Node
       #   that is used to send and receive eAPI messages
       #
-      def initialize(node, opts = {})
+      def initialize(node)
         @node = node
       end
 
@@ -72,7 +76,7 @@ module Rbeapi
       #
       # @return [String] The current running-config from the node
       def config
-        return @node.running_config
+        @node.running_config
       end
 
       ##
@@ -82,7 +86,7 @@ module Rbeapi
       # @return [Rbeapi::Eapilib::CommandError] An instance of CommandError
       #   that can be used to futher evaluate the root cause of an error
       def error
-        return @node.connection.error
+        @node.connection.error
       end
 
       ##
@@ -105,7 +109,7 @@ module Rbeapi
         return nil unless mdata
 
         _, block_end = mdata.offset(0)
-        block_end = block_end - block_start
+        block_end -= block_start
 
         config[block_start, block_end]
       end
@@ -122,14 +126,50 @@ module Rbeapi
       #   returns False if there was an error issuing the commands on the
       #   node.  Use error to further investigate the cause of any errors
       def configure(commands)
-        begin
-          @node.config(commands)
-          return true
-        rescue Rbeapi::Eapilib::CommandError, Rbeapi::Eapilib::ConnectionError
-          return false
+        @node.config(commands)
+        return true
+      rescue Rbeapi::Eapilib::CommandError, Rbeapi::Eapilib::ConnectionError
+        return false
+      end
+
+      ##
+      # command_builder builds the correct version of a command based on the
+      # configuration options.  If the value option is not provided then the
+      # no keyword is used to build the command.  If the default value is
+      # provided and set to true, then the default keyword is used.  If both
+      # options are provided, then the default option will take precedence.
+      #
+      # @return [String]
+      def command_builder(cmd, opts = {})
+        value = opts[:value]
+        default = opts.fetch(:default, false)
+        case default
+        when true then "default #{cmd}"
+        when false
+          case value
+          when nil, false then "no #{cmd}"
+          when true then cmd
+          else "#{cmd} #{value}"
+          end
         end
       end
+
+      ##
+      # configure_interface sends the commands over eAPI to the desitnation
+      # node to configure a specific interface.
+      #
+      # @param [String] :name The interface name to apply the configuration
+      #   to.  The name value must be the full interface identifier
+      #
+      # @param [Array] :commands The list of commands to configure the
+      #   interface
+      #
+      # @return [Boolean] Returns true if the commands complete successfully
+      def configure_interface(name, commands)
+        commands = [*commands]
+        commands.insert(0, "interface #{name}")
+        configure commands
+      end
     end
   end
 end
-