netbox-client-ruby 0.13.0 → 0.13.1

data/lib/netbox_client_ruby/entity.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module NetboxClientRuby
-  module Entity
+  module Entity # rubocop:disable Metrics/ModuleLength
     include NetboxClientRuby::Communication
 
     def self.included(other_klass)
@@ -26,20 +26,7 @@ module NetboxClientRuby
 
         raise ArgumentError, "No 'id' was defined, but one is expected." if fields.empty?
 
-        @id_fields = {}
-        if fields.first.is_a?(Hash)
-          fields.first.each { |key, value| @id_fields[key.to_s] = value.to_s }
-        else
-          fields.map(&:to_s).each do |field|
-            field_as_string = field.to_s
-            @id_fields[field_as_string] = field_as_string
-          end
-        end
-
-        @id_fields.keys.each do |field|
-          define_method(field) { instance_variable_get :"@#{field}" }
-        end
-
+        @id_fields = load_attributes(fields)
         @id_fields
       end
 
@@ -49,7 +36,7 @@ module NetboxClientRuby
         @readonly_fields = fields.map(&:to_s)
       end
 
-      def deletable(deletable = false)
+      def deletable(deletable = false) # rubocop:disable Style/OptionalBooleanParameter
         @deletable ||= deletable
       end
 
@@ -88,7 +75,9 @@ module NetboxClientRuby
         end
       end
 
-      def sanitize_mapping(fields_to_class_map)
+      private
+
+      def sanitize_mapping(fields_to_class_map) # rubocop:disable Metrics/MethodLength
         fields_map = {}
         fields_to_class_map.each do |field_definition|
           if field_definition.is_a?(Hash)
@@ -101,9 +90,28 @@ module NetboxClientRuby
         end
         fields_map
       end
+
+      def load_attributes(fields) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        id_fields = {}
+
+        if fields.first.is_a?(Hash)
+          fields.first.each { |key, value| id_fields[key.to_s] = value.to_s }
+        else
+          fields.map(&:to_s).each do |field|
+            field_as_string = field.to_s
+            id_fields[field_as_string] = field_as_string
+          end
+        end
+
+        id_fields.each_key do |field|
+          define_method(field) { instance_variable_get :"@#{field}" }
+        end
+
+        id_fields
+      end
     end
 
-    def initialize(given_values = nil)
+    def initialize(given_values = nil) # rubocop:disable Metrics/MethodLength
       return self if given_values.nil?
 
       if id_fields.count == 1 && !given_values.is_a?(Hash)
@@ -138,6 +146,7 @@ module NetboxClientRuby
 
     def save
       return post unless ids_set?
+
       patch
     end
 
@@ -158,7 +167,7 @@ module NetboxClientRuby
       self
     end
 
-    def update(new_values)
+    def update(new_values) # rubocop:disable Metrics/MethodLength
       new_values.each do |attribute, values|
         s_attribute = attribute.to_s
         next if readonly_fields.include? s_attribute
@@ -191,7 +200,7 @@ module NetboxClientRuby
       dirty_data[name.to_s] = value
     end
 
-    def method_missing(name_as_symbol, *args, &block)
+    def method_missing(name_as_symbol, *args, &block) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
       name = name_as_symbol.to_s
 
       if name.end_with?('=')
@@ -212,7 +221,7 @@ module NetboxClientRuby
       super
     end
 
-    def respond_to_missing?(name_as_symbol, *args)
+    def respond_to_missing?(name_as_symbol, *args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       name = name_as_symbol.to_s
 
       return false if name.end_with?('=') && readonly_fields.include?(name[0..-2])
@@ -275,6 +284,23 @@ module NetboxClientRuby
       self.class.object_fields
     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
+
+    def sanitize_variable_name(raw_name)
+      raw_name.gsub(/[^a-zA-Z0-9_]/, '_')
+    end
+
     def data_to_obj(raw_data, klass_or_proc = nil)
       if klass_or_proc.nil?
         hash_to_object raw_data
@@ -308,6 +334,7 @@ module NetboxClientRuby
       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?
+
         raise LocalError, "Received 'nil' while replacing ':#{match}' in '#{path}' with a value."
       end
       interpreted_path
@@ -323,9 +350,7 @@ module NetboxClientRuby
 
     def extract_ids
       id_fields.each do |id_attr, id_field|
-        unless data.key?(id_field)
-          raise LocalError, "Can't find the id field '#{id_field}' in the received data."
-        end
+        raise LocalError, "Can't find the id field '#{id_field}' in the received data." unless data.key?(id_field)
 
         instance_variable_set(:"@#{id_attr}", data[id_field])
       end

data/lib/netbox_client_ruby/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NetboxClientRuby
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    STRING = File.read(File.expand_path('../../VERSION', __dir__)).strip
+  end
+end

data/lib/netbox_client_ruby.rb

@@ -68,6 +68,16 @@ module NetboxClientRuby
     setting :ssl_options, default: { verify: true }
   end
 
+  def self.load_collection(collection, method_name, class_name)
+    collection.define_method(method_name) { class_name.new }
+    collection.__send__(:module_function, method_name)
+  end
+
+  def self.load_entity(entity, method_name, class_name)
+    entity.define_method(method_name) { |id| class_name.new id }
+    entity.__send__(:module_function, method_name)
+  end
+
   def self.circuits
     NetboxClientRuby::Circuits
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Nine Internet Solutions AG
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-22 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -96,14 +96,14 @@ dependencies:
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.0
 description:
@@ -113,28 +113,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dockerignore"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/gem-push.yml"
-- ".github/workflows/rspec.yml"
-- ".gitignore"
-- ".rspec"
-- Appraisals
-- Dockerfile
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- docker-compose.test.yml
-- docker-compose.yml
-- docker/start.sh
-- docker/start.test.sh
-- dump.sql
-- gemfiles/faraday0.gemfile
-- gemfiles/faraday1.gemfile
-- gemfiles/faraday2.gemfile
+- VERSION
 - lib/netbox-client-ruby.rb
 - lib/netbox_client_ruby.rb
 - lib/netbox_client_ruby/api/circuits.rb
@@ -251,15 +232,16 @@ files:
 - lib/netbox_client_ruby/entities.rb
 - lib/netbox_client_ruby/entity.rb
 - lib/netbox_client_ruby/error.rb
-- netbox-client-ruby.gemspec
-- netbox-client-ruby_rsa
-- netbox-client-ruby_rsa.pub
-- netbox.env
+- lib/netbox_client_ruby/version.rb
 homepage: https://github.com/ninech/netbox-client-ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ninech/netbox-client-ruby
+  changelog_uri: https://github.com/ninech/netbox-client-ruby/releases
+  source_code_uri: https://github.com/ninech/netbox-client-ruby
+  bug_tracker_uri: https://github.com/ninech/netbox-client-ruby/issues
 post_install_message:
 rdoc_options: []
 require_paths:

data/.dockerignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-quickstart.rb
-*.gz
-
-/vendor/
-/.git/

data/.github/workflows/codeql-analysis.yml

@@ -1,42 +0,0 @@
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '25 2 * * 6'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

data/.github/workflows/gem-push.yml

@@ -1,26 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    tags:
-      - "*"
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.2
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/rspec.yml

@@ -1,45 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby CI
-
-on: [push, pull_request]
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest]
-        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3']
-        gemfile:
-          [
-            'gemfiles/faraday1.gemfile',
-            'gemfiles/faraday2.gemfile',
-          ]
-        # Faraday 0.x with Ruby 3.x not supported
-        exclude:
-          - ruby: '3.0'
-            gemfile: gemfiles/faraday0.gemfile
-          - ruby: '3.1'
-            gemfile: gemfiles/faraday0.gemfile
-          - ruby: '3.2'
-            gemfile: gemfiles/faraday0.gemfile
-          - ruby: '3.3'
-            gemfile: gemfiles/faraday0.gemfile
-    runs-on: ${{ matrix.os }}
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - run: bundle exec rake spec

data/.gitignore

@@ -1,21 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-quickstart.rb
-*.gz
-
-vendor/
-Gemfile.lock
-*.gemfile.lock
-
-# Ignore MacOS files
-.DS_Store

data/.rspec

@@ -1 +0,0 @@
---color

data/Appraisals

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'faraday0' do
-  gem 'faraday', '< 1.0'
-  gem 'faraday_middleware', '< 1'
-end
-
-appraise 'faraday1' do
-  gem 'faraday', '= 1.0'
-  gem 'faraday_middleware', '< 2'
-end
-
-appraise 'faraday2' do
-  gem 'faraday', '< 3'
-  gem 'faraday-net_http_persistent'
-  remove_gem "faraday_middleware"
-end

data/Dockerfile

@@ -1,14 +0,0 @@
-ARG RUBY_VERSION=3.2.2
-FROM ruby:${RUBY_VERSION}-alpine
-
-RUN apk add --no-cache git openssl-dev build-base
-
-RUN mkdir /app
-WORKDIR /app
-
-COPY Gemfile Gemfile.lock netbox-client-ruby.gemspec VERSION ./
-RUN bundle install --jobs 4 --deployment --quiet
-
-COPY . ./
-
-CMD docker/start.sh

data/Gemfile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem dependencies in netbox-client-ruby.gemspec
-gemspec
-
-gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal.git'
-gem 'pry'
-gem 'rake'
-gem 'rspec'
-gem 'rubocop'
-gem 'rubocop-performance'
-gem 'rubocop-rake'
-gem 'rubocop-rspec'
-
-# fallback to faraday 1.x in dev environment
-gem 'faraday', '~> 1.10'
-gem 'faraday_middleware'

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'netbox-client-ruby'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-NetboxClientRuby.configure do |c|
-  c.netbox.auth.token = '0123456789abcdef0123456789abcdef01234567'
-  c.netbox.auth.rsa_private_key.path =
-    File.expand_path('../netbox-client-ruby_rsa', __dir__)
-  c.netbox.auth.rsa_private_key.password = nil
-  c.netbox.api_base_url = "http://#{`docker-compose port nginx 8080`.strip}/api/"
-  c.faraday.logger = :detailed_logger
-end
-
-NCR = NetboxClientRuby
-
-version = File.read(File.expand_path('../VERSION', __dir__)).strip
-
-puts <<~WELCOME_TEXT
-  This is using NetboxClientRuby v#{version}.
-  `NetboxClientRuby` has been abbreviated to `NCR` in this console.
-  You will be talking to '#{NetboxClientRuby.config.netbox.api_base_url}'.
-
-  Wondering how many regions you have in your Netbox?
-  Type: NetboxClientRuby.dcim.regions.count
-  Or Short: NCR.dcim.regions.count
-WELCOME_TEXT
-
-require 'pry'
-Pry.start
-
-# require 'irb'
-# IRB.start(__FILE__)

data/bin/setup

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-bundle exec appraisal install

data/docker/start.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-exec bin/console

data/docker/start.test.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-exec bundle exec rake

data/docker-compose.test.yml

@@ -1,16 +0,0 @@
-version: '2'
-services:
-  app:
-    build:
-      context: .
-      args:
-        RUBY_VERSION: 3.2.2
-    image: netbox-client-ruby:3.2.2
-    command: 'docker/start.test.sh'
-  app27:
-    build:
-      context: .
-      args:
-        RUBY_VERSION: 2.7.8
-    image: netbox-client-ruby:2.7.8
-    command: 'docker/start.test.sh'

data/docker-compose.yml

@@ -1,31 +0,0 @@
-version: '2'
-services:
-  nginx:
-    image: nginx:1.14-alpine
-    command: nginx -c /etc/netbox-nginx/nginx.conf
-    depends_on:
-      - netbox
-    volumes:
-      - netbox-nginx-config:/etc/netbox-nginx/
-      - netbox-static-files:/opt/netbox/netbox/static
-    ports:
-      - 80:8080
-  netbox:
-    image: ninech/netbox:v2.4.3
-    depends_on:
-      - postgres
-    volumes:
-      - netbox-static-files:/opt/netbox/netbox/static
-      - netbox-nginx-config:/etc/netbox-nginx/
-    env_file: 'netbox.env'
-  postgres:
-    image: postgres:10.4-alpine
-    environment:
-      POSTGRES_USER: netbox
-      POSTGRES_PASSWORD: netbox
-      POSTGRES_DB: netbox
-volumes:
-  netbox-static-files:
-    driver: local
-  netbox-nginx-config:
-    driver: local