netbox-client-ruby 0.10.0 → 0.10.2

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

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/secrets/secret'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Secrets
     class Secrets
       include Entities
 
-      path 'secrets/secrets.json'
+      path 'secrets/secrets/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -1,7 +1,4 @@
-require 'openssl'
-require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/api/dcim/device'
-require 'netbox_client_ruby/api/secrets/secret_role'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Secrets

data/lib/netbox_client_ruby/api/secrets.rb

@@ -1,8 +1,4 @@
-require 'netbox_client_ruby/api/secrets/rsa_key_pair'
-require 'netbox_client_ruby/api/secrets/secret_roles'
-require 'netbox_client_ruby/api/secrets/secrets'
-require 'netbox_client_ruby/api/secrets/session_key'
-require 'netbox_client_ruby/communication'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Secrets

data/lib/netbox_client_ruby/api/tenancy/tenant.rb

@@ -1,5 +1,4 @@
-require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/api/tenancy/tenant_group'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Tenancy

data/lib/netbox_client_ruby/api/tenancy/tenant_group.rb

@@ -1,4 +1,4 @@
-require 'netbox_client_ruby/entity'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Tenancy

data/lib/netbox_client_ruby/api/tenancy/tenant_groups.rb

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/tenancy/tenant_group'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Tenancy
     class TenantGroups
       include Entities
 
-      path 'tenancy/tenant-groups.json'
+      path 'tenancy/tenant-groups/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

data/lib/netbox_client_ruby/api/tenancy/tenants.rb

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/tenancy/tenant'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Tenancy
     class Tenants
       include Entities
 
-      path 'tenancy/tenants.json'
+      path 'tenancy/tenants/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

data/lib/netbox_client_ruby/api/tenancy.rb

@@ -1,8 +1,4 @@
-require 'netbox_client_ruby/api/tenancy/tenant'
-require 'netbox_client_ruby/api/tenancy/tenants'
-require 'netbox_client_ruby/api/tenancy/tenant_group'
-require 'netbox_client_ruby/api/tenancy/tenant_groups'
-require 'netbox_client_ruby/communication'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Tenancy

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

@@ -1,7 +1,4 @@
-require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/api/virtualization/cluster_group'
-require 'netbox_client_ruby/api/virtualization/cluster_type'
-require 'netbox_client_ruby/api/dcim/site'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization

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

@@ -1,4 +1,4 @@
-require 'netbox_client_ruby/entity'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization

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

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/virtualization/cluster_group'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization
     class ClusterGroups
       include Entities
 
-      path 'virtualization/cluster-groups.json'
+      path 'virtualization/cluster-groups/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -1,4 +1,4 @@
-require 'netbox_client_ruby/entity'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization

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

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/virtualization/cluster_type'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization
     class ClusterTypes
       include Entities
 
-      path 'virtualization/cluster-types.json'
+      path 'virtualization/cluster-types/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/virtualization/cluster'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization
     class Clusters
       include Entities
 
-      path 'virtualization/clusters.json'
+      path 'virtualization/clusters/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -1,5 +1,4 @@
-require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/api/virtualization/virtual_machine'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization

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

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/virtualization/interface'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization
     class Interfaces
       include Entities
 
-      path 'virtualization/interfaces.json'
+      path 'virtualization/interfaces/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -1,9 +1,4 @@
-require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/api/dcim/device_role'
-require 'netbox_client_ruby/api/dcim/platform'
-require 'netbox_client_ruby/api/ipam/ip_address'
-require 'netbox_client_ruby/api/tenancy/tenant'
-require 'netbox_client_ruby/api/virtualization/cluster'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization

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

@@ -1,12 +1,11 @@
-require 'netbox_client_ruby/entities'
-require 'netbox_client_ruby/api/virtualization/virtual_machine'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization
     class VirtualMachines
       include Entities
 
-      path 'virtualization/virtual-machines.json'
+      path 'virtualization/virtual-machines/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

data/lib/netbox_client_ruby/api/virtualization.rb

@@ -1,14 +1,4 @@
-require 'netbox_client_ruby/api/virtualization/cluster_group'
-require 'netbox_client_ruby/api/virtualization/cluster_groups'
-require 'netbox_client_ruby/api/virtualization/cluster_type'
-require 'netbox_client_ruby/api/virtualization/cluster_types'
-require 'netbox_client_ruby/api/virtualization/cluster'
-require 'netbox_client_ruby/api/virtualization/clusters'
-require 'netbox_client_ruby/api/virtualization/interface'
-require 'netbox_client_ruby/api/virtualization/interfaces'
-require 'netbox_client_ruby/api/virtualization/virtual_machine'
-require 'netbox_client_ruby/api/virtualization/virtual_machines'
-require 'netbox_client_ruby/communication'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Virtualization

data/lib/netbox_client_ruby/communication.rb

@@ -1,5 +1,4 @@
-require 'netbox_client_ruby/error'
-require 'netbox_client_ruby/connection'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Communication
@@ -23,8 +22,8 @@ module NetboxClientRuby
         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}") })
+        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

data/lib/netbox_client_ruby/connection.rb

@@ -1,22 +1,4 @@
-require 'faraday'
-require 'faraday/detailed_logger'
-require 'netbox_client_ruby/error'
-
-if Faraday::VERSION < '2'
-  begin
-    require 'faraday_middleware'
-  rescue LoadError => e
-    message = <<~MSG
-      For the current version of Faraday (#{Faraday::VERSION}), "faraday_middleware"
-      is a required peer dependency of "netbox-client-ruby". Please install
-      "faraday_middleware" separately OR upgrade to Faraday 2, in which case,
-      "faraday_middleware" is not needed to work with "netbox-client-ruby".
-
-      #{e.message}
-    MSG
-    raise NetboxClientRuby::Error, message
-  end
-end
+# frozen_string_literal: true
 
 module NetboxClientRuby
   class Connection

data/lib/netbox_client_ruby/entities.rb

@@ -1,5 +1,4 @@
-require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/error'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Entities

data/lib/netbox_client_ruby/entity.rb

@@ -1,5 +1,4 @@
-require 'netbox_client_ruby/communication'
-require 'netbox_client_ruby/error'
+# frozen_string_literal: true
 
 module NetboxClientRuby
   module Entity
@@ -38,7 +37,7 @@ module NetboxClientRuby
         end
 
         @id_fields.keys.each do |field|
-          define_method(field) { instance_variable_get "@#{field}" }
+          define_method(field) { instance_variable_get :"@#{field}" }
         end
 
         @id_fields
@@ -108,13 +107,13 @@ module NetboxClientRuby
       return self if given_values.nil?
 
       if id_fields.count == 1 && !given_values.is_a?(Hash)
-        instance_variable_set("@#{id_fields.keys.first}", given_values)
+        instance_variable_set(:"@#{id_fields.keys.first}", given_values)
         return self
       end
 
       given_values.each do |field, value|
         if id_fields.key? field.to_s
-          instance_variable_set "@#{field}", value
+          instance_variable_set :"@#{field}", value
         else
           # via method_missing, because it checks for readonly fields, etc.
           method_missing("#{field}=", value)
@@ -164,7 +163,7 @@ module NetboxClientRuby
         s_attribute = attribute.to_s
         next if readonly_fields.include? s_attribute
 
-        sym_attr_writer = "#{attribute}=".to_sym
+        sym_attr_writer = :"#{attribute}="
         if methods.include?(sym_attr_writer)
           public_send(sym_attr_writer, values)
         else
@@ -197,7 +196,7 @@ module NetboxClientRuby
 
       if name.end_with?('=')
         is_readonly_field = readonly_fields.include?(name[0..-2])
-        is_instance_variable = instance_variables.include?("@#{name[0..-2]}".to_sym)
+        is_instance_variable = instance_variables.include?(:"@#{name[0..-2]}")
         not_this_classes_business = is_readonly_field || is_instance_variable
 
         return super if not_this_classes_business
@@ -305,7 +304,7 @@ module NetboxClientRuby
     end
 
     def replace_path_variables_in(path)
-      interpreted_path = path.clone
+      interpreted_path = path.dup
       path.scan(/:([a-zA-Z_][a-zA-Z0-9_]+[!?=]?)/) do |match, *|
         path_variable_value = send(match)
         return interpreted_path.gsub! ":#{match}", path_variable_value.to_s unless path_variable_value.nil?
@@ -328,12 +327,12 @@ module NetboxClientRuby
           raise LocalError, "Can't find the id field '#{id_field}' in the received data."
         end
 
-        instance_variable_set("@#{id_attr}", data[id_field])
+        instance_variable_set(:"@#{id_attr}", data[id_field])
       end
     end
 
     def ids_set?
-      id_fields.map { |id_attr, _| instance_variable_get("@#{id_attr}") }.all?
+      id_fields.map { |id_attr, _| instance_variable_get(:"@#{id_attr}") }.all?
     end
   end
 end

data/lib/netbox_client_ruby/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NetboxClientRuby
   class Error < StandardError; end
   class ClientError < Error; end

data/lib/netbox_client_ruby.rb

@@ -1,6 +1,43 @@
+# frozen_string_literal: true
+
 require 'dry-configurable'
-require 'netbox_client_ruby/error'
-require 'netbox_client_ruby/api'
+require 'ipaddress'
+require 'openssl'
+
+require 'faraday'
+require 'faraday/detailed_logger'
+
+if Faraday::VERSION < '2'
+  begin
+    require 'faraday_middleware'
+  rescue LoadError => e
+    message = <<~MSG
+      For the current version of Faraday (#{Faraday::VERSION}), "faraday_middleware"
+      is a required peer dependency of "netbox-client-ruby". Please install
+      "faraday_middleware" separately OR upgrade to Faraday 2, in which case,
+      "faraday_middleware" is not needed to work with "netbox-client-ruby".
+
+      #{e.message}
+    MSG
+    raise NetboxClientRuby::Error, message
+  end
+end
+
+require 'zeitwerk'
+
+# load zeitwerk
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore("#{__dir__}/netbox-client-ruby.rb")
+  loader.collapse("#{__dir__}/netbox_client_ruby/api")
+  loader.inflector.inflect('dcim' => 'DCIM')
+  loader.inflector.inflect('ipam' => 'IPAM')
+  loader.inflector.inflect('rsa_key_pair' => 'RSAKeyPair')
+  # loader.log!
+  loader.setup
+end
+
+# load gem errors
+require_relative 'netbox_client_ruby/error'
 
 module NetboxClientRuby
   extend Dry::Configurable
@@ -29,4 +66,32 @@ module NetboxClientRuby
     setting :logger
     setting :request_options, default: { open_timeout: 1, timeout: 5 }
   end
+
+  def self.circuits
+    NetboxClientRuby::Circuits
+  end
+
+  def self.dcim
+    NetboxClientRuby::DCIM
+  end
+
+  def self.extras
+    NetboxClientRuby::Extras
+  end
+
+  def self.ipam
+    NetboxClientRuby::IPAM
+  end
+
+  def self.secrets
+    NetboxClientRuby::Secrets
+  end
+
+  def self.tenancy
+    NetboxClientRuby::Tenancy
+  end
+
+  def self.virtualization
+    NetboxClientRuby::Virtualization
+  end
 end

data/netbox-client-ruby.gemspec

@@ -1,9 +1,8 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
   spec.name          = 'netbox-client-ruby'
-  spec.version       = File.read(File.expand_path('VERSION', __dir__)).strip
+  spec.version       = `git describe --tags --match="v[0-9]*" --abbrev=0`.strip.delete_prefix("v")
 
   spec.summary       = 'A read/write client for Netbox v2.'
   spec.homepage      = 'https://github.com/ninech/netbox-client-ruby'
@@ -19,9 +18,6 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.7.0'
 
@@ -30,11 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday-detailed_logger', '~> 2.1'
   spec.add_runtime_dependency 'ipaddress', '~> 0.8', '>= 0.8.3'
   spec.add_runtime_dependency 'openssl', '>= 2.0.5'
-
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 13'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'rubocop', '~> 0.48'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.15'
+  spec.add_runtime_dependency 'zeitwerk', '~> 2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.2
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -93,89 +93,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.5
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.48'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.48'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
+        version: 2.6.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.6.0
 description: 
 email:
 - christian.maeder@nine.ch
@@ -189,13 +119,12 @@ files:
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
+- Appraisals
 - Dockerfile
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - bin/console
 - bin/setup
 - docker-compose.test.yml
@@ -204,14 +133,10 @@ files:
 - docker/start.test.sh
 - dump.sql
 - gemfiles/faraday0.gemfile
-- gemfiles/faraday0.gemfile.lock
 - gemfiles/faraday1.gemfile
-- gemfiles/faraday1.gemfile.lock
 - gemfiles/faraday2.gemfile
-- gemfiles/faraday2.gemfile.lock
 - lib/netbox-client-ruby.rb
 - lib/netbox_client_ruby.rb
-- 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_termination.rb
@@ -344,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: A read/write client for Netbox v2.