smart_proxy_ipam 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b3ac65296507b0ad85c10e613a774692b1547ef25d39ce59bc5f28db6c28734
-  data.tar.gz: 2058474b34f87a243cadc4960c75de19041f532d6c6dc7e2d30a9d63cfc4786d
+  metadata.gz: 0754301cca6caabaf785d9c4a7753d8543289fa9754339c12f706d23610577d2
+  data.tar.gz: ad1c8b77662f0ff667ff1c2127bfb9af6221dfe67cd7877968c6425e20fc4074
 SHA512:
-  metadata.gz: 25200a0e7c4a88d00b79995863277879ea5f8e479f6b4626426e1b14c2237b43d7cf6c50c11e9f50158c7d8b6ca7dcee48794498931076994a72396434bcc327
-  data.tar.gz: b320b8cfbb6f7b2b92944dc2629d28bcfa7d3a1c2626661abdab510bb3866dfb59d75b0640f7e489015066a6c960a727b4039633ac22e0f328d45bc6927fe0ff
+  metadata.gz: 74ba390d81e5be049f0ab15c1586babb91feddbde52c513cf65c35cc140a7471d3f531d578da899b406c09bdebbf8f6039a15e8105bf8ee7bafd67bb5ec3e4a9
+  data.tar.gz: a6fe51e572df5e809546fea30864b5bdf153e7eb297bc0a6ae909eda79c181fc028f6b7c2421c1745f62ef20e94bbf55f2cfcd1f5a86270c1ed372db22c3722d

data/lib/smart_proxy_ipam/api_resource.rb

@@ -21,20 +21,17 @@ module Proxy::Ipam
       request = Net::HTTP::Get.new(uri)
       request[@auth_header] = @token
       request['Accept'] = 'application/json'
-      request['Content-Type'] = 'application/json'
 
       Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
         http.request(request)
       end
     end
 
-    def delete(path, body = nil)
+    def delete(path)
       uri = URI(@api_base + path)
-      uri.query = URI.encode_www_form(body) if body
       request = Net::HTTP::Delete.new(uri)
       request[@auth_header] = @token
       request['Accept'] = 'application/json'
-      request['Content-Type'] = 'application/json'
 
       Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
         http.request(request)

data/lib/smart_proxy_ipam/ip_cache.rb

@@ -4,38 +4,45 @@ require 'monitor'
 require 'concurrent'
 require 'time'
 require 'smart_proxy_ipam/ipam_helper'
+require 'singleton'
 
 module Proxy::Ipam
   # Class for managing temp in-memory cache to prevent same IP's being suggested in race conditions
   class IpCache
+    include Singleton
     include Proxy::Log
     include Proxy::Ipam::IpamHelper
 
     DEFAULT_CLEANUP_INTERVAL = 60
-    @@ip_cache = nil
-    @@timer_task = nil
-
-    def initialize(params = {})
-      @@m = Monitor.new
-      @provider = params[:provider].to_s
-      init_cache if @@ip_cache.nil?
-      start_cleanup_task if @@timer_task.nil?
+
+    def initialize
+      @m = Monitor.new
+      init_cache
+      start_cleanup_task
+    end
+
+    def set_provider(provider)
+      @provider = provider
+    end
+
+    def get_provider
+      @provider
     end
 
     def set_group(group, value)
-      @@ip_cache[group.to_sym] = value
+      @ip_cache[group.to_sym] = value
     end
 
     def get_group(group)
-      @@ip_cache[group.to_sym]
+      @ip_cache[group.to_sym]
     end
 
     def get_cidr(group, cidr)
-      @@ip_cache[group.to_sym][cidr.to_sym]
+      @ip_cache[group.to_sym][cidr.to_sym]
     end
 
     def get_ip(group_name, cidr, mac)
-      @@ip_cache[group_name.to_sym][cidr.to_sym][mac.to_sym][:ip]
+      @ip_cache[group_name.to_sym][cidr.to_sym][mac.to_sym][:ip]
     end
 
     def get_cleanup_interval
@@ -43,27 +50,27 @@ module Proxy::Ipam
     end
 
     def ip_exists(ip, cidr, group_name)
-      cidr_key = @@ip_cache[group_name.to_sym][cidr.to_sym]&.to_s
+      cidr_key = @ip_cache[group_name.to_sym][cidr.to_sym]&.to_s
       cidr_key.include?(ip.to_s)
     end
 
     def add(ip, mac, cidr, group_name)
-      logger.debug("Adding IP '#{ip}' to cache for subnet '#{cidr}' in group '#{group_name}' for provider #{@provider}")
-      @@m.synchronize do
+      logger.debug("Adding IP '#{ip}' to cache for subnet '#{cidr}' in group '#{group_name}' for IPAM provider #{@provider.to_s}")
+      @m.synchronize do
         mac_addr = mac.nil? || mac.empty? ? SecureRandom.uuid : mac
-        group_hash = @@ip_cache[group_name.to_sym]
+        group_hash = @ip_cache[group_name.to_sym]
 
         group_hash.each do |key, values|
           if values.keys.include? mac_addr.to_sym
-            @@ip_cache[group_name.to_sym][key].delete(mac_addr.to_sym)
+            @ip_cache[group_name.to_sym][key].delete(mac_addr.to_sym)
           end
-          @@ip_cache[group_name.to_sym].delete(key) if @@ip_cache[group_name.to_sym][key].nil? || @@ip_cache[group_name.to_sym][key].empty?
+          @ip_cache[group_name.to_sym].delete(key) if @ip_cache[group_name.to_sym][key].nil? || @ip_cache[group_name.to_sym][key].empty?
         end
 
         if group_hash.key?(cidr.to_sym)
-          @@ip_cache[group_name.to_sym][cidr.to_sym][mac_addr.to_sym] = {ip: ip.to_s, timestamp: Time.now.to_s}
+          @ip_cache[group_name.to_sym][cidr.to_sym][mac_addr.to_sym] = {ip: ip.to_s, timestamp: Time.now.to_s}
         else
-          @@ip_cache = @@ip_cache.merge({group_name.to_sym => {cidr.to_sym => {mac_addr.to_sym => {ip: ip.to_s, timestamp: Time.now.to_s}}}})
+          @ip_cache = @ip_cache.merge({group_name.to_sym => {cidr.to_sym => {mac_addr.to_sym => {ip: ip.to_s, timestamp: Time.now.to_s}}}})
         end
       end
     end
@@ -71,12 +78,12 @@ module Proxy::Ipam
     private
 
     def start_cleanup_task
-      logger.info("Starting ip cache maintenance for provider #{@provider}, used by /next_ip.")
-      @@timer_task = Concurrent::TimerTask.new(execution_interval: DEFAULT_CLEANUP_INTERVAL) { init_cache }
-      @@timer_task.execute
+      logger.info("Starting ip cache maintenance for IPAM provider #{@provider.to_s}, used by /next_ip.")
+      @timer_task = Concurrent::TimerTask.new(execution_interval: DEFAULT_CLEANUP_INTERVAL) { init_cache }
+      @timer_task.execute
     end
 
-    # @@ip_cache structure
+    # @ip_cache structure
     #
     # Groups of subnets are cached under the External IPAM Group name. For example,
     # "IPAM Group Name" would be the section name in phpIPAM. All IP's cached for subnets
@@ -107,22 +114,22 @@ module Proxy::Ipam
     #   }
     # }
     def init_cache
-      @@m.synchronize do
-        if @@ip_cache && !@@ip_cache.empty?
-          logger.debug("Processing ip cache for provider #{@provider}")
-          @@ip_cache.each do |group, subnets|
+      @m.synchronize do
+        if @ip_cache && !@ip_cache.empty?
+          logger.debug("Processing ip cache for IPAM provider #{@provider.to_s}")
+          @ip_cache.each do |group, subnets|
             subnets.each do |cidr, macs|
               macs.each do |mac, ip|
                 if Time.now - Time.parse(ip[:timestamp]) > DEFAULT_CLEANUP_INTERVAL
-                  @@ip_cache[group][cidr].delete(mac)
+                  @ip_cache[group][cidr].delete(mac)
                 end
               end
-              @@ip_cache[group].delete(cidr) if @@ip_cache[group][cidr].nil? || @@ip_cache[group][cidr].empty?
+              @ip_cache[group].delete(cidr) if @ip_cache[group][cidr].nil? || @ip_cache[group][cidr].empty?
             end
           end
         else
-          logger.debug("Clearing ip cache for provider #{@provider}")
-          @@ip_cache = {'': {}}
+          logger.debug("Clearing ip cache for IPAM provider #{@provider.to_s}")
+          @ip_cache = {'': {}}
         end
       end
     end

data/lib/smart_proxy_ipam/ipam_api.rb

@@ -51,7 +51,7 @@ module Proxy::Ipam
         group_name = get_request_group(params)
 
         next_ip = provider.get_next_ip(mac, cidr, group_name)
-        halt 404, { error: errors[:no_free_ips] }.to_json if next_ip.nil?
+        halt 404, { error: ERRORS[:no_free_ips] }.to_json if next_ip.nil?
         next_ip.to_json
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
@@ -60,8 +60,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -98,7 +98,7 @@ module Proxy::Ipam
         group_name = get_request_group(params)
         subnet = provider.get_ipam_subnet(cidr, group_name)
 
-        halt 404, { error: errors[:no_subnet] }.to_json if subnet.nil?
+        halt 404, { error: ERRORS[:no_subnet] }.to_json if subnet.nil?
         subnet.to_json
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
@@ -107,8 +107,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -139,9 +139,8 @@ module Proxy::Ipam
       content_type :json
 
       begin
-        halt 500, { error: errors[:groups_not_supported] }.to_json unless provider.groups_supported?
+        halt 500, { error: ERRORS[:groups_not_supported] }.to_json unless provider.groups_supported?
         groups = provider.get_ipam_groups
-        halt 404, { error: errors[:no_groups] }.to_json if groups.nil?
         groups.to_json
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
@@ -150,8 +149,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -186,7 +185,7 @@ module Proxy::Ipam
         group_name = get_request_group(params)
         group = provider.get_ipam_group(group_name)
 
-        halt 404, { error: errors[:no_group] }.to_json if group.nil?
+        halt 404, { error: ERRORS[:no_group] }.to_json if group.nil?
         group.to_json
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
@@ -195,8 +194,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -234,7 +233,7 @@ module Proxy::Ipam
         group_name = get_request_group(params)
         subnets = provider.get_ipam_subnets(group_name)
 
-        halt 404, { error: errors[:no_subnets_in_group] }.to_json if subnets.nil?
+        halt 404, { error: ERRORS[:no_subnets_in_group] }.to_json if subnets.nil?
         subnets.to_json
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
@@ -243,8 +242,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -276,7 +275,7 @@ module Proxy::Ipam
         group_name = get_request_group(params)
         subnet = provider.get_ipam_subnet(cidr, group_name)
 
-        halt 404, { error: errors[:no_subnet] }.to_json if subnet.nil?
+        halt 404, { error: ERRORS[:no_subnet] }.to_json if subnet.nil?
         validate_ip_in_cidr!(ip, cidr)
         ip_exists = provider.ip_exists?(ip, subnet[:id], group_name)
         halt 200, ip_exists.to_json
@@ -287,8 +286,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -321,13 +320,13 @@ module Proxy::Ipam
         group_name = get_request_group(params)
         subnet = provider.get_ipam_subnet(cidr, group_name)
 
-        halt 404, { error: errors[:no_subnet] }.to_json if subnet.nil?
+        halt 404, { error: ERRORS[:no_subnet] }.to_json if subnet.nil?
         add_ip_params = { cidr: cidr, subnet_id: subnet[:id], group_name: group_name }
         validate_ip_in_cidr!(ip, cidr)
 
         ip_added = provider.add_ip_to_subnet(ip, add_ip_params) # Returns nil on success
         halt 500, ip_added.to_json unless ip_added.nil?
-        halt 201
+        status 201
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
         halt 400, { error: e.to_s }.to_json
@@ -335,8 +334,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
 
@@ -369,13 +368,13 @@ module Proxy::Ipam
         group_name = get_request_group(params)
         subnet = provider.get_ipam_subnet(cidr, group_name)
 
-        halt 404, { error: errors[:no_subnet] }.to_json if subnet.nil?
+        halt 404, { error: ERRORS[:no_subnet] }.to_json if subnet.nil?
         del_ip_params = { cidr: cidr, subnet_id: subnet[:id], group_name: group_name }
         validate_ip_in_cidr!(ip, cidr)
 
         ip_deleted = provider.delete_ip_from_subnet(ip, del_ip_params) # Returns nil on success
         halt 500, ip_deleted.to_json unless ip_deleted.nil?
-        halt 200
+        halt 204
       rescue Proxy::Validations::Error => e
         logger.warn(e.message)
         halt 400, { error: e.to_s }.to_json
@@ -383,8 +382,8 @@ module Proxy::Ipam
         logger.warn(e.message)
         halt 500, { error: e.message }.to_json
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET
-        logger.warn(errors[:no_connection])
-        halt 500, { error: errors[:no_connection] }.to_json
+        logger.warn(ERRORS[:no_connection])
+        halt 500, { error: ERRORS[:no_connection] }.to_json
       end
     end
   end

data/lib/smart_proxy_ipam/ipam_helper.rb

@@ -3,12 +3,31 @@ module Proxy::Ipam::IpamHelper
   include ::Proxy::Validations
 
   MAX_IP_RETRIES = 5
+  ERRORS = {
+    cidr: "A 'cidr' parameter for the subnet must be provided(e.g. IPv4: 100.10.10.0/24, IPv6: 2001:db8:abcd:12::/124)",
+    mac: "A 'mac' address must be provided(e.g. 00:0a:95:9d:68:10)",
+    ip: "Missing 'ip' parameter. An IPv4 or IPv6 address must be provided(e.g. IPv4: 100.10.10.22, IPv6: 2001:db8:abcd:12::3)",
+    group_name: "A 'group_name' must be provided",
+    no_ip: 'IP address not found',
+    no_free_ips: 'No free addresses found',
+    no_connection: 'Unable to connect to External IPAM server',
+    no_group: 'Group not found in External IPAM',
+    no_groups: 'No groups found in External IPAM',
+    no_subnet: 'Subnet not found in External IPAM',
+    no_subnets_in_group: 'No subnets found in External IPAM group',
+    provider: "The IPAM provider must be specified(e.g. 'phpipam' or 'netbox')",
+    groups_not_supported: 'Groups are not supported',
+    add_ip: 'Error adding IP to External IPAM',
+    bad_mac: 'Mac address is invalid',
+    bad_ip: 'IP address is invalid',
+    bad_cidr: 'The network cidr is invalid'
+  }.freeze
 
   def provider
     @provider ||=
       begin
         unless client.authenticated?
-          halt 500, {error: 'Invalid credentials for External IPAM'}.to_json
+          halt 500, { error: 'Invalid credentials for External IPAM' }.to_json
         end
         client
       end
@@ -71,7 +90,7 @@ module Proxy::Ipam::IpamHelper
       end
     end
 
-    next_ip
+    {data: next_ip}
   end
 
   def increment_ip(ip)
@@ -88,26 +107,4 @@ module Proxy::Ipam::IpamHelper
     halt 500, { error: errors[:groups_not_supported] }.to_json if group && !provider.groups_supported?
     group
   end
-
-  def errors
-    {
-      cidr: "A 'cidr' parameter for the subnet must be provided(e.g. IPv4: 100.10.10.0/24, IPv6: 2001:db8:abcd:12::/124)",
-      mac: "A 'mac' address must be provided(e.g. 00:0a:95:9d:68:10)",
-      ip: "Missing 'ip' parameter. An IPv4 or IPv6 address must be provided(e.g. IPv4: 100.10.10.22, IPv6: 2001:db8:abcd:12::3)",
-      group_name: "A 'group_name' must be provided",
-      no_ip: 'IP address not found',
-      no_free_ips: 'No free addresses found',
-      no_connection: 'Unable to connect to External IPAM server',
-      no_group: 'Group not found in External IPAM',
-      no_groups: 'No groups found in External IPAM',
-      no_subnet: 'Subnet not found in External IPAM',
-      no_subnets_in_group: 'No subnets found in External IPAM group',
-      provider: "The IPAM provider must be specified(e.g. 'phpipam' or 'netbox')",
-      groups_not_supported: 'Groups are not supported',
-      add_ip: 'Error adding IP to External IPAM',
-      bad_mac: 'Mac address is invalid',
-      bad_ip: 'IP address is invalid',
-      bad_cidr: 'The network cidr is invalid'
-    }
-  end
 end

data/lib/smart_proxy_ipam/ipam_validator.rb

@@ -17,7 +17,7 @@ module Proxy::Ipam::IpamValidator
 
   def validate_ip!(ip)
     good_ip = ip =~ Regexp.union([Resolv::IPv4::Regex, Resolv::IPv6::Regex])
-    raise Proxy::Validations::Error, errors[:bad_ip] if good_ip.nil?
+    raise Proxy::Validations::Error, ERRORS[:bad_ip] if good_ip.nil?
     ip
   end
 
@@ -39,9 +39,9 @@ module Proxy::Ipam::IpamValidator
   end
 
   def validate_mac!(mac)
-    raise Proxy::Validations::Error.new, errors[:mac] if mac.nil? || mac.empty?
+    raise Proxy::Validations::Error.new, ERRORS[:mac] if mac.nil? || mac.empty?
     unless mac.match(/^([0-9a-fA-F]{2}[:]){5}[0-9a-fA-F]{2}$/i)
-      raise Proxy::Validations::Error.new, errors[:bad_mac]
+      raise Proxy::Validations::Error.new, ERRORS[:bad_mac]
     end
     mac
   end

data/lib/smart_proxy_ipam/netbox/netbox_client.rb

@@ -16,13 +16,12 @@ module Proxy::Netbox
     include Proxy::Ipam::IpamHelper
     include Proxy::Ipam::IpamValidator
 
-    @ip_cache = nil
-
     def initialize(conf)
       @api_base = "#{conf[:url]}/api/"
       @token = conf[:token]
-      @api_resource = Proxy::Ipam::ApiResource.new(api_base: @api_base, token: 'Token ' + @token)
-      @ip_cache = Proxy::Ipam::IpCache.new(provider: 'netbox')
+      @api_resource = Proxy::Ipam::ApiResource.new(api_base: @api_base, token: "Token #{@token}")
+      @ip_cache = Proxy::Ipam::IpCache.instance
+      @ip_cache.set_provider('netbox')
     end
 
     def get_ipam_subnet(cidr, group_name = nil)
@@ -35,7 +34,8 @@ module Proxy::Netbox
     end
 
     def get_ipam_subnet_by_group(cidr, group_id)
-      response = @api_resource.get("ipam/prefixes/?status=active&prefix=#{cidr}&vrf_id=#{group_id}")
+      params = URI.encode_www_form({ status: 'active', prefix: cidr, vrf_id: group_id })
+      response = @api_resource.get("ipam/prefixes/?#{params}")
       json_body = JSON.parse(response.body)
       return nil if json_body['count'].zero?
       subnet = subnet_from_result(json_body['results'][0])
@@ -43,7 +43,8 @@ module Proxy::Netbox
     end
 
     def get_ipam_subnet_by_cidr(cidr)
-      response = @api_resource.get("ipam/prefixes/?status=active&prefix=#{cidr}")
+      params = URI.encode_www_form({ status: 'active', prefix: cidr })
+      response = @api_resource.get("ipam/prefixes/?#{params}")
       json_body = JSON.parse(response.body)
       return nil if json_body['count'].zero?
       subnet = subnet_from_result(json_body['results'][0])
@@ -55,7 +56,7 @@ module Proxy::Netbox
       json_body = JSON.parse(response.body)
       groups = []
 
-      return nil if json_body['count'].zero?
+      return groups if json_body['count'].zero?
 
       json_body['results'].each do |group|
         groups.push({
@@ -68,8 +69,9 @@ module Proxy::Netbox
     end
 
     def get_ipam_group(group_name)
-      raise errors[:groups_not_supported] unless groups_supported?
-      response = @api_resource.get("ipam/vrfs/?name=#{group_name}")
+      raise ERRORS[:groups_not_supported] unless groups_supported?
+      params = URI.encode_www_form({ name: group_name })
+      response = @api_resource.get("ipam/vrfs/?#{params}")
       json_body = JSON.parse(response.body)
       return nil if json_body['count'].zero?
 
@@ -85,18 +87,19 @@ module Proxy::Netbox
     def get_group_id(group_name)
       return nil if group_name.nil? || group_name.empty?
       group = get_ipam_group(group_name)
-      raise errors[:no_group] if group.nil?
+      raise ERRORS[:no_group] if group.nil?
       group[:id]
     end
 
     def get_ipam_subnets(group_name)
       if group_name.nil?
-        response = @api_resource.get('ipam/prefixes/?status=active')
+        params = URI.encode_www_form({ status: 'active' })
       else
         group_id = get_group_id(group_name)
-        response = @api_resource.get("ipam/prefixes/?status=active&vrf_id=#{group_id}")
+        params = URI.encode_www_form({ status: 'active', vrf_id: group_id })
       end
 
+      response = @api_resource.get("ipam/prefixes/?#{params}")
       json_body = JSON.parse(response.body)
       return nil if json_body['count'].zero?
       subnets = []
@@ -115,9 +118,9 @@ module Proxy::Netbox
 
     def ip_exists?(ip, subnet_id, group_name)
       group_id = get_group_id(group_name)
-      url = "ipam/ip-addresses/?address=#{ip}"
-      url += "&prefix_id=#{subnet_id}" unless subnet_id.nil?
-      url += "&vrf_id=#{group_id}" unless group_id.nil?
+      url = "ipam/ip-addresses/?#{URI.encode_www_form({ address: ip })}"
+      url += "&#{URI.encode_www_form({ prefix_id: subnet_id })}" unless subnet_id.nil?
+      url += "&#{URI.encode_www_form({ vrf_id: group_id })}" unless group_id.nil?
       response = @api_resource.get(url)
       json_body = JSON.parse(response.body)
       return false if json_body['count'].zero?
@@ -145,15 +148,16 @@ module Proxy::Netbox
       group_name = params[:group_name]
 
       if group_name.nil? || group_name.empty?
-        response = @api_resource.get("ipam/ip-addresses/?address=#{ip}")
+        params = URI.encode_www_form({ address: ip })
       else
         group_id = get_group_id(group_name)
-        response = @api_resource.get("ipam/ip-addresses/?address=#{ip}&vrf_id=#{group_id}")
+        params = URI.encode_www_form({ address: ip, vrf_id: group_id })
       end
 
+      response = @api_resource.get("ipam/ip-addresses/?#{params}")
       json_body = JSON.parse(response.body)
 
-      return { error: errors[:no_ip] } if json_body['count'].zero?
+      return { error: ERRORS[:no_ip] } if json_body['count'].zero?
 
       address_id = json_body['results'][0]['id']
       response = @api_resource.delete("ipam/ip-addresses/#{address_id}/")
@@ -163,12 +167,13 @@ module Proxy::Netbox
 
     def get_next_ip(mac, cidr, group_name)
       subnet = get_ipam_subnet(cidr, group_name)
-      raise errors[:no_subnet] if subnet.nil?
+      raise ERRORS[:no_subnet] if subnet.nil?
       response = @api_resource.get("ipam/prefixes/#{subnet[:id]}/available-ips/?limit=1")
       json_body = JSON.parse(response.body)
       return nil if json_body.empty?
       ip = json_body[0]['address'].split('/').first
-      cache_next_ip(@ip_cache, ip, mac, cidr, subnet[:id], group_name)
+      next_ip = cache_next_ip(@ip_cache, ip, mac, cidr, subnet[:id], group_name)
+      { data: next_ip }
     end
 
     def groups_supported?

data/lib/smart_proxy_ipam/phpipam/phpipam_client.rb

@@ -16,14 +16,13 @@ module Proxy::Phpipam
     include Proxy::Ipam::IpamHelper
     include Proxy::Ipam::IpamValidator
 
-    @ip_cache = nil
-
     def initialize(conf)
       @conf = conf
       @api_base = "#{@conf[:url]}/api/#{@conf[:user]}/"
       @token = authenticate
       @api_resource = Proxy::Ipam::ApiResource.new(api_base: @api_base, token: @token, auth_header: 'Token')
-      @ip_cache = Proxy::Ipam::IpCache.new(provider: 'phpipam')
+      @ip_cache = Proxy::Ipam::IpCache.instance
+      @ip_cache.set_provider('phpipam')
     end
 
     def get_ipam_subnet(cidr, group_name = nil)
@@ -41,7 +40,7 @@ module Proxy::Phpipam
       subnet_id = nil
 
       subnets.each do |subnet|
-        subnet_cidr = subnet[:subnet] + '/' + subnet[:mask]
+        subnet_cidr = "#{subnet[:subnet]}/#{subnet[:mask]}"
         subnet_id = subnet[:id] if subnet_cidr == cidr
       end
 
@@ -78,7 +77,7 @@ module Proxy::Phpipam
       return nil if group_name.nil?
       group = @api_resource.get("sections/#{group_name}/")
       json_body = JSON.parse(group.body)
-      raise errors[:no_group] if json_body['data'].nil?
+      raise ERRORS[:no_group] if json_body['data'].nil?
 
       data = {
         id: json_body['data']['id'],
@@ -92,7 +91,7 @@ module Proxy::Phpipam
     def get_ipam_groups
       groups = @api_resource.get('sections/')
       json_body = JSON.parse(groups.body)
-      return nil if json_body['data'].nil?
+      return [] if json_body['data'].nil?
 
       data = []
       json_body['data'].each do |group|
@@ -108,7 +107,7 @@ module Proxy::Phpipam
 
     def get_ipam_subnets(group_name)
       group = get_ipam_group(group_name)
-      raise errors[:no_group] if group.nil?
+      raise ERRORS[:no_group] if group.nil?
       subnets = @api_resource.get("sections/#{group[:id]}/subnets/")
       json_body = JSON.parse(subnets.body)
       return nil if json_body['data'].nil?
@@ -149,12 +148,13 @@ module Proxy::Phpipam
 
     def get_next_ip(mac, cidr, group_name)
       subnet = get_ipam_subnet(cidr, group_name)
-      raise errors[:no_subnet] if subnet.nil?
+      raise ERRORS[:no_subnet] if subnet.nil?
       response = @api_resource.get("subnets/#{subnet[:id]}/first_free/")
       json_body = JSON.parse(response.body)
       return { error: json_body['message'] } if json_body['message']
       ip = json_body['data']
-      cache_next_ip(@ip_cache, ip, mac, cidr, subnet[:id], group_name)
+      next_ip = cache_next_ip(@ip_cache, ip, mac, cidr, subnet[:id], group_name)
+      { data: next_ip }
     end
 
     def groups_supported?
@@ -168,7 +168,7 @@ module Proxy::Phpipam
     private
 
     def authenticate
-      auth_uri = URI(@api_base + '/user/')
+      auth_uri = URI("#{@api_base}/user/")
       request = Net::HTTP::Post.new(auth_uri)
       request.basic_auth @conf[:user], @conf[:password]
 

data/lib/smart_proxy_ipam/version.rb

@@ -1,5 +1,5 @@
 module Proxy
   module Ipam
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_ipam
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christopher Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies: []
-description: Smart proxy plugin for IPAM integration with various IPAM providers
+description: Smart proxy plugin for integration with various External IPAM providers
 email: chrisjsmith001@gmail.com
 executables: []
 extensions: []
@@ -60,5 +60,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
-summary: Smart proxy plugin for IPAM integration with various IPAM providers
+summary: Smart proxy plugin for integration with External IPAM providers
 test_files: []