netbox-client-ruby 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e92fcfb1847cb3521d78c31bf1963c3a05e5d9ff790d67de847dd7f0750ba7e
-  data.tar.gz: 7133f48050960e5bc0e5b5e29b7e488688f53dfe8c51a6103091d72b6753f501
+  metadata.gz: c3c13d93a4b630b6cbf0132bd3be08c5ce516eb5dd41796663decda4ecbaf3c5
+  data.tar.gz: da860034ae235b12b07fe39a2ed55d349df9805763312030eccdda9080184db3
 SHA512:
-  metadata.gz: db362181a8f59cc3209dfbdec06a0d29af0207ae8d94713f4a3965b9a91d07aa47aa743fc2c415fa39edc27aa9b94982bb7bc3920b8125a68090b7a9a6996a45
-  data.tar.gz: eb607a8f76f5dd6bb6106efd367f0f94206d6a34822ecf158a444761c43b13408c21c0299b067defb160a040b940dfae6ee4df36eeb3fce606f6bb3c68f71953
+  metadata.gz: 0de307eed7348946cc8d93c9e31fad29ad7931a01ab7fb9c3c29f00cb7218829e00e8b0033b7730add002c9552d2880cace8acb7eb915bbb4ca03e9579255685
+  data.tar.gz: 2bc8a49a8cb146f84ac9fcce228f1325c7925120afb0598fee6a6b4b560d28964de9ade481e60ac5971a78561b511ad48dc4987e0f51f470671a3cf2e8517155

data/VERSION

@@ -0,0 +1 @@
+0.13.1

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

@@ -11,7 +11,7 @@ module NetboxClientRuby
         planned: 2,
         provisioning: 3,
         offline: 4,
-        decommissioned: 5
+        decommissioned: 5,
       }.freeze
 
       id id: :id
@@ -27,7 +27,7 @@ module NetboxClientRuby
           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'] }
+        tenant: proc { |raw_data| Tenancy::Tenant.new raw_data['id'] },
       )
     end
   end

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

@@ -13,7 +13,7 @@ module NetboxClientRuby
       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'] }
+        interface: proc { |raw_data| DCIM::Interface.new raw_data['id'] },
       )
     end
   end

data/lib/netbox_client_ruby/api/circuits.rb

@@ -6,20 +6,18 @@ module NetboxClientRuby
       providers: Providers,
       circuits: Circuits,
       circuit_types: CircuitTypes,
-      circuit_terminations: CircuitTerminations
+      circuit_terminations: CircuitTerminations,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
       provider: Provider,
       circuit: Circuit,
       circuit_type: CircuitType,
-      circuit_termination: CircuitTermination
+      circuit_termination: CircuitTermination,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
   end
 end

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

@@ -20,7 +20,7 @@ module NetboxClientRuby
       creation_path 'dcim/device-types/'
       object_fields(
         manufacturer: proc { |raw_data| Manufacturer.new raw_data['id'] },
-        interface_ordering: InterfaceOrdering
+        interface_ordering: InterfaceOrdering,
       )
     end
   end

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

@@ -12,7 +12,7 @@ module NetboxClientRuby
       object_fields(
         manufacturer: proc do |raw_manufacturer|
           DCIM::Manufacturer.new raw_manufacturer['id']
-        end
+        end,
       )
     end
   end

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

@@ -8,7 +8,7 @@ module NetboxClientRuby
       STATUS_VALUES = {
         active: 1,
         planned: 2,
-        retired: 4
+        retired: 4,
       }.freeze
 
       id id: :id
@@ -23,7 +23,7 @@ module NetboxClientRuby
         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/dcim.rb

@@ -24,10 +24,9 @@ module NetboxClientRuby
       rack_roles: RackRoles,
       regions: Regions,
       sites: Sites,
-      virtual_chassis_list: VirtualChassisList
+      virtual_chassis_list: VirtualChassisList,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
@@ -52,10 +51,9 @@ module NetboxClientRuby
       rack_role: RackRole,
       region: Region,
       site: Site,
-      virtual_chassis: VirtualChassis
+      virtual_chassis: VirtualChassis,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
   end
 end

data/lib/netbox_client_ruby/api/extras/config_context.rb

@@ -18,7 +18,7 @@ module NetboxClientRuby
         clusters: proc { |raw_data| Virtualization::Cluster.new raw_data['id'] },
         tenant_groups: proc { |raw_data| Tenancy::TenantGroup.new raw_data['id'] },
         tenants: proc { |raw_data| Tenancy::Tenant.new raw_data['id'] },
-        tags: proc { |raw_data| Tag.new raw_data['id'] }
+        tags: proc { |raw_data| Tag.new raw_data['id'] },
       )
     end
   end

data/lib/netbox_client_ruby/api/extras.rb

@@ -5,19 +5,17 @@ module NetboxClientRuby
     {
       config_contexts: ConfigContexts,
       journal_entries: JournalEntries,
-      tags: Tags
+      tags: Tags,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
       config_context: ConfigContext,
       journal_entry: JournalEntry,
-      tag: Tag
+      tag: Tag,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
   end
 end

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

@@ -9,7 +9,7 @@ module NetboxClientRuby
         active: 1,
         reserved: 2,
         deprecated: 3,
-        dhcp: 5
+        dhcp: 5,
       }.freeze
 
       id id: :id
@@ -20,7 +20,7 @@ module NetboxClientRuby
         vrf: proc { |raw_data| Vrf.new raw_data['id'] },
         tenant: proc { |raw_data| Tenancy::Tenant.new raw_data['id'] },
         status: proc { |raw_data| STATUS_VALUES.key(raw_data['value']) || raw_data['value'] },
-        address: proc { |raw_ip| IPAddress.parse(raw_ip) }
+        address: proc { |raw_ip| IPAddress.parse(raw_ip) },
       )
       readonly_fields :display_name
 
@@ -33,8 +33,9 @@ module NetboxClientRuby
         interface_data = data['interface']
 
         return nil unless interface_data
-        return Virtualization::Interface.new interface_data['id'] unless interface_data.dig('virtual_machine').nil?
-        return DCIM::Interface.new interface_data['id']
+        return Virtualization::Interface.new interface_data['id'] unless interface_data['virtual_machine'].nil?
+
+        DCIM::Interface.new interface_data['id']
       end
     end
   end

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

@@ -15,7 +15,7 @@ module NetboxClientRuby
         role: proc { |raw_data| Role.new raw_data['id'] },
         status: proc { |raw_data| IpRangeStatus.new raw_data },
         start_address: proc { |raw_data| IPAddress.parse raw_data },
-        end_address: proc { |raw_data| IPAddress.parse raw_data }
+        end_address: proc { |raw_data| IPAddress.parse raw_data },
       )
     end
 

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

@@ -16,7 +16,7 @@ module NetboxClientRuby
         vlan: proc { |raw_data| Vlan.new raw_data['id'] },
         status: proc { |raw_data| PrefixStatus.new raw_data },
         role: proc { |raw_data| Role.new raw_data['id'] },
-        prefix: proc { |raw_data| IPAddress.parse raw_data }
+        prefix: proc { |raw_data| IPAddress.parse raw_data },
       )
       readonly_fields :display_name
     end

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

@@ -13,7 +13,7 @@ module NetboxClientRuby
         device: proc { |raw_data| Device.new raw_data['id'] },
         virtual_machine: proc { |raw_data| VirtualMachine.new raw_data['id'] },
         protocol: proc { |raw_data| ServiceProtocol.new raw_data },
-        ipaddresses: proc { |raw_data| IpAddress.new raw_data['id'] }
+        ipaddresses: proc { |raw_data| IpAddress.new raw_data['id'] },
       )
       readonly_fields :display_name
     end

data/lib/netbox_client_ruby/api/ipam.rb

@@ -12,10 +12,9 @@ module NetboxClientRuby
       services: Services,
       vlans: Vlans,
       vlan_groups: VlanGroups,
-      vrfs: Vrfs
+      vrfs: Vrfs,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
@@ -28,10 +27,9 @@ module NetboxClientRuby
       service: Service,
       vlan: Vlan,
       vlan_group: VlanGroup,
-      vrf: Vrf
+      vrf: Vrf,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
   end
 end

data/lib/netbox_client_ruby/api/secrets/rsa_key_pair.rb

@@ -5,7 +5,7 @@ module NetboxClientRuby
     class RSAKeyPair
       include Communication
 
-      PATH = '/api/secrets/generate-rsa-key-pair/'.freeze
+      PATH = '/api/secrets/generate-rsa-key-pair/'
 
       def public_key
         get['public_key']

data/lib/netbox_client_ruby/api/secrets/session_key.rb

@@ -5,7 +5,7 @@ module NetboxClientRuby
     class SessionKey
       include Communication
 
-      PATH = '/api/secrets/get-session-key/'.freeze
+      PATH = '/api/secrets/get-session-key/'
 
       def initialize
         session_key
@@ -49,6 +49,7 @@ module NetboxClientRuby
         private_key.to_pem
       end
 
+      # rubocop:disable Layout/LineLength,Metrics/MethodLength
       def decode_private_key(encoded_private_key)
         begin
           private_key = OpenSSL::PKey::RSA.new encoded_private_key, rsa_private_key_password
@@ -67,15 +68,18 @@ module NetboxClientRuby
         raise LocalError,
               "The file at '#{rsa_private_key_path}' is not a private key, but a private key is required for get-session-key. (The corresponding configuration is 'netbox.auth.rsa_private_key.path'.)"
       end
+      # rubocop:enable Layout/LineLength,Metrics/MethodLength
 
       def rsa_private_key_password
         pwd = rsa_private_key_config.password
         # If nil is not converted to '', then OpenSSL will block and ask on console for the password.
         # We really don't want that.
         return '' if pwd.nil?
+
         pwd
       end
 
+      # rubocop:disable Layout/LineLength
       def read_private_key_file(key_file)
         encoded_private_key = key_file.read
         return encoded_private_key unless encoded_private_key.nil? || encoded_private_key.empty?
@@ -90,6 +94,7 @@ module NetboxClientRuby
         raise LocalError,
               "No file exists at the given path '#{rsa_private_key_path}', but it's required for get-session-key. (The corresponding configuration is 'netbox.auth.rsa_private_key.path'.)"
       end
+      # rubocop:enable Layout/LineLength
 
       def rsa_private_key_path
         @rsa_private_key_path ||= File.expand_path(rsa_private_key_config.path)

data/lib/netbox_client_ruby/api/secrets.rb

@@ -6,18 +6,16 @@ module NetboxClientRuby
       secret_roles: SecretRoles,
       secrets: Secrets,
       generate_rsa_key_pair: RSAKeyPair,
-      get_session_key: SessionKey
+      get_session_key: SessionKey,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
       secret_role: SecretRole,
-      secret: Secret
+      secret: Secret,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
 
     def session_key=(session_key)

data/lib/netbox_client_ruby/api/tenancy.rb

@@ -6,20 +6,18 @@ module NetboxClientRuby
       tenants: Tenants,
       tenant_groups: TenantGroups,
       contacts: Contacts,
-      contact_groups: ContactGroups
+      contact_groups: ContactGroups,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
       tenant: Tenant,
       tenant_group: TenantGroup,
       contact: Contact,
-      contact_group: ContactGroup
+      contact_group: ContactGroup,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
   end
 end

data/lib/netbox_client_ruby/api/virtualization.rb

@@ -9,8 +9,7 @@ module NetboxClientRuby
       virtual_machines: VirtualMachines,
       interfaces: Interfaces,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { class_name.new }
-      module_function(method_name)
+      NetboxClientRuby.load_collection(self, method_name, class_name)
     end
 
     {
@@ -20,8 +19,7 @@ module NetboxClientRuby
       virtual_machine: VirtualMachine,
       interface: Interface,
     }.each_pair do |method_name, class_name|
-      define_method(method_name) { |id| class_name.new id }
-      module_function(method_name)
+      NetboxClientRuby.load_entity(self, method_name, class_name)
     end
   end
 end

data/lib/netbox_client_ruby/communication.rb

@@ -15,60 +15,44 @@ module NetboxClientRuby
       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 sanitize_variable_name(raw_name)
-      raw_name.gsub(/[^a-zA-Z0-9_]/, '_')
-    end
-
     def read(response)
       response.body
     end
 
-    def raise_on_http_error(response)
+    def raise_on_http_error(response) # rubocop:disable Metrics/MethodLength
       status = response.status
       body = response.body
 
       case status
-      when 200..299 then
-      when 300..499 then
+      when 200..299
+        # do nothing
+      when 300..499
         raise_on_http_client_error response
-      when 500..599 then
+      when 500..599
         raise NetboxClientRuby::RemoteError, "#{status} Remote Error#{formatted_body(body)}"
       else
         raise NetboxClientRuby::RemoteError, "#{status} Unknown Error Code#{formatted_body(body)}"
       end
     end
 
-    def raise_on_http_client_error(response)
+    def raise_on_http_client_error(response) # rubocop:disable Metrics/MethodLength
       status = response.status
       body = response.body
 
       case status
-      when 400 then
+      when 400
         raise_client_error '400 Bad Request', body
-      when 401 then
+      when 401
         raise_client_error '401 Unauthorized', body
-      when 403 then
+      when 403
         raise_client_error '403 Forbidden', body
-      when 405 then
+      when 405
         raise_client_error '405 Method Not Allowed', body
-      when 415 then
+      when 415
         raise_client_error '415 Unsupported Media Type', body
-      when 429 then
+      when 429
         raise_client_error '429 Too Many Requests', body
       else
         raise_client_error "#{status} Request Error", body
@@ -81,6 +65,7 @@ module NetboxClientRuby
 
     def formatted_body(body)
       return '' if body.nil? || body.empty?
+
       shortened = body.to_s
       one_line = shortened.gsub(/\n/, '\n')
       " (#{one_line})"

data/lib/netbox_client_ruby/connection.rb

@@ -3,7 +3,7 @@
 module NetboxClientRuby
   class Connection
     DEFAULT_OPTIONS = {
-      request_encoding: :json
+      request_encoding: :json,
     }.freeze
 
     def self.new(options = {})
@@ -13,7 +13,7 @@ module NetboxClientRuby
     def self.headers
       headers = {}
       auth_token = auth_config.token
-      headers['Authorization'] = "Token #{auth_token}".freeze if auth_token
+      headers['Authorization'] = "Token #{auth_token}" if auth_token
       headers['X-Session-Key'] = NetboxClientRuby::Secrets.session_key if NetboxClientRuby::Secrets.session_key
       headers
     end
@@ -26,7 +26,7 @@ module NetboxClientRuby
       NetboxClientRuby.config.netbox
     end
 
-    private_class_method def self.build_faraday(request_encoding: :json)
+    private_class_method def self.build_faraday(request_encoding: :json) # rubocop:disable Metrics/AbcSize
       config = NetboxClientRuby.config
       Faraday.new(url: config.netbox.api_base_url, headers: headers, ssl: config.faraday.ssl_options) do |faraday|
         faraday.request request_encoding

data/lib/netbox_client_ruby/entities.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module NetboxClientRuby
-  module Entities
+  module Entities # rubocop:disable Metrics/ModuleLength
     include NetboxClientRuby::Communication
     include Enumerable
 
@@ -37,7 +37,7 @@ module NetboxClientRuby
         @limit
       end
 
-      def check_limit(limit)
+      def check_limit(limit) # rubocop:disable Metrics/MethodLength
         max_limit = NetboxClientRuby.config.netbox.pagination.max_limit
         if limit.nil?
           raise ArgumentError,
@@ -74,8 +74,8 @@ module NetboxClientRuby
       end
     end
 
-    def find_by(attributes)
-      fail ArgumentError, '"attributes" expects a hash' unless attributes.is_a? Hash
+    def find_by(attributes) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      raise ArgumentError, '"attributes" expects a hash' unless attributes.is_a? Hash
 
       filter(attributes).find do |netbox_object|
         attributes.all? do |filter_key, filter_value|
@@ -83,19 +83,17 @@ module NetboxClientRuby
             custom_field = filter_key.to_s.sub('cf_', '')
 
             netbox_object.custom_fields[custom_field].to_s == filter_value.to_s
+          elsif netbox_object.respond_to?(filter_key)
+            netbox_object.public_send(filter_key).to_s == filter_value.to_s
           else
-            if netbox_object.respond_to?(filter_key)
-              netbox_object.public_send(filter_key).to_s == filter_value.to_s
-            else
-              false
-            end
+            false
           end
         end
       end
     end
 
     def filter(filter)
-      fail ArgumentError, '"filter" expects a hash' unless filter.is_a? Hash
+      raise ArgumentError, '"filter" expects a hash' unless filter.is_a? Hash
 
       @filter = filter
       reset