netbox-client-ruby 0.0.1

data/lib/netbox_client_ruby/api/ipam/ip_addresses.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/ip_address'
+
+module NetboxClientRuby
+  class IpAddresses
+    include NetboxClientRuby::Entities
+
+    path 'ipam/ip-addresses.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::IpAddress.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/prefix.rb

@@ -0,0 +1,47 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/ipam/role'
+require 'netbox_client_ruby/api/dcim/site'
+require 'netbox_client_ruby/api/ipam/vrf'
+require 'netbox_client_ruby/api/ipam/vlan'
+require 'netbox_client_ruby/api/ipam/vlan_group'
+require 'netbox_client_ruby/api/tenancy/tenant'
+
+module NetboxClientRuby
+  class Prefix
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/prefixes/:id.json'
+    creation_path 'ipam/prefixes/'
+    object_fields(
+      site: proc { |raw_data| NetboxClientRuby::Site.new raw_data['id'] },
+      vrf: proc { |raw_data| NetboxClientRuby::Vrf.new raw_data['id'] },
+      tenant: proc { |raw_data| NetboxClientRuby::Tenant.new raw_data['id'] },
+      vlan: proc { |raw_data| NetboxClientRuby::Vlan.new raw_data['id'] },
+      status: proc { |raw_data| NetboxClientRuby::PrefixStatus.new raw_data['value'] },
+      role: proc { |raw_data| NetboxClientRuby::Role.new raw_data['id'] }
+    )
+    readonly_fields :display_name
+  end
+
+  class PrefixStatus
+    attr_reader :value, :label
+
+    def initialize(status_value)
+      @value = status_value
+      @label = case status_value
+               when 0 then
+                 'Container'.freeze
+               when 1 then
+                 'Active'.freeze
+               when 2 then
+                 'Reserved'.freeze
+               when 3 then
+                 'Deprecated'.freeze
+               else
+                 'UNDEFINED'.freeze
+               end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/prefixes.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/prefix'
+
+module NetboxClientRuby
+  class Prefixes
+    include NetboxClientRuby::Entities
+
+    path 'ipam/prefixes.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Prefix.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/rir.rb

@@ -0,0 +1,12 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  class Rir
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/rirs/:id.json'
+    creation_path 'ipam/rirs/'
+  end
+end

data/lib/netbox_client_ruby/api/ipam/rirs.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/rir'
+
+module NetboxClientRuby
+  class Rirs
+    include NetboxClientRuby::Entities
+
+    path 'ipam/rirs.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Rir.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/role.rb

@@ -0,0 +1,12 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  class Role
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/roles/:id.json'
+    creation_path 'ipam/roles/'
+  end
+end

data/lib/netbox_client_ruby/api/ipam/roles.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/role'
+
+module NetboxClientRuby
+  class Roles
+    include NetboxClientRuby::Entities
+
+    path 'ipam/roles.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Role.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/vlan.rb

@@ -0,0 +1,40 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/tenancy/tenant'
+require 'netbox_client_ruby/api/ipam/role'
+require 'netbox_client_ruby/api/ipam/vlan_group'
+
+module NetboxClientRuby
+  class Vlan
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/vlans/:id.json'
+    creation_path 'ipam/vlans/'
+    object_fields(
+      tenant: proc { |raw_data| NetboxClientRuby::Tenant.new raw_data['id'] },
+      role: proc { |raw_data| NetboxClientRuby::Role.new raw_data['id'] },
+      status: proc { |raw_data| NetboxClientRuby::VlanStatus.new raw_data['value'] },
+      group: proc { |raw_data| NetboxClientRuby::VlanGroup.new raw_data['id'] }
+    )
+    readonly_fields :display_name
+  end
+
+  class VlanStatus
+    attr_reader :value, :label
+
+    def initialize(status_value)
+      @value = status_value
+      @label = case status_value
+               when 1 then
+                 'Active'.freeze
+               when 2 then
+                 'Reserved'.freeze
+               when 3 then
+                 'Deprecated'.freeze
+               else
+                 'UNDEFINED'.freeze
+               end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/vlan_group.rb

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/site'
+
+module NetboxClientRuby
+  class VlanGroup
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/vlan-groups/:id.json'
+    creation_path 'ipam/vlan-groups/'
+    object_fields site: proc { |raw_data| NetboxClientRuby::Site.new raw_data['id'] }
+  end
+end

data/lib/netbox_client_ruby/api/ipam/vlan_groups.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/vlan_group'
+
+module NetboxClientRuby
+  class VlanGroups
+    include NetboxClientRuby::Entities
+
+    path 'ipam/vlan-groups.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::VlanGroup.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/vlans.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/vlan'
+
+module NetboxClientRuby
+  class Vlans
+    include NetboxClientRuby::Entities
+
+    path 'ipam/vlans.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Vlan.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam/vrf.rb

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/tenancy/tenant'
+
+module NetboxClientRuby
+  class Vrf
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/vrfs/:id.json'
+    creation_path 'ipam/vrfs/'
+    object_fields tenant: proc { |raw_data| NetboxClientRuby::Tenant.new raw_data['id'] }
+  end
+end

data/lib/netbox_client_ruby/api/ipam/vrfs.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/vrf'
+
+module NetboxClientRuby
+  class Vrfs
+    include NetboxClientRuby::Entities
+
+    path 'ipam/vrfs.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Vrf.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/tenancy.rb

@@ -0,0 +1,25 @@
+require 'netbox_client_ruby/api/tenancy/tenant'
+require 'netbox_client_ruby/api/tenancy/tenants'
+require 'netbox_client_ruby/api/tenancy/tenant_group'
+require 'netbox_client_ruby/api/tenancy/tenant_groups'
+require 'netbox_client_ruby/communication'
+
+module NetboxClientRuby
+  class Tenancy
+    def tenants
+      Tenants.new
+    end
+
+    def tenant(id)
+      Tenant.new id
+    end
+
+    def tenant_groups
+      TenantGroups.new
+    end
+
+    def tenant_group
+      TenantGroup.new
+    end
+  end
+end

data/lib/netbox_client_ruby/api/tenancy/tenant.rb

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/tenancy/tenant_group'
+
+module NetboxClientRuby
+  class Tenant
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'tenancy/tenants/:id.json'
+    creation_path 'tenancy/tenants/'
+    object_fields group: proc { |raw_data| NetboxClientRuby::TenantGroup.new raw_data['id'] }
+  end
+end

data/lib/netbox_client_ruby/api/tenancy/tenant_group.rb

@@ -0,0 +1,12 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  class TenantGroup
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'tenancy/tenant-groups/:id.json'
+    creation_path 'tenancy/tenant-groups/'
+  end
+end

data/lib/netbox_client_ruby/api/tenancy/tenant_groups.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/tenancy/tenant_group'
+
+module NetboxClientRuby
+  class TenantGroups
+    include NetboxClientRuby::Entities
+
+    path 'tenancy/tenant-groups.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::TenantGroup.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/tenancy/tenants.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/tenancy/tenant'
+
+module NetboxClientRuby
+  class Tenants
+    include NetboxClientRuby::Entities
+
+    path 'tenancy/tenants.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Tenant.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/communication.rb

@@ -0,0 +1,74 @@
+require 'netbox_client_ruby/error/client_error'
+require 'netbox_client_ruby/error/remote_error'
+require 'netbox_client_ruby/connection'
+
+module NetboxClientRuby
+  module Communication
+    def response(response)
+      return nil if response.status == 304
+      return {} if response.status == 204
+
+      raise_on_http_error response.status
+
+      read response
+    end
+
+    def connection
+      NetboxClientRuby::Connection.new
+    end
+
+    def hash_to_object(hash)
+      objectified_class = Class.new
+      objectified_instance = objectified_class.new
+      hash.each do |k, v|
+        variable_name = sanitize_variable_name(k)
+        variable_name = "_#{variable_name}" if objectified_instance.methods.map(&:to_s).include?(variable_name)
+
+        objectified_instance.instance_variable_set("@#{variable_name}", v)
+        objectified_class.send(:define_method, variable_name, proc { instance_variable_get("@#{variable_name}") })
+      end
+      objectified_instance
+    end
+
+    private
+
+    def read(response)
+      response.body
+    end
+
+    def raise_on_http_error(status)
+      case status
+      when 200..399 then
+      when 400..499 then
+        raise_on_http_client_error status
+      when 500..599 then
+        raise NetboxClientRuby::RemoteError, "#{status} Remote Error"
+      else
+        raise NetboxClientRuby::RemoteError, "#{status} Unknown Error Code"
+      end
+    end
+
+    def raise_on_http_client_error(status)
+      case status
+      when 400 then
+        raise NetboxClientRuby::ClientError, '400 Bad Request'
+      when 401 then
+        raise NetboxClientRuby::ClientError, '401 Unauthorized'
+      when 403 then
+        raise NetboxClientRuby::ClientError, '403 Forbidden'
+      when 405 then
+        raise NetboxClientRuby::ClientError, '405 Method Not Allowed'
+      when 415 then
+        raise NetboxClientRuby::ClientError, '415 Unsupported Media Type'
+      when 429 then
+        raise NetboxClientRuby::ClientError, '429 Too Many Requests'
+      else
+        raise NetboxClientRuby::ClientError, "#{status} Request Error"
+      end
+    end
+
+    def sanitize_variable_name(raw_name)
+      raw_name.gsub(/[^a-zA-Z0-9_]/, '_')
+    end
+  end
+end