smart_proxy_dhcp_bluecat 0.1.0 → 0.1.5

data/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_main.rb

@@ -1,109 +1,128 @@
-require 'dhcp_common/server'
-
-module Proxy::DHCP::BlueCat
-  class Provider < ::Proxy::DHCP::Server
-    include Proxy::Log
-    include Proxy::Util
-
-    attr_reader :connection
-    def initialize(connection, managed_subnets)
-      @connection = connection
-      @managed_subnets = managed_subnets
-      super('bluecat', managed_subnets, nil)
-    end
-
-    def subnets
-      logger.debug('START subnets')
-      subnets = @connection.get_subnets
-      logger.debug('END subnets')
-      logger.debug('Returned: ' + subnets.class.to_s + ': ' + subnets.to_s)
-      subnets
-    end
-
-    def all_hosts(network_address)
-      logger.debug('START all_hosts with network_address: ' + network_address.to_s)
-      hosts = @connection.get_hosts(network_address)
-      logger.debug('END all_hosts with network_address: ' + network_address.to_s)
-      logger.debug('Returned: ' + hosts.class.to_s + ': ' + hosts.to_s)
-      hosts
-    end
-
-    def all_leases(network_address)
-      logger.debug('START all_leases with network_address: ' + network_address.to_s)
-      hosts = @connection.get_hosts(network_address)
-      logger.debug('END all_leases with network_address: ' + network_address.to_s)
-      logger.debug('Returned: ' + hosts.class.to_s + ': ' + hosts.to_s)
-      hosts
-    end
-
-    def unused_ip(subnet, mac_address, from_ip_address, to_ip_address)
-      logger.debug('START unused_ip with subnet: ' + subnet.to_s + ' mac_address: ' + mac_address.to_s + ' from_ip_address: ' + from_ip_address.to_s + ' to_ip_address: ' + to_ip_address.to_s)
-      ip = @connection.get_next_ip(subnet, from_ip_address, to_ip_address)
-      logger.debug('END unused_ip with subnet: ' + subnet.to_s + ' mac_address: ' + mac_address.to_s + ' from_ip_address: ' + from_ip_address.to_s + ' to_ip_address: ' + to_ip_address.to_s)
-      logger.debug('Returned: ' + ip.class.to_s + ': ' + ip.to_s)
-      ip
-    end
-
-    def find_record(subnet_address, address)
-      logger.debug('START find_record with subnet_address: ' + subnet_address.to_s + ' address: ' + address.to_s)
-      records = if IPAddress.valid?(address)
-                  find_records_by_ip(subnet_address, address)
-                else
-                  find_record_by_mac(subnet_address, address)
-                end
-      logger.debug('END find_record with subnet_address: ' + subnet_address.to_s + ' address: ' + address.to_s)
-      logger.debug('Returned: ' + records.class.to_s + ': ' + records.to_s)
-      return [] if records.nil?
-      records
-    end
-
-    def find_records_by_ip(subnet_address, ip)
-      logger.debug('START find_records_by_ip with subnet_address: ' + subnet_address.to_s + ' ip: ' + ip.to_s)
-      records = @connection.get_hosts_by_ip(ip)
-      logger.debug('END find_records_by_ip with subnet_address: ' + subnet_address.to_s + ' ip: ' + ip.to_s)
-      logger.debug('Returned: ' + records.class.to_s + ': ' + records.to_s)
-      return [] if records.nil?
-      records
-    end
-
-    def find_record_by_mac(subnet_address, mac_address)
-      logger.debug('START find_record_by_mac with subnet_address: ' + subnet_address.to_s + ' mac_address: ' + mac_address.to_s)
-      record = @connection.get_host_by_mac(mac_address)
-      logger.debug('END find_record_by_mac with subnet_address: ' + subnet_address.to_s + ' mac_address: ' + mac_address.to_s)
-      logger.debug('Returned: ' + record.class.to_s + ': ' + record.to_s)
-      record
-    end
-
-    def find_subnet(subnet_address)
-      logger.debug('START find_subnet with subnet_address: ' + subnet_address.to_s)
-      net = @connection.find_mysubnet(subnet_address)
-      logger.debug('END find_subnet with subnet_address: ' + subnet_address.to_s)
-      logger.debug('Returned: ' + net.class.to_s + ': ' + net.to_s)
-      net
-    end
-
-    def get_subnet(subnet_address)
-      logger.debug('START get_subnet with subnet_address: ' + subnet_address.to_s)
-      net = @connection.find_mysubnet(subnet_address)
-      logger.debug('END get_subnet with subnet_address: ' + subnet_address.to_s)
-      logger.debug('Returned: ' + net.class.to_s + ': ' + net.to_s)
-      net
-    end
-
-    def add_record(options)
-      logger.debug('START add_record with options: ' + options.to_s)
-      @connection.add_host(options)
-      logger.debug('END add_record with options: ' + options.to_s)
-    end
-
-    def del_record(record)
-      logger.debug('START del_record with record: ' + record.to_s)
-      if record.empty?
-        logger.debug('record empty, nothing to do')
-      else
-        @connection.remove_host(record.ip)
-      end
-      logger.debug('END del_record with record: ' + record.to_s)
-    end
-  end
-end
+require 'dhcp_common/server'
+
+module Proxy
+  module DHCP
+    module BlueCat
+      # this class handles commuincation from foreman
+      class Provider < ::Proxy::DHCP::Server
+        include Proxy::Log
+        include Proxy::Util
+
+        attr_reader :connection
+        def initialize(connection, managed_subnets)
+          @connection = connection
+          @managed_subnets = managed_subnets
+          super('bluecat', managed_subnets, nil)
+        end
+
+        # returns all subnets
+        def subnets
+          logger.debug('START subnets')
+          subnets = @connection.subnets
+          logger.debug('END subnets')
+          logger.debug('Returned: ' + subnets.class.to_s + ': ' + subnets.to_s)
+          subnets
+        end
+
+        # returns all hosts in a subnet
+        # in bluecat leases and hosts are the same
+        def all_hosts(network_address)
+          logger.debug('START all_hosts with network_address: ' + network_address.to_s)
+          hosts = @connection.hosts(network_address)
+          logger.debug('END all_hosts with network_address: ' + network_address.to_s)
+          logger.debug('Returned: ' + hosts.class.to_s + ': ' + hosts.to_s)
+          hosts
+        end
+
+        # returns all leases in a subnet
+        # in bluecat leases and hosts are the same
+        def all_leases(network_address)
+          logger.debug('START all_leases with network_address: ' + network_address.to_s)
+          hosts = @connection.hosts(network_address)
+          logger.debug('END all_leases with network_address: ' + network_address.to_s)
+          logger.debug('Returned: ' + hosts.class.to_s + ': ' + hosts.to_s)
+          hosts
+        end
+
+        # returns the next free ip in a subnet
+        def unused_ip(subnet, mac_address, from_ip_address, to_ip_address)
+          logger.debug('START unused_ip with subnet: ' + subnet.to_s + ' mac_address: ' + mac_address.to_s + ' from_ip_address: ' + from_ip_address.to_s + ' to_ip_address: ' + to_ip_address.to_s)
+          ip = @connection.next_ip(subnet, from_ip_address, to_ip_address)
+          logger.debug('END unused_ip with subnet: ' + subnet.to_s + ' mac_address: ' + mac_address.to_s + ' from_ip_address: ' + from_ip_address.to_s + ' to_ip_address: ' + to_ip_address.to_s)
+          logger.debug('Returned: ' + ip.class.to_s + ': ' + ip.to_s)
+          ip
+        end
+
+        # returns a record
+        # foreman calls this method with a ip or a mac address
+        def find_record(subnet_address, address)
+          logger.debug('START find_record with subnet_address: ' + subnet_address.to_s + ' address: ' + address.to_s)
+          records = if IPAddress.valid?(address)
+                      find_records_by_ip(subnet_address, address)
+                    else
+                      find_record_by_mac(subnet_address, address)
+                    end
+          logger.debug('END find_record with subnet_address: ' + subnet_address.to_s + ' address: ' + address.to_s)
+          logger.debug('Returned: ' + records.class.to_s + ': ' + records.to_s)
+          return [] if records.nil?
+          records
+        end
+
+        # returns a record based on a ip address
+        def find_records_by_ip(subnet_address, ip)
+          logger.debug('START find_records_by_ip with subnet_address: ' + subnet_address.to_s + ' ip: ' + ip.to_s)
+          records = @connection.hosts_by_ip(ip)
+          logger.debug('END find_records_by_ip with subnet_address: ' + subnet_address.to_s + ' ip: ' + ip.to_s)
+          logger.debug('Returned: ' + records.class.to_s + ': ' + records.to_s)
+          return [] if records.nil?
+          records
+        end
+
+        # returns a record based on a mac address
+        def find_record_by_mac(subnet_address, mac_address)
+          logger.debug('START find_record_by_mac with subnet_address: ' + subnet_address.to_s + ' mac_address: ' + mac_address.to_s)
+          record = @connection.host_by_mac(mac_address)
+          logger.debug('END find_record_by_mac with subnet_address: ' + subnet_address.to_s + ' mac_address: ' + mac_address.to_s)
+          logger.debug('Returned: ' + record.class.to_s + ': ' + record.to_s)
+          record
+        end
+
+        # returns a subnet based on a subnet address
+        def find_subnet(subnet_address)
+          logger.debug('START find_subnet with subnet_address: ' + subnet_address.to_s)
+          net = @connection.find_mysubnet(subnet_address)
+          logger.debug('END find_subnet with subnet_address: ' + subnet_address.to_s)
+          logger.debug('Returned: ' + net.class.to_s + ': ' + net.to_s)
+          net
+        end
+
+        # returns a subnet based on a subnet address
+        def get_subnet(subnet_address)
+          logger.debug('START get_subnet with subnet_address: ' + subnet_address.to_s)
+          net = @connection.find_mysubnet(subnet_address)
+          logger.debug('END get_subnet with subnet_address: ' + subnet_address.to_s)
+          logger.debug('Returned: ' + net.class.to_s + ': ' + net.to_s)
+          net
+        end
+
+        # adds a host record
+        def add_record(options)
+          logger.debug('START add_record with options: ' + options.to_s)
+          @connection.add_host(options)
+          logger.debug('END add_record with options: ' + options.to_s)
+        end
+
+        # removes a host record
+        def del_record(record)
+          logger.debug('START del_record with record: ' + record.to_s)
+          if record.empty?
+            logger.debug('record empty, nothing to do')
+          else
+            @connection.remove_host(record.ip)
+          end
+          logger.debug('END del_record with record: ' + record.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_plugin.rb

@@ -1,34 +1,38 @@
-module Proxy::DHCP::BlueCat
-  class Plugin < ::Proxy::Provider
-    plugin :dhcp_bluecat, ::Proxy::DHCP::BlueCat::VERSION
-
-    validate_presence :scheme, :verify, :host, :parent_block, :view_name, :config_id, :config_name, :server_id, :username, :password
-
-    requires :dhcp, '>= 1.16'
-
-    load_classes ::Proxy::DHCP::BlueCat::PluginConfiguration
-    load_dependency_injection_wirings ::Proxy::DHCP::BlueCat::PluginConfiguration
-
-    load_validators scheme_validator: ::Proxy::DHCP::BlueCat::SchemeValidator,
-                    verify_validator: ::Proxy::DHCP::BlueCat::VerifyValidator,
-                    host_validator: ::Proxy::DHCP::BlueCat::HostValidator,
-                    parent_block_validator: ::Proxy::DHCP::BlueCat::ParentBlockValidator,
-                    view_name_validator: ::Proxy::DHCP::BlueCat::ViewNameValidator,
-                    config_id_validator: ::Proxy::DHCP::BlueCat::ConfigIdValidator,
-                    config_name_validator: ::Proxy::DHCP::BlueCat::ConfigNameValidator,
-                    server_id_validator: ::Proxy::DHCP::BlueCat::ServerIdValidator,
-                    username_validator: ::Proxy::DHCP::BlueCat::UsernameValidator,
-                    password_validator: ::Proxy::DHCP::BlueCat::PasswordValidator
-
-    validate :scheme, scheme_validator: true
-    validate :verify, verify_validator: true
-    validate :host, host_validator: true
-    validate :parent_block, parent_block_validator: true
-    validate :view_name, view_name_validator: true
-    validate :config_id, config_id_validator: true
-    validate :config_name, config_name_validator: true
-    validate :server_id, server_id_validator: true
-    validate :username, username_validator: true
-    validate :password, password_validator: true
-  end
-end
+module Proxy
+  module DHCP
+    module BlueCat
+      class Plugin < ::Proxy::Provider
+        plugin :dhcp_bluecat, ::Proxy::DHCP::BlueCat::VERSION
+
+        validate_presence :scheme, :verify, :host, :parent_block, :view_name, :config_id, :config_name, :server_id, :username, :password
+
+        requires :dhcp, '>= 1.16'
+
+        load_classes ::Proxy::DHCP::BlueCat::PluginConfiguration
+        load_dependency_injection_wirings ::Proxy::DHCP::BlueCat::PluginConfiguration
+
+        load_validators scheme_validator: ::Proxy::DHCP::BlueCat::SchemeValidator,
+                        verify_validator: ::Proxy::DHCP::BlueCat::VerifyValidator,
+                        host_validator: ::Proxy::DHCP::BlueCat::HostValidator,
+                        parent_block_validator: ::Proxy::DHCP::BlueCat::ParentBlockValidator,
+                        view_name_validator: ::Proxy::DHCP::BlueCat::ViewNameValidator,
+                        config_id_validator: ::Proxy::DHCP::BlueCat::ConfigIdValidator,
+                        config_name_validator: ::Proxy::DHCP::BlueCat::ConfigNameValidator,
+                        server_id_validator: ::Proxy::DHCP::BlueCat::ServerIdValidator,
+                        username_validator: ::Proxy::DHCP::BlueCat::UsernameValidator,
+                        password_validator: ::Proxy::DHCP::BlueCat::PasswordValidator
+
+        validate :scheme, scheme_validator: true
+        validate :verify, verify_validator: true
+        validate :host, host_validator: true
+        validate :parent_block, parent_block_validator: true
+        validate :view_name, view_name_validator: true
+        validate :config_id, config_id_validator: true
+        validate :config_name, config_name_validator: true
+        validate :server_id, server_id_validator: true
+        validate :username, username_validator: true
+        validate :password, password_validator: true
+      end
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/dhcp_bluecat_version.rb

@@ -1,7 +1,7 @@
 module Proxy
   module DHCP
     module BlueCat
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.1.5'.freeze
     end
   end
 end

data/lib/smart_proxy_dhcp_bluecat/module_loader.rb

@@ -1,6 +1,12 @@
-class ::Proxy::DHCP::BlueCat::ModuleLoader < ::Proxy::DefaultModuleLoader
-  def log_provider_settings(settings)
-    super(settings)
-    logger.warn('http is used for connection to BlueCat address manager') if settings[:scheme] != 'https'
-  end
-end
+module Proxy
+  module DHCP
+    module BlueCat
+      class ModuleLoader < ::Proxy::DefaultModuleLoader
+        def log_provider_settings(settings)
+          super(settings)
+          logger.warn('http is used for connection to BlueCat address manager') if settings[:scheme] != 'https'
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/plugin_configuration.rb

@@ -1,33 +1,37 @@
-module Proxy::DHCP::BlueCat
-  class PluginConfiguration
-    def load_classes
-      require 'dhcp_common/dhcp_common'
-      require 'smart_proxy_dhcp_bluecat/bluecat_api'
-      require 'smart_proxy_dhcp_bluecat/dhcp_bluecat_main'
-    end
-
-    def load_dependency_injection_wirings(c, settings)
-      c.dependency :connection, (lambda do
-                                   BlueCat.new(
-                                     settings[:scheme],
-                                     settings[:verify],
-                                     settings[:host],
-                                     settings[:parent_block],
-                                     settings[:view_name],
-                                     settings[:config_name],
-                                     settings[:config_id],
-                                     settings[:server_id],
-                                     settings[:username],
-                                     settings[:password]
-                                   )
-                                 end)
-
-      c.dependency :dhcp_provider, (lambda do
-                                      ::Proxy::DHCP::BlueCat::Provider.new(
-                                        c.get_dependency(:connection),
-                                        settings[:subnets]
-                                      )
-                                    end)
-    end
-  end
-end
+module Proxy
+  module DHCP
+    module BlueCat
+      class PluginConfiguration
+        def load_classes
+          require 'dhcp_common/dhcp_common'
+          require 'smart_proxy_dhcp_bluecat/bluecat_api'
+          require 'smart_proxy_dhcp_bluecat/dhcp_bluecat_main'
+        end
+
+        def load_dependency_injection_wirings(c, settings)
+          c.dependency :connection, (lambda do
+                                       ::Proxy::DHCP::BlueCat::BlueCatAPI.new(
+                                         settings[:scheme],
+                                         settings[:verify],
+                                         settings[:host],
+                                         settings[:parent_block],
+                                         settings[:view_name],
+                                         settings[:config_name],
+                                         settings[:config_id],
+                                         settings[:server_id],
+                                         settings[:username],
+                                         settings[:password]
+                                       )
+                                     end)
+
+          c.dependency :dhcp_provider, (lambda do
+                                          ::Proxy::DHCP::BlueCat::Provider.new(
+                                            c.get_dependency(:connection),
+                                            settings[:subnets]
+                                          )
+                                        end)
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_dhcp_bluecat/settings_validator.rb

@@ -1,62 +1,66 @@
-module ::Proxy::DHCP::BlueCat
-  class SchemeValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if ['http', 'https'].include?(settings[:scheme])
-      raise ::Proxy::Error::ConfigurationError, "Setting 'scheme' can be set to either 'http' or 'https'"
-    end
-  end
-  class VerifyValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if [true, false].include?(settings[:verify])
-      raise ::Proxy::Error::ConfigurationError, "Setting 'verify' can be set to either 'true' or 'false' (bool)"
-    end
-  end
-  class HostValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if ['http', 'https'].include?(settings[:scheme])
-      raise ::Proxy::Error::ConfigurationError, "Setting 'scheme' can be set to either 'http' or 'https'"
-    end
-  end
-  class ParentBlockValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:parent_block].is_a?(Integer)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'parent_block' must be (integer)"
-    end
-  end
-  class ViewNameValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:view_name].is_a?(String)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'view_name' must be (string)"
-    end
-  end
-  class ConfigIdValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:config_id].is_a?(Integer)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'parent_block' must be (integer)"
-    end
-  end
-  class ConfigNameValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:config_name].is_a?(String)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'config_name' must be (string)"
-    end
-  end
-  class ServerIdValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:server_id].is_a?(Integer)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'server_id' must be (integer)"
-    end
-  end
-  class UsernameValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:username].is_a?(String)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'username' must be (string)"
-    end
-  end
-  class PasswordValidator < ::Proxy::PluginValidators::Base
-    def validate!(settings)
-      return true if settings[:password].is_a?(String)
-      raise ::Proxy::Error::ConfigurationError, "Setting 'password' must be (string)"
-    end
-  end
-end
+module Proxy
+  module DHCP
+    module BlueCat
+      class SchemeValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if ['http', 'https'].include?(settings[:scheme])
+          raise ::Proxy::Error::ConfigurationError, "Setting 'scheme' can be set to either 'http' or 'https'"
+        end
+      end
+      class VerifyValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if [true, false].include?(settings[:verify])
+          raise ::Proxy::Error::ConfigurationError, "Setting 'verify' can be set to either 'true' or 'false' (bool)"
+        end
+      end
+      class HostValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if ['http', 'https'].include?(settings[:scheme])
+          raise ::Proxy::Error::ConfigurationError, "Setting 'scheme' can be set to either 'http' or 'https'"
+        end
+      end
+      class ParentBlockValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:parent_block].is_a?(Integer)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'parent_block' must be (integer)"
+        end
+      end
+      class ViewNameValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:view_name].is_a?(String)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'view_name' must be (string)"
+        end
+      end
+      class ConfigIdValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:config_id].is_a?(Integer)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'parent_block' must be (integer)"
+        end
+      end
+      class ConfigNameValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:config_name].is_a?(String)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'config_name' must be (string)"
+        end
+      end
+      class ServerIdValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:server_id].is_a?(Integer)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'server_id' must be (integer)"
+        end
+      end
+      class UsernameValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:username].is_a?(String)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'username' must be (string)"
+        end
+      end
+      class PasswordValidator < ::Proxy::PluginValidators::Base
+        def validate!(settings)
+          return true if settings[:password].is_a?(String)
+          raise ::Proxy::Error::ConfigurationError, "Setting 'password' must be (string)"
+        end
+      end
+    end
+  end
+end