netbox-client-ruby 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67bf42f57fa35176857fba1a7ec57797b0345ccf5de0c4074f5bcf2c5be77c04
-  data.tar.gz: 20002e43346be5ce7d5a276656406b7096b302eaf055ef87a81844ae5f72a343
+  metadata.gz: 63568afc97653757809347e5b44d878e6d66294e2c8190068d471dedc680ef86
+  data.tar.gz: 961c454e7e81c28a216c323604743a0d24b5bd01a3e6fe95231b42f1d99d664b
 SHA512:
-  metadata.gz: 1db48b81125135817a7fe7aeed34a3b9ec589e1415bdf12c6fe26b8c69119ca540daca0d3077221f4c77aa6ff84289de765ff6b0aff1764c21652d08371eb5bf
-  data.tar.gz: feb71125dcb8896ca6777333f7a857032ac247b286c004d971d2d22fff256e294926adecf713466e092637455a75eb206056dd5297830e32630bf1b72bf573f7
+  metadata.gz: b1cce1d8566e42c11a12cc636b6996e3ed4f984d84157c37f376c75adc0a25609e38609191dd376ea406ae862d2931c9a264d5c492e81e98188216cff417c0bf
+  data.tar.gz: 347a7b25e339e3c06cf422bf012607c39216ea63908e993b1e76f716c99eef8e5135090d4a28d65445f928f11914c373adbaa94b9a8d0b968c26f427d21f3f8d

data/.github/workflows/rspec.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: [2.6, 2.7, 3.0]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/README.md

@@ -162,6 +162,10 @@ Not all objects which the Netbox API exposes are currently implemented. Implemen
   * Virtual Chassis: `NetboxClientRuby.dcim.virtual_chassis_list`
     (⚠️ Exception: The access is different and the class is called `VirtualChassisList` because the plural and singular
     names are the same and this poses a conflict.)
+* Extras:
+  * Config Contexts: `NetboxClientRuby.extras.config_contexts`
+  * Journal Entries: `NetboxClientRuby.extras.journal_entries`
+  * Tags: `NetboxClientRuby.extras.tags`
 * IPAM:
   * Aggregates: `NetboxClientRuby.ipam.aggregates`
   * IP Addresses: `NetboxClientRuby.ipam.ip_addresses`

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.6.0

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

@@ -29,6 +29,7 @@ module NetboxClientRuby
         primary_ip4: proc { |raw_data| IPAM::IpAddress.new raw_data['id'] },
         primary_ip6: proc { |raw_data| IPAM::IpAddress.new raw_data['id'] },
         virtual_chassis: proc { |raw_data| DCIM::VirtualChassis.new raw_data['id'] },
+        tags: proc { |raw_data| Extras::Tag.new raw_data['id'] },
       )
     end
   end

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

@@ -0,0 +1,25 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  module Extras
+    class ConfigContext
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'extras/config-contexts/:id.json'
+      creation_path 'extras/config-contexts/'
+      object_fields(
+        regions: proc { |raw_data| DCIM::Region.new raw_data['id'] },
+        sites: proc { |raw_data| DCIM::Site.new raw_data['id'] },
+        roles: proc { |raw_data| DCIM::DeviceRole.new raw_data['id'] },
+        platforms: proc { |raw_data| DCIM::Platform.new raw_data['id'] },
+        cluster_groups: proc { |raw_data| Virtualization::ClusterGroup.new raw_data['id'] },
+        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'] }
+      )
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/extras/config_context'
+
+module NetboxClientRuby
+  module Extras
+    class ConfigContexts
+      include Entities
+
+      path 'extras/config-contexts.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        ConfigContext.new raw_entity['id']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/extras/journal_entry'
+
+module NetboxClientRuby
+  module Extras
+    class JournalEntries
+      include Entities
+
+      path 'extras/journal-entries.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        JournalEntry.new raw_entity['id']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  module Extras
+    class JournalEntry
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'extras/journal-entries/:id.json'
+      creation_path 'extras/journal-entries/'
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'netbox_client_ruby/entity'
+
+module NetboxClientRuby
+  module Extras
+    class Tag
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'extras/tags/:id.json'
+      creation_path 'extras/tags/'
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/extras/tag'
+
+module NetboxClientRuby
+  module Extras
+    class Tags
+      include Entities
+
+      path 'extras/tags.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        Tag.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/extras.rb

@@ -0,0 +1,28 @@
+require 'netbox_client_ruby/api/extras/config_context'
+require 'netbox_client_ruby/api/extras/config_contexts'
+require 'netbox_client_ruby/api/extras/journal_entry'
+require 'netbox_client_ruby/api/extras/journal_entries'
+require 'netbox_client_ruby/api/extras/tag'
+require 'netbox_client_ruby/api/extras/tags'
+
+module NetboxClientRuby
+  module Extras
+    {
+      config_contexts: ConfigContexts,
+      journal_entries: JournalEntries,
+      tags: Tags
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) { class_name.new }
+      module_function(method_name)
+    end
+
+    {
+      config_context: ConfigContext,
+      journal_entry: JournalEntry,
+      tag: Tag
+    }.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.rb

@@ -1,5 +1,6 @@
 require 'netbox_client_ruby/api/circuits'
 require 'netbox_client_ruby/api/dcim'
+require 'netbox_client_ruby/api/extras'
 require 'netbox_client_ruby/api/ipam'
 require 'netbox_client_ruby/api/secrets'
 require 'netbox_client_ruby/api/tenancy'
@@ -15,6 +16,10 @@ module NetboxClientRuby
     NetboxClientRuby::DCIM
   end
 
+  def self.extras
+    NetboxClientRuby::Extras
+  end
+
   def self.ipam
     NetboxClientRuby::IPAM
   end

data/lib/netbox_client_ruby.rb

@@ -13,19 +13,19 @@ module NetboxClientRuby
       setting :rsa_private_key do
         # the default is intentionally not `~/.ssh/id_rsa`,
         # to not accidentally leak someone's main rsa private key
-        setting :path, '~/.ssh/netbox_rsa'
+        setting :path, default: '~/.ssh/netbox_rsa'
         setting :password
       end
     end
     setting :pagination do
-      setting :default_limit, 50
-      setting :max_limit, MAX_SIGNED_64BIT_INT
+      setting :default_limit, default: 50
+      setting :max_limit, default: MAX_SIGNED_64BIT_INT
     end
   end
 
   setting :faraday do
-    setting :adapter, :net_http
+    setting :adapter, default: :net_http
     setting :logger
-    setting :request_options, open_timeout: 1, timeout: 5
+    setting :request_options, default: { open_timeout: 1, timeout: 5 }
   end
 end

data/netbox-client-ruby.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.13.0'
   spec.add_runtime_dependency 'faraday', '~> 0.11', '>= 0.11.0'
   spec.add_runtime_dependency 'faraday-detailed_logger', '~> 2.1'
   spec.add_runtime_dependency 'faraday_middleware', '~> 0.11'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +276,13 @@ files:
 - lib/netbox_client_ruby/api/dcim/sites.rb
 - lib/netbox_client_ruby/api/dcim/virtual_chassis.rb
 - lib/netbox_client_ruby/api/dcim/virtual_chassis_list.rb
+- lib/netbox_client_ruby/api/extras.rb
+- lib/netbox_client_ruby/api/extras/config_context.rb
+- lib/netbox_client_ruby/api/extras/config_contexts.rb
+- lib/netbox_client_ruby/api/extras/journal_entries.rb
+- lib/netbox_client_ruby/api/extras/journal_entry.rb
+- lib/netbox_client_ruby/api/extras/tag.rb
+- lib/netbox_client_ruby/api/extras/tags.rb
 - lib/netbox_client_ruby/api/ipam.rb
 - lib/netbox_client_ruby/api/ipam/aggregate.rb
 - lib/netbox_client_ruby/api/ipam/aggregates.rb
@@ -340,7 +347,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="