e-meter-gom-daemon 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 art+com AG/dirk luesebrink
+
+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.markdown

@@ -0,0 +1,26 @@
+# e-meter-gom-daemon
+
+see: https://t-gallery.artcom.de/trac/wiki/e-meter-in-production?version=1
+
+## Install
+    
+As this gem uses jeweler you can make use of the rake gem tasks to install:
+
+    $ rake gemspec build install
+
+## Dependencies 
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 art+com/dirk luesebrink. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "e-meter-gom-daemon"
+    gem.summary = %Q{e-meter GOM sensor daemon}
+    gem.description = %Q{ 
+      Periodically polling the t-gallery e-meter and updating its GOM sensor
+      node accordingly.
+    }.gsub /\n\n/, ''
+    gem.email = "dirk@sebrink.de"
+    gem.homepage = "http://github.com/crux/e-meter-gom-daemon"
+    gem.authors = ["art+com/dirk luesebrink"]
+    gem.add_development_dependency "rspec gom-script applix"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "e-meter-gom-daemon #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/e-meter-gom-daemon

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'applix'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'e-meter-gom-daemon'
+
+#Thread.abort_on_exception = true
+$stderr.sync = true
+$stdout.sync = true
+
+def main argv
+  options = Hash.from_argv argv
+  args = (options.delete :args)
+  options[:callback_port] ||= 32119
+
+  sensor_url = args.shift
+  sensor_url or (raise Usage, "no <sensor_url>")
+  puts " -- starting e-meter GOM daemon: #{Time.now}"
+
+  #daemon = EmeterGomDaemon::Daemon.new sensor_url, options
+  #daemon.run
+  
+  Gom::Remote::Daemon.new(sensor_url, options) do |daemon, path|
+    sensor = EmeterGomDaemon::Node.new path, options
+    daemon.sensor_loop(sensor.interval) { |daemon| (sensor.tic daemon) }
+  end
+
+rescue => e
+  puts " ## #{e}\n -> #{e.backtrace.join "\n    "}"
+end
+
+main ARGV
+# vim: syntax=ruby

data/etc/e-meter-gom-daemon-debian-init-script

@@ -0,0 +1,97 @@
+#!/bin/sh
+### BEGIN INIT INFO
+# Provides:          e-meter-gom-daemon
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# X-Start-Before:    kdm gdm xdm
+# X-Stop-After:      kdm gdm xdm
+# Default-Start:     2 3 4 5
+# Default-Stop:      1
+# Short-Description: Start the e-meter daemon
+# Description:       e-meter values are polled and updated in the GOM
+### END INIT INFO
+
+set -e
+
+NAME=e-meter-gom-daemon
+DESC="t-gallery e-meter daemon"
+EMETER_NODE="http://gom.bonn.t-gallery/sensors/e-meter/home"
+LOGFILE="/var/log/e-meter-gom-daemon.log"
+DAEMON_USER="webs"
+DAEMON=$(which e-meter-gom-daemon)
+VERBOSITY="--verbose"
+
+PIDDIR=/var/run/e-meter-gom-daemon
+PIDFILE=$PIDDIR/pid
+#VERBOSITY="--quiet"
+PARAMS="--logfile=${LOGFILE} ${EMETER_NODE}"
+
+test -x $DAEMON || exit 0
+
+# Get lsb functions
+. /lib/lsb/init-functions
+. /etc/default/rcS
+
+start_it_up()
+{
+  if [ ! -d $PIDDIR ]; then
+    mkdir -p $PIDDIR
+    chown $DAEMON_USER $PIDDIR
+    #chgrp $DAEMON_USER $PIDDIR
+  fi
+
+  touch $LOGFILE
+  chown $DAEMON_USER $LOGFILE
+
+  if [ -e $PIDFILE ]; then
+    PIDDIR=/proc/$(cat $PIDFILE)
+    if [ -d ${PIDDIR} -a  "$(readlink -f ${PIDDIR}/exe)" = "${DAEMON}" ]; then 
+      log_success_msg "$DESC already started; not starting."
+      return
+    else
+      log_success_msg "Removing stale PID file $PIDFILE."
+      rm -f $PIDFILE
+    fi
+  fi
+
+  log_daemon_msg "Starting $DESC" "$NAME"
+  /sbin/start-stop-daemon --start --background $VERBOSITY \
+    --make-pidfile --pidfile $PIDFILE \
+    -c $DAEMON_USER --exec $DAEMON -- $PARAMS
+
+  log_end_msg $?
+}
+
+
+shut_it_down()
+{
+  log_daemon_msg "Stopping $DESC" "$NAME"
+  /sbin/start-stop-daemon $VERBOSITY --stop --retry 5 --oknodo \
+    --pidfile $PIDFILE --user $DAEMON_USER
+  # We no longer include these arguments so that start-stop-daemon
+  # can do its job even given that we may have been upgraded.
+  # We rely on the pidfile being sanely managed
+  # --exec $DAEMON -- --system $EMETER_NODE
+  log_end_msg $?
+  rm -f $PIDFILE
+}
+
+case "$1" in
+  start)
+    start_it_up
+    ;;
+  stop)
+    shut_it_down
+    ;;
+  restart)
+    shut_it_down
+    start_it_up
+  ;;
+  status)
+    status_of_proc -p $PIDFILE $DAEMON $NAME && exit 0 || exit $?
+    ;;
+  *)
+    log_success_msg "Usage: /etc/init.d/${NAME} {start|stop|restart|status}"
+    exit 2
+esac
+

data/lib/e-meter-gom-daemon/daemon.rb

@@ -0,0 +1,164 @@
+module EmeterGomDaemon
+  class Daemon
+
+    Defaults = {
+      :logfile => '-',
+      :interval => 5,
+      :threshold => 5, # in percent
+      :nagios_port => 9918,
+      :stealth => false,
+    }
+
+    # option precedence is: 
+    #   1. commands line options
+    #   2. GOM Sensor node values
+    #   3. built-in Default values (see #Defaults)
+    #
+    def initialize sensor_url, options = {}
+      @sensor_url = sensor_url
+      @gom, @sensor_path = (Gom::Remote::Connection.init @sensor_url)
+
+      @options = Defaults.merge(gnode(@sensor_path)).merge(options)
+      puts "options: #{@options.inspect}"
+
+      redirect_to logfile
+    end
+
+    def logfile
+      @logfile ||= @options[:logfile]
+    end
+
+    def interval 
+      @interval ||= Integer(@options[:interval])
+    end
+
+    def emeter_ip
+      @emeter_ip ||= @options[:emeter_ip]
+    end
+
+    def nagios_port
+      @nagios_port ||= @options[:nagios_port]
+    end
+
+    def threshold
+      @threshold ||= Float(@options[:threshold])
+    end
+
+    def stealth?
+      @stealth ||= @options[:stealth]
+    end
+
+    def run
+      run_nagios_thread # become visible to nagios
+      gom_checkin
+      loop do
+        begin
+          tic
+        rescue Exception => e
+          callstack = "#{e.backtrace.join "\n    "}"
+          puts " ## #{self} - #{e}\n -> #{callstack}"
+        ensure
+          sleep interval
+        end
+      end
+    ensure
+      stop_nagios_thread
+    end
+
+    private
+
+    def tic 
+      old = @current_value || 0
+      readout = poll
+      _, _, _, @current_value = readout
+      change_in_percent = 100 * (1 - (@current_value / old)).abs
+      if threshold < change_in_percent
+        t = Time.now
+        puts "#{t} :: #{readout.inspect}"
+        puts "#{t} :: #{@current_value}"
+        @gom.write "#{@sensor_path}:current_value", @current_value
+      end
+    end
+
+    def poll
+      # expected: '172.20.10.24;WEBIO-042BFF;Sensor 1 0..50A;0,150 A'
+      line = (open "http://#{emeter_ip}/Single1").read
+      ip, id, name, val = (line.split /;/)
+      [ip, id, name, (val.sub! /,/, '.').to_f]
+    end
+
+    private
+
+    def redirect_to logfile
+      (@logfile_fd && @logfile_fd.close) rescue nil
+      puts " -- redirecting stdout/stderr to: #{logfile}"
+      if logfile == '-'
+        if @stdout
+          $stderr, $stdout = @stdout, @stderr
+        end
+      else
+        @stderr, @stdout = $stdout, $stderr
+        @logfile_fd = File.open(logfile, File::WRONLY|File::APPEND|File::CREAT)
+        @logfile_fd.sync = true
+        $stderr = $stdout = @logfile_fd
+      end
+      # first line after redirect
+      puts " -- e-meter daemon logile redirect at #{Time.now}"
+    end
+
+    # push own ip and monitoring port back to GOM node
+    def gom_checkin
+      if stealth?
+        puts "skipping gom check-in in stealth mode"
+      else
+        @gom.write "#{@sensor_path}:daemon_ip", @gom.callback_ip
+        @gom.write "#{@sensor_path}:nagios_port", nagios_port
+      end
+    end
+
+    def stop_nagios_thread
+      @nagios_thread or return 
+      puts ' -- killing nagios thread...'
+      @nagios_thread.kill
+      @nagios_thread = nil
+      puts '    and gone.'
+      self
+    end
+
+    def run_nagios_thread
+      @nagios_thread .nil? or (raise "already running!")
+      port = nagios_port
+      @nagios_thread = Thread.new do
+        infinity = Proc.new do |env| 
+          [200, {"Content-Type" => "text/plain"}, env.inspect]
+        end
+        puts " -- running nagios server on port: #{port}"
+        Rack::Handler::Mongrel.run infinity, :Port => port
+      end
+      self
+    end
+
+    # 
+    # TODO: The GOM helper stuff is experimental and being tested here. Once
+    # it's prove i'll move it into the gom-script gem
+    #
+
+    #def gattr name
+    #  (Gom::Remote.connection.read "#{@sensor_path}:#{name}.txt")
+    #rescue NameError
+    #  nil
+    #end
+
+    def gnode path
+      json = (Gom::Remote.connection.read "#{path}.json")
+      (JSON.parse json)["node"]["entries"].select do |entry|
+        # 1. select attribute entries
+        entry.has_key? "attribute"
+      end.inject({}) do |h, a|
+        # 2. make it a key, value list
+        kv = a["attribute"]
+        h.update(kv["name"].to_sym => kv["value"])
+      end
+    end
+  end
+end

data/lib/e-meter-gom-daemon/node.rb

@@ -0,0 +1,173 @@
+module EmeterGomDaemon
+  class Node < Gom::Remote::Entry
+
+    Defaults = {
+      :logfile => '-',
+      :interval => 5,
+      :threshold => 5, # in percent
+      :nagios_port => 9918,
+      :stealth => false,
+      :base_value => 0,
+      :scale_factor => 1.0,
+    }
+
+    # option precedence is: 
+    #   1. commands line options
+    #   2. GOM Sensor node values
+    #   3. built-in Default values (see #Defaults)
+    #
+    def initialize path, options = {}
+      @path = path
+      @options = Defaults.merge(gnode @path).merge(options)
+      puts "options: #{@options.inspect}"
+
+      redirect_to logfile
+    end
+
+    def logfile
+      @logfile ||= @options[:logfile]
+    end
+
+    def interval 
+      @interval ||= Integer(@options[:interval])
+    end
+
+    def scale_factor 
+      @scale_factor ||= Float(@options[:scale_factor])
+    end
+
+    def base_value 
+      @base_value ||= Float(@options[:base_value])
+    end
+
+    def emeter_ip
+      @emeter_ip ||= @options[:emeter_ip]
+    end
+
+    def nagios_port
+      @nagios_port ||= @options[:nagios_port]
+    end
+
+    def threshold
+      @threshold ||= Float(@options[:threshold])
+    end
+
+    def stealth?
+      @stealth ||= @options[:stealth]
+    end
+
+    #def run
+    #  run_nagios_thread # become visible to nagios
+    #  gom_checkin
+    #  loop do
+    #    begin
+    #      tic
+    #    rescue Exception => e
+    #      callstack = "#{e.backtrace.join "\n    "}"
+    #      puts " ## #{self} - #{e}\n -> #{callstack}"
+    #    ensure
+    #      sleep interval
+    #    end
+    #  end
+    #ensure
+    #  stop_nagios_thread
+    #end
+
+    def tic *args
+      old = @current_value || 0
+      readout = poll
+      #puts "#{t} :: #{readout.inspect}"
+      _, _, _, @current_value = readout
+      change_in_percent = 100 * (1 - (@current_value / old)).abs
+      return if change_in_percent < threshold 
+
+      t = Time.now
+      val = scale_factor * @current_value + base_value
+      puts "#{t} :: #{@current_value} -> #{val}"
+      connection.write "#{@path}:current_value", val
+    end
+
+    private
+
+    def poll
+      # expected: '172.20.10.24;WEBIO-042BFF;Sensor 1 0..50A;0,150 A'
+      line = (open "http://#{emeter_ip}/Single1").read
+      ip, id, name, val = (line.split /;/)
+      [ip, id, name, (val.sub! /,/, '.').to_f]
+    end
+
+    private
+
+    def redirect_to logfile
+      (@logfile_fd && @logfile_fd.close) rescue nil
+      puts " -- redirecting stdout/stderr to: #{logfile}"
+      if logfile == '-'
+        if @stdout
+          $stderr, $stdout = @stdout, @stderr
+        end
+      else
+        @stderr, @stdout = $stdout, $stderr
+        @logfile_fd = File.open(logfile, File::WRONLY|File::APPEND|File::CREAT)
+        @logfile_fd.sync = true
+        $stderr = $stdout = @logfile_fd
+      end
+      # first line after redirect
+      puts " -- e-meter daemon logile redirect at #{Time.now}"
+    end
+
+    # push own ip and monitoring port back to GOM node
+    def gom_checkin
+      if stealth?
+        puts "skipping gom check-in in stealth mode"
+      else
+        @gom.write "#{@sensor_path}:daemon_ip", @gom.callback_ip
+        @gom.write "#{@sensor_path}:nagios_port", nagios_port
+      end
+    end
+
+    def stop_nagios_thread
+      @nagios_thread or return 
+      puts ' -- killing nagios thread...'
+      @nagios_thread.kill
+      @nagios_thread = nil
+      puts '    and gone.'
+      self
+    end
+
+    def run_nagios_thread
+      @nagios_thread .nil? or (raise "already running!")
+      port = nagios_port
+      @nagios_thread = Thread.new do
+        infinity = Proc.new do |env| 
+          [200, {"Content-Type" => "text/plain"}, env.inspect]
+        end
+        puts " -- running nagios server on port: #{port}"
+        Rack::Handler::Mongrel.run infinity, :Port => port
+      end
+      self
+    end
+
+    # 
+    # TODO: The GOM helper stuff is experimental and being tested here. Once
+    # it's prove i'll move it into the gom-script gem
+    #
+
+    #def gattr name
+    #  (Gom::Remote.connection.read "#{@sensor_path}:#{name}.txt")
+    #rescue NameError
+    #  nil
+    #end
+
+    #def gnode path
+    #  json = (Gom::Remote.connection.read "#{path}.json")
+    #  (JSON.parse json)["node"]["entries"].select do |entry|
+    #    # 1. select attribute entries
+    #    entry.has_key? "attribute"
+    #  end.inject({}) do |h, a|
+    #    # 2. make it a key, value list
+    #    kv = a["attribute"]
+    #    h.update(kv["name"].to_sym => kv["value"])
+    #  end
+    #end
+  end
+end

data/lib/e-meter-gom-daemon.rb

@@ -0,0 +1,2 @@
+require 'gom/remote'
+require 'e-meter-gom-daemon/node'

data/spec/e-meter-gom-daemon_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "EMeterGomDaemon" do
+  it "at least finds the e-meter module" do
+    EmeterGomDaemon.should_not == nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# figure out where we are being loaded from
+if $LOADED_FEATURES.grep(/spec\/spec_helper\.rb/).any?
+  begin
+    raise "foo"
+  rescue => e
+    puts <<-MSG
+  ===================================================
+  It looks like spec_helper.rb has been loaded
+  multiple times. Normalize the require to:
+
+    require "spec/spec_helper"
+
+  Things like File.join and File.expand_path will
+  cause it to be loaded multiple times.
+
+  Loaded this time from:
+
+    #{e.backtrace.join("\n    ")}
+  ===================================================
+    MSG
+  end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+#$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w{.. .. gom-remote lib})
+require 'rubygems'
+require 'e-meter-gom-daemon'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: e-meter-gom-daemon
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- art+com/dirk luesebrink
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 +01:00
+default_executable: e-meter-gom-daemon
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec gom-script applix
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: " \n      Periodically polling the t-gallery e-meter and updating its GOM sensor\n      node accordingly.\n    "
+email: dirk@sebrink.de
+executables: 
+- e-meter-gom-daemon
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/e-meter-gom-daemon
+- etc/e-meter-gom-daemon-debian-init-script
+- lib/e-meter-gom-daemon.rb
+- lib/e-meter-gom-daemon/daemon.rb
+- lib/e-meter-gom-daemon/node.rb
+- spec/e-meter-gom-daemon_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/crux/e-meter-gom-daemon
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: e-meter GOM sensor daemon
+test_files: 
+- spec/e-meter-gom-daemon_spec.rb
+- spec/spec_helper.rb