dboard 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+todo.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-preview1@dboard --create

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', :version => 2, :all_on_start => false, :all_after_pass => true, :bundler => false, :keep_failed => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+end

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Joakim Kolsjö
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+end
+
+task :default => :spec

data/dboard.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "dboard"
+  s.version     = Dboard::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joakim Kolsjö"]
+  s.email       = ["joakim.kolsjo@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Dashboard framework}
+  s.description = %q{Dashboard framework}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "httparty", "~> 0.7.8"
+  s.add_dependency "rake", "~> 0.9.2"
+  s.add_dependency "json", "~> 1.4.6"
+  s.add_dependency "dalli", "~> 1.0.5"
+  s.add_dependency "sinatra", "~> 1.2"
+  s.add_development_dependency "rspec", "2.6.0"
+  s.add_development_dependency "guard", "0.5.1"
+  s.add_development_dependency "guard-rspec", "0.4.3"
+  s.add_development_dependency "guard-bundler", "0.1.3"
+  s.add_development_dependency "rb-fsevent", "0.4.1"
+end

data/lib/api.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'cache'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'collector.rb'))
+require 'digest/md5'
+require 'json'
+require 'httparty'
+
+module Dboard
+  class Api
+    MAX_CACHE_TIME = 3600 # seconds
+    @@version = nil
+
+    class Client
+      include HTTParty
+    end
+
+    def self.get(params)
+      types = {}
+      params[:types].split(',').each do |type|
+        raw_data = CACHE.get("dashboard::source::#{type}")
+        data = raw_data ? JSON.parse(raw_data) : {}
+        types.merge!(type => { :data => data, :checksum => Digest::MD5.hexdigest(data.inspect) })
+      end
+      { :version => (@@version || ENV["COMMIT_HASH"] || "unversioned"), :sources => types }.to_json
+    end
+
+    def self.version=(version)
+      @@version = version
+    end
+
+    def self.update(params)
+      CACHE.set "dashboard::source::#{params[:type]}", params[:data], MAX_CACHE_TIME
+    end
+  end
+end

data/lib/cache.rb

@@ -0,0 +1,10 @@
+require 'dalli'
+
+module Dboard
+  if Config.config[:memcache]
+    CACHE = Dalli::Client.new(Config.config[:memcache])
+  else
+    CACHE = Dalli::Client.new("127.0.0.1:11211")
+  end
+end
+

data/lib/collector.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'publisher'))
+require 'singleton'
+
+module Dboard
+  class Collector
+    include Singleton
+
+    attr_reader :sources
+
+    def self.register_source(key, instance)
+      Collector.instance.register_source(key, instance)
+    end
+
+    def self.start
+      instance.start
+    end
+
+    def initialize
+      @sources = {}
+    end
+
+    def start
+      @sources.each do |source, instance|
+        Thread.new do
+          loop do
+            time = Time.now
+            puts "#{source} updating..."
+            update_source(source, instance)
+            elapsed_time = Time.now - time
+            time_until_next_update = instance.update_interval - elapsed_time
+            time_until_next_update = 0 if time_until_next_update < 0
+            puts "#{source} done in #{elapsed_time} seconds, will update again in #{time_until_next_update} seconds (interval: #{instance.update_interval})."
+            sleep time_until_next_update
+          end
+        end
+      end
+      loop { sleep 1 }
+    end
+
+    def update_source(source, instance)
+      data = instance.fetch
+      publish_data(source, data)
+    rescue Exception => ex
+      puts "Failed to update #{source}: #{ex.message}"
+      puts ex.backtrace
+    end
+
+    def register_source(key, instance)
+      @sources.merge!({ key => instance })
+    end
+
+    def publish_data(source, data)
+      Publisher.publish(source, data)
+    end
+  end
+end

data/lib/config.rb

@@ -0,0 +1,24 @@
+module Dboard
+  class Config
+    @@config ||= {}
+
+    def self.basic_auth(opts = {})
+      @@config[:basic_auth] = opts
+      Dboard::Api::Client.basic_auth(opts[:user], opts[:password])
+    end
+
+    def self.memcache(opts = {})
+      @@config[:memcache] = opts
+    end
+
+    def self.api(opts = {})
+      @@config[:api] = opts
+      Dboard::Api::Client.base_uri opts[:uri]
+    end
+
+    def self.config
+      @@config
+    end
+  end
+end
+

data/lib/dboard.rb

@@ -0,0 +1,3 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'config.rb'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'api.rb'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'collector.rb'))

data/lib/publisher.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module Dboard
+  class Publisher
+    def self.publish(source, data)
+      Api::Client.post("/sources/#{source}", :body => { :data => data.to_json })
+    rescue SocketError => ex
+      puts "SocketError: #{ex.message}"
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Dboard
+  VERSION = "0.0.1"
+end

data/spec/collector_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe Dboard::Collector, "register_source" do
+
+  before do
+    Dboard::Collector.instance.sources.clear
+  end
+
+  it "can register a source" do
+    new_relic = mock
+    new_relic.stub!(:update_interval).and_return(5)
+    Dboard::Collector.instance.register_source :new_relic, new_relic
+    Dboard::Collector.instance.sources.should == { :new_relic => new_relic }
+  end
+
+end
+
+describe Dboard::Collector, "update_source" do
+  before do
+    Dboard::Collector.instance.sources.clear
+  end
+
+  it "should collect and publish data from sources" do
+    new_relic = mock
+    new_relic.stub!(:fetch).and_return({ :db => "100%" })
+    Dboard::Publisher.should_receive(:publish).with(:new_relic, { :db => "100%" })
+    Dboard::Collector.instance.update_source(:new_relic, new_relic)
+  end
+
+  it "should print out debugging info" do
+    new_relic = mock
+    new_relic.stub!(:fetch).and_raise(Exception.new("some error"))
+    Dboard::Collector.instance.should_receive(:puts).twice
+    Dboard::Collector.instance.update_source(:new_relic, new_relic)
+  end
+
+end

data/spec/integration_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+# Test app
+require 'sinatra'
+
+get "/sources" do
+  Dboard::Api.get(params)
+end
+
+post "/sources/:type" do
+  Dboard::Api.update(params)
+end
+
+describe "Dashboard" do
+
+  def app
+    Sinatra::Application
+  end  
+
+  def start_app
+    app.port = 20843
+    app.environment = 'test'
+    @app_thread = Thread.new { app.run! }
+    sleep 1
+  end
+
+  def stop_app
+    @app_thread && @app_thread.kill
+  end
+
+  before do
+    ENV['API_URL'] = "http://localhost:20843"
+    ENV['API_USER'] = 'test'
+    ENV['API_PASSWORD'] = 'test'
+    @new_relic = mock
+    @new_relic.stub!(:fetch).and_return({ :db => "33.3%", :memory => "33333 MB" })
+    Dboard::CACHE.delete "dashboard::source::new_relic"
+  end
+  
+  it "should collect stats and post them to the server" do
+    start_app
+    body = Dboard::Api::Client.get("/sources?types=new_relic")
+    JSON.parse(body)["sources"]["new_relic"]["data"].should == {}
+    Dboard::Collector.instance.update_source(:new_relic, @new_relic)
+    body = Dboard::Api::Client.get("/sources?types=new_relic")
+    JSON.parse(body)["sources"]["new_relic"]["data"].should == { "db" => "33.3%", "memory" => "33333 MB" }
+  end
+
+  after do
+    stop_app
+  end
+
+end
+

data/spec/publisher_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe "Publisher", "publish" do
+  
+  it "should send data to the dashboard server" do
+    Dboard::Api::Client.should_receive(:post).with("/sources/new_relic", :body => { :data => { :db => "80%" }.to_json })
+    Dboard::Publisher.publish(:new_relic, { :db => "80%" })
+  end
+
+  it "should handle and log socket errors" do
+    Dboard::Api::Client.should_receive(:post).and_raise(SocketError.new("failed to connect"))
+    Dboard::Publisher.should_receive(:puts).with("SocketError: failed to connect")
+    Dboard::Publisher.publish(:new_relic, {})
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "rspec"
+
+ENV["RACK_ENV"] ||= 'test'
+ENV['API_URL'] = "http://localhost:20843"
+ENV['API_USER'] = 'test'
+ENV['API_PASSWORD'] = 'test'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/dboard'))
+
+Dboard::Api::Client.basic_auth(ENV['API_USER'], ENV['API_PASSWORD']) 
+Dboard::Api::Client.base_uri(ENV['API_URL'])

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: dboard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joakim Kolsjö
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2156106140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156106140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156105640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156105640
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2156105180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156105180
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: &2156104700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156104700
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &2156104160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156104160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156103640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156103640
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2156103160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *2156103160
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2156102620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: *2156102620
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &2156102100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *2156102100
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &2156101580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: *2156101580
+description: Dashboard framework
+email:
+- joakim.kolsjo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENCE
+- README
+- Rakefile
+- dboard.gemspec
+- lib/api.rb
+- lib/cache.rb
+- lib/collector.rb
+- lib/config.rb
+- lib/dboard.rb
+- lib/publisher.rb
+- lib/version.rb
+- spec/collector_spec.rb
+- spec/integration_spec.rb
+- spec/publisher_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Dashboard framework
+test_files: []