smart_proxy_dhcp_kea_api 1.0.0

data/lib/smart_proxy_dhcp_kea_api/plugin_configuration.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Proxy
+  module DHCP
+    module KeaApi
+      # This class manages the setup and configuration of the KeaApi plugin's
+      # internal components. It follows a pattern used by the Foreman Smart Proxy's
+      # dependency injection (DI) framework. Its responsibilities are divided into
+      # two main parts: loading the necessary classes into memory and then "wiring"
+      # them together by defining how each service gets created and what its
+      # dependencies are.
+      class PluginConfiguration
+        # Loads all the necessary classes for this provider into memory.
+        # This is called by the Smart Proxy before the dependency injection
+        # wirings are configured.
+
+        def load_classes
+          require 'dhcp_common/free_ips'
+          require 'smart_proxy_dhcp_kea_api/kea_api_client'
+          require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_subnet_service'
+          require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_main'
+        end
+
+        # Configures the dependency injection wirings for the KeaApi provider.
+        # The container is responsible for creating and managing instances of our services.
+        #
+        # @param container [Proxy::DependencyInjection::Container] The DI container to register services with.
+        # @param settings [Hash] The settings hash for this provider.
+
+        def load_dependency_injection_wirings(container, settings)
+          # A standard in-memory key-value store provided by the Smart Proxy framework.
+          # It's used by the SubnetService to cache DHCP data.
+          container.singleton_dependency :memory_store, -> { ::Proxy::MemoryStore.new }
+
+          # A singleton service that manages the temporary blacklisting of suggested IP addresses
+          # to prevent race conditions. Its duration is configured via the settings file.
+          container.singleton_dependency :unused_ips, -> { ::Proxy::DHCP::FreeIps.new(settings[:blacklist_duration_minutes]) }
+
+          # The custom client for communicating with the Kea API. This is registered as a singleton
+          # so that a single, persistent HTTP connection pool is used for all API calls.
+          container.singleton_dependency :kea_client, (lambda do
+            ::Proxy::DHCP::KeaApi::Client.new(
+              url: settings[:kea_api_url],
+              open_timeout: settings[:open_timeout],
+              read_timeout: settings[:read_timeout]
+            )
+          end)
+
+          # The custom service for caching all subnet, reservation, and lease data.
+          # This is a singleton because we want one central, authoritative cache that all
+          # requests can share. It depends on the Kea client to fetch data and the memory
+          # stores to cache it.
+          container.singleton_dependency :subnet_service, (lambda do
+            memory_store = container.get_dependency(:memory_store)
+            ::Proxy::DHCP::KeaApi::SubnetService.new(
+              container.get_dependency(:kea_client),
+              memory_store,
+              memory_store,
+              memory_store,
+              memory_store,
+              memory_store
+            )
+          end)
+
+          # The main provider class that ties everything together. This is the entry point
+          # for handling DHCP requests from Foreman. It depends on the subnet service,
+          # the API client, and the IP blacklist service to do its job.
+          container.dependency :dhcp_provider, (lambda do
+            ::Proxy::DHCP::KeaApi::Provider.new(
+              container.get_dependency(:subnet_service),
+              container.get_dependency(:kea_client),
+              container.get_dependency(:unused_ips)
+            )
+          end)
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_dhcp_kea_api.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Proxy
+  module DHCP
+    # The top-level namespace for this DHCP provider. All classes, modules,
+    # and services related to the Kea API integration will be defined within
+    # this KeaApi module to prevent naming conflicts with other plugins.
+    module KeaApi; end
+  end
+end
+
+# Require all the plugin's classes so they are available in the test environment
+require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_version'
+require 'smart_proxy_dhcp_kea_api/kea_api_client'
+require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_subnet_service'
+require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_main'
+require 'smart_proxy_dhcp_kea_api/plugin_configuration'
+require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_plugin'

data/smart_proxy_dhcp_kea_api.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'smart_proxy_dhcp_kea_api/dhcp_kea_api_version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = 'smart_proxy_dhcp_kea_api'
+  s.version     = Proxy::DHCP::KeaApi::VERSION
+  s.authors     = ['Sam McCarthy']
+  s.homepage    = 'https://gitlab.surrey.ac.uk/sm0049/smart-proxy-dhcp-kea-api'
+  s.summary     = 'Foreman Smart Proxy plugin for ISC Kea DHCP API'
+  s.description = 'Provides DHCP management for Foreman via the ISC Kea API, requiring the host_cmds and lease_cmds hooks.'
+  s.license     = 'GPL-3.0-only'
+  s.required_ruby_version = '>= 3.0', '< 4'
+
+  s.files = Dir.glob('{lib}/**/*', File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+  s.files += %w[LICENSE README.md smart_proxy_dhcp_kea_api.gemspec]
+
+  s.require_paths = ['lib']
+
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: smart_proxy_dhcp_kea_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sam McCarthy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-17 00:00:00.000000000 Z
+dependencies: []
+description: Provides DHCP management for Foreman via the ISC Kea API, requiring the
+  host_cmds and lease_cmds hooks.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/smart_proxy_dhcp_kea_api.rb
+- lib/smart_proxy_dhcp_kea_api/dhcp_kea_api_main.rb
+- lib/smart_proxy_dhcp_kea_api/dhcp_kea_api_plugin.rb
+- lib/smart_proxy_dhcp_kea_api/dhcp_kea_api_subnet_service.rb
+- lib/smart_proxy_dhcp_kea_api/dhcp_kea_api_version.rb
+- lib/smart_proxy_dhcp_kea_api/kea_api_client.rb
+- lib/smart_proxy_dhcp_kea_api/plugin_configuration.rb
+- smart_proxy_dhcp_kea_api.gemspec
+homepage: https://gitlab.surrey.ac.uk/sm0049/smart-proxy-dhcp-kea-api
+licenses:
+- GPL-3.0-only
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Foreman Smart Proxy plugin for ISC Kea DHCP API
+test_files: []