rubybvc 0.3.1 → 1.0.0

data/lib/openflowdev/of_switch.rb

@@ -29,19 +29,33 @@
 # THE POSSIBILITY OF SUCH DAMAGE.
 
 require 'controller/openflow_node'
+
+# Class that represents an instance of 'OpenFlow Switch' (OpenFlow capable device).
 class OFSwitch < OpenflowNode
   require 'json'
   require 'controller/controller'
   require 'openflowdev/flow_entry'
   require 'openflowdev/action_output'
   
+  # String: name of the controller node.
   attr_reader :name
   
+# _Parameters_ 
+# * +controller+:: Controller : Controller object through which the OpenFlow switch is to be controlled.
+# * +name+:: String : Node name of the OpenFlow node.
+# * +dpid+:: String : The OpenFlow datapath identifier for the OpenFlow device I.  e.g. admin
+
   def initialize(controller: nil, name: nil, dpid: nil)
     super(controller: controller, name: name)
     @dpid = dpid
   end
-  
+
+
+  ##
+  # Return info about the OpenFlow switch.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and info about the OpenFlow switch.  
   def get_switch_info
     get_uri = @controller.get_node_operational_uri(self)
     response = @controller.rest_agent.get_request(get_uri)
@@ -71,6 +85,11 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Return a list of OpenFlow features supported by the OpenFlow switch.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and supported features.
   def get_features_info
     get_uri = @controller.get_node_operational_uri(self)
     response = @controller.rest_agent.get_request(get_uri)
@@ -92,6 +111,11 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Return a list of ports for the OpenFlow switch.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of ports.
   def get_ports_list
     get_uri = @controller.get_node_operational_uri(self)
     response = @controller.rest_agent.get_request(get_uri)
@@ -109,6 +133,11 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Return a brief set of information about each port on the OpenFlow switch.
+  #
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of ports with brief info for each.
   def get_ports_brief_info
     get_uri = @controller.get_node_operational_uri(self)
     response = @controller.rest_agent.get_request(get_uri)
@@ -131,6 +160,13 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Return detailed information about a specific port.
+  #
+  # _Parameters_ 
+  # * +port+:: Integer : number for the port from the #get_ports_brief_info 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and detailed information about the requested port.
   def get_port_detail_info(port)
     get_uri = "#{@controller.get_node_operational_uri(self)}/node-connector/"\
       "#{self.name}:#{port}"
@@ -145,6 +181,13 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Add a new flow or modify an existing one.
+  #
+  # _Parameters_ 
+  # * +flow+:: FlowEntry : the flow definition 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and error details (if Status indicates an error).
   def add_modify_flow(flow)
     put_uri = "#{@controller.get_node_config_uri(self)}/table/#{flow.table_id}/"\
       "flow/#{flow.id}"
@@ -157,6 +200,14 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Return details of a specific flow.
+  #
+  # _Parameters_ 
+  # * +table_id+:: String : the identifier for the OpenFlow table from which to retrieve the flow 
+  # * +flow_id+:: String : the identifier for the flow to retrieve.
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and details about the requested flow.
   def get_configured_flow(table_id: nil, flow_id: nil)
     raise ArgumentError, "Table ID (table_id) required" unless table_id
     raise ArgumentError, "Flow ID (flow_id) required" unless flow_id
@@ -168,6 +219,14 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Remove a flow.
+  #
+  # _Parameters_ 
+  # * +table_id+:: String : the identifier for the OpenFlow table from which to remove the flow 
+  # * +flow_id+:: String : the identifier for the flow to remove.
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and details on error (if Status indicates an error).
   def delete_flow(table_id: nil, flow_id: nil)
     raise ArgumentError, "Table ID (table_id) required" unless table_id
     raise ArgumentError, "Flow ID (flow_id) required" unless flow_id
@@ -181,16 +240,38 @@ class OFSwitch < OpenflowNode
     end
   end
   
+  ##
+  # Return a list of flows in the controller's operational data store for the OpenFlow switch.  These are the flows that are in the switch.
+  #
+  # _Parameters_ 
+  # * +table_id+:: String : the identifier for the OpenFlow table from which to retrieve the flows 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of flows.
   def get_operational_flows(table_id: nil)
     raise ArgumentError, "Table ID (table_id) required" unless table_id
     get_flows(table_id: table_id)
   end
   
+  ##
+  # Return a list of flows in the controller's configuration data store for the OpenFlow switch.  These are the flows that the controller is supposed to program into the OpenFlow switch.
+  #
+  # _Parameters_ 
+  # * +table_id+:: String : the identifier for the OpenFlow table from which to retrieve the flows 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of flows.
   def get_configured_flows(table_id: nil)
     raise ArgumentError, "Table ID (table_id) required" unless table_id
     get_flows(table_id: table_id, is_operational: false)
   end
   
+  ##
+  # Return a list of flows in the controller's operational data store for the OpenFlow switch.  These are the flows that are in the switch.
+  # These flows will be returned in Open Vswitch (OVS) format.
+  #
+  # _Parameters_ 
+  # * +table_id+:: String : the identifier for the OpenFlow table from which to retrieve the flows 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of flows in Open VSwitch format.
   def get_operational_flows_ovs_syntax(table_id: nil, sort: false)
     raise ArgumentError, "Table ID (table_id) required" unless table_id
     response = get_operational_flows(table_id: table_id)
@@ -206,6 +287,16 @@ class OFSwitch < OpenflowNode
     end
   end
   
+
+  ##
+  # Return a list of flows in the controller's configured data store for the OpenFlow switch.  
+  # These are the flows that the controller is to program into the OpenFlow switch.
+  # These flows will be returned in Open Vswitch (OVS) format.
+  #
+  # _Parameters_ 
+  # * +table_id+:: String : the identifier for the OpenFlow table from which to retrieve the flows 
+  # _Return_ _Value_
+  # * NetconfResponse :  Status ( NetconfResponseStatus ) and list of flows in Open VSwitch format.
   def get_configured_flows_ovs_syntax(table_id: nil, sort: false)
     raise ArgumentError, "Table ID (table_id) required" unless table_id
     response = get_configured_flows(table_id: table_id)
@@ -223,7 +314,7 @@ class OFSwitch < OpenflowNode
   
   private
   
-  def get_flows(table_id: nil, is_operational: true)
+  def get_flows(table_id: nil, is_operational: true) #:nodoc:
     if is_operational
       get_uri = "#{@controller.get_node_operational_uri(self)}/"\
         "flow-node-inventory:table/#{table_id}"
@@ -246,7 +337,7 @@ class OFSwitch < OpenflowNode
     end
   end
   
-  def odl_to_ovs_flow_syntax(odl_flow)
+  def odl_to_ovs_flow_syntax(odl_flow) #:nodoc:
     ovs_flow = {}
     if odl_flow.has_key?('cookie')
       ovs_flow['cookie'] = "0x#{odl_flow['cookie'].to_s(16)}"

data/lib/utils/hash_with_compact.rb

@@ -30,7 +30,7 @@
 
 # borrowing from rails implementation 
 # https://github.com/rails/rails/blob/c0357d789b4323da64f1f9f82fa720ec9bac17cf/activesupport/lib/active_support/core_ext/hash/compact.rb#L8
-class Hash
+class Hash #:nodoc: all
   def compact
     self.select { |_, value| value.is_a?(Hash) ? !value.compact_and_check_if_empty : !value.nil? }
   end

data/lib/utils/netconf_response.rb

@@ -28,17 +28,25 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class defining response to most requests made in rubybvc.
 class NetconfResponse
   require 'utils/netconf_response_status'
   
+  # integer: success or failure status of request
   attr_accessor :status
+  # <variable>: the response from the request or more information about failure
   attr_accessor :body
   
-  def initialize(netconf_response_status = nil, json_body = nil)
+  def initialize(netconf_response_status = nil, json_body = nil) #:nodoc:
     @status = netconf_response_status
     @body = json_body
   end
   
+  ##
+  # Return a string for the status.
+  #
+  # _Return_ _Value_
+  # * string :  A string describing the status of the response (success or reason for failure).
   def message
     case(@status)
     when NetconfResponseStatus::OK

data/lib/utils/netconf_response_status.rb

@@ -28,6 +28,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class defining the numeric status that may be returned from making a request to rubybvc
 class NetconfResponseStatus
   OK = 200
   NODE_CONNECTED = 210

data/lib/utils/rest_agent.rb

@@ -28,7 +28,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
-class RestAgent
+class RestAgent #:nodoc: all
   require 'uri'
   require 'net/http'
   require 'logger'

data/lib/utils/utilities.rb

@@ -28,7 +28,7 @@
 # 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)
+def check_response_for_success(response) #:nodoc:
   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
@@ -39,7 +39,7 @@ def check_response_for_success(response)
   netconf_response
 end
 
-def handle_error_response(response)
+def handle_error_response(response) #:nodoc:
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubybvc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sarah Dempsey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri