netbox-client-ruby 0.4.10 → 0.5.4

data/lib/netbox_client_ruby/api.rb

@@ -1,3 +1,4 @@
+require 'netbox_client_ruby/api/circuits'
 require 'netbox_client_ruby/api/dcim'
 require 'netbox_client_ruby/api/ipam'
 require 'netbox_client_ruby/api/secrets'
@@ -6,6 +7,10 @@ require 'netbox_client_ruby/api/virtualization'
 require 'netbox_client_ruby/communication'
 
 module NetboxClientRuby
+  def self.circuits
+    NetboxClientRuby::Circuits
+  end
+
   def self.dcim
     NetboxClientRuby::DCIM
   end

data/lib/netbox_client_ruby/api/circuits.rb

@@ -0,0 +1,33 @@
+require 'netbox_client_ruby/api/circuits/circuit'
+require 'netbox_client_ruby/api/circuits/circuits'
+require 'netbox_client_ruby/api/circuits/circuit_termination'
+require 'netbox_client_ruby/api/circuits/circuit_terminations'
+require 'netbox_client_ruby/api/circuits/circuit_type'
+require 'netbox_client_ruby/api/circuits/circuit_types'
+require 'netbox_client_ruby/api/circuits/provider'
+require 'netbox_client_ruby/api/circuits/providers'
+require 'netbox_client_ruby/communication'
+
+module NetboxClientRuby
+  module Circuits
+    {
+      providers: Providers,
+      circuits: Circuits,
+      circuit_types: CircuitTypes,
+      circuit_terminations: CircuitTerminations
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) { class_name.new }
+      module_function(method_name)
+    end
+
+    {
+      provider: Provider,
+      circuit: Circuit,
+      circuit_type: CircuitType,
+      circuit_termination: CircuitTermination
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) { |id| class_name.new id }
+      module_function(method_name)
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/circuit.rb

@@ -0,0 +1,37 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/circuits/circuit_type'
+require 'netbox_client_ruby/api/circuits/provider'
+require 'netbox_client_ruby/api/tenancy/tenant'
+
+module NetboxClientRuby
+  module Circuits
+    class Circuit
+      include Entity
+
+      STATUS_VALUES = {
+        deprovisioning: 0,
+        active: 1,
+        planned: 2,
+        provisioning: 3,
+        offline: 4,
+        decommissioned: 5
+      }.freeze
+
+      id id: :id
+      deletable true
+      path 'circuits/circuits/:id.json'
+      creation_path 'circuits/circuits/'
+
+      object_fields(
+        provider: proc do |raw_data|
+          Provider.new raw_data['id']
+        end,
+        status: proc do |raw_status|
+          STATUS_VALUES.key(raw_status['value']) || raw_status['value']
+        end,
+        type: proc { |raw_data| CircuitType.new raw_data['id'] },
+        tenant: proc { |raw_data| Tenancy::Tenant.new raw_data['id'] }
+      )
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/circuit_termination.rb

@@ -0,0 +1,23 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/circuits/circuit'
+require 'netbox_client_ruby/api/dcim/site'
+require 'netbox_client_ruby/api/dcim/interface'
+
+module NetboxClientRuby
+  module Circuits
+    class CircuitTermination
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'circuits/circuit-terminations/:id.json'
+      creation_path 'circuits/circuit-terminations/'
+
+      object_fields(
+        circuit: proc { |raw_data| Circuit::Circuit.new raw_data['id'] },
+        site: proc { |raw_data| DCIM::Site.new raw_data['id'] },
+        interface: proc { |raw_data| DCIM::Interface.new raw_data['id'] }
+      )
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/circuit_terminations.rb

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/circuits/circuit_termination'
+
+module NetboxClientRuby
+  module Circuits
+    class CircuitTerminations
+      include Entities
+
+      path 'circuits/circuit-terminations.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        CircuitTermination.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/circuit_type.rb

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  module Circuits
+    class CircuitType
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'circuits/circuit-types/:id.json'
+      creation_path 'circuits/circuit-types/'
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/circuit_types.rb

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/circuits/circuit_type'
+
+module NetboxClientRuby
+  module Circuits
+    class CircuitTypes
+      include Entities
+
+      path 'circuits/circuit-types.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        CircuitType.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/circuits.rb

@@ -0,0 +1,26 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/circuits/circuit'
+
+module NetboxClientRuby
+  module Circuits
+    ##
+    # This allows to access a list of Netbox Circuits.
+    #
+    # Normally, this class would be called `Circuits`.
+    # But this conflicts with the module of the same name.
+    class Circuits
+      include Entities
+
+      path 'circuits/circuits.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        Circuit.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/provider.rb

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  module Circuits
+    class Provider
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'circuits/providers/:id.json'
+      creation_path 'circuits/providers/'
+    end
+  end
+end

data/lib/netbox_client_ruby/api/circuits/providers.rb

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/circuits/provider'
+
+module NetboxClientRuby
+  module Circuits
+    class Providers
+      include Entities
+
+      path 'circuits/providers.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        Provider.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/dcim.rb

@@ -1,3 +1,9 @@
+require 'netbox_client_ruby/api/dcim/console_connection'
+require 'netbox_client_ruby/api/dcim/console_connections'
+require 'netbox_client_ruby/api/dcim/console_port'
+require 'netbox_client_ruby/api/dcim/console_ports'
+require 'netbox_client_ruby/api/dcim/console_server_port'
+require 'netbox_client_ruby/api/dcim/console_server_ports'
 require 'netbox_client_ruby/api/dcim/device'
 require 'netbox_client_ruby/api/dcim/devices'
 require 'netbox_client_ruby/api/dcim/device_role'
@@ -5,6 +11,8 @@ require 'netbox_client_ruby/api/dcim/device_roles'
 require 'netbox_client_ruby/api/dcim/device_type'
 require 'netbox_client_ruby/api/dcim/device_types'
 require 'netbox_client_ruby/api/dcim/interface'
+require 'netbox_client_ruby/api/dcim/interface_connection'
+require 'netbox_client_ruby/api/dcim/interface_connections'
 require 'netbox_client_ruby/api/dcim/interfaces'
 require 'netbox_client_ruby/api/dcim/inventory_item'
 require 'netbox_client_ruby/api/dcim/inventory_items'
@@ -12,6 +20,8 @@ require 'netbox_client_ruby/api/dcim/manufacturer'
 require 'netbox_client_ruby/api/dcim/manufacturers'
 require 'netbox_client_ruby/api/dcim/platform'
 require 'netbox_client_ruby/api/dcim/platforms'
+require 'netbox_client_ruby/api/dcim/power_connection'
+require 'netbox_client_ruby/api/dcim/power_connections'
 require 'netbox_client_ruby/api/dcim/power_outlet'
 require 'netbox_client_ruby/api/dcim/power_outlets'
 require 'netbox_client_ruby/api/dcim/power_port'
@@ -19,6 +29,8 @@ require 'netbox_client_ruby/api/dcim/power_ports'
 require 'netbox_client_ruby/api/dcim/rack'
 require 'netbox_client_ruby/api/dcim/rack_group'
 require 'netbox_client_ruby/api/dcim/rack_groups'
+require 'netbox_client_ruby/api/dcim/rack_reservation'
+require 'netbox_client_ruby/api/dcim/rack_reservations'
 require 'netbox_client_ruby/api/dcim/rack_role'
 require 'netbox_client_ruby/api/dcim/rack_roles'
 require 'netbox_client_ruby/api/dcim/racks'
@@ -26,45 +38,61 @@ require 'netbox_client_ruby/api/dcim/region'
 require 'netbox_client_ruby/api/dcim/regions'
 require 'netbox_client_ruby/api/dcim/site'
 require 'netbox_client_ruby/api/dcim/sites'
+require 'netbox_client_ruby/api/dcim/virtual_chassis'
+require 'netbox_client_ruby/api/dcim/virtual_chassis_list'
 require 'netbox_client_ruby/communication'
 
 module NetboxClientRuby
   module DCIM
     {
+      console_connections: ConsoleConnections,
+      console_ports: ConsolePorts,
+      console_server_ports: ConsoleServerPorts,
       devices: Devices,
       device_roles: DeviceRoles,
       device_types: DeviceTypes,
       interfaces: Interfaces,
+      interface_connections: InterfaceConnections,
       inventory_items: InventoryItems,
       manufacturers: Manufacturers,
       platforms: Platforms,
+      power_connections: PowerConnections,
       power_outlets: PowerOutlets,
       power_ports: PowerPorts,
       racks: Racks,
       rack_groups: RackGroups,
+      rack_reservations: RackReservations,
       rack_roles: RackRoles,
       regions: Regions,
-      sites: Sites
+      sites: Sites,
+      virtual_chassis_list: VirtualChassisList
     }.each_pair do |method_name, class_name|
       define_method(method_name) { class_name.new }
       module_function(method_name)
     end
 
     {
+      console_connection: ConsoleConnection,
+      console_port: ConsolePort,
+      console_server_port: ConsoleServerPort,
       device: Device,
       device_role: DeviceRole,
       device_type: DeviceType,
       interface: Interface,
+      interface_connection: InterfaceConnection,
       inventory_item: InventoryItem,
       manufacturer: Manufacturer,
       platform: Platform,
+      power_connection: PowerConnection,
       power_outlet: PowerOutlet,
       power_port: PowerPort,
       rack: Rack,
       rack_group: RackGroup,
+      rack_reservation: RackReservation,
       rack_role: RackRole,
       region: Region,
-      site: Site
+      site: Site,
+      virtual_chassis: VirtualChassis
     }.each_pair do |method_name, class_name|
       define_method(method_name) { |id| class_name.new id }
       module_function(method_name)

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+require 'netbox_client_ruby/api/dcim/console_server_port'
+
+module NetboxClientRuby
+  module DCIM
+    class ConsoleConnection
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/console-connections/:id.json'
+      creation_path 'dcim/console-connections/'
+
+      object_fields(
+        device: proc { |raw_data| Device.new raw_data['id'] },
+        cs_port: proc { |raw_data| ConsoleServerPort.new raw_data['id'] },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/console_connection'
+
+module NetboxClientRuby
+  module DCIM
+    class ConsoleConnections
+      include Entities
+
+      path 'dcim/console-connections.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        ConsoleConnection.new raw_entity['id']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+require 'netbox_client_ruby/api/dcim/console_server_port'
+
+module NetboxClientRuby
+  module DCIM
+    class ConsolePort
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/console-ports/:id.json'
+      creation_path 'dcim/console-ports/'
+
+      object_fields(
+        device: proc { |raw_data| Device.new raw_data['id'] },
+        cs_port: proc { |raw_data| ConsoleServerPort.new raw_data['id'] },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/console_port'
+
+module NetboxClientRuby
+  module DCIM
+    class ConsolePorts
+      include Entities
+
+      path 'dcim/console-ports.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        ConsolePort.new raw_entity['id']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+require 'netbox_client_ruby/api/dcim/console_port'
+
+module NetboxClientRuby
+  module DCIM
+    class ConsoleServerPort
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/console-server-ports/:id.json'
+      creation_path 'dcim/console-server-ports/'
+
+      object_fields(
+        device: proc { |raw_data| Device.new raw_data['id'] },
+        connected_console: proc { |raw_data| ConsolePort.new raw_data },
+      )
+    end
+  end
+end