netbox-client-ruby 0.0.1

data/lib/netbox_client_ruby/api/dcim/device.rb

@@ -0,0 +1,31 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device_type'
+require 'netbox_client_ruby/api/dcim/device_role'
+require 'netbox_client_ruby/api/tenancy/tenant'
+require 'netbox_client_ruby/api/dcim/platform'
+require 'netbox_client_ruby/api/dcim/site'
+require 'netbox_client_ruby/api/dcim/rack'
+require 'netbox_client_ruby/api/ipam/ip_address'
+
+module NetboxClientRuby
+  class Device
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'dcim/devices/:id.json'
+    creation_path 'dcim/devices/'
+    object_fields(
+      device_type: proc { |raw_data| NetboxClientRuby::DeviceType.new raw_data['id'] },
+      device_role: proc { |raw_data| NetboxClientRuby::DeviceRole.new raw_data['id'] },
+      tenant: proc { |raw_data| NetboxClientRuby::Tenant.new raw_data['id'] },
+      platform: proc { |raw_data| NetboxClientRuby::Platform.new raw_data['id'] },
+      site: proc { |raw_data| NetboxClientRuby::Site.new raw_data['id'] },
+      rack: proc { |raw_data| NetboxClientRuby::Rack.new raw_data['id'] },
+      parent_device: proc { |raw_data| NetboxClientRuby::Device.new raw_data['id'] },
+      primary_ip: proc { |raw_data| NetboxClientRuby::IpAddress.new raw_data['id'] },
+      primary_ip4: proc { |raw_data| NetboxClientRuby::IpAddress.new raw_data['id'] },
+      primary_ip6: proc { |raw_data| NetboxClientRuby::IpAddress.new raw_data['id'] }
+    )
+  end
+end

data/lib/netbox_client_ruby/api/dcim/device_role.rb

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

data/lib/netbox_client_ruby/api/dcim/device_roles.rb

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

data/lib/netbox_client_ruby/api/dcim/device_type.rb

@@ -0,0 +1,26 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/manufacturer'
+
+module NetboxClientRuby
+  class InterfaceOrdering
+    attr_reader :value, :label
+
+    def initialize(raw_data)
+      @value = raw_data['value']
+      @label = raw_data['label']
+    end
+  end
+
+  class DeviceType
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'dcim/device-types/:id.json'
+    creation_path 'dcim/device-types/'
+    object_fields(
+      manufacturer: proc { |raw_data| NetboxClientRuby::Manufacturer.new raw_data['id'] },
+      interface_ordering: NetboxClientRuby::InterfaceOrdering
+    )
+  end
+end

data/lib/netbox_client_ruby/api/dcim/device_types.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/device_type'
+
+module NetboxClientRuby
+  class DeviceTypes
+    include NetboxClientRuby::Entities
+
+    path 'dcim/device-types.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::DeviceType.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/devices.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/device'
+
+module NetboxClientRuby
+  class Devices
+    include NetboxClientRuby::Entities
+
+    path 'dcim/devices.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Device.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/interface.rb

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+
+module NetboxClientRuby
+  class Interface
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'dcim/interfaces/:id.json'
+    creation_path 'dcim/interfaces/'
+    object_fields device: proc { |raw_data| NetboxClientRuby::Device.new raw_data['id'] }
+  end
+end

data/lib/netbox_client_ruby/api/dcim/interfaces.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/interface'
+
+module NetboxClientRuby
+  class Interfaces
+    include NetboxClientRuby::Entities
+
+    path 'dcim/interfaces.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Interface.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/manufacturer.rb

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

data/lib/netbox_client_ruby/api/dcim/manufacturers.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/manufacturer'
+
+module NetboxClientRuby
+  class Manufacturers
+    include NetboxClientRuby::Entities
+
+    path 'dcim/manufacturers.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Manufacturer.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/platform.rb

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

data/lib/netbox_client_ruby/api/dcim/platforms.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/platform'
+
+module NetboxClientRuby
+  class Platforms
+    include NetboxClientRuby::Entities
+
+    path 'dcim/platforms.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Platform.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/rack.rb

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

data/lib/netbox_client_ruby/api/dcim/racks.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/rack'
+
+module NetboxClientRuby
+  class Racks
+    include NetboxClientRuby::Entities
+
+    path 'dcim/racks.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Rack.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/region.rb

@@ -0,0 +1,13 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  class Region
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'dcim/regions/:id.json'
+    creation_path 'dcim/regions/'
+    object_fields parent: proc { |raw_data| Region.new raw_data['id'] }
+  end
+end

data/lib/netbox_client_ruby/api/dcim/regions.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/region'
+
+module NetboxClientRuby
+  class Regions
+    include NetboxClientRuby::Entities
+
+    path 'dcim/regions.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Region.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim/site.rb

@@ -0,0 +1,15 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  class Site
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    readonly_fields :count_prefixes, :count_vlans, :count_racks, :count_devices,
+                    :count_circuits
+
+    deletable true
+    path 'dcim/sites/:id.json'
+    creation_path 'dcim/sites/'
+  end
+end

data/lib/netbox_client_ruby/api/dcim/sites.rb

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/site'
+
+module NetboxClientRuby
+  class Sites
+    include NetboxClientRuby::Entities
+
+    path 'dcim/sites.json'
+    data_key 'results'
+    count_key 'count'
+    entity_creator :entity_creator
+
+    private
+
+    def entity_creator(raw_entity)
+      NetboxClientRuby::Site.new raw_entity['id']
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam.rb

@@ -0,0 +1,53 @@
+require 'netbox_client_ruby/api/ipam/aggregate'
+require 'netbox_client_ruby/api/ipam/aggregates'
+require 'netbox_client_ruby/api/ipam/ip_addresses'
+require 'netbox_client_ruby/api/ipam/ip_address'
+require 'netbox_client_ruby/api/ipam/prefix'
+require 'netbox_client_ruby/api/ipam/prefixes'
+require 'netbox_client_ruby/api/ipam/rir'
+require 'netbox_client_ruby/api/ipam/rirs'
+require 'netbox_client_ruby/api/ipam/role'
+require 'netbox_client_ruby/api/ipam/roles'
+# require 'netbox_client_ruby/api/ipam/service'
+# require 'netbox_client_ruby/api/ipam/services'
+require 'netbox_client_ruby/api/ipam/vlan_group'
+require 'netbox_client_ruby/api/ipam/vlan_groups'
+require 'netbox_client_ruby/api/ipam/vlan'
+require 'netbox_client_ruby/api/ipam/vlans'
+require 'netbox_client_ruby/api/ipam/vrf'
+require 'netbox_client_ruby/api/ipam/vrfs'
+require 'netbox_client_ruby/communication'
+
+module NetboxClientRuby
+  class IPAM
+    {
+      aggregates: Aggregates,
+      ip_addresses: IpAddresses,
+      prefixes: Prefixes,
+      rirs: Rirs,
+      roles: Roles,
+      vlans: Vlans,
+      vlan_groups: VlanGroups,
+      vrfs: Vrfs
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) do
+        class_name.new
+      end
+    end
+
+    {
+      aggregate: Aggregate,
+      ip_address: IpAddress,
+      prefix: Prefix,
+      rir: Rir,
+      role: Role,
+      vlan: Vlan,
+      vlan_group: VlanGroup,
+      vrf: Vrf
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) do |id|
+        class_name.new id
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,42 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/interface'
+require 'netbox_client_ruby/api/ipam/vrf'
+require 'netbox_client_ruby/api/tenancy/tenant'
+
+module NetboxClientRuby
+  class IpAddress
+    include NetboxClientRuby::Entity
+
+    id id: :id
+    deletable true
+    path 'ipam/ip-addresses/:id.json'
+    creation_path 'ipam/ip-addresses/'
+    object_fields(
+      vrf: proc { |raw_data| NetboxClientRuby::Vrf.new raw_data['id'] },
+      tenant: proc { |raw_data| NetboxClientRuby::Tenant.new raw_data['id'] },
+      status: proc { |raw_data| NetboxClientRuby::IpAddressStatus.new raw_data['value'] },
+      interface: proc { |raw_data| NetboxClientRuby::Interface.new raw_data['id'] }
+    )
+    readonly_fields :display_name
+  end
+
+  class IpAddressStatus
+    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
+               when 5 then
+                 'DHCP'.freeze
+               else
+                 'UNDEFINED'.freeze
+               end
+    end
+  end
+end