dboard 1.0.5 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 066c3ae2d4574bad0b7b56e0c5a784fe36b396d5
-  data.tar.gz: 49aa1e783781c16fabee8416c2bdc97e9eceb0d1
+SHA256:
+  metadata.gz: 4e3f07d3f503da759e56a7e315c0a59c3a1e7fa9a4bd3cdc2ac6533294c4d6df
+  data.tar.gz: 6f5d28ba5299fa8d219c4f1581635c78db27052ddc9fc06c33e06bd9f4507613
 SHA512:
-  metadata.gz: 779322a76e7fd4521fc8c30cd6e394444e2ee25ee16849a7958a2fc04cb883f5d7c7b7e2dd32376f4edc51e4ac0a1ab6d146dc17e642defd532ae2e74bbbd319
-  data.tar.gz: 14c30edbffe96773c1d783865e7e97581c286d06eff18c87c078d63c33eeca4c49dfbd1cc69591435fa0ca1e652d99021bd89b9dd1c73d724ceb208f8bb16074
+  metadata.gz: 3a7d9df2e8c2271a83fc757f9564dd41c5662a3780a01a5c4d5024421035ed3b2eca88f5379b96c7c39a151821be2152cb3d6e11269a5ec3f8db0e5ddf78af07
+  data.tar.gz: 004c14e13bc762c8fe3aae9618696a568048c139a0e0ab30c7b49e603f680d0f79d5251d55ad49e058edce6b97315a09981c627bc1dec68d44eea84ed6db4089

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"]
+
+    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,11 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 gemspec
+
+gem "net_http_timeout_errors"
+
+group :development, :test do
+  gem "barsoom_utils"
+  gem "rspec"
+  gem "rubocop"
+  gem "webmock"
+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,20 @@ 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 "dalli"
   s.add_dependency "httparty"
-  s.add_dependency "rake"
   s.add_dependency "json"
-  s.add_dependency "dalli"
+  s.add_dependency "rake"
   s.add_dependency "sinatra"
-  s.add_development_dependency "rspec", "2.6.0"
 end

data/lib/api.rb

@@ -1,8 +1,9 @@
-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"
+require "net_http_timeout_errors"
 
 module Dboard
   class Api
@@ -11,16 +12,37 @@ module Dboard
 
     class Client
       include HTTParty
+
+      def self.post(*args, **kwargs)
+        with_retries { super }
+      end
+
+      private
+
+      private_class_method \
+      def self.with_retries
+        remaining_attempts = 3
+
+        begin
+          remaining_attempts -= 1
+          yield
+        rescue *NetHttpTimeoutErrors.all
+          raise if remaining_attempts == 0
+
+          sleep((ENV["RACK_ENV"] == "test") ? 0 : 5)
+          retry
+        end
+      end
     end
 
     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,6 +26,7 @@ module Dboard
     def initialize
       @sources = {}
       @after_update_callback = lambda {}
+      @error_callback = lambda { |exception| }
     end
 
     def start
@@ -45,6 +50,10 @@ module Dboard
       @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
@@ -56,6 +65,7 @@ module Dboard
     rescue Exception => ex
       puts "Failed to update #{source}: #{ex.message}"
       puts ex.backtrace
+      @error_callback.call(ex)
     end
 
     private

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.5"
+  VERSION = "2.0.1"
 end

data/spec/collector_spec.rb

@@ -1,30 +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
+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
@@ -32,17 +48,17 @@ describe Dboard::Collector, "update_source" 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%" })
+  it "collects and publishes data from sources" do
+    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
+  it "prints out debugging info" do
+    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,33 @@
-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%" })
+describe "Publisher", ".publish" do
+  it "sends data to the dashboard server" do
+    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")
+  it "retries network errors" do
+    stub_request(:post, "http://api.example/sources/new_relic").
+      to_timeout.times(2).
+      to_return({ body: "OK!" })
+
     Dboard::Publisher.publish(:new_relic, {})
   end
 
+  it "raises network errors if we run out of retries" do
+    stub_request(:post, "http://api.example/sources/new_relic").
+      to_timeout.times(3).
+      to_return({ body: "OK!" })
+
+    expect {
+      Dboard::Publisher.publish(:new_relic, {})
+    }.to raise_error(Net::OpenTimeout)
+  end
+
+  # 2021-12-07: No idea why we've treated this one specially, but keeping it for now.
+  it "logs socket errors if we run out of retries" do
+    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,12 @@
 require "rspec"
+require 'webmock/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://api.example"
+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,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: dboard
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.1
 platform: ruby
 authors:
 - Joakim Kolsjö
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dalli
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.0
 description: Dashboard framework
 email:
 - joakim.kolsjo@gmail.com
@@ -101,8 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".rvmrc"
+- ".rubocop.yml"
 - Gemfile
 - LICENCE
 - README.md
@@ -116,13 +103,13 @@ files:
 - lib/publisher.rb
 - lib/version.rb
 - spec/collector_spec.rb
-- spec/integration_spec.rb
 - spec/publisher_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -138,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Dashboard framework

data/.rvmrc

@@ -1 +0,0 @@
-rvm ruby-2.1.0@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
-