swiss_admin 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63eff973bde4a3cbdc4db697e985346757472687
+  data.tar.gz: 5daea5b752c885c7539c7289cbb9c9da2bf287c2
+SHA512:
+  metadata.gz: 4a469600791cf64ef5d448c4da69a8cdedcb65de6b0afaee0e63e376153451fba0f3be6dda574a77dc4fd021cedc3ad3ac45a1bfed4b2d42ec39dfb70472fc76
+  data.tar.gz: abd5c1846b50ea41da4b414720e98e86f702f49b9f62fd2ca27ad5aa0f3a15a8292f14a6c4ca43e6da8af44c0d52fc207e1352e190a1e9514a71a397466bf3e7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swiss_admin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bradley Smith
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,275 @@
+# SwissAdmin
+
+A generous, but not too bloated, system/host helpers for any self respecting system administrator ;)
+
+SwissAdmin can either be included in your project or can used from the CLI.
+
+I find it best to install swissadmin in your global gemset.
+
+### This only works on Linux
+
+## Things that make swissadmin cool.
+
+1. It offers just the right amount of information about the system/host your are running it on.
+2. Provides a web server for REST calls.
+3. Provides a DRb server to query host for information. (see todo)
+4. Everytime you use it puppies and rainbows shoot into the sky.
+
+There a tons of tools that do similar stuff, but I find them to contain way to much information.
+I do not have the brain capacity to remember all those arguments and parsing features. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'swiss_admin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swiss_admin
+
+## Usage
+
+* only commands listed below are funcitonal currenlty
+
+```bash
+Commands:
+  swissadmin hardware SUBCOMMAND  # Returns information about host hardware
+  swissadmin help [COMMAND]       # Describe available commands or one specific command
+  swissadmin host SUBCOMMAND      # Returns information about the host
+  swissadmin network SUBCOMMAND   # Returns information about host network
+  swissadmin user SUBCOMMAND      # Returns information about user(s) on host
+```
+
+### Hardware 
+List information about the host's hardware
+
+```bash
+Commands:
+  swissadmin hardware cpus            # Number of cpu's
+  swissadmin hardware help [COMMAND]  # Describe subcommands or one specific subcommand
+  swissadmin hardware memory          # memory for host
+```
+
+```ruby 
+swissadmin hardware cpus #=> 4
+```
+
+```ruby 
+swissadmin hardware memory #=> 
+MemTotal           7873568
+MemFree            3731188
+Buffers            164064
+.....
+```
+
+### Host
+
+Returns information about the host
+
+```bash
+commands:
+  swissadmin host help [COMMAND]  # Describe subcommands or one specific subcommand
+  swissadmin host name            # Hostname
+  swissadmin host loadavg         # Current system load 
+```
+
+```ruby
+swissadmin host name #=> foo.local
+```
+
+```ruby
+# 1,5,15,number of currently running processes/total number of processes, pid
+swissadmin host loadavg #=> 0.10 0.19 0.23 1/742 24553
+```
+
+### Network
+
+Return information about the host's network 
+
+```bash
+Commands:
+  swissadmin network first_ipv4      # First ipv4 interface
+  swissadmin network help [COMMAND]  # Describe subcommands or one specific subcommand
+  swissadmin network ip_addresses    # All the ip addresses on this host
+```
+
+```ruby 
+swissadmin host ip_addresses #=> {:ip_address=>"127.0.0.1", :name=>["localhost", "0"]}
+{:ip_address=>"192.168.4.34", :name=>["bradleyd-900X4C.local", "0"]}
+{:ip_address=>"::1", :name=>["ip6-localhost", "0"]}
+{:ip_address=>"fe80::c685:8ff:fe72:beab%wlan0", :name=>["fe80::c685:8ff:fe72:beab%wlan0", "0"]}
+```
+
+```ruby 
+swissadmin host first_ipv4 #=> 192.168.0.5
+```
+
+### User
+
+Return information about user(s)
+
+```bash
+Commands:
+  swissadmin user active          # All active users
+  swissadmin user current         # Current user
+  swissadmin user help [COMMAND]  # Describe subcommands or one specific subcommand
+  swissadmin user home            # Current user's home directory
+```
+
+```ruby
+swissadmin user active #=>
+bradleyd tty7     :0                2days init --user
+bradleyd pts/0    :0               57:24  bash
+bradleyd pts/3    :0                1:06m bash
+bradleyd pts/8    :0.0              4.00s w -s -h
+```
+
+```ruby
+swissadmin user current #=> bradleyd
+```
+
+```ruby
+swissadmin user home #=> /home/bradleyd
+```
+
+### Web
+```bash
+Commands:
+  swissadmin web help [COMMAND]  # Describe subcommands or one specific subcommand
+  swissadmin web start           # Start web server
+  Usage:
+  swissadmin start
+Options:
+  -p, [--port=PORT]  # Set port for web companion
+                     # Default: 8080
+
+  swissadmin web stop            # Stop web server
+  swissadmin web status          # Status of the web server
+```
+
+```ruby
+swissadmin web start
+```
+This also gives you an API which you can query
+
+Every CLI command can be accessed via the REST API
+
+```ruby
+curl localhost:8080/api/host/loadavg #=> {"load_average":"0.29 0.29 0.28 2/972 27659\n"}
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Add a new command
+### This is a work in progress and might not be worth a dam
+
+To add a new command you must understand the directory structures of ```lib/``` and ```cli/```
+
+### lib/
+
+```bash
+lib/swiss_admin/
+├── hardware
+│   ├── cpus.rb
+│   └── memory.rb
+├── host
+│   └── host.rb
+├── network
+│   └── network.rb
+├── user
+│   └── user.rb
+```
+
+### cli/
+```bash
+lib/swiss_admin/cli/
+├── cli.rb
+├── hardware_cli.rb
+├── host_cli.rb
+├── network_cli.rb
+└── user_cli.rb
+```
+
+Let's say you have a need for a command called--you guessed it--```foo```
+
+```foo``` will give you the ultimate answer.
+
+* I will assume you have written tests for ```foo``` you know who you are!
+
+If ```foo``` does not fit in any category from ```lib/``` then you would create a new one.  
+
+Create a file and directory called foo and adjust to your liking.
+
+```ruby
+# foo/foo.rb
+module SwissAdmin
+  class Foo
+    def self.answer
+      "42"
+    end
+  end
+end
+```
+
+Run your tests...green I presume.
+
+Create another file under ```cli/``` cleverly called ```foo_cli.rb```
+
+```ruby 
+module SwissAdmin
+  module Commands
+    class Foo < Thor
+      namespace :foo
+
+      desc "answer", "ultimate answer"
+      def answer
+        $stdout.puts SwissAdmin::Foo.answer
+      end
+
+    end
+  end
+end
+```
+
+* Note, we are calling ```Foo``` class from ```lib/``` instead of just creating it here
+* This is so we can use ```swissadmin``` as library in another project and forgo the CLI
+
+
+Next, we need to tell ```CLI``` about this new command.
+
+```ruby
+#lib/cli/cli.rb
+
+module SwissAdmin
+  class CLI < Thor
+    #....snippet....
+    desc "foo SUBCOMMAND", "Returns the ultimate answer"
+    subcommand "foo", SwissAdmin::Commands::Foo
+  end
+end
+```
+
+This will give ```swissadmin``` the ultimate power and bestow it upon you ;)
+
+```ruby
+swissadmin foo answer #=> 42
+```
+
+### TODO
+
+* create DRB server
+* Lock down web server with basic auth or token
+* Show all commands available in CLI
+* Show all commands available in Web
+* Write pid, port file path to `~/.swissadmin/.web.conf

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.options = "-v"
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb", "test/cli/*_test.rb"]
+end

data/bin/swissadmin

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
+require "bundler/setup"
+require 'swiss_admin'
+
+SwissAdmin::CLI.start

data/lib/swiss_admin.rb

@@ -0,0 +1,9 @@
+require "swiss_admin/version"
+require "swiss_admin/cli"
+require "swiss_admin/host"
+require "swiss_admin/hardware"
+require "swiss_admin/network"
+require "swiss_admin/user"
+
+module SwissAdmin
+end

data/lib/swiss_admin/cli.rb

@@ -0,0 +1,6 @@
+require "swiss_admin/cli/host_cli"
+require "swiss_admin/cli/hardware_cli"
+require "swiss_admin/cli/network_cli"
+require "swiss_admin/cli/user_cli"
+require "swiss_admin/cli/web_cli"
+require "swiss_admin/cli/cli"

data/lib/swiss_admin/cli/cli.rb

@@ -0,0 +1,19 @@
+require "thor"
+module SwissAdmin
+  class CLI < Thor
+    desc "host SUBCOMMAND", "Returns information about the host"
+    subcommand "host", SwissAdmin::Commands::Host
+
+    desc "hardware SUBCOMMAND", "Returns information about host hardware"
+    subcommand "hardware", SwissAdmin::Commands::Hardware
+    
+    desc "network SUBCOMMAND", "Returns information about host network"
+    subcommand "network", SwissAdmin::Commands::Network
+
+    desc "user SUBCOMMAND", "Returns information about user(s) on host"
+    subcommand "user", SwissAdmin::Commands::User
+
+    desc "web SUBCOMMAND", "A basic web ui with all of the hosts information"
+    subcommand "web", SwissAdmin::Commands::Web
+  end
+end

data/lib/swiss_admin/cli/hardware_cli.rb

@@ -0,0 +1,19 @@
+require "thor"
+module SwissAdmin
+  module Commands
+    class Hardware < Thor
+      namespace :hardware
+
+      desc "cpus", "Number of cpu's"
+      def cpus
+        $stdout.puts SwissAdmin::Hardware.cpus
+      end
+
+      desc "memory", "memory for host"
+      def memory
+        print_table(SwissAdmin::Hardware.memory)
+      end
+    end
+  end
+end
+

data/lib/swiss_admin/cli/host_cli.rb

@@ -0,0 +1,18 @@
+require "thor"
+module SwissAdmin
+  module Commands
+    class Host < Thor
+      namespace :host
+
+      desc "name", "Hostname"
+      def name
+        $stdout.puts SwissAdmin::Host.name
+      end
+
+      desc "loadavg", "Current system load"
+      def loadavg
+        $stdout.puts SwissAdmin::Host.loadavg
+      end
+    end
+  end
+end

data/lib/swiss_admin/cli/network_cli.rb

@@ -0,0 +1,19 @@
+require "thor"
+module SwissAdmin
+  module Commands
+    class Network < Thor
+      namespace :network
+
+      desc "ip_addresses", "All the ip addresses on this host"
+      def ip_addresses
+        $stdout.puts SwissAdmin::Network.ip_addresses
+      end
+
+      desc "first_ipv4", "First ipv4 interface"
+      def first_ipv4
+        $stdout.puts SwissAdmin::Network.first_ipv4 
+      end
+    end
+  end
+end
+