netbox-client-ruby 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae1d31ceba9d0b8990392ec90a28fa14e1ccad11
-  data.tar.gz: 242bbeccaba7d294b425f7dca4dda68cec7ef7ad
+  metadata.gz: 06b586e73594396dd7fdcffce33dde0a8a7c5ae6
+  data.tar.gz: 6c10c27dc81db8f26a3f5a5c319ef06b7d2b8688
 SHA512:
-  metadata.gz: 16e34743cc6866cdd3a3916ddc1706af081214416b592316a06bb22db034e8f728c6bd74373d69f5f0add5ce639aed31d5860d824ba0c7ad9e163888d40d7564
-  data.tar.gz: f906ac593eac5c959de0ad5efb8561dced8546e76408240d46b0ef3545f3ff69ca679b00189d83397fcf17396896cdb52de809682899da445116826c924a70b0
+  metadata.gz: 792d23f9938ea1e8a974db2a53fd67d6de86899f2a1f4cce6e5778e16d7ea1f3a72f97cfff2c738d03b59fe62a33e8d0faa4c8c1ff6e2942b660d4ed1d07db0d
+  data.tar.gz: 7ee301dccf03b6c31691871416d65cdb8dded5a4c46f4a26cd313abe2b23855e9c6112289fea316055c6f70dc436184d43182b585db1eca8d5e0399293255f03

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    netbox-client-ruby (0.1.2)
+    netbox-client-ruby (0.1.3)
       dry-configurable (~> 0.1)
       faraday (>= 0.11.0)
       faraday-detailed_logger (~> 2.1)
@@ -18,7 +18,7 @@ GEM
     diff-lcs (1.3)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
-    faraday (0.12.2)
+    faraday (0.13.1)
       multipart-post (>= 1.2, < 3)
     faraday-detailed_logger (2.1.2)
       faraday (~> 0.8)

data/README.md

@@ -76,6 +76,32 @@ 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."
 
+# get a site by id
+s = NetboxClientRuby.dcim.site(1)
+
+# update a site
+s.update(name: 'Zurich', slug: 'zrh')
+
+# update a site (alternative)
+s.name = 'Amsterdam'
+s.slug = 'ams'
+s.save
+
+# create a site
+new_s = NetboxClientRuby::DCIM::Site.new
+new_s.name = 'Berlin'
+new_s.slug = 'ber'
+new_s.save
+
+# create a site (alternative)
+new_s = NetboxClientRuby::DCIM::Site
+          .new(name: 'Berlin', slug: 'ber')
+          .save
+
+# delete a site
+s = NetboxClientRuby.dcim.site(1)
+s.delete
+
 # working with secrets
 secrets = NetboxClientRuby.secrets.secrets
 puts "#{secrets.total} secrets are in your Netbox."
@@ -106,6 +132,8 @@ Not all objects which the Netbox API exposes are currently implemented. Implemen
   * Interfaces
   * Manufacturers
   * Platforms
+  * Power Outlets
+  * Power Ports
   * Racks
   * Regions
   * Sites
@@ -126,7 +154,7 @@ Not all objects which the Netbox API exposes are currently implemented. Implemen
 * Tenancy:
   * Tenant
   * Tenant Groups
-  
+
 If you can't find the object you need, also check
 [the source code](https://github.com/ninech/netbox-client-ruby/tree/master/lib/netbox_client_ruby/api)
 if it was added in the meantime without the list above having been updated.
@@ -159,6 +187,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## About
 
-This gem is currently maintained and funded by [nine.ch](https://nine.ch).
+This gem is currently maintained and funded by [nine](https://nine.ch).
 
-[![nine.ch logo](https://blog.nine.ch/assets/logo.png)](https://nine.ch)
+[![logo of the company 'nine'](https://logo.apps.at-nine.ch/Dmqied_eSaoBMQwk3vVgn4UIgDo=/trim/500x0/logo_claim.png)](https://www.nine.ch)

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/docker-compose.yml

@@ -1,25 +1,5 @@
 version: '2'
 services:
-  app:
-    build:
-      context: .
-      args:
-        RUBY_VERSION: 2.3.4
-    image: netbox-client-ruby:2.3.4
-    depends_on:
-      - nginx
-    volumes:
-      - .:/app
-  app24:
-    build:
-      context: .
-      args:
-        RUBY_VERSION: 2.4.1
-    image: netbox-client-ruby:2.4.1
-    depends_on:
-      - nginx
-    volumes:
-      - .:/app
   nginx:
     image: nginx:1.11-alpine
     command: nginx -g 'daemon off;' -c /etc/netbox-nginx/nginx.conf

data/lib/netbox_client_ruby/api/dcim.rb

@@ -12,6 +12,10 @@ require 'netbox_client_ruby/api/dcim/manufacturer'
 require 'netbox_client_ruby/api/dcim/manufacturers'
 require 'netbox_client_ruby/api/dcim/platform'
 require 'netbox_client_ruby/api/dcim/platforms'
+require 'netbox_client_ruby/api/dcim/power_outlet'
+require 'netbox_client_ruby/api/dcim/power_outlets'
+require 'netbox_client_ruby/api/dcim/power_port'
+require 'netbox_client_ruby/api/dcim/power_ports'
 require 'netbox_client_ruby/api/dcim/rack'
 require 'netbox_client_ruby/api/dcim/racks'
 require 'netbox_client_ruby/api/dcim/region'
@@ -30,6 +34,8 @@ module NetboxClientRuby
       inventory_items: InventoryItems,
       manufacturers: Manufacturers,
       platforms: Platforms,
+      power_outlets: PowerOutlets,
+      power_ports: PowerPorts,
       racks: Racks,
       regions: Regions,
       sites: Sites
@@ -46,6 +52,8 @@ module NetboxClientRuby
       inventory_item: InventoryItem,
       manufacturer: Manufacturer,
       platform: Platform,
+      power_outlet: PowerOutlet,
+      power_port: PowerPort,
       rack: Rack,
       region: Region,
       site: Site

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

@@ -0,0 +1,18 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+require 'netbox_client_ruby/api/dcim/power_port'
+
+module NetboxClientRuby
+  module DCIM
+    class PowerOutlet
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/power-outlets/:id.json'
+      creation_path 'dcim/power-outlets/'
+      object_fields device: proc { |raw_data| Device.new raw_data['id'] }
+      object_fields connected_port: proc { |raw_data| PowerPort.new raw_data }
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/interface'
+
+module NetboxClientRuby
+  module DCIM
+    class PowerOutlets
+      include Entities
+
+      path 'dcim/power-outlets.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        PowerOutlet.new raw_entity['id']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'netbox_client_ruby/entity'
+require 'netbox_client_ruby/api/dcim/device'
+require 'netbox_client_ruby/api/dcim/power_outlet'
+
+module NetboxClientRuby
+  module DCIM
+    class PowerPort
+      include Entity
+
+      id id: :id
+      deletable true
+      path 'dcim/power-ports/:id.json'
+      creation_path 'dcim/power-ports/'
+      object_fields device: proc { |raw_data| Device.new raw_data['id'] }
+      object_fields power_outlet: proc { |raw_data| PowerOutlet.new raw_data['id'] }
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'netbox_client_ruby/entities'
+require 'netbox_client_ruby/api/dcim/interface'
+
+module NetboxClientRuby
+  module DCIM
+    class PowerPorts
+      include Entities
+
+      path 'dcim/power-ports.json'
+      data_key 'results'
+      count_key 'count'
+      entity_creator :entity_creator
+
+      private
+
+      def entity_creator(raw_entity)
+        PowerPort.new raw_entity['id']
+      end
+    end
+  end
+end

data/lib/netbox_client_ruby/communication.rb

@@ -8,7 +8,7 @@ module NetboxClientRuby
       return nil if response.status == 304
       return {} if response.status == 204
 
-      raise_on_http_error response.status
+      raise_on_http_error response
 
       read response
     end
@@ -32,43 +32,60 @@ module NetboxClientRuby
 
     private
 
+    def sanitize_variable_name(raw_name)
+      raw_name.gsub(/[^a-zA-Z0-9_]/, '_')
+    end
+
     def read(response)
       response.body
     end
 
-    def raise_on_http_error(status)
+    def raise_on_http_error(response)
+      status = response.status
+      body = response.body
+
       case status
       when 200..399 then
       when 400..499 then
-        raise_on_http_client_error status
+        raise_on_http_client_error response
       when 500..599 then
-        raise NetboxClientRuby::RemoteError, "#{status} Remote Error"
+        raise NetboxClientRuby::RemoteError, "#{status} Remote Error#{formatted_body(body)}"
       else
-        raise NetboxClientRuby::RemoteError, "#{status} Unknown Error Code"
+        raise NetboxClientRuby::RemoteError, "#{status} Unknown Error Code#{formatted_body(body)}"
       end
     end
 
-    def raise_on_http_client_error(status)
+    def raise_on_http_client_error(response)
+      status = response.status
+      body = response.body
+
       case status
       when 400 then
-        raise NetboxClientRuby::ClientError, '400 Bad Request'
+        raise_client_error '400 Bad Request', body
       when 401 then
-        raise NetboxClientRuby::ClientError, '401 Unauthorized'
+        raise_client_error '401 Unauthorized', body
       when 403 then
-        raise NetboxClientRuby::ClientError, '403 Forbidden'
+        raise_client_error '403 Forbidden', body
       when 405 then
-        raise NetboxClientRuby::ClientError, '405 Method Not Allowed'
+        raise_client_error '405 Method Not Allowed', body
       when 415 then
-        raise NetboxClientRuby::ClientError, '415 Unsupported Media Type'
+        raise_client_error '415 Unsupported Media Type', body
       when 429 then
-        raise NetboxClientRuby::ClientError, '429 Too Many Requests'
+        raise_client_error '429 Too Many Requests', body
       else
-        raise NetboxClientRuby::ClientError, "#{status} Request Error"
+        raise_client_error "#{status} Request Error", body
       end
     end
 
-    def sanitize_variable_name(raw_name)
-      raw_name.gsub(/[^a-zA-Z0-9_]/, '_')
+    def raise_client_error(message, body = nil)
+      raise NetboxClientRuby::ClientError, "#{message}#{formatted_body(body)}"
+    end
+
+    def formatted_body(body)
+      return '' if body.nil? || body.empty?
+      shortened = body.to_s[0, 50]
+      one_line = shortened.gsub(/\n/, '\n')
+      " (#{one_line})"
     end
   end
 end

data/lib/netbox_client_ruby/entity.rb

@@ -104,17 +104,22 @@ module NetboxClientRuby
       end
     end
 
-    def initialize(given_ids = nil)
-      return self if given_ids.nil?
+    def initialize(given_values = nil)
+      return self if given_values.nil?
 
-      if id_fields.count == 1 && !given_ids.is_a?(Hash)
-        instance_variable_set("@#{id_fields.keys.first}", given_ids)
+      if id_fields.count == 1 && !given_values.is_a?(Hash)
+        instance_variable_set("@#{id_fields.keys.first}", given_values)
         return self
       end
 
-      check_given_ids(given_ids)
-
-      given_ids.each { |id_field, id_value| instance_variable_set "@#{id_field}", id_value }
+      given_values.each do |field, value|
+        if id_fields.key? field.to_s
+          instance_variable_set "@#{field}", value
+        else
+          # via method_missing, because it checks for readonly fields, etc.
+          method_missing("#{field}=", value)
+        end
+      end
 
       self
     end
@@ -189,12 +194,10 @@ module NetboxClientRuby
         is_instance_variable = instance_variables.include?("@#{name[0..-2]}".to_sym)
         not_this_classes_business = is_readonly_field || is_instance_variable
 
-        if not_this_classes_business
-          super
-        else
-          dirty_data[name[0..-2]] = args[0]
-          return args[0]
-        end
+        return super if not_this_classes_business
+
+        dirty_data[name[0..-2]] = args[0]
+        return args[0]
       end
 
       return dirty_data[name] if dirty_data.key? name
@@ -247,21 +250,6 @@ module NetboxClientRuby
       self
     end
 
-    def check_given_ids(given_ids)
-      if !given_ids.is_a? Hash
-        raise ArgumentError, "'#{self.class}.new' expects the argument to be a Hash when multiple ids are defined"
-      elsif given_ids.empty?
-        raise ArgumentError, "'#{self.class}.new' expects a the argument to not be empty."
-      end
-
-      missing_ids = id_fields.keys - given_ids.keys.map(&:to_s)
-
-      unless missing_ids.empty?
-        raise ArgumentError,
-              "'#{self.class}.new' expects a value for all defined IDs. The following values are missing: '#{missing_ids.join(', ')}'"
-      end
-    end
-
     def data
       @data ||= get
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netbox-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -222,6 +222,10 @@ files:
 - lib/netbox_client_ruby/api/dcim/manufacturers.rb
 - lib/netbox_client_ruby/api/dcim/platform.rb
 - lib/netbox_client_ruby/api/dcim/platforms.rb
+- lib/netbox_client_ruby/api/dcim/power_outlet.rb
+- lib/netbox_client_ruby/api/dcim/power_outlets.rb
+- lib/netbox_client_ruby/api/dcim/power_port.rb
+- lib/netbox_client_ruby/api/dcim/power_ports.rb
 - lib/netbox_client_ruby/api/dcim/rack.rb
 - lib/netbox_client_ruby/api/dcim/racks.rb
 - lib/netbox_client_ruby/api/dcim/region.rb