op5util 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66a61ce3bc99e6e4d91278aefc1c6d3f5f9c4fd2
-  data.tar.gz: ba3e0fd30da81840f892b86f3244337a1c74ae6b
+  metadata.gz: e98f6586637c365b530e61bfbe8f093810f91c4a
+  data.tar.gz: af78260122910360c4b002a63517e741cdd5dfb1
 SHA512:
-  metadata.gz: 971e2e9b7b31ec5df7b079ed2da7b67c0783d7b21cf916b6d42df074f3d4a0bb08d2f7990b9373745a4543f251424e42fe82c020dbe3ccad374509142649b7cc
-  data.tar.gz: 27bd5cf0ba4dd63fac584f02c4e92c16b91a2465a14cc77a29ae64d73297a0d185510d4e02f78b7120b32c0af509421432cfffc994438462a24159163f15ea1b
+  metadata.gz: 299a69cdfc4641c84eacbe55fda165b818e3d89fe164b07542c10d8767c9e52cbc7098a50fabd208e4872d56a492a740f29d3b5e6c00d345593b7b22eb5f9f01
+  data.tar.gz: ec5d9537d086bf34e302e063000806cb138a26919ea91b587ae502cf71a3c152163f80c9a203983bb67e7156129179f3a1398db8eeeaf6b84f16174454577f48

data/Readme.md

@@ -77,31 +77,36 @@ Once the problem is resolved and the host is up, ```op5util schedule gitlab01, b
 
 ## Installation
 
-Use gem install, probably with sudo if you are using a system-global ruby version. This will automatically
-install op5util with dependencies.
+Install instructions intended for and tested on a fresh install of ubuntu 16.04.
+
+Op5util is distributed as a ruby gem, so first ruby must be installed.
+
+``` shell
+user@host:~$ sudo apt-get install -y ruby
+```
+
+Use the command gem install, sudo is needed. This will automatically install op5util
+and the other gems that op5util depends on.
 
 ```shell
-$ sudo gem install op5util
-Fetching: colorize-0.8.1.gem (100%)
-Successfully installed colorize-0.8.1
-Fetching: gli-2.16.1.gem (100%)
-Successfully installed gli-2.16.1
-Fetching: multi_xml-0.6.0.gem (100%)
-Successfully installed multi_xml-0.6.0
-Fetching: httparty-0.15.5.gem (100%)
-When you HTTParty, you must party hard!
-Successfully installed httparty-0.15.5
-Fetching: unicode-display_width-1.3.0.gem (100%)
-Successfully installed unicode-display_width-1.3.0
-Fetching: terminal-table-1.8.0.gem (100%)
-Successfully installed terminal-table-1.8.0
-Fetching: op5util-0.1.2.gem (100%)
-Successfully installed op5util-0.1.2
-Done installing documentation for colorize, gli, multi_xml, httparty, unicode-display_width, terminal-table, op5util after 2 seconds
-7 gems installed
+user@host:~$ sudo gem install op5util
 ```
 
-Latest version is 0.1.2
+Latest version is 0.1.3, you can verify that op5util is installed correctly with:
+
+``` shell
+user@host:~$ gem list --details op5util
+
+*** LOCAL GEMS ***
+
+op5util (0.1.3)
+    Author: Niklas Paulsson
+    Homepage: https://github.com/np422/Op5util
+    License: MIT License
+    Installed at: /var/lib/gems/2.3.0
+
+    A utility to do common Op5 administration from the commandline
+```
 
 Rubygem homepage for op5util is available at: https://rubygems.org/gems/op5util
 
@@ -122,9 +127,9 @@ NAME
     About authentication, if you supply username/password as command-line flags they will be
     used first. If username/password options isn't supplied on the command-line, the environment
     variables OP5USER and OP5PASS will be used. If there are no environment variables present,
-    the file ~/.op5pass (or --authfile=) will be read. The file format is a single line with
-    username and password separated by a : (colon). The supplied credentials shoud be an
-    account with administrative privileges.
+    the file ~/.op5pass (or --authfile=, or environment OP5AUTHFILE) will be read. The file
+    format is a single line with username and password separated by a : (colon). The supplied
+    credentials shoud be an account with administrative privileges.
 
     This application uses the REST-api described at https://your.op5.sever/api/help. Although
     TLS/SSL is used, no verification of the certificate is done as most Op5-servers have a
@@ -134,11 +139,12 @@ SYNOPSIS
     op5util [global options] command [command options] [arguments...]
 
 VERSION
-    0.0.9
+    0.1.3
 
 GLOBAL OPTIONS
-    -f, --authfile=authfile - Authfile containing "username:password" used to authenticate
-                              with Op5 server (default: ~/.op5pass)
+    -f, --authfile=authfile - Authfile containing "username:password" used to authenticate with Op5
+                              server, enviromnent variable OP5AUTHFILE will override the default
+                              value (default: ~/.op5pass)
     --help                  - Show this message
     -m, --monitor=monitor   - Hostname or IP-address of the Op5 monitor server, if not supplied
                               the environment variable MONITOR will be used (default: none)
@@ -149,16 +155,18 @@ GLOBAL OPTIONS
     --version               - Display the program version
 
 COMMANDS
-    acknowledge    - Acknowledge outstanding host and service alarms.
+    acknowledge    - Acknowledge outstanding host and service alarms, without host - *ALL*
+                     outstanding alarms and services are acknowledged, ackn is "sticky" - it
+                     lasts until host/service recovery.
     add            - Add a new host to be monitored by the Op5 server
     add_hostgroups - Add host to a new hostgroup(s)
     downtime       - Schedule fixed downtime for a host
     help           - Shows a list of commands or help for one command
-    hostgroups     - List hostgroups, optionally with member and service info
+    hostgroups     - List hostgroups, optionally with member and service info, Usage examples:
+                     'op5util hostgroups' to list all hostgroups, 'op5util hostgroups -l linux_hosts'
                      to list members and services for the linux_hosts hostgroup
     schedule       - Schedule host and all host services checks to be performed swiftly for the given host
     status         - Show monitoring status, if no host is given all hosts/services are included
-
 ```
 
 ### Command usage
@@ -201,3 +209,10 @@ Please, give my repo a github star or drop me line if you find this utility usef
 free to leave a bug-reports or feature requests as an issue in this repo.
 
 /Niklas
+
+## Version history
+
+### 0.1.3
+
+Environment variable OP5AUTHFILE possible to use instead of --authfile, check permission
+of authfile and refuse to start if readable by other than owner.

data/lib/op5util/version.rb

@@ -1,3 +1,3 @@
 module Op5util
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/op5util.gemspec

@@ -1,4 +1,4 @@
-# rubocop:disable UselessAssignment, StringLiterals
+# rubocop:disable UselessAssignment
 require File.join([File.dirname(__FILE__), 'lib', 'op5util', 'version.rb'])
 spec = Gem::Specification.new do |s|
   s.name = 'op5util'
@@ -9,8 +9,8 @@ spec = Gem::Specification.new do |s|
   s.licenses = ['MIT License']
   s.homepage = 'https://github.com/np422/Op5util'
   s.summary = 'A utility to do common Op5 administration from the commandline'
-  s.files = `git ls-files`.split("
-")
+  s.files = %w[bin/op5util lib/op5util.rb LICENSE op5util.gemspec] +
+            %w[op5util.rdoc README.rdoc Readme.md] + Dir.glob('lib/op5util/*')
   s.require_paths << 'lib'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README.rdoc', 'op5util.rdoc']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: op5util
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Niklas Paulsson
@@ -117,12 +117,8 @@ extra_rdoc_files:
 - README.rdoc
 - op5util.rdoc
 files:
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
-- Rakefile
 - Readme.md
 - bin/op5util
 - lib/op5util.rb
@@ -140,19 +136,6 @@ files:
 - lib/op5util/version.rb
 - op5util.gemspec
 - op5util.rdoc
-- pkg/op5util-0.0.1.gem
-- pkg/op5util-0.0.2.gem
-- pkg/op5util-0.0.3.gem
-- pkg/op5util-0.0.9.gem
-- pkg/op5util-0.1.0.gem
-- pkg/op5util-0.1.1.gem
-- pkg/op5util-0.1.2.gem
-- screenshots/host_op5.png
-- screenshots/host_op5_listview.png
-- screenshots/usecase1.png
-- screenshots/usecase2.png
-- test/default_test.rb
-- test/test_helper.rb
 homepage: https://github.com/np422/Op5util
 licenses:
 - MIT License

data/.gitignore

@@ -1,7 +0,0 @@
-pkg/*/
-!pkg/*pkg
-*~
-.bundle/
-vendor/
-pkg/op5util-0.0.*.gem
-.DS_Store

data/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-gem 'colorize'
-gem 'httparty'
-gem 'terminal-table'
-
-group :development do
-  gem 'awesome_print'
-  gem 'rake'
-  gem 'rdoc'
-  gem 'test-unit'
-end

data/Gemfile.lock

@@ -1,42 +0,0 @@
-PATH
-  remote: .
-  specs:
-    op5util (0.1.3)
-      colorize (= 0.8.1)
-      gli (= 2.16.1)
-      httparty (= 0.15.5)
-      terminal-table (= 1.8.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    awesome_print (1.7.0)
-    colorize (0.8.1)
-    gli (2.16.1)
-    httparty (0.15.5)
-      multi_xml (>= 0.5.2)
-    multi_xml (0.6.0)
-    power_assert (0.2.6)
-    rake (12.0.0)
-    rdoc (5.1.0)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    test-unit (3.2.5)
-      power_assert
-    unicode-display_width (1.2.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  awesome_print
-  colorize
-  httparty
-  op5util!
-  rake
-  rdoc
-  terminal-table
-  test-unit
-
-BUNDLED WITH
-   1.15.1

data/Rakefile

@@ -1,16 +0,0 @@
-require 'rake/clean'
-require 'rubygems'
-require 'rubygems/package_task'
-require 'rdoc/task'
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
-  rd.title = 'Your application title'
-end
-
-spec = eval(File.read('op5util.gemspec'))
-
-Gem::PackageTask.new(spec) do |pkg|
-end
-
-task :default => [:test]

data/test/default_test.rb

@@ -1,14 +0,0 @@
-require 'test_helper'
-
-class DefaultTest < Test::Unit::TestCase
-
-  def setup
-  end
-
-  def teardown
-  end
-
-  def test_the_truth
-    assert true
-  end
-end

data/test/test_helper.rb

@@ -1,9 +0,0 @@
-require 'test/unit'
-
-# Add test libraries you want to use here, e.g. mocha
-
-class Test::Unit::TestCase
-
-  # Add global extensions to the test case class here
-  
-end