rbeapi 0.1.0

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/backup/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,25 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'net_http_unix'
+gem 'inifile'
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'guard-shell'
+end
+
+group :development, :test do
+  gem 'rake', '~> 10.1.0'
+  gem 'rspec', '~> 3.0.0'
+  gem 'rspec-mocks', '~> 3.0.0'
+  gem 'simplecov'
+  gem 'yard'
+  gem 'redcarpet', '~> 3.1.2'
+  gem 'pry',                     require: false
+  gem 'pry-doc',                 require: false
+  gem 'pry-stack_explorer',      require: false
+end
+
+# vim:ft=ruby

data/Guardfile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/)     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, Arista Networks EOS+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of rbeapi nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,218 @@
+# Arista eAPI Ruby Library
+
+#### Table of Contents
+
+1. [Overview] (#overview)
+    * [Requirements] (#requirements)
+2. [Getting Started] (#getting-started)
+3. [Installation] (#installation)
+5. [Contributing] (#contributing)
+6. [License] (#license)
+
+
+The Ruby Cliet for eAPI provides a native Ruby implementation for programming Arista EOS network devices using Ruby.  The Ruby client provides the ability to build native applications in Ruby that can communicate with EOS either locally via Unix domain sockets (on-box) or remotely over a HTTP/S transport (off-box).  It uses a standard INI-style configuration file to specifiy one or more connection profiles.
+
+The rbeapi implemenation also provides an API layer for building native Ruby objects that allow for configuration and state extraction of EOS nodes.  The API layer provides a consistent implementation for working with EOS configuration resources.  The implementation of the API layer is highly extensible and can be used as a foundation for building custom data models.
+
+The libray is freely provided to the open source community for building robust applications using Arista EOS eAPI.  Support is provided as best effort through Github iusses.
+
+## Requirements
+
+* Arista EOS 4.12 or later
+* Arista eAPI enabled for at least one transport (see official EOS Config Guide at arista.com for details)
+* Ruby 1.9.3 or later
+
+# Getting Started
+In order to use rbeapi, the EOS command API must be enabled using ``management
+api http-commands`` configuration mode.  This library supports eAPI calls over
+both HTTP and UNIX Domain Sockets.  Once the command API is enabled on the
+destination node, create a configuration file with the node properities. 
+
+**Note:** The default search path for the conf file is ``~/.eapi.conf``
+followed by ``/mnt/flash/eapi.conf``.  This can be overridden by setting
+``EAPI_CONF=<path file conf file>`` in your environment.
+
+## Example eapi.conf File
+Below is an example of an eAPI conf file.  The conf file can contain more than
+one node.  Each node section must be prefaced by **connection:\<name\>** where
+\<name\> is the name of the connection.
+
+The following configuration options are available for defining node entries:
+
+* **host** - The IP address or FQDN of the remote device.  If the host
+  parameter is omitted then the connection name is used
+* **username** - The eAPI username to use for authentication (only required for
+  http or https connections)
+* **password** - The eAPI password to use for authentication (only required for
+  http or https connections)
+* **enablepwd** - The enable mode password if required by the destination node
+* **transport** - Configures the type of transport connection to use.  The
+  default value is _https_.  Valid values are:
+    * socket (available in EOS 4.14.5 or later)
+    * http_local (available in EOS 4.14.5 or later)
+    * http
+    * https  
+* **port** - Configures the port to use for the eAPI connection.  A default
+  port is used if this parameter is absent, based on the transport setting
+using the following values:
+    * transport: http, default port: 80
+    * transport: https, deafult port: 443
+    * transport: https_local, default port: 8080
+    * transport: socket, default port: n/a
+
+
+_Note:_ See the EOS User Manual found at arista.com for more details on
+configuring eAPI values.
+
+All configuration values are optional. 
+
+```
+[connection:veos01]
+username: eapi
+password: password
+transport: http
+
+[connection:veos02]
+transport: http
+
+[connection:veos03]
+transport: socket
+
+[connection:veos04]
+host: 172.16.10.1
+username: eapi
+password: password
+enablepwd: itsasecret
+port: 1234
+transport: https
+
+[connection:localhost]
+transport: http_local
+```
+
+The above example shows different ways to define EOS node connections.  All
+configuration options will attempt to use default values if not explicitly
+defined.  If the host parameter is not set for a given entry, then the
+connection name will be used as the host address.
+
+### Configuring \[connection:localhost]
+
+The rbeapi library automatically installs a single default configuration entry
+for connecting to localhost host using a transport of sockets.  If using the
+rbeapi library locally on an EOS node, simply enable the command API to use
+sockets and no further configuration is needed for rbeapi to function.  If you
+specify an entry in a conf file with the name ``[connection:localhost]``, the
+values in the conf file will overwrite the default.
+
+## Using rbeapi
+The Ruby Client for eAPI was designed to be easy to use and implement for
+writing tools and applications that interface with the Arista EOS management
+plane.  
+
+### Creating a connection and sending commands
+Once EOS is configured properly and the config file created, getting started
+with a connection to EOS is simple.  Below demonstrates a basic connection
+using rbeapi.  For more examples, please see the examples folder.
+
+```
+# start by importing the library
+require 'rbeapi/client'
+
+# create a node object by specifying the node to work with
+node = Rbeap::Client.connect_to('veos01')
+
+# send one or more commands to the node
+node.eanble('show hostname')
+node.enable('show hostname')
+=> [{:command=>"show hostname", :result=>{"fqdn"=>"veos01.arista.com", "hostname"=>"veos01"}, :encoding=>"json"}]
+
+# use the config method to send configuration commands
+node.config('hostname veos01')
+=> [{}]
+
+# multiple commands can be sent by using a list (works for both enable or
+config)
+node.config(['interface Ethernet1', 'description foo'])
+=> [{}, {}]
+
+# return the running or startup configuration from the node (output omitted for
+brevity)
+node.running_config
+
+node.startup_config
+```
+
+### Using the API
+
+The rbeapi library provides both a client for send and receiving commands over
+eAPI as well as an API for working directly with EOS resources.   The API is
+designed to be easy and straightforward to use yet also extensible.  Below is
+an example of working with the ``vlans`` API
+
+```
+# create a connection to the node
+require 'rbeapi/client'
+node = Rbeapi::Client.connect_to('veos01')
+
+# get the instance of the API (in this case vlans)
+vlans = node.api('vlans')
+
+# return all vlans from the node
+vlans.getall
+=> {"1"=>{:name=>"tester", :state=>"active", :trunk_groups=>[]},
+ "4"=>{:name=>"VLAN0004", :state=>"active", :trunk_groups=>[]},
+ "100"=>{:name=>"TEST_VLAN_100", :state=>"active", :trunk_groups=>[]},
+ "300"=>{:name=>"VLAN0300", :state=>"active", :trunk_groups=>[]}}
+
+# return a specific vlan from the node
+vlans.get(1)
+=> {:name=>"tester", :state=>"active", :trunk_groups=>[]}
+
+# add a new vlan to the node
+vlans.create(400)
+=> true
+
+# set the new vlan name
+vlans.set_name(100, value: 'foo')
+=> true
+```
+
+All API implementations developed by Arista EOS+ CS are found in the rbeapi/api
+folder.  See the examples folder for additional examples.
+
+# Installation
+
+The source code for rbeapi is provided on Github at
+http://github.com/arista-eosplus/rbeapi.  All current development is done in
+the develop branch.  Stable released versions are tagged in the master branch
+and uploaded to RubyGems.
+
+* To install the latest stable version of rbeapi, simply run ``gem install
+  rbeapi``
+* To install the latest development version from Github, simply clone the
+  develop branch and run ``rake build``
+
+
+# Contributing
+
+Contributing pull requests are gladly welcomed for this repository.  Please
+note that all contributions that modify the library behavior require
+corresponding test cases otherwise the pull request will be rejected.  
+
+# License
+
+Copyright (c) 2015, Arista Networks, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of Arista Networks nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'rbeapi/version'
+
+task :build do
+    system "gem build rbeapi.gemspec"
+end
+
+task :release => :build do
+    system "gem push rbeapi-#{Rbeapi::VERSION}"
+end

data/lib/rbeapi.rb

@@ -0,0 +1,32 @@
+#
+# Copyright (c) 2014, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+require 'rbeapi/client'

data/lib/rbeapi/api.rb

@@ -0,0 +1,135 @@
+#
+# Copyright (c) 2014, Arista Networks, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name of Arista Networks nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+require 'rbeapi/eapilib'
+
+module Rbeapi
+
+  module Api
+
+    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
+      #
+      # @param [Node] :node An instance of Rbeapi::Client::Node used to
+      #   send and receive eAPI messages
+      def self.instance(node)
+        new(node)
+      end
+
+      ##
+      # 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.
+      #
+      # @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 = {})
+        @node = node
+      end
+
+      ##
+      # Returns the running configuration from the node instance.  This is
+      # a convenience method to easily access the current running config
+      # from an API module
+      #
+      # @return [String] The current running-config from the node
+      def config
+        return @node.running_config
+      end
+
+      ##
+      # Provides a convenience method for access the connection error (if
+      # one exists) of the node's connection instance
+      #
+      # @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
+      end
+
+      ##
+      # Returns a block of configuration from the current running config
+      # as a string.  The argument is used to search the config and return
+      # the text along with any child configuration statements.
+      #
+      # @param [String] :text The text to be used to find the parent line
+      #   in the nodes configuration.
+      #
+      # @returns [nil, String] Returns the block of configuration based on
+      #   the supplied argument.  If the argument is not found in the
+      #   configuration, nil is returned
+      def get_block(text)
+        mdata = /^#{text}$/.match(config)
+        return nil unless mdata
+        block_start, line_end = mdata.offset(0)
+
+        mdata = /^[^\s]/.match(config, line_end)
+        return nil unless mdata
+
+        _, block_end = mdata.offset(0)
+        block_end = block_end - block_start
+
+        config[block_start, block_end]
+      end
+
+      ##
+      # Method called to send configuration commands to the node.  This method
+      # will send the commands to the node and rescue from CommandError or
+      # ConnectionError.
+      #
+      # @param [String, Array] :commands The commands to send to the node over
+      #   the API connection to configure the system
+      #
+      # @return [Boolean] Returns True if the commands were successful or
+      #   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
+        end
+      end
+    end
+  end
+end
+