netbox-client-ruby 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4ce6b89340a7c8795dcd0fe79e5eead1d7ca11abf6b767673ff16465d142b2f
-  data.tar.gz: a0540c0ad802030518779007d5c712d15edb3c8c08f79b3c6dc83cb22f6a94ef
+  metadata.gz: 85ce04cb9854fd468e6c4d99c2233d84e133a7488179cfdbcea8a1e89f2a4fec
+  data.tar.gz: 88e8bbfed0e980c15e31baa5c90b477a85a4131a567773be557c0f566031b9e2
 SHA512:
-  metadata.gz: b6c23ecd8297b3efe23fd304a611580b593c2bb8d6ffd54da847ac06c01d5bbef0ab5fc2f5f1b08e50c35063bcb1edcdb4d8b97e49ff0641fb4deb2827a9e008
-  data.tar.gz: 55f743a9d3784714179c6c566ea887da2d04aabcc21693504b4989ba6f2061876aabd4c9da1eb1aa9ca34d9a36afa1e0cb4b5f7b095161c6cdc8d9ce671619c2
+  metadata.gz: 3b0e0f3ae1cb4d7975292edee8692835c278759f46e1fe271a405f1580cb2b061e738b0daf50e55250edb12cf7e3a74eeebf939b4e3f8e4c954e250ebc7a6a50
+  data.tar.gz: 0ebd13d8c1b3282510aaff72cd0d8c8f08484f43e696a98a22040f4495446f57783c47dc00b47fd4a40d00341496622e3025bf46d83531bfc1f045203e94524c

data/README.md

@@ -135,48 +135,56 @@ Not all objects which the Netbox API exposes are currently implemented. Implemen
 [is trivial](https://github.com/ninech/netbox-client-ruby/commit/e3cee19d21a8a6ce480d7c03d23d7c3fbc92417a), though.
 
 * Circuits:
-  * Circuits
-  * Circuit Types
-  * Circuit Terminations
-  * Providers
+  * Circuits: `NetboxClientRuby.circuits.circuits`
+  * Circuit Types: `NetboxClientRuby.circuits.circuit_types`
+  * Circuit Terminations: `NetboxClientRuby.circuits.circuit_terminations`
+  * Providers: `NetboxClientRuby.circuits.providers`
 * DCIM:
-  * Devices
-  * Device Roles
-  * Device Types
-  * Interfaces
-  * Manufacturers
-  * Platforms
-  * Power Outlets
-  * Power Ports
-  * Racks
-  * Rack Groups
-  * Rack Roles
-  * Rack Reservations
-  * Regions
-  * Sites
+  * Console Connections: `NetboxClientRuby.dcim.console_connections`
+  * Console Ports: `NetboxClientRuby.dcim.console_ports`
+  * Console Server Ports: `NetboxClientRuby.dcim.console_server_ports`
+  * Devices: `NetboxClientRuby.dcim.devices`
+  * Device Roles: `NetboxClientRuby.dcim.device_roles`
+  * Device Types: `NetboxClientRuby.dcim.device_types`
+  * Interfaces: `NetboxClientRuby.dcim.interfaces`
+  * Interface Connections: `NetboxClientRuby.dcim.interface_connections`
+  * Manufacturers: `NetboxClientRuby.dcim.manufacturers`
+  * Platforms: `NetboxClientRuby.dcim.platforms`
+  * Power Connections: `NetboxClientRuby.dcim.power_connections`
+  * Power Outlets: `NetboxClientRuby.dcim.power_outlets`
+  * Power Ports: `NetboxClientRuby.dcim.power_ports`
+  * Racks: `NetboxClientRuby.dcim.racks`
+  * Rack Groups: `NetboxClientRuby.dcim.rack_groups`
+  * Rack Roles: `NetboxClientRuby.dcim.rack_roles`
+  * Rack Reservations: `NetboxClientRuby.dcim.rack_reservations`
+  * Regions: `NetboxClientRuby.dcim.regions`
+  * Sites: `NetboxClientRuby.dcim.sites`
+  * Virtual Chassis: `NetboxClientRuby.dcim.virtual_chassis_list`
+    (⚠️ Exception: The access is different and the class is called `VirtualChassisList` because the plural and singular
+    names are the same and this poses a conflict.)
 * IPAM:
-  * Aggregates
-  * IP Addresses
-  * Prefixes
-  * RIRs
-  * Roles
-  * VLANs
-  * VLAN Groups
-  * VRFs
+  * Aggregates: `NetboxClientRuby.ipam.aggregates`
+  * IP Addresses: `NetboxClientRuby.ipam.ip_addresses`
+  * Prefixes: `NetboxClientRuby.ipam.prefixes`
+  * RIRs: `NetboxClientRuby.ipam.rirs`
+  * Roles: `NetboxClientRuby.ipam.roles`
+  * VLANs: `NetboxClientRuby.ipam.vlans`
+  * VLAN Groups: `NetboxClientRuby.ipam.vlan_groups`
+  * VRFs: `NetboxClientRuby.ipam.vrfs`
 * Secrets:
-  * Secrets
-  * Secret Roles
-  * get-session-key
-  * generate-rsa-key-pair
+  * Secrets: `NetboxClientRuby.secrets.secrets`
+  * Secret Roles: `NetboxClientRuby.secrets.secret_roles`
+  * generate-rsa-key-pair: `NetboxClientRuby.secrets.generate_rsa_key_pair`
+  * get-session-key: `NetboxClientRuby.secrets.get_session_key`
 * Tenancy:
-  * Tenant
-  * Tenant Groups
+  * Tenant: `NetboxClientRuby.tenancy.tenants`
+  * Tenant Groups: `NetboxClientRuby.tenancy.tenant_groups`
 * Virtualization:
-  * Cluster Types
-  * Cluster Groups
-  * Clusters
-  * Virtual Machines
-  * Interfaces
+  * Cluster Types: `NetboxClientRuby.virtualization.cluster_types`
+  * Cluster Groups: `NetboxClientRuby.virtualization.cluster_groups`
+  * Clusters: `NetboxClientRuby.virtualization.clusters`
+  * Virtual Machines: `NetboxClientRuby.virtualization.virtual_machines`
+  * Interfaces: `NetboxClientRuby.virtualization.interfaces`
 
 If you can't find the object you need, also check
 [the source code](https://github.com/ninech/netbox-client-ruby/tree/master/lib/netbox_client_ruby/api)

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/netbox_client_ruby/api/circuits.rb

@@ -1,5 +1,5 @@
 require 'netbox_client_ruby/api/circuits/circuit'
-require 'netbox_client_ruby/api/circuits/circuit_list'
+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'
@@ -12,7 +12,7 @@ module NetboxClientRuby
   module Circuits
     {
       providers: Providers,
-      circuits: CircuitList,
+      circuits: Circuits,
       circuit_types: CircuitTypes,
       circuit_terminations: CircuitTerminations
     }.each_pair do |method_name, class_name|

data/lib/netbox_client_ruby/api/circuits/{circuit_list.rb → circuits.rb}

@@ -8,7 +8,7 @@ module NetboxClientRuby
     #
     # Normally, this class would be called `Circuits`.
     # But this conflicts with the module of the same name.
-    class CircuitList
+    class Circuits
       include Entities
 
       path 'circuits/circuits.json'

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'
@@ -28,18 +38,25 @@ 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,
@@ -47,20 +64,26 @@ module NetboxClientRuby
       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,
@@ -68,7 +91,8 @@ module NetboxClientRuby
       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

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

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

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

@@ -5,6 +5,7 @@ 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/dcim/virtual_chassis'
 require 'netbox_client_ruby/api/ipam/ip_address'
 
 module NetboxClientRuby
@@ -26,7 +27,8 @@ module NetboxClientRuby
         parent_device: proc { |raw_data| Device.new raw_data['id'] },
         primary_ip: proc { |raw_data| IPAM::IpAddress.new raw_data['id'] },
         primary_ip4: proc { |raw_data| IPAM::IpAddress.new raw_data['id'] },
-        primary_ip6: proc { |raw_data| IPAM::IpAddress.new raw_data['id'] }
+        primary_ip6: proc { |raw_data| IPAM::IpAddress.new raw_data['id'] },
+        virtual_chassis: proc { |raw_data| DCIM::VirtualChassis.new raw_data['id'] },
       )
     end
   end

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

@@ -0,0 +1,20 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/interface'
+
+module NetboxClientRuby
+  module DCIM
+    class InterfaceConnection
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/interface-connections/:id.json'
+      creation_path 'dcim/interface-connections/'
+
+      object_fields(
+        interface_a: proc { |raw_data| Interface.new raw_data['id'] },
+        interface_b: proc { |raw_data| Interface.new raw_data['id'] },
+      )
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+
+module NetboxClientRuby
+  module DCIM
+    class VirtualChassis
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/virtual-chassis/:id.json'
+      creation_path 'dcim/virtual-chassis/'
+
+      object_fields(
+        master: proc { |raw_data| Device.new raw_data['id'] },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/virtual_chassis'
+
+module NetboxClientRuby
+  module DCIM
+    class VirtualChassisList
+      include Entities
+
+      path 'dcim/virtual-chassis.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        VirtualChassis.new raw_entity['id']
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -225,14 +225,20 @@ files:
 - lib/netbox_client_ruby/api.rb
 - lib/netbox_client_ruby/api/circuits.rb
 - lib/netbox_client_ruby/api/circuits/circuit.rb
-- lib/netbox_client_ruby/api/circuits/circuit_list.rb
 - lib/netbox_client_ruby/api/circuits/circuit_termination.rb
 - lib/netbox_client_ruby/api/circuits/circuit_terminations.rb
 - lib/netbox_client_ruby/api/circuits/circuit_type.rb
 - lib/netbox_client_ruby/api/circuits/circuit_types.rb
+- lib/netbox_client_ruby/api/circuits/circuits.rb
 - lib/netbox_client_ruby/api/circuits/provider.rb
 - lib/netbox_client_ruby/api/circuits/providers.rb
 - lib/netbox_client_ruby/api/dcim.rb
+- lib/netbox_client_ruby/api/dcim/console_connection.rb
+- lib/netbox_client_ruby/api/dcim/console_connections.rb
+- lib/netbox_client_ruby/api/dcim/console_port.rb
+- lib/netbox_client_ruby/api/dcim/console_ports.rb
+- lib/netbox_client_ruby/api/dcim/console_server_port.rb
+- lib/netbox_client_ruby/api/dcim/console_server_ports.rb
 - lib/netbox_client_ruby/api/dcim/device.rb
 - lib/netbox_client_ruby/api/dcim/device_role.rb
 - lib/netbox_client_ruby/api/dcim/device_roles.rb
@@ -240,6 +246,8 @@ files:
 - lib/netbox_client_ruby/api/dcim/device_types.rb
 - lib/netbox_client_ruby/api/dcim/devices.rb
 - lib/netbox_client_ruby/api/dcim/interface.rb
+- lib/netbox_client_ruby/api/dcim/interface_connection.rb
+- lib/netbox_client_ruby/api/dcim/interface_connections.rb
 - lib/netbox_client_ruby/api/dcim/interfaces.rb
 - lib/netbox_client_ruby/api/dcim/inventory_item.rb
 - lib/netbox_client_ruby/api/dcim/inventory_items.rb
@@ -247,6 +255,8 @@ files:
 - lib/netbox_client_ruby/api/dcim/manufacturers.rb
 - lib/netbox_client_ruby/api/dcim/platform.rb
 - lib/netbox_client_ruby/api/dcim/platforms.rb
+- lib/netbox_client_ruby/api/dcim/power_connection.rb
+- lib/netbox_client_ruby/api/dcim/power_connections.rb
 - lib/netbox_client_ruby/api/dcim/power_outlet.rb
 - lib/netbox_client_ruby/api/dcim/power_outlets.rb
 - lib/netbox_client_ruby/api/dcim/power_port.rb
@@ -263,6 +273,8 @@ files:
 - lib/netbox_client_ruby/api/dcim/regions.rb
 - lib/netbox_client_ruby/api/dcim/site.rb
 - lib/netbox_client_ruby/api/dcim/sites.rb
+- lib/netbox_client_ruby/api/dcim/virtual_chassis.rb
+- lib/netbox_client_ruby/api/dcim/virtual_chassis_list.rb
 - lib/netbox_client_ruby/api/ipam.rb
 - lib/netbox_client_ruby/api/ipam/aggregate.rb
 - lib/netbox_client_ruby/api/ipam/aggregates.rb