netbox-client-ruby 0.9.0 → 0.10.1

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class PowerOutlets
       include Entities
 
-      path 'dcim/power-outlets.json'
+      path 'dcim/power-outlets/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class PowerPorts
       include Entities
 
-      path 'dcim/power-ports.json'
+      path 'dcim/power-ports/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class RackGroups
       include Entities
 
-      path 'dcim/rack-groups.json'
+      path 'dcim/rack-groups/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class RackReservations
       include Entities
 
-      path 'dcim/rack-reservations.json'
+      path 'dcim/rack-reservations/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class RackRoles
       include Entities
 
-      path 'dcim/rack-roles.json'
+      path 'dcim/rack-roles/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Racks
       include Entities
 
-      path 'dcim/racks.json'
+      path 'dcim/racks/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Regions
       include Entities
 
-      path 'dcim/regions.json'
+      path 'dcim/regions/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Sites
       include Entities
 
-      path 'dcim/sites.json'
+      path 'dcim/sites/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class VirtualChassisList
       include Entities
 
-      path 'dcim/virtual-chassis.json'
+      path 'dcim/virtual-chassis/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class ConfigContexts
       include Entities
 
-      path 'extras/config-contexts.json'
+      path 'extras/config-contexts/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class JournalEntries
       include Entities
 
-      path 'extras/journal-entries.json'
+      path 'extras/journal-entries/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Tags
       include Entities
 
-      path 'extras/tags.json'
+      path 'extras/tags/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Aggregates
       include Entities
 
-      path 'ipam/aggregates.json'
+      path 'ipam/aggregates/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -38,7 +38,7 @@ module NetboxClientRuby
 
         return nil unless interface_data
 
-        if interface_data.key? ('virtual_machine')
+        if interface_data.key?('virtual_machine')
           Virtualization::Interface.new interface_data['id']
         else
           DCIM::Interface.new interface_data['id']

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class IpAddresses
       include Entities
 
-      path 'ipam/ip-addresses.json'
+      path 'ipam/ip-addresses/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class IpRanges
       include Entities
 
-      path 'ipam/ip-ranges.json'
+      path 'ipam/ip-ranges/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Prefixes
       include Entities
 
-      path 'ipam/prefixes.json'
+      path 'ipam/prefixes/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Rirs
       include Entities
 
-      path 'ipam/rirs.json'
+      path 'ipam/rirs/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Roles
       include Entities
 
-      path 'ipam/roles.json'
+      path 'ipam/roles/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Services
       include Entities
 
-      path 'ipam/services.json'
+      path 'ipam/services/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class VlanGroups
       include Entities
 
-      path 'ipam/vlan-groups.json'
+      path 'ipam/vlan-groups/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Vlans
       include Entities
 
-      path 'ipam/vlans.json'
+      path 'ipam/vlans/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class Vrfs
       include Entities
 
-      path 'ipam/vrfs.json'
+      path 'ipam/vrfs/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     class SecretRoles
       include Entities
 
-      path 'secrets/secret-roles.json'
+      path 'secrets/secret-roles/'
       data_key 'results'
       count_key 'count'
       entity_creator :entity_creator

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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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/tenancy/tenant_groups.rb

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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/virtualization/cluster_groups.rb

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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_types.rb

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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/interfaces.rb

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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_machines.rb

@@ -6,7 +6,7 @@ module NetboxClientRuby
     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/communication.rb

@@ -1,5 +1,4 @@
-require 'netbox_client_ruby/error/client_error'
-require 'netbox_client_ruby/error/remote_error'
+require 'netbox_client_ruby/error'
 require 'netbox_client_ruby/connection'
 
 module NetboxClientRuby
@@ -24,8 +23,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,7 +1,22 @@
 require 'faraday'
-require 'faraday_middleware'
 require 'faraday/detailed_logger'
-require 'netbox_client_ruby/error/local_error'
+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
 
 module NetboxClientRuby
   class Connection

data/lib/netbox_client_ruby/entities.rb

@@ -1,5 +1,5 @@
 require 'netbox_client_ruby/entity'
-require 'netbox_client_ruby/error/local_error'
+require 'netbox_client_ruby/error'
 
 module NetboxClientRuby
   module Entities

data/lib/netbox_client_ruby/entity.rb

@@ -1,5 +1,5 @@
 require 'netbox_client_ruby/communication'
-require 'netbox_client_ruby/error/local_error'
+require 'netbox_client_ruby/error'
 
 module NetboxClientRuby
   module Entity
@@ -38,7 +38,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 +108,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 +164,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 +197,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
@@ -328,12 +328,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

@@ -0,0 +1,6 @@
+module NetboxClientRuby
+  class Error < StandardError; end
+  class ClientError < Error; end
+  class LocalError < Error; end
+  class RemoteError < Error; end
+end

data/lib/netbox_client_ruby.rb

@@ -1,4 +1,5 @@
 require 'dry-configurable'
+require 'netbox_client_ruby/error'
 require 'netbox_client_ruby/api'
 
 module NetboxClientRuby

data/netbox-client-ruby.gemspec

@@ -3,7 +3,7 @@ $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', __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'
@@ -26,9 +26,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_runtime_dependency 'dry-configurable', '~> 1'
-  spec.add_runtime_dependency 'faraday', '>= 0.11.0', '< 2'
+  spec.add_runtime_dependency 'faraday', '>= 0.11.0', '< 3'
   spec.add_runtime_dependency 'faraday-detailed_logger', '~> 2.1'
-  spec.add_runtime_dependency 'faraday_middleware', '>= 0.11', '< 2'
   spec.add_runtime_dependency 'ipaddress', '~> 0.8', '>= 0.8.3'
   spec.add_runtime_dependency 'openssl', '>= 2.0.5'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -33,7 +33,7 @@ dependencies:
         version: 0.11.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 0.11.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
@@ -58,26 +58,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: ipaddress
   requirement: !ruby/object:Gem::Requirement
@@ -211,10 +191,10 @@ files:
 - ".rspec"
 - Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - bin/console
 - bin/setup
 - docker-compose.test.yml
@@ -222,6 +202,12 @@ files:
 - docker/start.sh
 - 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
@@ -332,9 +318,7 @@ files:
 - lib/netbox_client_ruby/connection.rb
 - lib/netbox_client_ruby/entities.rb
 - lib/netbox_client_ruby/entity.rb
-- lib/netbox_client_ruby/error/client_error.rb
-- lib/netbox_client_ruby/error/local_error.rb
-- lib/netbox_client_ruby/error/remote_error.rb
+- lib/netbox_client_ruby/error.rb
 - netbox-client-ruby.gemspec
 - netbox-client-ruby_rsa
 - netbox-client-ruby_rsa.pub
@@ -359,7 +343,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.

data/VERSION

@@ -1 +0,0 @@
-0.9.0

data/lib/netbox_client_ruby/error/client_error.rb

@@ -1,4 +0,0 @@
-module NetboxClientRuby
-  class ClientError < StandardError
-  end
-end

data/lib/netbox_client_ruby/error/local_error.rb

@@ -1,4 +0,0 @@
-module NetboxClientRuby
-  class LocalError < StandardError
-  end
-end

data/lib/netbox_client_ruby/error/remote_error.rb

@@ -1,4 +0,0 @@
-module NetboxClientRuby
-  class RemoteError < StandardError
-  end
-end