icontrol 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jose Fernandez (magec)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,9 @@
+# IControl: F5 BigIP SOAP API Client
+
+IControl allows you to easily connect to a BigIP F5 load balancer and by means of the SOAP API. You can programmatically do almost the same as in the Web Interface.
+
+## Installing
+
+# Install the gem:
+    gem install icontrol
+

data/README.rdoc

@@ -0,0 +1,16 @@
+= icontrol
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jose Fernandez (magec). See LICENSE for details.

data/lib/icontrol.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH << File.dirname(__FILE__) 
+require 'icontrol/attributable'
+require 'icontrol/base'
+require 'icontrol/mappings'
+require 'icontrol/common'
+require 'icontrol/statistic_type'
+require 'icontrol/local_lb/profile_http_class'
+require 'icontrol/local_lb/profile_auth'
+require 'icontrol/local_lb/rate_class'
+require 'icontrol/local_lb/snat_pool'
+require 'icontrol/local_lb/common'
+require 'icontrol/local_lb/pool'
+require 'icontrol/local_lb/pool_member'
+require 'icontrol/local_lb/rule'
+require 'icontrol/local_lb/virtual_server'
+require 'icontrol/local_lb/monitor'
+require 'icontrol/local_lb/monitor_rule'

data/lib/icontrol/attributable.rb

@@ -0,0 +1,36 @@
+module Attributable
+
+  def self.included(klass)
+    klass.class_eval do
+      extend ClassMethods
+      include InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def set_id_name(id_name)
+      @id_name = id_name
+    end
+    
+    def id_name
+      @id_name
+    end
+  end
+
+  module InstanceMethods
+    def initialize(attributes)
+      id = attributes.delete(self.class.id_name) if attributes && attributes[self.class.id_name]
+      @attributes = attributes || {}
+      @attributes[:id] ||= id 
+    end
+
+    def method_missing(method_name,*args,&block)
+      if @attributes && @attributes.has_key?(method_name)
+        return @attributes[method_name] 
+      else
+        super
+      end 
+    end  
+  end
+
+end

data/lib/icontrol/base.rb

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+require 'savon'
+require 'net/https'
+require 'digest/md5'
+
+# The idea is to create an object proxy to the web service client with the same structure 
+# than the IControl stuff
+
+module IControl
+
+  class NotConfiguredException < Exception; end
+  
+  module Common
+    class IPPortDefinition
+      attr_accessor :address,:port
+      def initialize(options)
+        @address = options[:address]
+        @port = options[:port]
+      end
+    end    
+  end
+
+
+  class Base
+
+    def default_body
+      { self.class.id_name.to_s + "s" =>  {:value => [@attributes[:id]] } }
+    end
+
+    # Generic type mapping
+    def self.map_response(response)
+      response_key = response.keys.first
+      if response_key
+        if response[response_key].has_key? :return
+          return IControl::Mappings.map_object(response[response_key][:return]) 
+        else
+          return nil
+        end
+      else
+        raise "Invalid Response #{response.inspect}"
+      end
+    end
+
+    def self.find(name)
+      return self.find_all if name == :all 
+      if name == :first
+        all = self.find_all
+        return all[0] if all.length >0
+      end
+      if self.get_list.include?(name)
+        return self.new(:id => name)
+      else
+        return nil
+      end
+    end
+
+    def self.find_all
+      self.get_list.map {|i| self.new(:id => i)}
+    end    
+
+    def method_missing(method_name,*args,&block)
+      
+       return super if @attributes.has_key? method_name 
+
+      if self.class.wsdl.operations.keys.include?("get_#{method_name}".to_sym)
+        return self.class.send("get_#{method_name}".to_sym) do |soap|
+          soap.body = default_body
+        end
+      end
+
+      if self.class.wsdl.operations.keys.include?("#{method_name}".to_sym)
+        return self.class.send("#{method_name}".to_sym) do |soap|
+          soap.body = default_body
+        end
+      end
+      
+      return super
+    end
+
+    include Attributable
+
+  end
+
+  class << self
+    attr_accessor :config
+  end
+  
+  def self.configured?
+    return @config[:user] != "" && @config[:password] != "" && @config[:base_url] != ""
+  end
+
+  @config = {
+    :user     => "",               # username and password
+    :password => "",
+    :base_url => "",                # base url for the web-service (https://example.com/iControl/iControlPortal.cgi)
+    :test_mode => false,           # When test mode is set, the soap responses are saved (this is done to ease the testing fixtures generation)
+    :test_path => File.join(File.dirname(__FILE__),"..","..","spec","fixtures"),
+    :test_file_prefix => ""
+  }
+
+  def self.save_test_info(request,response,wsdl,class_name,method_name)
+    
+    request_md5 = Digest::MD5.hexdigest(request)
+    request_file_name  = request_raw_file_name = File.join(IControl.config[:test_path],"soap","xml","#{class_name}.#{method_name}_#{request_md5}_request")
+    response_file_name = response_raw_file_name = File.join(IControl.config[:test_path],"soap","xml","#{class_name}.#{method_name}_#{request_md5}_response")
+
+    timestamp = Time.now.strftime("%Y%m%d%m%S") + Time.now.usec.to_s 
+
+    while File.exists?(response_file_name + ".xml") || File.exists?(request_file_name + ".xml")
+      response_file_name = response_raw_file_name + "." + timestamp
+      request_file_name = request_raw_file_name + "." + timestamp
+    end
+
+    File.open(response_file_name + ".xml","w") { |file| file << response.to_xml }
+    File.open(request_file_name + ".xml","w") { |file| file << request }
+    
+    wsdl_file_name = File.join(IControl.config[:test_path],"wsdl","xml","#{class_name}.xml")
+    unless File.exists?(wsdl_file_name) 
+      File.open(wsdl_file_name,"w") do |file|
+        file << wsdl
+      end
+    end
+  end
+
+
+
+  def IControl.const_missing(name)
+    
+    # Whenever we find a new module subclassing IControl we create it
+    
+    modulo = Module.new do 
+
+      # This new module has the ability to automatically create classes when subclassing from it
+
+      (class << self; self; end).instance_eval do                 # We do it in the eigenclass
+        
+        define_method("const_missing") do |class_name|
+          
+          # Whenever we are called with a class name we create a new one based on the configuration we have
+          
+          klass = Class.new(IControl::Base) do
+
+            (class << self; self; end).instance_eval do 
+              
+              define_method("client") do 
+                return @client if @client
+                @client = nil
+                if IControl.configured?
+                  @client = Savon::Client.new IControl.config[:base_url] + "?WSDL=#{name.to_s}.#{class_name.to_s}"
+                  @client.request.basic_auth IControl.config[:user],IControl.config[:password]
+                  @client.request.http.ssl_client_auth( :verify_mode => OpenSSL::SSL::VERIFY_NONE )
+                else
+                  raise IControl::NotConfiguredException
+                end
+                return @client
+              end
+              
+              # This is done this way cause I need access to name and class_name
+              # metaprogramming to cross the scope, don't really like it actually.
+              # TODO: Make use of the delegation patern much more clean I think
+                            
+              define_method("method_missing") do |method_name,*args,&block|
+
+                raise IControl::NotConfiguredException unless IControl.configured?
+                if client 
+                  if client.wsdl.operations.keys.include?(method_name)  
+                    # When calling a soap method we transparently add the ns
+                    request = ""
+                    response = client.send(method_name,*args) do |soap|
+                      soap.namespaces["xmlns:wsdl"] = "urn:iControl:#{name}/#{class_name}"
+                      block.call(soap) if block
+                      request = soap.to_xml
+                    end
+                    # In case we save test fixtures
+                    IControl.save_test_info(request,response, client.wsdl ,"IControl.#{name}.#{class_name}#{IControl.config[:test_file_prefix]}",method_name) if IControl.config[:test]
+                    return self.map_response(response.to_hash)
+                  else
+                    client.send(method_name,*args,&block)
+                  end
+                else
+                  super(method_name,*args,&block)
+                end 
+              end
+            end
+          end
+          self.const_set(class_name,klass)
+        end
+      end
+    end
+    self.const_set(name,modulo)
+  end
+end
+
+# If we are going to redefine any give class we need to force the const_missing for the 
+# initial declaration to be made
+
+

data/lib/icontrol/common.rb

@@ -0,0 +1,109 @@
+
+# This is a helper for defining constants
+module IControl
+
+  class NoSuchPoolException < Exception; end
+  class MethodNotImplementedException < Exception; end
+
+  module ConstDefiner
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+
+      def class_name
+        self.name.split("::").last
+      end
+      
+      def declare_constants(constants,parent)
+        constants.each do |const_name|
+          klass = Class.new(parent)
+          self.const_set(const_name,klass)
+        end
+      end
+      
+      def from_string(klass)
+        return eval("::#{self}::#{klass}")
+      end 
+    end
+  end
+
+
+  module Common
+
+    class VLANFilterList
+      attr_accessor :state,:vlans
+      def initialize(attributes)
+        @state = IControl::Common::EnabledState.from_string(attributes[:state])
+        @vlans = [attributes[:vlans][:item]].flatten.compact
+      end
+
+    end
+
+    class ULong64
+      attr_accessor :high,:low
+
+      def initialize(options)
+        @high = options[:high].to_i
+        @low  = options[:low].to_i
+      end    
+
+      def to_f
+        retVal = 0.0
+        if @high >=0
+          retVal = @high << 32 & 0xffff0000
+        else 
+          retVal = ((@high & 0x7fffffff) << 32) + (0x80000000 << 32)
+        end
+        if  @low >=0
+          retVal += @low
+        else 
+          retVal += ((@low & 0x7fffffff) + 0x7fffffff)
+        end
+        return retVal; 
+      end
+      
+      def to_hash
+        return {:high => @high,:low => @low}
+      end
+
+    end
+
+    class SourcePortBehavior
+      include ConstDefiner
+      declare_constants [:SOURCE_PORT_PRESERVE,:SOURCE_PORT_PRESERVE_STRICT,:SOURCE_PORT_CHANGE],SourcePortBehavior
+    end
+
+    class EnabledState      
+      include ConstDefiner
+      declare_constants [:STATE_ENABLED,:STATE_DISABLED],EnabledState
+    end
+
+    class TMOSModule
+      include ConstDefiner
+      declare_constants [:TMOS_MODULE_ASM, :TMOS_MODULE_SAM, :TMOS_MODULE_WAM], TMOSModule
+    end
+
+    class ProtocolType
+      
+      include ConstDefiner
+      
+      valid_consts = [:PROTOCOL_ANY,:PROTOCOL_IPV6,:PROTOCOL_ROUTING,:PROTOCOL_NONE,
+                      :PROTOCOL_FRAGMENT,:PROTOCOL_DSTOPTS,:PROTOCOL_TCP,:PROTOCOL_UDP,
+                      :PROTOCOL_ICMP,:PROTOCOL_ICMPV6,:PROTOCOL_OSPF,:PROTOCOL_SCTP]
+      
+      declare_constants valid_consts,ProtocolType
+
+    end
+
+    class IPPortDefinition
+      attr_accessor :address,:port
+      def initialize(options)
+        @address = options[:address]
+        @port = options[:port]
+      end
+    end    
+  end
+end

data/lib/icontrol/local_lb/common.rb

@@ -0,0 +1,47 @@
+module IControl
+  module LocalLB
+    
+    class HardwareAccelerationMode
+      include IControl::ConstDefiner
+      declare_constants  [:HW_ACCELERATION_MODE_NONE, :HW_ACCELERATION_ASSIST, :HW_ACCELERATION_MODE_FULL ], HardwareAccelerationMode
+    end
+
+    class ClonePoolType
+      include IControl::ConstDefiner
+      declare_constants [ :CLONE_POOL_TYPE_UNDEFINED, :CLONE_POOL_TYPE_CLIENTSIDE, :CLONE_POOL_TYPE_SERVERSIDE ], ClonePoolType
+    end
+
+    class ProfileContextType
+      include IControl::ConstDefiner
+      declare_constants [ :PROFILE_CONTEXT_TYPE_ALL, :PROFILE_CONTEXT_TYPE_CLIENT, :PROFILE_CONTEXT_TYPE_SERVER], ProfileContextType
+    end
+
+    class SnatType
+      include IControl::ConstDefiner
+      declare_constants [ :SNAT_TYPE_NONE, :SNAT_TYPE_TRANSLATION_ADDRESS, :SNAT_TYPE_SNATPOOL, :SNAT_TYPE_AUTOMAP ], SnatType
+    end
+
+    class ProfileType
+      include IControl::ConstDefiner
+
+      declare_constants [ :PROFILE_TYPE_TCP, :PROFILE_TYPE_UDP, :PROFILE_TYPE_FTP, :PROFILE_TYPE_FAST_L4, 
+                          :PROFILE_TYPE_HTTP, :PROFILE_TYPE_SERVER_SSL, :PROFILE_TYPE_CLIENT_SSL, 
+                          :PROFILE_TYPE_AUTH, :PROFILE_TYPE_PERSISTENCE, :PROFILE_TYPE_CONNECTION_POOL, 
+                          :PROFILE_TYPE_STREAM, :PROFILE_TYPE_FAST_HTTP, :PROFILE_TYPE_IIOP, 
+                          :PROFILE_TYPE_RTSP, :PROFILE_TYPE_STATISTICS, :PROFILE_TYPE_HTTPCLASS, :PROFILE_TYPE_SCTP, 
+                          :PROFILE_TYPE_INSTANCE, :PROFILE_TYPE_SIPP ], ProfileType
+    end
+
+    class PersistenceMode
+      include IControl::ConstDefiner
+
+      declare_constants [ :PERSISTENCE_MODE_NONE, :PERSISTENCE_MODE_SOURCE_ADDRESS_AFFINITY, 
+                          :PERSISTENCE_MODE_DESTINATION_ADDRESS_AFFINITY, :PERSISTENCE_MODE_COOKIE, 
+                          :PERSISTENCE_MODE_MSRDP, :PERSISTENCE_MODE_SSL_SID, :PERSISTENCE_MODE_SIP, 
+                          :PERSISTENCE_MODE_UIE, :PERSISTENCE_MODE_HASH ], PersistenceMode
+      
+    end
+
+    
+  end
+end