dboard 1.0.3 → 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60c9af8ba57dc09e45ec0f39a2e8394705c4cfadd771f52210578438f4f64219
+  data.tar.gz: d1422616d6c609c49cd32c1a88481ae929391d5d3d937cc81b5abb1e37457a90
+SHA512:
+  metadata.gz: '091c5bebede637161ece4d905ec07acb12d018c2d7dde186bb427639edbebe43211393ea6279b9ec212f02cdaff847b9812d21e6f1e1bc98dd9dbf117d0ee33a'
+  data.tar.gz: dcc00cb4d504f0911b19f68c98af3db66e76a4cef444a8efcbb0e1a8daaa2a281da11f12eb3ae132bee5c7b06c09e0e228c17b2ad1ad2af005e47d379d71c5b0

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 todo.txt
+/tmp

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+inherit_gem:
+  barsoom_utils: shared_rubocop.yml

data/Gemfile

@@ -1,2 +1,7 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 gemspec
+
+group :development, :test do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "rubocop"
+end

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby CI](https://github.com/barsoom/dboard/actions/workflows/ci.yml/badge.svg)](https://github.com/barsoom/dboard/actions/workflows/ci.yml)
+
 A dashboard framework.
 
 It handles collecting data from user defined sources (simple ruby classes) and provides a simple API to poll for updates. See the [example app](https://github.com/joakimk/dboard_example) for information on how to use it.

data/Rakefile

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

data/dboard.gemspec

@@ -6,22 +6,21 @@ 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.authors     = [ "Joakim Kolsjö" ]
+  s.email       = [ "joakim.kolsjo@gmail.com" ]
   s.homepage    = ""
   s.summary     = %q{Dashboard framework}
   s.description = %q{Dashboard framework}
   s.license     = "MIT"
+  s.metadata    = { "rubygems_mfa_required" => "true" }
 
   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.require_paths = [ "lib" ]
 
   s.add_dependency "httparty"
   s.add_dependency "rake"
   s.add_dependency "json"
   s.add_dependency "dalli"
   s.add_dependency "sinatra"
-  s.add_development_dependency "rspec", "2.6.0"
+  s.add_development_dependency "rspec", "~> 3.9"
 end

data/lib/api.rb

@@ -1,8 +1,8 @@
-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'
+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
@@ -15,12 +15,12 @@ module Dboard
 
     def self.get(params)
       types = {}
-      params[:types].split(',').each do |type|
+      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) })
+        types.merge!(type => { data: data, checksum: Digest::MD5.hexdigest(data.inspect) })
       end
-      { :version => (@@version || ENV["COMMIT_HASH"] || "unversioned"), :sources => types }.to_json
+      { version: (@@version || ENV["COMMIT_HASH"] || "unversioned"), sources: types }.to_json
     end
 
     def self.version=(version)

data/lib/cache.rb

@@ -1,4 +1,4 @@
-require 'dalli'
+require "dalli"
 
 module Dboard
   if Config.config[:memcache]

data/lib/collector.rb

@@ -1,5 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'publisher'))
-require 'singleton'
+require File.expand_path(File.join(File.dirname(__FILE__), "publisher"))
+require "singleton"
 
 module Dboard
   class Collector
@@ -15,6 +15,10 @@ module Dboard
       Collector.instance.register_after_update_callback(callback)
     end
 
+    def self.register_error_callback(callback)
+      Collector.instance.register_error_callback(callback)
+    end
+
     def self.start
       instance.start
     end
@@ -22,11 +26,14 @@ module Dboard
     def initialize
       @sources = {}
       @after_update_callback = lambda {}
+      @error_callback = lambda { |exception| }
     end
 
     def start
       @sources.each do |source, instance|
         Thread.new do
+          wait_a_little_bit_to_not_start_all_fetches_at_once
+
           loop do
             update_in_thread(source, instance)
           end
@@ -35,20 +42,19 @@ module Dboard
       loop { sleep 1 }
     end
 
-    def update_in_thread(source, instance)
-      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
-    rescue Exception => ex
-      puts "Something failed outside the update_source method. #{ex.message}"
-      puts ex.backtrace
+    def register_source(key, instance)
+      @sources.merge!({ key => instance })
+    end
+
+    def register_after_update_callback(callback)
+      @after_update_callback = callback
     end
 
+    def register_error_callback(callback)
+      @error_callback = callback
+    end
+
+    # Public because the old tests depend on it
     def update_source(source, instance)
       begin
         data = instance.fetch
@@ -59,18 +65,31 @@ module Dboard
     rescue Exception => ex
       puts "Failed to update #{source}: #{ex.message}"
       puts ex.backtrace
+      @error_callback.call(ex)
     end
 
-    def register_source(key, instance)
-      @sources.merge!({ key => instance })
-    end
+    private
 
-    def register_after_update_callback(callback)
-      @after_update_callback = callback
+    def update_in_thread(source, instance)
+      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
+    rescue Exception => ex
+      puts "Something failed outside the update_source method. #{ex.message}"
+      puts ex.backtrace
     end
 
     def publish_data(source, data)
       Publisher.publish(source, data)
     end
+
+    def wait_a_little_bit_to_not_start_all_fetches_at_once
+      sleep 10 * rand
+    end
   end
 end

data/lib/dboard.rb

@@ -1,3 +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'))
+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

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

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Dboard
-  VERSION = "1.0.3"
+  VERSION = "1.1.1"
 end

data/spec/collector_spec.rb

@@ -1,32 +1,46 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+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)
+    new_relic = double
+    allow(new_relic).to receive(:update_interval).and_return(5)
     Dboard::Collector.register_source :new_relic, new_relic
-    Dboard::Collector.instance.sources.should == { :new_relic => new_relic }
+    expect(Dboard::Collector.instance.sources).to eq({ new_relic: new_relic })
   end
 
   it "can register an after update callback" do
-    new_relic = mock
-    new_relic.stub!(:fetch).and_return({ :db => "100%" })
-    callback = mock
+    new_relic = double
+    allow(new_relic).to receive(:fetch).and_return({ db: "100%" })
+    callback = double
     Dboard::Collector.register_after_update_callback callback
 
-    callback.should_receive(:call)
-    Dboard::Publisher.stub!(:publish)
+    expect(callback).to receive(:call)
+    allow(Dboard::Publisher).to receive(:publish)
     Dboard::Collector.instance.update_source(:new_relic, new_relic)
 
     # since it is a singleton, and this callbacks leaks into the other tests
     Dboard::Collector.register_after_update_callback(lambda {})
   end
 
+  it "can register an error callback" do
+    new_relic = double
+    error = RuntimeError.new("error")
+    allow(new_relic).to receive(:fetch).and_raise(error)
+    callback = double
+    Dboard::Collector.register_error_callback callback
+
+    expect(callback).to receive(:call).with(error)
+    allow(Dboard::Publisher).to receive(:publish)
+    allow_any_instance_of(Dboard::Collector).to receive(:puts)
+    Dboard::Collector.instance.update_source(:new_relic, new_relic)
+
+    # since it is a singleton, and this callbacks leaks into the other tests
+    Dboard::Collector.register_error_callback(lambda { |_| })
+  end
 end
 
 describe Dboard::Collector, "update_source" do
@@ -35,17 +49,16 @@ describe Dboard::Collector, "update_source" do
   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%" })
+    new_relic = double
+    allow(new_relic).to receive(:fetch).and_return({ db: "100%" })
+    expect(Dboard::Publisher).to 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
+    new_relic = double
+    allow(new_relic).to receive(:fetch).and_raise(Exception.new("some error"))
+    expect(Dboard::Collector.instance).to receive(:puts).twice
     Dboard::Collector.instance.update_source(:new_relic, new_relic)
   end
-
 end

data/spec/publisher_spec.rb

@@ -1,16 +1,14 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+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 }, :timeout => 10000)
-    Dboard::Publisher.publish(:new_relic, { :db => "80%" })
+    expect(Dboard::Api::Client).to receive(:post).with("/sources/new_relic", body: { data: { db: "80%" }.to_json }, timeout: 10000)
+    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")
+    expect(Dboard::Api::Client).to receive(:post).and_raise(SocketError.new("failed to connect"))
+    expect(Dboard::Publisher).to receive(:puts).with("SocketError: failed to connect")
     Dboard::Publisher.publish(:new_relic, {})
   end
-
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require "rspec"
 
-ENV["RACK_ENV"] ||= 'test'
-ENV['API_URL'] = "http://localhost:20843"
-ENV['API_USER'] = 'test'
-ENV['API_PASSWORD'] = 'test'
+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'))
+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'])
+Dboard::Api::Client.basic_auth(ENV["API_USER"], ENV["API_PASSWORD"])
+Dboard::Api::Client.base_uri(ENV["API_URL"])

metadata

@@ -1,121 +1,109 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dboard
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+version: !ruby/object:Gem::Version
+  version: 1.1.1
 platform: ruby
-authors: 
-- "Joakim Kolsj\xC3\xB6"
+authors:
+- Joakim Kolsjö
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-05 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: dalli
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: sinatra
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 description: Dashboard framework
-email: 
+email:
 - joakim.kolsjo@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rvmrc
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENCE
 - README.md
@@ -129,42 +117,30 @@ files:
 - lib/publisher.rb
 - lib/version.rb
 - spec/collector_spec.rb
-- spec/integration_spec.rb
 - spec/publisher_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: ""
-licenses: 
+homepage: ''
+licenses:
 - MIT
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 3.2.28
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Dashboard framework
 test_files: []
-

data/.rvmrc

@@ -1 +0,0 @@
-rvm ree-1.8.7-2011.03@dboard --create

data/spec/integration_spec.rb

@@ -1,54 +0,0 @@
-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
-