rubybvc 0.3.1

data/lib/utils/netconf_response.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2015,  BROCADE COMMUNICATIONS SYSTEMS, 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. 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.
+#
+# 3. Neither the name of the copyright holder 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.
+
+class NetconfResponse
+  require 'utils/netconf_response_status'
+  
+  attr_accessor :status
+  attr_accessor :body
+  
+  def initialize(netconf_response_status = nil, json_body = nil)
+    @status = netconf_response_status
+    @body = json_body
+  end
+  
+  def message
+    case(@status)
+    when NetconfResponseStatus::OK
+      "Success"
+    when NetconfResponseStatus::NODE_CONNECTED
+      "Node is connected"
+    when NetconfResponseStatus::NODE_DISCONNECTED
+      "Node is disconnected"
+    when NetconfResponseStatus::NODE_NOT_FOUND
+      "Node not found"
+    when NetconfResponseStatus::NODE_CONFIGURED
+      "Node is configured"
+    when NetconfResponseStatus::CONN_ERROR
+      "Server connection error"
+    when NetconfResponseStatus::CTRL_INTERNAL_ERROR
+      "Internal server error"
+    when NetconfResponseStatus::HTTP_ERROR
+      msg = "HTTP error"
+      msg += " #{@body.code}" if @body && @body.code
+      msg += " - #{@body.message}" if @body && @body.message
+      msg
+    when NetconfResponseStatus::DATA_NOT_FOUND
+      "Requested data not found"
+    end
+  end
+end

data/lib/utils/netconf_response_status.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2015,  BROCADE COMMUNICATIONS SYSTEMS, 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. 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.
+#
+# 3. Neither the name of the copyright holder 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.
+
+class NetconfResponseStatus
+  OK = 200
+  NODE_CONNECTED = 210
+  NODE_DISCONNECTED = 410
+  NODE_NOT_FOUND = 404
+  NODE_CONFIGURED = 211
+  CONN_ERROR = 503
+  CTRL_INTERNAL_ERROR = 500
+  HTTP_ERROR = 400
+  DATA_NOT_FOUND = 444
+end

data/lib/utils/rest_agent.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2015,  BROCADE COMMUNICATIONS SYSTEMS, 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. 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.
+#
+# 3. Neither the name of the copyright holder 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.
+
+class RestAgent
+  require 'uri'
+  require 'net/http'
+  require 'logger'
+
+  attr_reader :service_uri
+  attr_accessor :headers
+  
+  $LOG = Logger.new('rubybvc-requests.log')
+
+  def initialize(service_uri, headers: {}, username: nil, password: nil,
+      open_timeout: nil)
+    @service_uri = URI(service_uri)
+    @headers = {'Content-Type' => 'application/json', 'Accept' => 'application/json'}.merge(headers)
+    @username = username
+    @password = password
+    @open_timeout = open_timeout
+  end
+  
+  def get_request(uri_endpoint, query_params = {})
+    uri = @service_uri + URI(uri_endpoint)
+    uri.query = URI.encode_www_form(query_params) unless query_params.empty?
+    req = Net::HTTP::Get.new(uri, @headers)
+    return send_request(uri, req)
+  end
+
+  def post_request(uri_endpoint, post_body, headers: {})
+    uri = @service_uri + URI(uri_endpoint)
+    req = Net::HTTP::Post.new(uri, @headers.merge(headers))
+    req.body = post_body.is_a?(String) ? post_body : post_body.to_json
+    return send_request(uri, req)
+  end
+  
+#  def patch_request(uri_endpoint, patch_body, headers: {})
+#    uri = @service_uri + URI(uri_endpoint)
+#    req = Net::HTTP::Patch.new(uri, @headers.merge(headers))
+#    req.body = patch_body.to_json
+#    return send_request(uri, req)
+#  end
+
+  def put_request(uri_endpoint, put_body, headers: {})
+    uri = @service_uri + URI(uri_endpoint)
+    req = Net::HTTP::Put.new(uri, @headers.merge(headers))
+    req.body = put_body.to_json
+    return send_request(uri, req)
+  end
+
+  def delete_request(uri_endpoint)
+    uri = @service_uri + URI(uri_endpoint)
+    req = Net::HTTP::Delete.new(uri, @headers)
+    return send_request(uri, req)
+  end
+
+  private
+
+  def send_request(uri, request)
+    request.basic_auth(@username, @password) unless @username.nil? || @username.empty?
+    begin
+      $LOG.info request.to_yaml
+      response =  Net::HTTP.start(uri.host, uri.port, :open_timeout => @open_timeout,
+        :use_ssl => uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+      $LOG.info response.to_yaml
+      # catch html responses
+      return response
+    rescue Net::HTTPHeaderSyntaxError, Net::HTTPBadResponse, Net::OpenTimeout => e
+      $LOG.error "Error connecting to #{@service_uri}: #{e.message}"
+      return nil
+    end
+  end
+
+end

data/lib/utils/utilities.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2015,  BROCADE COMMUNICATIONS SYSTEMS, 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. 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.
+#
+# 3. Neither the name of the copyright holder 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.
+
+def check_response_for_success(response)
+  netconf_response = nil
+  if response && ((response.body && response.code.to_i < 204) || (response.code.to_i == 204 && !response.body))
+    parsed_body = response.body ? JSON.parse(response.body) : nil
+    netconf_response = yield parsed_body
+  else
+    netconf_response = handle_error_response(response)
+  end
+  netconf_response
+end
+
+def handle_error_response(response)
+  if response && response.body.nil? && response.code.to_i < 204
+    netconf_response = NetconfResponse.new(NetconfResponseStatus::CTRL_INTERNAL_ERROR)
+  elsif response && response.code.to_i > 204
+    netconf_response = NetconfResponse.new(NetconfResponseStatus::HTTP_ERROR,
+       response)
+  elsif !response
+    netconf_response = NetconfResponse.new(NetconfResponseStatus::CONN_ERROR)
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rubybvc
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Sarah Dempsey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+description: Ruby support library for Brocade Vyatta Controller (BVC) RESTCONF API
+email: support@elbrys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/controller/controller.rb
+- lib/controller/netconf_node.rb
+- lib/controller/node.rb
+- lib/controller/openflow_node.rb
+- lib/netconfdev/vrouter/dataplane_firewall.rb
+- lib/netconfdev/vrouter/firewall.rb
+- lib/netconfdev/vrouter/rule.rb
+- lib/netconfdev/vrouter/rules.rb
+- lib/netconfdev/vrouter/vrouter5600.rb
+- lib/openflowdev/action_output.rb
+- lib/openflowdev/actions/action.rb
+- lib/openflowdev/actions/actions.rb
+- lib/openflowdev/actions/copy_ttl_inwards_action.rb
+- lib/openflowdev/actions/copy_ttl_outwards_action.rb
+- lib/openflowdev/actions/dec_mpls_ttl_action.rb
+- lib/openflowdev/actions/dec_nw_ttl_action.rb
+- lib/openflowdev/actions/drop_action.rb
+- lib/openflowdev/actions/flood_action.rb
+- lib/openflowdev/actions/flood_all_action.rb
+- lib/openflowdev/actions/group_action.rb
+- lib/openflowdev/actions/hw_path_action.rb
+- lib/openflowdev/actions/loopback_action.rb
+- lib/openflowdev/actions/output_action.rb
+- lib/openflowdev/actions/pop_mpls_header_action.rb
+- lib/openflowdev/actions/pop_pbb_header_action.rb
+- lib/openflowdev/actions/pop_vlan_header_action.rb
+- lib/openflowdev/actions/push_mpls_header_action.rb
+- lib/openflowdev/actions/push_pbb_header_action.rb
+- lib/openflowdev/actions/push_vlan_header_action.rb
+- lib/openflowdev/actions/set_dl_dst_action.rb
+- lib/openflowdev/actions/set_dl_src_action.rb
+- lib/openflowdev/actions/set_field_action.rb
+- lib/openflowdev/actions/set_mpls_ttl_action.rb
+- lib/openflowdev/actions/set_nw_dst_action.rb
+- lib/openflowdev/actions/set_nw_src_action.rb
+- lib/openflowdev/actions/set_nw_ttl_action.rb
+- lib/openflowdev/actions/set_queue_action.rb
+- lib/openflowdev/actions/set_tp_dst_action.rb
+- lib/openflowdev/actions/set_tp_src_action.rb
+- lib/openflowdev/actions/set_vlan_cfi_action.rb
+- lib/openflowdev/actions/set_vlan_id_action.rb
+- lib/openflowdev/actions/set_vlan_pcp_action.rb
+- lib/openflowdev/actions/strip_vlan_action.rb
+- lib/openflowdev/actions/sw_path_action.rb
+- lib/openflowdev/flow_entry.rb
+- lib/openflowdev/instruction.rb
+- lib/openflowdev/match.rb
+- lib/openflowdev/of_switch.rb
+- lib/rubybvc.rb
+- lib/utils/hash_with_compact.rb
+- lib/utils/netconf_response.rb
+- lib/utils/netconf_response_status.rb
+- lib/utils/rest_agent.rb
+- lib/utils/utilities.rb
+homepage: ''
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby BVC
+test_files: []