netbox-client-ruby 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 980c41479f9ebc620b9d44319b03a301bb88558b
-  data.tar.gz: 5bd503c8ca0adb4c868b779f92d42f62301858f6
+  metadata.gz: b208caa12086d6501f332d3b8569158d4d63ad5a
+  data.tar.gz: ce322b1cba7805f739b5fa2b79de2ba6c75455a9
 SHA512:
-  metadata.gz: 4c17ce3c8d947d50c35e6d408dd74aaabce5d915d16de620ad834232337303241a2fe79da356f7ffec71180b4fa2b9d4773b08d1ddde38e3f07e2768e3d918fd
-  data.tar.gz: 650212f2c20e238ff5ffcdfa827f3062fc64d3af52a048e0e26a172ea49d584f03a6496c9187b710c012cbf9c84922beae25d38ecd417740f618f30cac8d239e
+  metadata.gz: 9bbe1c52549ca8f5257aefab0dca882c926a31af88c6bb47a8fae616c6d6a975822ef6975a367de0ce5dde50d6e134c063f6cf93036361d09fee27642b9df3f0
+  data.tar.gz: affbc19283cb620529178f35c66dd426e3879e40febb66818927c21a075192d95d83087c5c96456f9185de3f430c82ef4b3e932c97d1acbd4b1b7fa4b75b0723

data/README.md

@@ -68,7 +68,7 @@ sites = NetboxClientRuby.dcim.sites
 puts "There are #{sites.total} sites in your Netbox instance."
 
 # get the first site of the result set
-first_site = sites[0]
+first_site = sites.first
 puts "The first site is called #{first_site.name}."
 
 # filter devices by site
@@ -76,6 +76,15 @@ puts "The first site is called #{first_site.name}."
 devices_of_site = NetboxClientRuby.dcim.devices.filter(site: first_site.slug)
 puts "#{devices_of_site.total} devices belong to the site. #{devices_of_site}.length devices have been fetched."
 
+# Finds a specific device
+NetboxClientRuby.dcim.devices.find_by(name: 'my-device', other_field: 'other-value')
+
+# Finds a specific device with a certain custom field
+NetboxClientRuby.dcim.devices.find_by(cf_custom_url: 'https://google.com')
+
+# Or a mix of regular and custom fields
+NetboxClientRuby.dcim.devices.find_by(name: 'my-device', cf_custom_field: 'custom-value')
+
 # get a site by id
 s = NetboxClientRuby.dcim.site(1)
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/netbox_client_ruby/entities.rb

@@ -75,8 +75,28 @@ module NetboxClientRuby
       end
     end
 
+    def find_by(attributes)
+      fail ArgumentError, '"attributes" expects a hash' unless attributes.is_a? Hash
+
+      filter(attributes).find do |netbox_object|
+        attributes.all? do |filter_key, filter_value|
+          if filter_key.to_s.start_with?('cf_')
+            custom_field = filter_key.to_s.sub('cf_', '')
+
+            netbox_object.custom_fields[custom_field] == filter_value
+          else
+            if netbox_object.respond_to?(filter_key)
+              netbox_object.public_send(filter_key) == filter_value
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+
     def filter(filter)
-      raise ArgumentError, '"filter" expects a hash' unless filter.is_a? Hash
+      fail ArgumentError, '"filter" expects a hash' unless filter.is_a? Hash
 
       @filter = filter
       reset

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable