ducksboard_reporter 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7f00fc8b81a969ebe5929f8ad0c425ff83c5db0
-  data.tar.gz: ba5f182123e40a7631c60c7318c0c7c13cd8daba
+  metadata.gz: 2e9e37631f42cbb8f97861aba8f999a1d1f2e9ca
+  data.tar.gz: 23adcddf869c5325194a3d86822501437f6213ef
 SHA512:
-  metadata.gz: 02447f41db7fcb8fa6f366fd127c9787da9296c61e579575f4e6cdc99399aeb7d991b7e202969641abc24fffabb41359b3b8e6ddf9017745c481ab96bb003b81
-  data.tar.gz: 7ecd587c9dae113a7663af7e1319829174c9962e433a2e4010501b55e3d811dfe0a05c7c6187f3e6f4a4988d37936cf3a4d39d0422efd5d1d913bbc4a04b3d35
+  metadata.gz: 447a3fc6aa73461881fd04aeef2066b2cb060aae83eae61b2d46f2f5be2f8e8dfc43154ac926d9952ea16e085534d60bfc6695a8f832c28dfb314718ba2a8e92
+  data.tar.gz: 367a1f301afa96ed6484be68199dd76b52462ca7ba8a4c99683598d3dcd03888c29693b89ee215b25f063a098827323b493640963245d5c2f3ff3ad9a43413ce

data/bin/ducksboard-reporter

@@ -3,10 +3,11 @@ $:.unshift File.expand_path("../../lib", __FILE__)
 
 require "ducksboard_reporter"
 require "trollop"
+require "yaml"
 
 opts = Trollop::options do
-  opt :config_file, "Define config file", short: 'f', type: :string, required: true
+  opt :config_file, "Path to config file", short: "f", type: :string, required: true
 end
 
-DucksboardReporter.config_file = opts[:config_file]
-DucksboardReporter.start
+config = YAML.load_file(opts[:config_file])
+DucksboardReporter::App.new(config).start

data/ducksboard_reporter.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ducksboard_reporter/version'
+require "ducksboard_reporter/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ducksboard_reporter"
@@ -20,10 +20,13 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "byebug"
 
-  spec.add_runtime_dependency "ducksboard"
-  spec.add_runtime_dependency "hashie"
-  spec.add_runtime_dependency "celluloid"
-  spec.add_runtime_dependency "timers"
-  spec.add_runtime_dependency "trollop"
+  spec.add_runtime_dependency "ducksboard", "~> 0.1.6"
+  spec.add_runtime_dependency "hashie", ">= 3.3.1"
+  spec.add_runtime_dependency "celluloid", "~> 0.16"
+  spec.add_runtime_dependency "timers", ">= 1.1.0"
+  spec.add_runtime_dependency "trollop", ">= 1.16.2"
 end

data/example_config.yml

@@ -7,7 +7,8 @@ reporters:
 
   - name: haproxy_log_requests
     type: HaproxyLogRequests
-    logfile: /var/log/haproxy.log
+    options:
+      log_file: /var/log/haproxy.log
 
 widgets:
   - type: Box

data/lib/ducksboard_reporter/reporter.rb

@@ -3,15 +3,15 @@ module DucksboardReporter
     include Celluloid
     include Celluloid::Logger
 
-    attr_reader :options
-    attr_accessor :value
+    attr_accessor :value, :timestamp, :name, :options
 
-    def initialize(options = {})
+    def initialize(name, options = {})
+      @name = name
       @options = options
     end
 
     def start
-      debug log_format("Started")
+      debug(log_format("Started"))
       async.collect
     end
 
@@ -21,14 +21,10 @@ module DucksboardReporter
       @timestamp || Time.now.to_i
     end
 
-    def to_s
-      options.name
-    end
-
     private
 
     def log_format(msg)
-      @log_prefix ||= "Reporter #{self.class.name.split("::").last}(#{to_s}): "
+      @log_prefix ||= "Reporter #{self.class.name.split("::").last}(#{@name}): "
       @log_prefix + msg
     end
   end

data/lib/ducksboard_reporter/reporters/haproxy_log_requests.rb

@@ -9,9 +9,9 @@ module DucksboardReporter
         nosrvs = 0
 
         begin
-          file = File.open(options.logfile, "r")
+          file = File.open(options[:log_file], "r")
         rescue Errno::ENOENT
-          error("HaproxyLogRequests: Cannot open #{options.logfile}")
+          error("HaproxyLogRequests: Cannot open #{options[:log_file]}")
           return
         end
 

data/lib/ducksboard_reporter/version.rb

@@ -1,3 +1,3 @@
 module DucksboardReporter
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/ducksboard_reporter/widget.rb

@@ -3,35 +3,31 @@ module DucksboardReporter
     include Celluloid
     include Celluloid::Logger
 
-    attr_reader :id, :reporter, :options
+    attr_reader :id, :reporter, :options, :updater
 
     def initialize(klass, id, reporter, options = {})
       @klass = klass
       @id = id
       @reporter = reporter
       @options = options
-      @widget = instanciate_widget
+      @updater = instanciate_updater
     end
 
     def start
-      debug log_format("Started with reporter #{reporter}")
+      debug log_format("Started using reporter #{reporter.name}")
 
       every(interval) do
-        begin
-          update
-        rescue Net::OpenTimeout
-          # ignore unseccessful updates
-        end
+        update
       end
     end
 
     def update
       value = case value_method
       when Symbol
-        reporter.public_send(value_method)
+        @reporter.public_send(value_method)
       when Hash
         value_method.inject({}) do |memo, (k, v)|
-          memo[k] = (v.is_a?(Symbol) ? reporter.public_send(v) : v)
+          memo[k] = (v.is_a?(Symbol) ? @reporter.public_send(v) : v)
           memo
         end
       else
@@ -40,30 +36,30 @@ module DucksboardReporter
 
       debug log_format("Updating value #{value}")
 
-      @widget.update(value)
-    rescue Net::ReadTimeout
+      @updater.update(value)
+    rescue Net::ReadTimeout, Net::OpenTimeout
       # accept timeout errors
     end
 
     def interval
-      options.interval || 10
+      options[:interval] || 10
     end
 
     private
 
     def log_format(msg)
-      @log_prefix ||= "Widget #{self.class.name.split("::").last}(#{id}): "
+      @log_prefix ||= "Widget #{@klass}(#{id}): "
       @log_prefix + msg
     end
 
     def value_method
-      options.value || :value
+      options[:value] || :value
     end
 
-    def instanciate_widget
+    def instanciate_updater
       klass = Class.new(Ducksboard::Widget)
       klass.default_timeout(interval - 1)
-      klass.new(id)
+      klass.new(@id)
     end
   end
 end

data/lib/ducksboard_reporter.rb

@@ -1,77 +1,89 @@
 require "rubygems"
 
 require "logger"
-require "hashie"
 require "celluloid"
 require "timers"
 require "ducksboard"
+require "hashie/extensions/symbolize_keys"
+Hash.include Hashie::Extensions::SymbolizeKeys
 
 require "ducksboard_reporter/version"
 require "ducksboard_reporter/reporter"
-require "ducksboard_reporter/reporters"
 require "ducksboard_reporter/widget"
 
+require "ducksboard_reporter/reporters/random"
+require "ducksboard_reporter/reporters/haproxy_log_requests"
+require "ducksboard_reporter/reporters/cpu_usage"
+
 Thread.abort_on_exception = true
 
 module DucksboardReporter
   extend self
-  include Celluloid::Logger
-
-  def config
-    @config ||= Hashie::Mash.load(config_file)
-  end
 
-  def config_file
-    @config_file
-  end
-
-  def config_file=(file)
-    @config_file = file
-  end
+  include Celluloid::Logger
 
   def logger
     @logger ||= Celluloid.logger = Logger.new($stdout)
   end
 
-  def reporters
-    @reporters ||= {}
-  end
+  class App
 
-  def widgets
-    @widgets ||= []
-  end
+    attr_reader :config, :reporters, :widgets
 
-  def start
-    Signal.trap("INT") { exit }
+    def initialize(config)
+      @config = config.symbolize_keys!
+      register_reporters
+      register_widgets
+    end
 
-    Ducksboard.api_key = config.api_key
+    def start
+      Signal.trap("INT") { exit }
 
-    instanciate_reporters
-    instanciate_widgets
+      Ducksboard.api_key = config[:api_key]
 
-    sleep
-  end
+      start_reporters
+      start_widgets
 
-  def instanciate_reporters
-    DucksboardReporter.config.reporters.each do |config|
-      reporter = Reporters.const_get(config.type, false).new(config)
-      reporters[config.name] = reporter
-      reporter.start
+      sleep # let the actors continue their work
     end
-  end
 
-  def instanciate_widgets
-    DucksboardReporter.config.widgets.each do |config|
-      reporter = reporters[config.reporter]
+    def register_reporters
+      @reporters = {}
 
-      unless reporter
-        logger.error("Cannot find reporter #{config.reporter}")
-        exit
+      @config[:reporters].each do |config|
+        reporter = Reporters.const_get(config[:type], false).new(config[:name], config[:options])
+        @reporters[reporter.name] = reporter
       end
+    end
+
+    def register_widgets
+      @widgets = []
+
+      @config[:widgets].each do |config|
+        reporter = @reporters.fetch(config[:reporter])
+
+        unless reporter
+          logger.error("Cannot find reporter #{config[:reporter]}")
+          exit
+        end
+
+        widget = Widget.new(config[:type], config[:id], reporter, config)
+        @widgets << widget
+      end
+    end
+
+    def start_reporters
+      @reporters.each {|_, reporter| reporter.start }
+    end
+
+    def start_widgets
+      @widgets.each(&:start)
+    end
+
+    private
 
-      widget = Widget.new(config.type, config.id, reporter, config)
-      widget.start
-      widgets << widget
+    def logger
+      DucksboardReporter.logger
     end
   end
 end

data/spec/ducksboard_reporter_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+class DucksboardReporter::Reporters::FooBar < DucksboardReporter::Reporter
+  attr_accessor :log_file
+end
+
+describe DucksboardReporter::App do
+  let(:config) { YAML.load_file(File.expand_path("../config.yml", __FILE__)) }
+  let(:app) { DucksboardReporter::App.new(config) }
+  let(:reporter) { app.reporters["foo_bar"] }
+  let(:widget) { app.widgets.first }
+
+  it "registers reporters from config" do
+    expect(app.reporters.values.map(&:class)).to include(DucksboardReporter::Reporters::Random)
+  end
+
+  it "registers widgets from config" do
+    expect(app.widgets.map(&:class)).to include(DucksboardReporter::Widget)
+  end
+
+  describe "single reporter" do
+
+    it "sets name from config" do
+      expect(reporter.name).to eq("foo_bar")
+    end
+
+    it "applies options to reporters" do
+      expect(reporter.options[:log_file]).to eq("/var/log/haproxy.log")
+    end
+  end
+
+  describe "single widget" do
+
+    it "sets id from config" do
+      expect(widget.id).to eq(1234)
+    end
+
+    it "references reporter" do
+      expect(widget.reporter).to eq(reporter)
+    end
+  end
+end
+

data/spec/reporter_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+
+class FooReporter < DucksboardReporter::Reporter
+  attr_accessor :log_file, :condition
+
+  def initialize(*args)
+    @condition = Celluloid::Condition.new
+    super
+  end
+
+  def collect
+    sleep 0.001
+    @condition.signal("called")
+  end
+
+  def collect_called
+    @condition.wait
+    true
+  end
+end
+
+describe DucksboardReporter::Reporter do
+
+  let(:reporter) { FooReporter.new("foo") }
+
+  describe "#collect" do
+    it "will be called on start" do
+      reporter.start
+      expect(reporter.collect_called).to be(true)
+    end
+  end
+
+  describe "#timestamp" do
+    it "returns current time" do
+      expect(reporter.timestamp).to be_within(1).of(Time.now.to_i)
+    end
+
+    it "returns set timestamp" do
+      time = Time.now.to_i + 10
+      reporter.timestamp = time
+      expect(reporter.timestamp).to eq(time)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "ducksboard_reporter"
+require "byebug"
+
+DucksboardReporter.logger.level = Logger::FATAL
+
+RSpec.configure do |config|
+end

data/spec/widget_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+class WidgetReporter < DucksboardReporter::Reporter
+  def value
+    23
+  end
+
+  def other_value
+    99
+  end
+end
+
+describe DucksboardReporter::Widget do
+
+  let(:reporter) { WidgetReporter.new("name") }
+  let(:widget) { DucksboardReporter::Widget.new("Box", 1234, reporter) }
+
+  describe "#update" do
+    it "updates value from reporter" do
+      expect(widget.updater).to receive(:update).with(23)
+      widget.update
+    end
+
+    it "will not crash on Net::ReadTimeout" do
+      expect(widget.updater).to receive(:update).and_raise(Net::ReadTimeout)
+      widget.update
+    end
+
+    it "will not crash on Net::OpenTimeout" do
+      expect(widget.updater).to receive(:update).and_raise(Net::OpenTimeout)
+      widget.update
+    end
+
+    it "uses static values for update" do
+      widget = DucksboardReporter::Widget.new("Box", 1234, reporter, value: "hello")
+      expect(widget.updater).to receive(:update).with("hello")
+      widget.update
+    end
+
+    it "uses Symbols for method reference" do
+      widget = DucksboardReporter::Widget.new("Box", 1234, reporter, value: :other_value)
+      expect(widget.updater).to receive(:update).with(99)
+      widget.update
+    end
+
+    it "uses a Hash for contructing complex values " do
+      widget = DucksboardReporter::Widget.new("Box", 1234, reporter, value: {current: :value, foo: "bar"})
+      expect(widget.updater).to receive(:update).with(current: 23, foo: "bar")
+      widget.update
+    end
+  end
+
+  describe "#interval" do
+    it "retuns default value" do
+      expect(widget.interval).to eq(10)
+    end
+
+    it "returns interval option" do
+      widget = DucksboardReporter::Widget.new("Box", 1234, reporter, interval: 20)
+      expect(widget.interval).to eq(20)
+    end
+  end
+
+  describe "#start" do
+    it "calls update every interval" do
+      widget = DucksboardReporter::Widget.new("Box", 1234, reporter, interval: 0.001)
+      expect(widget.updater).to receive(:update).at_least(:once)
+      widget.start
+      sleep 0.002
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducksboard_reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - unnu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ducksboard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,47 +67,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: celluloid
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ducksboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.16.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.16.2
 description: Report values to ducksboard
 email:
 - norman.timmler@gmail.com
@@ -126,13 +168,16 @@ files:
 - example_config.yml
 - lib/ducksboard_reporter.rb
 - lib/ducksboard_reporter/reporter.rb
-- lib/ducksboard_reporter/reporters.rb
 - lib/ducksboard_reporter/reporters/bandwidth.rb
 - lib/ducksboard_reporter/reporters/cpu_usage.rb
 - lib/ducksboard_reporter/reporters/haproxy_log_requests.rb
 - lib/ducksboard_reporter/reporters/random.rb
 - lib/ducksboard_reporter/version.rb
 - lib/ducksboard_reporter/widget.rb
+- spec/ducksboard_reporter_spec.rb
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
+- spec/widget_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -157,4 +202,8 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Report values to ducksboard
-test_files: []
+test_files:
+- spec/ducksboard_reporter_spec.rb
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
+- spec/widget_spec.rb

data/lib/ducksboard_reporter/reporters.rb

@@ -1,6 +0,0 @@
-module DucksboardReporter
-  module Reporters
-  end
-end
-
-Dir[File.dirname(__FILE__) + '/reporters/*.rb'].each {|file| require file }