feat: add NetboxClientRuby::DCIM::Cable(s)

Author: haydenmuhl

lib/netbox_client_ruby/api/dcim.rb

@@ -3,6 +3,7 @@
 module NetboxClientRuby
   module DCIM
     {
+      cables: Cables,
       console_connections: ConsoleConnections,
       console_ports: ConsolePorts,
       console_server_ports: ConsoleServerPorts,
@@ -33,6 +34,7 @@ module DCIM
     end
 
     {
+      cable: Cable,
       console_connection: ConsoleConnection,
       console_port: ConsolePort,
       console_server_port: ConsoleServerPort,

lib/netbox_client_ruby/api/dcim/cable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module NetboxClientRuby
+  module DCIM
+    class Cable
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/cables/:id/'
+      creation_path 'dcim/cables/'
+    end
+  end
+end

lib/netbox_client_ruby/api/dcim/cables.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module NetboxClientRuby
+  module DCIM
+    class Cables
+      include Entities
+
+      path 'dcim/cables/'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        Cable.new raw_entity['id']
+      end
+    end
+  end
+end

spec/fixtures/dcim/cable_1.json

@@ -0,0 +1,20 @@
+{
+  "id": 1,
+  "display": "#1",
+  "type": "cat5",
+  "a_terminations": [],
+  "b_terminations": [],
+  "status": {
+    "value": "connected",
+    "label": "Connected"
+  },
+  "tenant": null,
+  "label": null,
+  "color": null,
+  "length": null,
+  "length_unit": null,
+  "description": null,
+  "comments": null,
+  "tags": [],
+  "custom_fields": {}
+}

spec/fixtures/dcim/cables.json

@@ -0,0 +1,67 @@
+{
+  "count": 3,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 1,
+      "display": "#1",
+      "type": "cat5",
+      "a_terminations": [],
+      "b_terminations": [],
+      "status": {
+        "value": "connected",
+        "label": "Connected"
+      },
+      "tenant": null,
+      "label": null,
+      "color": null,
+      "length": null,
+      "length_unit": null,
+      "description": null,
+      "comments": null,
+      "tags": [],
+      "custom_fields": {}
+    },
+    {
+      "id": 2,
+      "display": "#2",
+      "type": "cat5",
+      "a_terminations": [],
+      "b_terminations": [],
+      "status": {
+        "value": "connected",
+        "label": "Connected"
+      },
+      "tenant": null,
+      "label": null,
+      "color": null,
+      "length": null,
+      "length_unit": null,
+      "description": null,
+      "comments": null,
+      "tags": [],
+      "custom_fields": {}
+    },
+    {
+      "id": 3,
+      "display": "#3",
+      "type": "cat5",
+      "a_terminations": [],
+      "b_terminations": [],
+      "status": {
+        "value": "connected",
+        "label": "Connected"
+      },
+      "tenant": null,
+      "label": null,
+      "color": null,
+      "length": null,
+      "length_unit": null,
+      "description": null,
+      "comments": null,
+      "tags": [],
+      "custom_fields": {}
+    }
+  ]
+}

spec/netbox_client_ruby/api/dcim/cable_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe NetboxClientRuby::DCIM::Cable, faraday_stub: true do
+  subject { sut.new entity_id }
+
+  let(:entity_id) { 1 }
+  let(:expected_type) { 'cat5' }
+  let(:sut) { described_class }
+  let(:base_url) { '/api/dcim/cables/' }
+
+  let(:request_url) { "#{base_url}#{entity_id}/" }
+  let(:response) { File.read("spec/fixtures/dcim/cable_#{entity_id}.json") }
+
+  describe '#id' do
+    it 'shall be the expected id' do
+      expect(subject.id).to eq(entity_id)
+    end
+  end
+
+  describe '#type' do
+    it 'fetches the data' do
+      allow(faraday).to receive(:get).and_call_original
+
+      expect(subject.type).to_not be_nil
+    end
+
+    it 'shall be the expected type' do
+      expect(subject.type).to eq(expected_type)
+    end
+  end
+
+  describe '.delete' do
+    let(:request_method) { :delete }
+    let(:response_status) { 204 }
+    let(:response) { nil }
+
+    it 'deletes the object' do
+      expect(faraday).to receive(request_method).and_call_original
+      subject.delete
+    end
+  end
+
+  describe '.update' do
+    let(:request_method) { :patch }
+    let(:request_params) { { 'type' => 'coaxial' } }
+
+    it 'updates the object' do
+      expect(faraday).to receive(request_method).and_call_original
+      expect(subject.update(type: 'coaxial').type).to eq(expected_type)
+    end
+  end
+
+  describe '.reload' do
+    it 'reloads the object' do
+      expect(faraday).to receive(request_method).twice.and_call_original
+
+      subject.reload
+      subject.reload
+    end
+  end
+
+  describe '.save' do
+    let(:type) { 'coaxial' }
+    let(:request_params) { { 'type' => type } }
+
+    context 'update' do
+      subject do
+        cable = sut.new entity_id
+        cable.type = type
+        cable
+      end
+
+      let(:request_method) { :patch }
+
+      it 'does not call PATCH until save is called' do
+        expect(faraday).to_not receive(request_method)
+        expect(faraday).to_not receive(:get)
+
+        expect(subject.type).to eq(type)
+      end
+
+      it 'calls PATCH when save is called' do
+        expect(faraday).to receive(request_method).and_call_original
+
+        expect(subject.save).to be(subject)
+      end
+
+      it 'Reads the answer from the PATCH answer' do
+        expect(faraday).to receive(request_method).and_call_original
+
+        subject.save
+        expect(subject.type).to eq(expected_type)
+      end
+    end
+
+    context 'create' do
+      subject do
+        cable = sut.new
+        cable.type = type
+        cable
+      end
+
+      let(:request_method) { :post }
+      let(:request_url) { base_url }
+
+      it 'does not POST until save is called' do
+        expect(faraday).to_not receive(request_method)
+        expect(faraday).to_not receive(:get)
+
+        expect(subject.type).to eq(type)
+      end
+
+      it 'POSTs the data upon a call of save' do
+        expect(faraday).to receive(request_method).and_call_original
+
+        expect(subject.save).to be(subject)
+      end
+
+      it 'Reads the answer from the POST' do
+        expect(faraday).to receive(request_method).and_call_original
+
+        subject.save
+
+        expect(subject.id).to be(1)
+        expect(subject.type).to eq(expected_type)
+      end
+    end
+  end
+end

spec/netbox_client_ruby/api/dcim/cables_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe NetboxClientRuby::DCIM::Cables, faraday_stub: true do
+  let(:expected_length) { 3 }
+  let(:singular_type) { NetboxClientRuby::DCIM::Cable }
+
+  let(:response) { File.read('spec/fixtures/dcim/cables.json') }
+  let(:request_url) { '/api/dcim/cables/' }
+
+  context 'unpaged fetch' do
+    describe '#length' do
+      it 'shall be the expected length' do
+        expect(subject.length).to be expected_length
+      end
+    end
+
+    describe '#total' do
+      it 'shall be the expected total' do
+        expect(subject.total).to be expected_length
+      end
+    end
+
+    describe '#reload' do
+      it 'fetches the correct data' do
+        expect(faraday).to receive(:get).and_call_original
+        subject.reload
+      end
+
+      it 'caches the data' do
+        expect(faraday).to receive(:get).and_call_original
+        subject.total
+        subject.total
+      end
+
+      it 'reloads the data' do
+        expect(faraday).to receive(:get).twice.and_call_original
+        subject.reload
+        subject.reload
+      end
+    end
+
+    describe '#as_array' do
+      it 'returns the correct amount' do
+        expect(subject.to_a.length).to be expected_length
+      end
+
+      it 'returns Cable instances' do
+        subject.to_a.each do |element|
+          expect(element).to be_a singular_type
+        end
+      end
+    end
+  end
+end