netbox-client-ruby 0.4.10 → 0.5.0

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/circuit_list'
+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: CircuitList,
+      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|
+          Circuit::CircuitProvider.new raw_data['id']
+        end,
+        status: proc do |raw_status|
+          STATUS_VALUES.key(raw_status['value']) || raw_status['value']
+        end,
+        type: proc { |raw_data| Circuit::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_list.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 CircuitList
+      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/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/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

@@ -19,6 +19,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'
@@ -42,6 +44,7 @@ module NetboxClientRuby
       power_ports: PowerPorts,
       racks: Racks,
       rack_groups: RackGroups,
+      rack_reservations: RackReservations,
       rack_roles: RackRoles,
       regions: Regions,
       sites: Sites
@@ -62,6 +65,7 @@ module NetboxClientRuby
       power_port: PowerPort,
       rack: Rack,
       rack_group: RackGroup,
+      rack_reservation: RackReservation,
       rack_role: RackRole,
       region: Region,
       site: Site

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

@@ -1,4 +1,5 @@
 require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/manufacturer'
 
 module NetboxClientRuby
   module DCIM
@@ -9,6 +10,11 @@ module NetboxClientRuby
       deletable true
       path 'dcim/platforms/:id.json'
       creation_path 'dcim/platforms/'
+      object_fields(
+        manufacturer: proc do |raw_manufacturer|
+          DCIM::Manufacturer.new raw_manufacturer['id']
+        end
+      )
     end
   end
 end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/rack'
+require 'netbox_client_ruby/api/tenancy/tenant'
+
+module NetboxClientRuby
+  module DCIM
+    class RackReservation
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/rack-reservations/:id.json'
+      creation_path 'dcim/rack-reservations/'
+
+      object_fields(
+        rack: proc { |raw_data| DCIM::Rack.new raw_data['id'] },
+        tenant: proc { |raw_data| Tenancy::Tenant.new raw_data['id'] },
+      )
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/rack_reservation'
+
+module NetboxClientRuby
+  module DCIM
+    class RackReservations
+      include Entities
+
+      path 'dcim/rack-reservations.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        RackReservation.new raw_entity['id']
+      end
+    end
+  end
+end

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

@@ -1,6 +1,4 @@
 require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/api/dcim/region'
-require 'netbox_client_ruby/api/tenancy/tenant'
 
 module NetboxClientRuby
   module DCIM

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

@@ -1,17 +1,30 @@
 require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/region'
 
 module NetboxClientRuby
   module DCIM
     class Site
       include Entity
 
+      STATUS_VALUES = {
+        active: 1,
+        planned: 2,
+        retired: 4
+      }.freeze
+
       id id: :id
-      readonly_fields :count_prefixes, :count_vlans, :count_racks, :count_devices,
-                      :count_circuits
+      readonly_fields :count_prefixes, :count_vlans, :count_racks,
+                      :count_devices, :count_circuits
 
       deletable true
       path 'dcim/sites/:id.json'
       creation_path 'dcim/sites/'
+      object_fields(
+        region: proc { |raw_region| DCIM::Region.new raw_region['id'] },
+        status: proc do |raw_status|
+          STATUS_VALUES.key(raw_status['value']) || raw_status['value']
+        end
+      )
     end
   end
 end

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

@@ -11,8 +11,7 @@ module NetboxClientRuby
       path 'virtualization/interfaces/:id.json'
       creation_path 'virtualization/interfaces/'
       object_fields virtual_machine: proc { |raw_data|
-        # https://github.com/digitalocean/netbox/issues/1794
-        VirtualMachine.new(raw_data.is_a?(Hash) ? raw_data['id'] : raw_data)
+        VirtualMachine.new raw_data['id']
       }
     end
   end

data/netbox-client-ruby.gemspec

@@ -1,18 +1,17 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'netbox-client-ruby'
-  spec.version       = File.read(File.expand_path('../VERSION', __FILE__)).strip
-  spec.authors       = ['Christian Mäder']
-  spec.email         = ['christian.maeder@nine.ch']
+  spec.version       = File.read(File.expand_path('VERSION', __dir__)).strip
 
   spec.summary       = 'A read/write client for Netbox v2.'
   spec.homepage      = 'https://github.com/ninech/netbox-client-ruby'
   spec.license       = 'MIT'
 
+  spec.authors       = ['Christian Mäder']
+  spec.email         = ['christian.maeder@nine.ch']
+
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   end
@@ -25,16 +24,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
-  spec.add_runtime_dependency 'faraday', '>= 0.11.0'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0.11.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.11', '>= 0.11.0'
   spec.add_runtime_dependency 'faraday-detailed_logger', '~> 2.1'
-  spec.add_runtime_dependency 'ipaddress', '>= 0.8.3'
-  spec.add_runtime_dependency 'openssl', '>= 2.0.5'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.11.0'
+  spec.add_runtime_dependency 'ipaddress', '~> 0.8', '>= 0.8.3'
+  spec.add_runtime_dependency 'openssl', '~> 2.0', '>= 2.0.5'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rubocop', '~> 0.48'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.15'
 end

data/netbox-client-ruby_rsa

@@ -0,0 +1,51 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIJKQIBAAKCAgEAq8CSKPwZSbdekzP4Bpp/3KWgQdBlQdgV9mzgvCf6cj8h2tYt
+Y05QKP0pbQv1XAX0S1pave49xON9X/huGKdEtou6/XC3HrDyyAQ43wSR0gv357W7
+B6DEpAhw6ApINPFY/KQL78BqcAEu4pwXvJ3IdwBIYLJ9Czrg8r+JPwOVNWbD0UWM
+etsUKPKooOKbz1WPZwF9IEMUtTRYs7TlQyh5Sc7nDII0hvYpm9fwy+jpNYqF81nQ
+SOFyNgNn/bHImqDVbZLS77/P4kTdbIQTDemPPppfOfMjjEsB1Z7J/I7S7x3C8kBX
+JeGqpCwM/ZOMg/AvbiByAVO0g8fUs1loe8h0tpJgH+c2cLVgSDN9GRjpyG9ooOQx
+GhOxm/0nsLVbmOZ4bAPBvrwSBrhj75qJa+lXW1PtKfjdaQ+tCRtC/6AolCtCMgoq
+RG1T1h6VyeMWzH2x7VtOwj1/TdaAdnZQawsavTXCXVDy7XsS4ueZcdObISfIP/FM
+Fz9KQpgD2jwZ4tS/tXTlttg8chdR5flr88ABzVWpm42wh0z3kdd9pkN52rJU6rJ4
+XRoBm3u3dM10DKyKVcrUVDjR9KJJg7WcoNcbBnSLFHCRTybtAPaSRNNdxzVD06s6
+AoGoirAds+EchkEcB5mnh/Rqb13Aumpf3aMyTE/C4fF6R2uzyTvINr4R3esCAwEA
+AQKCAgEAgwrbub+XP8JTu3aUT92DnwMTwgNRrqpDH5C063qJQK/gkcqGONWgnZWD
+DPtpyjuUyAV5ZJ6orFdx6k5vGgpNiAYWtpZQcW9K3ccy6R3gcGXHURg8Sjaksg7q
+rnBh5VsbrS8xGE00KJ8OecHk7nloYTtq/bRRaccTqMLw4Y5HQsZUs5Af/gC3YgK7
+HH2pqci7MDlXkcz8uMDmyL5FijcQS3s8mDOkBjE9T/WzeLENdldpmmG1ZFX2wTVa
+G5uQ1kHOddrnbBtqblZipxAiRaQlMfuwmlNjlQAJt0Z/EF6cm+qWOiVTGMkUXExr
+4PG57VTNq3W/5jlKap2GMQ0PhhpMyVvILoJ3l1sqZ06cpHnCZ+N1fOYIS+QpI5Wy
+AM98blWZ/o/+/rE/72PzfU8w6yGLi8E3Ll5WW2LnAx8cYEQPFPOtudNTlorZBHhx
+F0iqHf5dRPnA5vev2mOCZTMH1DUir9n4Rd2NwGWmqyAb9CdFSb7ZrKnNCWikwL/O
+mFwulL99zdgmYiPyd4BNYuhouXxr515+BCLesO7Z7K7+50jD6qiVnikU7bvd87fH
+Jw7xlizWN/M4/i879hFnhV2EzDX7Goq79/eRXyJG1MCDYv7zQ9vI3nz67V63OtOf
+CAYHykK9Xa/tUvmbySzmorhZNKenqm1AagL3tAa+f7T652p5XzkCggEBANgcbk4C
+Lx4NG8Jml5srhVnO8tPiJI3JaZpHq4wer47XB0a9wuHQWzT3ywOs8HCHzFUEktAG
+BONBSkFAuEteIHRS0RR2A+dLwBiJ8ff3eQUHPdRbQbwcrlnfV3gHhW8A7iwIUaiU
+7iVN5qnQRGnp+QYSXgZFJegRaPD0UMKvsFBA06xzHu71XtATes2bEa4zScZmT2to
+8b3eCTrGzz/HA3rhi+7lqe+G2KQPFbbc7Yo1DumX3uhvsc7GbsOIsajtA/IvJW1y
+tbQvHGg3kI3rwoMoE6ODHsjb0nRzPvtNhTOjORCymIPQ4DR87q0Brgkbmr1XgNGY
+N6+YUQ7SD00BAn0CggEBAMt0HpKqb1t3eET6FgGcm2O4Q13cTH/LQFqFl/NOTIQF
+iKsb8MB3JaJMx0JJsvY+sgFjBmHYbpiL9/85/TyedVv3A8am6nmC1Ys6IclgXP8j
+pZrl671OmsesyQQgTTjoRUoPZuLprvA9khH/KHihB5cXt5n0BO93LjJCHRTO3HCW
+Yn9XpaANfJi/+fxswf5yd9Ah7dxHaUFovNf7XZUHwPVvmSfU33J8CGzwONf5IeWG
+Rf86RSLzcEmHNu9fs7de2qc6gOpicnVbrSyyCdXAuW+df0GtbTKcBgMf62h0MdNB
+/j/AD0OignIKz3zHO1ZC5YrZJj2yTMT8vmz0XtHHJocCggEAZZc340PzklTnL8O6
+kR8sWMOIM0KjnGOKWRRH+F6UeLlsmjyqWCzyMzwpG1k4zi2ISI8V1OR/d7VBits5
+x3RAHW6xCsVPoHNjoiV2sfKL2WlGD4W2qQ9yhp0PKUWf3Ea7r8dZW75nFPJB9KIL
+Bx8OCWSo/pmS8Dz+8AZp0Jt2bsOKvg6ABCUkpPwDRpQXA6TokXOW8g8rVO4DuLWs
+x3ZulF1iwrMD562kObs9ofDJWacHk5fpGasoEuQFPbYMjjSdHkQ7e+/oqwNaf0Nf
+mNezYKR+VudUmWd8z3E9sjUG4Pdh5A+Q0qZmP0ZbjMi1X2Kyoz93NxAvXURlFmp4
+9uH6oQKCAQEAlPJG66Lg8XqOTxkzgSyQyjl9ADsmuiwnyd2h95rsA381pedHou/X
+WnGRMyNXZFVT5hYD9yAHH6DhBzYCAh4T1ycI2acbY6f4A/yj/ZSRoKwNMlB+/FGO
+mP4TD/VB85aAG48ZCKiBzRmWVZySmXVyZBgV7xypfFKpPFwQhEpJMhe2tnmJJJqb
+DA0Hy9gnUculkXc1dx3EngE6t3gr884AYu63lmSOzXamiHJ5ewvF2A4sMoULVmIY
+Y4wdGLPckzNbKjB3bqByIR7jsiQJdTapy1/naUK4/eMht6nnosnmLD5VD4Dg6+gO
+TcVCT5xgAW/qMnN1PpfJAjHyizuAK138AwKCAQAFIVVmFcOyFTjf3nEaHOOW+4qH
+Yh4q5YPsdjtQcHRO2sUEOeXZgYat25NC+Pb8fjyaUbcv4c550VRN5kSvvwvMhWu/
+jPWydozFcBM7Q6pwlgSKn3kaGjHqZb58obbzSyvrqhN4Okghp43jARbDdvbN0n0u
+Rin2iSqf4Ti73uxra3rrRkoUiWdAlMN/YuDzkTASmQX0aAJC+ZiIFdHqc+BBTb9W
+tqtAVFkaHmWCW/SLDaH/SFBcEQ8xeawT/XhZY8Vs4FCSTN8oYDz0Dxcls6Rrbnbb
+bvN4dDuIpk3R7G592Ju1viJyIRFwEmp92lBqYvt7cX2cq9rkFnd5zCVTkrfZ
+-----END RSA PRIVATE KEY-----