apocalypse-client 0.0.2 → 0.0.3

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+host.yml

data/README.md

@@ -17,25 +17,13 @@ Next install the ruby gem.
 
     sudo gem install apocalypse-client
 
-Now you can create the file `/etc/cron.d/apocalypse` with the following
-content:
-
-    * * * * * root PATH=$PATH:/sbin:/usr/sbin /usr/bin/env apocalypse-client report --server SERVER --port PORT --hostid HOSTID > /dev/null
-
+once installed run the install|now command
+  apocalypse-client now
+    
 This will send metrics data every minute to your Apocalypse server. If
 you require different intervals, refer to `man 5 crontab` for details on
 how to schedule reporting.
 
-You need to replace the placeholders with actual data:
-
- * `SERVER` - The ip or hostname for your Apocalypse server. E.g.
-   apocalyse.example.org
- * `PORT` - The port number the Apocalypse server is listening on.
-   Default: 80
- * `HOSTID` - An ID identifying this server. You are free to choose
-   whatever you want. But be careful not to chose a duplicate hostid,
-because it will mess up you statistics. 
-
 If an error occurs cron will try to notify you by email. This depends on
 how your systems cron is configured.
 

data/bin/apocalypse-client

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 require "apocalypse-client"
 require 'trollop'
 
-SUB_COMMANDS = %w(report install check)
+SUB_COMMANDS = %w(report check install now update)
 
 global_opts = Trollop::options do
   banner "Apocalypse Reporter"
@@ -17,14 +17,13 @@ cmd = ARGV.shift
 cmd_opts = case cmd
   when "report"
     Trollop::options do
-      opt :server,  "Hostname of the Apocalypse Server", :type => :string, :short => "-s"
-      opt :port,    "Port the Apocalypse Server is listening on. Default: 80", :type => :string, :default => '80', :short => "-p"
-      opt :hostid,  "Identifier for this server", :type => :string, :short => "-i"
+      # Nothing here
     end
+  when "update"
+    Trollop::options {}    
   when "install"
-    Trollop::options do
-      # TODO
-    end
+  when "now"    
+    Trollop::options {}
   when "check"
     Trollop::options do
       # TODO

data/lib/apocalypse-client.rb

@@ -1,6 +1,10 @@
+require "yaml"
 require 'rubygems'
 require 'net/http'
 require 'json'
+require 'apocalypse-client/version'
+require 'apocalypse-client/response'
+require 'apocalypse-client/install'
 
 class Hash
   #
@@ -14,15 +18,26 @@ end
 
 module Apocalypse
   class Client
-    ## Commands
+    def self.host_file;     "#{File.dirname(__FILE__)}/../host.yml"; end
+    def self.cron_job_file; "/etc/cron.d/apocalyse"; end    
+    def self.rvm?;          !`which rvm`.chomp.empty? end        
+    
+    def self.cron_job_command
+      return rvm? \
+        ? " * * * * * root PATH=$PATH:/sbin:/usr/sbin rvm use $RUBY_VERSION ; /usr/local/bin/rvm exec apocalypse-client report > /dev/null" \
+        : "* * * * * root PATH=$PATH:/sbin:/usr/sbin /usr/bin/env apocalypse-client report > /dev/null"
+    end
 
     # Report metrics
     def report(options)
-      puts options.inspect
-			request = Net::HTTP::Post.new("/api/metrics/#{options[:hostid]}", initheader = {'Content-Type' =>'application/json'})
-		  request.body = gather_metrics.to_json
-      response = Net::HTTP.new(options[:server], options[:port]).start {|http| http.request(request) }
-      puts "Response #{response.code} #{response.message}: #{response.body}"
+      request       = Net::HTTP::Post.new("/api/metrics/#{properties[:hostname]}", initheader = {'Content-Type' =>'application/json'})
+      request.body  = gather_metrics.to_json
+      Net::HTTP.start(properties[:server_address], properties[:port]) do |http|
+        request.basic_auth(properties[:username], properties[:password])
+        response              = http.request(request)
+        
+        Apocalyse::Client::Response.parse!(response)
+      end
     end
 
     # Check if all local deps are available
@@ -41,16 +56,18 @@ module Apocalypse
       end
     end
 
-    def install(options)
-      puts <<-EOF
-Sorry, no automated installation yet. Installation is, however, quite easy.
-
-Simply create the file `/etc/cron.d/apocalypse` and put the following line in it:
+    def update(options)
+      installation = Apocalyse::Client::Install.new
+      installation.update!
+    end
 
-* * * * * root PATH=$PATH:/sbin:/usr/sbin /usr/bin/env apocalypse-reporter report --server APOCALYPSE_SERVER --hostid SERVER_ID > /dev/null
+    def now(options)
+      install(options)
+    end
 
-Make sure to replace the server and hostid placeholders with something more useful.
-      EOF
+    def install(options)
+      installation = Apocalyse::Client::Install.new
+      installation.install!
     end
 
     # Gather metrics
@@ -63,10 +80,15 @@ Make sure to replace the server and hostid placeholders with something more usef
         'memory' => memory_metrics,
         'swap' => swap_metrics,
         'blockdevices' => blockdevice_metrics,
-        'network' => network_metrics
+        'network' => network_metrics,
+        'client'  => client_information
       }
     end
 
+    def client_information
+      { 'version' => Apocalypse::Client::VERSION }
+    end
+
     # Returns the number of CPU Cores for this system
     def cpu_cores
       `cat /proc/cpuinfo | grep bogomips | wc -l`.strip
@@ -129,5 +151,11 @@ Make sure to replace the server and hostid placeholders with something more usef
         }}
       end
     end
+    
+    private
+      def properties
+        throw Exception.new("Host file not found. Please run `apocalyse-client now`") unless File.exists?(self.class.host_file)
+        @properties ||= ::YAML.load(File.open(self.class.host_file))
+      end
   end
 end

data/lib/apocalypse-client/install.rb

@@ -0,0 +1,151 @@
+module Apocalyse
+  module Client
+    class Install
+      def install!
+        check_file_access   # Start of by checking if we can write the Cron job
+        read_values         # Now ask the user for the configuration input
+        validate            # Make sure the input is correct
+        check_server        # Check if the provided server is accessible 
+        write_host_file     # Write the configuration file for this host
+        install_cron_job    # Finally install the Cronjob
+        
+        puts "All done.."
+      rescue Exception => e
+       puts e.message
+      end
+
+      def update!
+        puts "Updating..."
+        #  Nothing here as nothing needs to be updated yet.
+      end
+      
+      def self_update!
+        update_gem         # gem update apocalypse-client
+        update_command     # Do a update command
+        
+      rescue Exception => e
+        puts e.message
+      end
+      
+      protected 
+        # Read the configuration for this server provided by the user
+        def read_values
+          # Read the Apocalypse Server information
+          url        = read_user_input("Enter The full address of the Apocalypse server: ").downcase
+          @port      = read_user_input("Enter The port number of the Apocalypse server {{default}}: ", "80")
+          
+          # Cleanup the user input for the server input
+          url         = url.gsub(/http:\/\/(.+?$)/, "\\1") if url =~ /^http:\/\//i
+          @address    = url.gsub(/\/$/, "")
+
+          # HTTP auth variables
+          @username = read_user_input("Enter your username {{default}}: "     , `whoami`)
+          @password = read_user_input("Enter your password: "                 , "", false)
+          
+          # This servers hostname
+          @hostname = read_user_input("Enter The full hostname(FQDN) {{default}}: " , `hostname`).downcase
+        end
+      
+        # Ask the user if the input is valid
+        # If so write the host file and continue installing
+        def validate
+          2.times { puts }
+          puts <<-EOF
+You have entered the following information
+Apocalypse server       : #{@address}
+Apocalypse server port  : #{@port}
+Apocalypse username     : #{@username}
+Apocalypse password     : #{'*' *@password.length}
+This Server' hostname   : #{@hostname}
+EOF
+
+          print "Is this correct? [no]: "
+          raise Exception.new("Aborted by user.") unless gets =~ /^y(?:es|)$/
+          puts
+        end
+        
+        # Check if the server address is correct
+        def check_server
+          raise Exception.new("Could not reach Apocalypse server please check the address and port and try again.") unless server_reachable?
+        end
+
+        # Write the user provided information to a YAML file
+        def write_host_file
+          puts "Writing Apocalypse host file..."
+          host_config   = {
+                           :hostname        => @hostname,
+                           :server_address  => @address, 
+                           :port            => @port,                           
+                           :username        => @username, 
+                           :password        => @password
+                          }
+          file          = File.open(::Apocalypse::Client.host_file, "w") do |f|
+            f.write host_config.to_yaml
+          end          
+        end
+        
+        def check_file_access
+          writeable = `if [ \`touch #{::Apocalypse::Client.cron_job_file} 2> /dev/null; echo "$?"\` -eq 0 ]; then
+          echo "true"
+          else
+          echo "false"
+          fi`          
+          unless writeable.chomp.eql? "true"
+           raise Exception.new("You don't have permission to write #{::Apocalypse::Client.cron_job_file}. Either run the script as root or make #{::Apocalypse::Client.cron_job_file} writeable for this user.")
+          end
+        end
+        
+        def install_cron_job
+          `echo "#{::Apocalypse::Client.cron_job_command}" > #{::Apocalypse::Client.cron_job_file}`
+        end
+        
+        def update_gem
+          if ::Apocalypse::Client.rvm?  
+            puts "Updating gem using RVM.."
+            `PATH=$PATH:/sbin:/usr/sbin rvm use $RUBY_VERSION; /usr/local/bin/rvm gem update apocalypse-client > /dev/null`
+          else
+            puts "Updating system gem.."          
+            `PATH=$PATH:/sbin:/usr/sbin; sudo gem update apocalypse-client > /dev/null`
+          end          
+        end
+        
+        def update_command
+          if ::Apocalypse::Client.rvm?  
+            `PATH=$PATH:/sbin:/usr/sbin rvm use $RUBY_VERSION; apocalypse-client update > /dev/null`
+          else
+            `PATH=$PATH:/sbin:/usr/sbin /usr/bin/env apocalypse-client update > /dev/null`
+          end          
+        end
+        
+      private
+        # Read the user input from the console and return either the default value or the user input
+        def read_user_input(message, default = "", show_input = true)
+          print interpolate_message(message, default)
+          show_input ? gets : silent_command { gets }
+          ($_.chomp.empty?) ? default.chomp : $_.chomp
+        end
+        
+        # Interpolate the message with the given string replacing: {{var}} with: (var: #{str})
+        def interpolate_message(message, str)
+          message.gsub(/\{\{(.+?)\}\}/, (str.empty?) ? "" : "(\\1: #{str.chomp})")
+        end
+        
+        # Execute the command in the given block without returning writing anything to stdout
+        def silent_command(&cmd)
+          system "stty -echo"          
+          yield
+          system "stty echo"
+          puts
+        end
+        
+        # Check if the server is reachable before continuing with the installation
+        def server_reachable?
+          puts "Checking #{@address}:#{@port}"
+          res = Net::HTTP.start(@address, @port) {|http| http.get('/') }
+          return res.code == "200"
+        end
+    end
+  end
+end
+
+

data/lib/apocalypse-client/response.rb

@@ -0,0 +1,40 @@
+module Apocalyse
+  module Client
+    class Response
+      RESULT_OK               = 0
+      RESULT_CLIENT_OUTDATED  = 1001
+      
+      def self.parse!(response)
+        return if response.code.to_i == 401
+        
+        if response.code.to_i == 200
+          response_obj = JSON.parse(response.body)
+          unless response_obj["code"] == RESULT_OK
+            perform!(response_obj["code"])
+          end
+        else
+          resolve_invalid_response
+        end
+        
+      rescue => e 
+        resolve_invalid_response
+      end
+
+      def self.perform!(result_code)
+        case result_code
+          when RESULT_CLIENT_OUTDATED
+            puts "Received update result code"            
+            ::Apocalyse::Client::Install.new.self_update!
+
+          else
+            resolve_invalid_response
+          end
+      end
+
+      def self.resolve_invalid_response
+        puts "Invalid response, let's try to update."
+        ::Apocalyse::Client::Install.new.self_update!
+      end      
+    end
+  end
+end   

data/lib/apocalypse-client/version.rb

@@ -1,5 +1,5 @@
 module Apocalypse
   class Client
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/client_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 
+
 describe Apocalypse::Client do
   before(:each) do
     @reporter = Apocalypse::Client.new
@@ -122,4 +123,10 @@ EOF
       sda2["mount"].should eql("/")
     end
   end
+  
+  describe "Client information" do
+    it "should return the current version of this client." do
+      @reporter.client_information.should eql({ 'version' => Apocalypse::Client::VERSION })
+    end
+  end  
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'apocalypse-client'
-
+require 'apocalypse-client/version'
 require 'rspec'
 require 'json'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apocalypse-client
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ariejan de Vroom
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-06 00:00:00 +02:00
-default_executable: 
+date: 2011-10-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -84,10 +83,11 @@ files:
 - apocalypse-client.gemspec
 - bin/apocalypse-client
 - lib/apocalypse-client.rb
+- lib/apocalypse-client/install.rb
+- lib/apocalypse-client/response.rb
 - lib/apocalypse-client/version.rb
 - spec/client_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: apocalypse-client
-rubygems_version: 1.5.0
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Watch out for the apocalypse