lenovo-rbapi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 667259711ddfa036e529c429db4ae5fcf06a4574ffea0398e2d1edf0e9dc619c
-  data.tar.gz: 5d11b22f8e97e64612ab04e0df18bbd4e6366e09f986199732c502121aa162cc
+SHA1:
+  metadata.gz: 54690c92b60368321ef8dea8d70845c9fb38b7c4
+  data.tar.gz: 743b3d4a5e7bef4cce3b2b5ab502353a4e513053
 SHA512:
-  metadata.gz: bbfb514565c1d94585d5d333e9f845d24e841774260e33163722d2213d7901ad5114fda216a0cd4e7a23d8d82f35281aa10bdcfd240f083f0dbab7df94dee601
-  data.tar.gz: 7c55b018645c51a1a76f944eab648677c8cd4c8a6ca38bac9a4af9543a7853c2673711548987be4af3eb8e2754ad0d966fc5b393af66dffe63f7a107efb32a15
+  metadata.gz: c8f8174ac969fc525a083bc918ee926cc7afab35aa2bda4c8352e2e7e10cba56cf491894e180eaca26955ed777647aaa5c5fe7302ab2732b77ed30c134f97228
+  data.tar.gz: 9f3315057ce874ba0cf74b973eb19b99fd086c031d31121fbf7727291eb78b28936638062fc47c37e7541c392e4d56175656f33a885bdbddfa412a7fdb576558

data/README.md

@@ -1,84 +1,84 @@
-# Lenovo CNOS Ruby API Library
-
-## Overview
-The Ruby Client for CNOS API provides a native Ruby implementation for programming
-Lenovo CNOS network devices using Ruby.  The Ruby client provides the ability to
-build native applications in Ruby that can communicate with CNOS remotely over 
-a HTTP/S transport (off-box).
-
-The Ruby API implemenation also provides an API layer for building native Ruby
-objects that allow for configuration and management of Lenovo CNOS switches. 
-
-The library is freely provided to the open source community for building applications 
-using CNOS REST API infrastrcuture. Support is provided as best effort through
-Github iusses.
-
-## Requirements
-* Lenovo CNOS 10.4 or later
-* Ruby 2.2.3 or later
-
-## CNOS Ruby APIs
-The CNOS Ruby Client was designed to be easy to use and develop plugins or tools
-that interface with the Lenovo CNOS switches.
-
-### Using the API
-#### Switch Configutation file
-This configuration file is used to define the configuration options or model for switches (switch.yml or any xxx.yml)
-
-##### transport (HTTP/HTTPs)
-transport : 'http' 
-
-##### HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
-port : '8090' 
-
-##### Switch IP address
-ip : 'switch ip address' 
-
-##### Switch Credentials
-user : 'username' 
-
-password : 'password' 
-
-#### Creating connection and sending configurations
-Below demonstrates a basic connection using the API. For more examples, please see the examples folder.
-
-#import the libraries
-
-require 'cnos-rbapi/connect'
-
-require 'cnos-rbapi/vlan'
-
-##### create connection to the node using the configuration file
-conn = Connect.new(param) 
-
-where param is a dictionary formed either from the config file or hardcoded 
-with the following key value pairs 
-
-##### transport (HTTP/HTTPs) 
-transport => 'http' 
-
-##### HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
-port => '8090'  
-
-##### Switch IP address 
-ip => 'switch ip address'
-
-##### Switch Credentials
-user => 'username'  
-password => 'password'
-  
-##### Use VLAN APIs to retrieve VLAN information
-Vlan.get_all_vlan(conn)
-
-params = {"vlan_name" => "test", "vlan_id" => 10, "admin_state" => "up"}
-
-##### Use VLAN APIs to create/update and delete VLANs
-resp = Vlan.create_vlan(conn, params) 
-
-resp = Vlan.get_vlan_prop(conn, 10)
-
-params = {"vlan_name" => "test", "admin_state" => "up"}
-
-resp = Vlan.update_vlan(conn, 10, params)
-
-Vlan.delete_vlan(conn, 10)
+# Lenovo CNOS Ruby API Library
+
+## Overview
+The Ruby Client for CNOS API provides a native Ruby implementation for programming
+Lenovo CNOS network devices using Ruby.  The Ruby client provides the ability to
+build native applications in Ruby that can communicate with CNOS remotely over
+a HTTP/S transport (off-box).
+
+The Ruby API implemenation also provides an API layer for building native Ruby
+objects that allow for configuration and management of Lenovo CNOS switches.
+
+The library is freely provided to the open source community for building applications
+using CNOS REST API infrastrcuture. Support is provided as best effort through
+Github iusses.
+
+## Requirements
+* Lenovo CNOS 10.4 or later
+* Ruby 2.2.3 or later
+
+## CNOS Ruby APIs
+The CNOS Ruby Client was designed to be easy to use and develop plugins or tools
+that interface with the Lenovo CNOS switches.
+
+### Using the API
+#### Switch Configutation file
+This configuration file is used to define the configuration options or model for switches (switch.yml or any xxx.yml)
+
+##### transport (HTTP/HTTPs)
+transport : 'http'
+
+##### HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
+port : '8090'
+
+##### Switch IP address
+ip : 'switch ip address'
+
+##### Switch Credentials
+user : 'username'
+
+password : 'password'
+
+#### Creating connection and sending configurations
+Below demonstrates a basic connection using the API. For more examples, please see the examples folder.
+#import the libraries
+
+require 'cnos-rbapi/connect'
+
+require 'cnos-rbapi/vlan'
+
+##### create connection to the node using the configuration file
+conn = Connect.new(param)
+
+where param is a dictionary formed either from the config file or hardcoded
+with the following key value pairs
+
+##### transport (HTTP/HTTPs)
+transport => 'http'
+
+##### HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
+port => '8090'  
+
+##### Switch IP address
+ip => 'switch ip address'
+
+##### Switch Credentials
+user => 'username'  
+password => 'password'
+
+##### Use VLAN APIs to retrieve VLAN information
+Vlan.get_all_vlan(conn)
+
+params = {"vlan_name" => "test", "vlan_id" => 10, "admin_state" => "up"}
+
+##### Use VLAN APIs to create/update and delete VLANs
+resp = Vlan.create_vlan(conn, params)
+
+resp = Vlan.get_vlan_prop(conn, 10)
+
+params = {"vlan_name" => "test", "admin_state" => "up"}
+
+resp = Vlan.update_vlan(conn, 10, params)
+
+Vlan.delete_vlan(conn, 10)
+

data/lib/cnos-rbapi.rb

@@ -1,16 +1,24 @@
 ##
-### Copyright (c) 2017, Lenovo. All rights reserved.
-###  
-### This program and the accompanying materials are licensed and made available
-### under the terms and conditions of the 3-clause BSD License that accompanies 
-### this distribution. 
-###  
-### The full text of the license may be found at
+### Copyright (C) 2017 Lenovo, Inc.
+### Licensed under the Apache License, Version 2.0 (the "License");
+### you may not use this file except in compliance with the License.
+### You may obtain a copy of the License at
+###       http://www.apache.org/licenses/LICENSE-2.0
 ###
-### https://opensource.org/licenses/BSD-3-Clause 
-###  
-### THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 
-### WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+### Unless required by applicable law or agreed to in writing, software
+### distributed under the License is distributed on an "AS IS" BASIS,
+### WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+### See the License for the specific language governing permissions and
+### limitations under the License.
 ###
 #
 require 'cnos-rbapi/connect.rb'
+
+module LenovoGem
+  class Cnos
+    def self.lenovo?
+      puts "YOU ARE AWESOME!!"
+    end
+  end
+end
+

data/lib/cnos-rbapi/arp.rb

@@ -1,16 +1,15 @@
 ##
-## Copyright (c) 2017, Lenovo. All rights reserved.
+## Copyright (C) 2017 Lenovo, Inc.
+## Licensed under the Apache License, Version 2.0 (the "License"); 
+## you may not use this file except in compliance with the License. 
+## You may obtain a copy of the License at 
+##       http://www.apache.org/licenses/LICENSE-2.0
 ##
-## This program and the accompanying materials are licensed and made available
-## under the terms and conditions of the 3-clause BSD License that accompanies
-## this distribution.
-##
-## The full text of the license may be found at
-##
-## https://opensource.org/licenses/BSD-3-Clause
-##
-## THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-## WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+## Unless required by applicable law or agreed to in writing, software 
+## distributed under the License is distributed on an "AS IS" BASIS, 
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and 
+## limitations under the License.
 ##
 require 'rest-client'
 require 'json'
@@ -24,7 +23,7 @@ require_relative 'rest_utils'
 ## 
 
 class Arp
-	@cfg  = '/nos/api/cfg/arp'
+	@@cfg  = '/nos/api/cfg/arp'
         
 	# This API gets the ARP properties of the system.
         # 
@@ -34,7 +33,7 @@ class Arp
         #
         #  return: JSON response 		
 	def self.get_arp_sys_prop(conn)
-                url = form_url(conn, @cfg)
+                url = form_url(conn, @@cfg)
                 hdr = form_hdr(conn)
                 Rest.get(conn, url, hdr)
         end
@@ -47,7 +46,7 @@ class Arp
         #
         #  return: JSON response 		
         def self.get_arp_prop_all(conn)
-                url = form_url(conn, @cfg + '_interface')
+                url = form_url(conn, @@cfg + '_interface')
                 hdr = form_hdr(conn)
                 Rest.get(conn, url, hdr)
         end
@@ -66,7 +65,7 @@ class Arp
         #
 	#  return: JSON response 		
         def self.set_arp_sys_prop(conn, params)
-                url = form_url(conn, @cfg)
+                url = form_url(conn, @@cfg)
                 hdr = form_hdr(conn)
                 params = params.to_json
                 Rest.put(conn, url, hdr, params)
@@ -82,7 +81,7 @@ class Arp
 	def self.get_arp_intf_prop(conn, intf)
                 temp = intf.dup
 		temp.sub! '/', '%2F'
-                url = form_url(conn, @cfg + '_interface/' + temp)
+                url = form_url(conn, @@cfg + '_interface/' + temp)
                 hdr = form_hdr(conn)
                 Rest.get(conn, url, hdr)
         end
@@ -105,7 +104,7 @@ class Arp
         def self.set_arp_intf_prop(conn, intf,  params)
                 temp = intf.dup
 		temp.sub! '/', '%2F'
-                url = form_url(conn, @cfg + '_interface/' + temp)
+                url = form_url(conn, @@cfg + '_interface/' + temp)
                 hdr = form_hdr(conn)
                 params = params.to_json
                 Rest.put(conn, url, hdr, params)

data/lib/cnos-rbapi/connect.rb

@@ -1,16 +1,15 @@
 ##
-## Copyright (c) 2017, Lenovo. All rights reserved.
+## Copyright (C) 2017 Lenovo, Inc.
+## Licensed under the Apache License, Version 2.0 (the "License"); 
+## you may not use this file except in compliance with the License. 
+## You may obtain a copy of the License at 
+##       http://www.apache.org/licenses/LICENSE-2.0
 ##
-## This program and the accompanying materials are licensed and made available
-## under the terms and conditions of the 3-clause BSD License that accompanies
-## this distribution.
-##
-## The full text of the license may be found at
-##
-## https://opensource.org/licenses/BSD-3-Clause
-##
-## THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-## WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+## Unless required by applicable law or agreed to in writing, software 
+## distributed under the License is distributed on an "AS IS" BASIS, 
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and 
+## limitations under the License.
 ##
 require 'rest-client'
 require 'yaml'
@@ -42,7 +41,8 @@ class Connect
         #  file   :config file
         #
         #  return: Connect object 		
-	def initialize(params)
+	def initialize(file)
+		params = YAML.load_file(file)
 		@transport = params['transport']
 		@port      = params['port']
 		@ip        = params['ip']

data/lib/cnos-rbapi/igmp.rb

@@ -1,16 +1,15 @@
 ##
-## Copyright (c) 2017, Lenovo. All rights reserved.
+## Copyright (C) 2017 Lenovo, Inc.
+## Licensed under the Apache License, Version 2.0 (the "License"); 
+## you may not use this file except in compliance with the License. 
+## You may obtain a copy of the License at 
+##       http://www.apache.org/licenses/LICENSE-2.0
 ##
-## This program and the accompanying materials are licensed and made available
-## under the terms and conditions of the 3-clause BSD License that accompanies
-## this distribution.
-##
-## The full text of the license may be found at
-##
-## https://opensource.org/licenses/BSD-3-Clause
-##
-## THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-## WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+## Unless required by applicable law or agreed to in writing, software 
+## distributed under the License is distributed on an "AS IS" BASIS, 
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and 
+## limitations under the License.
 ##
 require 'rest-client'
 require 'json'
@@ -24,7 +23,7 @@ require_relative 'rest_utils'
 ## on the node. This class presents an abstraction
 ## 
 class Igmp
-	@cfg  = '/nos/api/cfg/igmp'
+	@@cfg  = '/nos/api/cfg/igmp'
 	
 	#  This API gets IGMP Snooping properties of the system.
         # 
@@ -34,7 +33,7 @@ class Igmp
         #
         #  return: JSON response 		
         def self.get_igmp_snoop_prop(conn)
-                url = form_url(conn, @cfg + '/snoop')
+                url = form_url(conn, @@cfg + '/snoop')
                 hdr = form_hdr(conn)
                 Rest.get(conn, url, hdr)
         end
@@ -59,7 +58,7 @@ class Igmp
         #
         #  return: JSON response 		
         def self.set_igmp_snoop_prop(conn, params)
-                url = form_url(conn, @cfg + '/snoop')
+                url = form_url(conn, @@cfg + '/snoop')
                 hdr = form_hdr(conn)
                 params = params.to_json
                 Rest.put(conn, url, hdr, params)
@@ -74,7 +73,7 @@ class Igmp
         #
         #  return: JSON response 		
 	def self.get_igmp_vlan_prop(conn, vlan_id)
-		temp = @cfg.dup
+		temp = @@cfg.dup
 		temp.sub! 'igmp', 'mc_vlan/' + vlan_id.to_s	
                 url = form_url(conn, temp)
                 hdr = form_hdr(conn)
@@ -107,7 +106,7 @@ class Igmp
         #
         #  return: JSON response		            
         def self.set_igmp_vlan_prop(conn, vlan_id, params)
-		temp = @cfg.dup
+		temp = @@cfg.dup
                 temp.sub! 'igmp', 'mc_vlan/' + vlan_id.to_s
                 url = form_url(conn, temp)
                 hdr = form_hdr(conn)

data/lib/cnos-rbapi/ip_intf.rb

@@ -1,16 +1,15 @@
 ##
-## Copyright (c) 2017, Lenovo. All rights reserved.
+## Copyright (C) 2017 Lenovo, Inc.
+## Licensed under the Apache License, Version 2.0 (the "License"); 
+## you may not use this file except in compliance with the License. 
+## You may obtain a copy of the License at 
+##       http://www.apache.org/licenses/LICENSE-2.0
 ##
-## This program and the accompanying materials are licensed and made available
-## under the terms and conditions of the 3-clause BSD License that accompanies
-## this distribution.
-##
-## The full text of the license may be found at
-##
-## https://opensource.org/licenses/BSD-3-Clause
-##
-## THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-## WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+## Unless required by applicable law or agreed to in writing, software 
+## distributed under the License is distributed on an "AS IS" BASIS, 
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and 
+## limitations under the License.
 ##
 require 'rest-client'
 require 'json'
@@ -24,7 +23,7 @@ require_relative 'rest_utils'
 ## 
 
 class Ipintf
-	@cfg  = '/nos/api/cfg/ip_interface'
+	@@cfg  = '/nos/api/cfg/ip_interface'
 	# This API gets the IP properties of all interface.
         # 
         # 
@@ -33,7 +32,7 @@ class Ipintf
         #
         #  return: JSON response 		
         def self.get_ip_prop_all(conn)
-                url = form_url(conn, @cfg)
+                url = form_url(conn, @@cfg)
                 hdr = form_hdr(conn)
                 Rest.get(conn, url, hdr)
         end
@@ -49,7 +48,7 @@ class Ipintf
 	def self.get_ip_prop_intf(conn, intf)
                 temp = intf.dup
                 temp.sub! '/', '%2F'
-                url = form_url(conn, @cfg + '/' + temp)
+                url = form_url(conn, @@cfg + '/' + temp)
                 hdr = form_hdr(conn)
                 Rest.get(conn, url, hdr)
         end
@@ -84,7 +83,7 @@ class Ipintf
 	def self.update_ip_prop_intf(conn, intf, params)
                 temp = intf.dup
                 temp.sub! '/', '%2F'
-                url = form_url(conn, @cfg + '/' + temp)
+                url = form_url(conn, @@cfg + '/' + temp)
                 hdr = form_hdr(conn)
                 params = params.to_json
                 Rest.put(conn, url, hdr, params)