netbox-client-ruby 0.5.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aa57ef278da6adb8d9ce15c863b4dd039ed08504447f4f685769084115270f2
-  data.tar.gz: '099904cdb69cb9169e200f0a61cebc1eab93a8ac24857688d0c42e18131a7257'
+  metadata.gz: 50a77d703f7329b04d26b28dee592d7dd55e560bfe3082c8c6e9f5f5a5dd1df1
+  data.tar.gz: 41d4fb8832e252d9eb7a5085c29e56850d4bdae105f4fa2b836671a60098bf9d
 SHA512:
-  metadata.gz: 63597888ded26ba4e28121c5453caf16c613cb80cc966f5800eeb4473a8d777ccd1d0816b67bcf70b6dde61a8ca93cc5364d791a73b7c966b03cc8dff85fb357
-  data.tar.gz: 3d8d4ebb1ba8d3110aa9d1bc9010a5d95f3e2c33af16628da92f19267bf7cad2923f8a26cfed35bba61584718d8c2d208f30dbb21996e32240de67aff8559e05
+  metadata.gz: afaf288b3771669f1f8606792046e0db0b89b6b77cfef65ce85224109a38a212b518dbaeacbd3c68d228aeade56e925b9c5eb3eab5f9bc649989fe51ad4f16b1
+  data.tar.gz: 695e673b4833f1d2de88d32fbcdec16fb850fb7fedff59cc983e5e98b1f71fd9462975e5452289633f7e399d419f110e7ef8169c7bd561b1c3bff6388a324ebd

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

@@ -0,0 +1,42 @@
+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/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,9 +162,14 @@ 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`
+  * IP Ranges: `NetboxClientRuby.ipam.ip_ranges`
   * Prefixes: `NetboxClientRuby.ipam.prefixes`
   * RIRs: `NetboxClientRuby.ipam.rirs`
   * Roles: `NetboxClientRuby.ipam.roles`

data/VERSION

@@ -1 +1 @@
-0.5.6
+0.7.0

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.rb

@@ -1,3 +1,5 @@
+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'
@@ -6,6 +8,7 @@ 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|
@@ -14,6 +17,7 @@ module NetboxClientRuby
     end
 
     {
+      config_context: ConfigContext,
       journal_entry: JournalEntry,
       tag: Tag
     }.each_pair do |method_name, class_name|

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

@@ -0,0 +1,35 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/ipam/role'
+require 'netbox_client_ruby/api/ipam/vrf'
+require 'netbox_client_ruby/api/tenancy/tenant'
+require 'ipaddress'
+
+module NetboxClientRuby
+  module IPAM
+    class IpRange
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'ipam/ip-ranges/:id.json'
+      creation_path 'ipam/ip-ranges/'
+      object_fields(
+        vrf: proc { |raw_data| Vrf.new raw_data['id'] },
+        tenant: proc { |raw_data| Tenancy::Tenant.new raw_data['id'] },
+        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
+
+    class IpRangeStatus
+      attr_reader :value, :label
+
+      def initialize(raw_data)
+        @value = raw_data['value']
+        @label = raw_data['label']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/ipam/ip_range'
+
+module NetboxClientRuby
+  module IPAM
+    class IpRanges
+      include Entities
+
+      path 'ipam/ip-ranges.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        IpRange.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/api/ipam.rb

@@ -2,6 +2,8 @@ require 'netbox_client_ruby/api/ipam/aggregate'
 require 'netbox_client_ruby/api/ipam/aggregates'
 require 'netbox_client_ruby/api/ipam/ip_addresses'
 require 'netbox_client_ruby/api/ipam/ip_address'
+require 'netbox_client_ruby/api/ipam/ip_ranges'
+require 'netbox_client_ruby/api/ipam/ip_range'
 require 'netbox_client_ruby/api/ipam/prefix'
 require 'netbox_client_ruby/api/ipam/prefixes'
 require 'netbox_client_ruby/api/ipam/rir'
@@ -23,6 +25,7 @@ module NetboxClientRuby
     {
       aggregates: Aggregates,
       ip_addresses: IpAddresses,
+      ip_ranges: IpRanges,
       prefixes: Prefixes,
       rirs: Rirs,
       roles: Roles,
@@ -37,6 +40,7 @@ module NetboxClientRuby
     {
       aggregate: Aggregate,
       ip_address: IpAddress,
+      ip_range: IpRange,
       prefix: Prefix,
       rir: Rir,
       role: Role,

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,10 +23,12 @@ 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.add_runtime_dependency 'faraday', '~> 0.11', '>= 0.11.0'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.13.0'
+  spec.add_runtime_dependency 'faraday', '>= 0.11.0', '< 2'
   spec.add_runtime_dependency 'faraday-detailed_logger', '~> 2.1'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0.11'
+  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', '>= 2.0.5'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.7.0
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2022-07-21 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
@@ -31,9 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
@@ -62,16 +62,22 @@ dependencies:
   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
@@ -204,6 +210,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dockerignore"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/rspec.yml"
 - ".gitignore"
@@ -277,6 +284,8 @@ files:
 - 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
@@ -286,6 +295,8 @@ files:
 - lib/netbox_client_ruby/api/ipam/aggregates.rb
 - lib/netbox_client_ruby/api/ipam/ip_address.rb
 - lib/netbox_client_ruby/api/ipam/ip_addresses.rb
+- lib/netbox_client_ruby/api/ipam/ip_range.rb
+- lib/netbox_client_ruby/api/ipam/ip_ranges.rb
 - lib/netbox_client_ruby/api/ipam/prefix.rb
 - lib/netbox_client_ruby/api/ipam/prefixes.rb
 - lib/netbox_client_ruby/api/ipam/rir.rb
@@ -345,7 +356,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:
   - - ">="