opsview_rest 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5f07bb5d9579733ba504371dcdde50cd397c15d
-  data.tar.gz: 15aaae864adbc403135c0af3cf6f3d88b794ae7c
+  metadata.gz: c47caceb6cf6996f1ada216cbb64020cd89e2bf7
+  data.tar.gz: e5e4436ee08118e4817fca3a22a7f3ce2c6dbe09
 SHA512:
-  metadata.gz: 51e4191a36adb6bc5c5e260a7d458a3eb020384f231bde0a5cdda795ce59a2866e9a97a64ba4b387102e814553e92fcae1edae8cef3d8b6a43b76c6ec1c28439
-  data.tar.gz: 1f599e2413800c55569bdc3f9b9343e22e3bb87526fc0eb7bad808a7845f64b3469410b392a519ceb6c975d1563c201b170aab1c6c42111c36227d6d801e8341
+  metadata.gz: c7c084a5bb41b5a44f3201d9de19d9ece0775dc6678a0adb73479eac5427026147436953273aa4b6ec5b4edc04158f4c887e6c9e9c2ec237f5c60a17347d6782
+  data.tar.gz: da10bb0f01385b8b2a19c9fb63ee067fc6439b607bbc7993bdda4404d1f523f4a252ea20b343cbb088d2d4d25640ae7008153e022e7e91585e5c62916a8d4e68

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,67 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-11-05 11:16:12 +0000 using RuboCop version 0.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/UnreachableCode:
+  Exclude:
+    - 'lib/opsview_rest.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/opsview_rest_spec.rb'
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 31
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 144
+
+# Offense count: 3
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 39
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 190 
+
+# Offense count: 15
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 57
+
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 14
+          
+# Offense count: 15
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/opsview_rest.rb'
+    - 'lib/opsview_rest/attribute.rb'
+    - 'lib/opsview_rest/contact.rb'
+    - 'lib/opsview_rest/host.rb'
+    - 'lib/opsview_rest/hostcheckcommand.rb'
+    - 'lib/opsview_rest/hostgroup.rb'
+    - 'lib/opsview_rest/hosttemplate.rb'
+    - 'lib/opsview_rest/keyword.rb'
+    - 'lib/opsview_rest/mixin.rb'
+    - 'lib/opsview_rest/monitoringserver.rb'
+    - 'lib/opsview_rest/notificationmethod.rb'
+    - 'lib/opsview_rest/role.rb'
+    - 'lib/opsview_rest/servicecheck.rb'
+    - 'lib/opsview_rest/servicegroup.rb'
+    - 'lib/opsview_rest/timeperiod.rb'
+

data/.travis.yml

@@ -1,10 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.3.1
   - ruby-head
 script: bundle exec rake
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: 1.8.7

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in opsview_rest.gemspec
 gemspec
-
-

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'rake'
 
-#encoding: utf-8
+# encoding: utf-8
 require 'rubygems'
 require 'bundler'
 Bundler.setup
@@ -10,13 +10,13 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 begin
   require 'yard'
   YARD::Rake::YardocTask.new
 rescue LoadError
   task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+    abort 'YARD is not available. In order to run yardoc, you must: sudo gem install yard'
   end
 end

data/lib/opsview_rest.rb

@@ -2,26 +2,25 @@ require 'rest-client'
 require 'json'
 
 class OpsviewRest
-
   attr_accessor :url, :username, :password, :rest
 
   def initialize(url, options = {})
     options = {
-      :username => "api",
-      :password => "changeme",
-      :connect  => true
+      username: 'api',
+      password: 'changeme',
+      connect: true
     }.update options
 
     @url      = url
     @username = options[:username]
     @password = options[:password]
-    @rest     = RestClient::Resource.new("#{@url}/rest/", :headers => { :content_type => 'application/json' })
+    @rest     = RestClient::Resource.new("#{@url}/rest/", headers: { content_type: 'application/json' })
 
     login if options[:connect]
   end
 
   def login
-    response = post('login', { 'username' => @username, 'password' => @password })
+    response = post('login', 'username' => @username, 'password' => @password)
     @rest.headers[:x_opsview_token]    = response['token']
     @rest.headers[:x_opsview_username] = @username
     response
@@ -73,40 +72,38 @@ class OpsviewRest
       require 'opsview_rest/timeperiod'
       OpsviewRest::Timeperiod.new(self, options)
     else
-      raise "Type not implemented yet."
+      raise 'Type not implemented yet.'
     end
   end
 
   def list(options = {})
     options = {
-      :type => "host",
-      :rows => "all"
+      type: 'host',
+      rows: 'all'
     }.update options
 
     get("config/#{options[:type]}?rows=#{options[:rows]}")
   end
 
   def reload
-    get("reload")
+    get('reload')
   end
 
   def initiate_reload
-    post("reload", {})
+    post('reload', {})
   end
 
   def find(options = {})
     options = {
-      :type => nil,
-      :rows => "all",
-      :searchattribute => nil
+      type: nil,
+      rows: 'all',
+      searchattribute: nil
     }.update options
 
-    if options[:searchattribute].nil?
-      options[:searchattribute] = "name"
-    end
-    
+    options[:searchattribute] = 'name' if options[:searchattribute].nil?
+
     if options[:name].nil?
-      raise ArgumentError, "Need to specify the name of the object."
+      raise ArgumentError, 'Need to specify the name of the object.'
     else
       get("config/#{options[:type]}?s.#{options[:searchattribute]}=#{options[:name]}&rows=#{options[:rows]}")
     end
@@ -114,14 +111,14 @@ class OpsviewRest
 
   def purge(options = {})
     options = {
-      :type => "host",
-      :name => nil
+      type: 'host',
+      name: nil
     }.update options
 
     if options[:name].nil?
-      raise ArgumentError, "Need to specify the name of the object."
+      raise ArgumentError, 'Need to specify the name of the object.'
     else
-      id = find(:type => options[:type], :name => options[:name])[0]["id"]
+      id = find(type: options[:type], name: options[:name])[0]['id']
       delete("config/#{options[:type]}/#{id}")
     end
   end
@@ -142,15 +139,13 @@ class OpsviewRest
     api_request { @rest[path_part].put(payload.to_json, additional_headers, &block) }
   end
 
-  def api_request(&block)
+  def api_request
     response_body = begin
-      response = block.call
+      response = yield
       response.body
     rescue RestClient::Exception => e
       raise "I have #{e.inspect} with #{e.http_code}"
-      if e.http_code == 307
-        get(e.response)
-      end
+      get(e.response) if e.http_code == 307
       e.response
     end
     parse_response(JSON.parse(response_body))
@@ -159,16 +154,16 @@ class OpsviewRest
   def parse_response(response)
     # We've got an error if there's "message" and "detail" fields
     # in the response
-    if response["message"] and response["detail"]
-      raise Opsview::Exceptions::RequestFailed, "Request failed: #{response["message"]}, detail: #{response["detail"]}"
+    if response['message'] && response['detail']
+      raise Opsview::Exceptions::RequestFailed, "Request failed: #{response['message']}, detail: #{response['detail']}"
     # If we have a token, return that:
-    elsif response["token"]
+    elsif response['token']
       response
     # If we have a list of objects, return the list:
-    elsif response["list"]
-      response["list"]
+    elsif response['list']
+      response['list']
     else
-      response["object"]
+      response['object']
     end
   end
 end

data/lib/opsview_rest/attribute.rb

@@ -2,31 +2,29 @@ require 'opsview_rest/mixin'
 
 class OpsviewRest
   class Attribute
-
     include OpsviewRest::Mixin
 
     attr_accessor :options, :opsview, :resource_type
 
     def initialize(opsview, options = {})
       @options = {
-        :name => "PROCESSES",
-        :arg1 => "",
-        :arg2 => "",
-        :arg3 => "",
-        :arg4 => "",
-        :value => "",
-        :servicechecks => [],
-        :save    => true,
-        :replace => false
+        name: 'PROCESSES',
+        arg1: '',
+        arg2: '',
+        arg3: '',
+        arg4: '',
+        value: '',
+        servicechecks: [],
+        save: true,
+        replace: false
       }.update options
 
       @opsview = opsview
       @resource_type = @options[:type]
 
-      @options[:servicechecks] = @options[:servicechecks].map { |x| { "name" => x } }
+      @options[:servicechecks] = @options[:servicechecks].map { |x| { 'name' => x } }
 
       save(@options[:replace]) if @options[:save]
     end
-
   end
 end

data/lib/opsview_rest/contact.rb

@@ -2,70 +2,68 @@ require 'opsview_rest/mixin'
 
 class OpsviewRest
   class Contact
-
     include OpsviewRest::Mixin
 
     attr_accessor :options, :opsview, :resource_type
 
     def initialize(opsview, options = {})
       @options = {
-        :name    => "foobar",
-        :fullname => "",
-        :description => "",
-        :encrypted_password => "$apr1$HTQogYE7$09TNcZWa/WzoBXdUF6Iyr1",
-        :realm => "local",
-        :language => "",
-        :role => "View all, change none",
-        :variables => [
-          { :value => "", :name => "EMAIL" },
-          { :value => 1, :name => "RSS_COLLAPSED" },
-          { :value => 1440, :name => "RSS_MAXIMUM_AGE" },
-          { :value => 30, :name => "RSS_MAXIMUM_ITEMS" }
+        name: 'foobar',
+        fullname: '',
+        description: '',
+        encrypted_password: '$apr1$HTQogYE7$09TNcZWa/WzoBXdUF6Iyr1',
+        realm: 'local',
+        language: '',
+        role: 'View all, change none',
+        variables: [
+          { value: '', name: 'EMAIL' },
+          { value: 1, name: 'RSS_COLLAPSED' },
+          { value: 1440, name: 'RSS_MAXIMUM_AGE' },
+          { value: 30, name: 'RSS_MAXIMUM_ITEMS' }
         ],
-        :notificationprofiles => [
-          { :name => "24x7",
-            :host_notification_options => "u,d,r,f",
-            :notificationmethods => [
-              { :name => "Email" }
+        notificationprofiles: [
+          { name: '24x7',
+            host_notification_options: 'u,d,r,f',
+            notificationmethods: [
+              { name: 'Email' }
             ],
-            :servicegroups => [],
-            :all_servicegroups => 1,
-            :all_hostgroups => 0,
-            :keywords => [],
-            :service_notification_options => "w,c,r,u,f",
-            :hostgroups => [],
-            :notification_level => 1,
-            :notification_period => { :name => "24x7" } },
-          { :name => "8x5",
-            :host_notification_options => "u,d,r,f",
-            :notificationmethods => [
-              { :name => "Email" }
+            servicegroups: [],
+            all_servicegroups: 1,
+            all_hostgroups: 0,
+            keywords: [],
+            service_notification_options: 'w,c,r,u,f',
+            hostgroups: [],
+            notification_level: 1,
+            notification_period: { name: '24x7' } },
+          { name: '8x5',
+            host_notification_options: 'u,d,r,f',
+            notificationmethods: [
+              { name: 'Email' }
             ],
-            :servicegroups => [],
-            :all_servicegroups => 1,
-            :all_hostgroups => 0,
-            :keywords => [],
-            :service_notification_options => "w,c,r,u,f",
-            :hostgroups => [],
-            :notification_level => 1,
-            :notification_period => { :name => "workhours" } }
+            servicegroups: [],
+            all_servicegroups: 1,
+            all_hostgroups: 0,
+            keywords: [],
+            service_notification_options: 'w,c,r,u,f',
+            hostgroups: [],
+            notification_level: 1,
+            notification_period: { name: 'workhours' } }
         ],
-        :save    => true,
-        :replace => false
+        save: true,
+        replace: false
       }.update options
 
       @opsview = opsview
       @resource_type = @options[:type]
 
-      @options[:all_servicegroups] = if @options[:all_servicegroups] then 1 else 0 end
-      @options[:all_hostgroups] = if @options[:all_hostgroups] then 1 else 0 end
-      @options[:servicegroups] = @options[:servicegroups].map { |x| { "name" => x } } unless @options[:servicegroups].nil?
-      @options[:keywords] = @options[:keywords].map { |x| { "name" => x } } unless @options[:keywords].nil?
-      @options[:hostgroups] = @options[:hostgroups].map { |x| { "name" => x } } unless @options[:hostgroups].nil?
-      @options[:role] = { "name" => @options[:role] }
+      @options[:all_servicegroups] = (@options[:all_servicegroups] ? 1 : 0)
+      @options[:all_hostgroups] = (@options[:all_hostgroups] ? 1 : 0)
+      @options[:servicegroups] = @options[:servicegroups].map { |x| { 'name' => x } } unless @options[:servicegroups].nil?
+      @options[:keywords] = @options[:keywords].map { |x| { 'name' => x } } unless @options[:keywords].nil?
+      @options[:hostgroups] = @options[:hostgroups].map { |x| { 'name' => x } } unless @options[:hostgroups].nil?
+      @options[:role] = { 'name' => @options[:role] }
 
       save(@options[:replace]) if @options[:save]
     end
-
   end
 end

data/lib/opsview_rest/host.rb

@@ -2,7 +2,6 @@ require 'opsview_rest/mixin'
 
 class OpsviewRest
   class Host
-
     include OpsviewRest::Mixin
 
     attr_accessor :options, :opsview, :resource_type
@@ -10,46 +9,46 @@ class OpsviewRest
     def initialize(opsview, options = {})
       # Default set of attributes to send to Opsview:
       @options = {
-        :flap_detection_enabled => false,
-        :snmpv3_privprotocol    => nil,
-        :hosttemplates => [],
-        :keywords => [],
-        :check_period => "24x7",
-        :hostattributes => [],
-        :notification_period => "24x7",
-        :name => "unknown",
-        :rancid_vendor => nil,
-        :snmp_community => "public",
-        :hostgroup => "Unknown",
-        :enable_snmp => false,
-        :monitored_by => "Master Monitoring Server",
-        :alias => "Managed Host",
-        :uncommitted => false,
-        :parents => [],
-        :icon => { "name" => "LOGO - Opsview" },
-        :retry_check_interval => 1,
-        :ip => "localhost",
-        :use_mrtg => false,
-        :servicechecks => [],
-        :use_rancid => false,
-        :nmis_node_type => "router",
-        :snmp_version => "2c",
-        :snmp_authpassword => "",
-        :use_nmis => false,
-        :rancid_connection_type => "ssh",
-        :snmpv3_authprotocol => nil,
-        :rancid_username => nil,
-        :rancid_password => nil,
-        :check_command => "ping",
-        :check_attempts => 2,
-        :check_interval => 0,
-        :notification_interval => 60,
-        :snmp_port => 161,
-        :snmpv3_username => "",
-        :snmpv3_privpassword => "",
-        :other_addresses => "",
-        :save    => true,
-        :replace => false
+        flap_detection_enabled: false,
+        snmpv3_privprotocol: nil,
+        hosttemplates: [],
+        keywords: [],
+        check_period: '24x7',
+        hostattributes: [],
+        notification_period: '24x7',
+        name: 'unknown',
+        rancid_vendor: nil,
+        snmp_community: 'public',
+        hostgroup: 'Unknown',
+        enable_snmp: false,
+        monitored_by: 'Master Monitoring Server',
+        alias: 'Managed Host',
+        uncommitted: false,
+        parents: [],
+        icon: { 'name' => 'LOGO - Opsview' },
+        retry_check_interval: 1,
+        ip: 'localhost',
+        use_mrtg: false,
+        servicechecks: [],
+        use_rancid: false,
+        nmis_node_type: 'router',
+        snmp_version: '2c',
+        snmp_authpassword: '',
+        use_nmis: false,
+        rancid_connection_type: 'ssh',
+        snmpv3_authprotocol: nil,
+        rancid_username: nil,
+        rancid_password: nil,
+        check_command: 'ping',
+        check_attempts: 2,
+        check_interval: 0,
+        notification_interval: 60,
+        snmp_port: 161,
+        snmpv3_username: '',
+        snmpv3_privpassword: '',
+        other_addresses: '',
+        save: true,
+        replace: false
       }.update options
 
       @opsview = opsview
@@ -57,21 +56,20 @@ class OpsviewRest
 
       # Add any weird exceptions here (like hostgroups having to be mapped
       # to "name" => hostgroup, etc.):
-      @options[:flap_detection_enabled] = if @options[:flap_detection_enabled] then 1 else 0 end
-      @options[:enable_snmp] = if @options[:enable_snmp] then 1 else 0 end
-      @options[:use_mrtg] = if @options[:use_mrtg] then 1 else 0 end
-      @options[:use_rancid] = if @options[:use_rancid] then 1 else 0 end
-      @options[:use_nmis] = if @options[:use_nmis] then 1 else 0 end
-      @options[:uncommitted] = if @options[:uncommitted] then 1 else 0 end
-      @options[:check_period] = { "name" => @options[:check_period] }      
-      @options[:hostgroup] = { "name" => @options[:hostgroup] }
-      @options[:notification_period] = { "name" => @options[:notification_period] }
-      @options[:monitored_by] = { "name" => @options[:monitored_by] }
-      @options[:servicechecks] = @options[:servicechecks].map { |x| { "name" => x } }
-      @options[:check_command] = { "name" => @options[:check_command] }
+      @options[:flap_detection_enabled] = (@options[:flap_detection_enabled] ? 1 : 0)
+      @options[:enable_snmp] = (@options[:enable_snmp] ? 1 : 0)
+      @options[:use_mrtg] = (@options[:use_mrtg] ? 1 : 0)
+      @options[:use_rancid] = (@options[:use_rancid] ? 1 : 0)
+      @options[:use_nmis] = (@options[:use_nmis] ? 1 : 0)
+      @options[:uncommitted] = (@options[:uncommitted] ? 1 : 0)
+      @options[:check_period] = { 'name' => @options[:check_period] }
+      @options[:hostgroup] = { 'name' => @options[:hostgroup] }
+      @options[:notification_period] = { 'name' => @options[:notification_period] }
+      @options[:monitored_by] = { 'name' => @options[:monitored_by] }
+      @options[:servicechecks] = @options[:servicechecks].map { |x| { 'name' => x } }
+      @options[:check_command] = { 'name' => @options[:check_command] }
 
       save(@options[:replace]) if @options[:save]
     end
-
   end
 end