rbeapi 0.1.0 → 0.2.0

data/lib/rbeapi/api/ipinterfaces.rb

@@ -31,14 +31,16 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
     #
     # The Ipinterface class provides an instance for managing logical
     # IP interfaces configured using eAPI.
     class Ipinterfaces < Entity
-
       DEFAULT_ADDRESS = ''
 
       ##
@@ -125,7 +127,7 @@ module Rbeapi
       # @return [Hash<Symbol, Object>] resource hash attribute
       def parse_mtu(config)
         mdata = /(?<=mtu\s)(\d+)$/.match(config)
-        { mtu: mdata.nil? ? '': mdata[1] }
+        { mtu: mdata.nil? ? '' : mdata[1] }
       end
       private :parse_mtu
 

data/lib/rbeapi/api/logging.rb

@@ -31,12 +31,15 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
+    ##
+    # The Logging class manages logging settings on an EOS node.
     class Logging < Entity
-
       ##
       # get returns the current logging configuration hash extracted from the
       # nodes running configuration.
@@ -97,8 +100,8 @@ module Rbeapi
       #
       # @param [Hash] :opts Optional keyword arguments
       #
-      # @option :opts [Boolean] :value Enables logging globally if value is true or
-      #   disabled logging glboally if value is false
+      # @option :opts [Boolean] :value Enables logging globally if value is true
+      #   or disabled logging glboally if value is false
       #
       # @option :opts [Boolean] :default Configure the ip address value using
       #   the default keyword

data/lib/rbeapi/api/mlag.rb

@@ -31,48 +31,51 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
     ##
     # The Mlag class provides a configuration instance for working with
     # the global MLAG configuration of the node
     class Mlag < Entity
-
       DEFAULT_DOMAIN_ID = ''
       DEFAULT_LOCAL_INTF = ''
       DEFAULT_PEER_ADDR = ''
       DEFAULT_PEER_LINK = ''
 
       ##
-      # get returns the mlag configuration from the node as a resource hash
+      # get scans the current nodes configuration and returns the values as
+      # a Hash descriping the current state.
       #
-      # @example
-      #   {
-      #     domain_id: <string>
-      #     local_interface: <string>
-      #     peer_address: <string>
-      #     peer_link: <string>
-      #     shutdown: [true, false]
-      #     interfaces: {...}
-      #   }
+      # The resource hash returned contains the following:
+      #   * domain_id: (String) The MLAG domain-id value
+      #   * local_interface: (String) The MLAG local-interface value
+      #   * peer_address: (String) The IP address of the MLAG peer
+      #   * peer_link: (String) The MLAG transit peer-link value
+      #   * shutdown: (Boolean) The administrative staet of the mlag
+      #     configuration
+      #   * interfaces: (Hash) The list of configured MLAG interfaces.  (See
+      #     parse_interfaces for the Hash details)
       #
-      # @see MlagInterfaces interface resource message
+      # @see parse_interfaces
       #
       # @return [nil, Hash<Symbol, Object] returns the nodes current running
       #   configuration as a Hash.  If mlag is not configured on the node this
       #   method will return nil
-      def get()
+      def get
         config = get_block('mlag configuration')
-        response = {}
-        response.merge!(parse_domain_id(config))
-        response.merge!(parse_local_interface(config))
-        response.merge!(parse_peer_address(config))
-        response.merge!(parse_peer_link(config))
-        response.merge!(parse_shutdown(config))
-        response[:interfaces] = interfaces.getall
-        response
+
+        global = {}
+        global.merge!(parse_domain_id(config))
+        global.merge!(parse_local_interface(config))
+        global.merge!(parse_peer_address(config))
+        global.merge!(parse_peer_link(config))
+        global.merge!(parse_shutdown(config))
+
+        { global: global, interfaces: parse_interfaces }
       end
 
       ##
@@ -166,18 +169,27 @@ module Rbeapi
       private :parse_shutdown
 
       ##
-      # interfaces returns a memoized instance of MlagInterfaces that provide
-      # an api for working with mlag interfaces in the nodes current
-      # configuration.
+      # parse_interfaces scans the global configuraiton and returns all of the
+      # configured MLAG interfaces.  Each interface returns the configured MLAG
+      # identifier for establishing a MLAG peer.  The return value is intended
+      # to be merged into the resource Hash
       #
-      # @see MlagInterfaces
+      # The resource Hash attribute returned contains:
+      #   * mlag_id: (Fixnum) The configured MLAG identifier
       #
-      # @return [Object] returns an instance of MlagInterfaces
-      def interfaces
-        return @interfaces if @interfaces
-        @interfaces = MlagInterfaces.new(node)
-        @interfaces
+      # @api private
+      #
+      # @return [Hash<Symbol, Object>] resource Hash attribute
+      def parse_interfaces
+        names = config.scan(/(?<=^interface\s)Po.+/)
+        names.each_with_object({}) do |name, hsh|
+          config = get_block("^interface #{name}")
+          next unless config
+          id = config.scan(/(?<=mlag )\d+/)
+          hsh[name] = { mlag_id: id.first.to_i } unless id.empty?
+        end
       end
+      private :parse_interfaces
 
       ##
       # set_domain_id configures the mlag domain-id value in the current nodes
@@ -377,100 +389,6 @@ module Rbeapi
         end
         configure(cmds)
       end
-    end
-
-    class MlagInterfaces < Entity
-
-      ##
-      # get returns the mlag interface configuration as a hash object.  If the
-      # specified interface name is not configured as an mlag interface this
-      # method will return nil
-      #
-      # @example
-      #   {
-      #     mlag_id: <string>
-      #   }
-      #
-      # @param [String] :name The full interface name of the interface to
-      #   return the mlag interface hash for.
-      #
-      # @return [nil, Hash<Symbol, Object>] returns the interface configuration
-      #   as a resource hash.  If the interface is not configured as an mlag
-      #   interface nil is returned.
-      def get(name)
-        config = get_block("^interface #{name}")
-        return nil unless config
-        mdata = /(?<=\s{3}mlag\s)(.+)$/.match(config)
-        return nil unless mdata
-        { mlag_id: mdata[1] }
-      end
-
-      ##
-      # getall scans the nodes current running configuration and returns a
-      # hash of all mlag interfaces keyed by the interface name.  If no
-      # interfaces are configured, an empty hash object is returned
-      #
-      # @see get Interface resource example
-      #
-      # @return [Hash<String, Hash>] returns the nodes mlag interface
-      #   configurations as a hash
-      def getall
-        names = config.scan(/(?<=^interface\s)Po.+/)
-        names.each_with_object({}) do |name, response|
-          data = get name
-          response[name] = data if data
-        end
-      end
-
-      ##
-      # create adds a new mlag interface to the nodes current running
-      # configuration.  If the specified interface already exists, then this
-      # method will return successfully with the updated mlag id.
-      #
-      # @see set_mlag_id
-      #
-      # @param [String] :name The name of of the interface to create.  The name
-      #   must be the full interface name.  The value of name is expected to
-      #   be a Port-Channel interface.
-      #
-      # @param [String, Integer] :id The value of the mlag id to configure for
-      #   the specified interface.  Valid mlag ids are in the range of 1 to
-      #   2000.
-      #
-      # @return [Boolean] returns true if the command completed successfully
-      def create(name, id)
-        set_mlag_id(name, value: id)
-      end
-
-      ##
-      # delete removes a mlag interface from the nodes current running
-      # configuration.  If the specified interface does not exist as a mlag
-      # interface this method will return successfully
-      #
-      # @see set_mlag_id
-      #
-      # @param [String] :name The name of of the interface to remove.  The name
-      #   must be the full interface name.
-      #
-      # @return [Boolean] returns true if the command completed successfully
-      def delete(name)
-        set_mlag_id(name)
-      end
-
-      ##
-      # default configures a mlag interface using the default keyword.  If the
-      # specified interface does not exist as a mlag interface this method
-      # will return successfully
-      #
-      # @see set_mlag_id
-      #
-      # @param [String] :name The name of of the interface to create.  The name
-      #   must be the full interface name.
-      #
-      # @return [Boolean] returns true if the command completed successfully
-      def default(name)
-        set_mlag_id(name, default: true)
-      end
 
       ##
       # set_mlag_id configures the mlag id on the interface in the nodes
@@ -510,7 +428,7 @@ module Rbeapi
         when true
           cmds << 'default mlag'
         when false
-          cmds << (value ? "mlag #{value}"  : 'no mlag')
+          cmds << (value ? "mlag #{value}" : 'no mlag')
         end
         configure(cmds)
       end

data/lib/rbeapi/api/ntp.rb

@@ -37,12 +37,10 @@ module Rbeapi
   ##
   # Api is module namesapce for working with the EOS command API
   module Api
-
     ##
     # The Ntp class provides an intstance for working with the nodes
     # NTP configuraiton.
     class Ntp < Entity
-
       DEFAULT_SRC_INTF = ''
 
       ##
@@ -130,8 +128,7 @@ module Rbeapi
         when true
           cmds = 'default ntp source'
         when false
-          cmds = (value ? "ntp source #{value}" : \
-                          'no ntp source')
+          cmds = (value ? "ntp source #{value}" : 'no ntp source')
         end
         configure(cmds)
       end

data/lib/rbeapi/api/ospf.rb

@@ -31,18 +31,21 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
     ##
     # The Ospf class is a global class that provides an instance for working
     # with the node's OSPF configuration
     class Ospf < Entity
-
       ##
       # Returns the global OSPF configuration from the node
       #
+      # rubocop:disable Metrics/MethodLength
+      #
       # @example
       #   {
       #     "router_id": <string>
@@ -58,11 +61,10 @@ module Rbeapi
         config = get_block("router ospf #{inst}")
         return nil unless config
 
-        resp = {}
+        response = {}
         mdata = /(?<=^\s{3}router-id\s)(.+)$/.match(config)
-        resp['router_id'] = mdata.nil? ? '' : mdata[0]
+        response['router_id'] = mdata.nil? ? '' : mdata[0]
 
-        mdata = /^\s{3}network\s(.+)\sarea\s(.+)$/.match(config)
         networks = config.scan(/^\s{3}network\s(.+)\sarea\s(.+)$/)
         areas = networks.each_with_object({}) do |cfg, hsh|
           net, area = cfg
@@ -72,14 +74,15 @@ module Rbeapi
             hsh[area] = [net]
           end
         end
-        resp['areas'] = areas
+        response['areas'] = areas
 
-        values = config.scan(/(?<=^\s{3}redistribute\s)(\w+)[\s|$]*(route-map\s(.+))?/)
+        values = \
+          config.scan(/(?<=^\s{3}redistribute\s)(\w+)[\s|$]*(route-map\s(.+))?/)
 
-        resp['redistribute'] = values.each_with_object({}) do |value, hsh|
+        response['redistribute'] = values.each_with_object({}) do |value, hsh|
           hsh[value[0]] = { 'route_map' => value[2] }
         end
-        resp
+        response
       end
 
       ##
@@ -91,8 +94,6 @@ module Rbeapi
       #   "interfaces": {...}
       # }
       def getall
-        response = {}
-
         instances = config.scan(/(?<=^router\sospf\s)\d+$/)
         response = instances.each_with_object({}) do |inst, hsh|
           hsh[inst] = get inst
@@ -145,8 +146,10 @@ module Rbeapi
       end
     end
 
+    ##
+    # The OspfInterfaces class is a global class that provides an instance
+    # for working with the node's OSPF interface configuration
     class OspfInterfaces < Entity
-
       ##
       # Returns a single MLAG interface configuration
       #

data/lib/rbeapi/api/prefixlists.rb

@@ -31,16 +31,17 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
     ##
     # The Prefixlists class provides a configuration instance for working
     # with static routes in EOS.
     #
     class Prefixlists < Entity
-
       ##
       # Returns the static routes configured on the node
       #
@@ -92,7 +93,6 @@ module Rbeapi
         cmd << " seq #{seq}" if seq
         configure cmd
       end
-
     end
   end
 end

data/lib/rbeapi/api/radius.rb

@@ -31,16 +31,16 @@
 #
 require 'rbeapi/api'
 
-
+##
+# Rbeapi toplevel namespace
 module Rbeapi
   ##
-  # Eos is module namesapce for working with the EOS command API
+  # Rbeapi::Api
   module Api
     ##
     # Radius provides instance methods to retrieve and set radius configuration
     # values.
     class Radius < Entity
-
       DEFAULT_KEY_FORMAT = 0
       DEFAULT_KEY = nil
 
@@ -164,11 +164,11 @@ module Rbeapi
       private :parse_servers
 
       ##
-      # set_global_key configures the global radius-server key.  If the value option
-      # is not specified, radius-server key is configured using the no keyword.
-      # If the default option is specified, radius-server key is configured
-      # using the default keyword.  If both options are specified, the default
-      # keyword option takes precedence.
+      # set_global_key configures the global radius-server key.  If the value
+      # option is not specified, radius-server key is configured using the no
+      # keyword. If the default option is specified, radius-server key is
+      # configured using the default keyword. If both options are specified,
+      # the default keyword option takes precedence.
       #
       # @eos_version 4.13.7M
       #
@@ -197,18 +197,21 @@ module Rbeapi
         when true
           cmds = 'default radius-server key'
         when false
-          cmds = value ? "radius-server key #{key_format} #{value}" :
-                         'no radius-server key'
+          if value
+            cmds = "radius-server key #{key_format} #{value}"
+          else
+            cmds = 'no radius-server key'
+          end
         end
         configure cmds
       end
 
       ##
-      # set_global_timeout configures the radius-server timeout value.  If the value
-      # options is not specified, radius-server timeout is configured using the
-      # no keyword.  If the default option is specified, radius-server timeout
-      # is configured using the default keyword.  If both options are specified
-      # then the default keyword takes precedence.
+      # set_global_timeout configures the radius-server timeout value.  If the
+      # value # options is not specified, radius-server timeout is configured
+      # using the no keyword.  If the default option is specified, radius-server
+      # timeout is configured using the default keyword.  If both options are
+      # specified then the default keyword takes precedence.
       #
       # @eos_version 4.13.7M
       #
@@ -233,19 +236,22 @@ module Rbeapi
         when true
           cmds = 'default radius-server timeout'
         when false
-          cmds = value ? "radius-server timeout #{value}" :
-                         'no radius-server timeout'
+          if value
+            cmds = "radius-server timeout #{value}"
+          else
+            cmds = 'no radius-server timeout'
+          end
         end
         configure cmds
       end
 
       ##
-      # set_global_retransmit configures the global radius-server restransmit value.
-      # If the value is not specified, the radius-server retransmist value is
-      # configured using the no keyword.  If the default option is specified,
-      # the radius-server retransmit value is configured using the default
-      # keyword.  If both options are specified then the default keyword taks
-      # precedence
+      # set_global_retransmit configures the global radius-server restransmit
+      # value. If the value is not specified, the radius-server retransmist
+      # value is configured using the no keyword.  If the default option is
+      # specified, the radius-server retransmit value is configured using the
+      # default keyword. If both options are specified then the default keyword
+      # takes precedence
       #
       # @eos_version 4.13.7M
       #
@@ -270,8 +276,11 @@ module Rbeapi
         when true
           cmds = 'default radius-server retransmit'
         when false
-          cmds = value ?  "radius-server retransmit #{value}" :
-                          'no radius-server retransmit'
+          if value
+            cmds = "radius-server retransmit #{value}"
+          else
+            cmds = 'no radius-server retransmit'
+          end
         end
         configure cmds
       end

data/lib/rbeapi/api/routemaps.rb

@@ -31,12 +31,21 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
+  ##
+  # Rbeapi::Api
   module Api
-
+    ##
+    # The Routemaps class manages routemaps. A route map is a list of rules
+    # that control the redistribution of IP routes into a protocol domain on
+    # the basis of such criteria as route metrics, access control lists, next
+    # hop addresses, and route tags.
+    #
+    # rubocop:disable Metrics/MethodLength
+    #
     class Routemaps < Entity
-
       def get(name)
         entries = config.scan(/^route-map\s#{name}\s.+$/)
 
@@ -52,13 +61,13 @@ module Rbeapi
             case mdata.nil? ? nil : mdata[1]
             when 'match'
               hsh['match_rules'] = [] unless hsh.include?('match')
-              hsh['match_rules'] << rule.strip()
+              hsh['match_rules'] << rule.strip
             when 'set'
               hsh['set_rules'] = [] unless hsh.include?('set')
-              hsh['set_rules'] << rule.strip()
+              hsh['set_rules'] << rule.strip
             when 'continue'
               hsh['continue_rules'] = [] unless hsh.include?('continue')
-              hsh['continue_rules'] << rule.strip()
+              hsh['continue_rules'] << rule.strip
             end
           end
           rule_hsh.update(parsed)
@@ -69,9 +78,7 @@ module Rbeapi
       def getall
         maps = config.scan(/(?<=^route-map\s)[^\s]+/)
         maps.each_with_object({}) do |name, hsh|
-          if !hsh.include?(name)
-            hsh[name] = get name
-          end
+          hsh[name] = get name unless hsh.include?(name)
         end
       end
 
@@ -94,7 +101,6 @@ module Rbeapi
       def remove_rule(name, action, seqno)
         configure "no route-map #{name} #{action} #{seqno}"
       end
-
     end
   end
 end

data/lib/rbeapi/api/snmp.rb

@@ -31,20 +31,21 @@
 #
 require 'rbeapi/api'
 
+##
+# Rbeapi toplevel namespace
 module Rbeapi
-
   ##
   # Api is module namespace for working with eAPI abstractions
   module Api
-
     ##
     # The Snmp class provides a class implementation for working with the
     # nodes SNMP conifguration entity.  This class presents an abstraction
     # of the node's snmp configuration from the running config.
     #
+    # rubocop:disable Metrics/ClassLength
+    #
     # @eos_version 4.13.7M
     class Snmp < Entity
-
       DEFAULT_SNMP_LOCATION = ''
       DEFAULT_SNMP_CONTACT = ''
       DEFAULT_SNMP_CHASSIS_ID = ''
@@ -172,7 +173,7 @@ module Rbeapi
 
         notifications = traps.map do |trap|
           state, name = trap
-          { name: name, state: CFG_TO_STATE[state]}
+          { name: name, state: CFG_TO_STATE[state] }
         end
         notifications << { name: 'all', state: CFG_TO_STATE[all.first] }
         { notifications: notifications }
@@ -238,8 +239,11 @@ module Rbeapi
         when true
           cmds = ['default snmp-server location']
         when false
-          cmds = (value.nil? ? "no snmp-server location" : \
-                               "snmp-server location #{value}")
+          if value.nil?
+            cmds = 'no snmp-server location'
+          else
+            cmds = "snmp-server location #{value}"
+          end
         end
         configure(cmds)
       end
@@ -275,8 +279,11 @@ module Rbeapi
         when true
           cmds = ['default snmp-server contact']
         when false
-          cmds = (value.nil? ? "no snmp-server contact" : \
-                               "snmp-server contact #{value}")
+          if value.nil?
+            cmds = 'no snmp-server contact'
+          else
+            cmds = "snmp-server contact #{value}"
+          end
         end
         configure(cmds)
       end
@@ -312,8 +319,11 @@ module Rbeapi
         when true
           cmds = 'default snmp-server chassis-id'
         when false
-          cmds = (value.nil? ? "no snmp-server chassis-id" : \
-                               "snmp-server chassis-id #{value}")
+          if value.nil?
+            cmds = 'no snmp-server chassis-id'
+          else
+            cmds = "snmp-server chassis-id #{value}"
+          end
         end
         configure(cmds)
       end
@@ -350,10 +360,13 @@ module Rbeapi
         when true
           cmds = ['default snmp-server source-interface']
         when false
-          cmds = (value.nil? ? "no snmp-server source-interface" : \
-                               "snmp-server source-interface #{value}")
+          if value.nil?
+            cmds = 'no snmp-server source-interface'
+          else
+            cmds = "snmp-server source-interface #{value}"
+          end
         end
-       configure(cmds)
+        configure(cmds)
       end
 
       ##