vnet_api_client 0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c9692d1d0c36a83f2f96cae9f4c04cb87d829a2
+  data.tar.gz: 615a548f72bab017dad951798ddeb543ca419773
+SHA512:
+  metadata.gz: 79379cf32e11fdaf7941ba3ab44201c3ec83cae9aab7dc474fcea5512d847ee033a2bd1f8035f23192ea4e32df4f972442908130197aabdfc6a88cc6b35a5cb8
+  data.tar.gz: 2191645275d2879000c6b185df515de69526ef1a8a4572e0d33d970132ab99d7b1c1dde7f08bc61e921814fa917c3c3c92400f786fd3cc0feeb64247a5654ec0

data/README.md

@@ -0,0 +1,47 @@
+A Ruby library for accessing the OpenVNet WebAPI. All this library does is call Ruby's built in `Net::HTTP`. No further external libraries required.
+
+The JSON responses from the API are returned as Ruby hashes.
+
+Installation:
+
+```bash
+gem install vnet_api_client
+```
+
+Usage:
+
+```ruby
+require 'rubygems'
+require 'vnet_api_client'
+
+# This is the default value. If your OpenVNet WebAPI is located at localhost
+# port 9090, you don't have to include this line.
+VNetAPIClient.uri = 'http://localhost:9090'
+
+# Creates a new network
+VNetAPIClient::Network.create(display_name: 'my_network',
+                              ipv4_network: '192.168.3.0',
+                              ipv4_prefix: 24)
+
+# Enables routing and changes display name for an interface
+VNetAPIClient::Interface.update('i-abcdefg', enable_routing: true,
+                                             display_name: 'my new name')
+
+# Retrieves all datapaths
+VNetAPIClient::Datapath.index
+
+# Retrieves one interface
+VNetAPIClient::Interface.show('i-abcdefg')
+
+# Deletes one ip lease
+VNetAPIClient::IpLease.delete('il-begone')
+
+# Adds an interface to a security group
+VNetAPIClient::SecurityGroup.add_interface('sg-enter', 'i-getin')
+
+# Shows all networks in a datapath
+VNetAPIClient::Datapath.show_networks('dp-mypath')
+
+# Deletes a static address from a translation
+VNetAPIClient::Translation.remove_static_address('tr-xxxxx')
+```

data/lib/vnet_api_client.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+require 'net/http'
+require 'json'
+
+require_relative 'vnet_api_client/api_resource'
+require_relative 'vnet_api_client/api_resources'
+require_relative 'vnet_api_client/response_format'
+
+module VNetAPIClient
+  def self.uri=(u)
+    ApiResource.api_uri = u
+  end
+
+  def self.version=(v)
+    ApiResource.api_version = v
+  end
+
+  def self.format=(f)
+    ApiResource.api_format = f
+  end
+end
+
+# Set default values
+VNetAPIClient.uri = 'http://localhost:9090'
+VNetAPIClient.format = :json

data/lib/vnet_api_client/api_resource.rb

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+
+module VNetAPIClient
+
+  class ApiResource
+    class << self
+      attr_accessor :api_uri
+      attr_accessor :api_format
+
+      def api_full_uri(suffix)
+        u = ApiResource.api_uri
+        f = ApiResource.api_format
+
+        uri = "#{u}/api/1.0"
+        uri += "/#{suffix}" if suffix
+        uri += ".#{f}"
+
+        URI(uri)
+      end
+
+      def send_request(verb, suffix, params = nil)
+        uri = api_full_uri(suffix)
+        uri.query = URI.encode_www_form(params) if params
+
+        response = Net::HTTP.start(uri.host, uri.port) do |http|
+          request = verb.new(uri.request_uri)
+          http.request(request)
+        end
+
+        response_format = ApiResource.api_format.to_sym
+
+        ResponseFormats[response_format].parse(response)
+      end
+
+      #
+      # Metaprogramming to define common methods
+      #
+      def api_suffix(suffix)
+        @api_suffix = suffix
+      end
+
+      def metaclass
+        class << self
+          self
+        end
+      end
+
+      def define_standard_crud_methods
+        metaclass.instance_eval do
+          define_method(:create) do |params = nil|
+            send_request(Net::HTTP::Post, @api_suffix, params)
+          end
+
+          define_method(:update) do |uuid, params = nil|
+            send_request(Net::HTTP::Put, "#{@api_suffix}/#{uuid}", params)
+          end
+
+          define_method(:delete) do |uuid|
+            send_request(Net::HTTP::Delete, "#{@api_suffix}/#{uuid}")
+          end
+
+          define_method(:show) do |uuid|
+            send_request(Net::HTTP::Get, "#{@api_suffix}/#{uuid}")
+          end
+
+          define_method(:index) do
+            send_request(Net::HTTP::Get, @api_suffix)
+          end
+        end
+      end
+
+      def define_relation_methods(relation_name)
+        define_add_relation(relation_name)
+        define_show_relation(relation_name)
+        define_remove_relation(relation_name)
+      end
+
+      def define_add_relation(relation_name)
+        metaclass.instance_eval do
+          singular_name = relation_name.to_s.chomp('s')
+
+          define_method("add_#{singular_name}") do |uuid, relation_uuid, params = nil|
+            suffix = "#{@api_suffix}/#{uuid}/#{relation_name}/#{relation_uuid}"
+            send_request(Net::HTTP::Post, suffix, params)
+          end
+        end
+      end
+
+      def define_show_relation(relation_name)
+        metaclass.instance_eval do
+          define_method("show_#{relation_name}") do |uuid|
+            send_request(Net::HTTP::Get, "#{@api_suffix}/#{uuid}/#{relation_name}")
+          end
+        end
+      end
+
+      def define_remove_relation(relation_name)
+        metaclass.instance_eval do
+          singular_name = relation_name.to_s.chomp('s')
+
+          define_method("remove_#{singular_name}") do |uuid, relation_uuid|
+            suffix = "#{@api_suffix}/#{uuid}/#{relation_name}/#{relation_uuid}"
+            send_request(Net::HTTP::Delete, suffix)
+          end
+        end
+      end
+
+    end
+  end
+
+end
+

data/lib/vnet_api_client/api_resources.rb

@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+
+module VNetAPIClient
+
+  class Datapath < ApiResource
+    api_suffix :datapaths
+
+    define_standard_crud_methods
+    define_relation_methods(:networks)
+    define_relation_methods(:route_links)
+  end
+
+  class DnsService < ApiResource
+    api_suffix :dns_services
+
+    define_standard_crud_methods
+
+    define_show_relation(:dns_records)
+    define_remove_relation(:dns_records)
+
+    def self.add_dns_record(dns_service_uuid, params = nil)
+      send_request(Net::HTTP::Post,
+                   "#{@api_suffix}/#{dns_service_uuid}/dns_records",
+                   params)
+    end
+  end
+
+  class Interface < ApiResource
+    api_suffix :interfaces
+
+    define_standard_crud_methods
+    define_relation_methods(:security_groups)
+
+    define_show_relation(:ports)
+
+    def self.rename(interface_uuid, params = nil)
+      send_request(Net::HTTP::Put, "#{@api_suffix}/#{interface_uuid}/rename", params)
+    end
+
+    def self.add_port(interface_uuid, params = nil)
+      send_request(Net::HTTP::Post, "#{@api_suffix}/#{interface_uuid}/ports", params)
+    end
+
+    def self.remove_port(interface_uuid, params = nil)
+      send_request(Net::HTTP::Delete, "#{@api_suffix}/#{interface_uuid}/ports", params)
+    end
+  end
+
+  class IpLease < ApiResource
+    api_suffix :ip_leases
+
+    define_standard_crud_methods
+  end
+
+  class IpRangeGroup < ApiResource
+    api_suffix :ip_range_groups
+
+    define_standard_crud_methods
+
+    define_show_relation(:ip_ranges)
+    define_remove_relation(:ip_ranges)
+
+    def self.add_range(ip_range_group_uuid, params = nil)
+      send_request(Net::HTTP::Post,
+                   "#{@api_suffix}/#{ip_range_group_uuid}/ip_ranges",
+                   params)
+    end
+  end
+
+  class IpLeaseContainer < ApiResource
+    api_suffix :ip_lease_containers
+
+    define_standard_crud_methods
+
+    define_show_relation(:ip_leases)
+  end
+
+  class IpRetentionContainer < ApiResource
+    api_suffix :ip_retention_containers
+
+    define_standard_crud_methods
+
+    define_show_relation(:ip_retentions)
+  end
+
+  class LeasePolicy < ApiResource
+    api_suffix :lease_policies
+
+    define_standard_crud_methods
+    define_relation_methods(:ip_lease_containers)
+    define_relation_methods(:ip_retention_containers)
+    define_relation_methods(:networks)
+    define_relation_methods(:interfaces)
+
+    def self.add_lease(lease_policy_uuid, params = nil)
+      send_request(Net::HTTP::Post,
+                   "#{@api_suffix}/#{lease_policy_uuid}/ip_leases",
+                   params)
+    end
+  end
+
+  class MacLease < ApiResource
+    api_suffix :mac_leases
+
+    define_standard_crud_methods
+  end
+
+  class Network < ApiResource
+    api_suffix :networks
+
+    define_standard_crud_methods
+  end
+
+  class NetworkService < ApiResource
+    api_suffix :network_services
+
+    define_standard_crud_methods
+  end
+
+  class Route < ApiResource
+    api_suffix :routes
+
+    define_standard_crud_methods
+  end
+
+  class RouteLink < ApiResource
+    api_suffix :route_links
+
+    define_standard_crud_methods
+  end
+
+  class SecurityGroup < ApiResource
+    api_suffix :security_groups
+
+    define_standard_crud_methods
+    define_relation_methods(:interfaces)
+  end
+
+  class Translation < ApiResource
+    api_suffix :translations
+
+    define_standard_crud_methods
+
+    def self.add_static_address(translation_uuid, params = nil)
+      send_request(Net::HTTP::Post,
+                   "#{@api_suffix}/#{translation_uuid}/static_address",
+                   params)
+    end
+
+    def self.remove_static_address(translation_uuid, params = nil)
+      send_request(Net::HTTP::Delete,
+                   "#{@api_suffix}/#{translation_uuid}/static_address",
+                   params)
+    end
+  end
+
+  class VlanTranslation < ApiResource
+    api_suffix :vlan_translations
+
+    define_standard_crud_methods
+  end
+
+end
+

data/lib/vnet_api_client/response_format.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+module VNetAPIClient
+  module ResponseFormats
+
+    def self.[](format)
+      case format
+      when :json
+        Json.new
+      else
+        raise "Unknown response format: #{format}"
+      end
+    end
+
+    class Format
+      def parse(response)
+        raise NotImplementedError
+      end
+    end
+
+    class Json < Format
+      def parse(response)
+        JSON.parse(response.body) if response.body
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: vnet_api_client
+version: !ruby/object:Gem::Version
+  version: '0.7'
+platform: ruby
+authors:
+- Axsh Co. LTD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies: []
+description: Ruby wrapper for OpenVNet's RESTful API
+email: dev@axsh.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vnet_api_client.rb
+- lib/vnet_api_client/api_resources.rb
+- lib/vnet_api_client/response_format.rb
+- lib/vnet_api_client/api_resource.rb
+- README.md
+homepage: http://openvnet.org
+licenses:
+- LGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.1.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for OpenVNet's RESTful API
+test_files: []
+has_rdoc: