opsview_rest 0.0.1

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'rest-client', :require=>"rest_client"
+gem 'json'
+
+
+group :development do
+  gem 'rake'
+  gem "rspec", "~> 2.0.0"
+  gem "yard"
+  gem 'jeweler'
+end
+
+
+

data/README.rdoc

@@ -0,0 +1,41 @@
+= WARNING! ACHTUNG!
+
+Don't use yet!  This gem is still in development, and I heavily recommend
+against *anyone* using this gem.
+
+Also, descriptions on how the gem works in this README is bound to change
+at any time.
+
+= opsview_rest
+
+A Ruby Gem that allows you to interact with an Opsview server.
+
+== Resources
+
+First iteration will focus on creating/updating/deleting resources on an
+Opsview server.  The following resources are currently supported:
+
+- Hosts
+- Contacts
+- Hostgroups
+- Host Templates
+- Notification Methods
+- Roles
+- Service Checks
+- Service Groups
+
+This gem is heavily based off of Adam Jacob's "dynect_rest" gem.
+
+This is how you would use the gem to create a resource:
+
+  require 'opsview_rest'
+  connection = OpsviewRest.new(:url => "https://example.com/rest", :username => "hi", :password => "hello")
+  host = connection.create(:name    => "foobar",
+                           :ip      => "192.168.1.1",
+                           :type    => :host,
+                           :replace => false)
+
+  # Let's say we want to peer into what we have so far for hosts:
+
+  connection = Opsview.new(...)
+  hosts = connection.host.list

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "opsview_rest"
+    gem.summary = %Q{Opsview REST API library}
+    gem.description = %Q{Update configuration on Opsview server via REST API}
+    gem.email = "christian.paredes@seattlebiomed.org"
+    gem.homepage = "http://github.com/cparedes/opsview_rest"
+    gem.authors = ["Christian Paredes"]
+    gem.add_development_dependency "rspec", ">= 2.0"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_dependency('json')
+    gem.add_dependency('rest-client')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(: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"
+  end
+end

data/TODO.md

@@ -0,0 +1,20 @@
+TODO List
+=========
+
+1. Figure out a way to instantiate a ton of methods for all of the different
+   resource types.  There isn't a nice way to deal with, say, hosts, and
+   hostgroups at the moment (since they all have different parameters.)
+   The only things that are common between the different resource types
+   are "name" and "id".
+1a. If not this, then there should be a better way to deal with the plethora
+    of fields that we could possibly update in Opsview for each resource type.
+    I've mostly based the code off of Adam Jacob's dynect_rest gem, which
+    has a much simpler API and a predictable set of parameters - thus, it
+    makes sense to dynamically create a ton of methods and allow stuff like
+    "dynect.record.ip.foobar" as an accessor.
+
+    One thought is to simply choose a functional subset of the parameters we
+    could pass into each type of resource, and add more as the need arises.
+    Another thought is to simply pass in a hash with a bunch of data in it,
+    but I'd rather not do this, as it'd make the user guess how best to format
+    the data.

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/opsview_rest/attribute.rb

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

data/lib/opsview_rest/contact.rb

@@ -0,0 +1,68 @@
+require 'opsview_rest/mixin'
+
+class OpsviewRest
+  class Attribute
+
+    include OpsviewRest::Mixin
+
+    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" }
+        ],
+        :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 => "workhours" } }
+        ],
+        :save    => true,
+        :replace => false
+      }.update options
+
+      @opsview = opsview
+
+      @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 } }
+      @options[:keywords] = @options[:keywords].map { |x| { "name" => x } }
+      @options[:hostgroups] = @options[:hostgroups].map { |x| { "name" => x } }
+      @options[:role] = { "name" => @options[:role] }
+
+      save(@options[:replace]) if @options[:save]
+    end
+
+  end
+end

data/lib/opsview_rest/host.rb

@@ -0,0 +1,76 @@
+require 'opsview_rest/mixin'
+
+class OpsviewRest
+  class Host
+
+    include OpsviewRest::Mixin
+
+    attr_accessor :options, :opsview
+
+    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
+      }.update options
+
+      @opsview = opsview
+
+      # 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] }
+
+      save(@options[:replace]) if @options[:save]
+    end
+
+  end
+end

data/lib/opsview_rest/hostcheckcommand.rb

@@ -0,0 +1,31 @@
+require 'opsview_rest/mixin'
+
+class OpsviewRest
+  class Hostcheckcommand
+
+    include OpsviewRest::Mixin
+
+    attr_accessor :opsview, :options
+
+    def initialize(opsview, options = {})
+      @options = {
+        :name => "ping",
+        :args => "-H $HOSTADDRESS$ -t 3 -w 500.0,80% -c 1000.0,100%",
+        :priority => 1,
+        :plugin => "check_icmp",
+        :uncommitted => false,
+        :save    => true,
+        :replace => false
+      }.update options
+
+      @opsview = opsview
+
+      @options[:plugin] = { "name" => @options[:plugin] }
+      @options[:hosts] = @options[:hosts].map { |x| { "name" => x } }
+      @options[:uncommitted] = if @options[:uncommitted] then 1 else 0 end
+
+      save(@options[:replace]) if @options[:save]
+    end
+
+  end
+end

data/lib/opsview_rest/hostgroup.rb

@@ -0,0 +1,28 @@
+require 'opsview_rest/mixin'
+
+class OpsviewRest
+  class Hostgroup
+
+    include OpsviewRest::Mixin
+
+    attr_accessor :opsview, :options
+
+    def initialize(opsview, options = {})
+      @options = {
+        :parent => "Opsview",
+        :name => "unknown",
+        :save    => true,
+        :replace => false
+      }.update options
+
+      @opsview = opsview
+
+      @options[:parent] = { "name" => @options[:parent] }
+      @options[:hosts] = @options[:hosts].map { |x| { "name" => x } }
+      @options[:children] = @options[:children].map { |x| { "name" => x } }
+
+      save(@options[:replace]) if @options[:save]
+    end
+
+  end
+end

data/lib/opsview_rest/mixin.rb

@@ -0,0 +1,29 @@
+class OpsviewRest
+  module Mixin
+
+    def resource_path(full=false)
+      if (full == true || full == :full)
+        "/rest/config/#{self.class.name.split('::').last.downcase}"
+      else
+        "config/#{self.class.name.split('::').last.downcase}"
+      end
+    end
+
+    def list
+      self.opsview.get(resource_path)
+    end
+
+    def save(replace=false)
+      if replace == true || replace == :replace
+        self.opsview.put(self.resource_path, self)
+      else
+        self.opsview.post(self.resource_path, self)
+      end
+    end
+
+    def to_json
+      self.options.to_json
+    end
+
+  end
+end

data/lib/opsview_rest.rb

@@ -0,0 +1,125 @@
+require 'rest-client'
+require 'json'
+
+class OpsviewRest
+
+  attr_accessor :url, :username, :password, :rest
+
+  def initialize(url, options = {})
+    options = {
+      :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' })
+
+    login if options[:connect]
+  end
+
+  def login
+    response = post('login', { 'username' => @username, 'password' => @password })
+    @rest.headers[:x_opsview_token]    = response['token']
+    @rest.headers[:x_opsview_username] = @username
+    response
+  end
+
+  def logout
+    delete('login')
+  end
+
+  def create(options = {})
+    case options[:type]
+    when :attribute
+      require 'opsview_rest/attribute'
+      OpsviewRest::Attribute.new(self, options)
+    when :contact
+      require 'opsview_rest/contact'
+      OpsviewRest::Contact.new(self, options)
+    when :host
+      require 'opsview_rest/host'
+      OpsviewRest::Host.new(self, options)
+    when :hostcheckcommand
+      require 'opsview_rest/hostcheckcommand'
+      OpsviewRest::Hostcheckcommand.new(self, options)
+    when :hostgroup
+      require 'opsview_rest/hostgroup'
+      OpsviewRest::Hostgroup.new(self, options)
+    when :hosttemplate
+      require 'opsview_rest/hosttemplate'
+      OpsviewRest::Hosttemplate.new(self, options)
+    when :keyword
+      require 'opsview_rest/keyword'
+      OpsviewRest::Keyword.new(self, options)
+    when :monitoring_server
+      require 'opsview_rest/monitoring_server'
+      OpsviewRest::MonitoringServer.new(self, options)
+    when :notification_method
+      require 'opsview_rest/notification_method'
+      OpsviewRest::NotificationMethod.new(self, options)
+    when :role
+      require 'opsview_rest/role'
+      OpsviewRest::Role.new(self, options)
+    when :servicecheck
+      require 'opsview_rest/servicecheck'
+      OpsviewRest::Servicecheck.new(self, options)
+    when :servicegroup
+      require 'opsview_rest/servicegroup'
+      OpsviewRest::Servicegroup.new(self, options)
+    when :timeperiod
+      require 'opsview_rest/timeperiod'
+      OpsviewRest::Timeperiod.new(self, options)
+    else
+      raise "Type not implemented yet."
+    end
+  end
+
+  def get(path_part, additional_headers = {}, &block)
+    api_request { @rest[path_part].get(additional_headers, &block) }
+  end
+
+  def delete(path_part, additional_headers = {}, &block)
+    api_request { @rest[path_part].delete(additional_headers, &block) }
+  end
+
+  def post(path_part, payload, additional_headers = {}, &block)
+    api_request { @rest[path_part].post(payload.to_json, additional_headers, &block) }
+  end
+
+  def put(path_part, payload, additional_headers = {}, &block)
+    api_request { @rest[path_part].put(payload.to_json, additional_headers, &block) }
+  end
+
+  def api_request(&block)
+    response_body = begin
+      response = block.call
+      response.body
+    rescue RestClient::Exception => e
+      puts "I have #{e.inspect} with #{e.http_code}"
+      if e.http_code == 307
+        get(e.response)
+      end
+      e.response
+    end
+    parse_response(JSON.parse(response_body))
+  end
+
+  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 we have a token, return that:
+    elsif response["token"]
+      response
+    # If we have a list of objects, return the list:
+    elsif response["list"]
+      response["list"]
+    else
+      response["object"]
+    end
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification 
+name: opsview_rest
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Christian Paredes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: rest-client
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: json
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: rake
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  version_requirements: *id004
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: yard
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  version_requirements: *id007
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
+  name: yard
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id009
+  name: json
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id010
+  name: rest-client
+  prerelease: false
+  type: :runtime
+description: Update configuration on Opsview server via REST API
+email: christian.paredes@seattlebiomed.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- README.rdoc
+- Rakefile
+- TODO.md
+- VERSION
+- 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/mixin.rb
+homepage: http://github.com/cparedes/opsview_rest
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Opsview REST API library
+test_files: []
+