nagios_nrdp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODQ2MGU1NTlhMzNkOTMyZDg2OTZkNjAzZmRhYzUyZjI3Y2I0NjYxOQ==
+    MjZmYWQzYzA2N2JiNzJiNmI2MmI0NDIxOTVlYjNjNjc0ZjQ4NmZhOQ==
   data.tar.gz: !binary |-
-    YjhmMzI1OGY4ZjE1YjJhZWZmZTZiZjM2ZWQ3NzNkYmQwMDQ5MDNjNg==
+    NzcwM2ZlYjMwZDVkYTNmOTVhZTg1Nzc1MzNhYzQ4OGRlNzNhYTRlOQ==
 SHA512:
   metadata.gz: !binary |-
-    YTJkNzUxZGVmNmJjZDhmNzgyZDc1YmZjOWRmNmZlNDI0YmE0MGRkMmU0Njg5
-    YzMyZWZkNjRkYTRlMjk0NzM2NTc3NzRiZDdmYTMzMGU1ODgxZjAzMDMwMmM4
-    Y2UyMTg5NDk5MWE4NWEzOTIxMGU3N2IxZGI3ODEyZDliMTM5YTM=
+    ZWI5NTNmODJhYzkzNDEyMDBhYzEyNDcwYTkzNmM3ZDhiMDZiMzZjZTRmY2M2
+    MThkY2ZmNmFiMGQxZjk2MzQ3OTg3YTlhOThlNzE1YTg0OTkxMTY1N2RjZmI4
+    MmQ3MmNjMzE0ZWY2NzFmZDhkZTcyMGM5MDMzMTdhMjkxMjljZjI=
   data.tar.gz: !binary |-
-    ODcyOTEzMGU3MzFmNTI2MmQ2NDE0OWI3Y2JhOGJkZDE2MjE5NTJkYzljMjBl
-    NDkzZjU5ZjU1ODUwNDdjZGFhYTQzZTgxYzAyOTdmYzljODU5MDExMTcwODY1
-    ZmJlZjY4NzUxYjRkZjkwYjIxNzIzMTNhOWY5NWYwYmZiYmY4MDg=
+    MjNlZmM1ZWVjZWU3MjE5NmQxYjEyMzY5YTBkNjhmYzZjYmI1ZjlmYzJhYmVi
+    Y2NhYjA3ZjhiMGI2ZDExOTYxY2EzNDBlYmJjMThlZDJhZmU4NWNmNTk3MTdi
+    ZTM2NWFlYmIxMTg0ZmEyMmQ3MzNhOTIxNmI2NDU5ZTllNmRjMGU=

data/README.md

@@ -44,6 +44,21 @@ nrdp = Nagios::Nrdp.new(url: url, token: token)
 nrdp.submit_check(hostname: hostname, servicename: servicename, state: state.to_i, output: output)
 ```
 
+* Send multiple passive checks:
+
+```ruby
+require 'nagios_nrdp'
+
+url = 'http://some.host/nrdp'
+token = 'your token'
+checks = [{ hostname: 'host1', state: 1, output: 'DOWN' },
+          { hostname: 'host2', state: 0, output: 'UP' }]
+
+nrdp = Nagios::Nrdp.new(url: url, token: token)
+nrdp.submit_checks(checks)
+```
+
+
 * Send a command:
 
 ```ruby

data/Rakefile

@@ -3,6 +3,7 @@ require 'rake'
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
+require 'yard'
 
 task :default => :test
 
@@ -19,7 +20,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = 'nagios_nrdp'
     gem.summary = 'A ruby gem for submitting passive checks and commands to Nagios through NRDP.'
-    gem.description = 'A pure ruby implementation an NRDP client for submitting passive checks and commands to Nagios through NRDP.'
+    gem.description = 'A pure ruby implementation of an NRDP client for submitting passive checks and commands to Nagios through NRDP.'
     gem.email = 'stjeanp@pat-st-jean.com'
     gem.homepage = 'http://github.com/stjeanp/nrdp'
     gem.authors = ['stjeanp']
@@ -27,12 +28,21 @@ begin
     gem.files        = %w(README.md Rakefile) + Dir['lib/**/*'] + Dir['spec/**/*']
     gem.test_files   = Dir['spec/**/*']
     gem.licenses     = ['MIT']
+    gem.required_ruby_version = '>= 1.9.3'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
 end
 
+# Include Yard tasks for rake yard
+YARDOC_LOCATION = "doc"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', "README"]
+  t.options = ["--output-dir", YARDOC_LOCATION, "--title", "nagios_nrdp "]
+  #t.stats_options = ["--list-undoc"]
+end
+
 desc "Run syntax, lint, and rspec tests..."
 task :test => [
   :rubocop,

data/lib/nagios/nrdp.rb

@@ -2,13 +2,29 @@ require 'net/http'
 require 'uri'
 require 'nokogiri'
 
+# The parent, trying to keep the class tree clean
 module Nagios
   # Implements an interface to Nagios NRDP to facilitate submitting check
   # results and commands
+  #
+  # @see https://assets.nagios.com/downloads/nrdp/docs/NRDP_Overview.pdf
   class Nrdp
+    # @!attribute [rw] url
+    #   The URL of the NRDP endpoint
+    #   @return [String] the URL of the NRDP endpoint
     attr_accessor :url
+    # @!attribute [rw] token
+    #   The authentication token
+    #   @return [String] the authentication token
     attr_accessor :token
 
+    # Create a new instance of Nagios::Nrdp and set the URL and token
+    #
+    # @param [Hash] args parameters for this instance
+    # @option args [String] :url the URL of the NRDP endpoint
+    # @option args [String] :token the authentication token
+    #
+    # @raise [ArgumentError] when the args fail validation
     def initialize(args = {})
       @url = args[:url] || nil
       @token = args[:token] || nil
@@ -23,6 +39,17 @@ module Nagios
       fail ArgumentError, 'The token supplied is invalid!' unless @token && !@token.empty?
     end
 
+    # @overload submit_check(the_check)
+    #   Submit a single passive check result
+    #   @param [Hash] the_check the passive check result data
+    #   @option the_check [String] :hostname The hostname for this passive check
+    #   @option the_check [String] :servicename The optional service name for this passive check
+    #   @option the_check [Integer] :state The state of this passive check
+    #   @option the_check [String] :output The output of this passive check
+    #   @raise [RuntimeError] when the submission fails
+    # @overload submit_check(the_checks)
+    #   @param [Array<Hash>] the_checks an array of passive check results
+    #   @raise [RuntimeError] when the submission fails
     def submit_check(*args)
       if args[0].is_a? Hash
         the_checks = [args[0]]
@@ -66,6 +93,12 @@ module Nagios
     end
     alias_method :submit_checks, :submit_check
 
+    # Submit a Nagios command
+    #
+    # @param [String] the_command the command to be submitted
+    #
+    # @raise [ArgumentError] when the args fail validation
+    # @raise [RuntimeError] when the submission fails
     def submit_command(the_command = '')
       if !the_command || !the_command.is_a?(String) || the_command.empty?
         fail ArgumentError, 'Invalid command supplied!'
@@ -98,6 +131,17 @@ module Nagios
 
     private
 
+    # Validate the supplied check's data
+    #
+    # @api private
+    #
+    # @param [Hash] the_check the passive check result data
+    # @option the_check [String] :hostname The hostname for this passive check
+    # @option the_check [String] :servicename The optional service name for this passive check
+    # @option the_check [Integer] :state The state of this passive check
+    # @option the_check [String] :output The output of this passive check
+    #
+    # @raise [ArgumentError] when validation fails
     def validate_check(the_check = {})
       fail ArgumentError, 'Unknown parameters in check!' unless the_check.keys.all? { |key| [:hostname, :servicename, :state, :output].include? key }
       if [:hostname, :state, :output].any? { |key| !the_check.key?(key) }
@@ -106,6 +150,13 @@ module Nagios
       fail ArgumentError, "Check's state must be an integer!" unless the_check[:state].is_a? Integer
     end
 
+    # Create the XML document containing the passive check results
+    #
+    # @param [Array<Hash>] the_checks the array of passive check results
+    #
+    # @return [String] the XML document to be submitted
+    #
+    # @raise [ArgumentError] when the checks aren't valid
     def build_xml(the_checks = [])
       if the_checks.nil? || the_checks.count < 1
         fail ArgumentError, 'You must send at least one check!'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nagios_nrdp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - stjeanp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -138,7 +138,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: !binary |-
           MC44
-description: A pure ruby implementation an NRDP client for submitting passive checks
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MC44
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MC44
+description: A pure ruby implementation of an NRDP client for submitting passive checks
   and commands to Nagios through NRDP.
 email: stjeanp@pat-st-jean.com
 executables: []
@@ -165,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='