is_it_done_yet 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8cded42ede28e4279d6d57be770449cb57cd4370
-  data.tar.gz: bdffab5e1c71d5781a93096d58f4ea10d0284588
+SHA256:
+  metadata.gz: 3370c312f841a7cb85eacf8a0f52945c3cd662dce2e45788d3c9e60908866ae0
+  data.tar.gz: 481779c28ea71076b0c9dd9ffb902d53bf9aa4bc94896608ff6a433bc7c39f6d
 SHA512:
-  metadata.gz: e92becf7e492523175a4bfc243b0ed44afe464a9143a425d8ccec1c69680e8f22fdd52c06229401f5dd910d99e9331061f303fad5467cf4a7ff84acb46ff5243
-  data.tar.gz: bd8ffb0dfbd1c7b0cc517c48fa90add9942a6f673680d488b4b683fd8eac38e87a911107f895b740cf0d99b1267450be302f5a4987d5b13c5facd8b0e0b95031
+  metadata.gz: 7c9e4dc318b6ce443062e9d7dd796e36ead41989e7671ccbe3df0e0ebe99d5cbba4290c5b71408abcf83ff9f622facb6dd07c23194136d741339eb4f1e26ee7c
+  data.tar.gz: 032acfa618083162944e0d9253ce094a7682db09a18957b2d925363d1c886d376a1240cf1c9929e14984504d7503007c6f30838f0a18c96f6a8763e41a2d6543

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,6 +1,5 @@
-/.bundle/
+git /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -10,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem
+.byebug_history
+
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# 0.6.0
+
+Bumping dependencies
+
+# 0.5.0
+
+Bumping dependencies
+
+
+# 0.4.0
+
+Features:
+
+* Introduced `PUT /builds/:build_id/nodes/:node_id` which enables CI scripts that update node values for instance when rebuilding.
+
+# 0.3.0
+
+Features:
+
+* Clear state for a build using `DELETE /builds/:build_id`. Useful when a CI build is restarted.
+
+Bug fixes:
+
+* Posting now adheres to standard REST conventions; returns 201 with no body if successful and 409 if the node already exists.
+
+
+# 0.2.0
+
+Features:
+
+* Build ids and node ids may now contain any (url-escaped) character.
+   - Note that when all nodes of a build are queried, `GET /builds/:build_id`, node ids will appear in their url-unescaped form.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in is_it_done_yet.gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    is_it_done_yet (0.6.0)
+      concurrent-ruby
+      json
+      rack-contrib
+      rack-token_auth
+      sinatra (~> 2.0)
+      thin
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.7)
+    daemons (1.3.1)
+    diff-lcs (1.3)
+    eventmachine (1.2.7)
+    json (2.3.1)
+    knapsack (1.17.1)
+      rake
+    method_source (0.9.2)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.2.3)
+    rack-contrib (2.2.0)
+      rack (~> 2.0)
+    rack-protection (2.0.8.1)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rack-token_auth (0.2.0)
+      rack
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby2_keywords (0.0.2)
+    sinatra (2.0.8.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.8.1)
+      tilt (~> 2.0)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    tilt (2.0.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  is_it_done_yet!
+  knapsack
+  pry
+  rack-test
+  rake
+  rspec
+
+BUNDLED WITH
+   2.1.0.pre.1

data/README.md

@@ -6,6 +6,8 @@ The intended use case is when you want to use one of the build nodes as a master
 
 Specifically I built it to allow a travis job at work to do parallel tests with Knapsack and do a deploy if all tests pass.
 
+An example Travis build configuration that takes advantage of a deployed `is_it_done_yet` service is available in [examples](exampels/.travis.yml).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,6 +28,19 @@ Or install it yourself as:
 
 This library includes a Rack application which you can instantiate by doing `IsItDoneYet.build_app`. In the [example Rack config](examples/config.ru) there's a setup with token-based auth middleware. Include a similar `config.ru` at the root of your application and run `bundle exec rackup` to start the web app locally. If you're running it on a cloud service, follow your service's guidelines on deploying Rack applications.
 
+The web app provides five endpoints:
+* `POST /builds/:build_id/nodes/:node_id` to write value for node, failing to overwrite.
+    - example request body: `{ "build_state" : "ok" }`
+* `PUT /builds/:build_id/nodes/:node_id` to write or overwrite value for node.
+    - example request body: `{ "build_state" : "building", "build_state_on_overwrite" : "rebuilding" }`
+* `GET /builds/:build_id`
+    - example response body: `{ "build_states": { "51": "bad", "52": "ok" } }`
+* `GET /builds/:build_id/nodes/:node_id`
+    - example response body: `{ "build_state": "ok" }`
+* `DELETE /builds/:build_id` to clear state for a build
+
+The app keeps the build states in memory. This means that values will be lost after a restart of the service. Further, load balancing across multiple instances will only work if routing to the individual instance is consistent for the same `:build_id` path parameter, but scaling beyond one app instance is not currently a known use case.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,10 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require 'knapsack'
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'knapsack'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 Knapsack.load_tasks if defined?(Knapsack)

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "is_it_done_yet"
+require 'bundler/setup'
+require 'is_it_done_yet'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "is_it_done_yet"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/config.ru

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'rack/contrib'
+require 'rack/token_auth'
+require 'is_it_done_yet'
+Bundler.require
+
+# Shared secret authentication
+use Rack::TokenAuth do |token, _options, _env|
+  token == ENV['IIDY_TOKEN']
+end
+
+# Heartbeat endpoint
+map '/health_check' do
+  run ->(_env) { [200, { 'Content-Type' => 'text/plain' }, ['success']] }
+end
+
+run IsItDoneYet.build_app

data/examples/ci-clear

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Script that clears build status of
+# travis nodes from synchronising service
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+SLEEP_TIME_SECONDS = 30
+
+env_ok = ENV['CI_NODE_INDEX'] &&
+         ENV['CI_NODE_TOTAL'] &&
+         ENV['IIDY_ENDPOINT'] &&
+         ENV['TRAVIS_BUILD_NUMBER'] &&
+         ENV['TRAVIS_JOB_NUMBER'] &&
+         ENV['IIDY_TOKEN']
+
+abort 'Bad env' unless env_ok
+
+main_node = ENV['CI_NODE_INDEX'] == '0'
+auth_token = "Token token=\"#{ENV['IIDY_TOKEN']}\""
+
+if main_node
+  build_id = "is_it_done_yet--#{ENV['TRAVIS_BUILD_NUMBER']}"
+
+  url = ENV['IIDY_ENDPOINT'] + "/builds/#{build_id}"
+
+  puts "URL: #{url}"
+
+  uri = URI(url)
+
+  request = Net::HTTP::Delete.new(uri)
+  request['Authorization'] = auth_token
+
+  response = Net::HTTP.start(
+    uri.hostname,
+    uri.port,
+    use_ssl: uri.scheme == 'https'
+  ) { |http| http.request(request) }
+
+  abort 'Failed to clear results' unless response.code == '204'
+  puts 'Successfully cleared results!'
+else
+  puts 'Not main node!'
+end

data/examples/ci-deploy

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 main_node = ENV['CI_NODE_INDEX'] == '0'
 
 if main_node

data/examples/ci-post

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Script that posts build status of
 # travis nodes (from ARGV[0]) to synchronising service
@@ -46,5 +47,5 @@ else
     use_ssl: uri.scheme == 'https'
   ) { |http| http.request(request) }
 
-  abort "Failed to post build status: #{response.code}" unless response.code == '200'
+  abort "Failed to post build status: #{response.code}" unless response.code == '201'
 end

data/examples/ci-put

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Script that puts build and rebuild status of
+# travis nodes (from ARGV[0] and ARGV[1]) to synchronising service
+require 'net/http'
+require 'uri'
+require 'json'
+
+env_ok = ENV['CI_NODE_INDEX'] &&
+         ENV['CI_NODE_TOTAL'] &&
+         ENV['IIDY_ENDPOINT'] &&
+         ENV['TRAVIS_BUILD_NUMBER'] &&
+         ENV['TRAVIS_JOB_NUMBER'] &&
+         ENV['IIDY_TOKEN']
+
+args_ok = !ARGV[0].nil?
+
+abort 'Bad env' unless env_ok
+abort 'Bad args' unless args_ok
+
+main_node = ENV['CI_NODE_INDEX'] == '0'
+auth_token = "Token token=\"#{ENV['IIDY_TOKEN']}\""
+
+if main_node
+  puts 'Main node!'
+else
+  # publish progress
+  build_id = "is_it_done_yet--#{ENV['TRAVIS_BUILD_NUMBER']}"
+  node_id = ENV['TRAVIS_JOB_NUMBER']
+
+  url = ENV['IIDY_ENDPOINT'] +
+        "/builds/#{build_id}/nodes/#{node_id}"
+
+  puts "URL: #{url}"
+
+  uri = URI(url)
+
+  request = Net::HTTP::Put.new(uri)
+  request['Authorization'] = auth_token
+  request.body = {
+    build_state: ARGV[0],
+    build_state_on_overwrite: ARGV[1]
+  }.compact.to_json
+  request.content_type = 'application/json'
+
+  response = Net::HTTP.start(
+    uri.hostname,
+    uri.port,
+    use_ssl: uri.scheme == 'https'
+  ) { |http| http.request(request) }
+
+  abort "Failed to put build status: #{response.code}" unless response.code == '204'
+end

data/examples/ci-sync

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Script that queries build status of
 # travis nodes from synchronising service
@@ -8,7 +9,9 @@ require 'net/http'
 require 'uri'
 require 'json'
 
-OK_STATES = %w(OK GOOD).freeze
+OK_STATES = %w[OK GOOD].freeze
+BUILDING_STATE = 'BUILDING'.freeze
+REBUILDING_STATE = 'REBUILDING'.freeze
 SLEEP_TIME_SECONDS = 30
 
 env_ok = ENV['CI_NODE_INDEX'] &&
@@ -39,10 +42,11 @@ if main_node
   expected_size = ENV['CI_NODE_TOTAL'].to_i - 1
   attempts = 0
   success = false
+  rebuilding = false
 
   loop do
     attempts += 1
-    abort 'Failed to fetch results' if attempts > 10
+    abort 'Failed to fetch results' if attempts > 10 && !rebuilding
 
     puts "Attempt no. #{attempts} at fetching build states"
 
@@ -52,13 +56,25 @@ if main_node
       use_ssl: uri.scheme == 'https'
     ) { |http| http.request(request) }
 
-    next unless response.code == '200'
+    unless response.code == '200'
+      sleep SLEEP_TIME_SECONDS
+      next
+    end
+
     build_states = JSON.parse(response.body)['build_states']
 
     if build_states.size < expected_size
       puts "Some nodes have not reported in yet, \
-        found #{build_states.size}, \
-        expected #{expected_size}, waiting a bit"
+      found #{build_states.size}, \
+      expected #{expected_size}, waiting a bit"
+      sleep SLEEP_TIME_SECONDS
+      next
+    end
+
+    rebuilding = build_states.any?{ |(_k, value)| REBUILDING_STATE == value.upcase  }
+    building = build_states.any?{ |(_k, value)| BUILDING_STATE == value.upcase  }
+    if rebuilding || building
+      puts 'Nodes are building or rebuilding'
       sleep SLEEP_TIME_SECONDS
       next
     end

data/examples/config.ru

@@ -1,11 +1,21 @@
+# frozen_string_literal: true
+
 require 'bundler'
 require 'rack/contrib'
 require 'rack/token_auth'
 require 'is_it_done_yet'
 Bundler.require
 
-use Rack::TokenAuth do |token, options, env|
+# Shared secret authentication
+use Rack::TokenAuth do |token, _options, _env|
   token == ENV['IIDY_TOKEN']
 end
 
+# Heartbeat endpoint
+use Rack::Builder.new do
+  map '/health_check' do
+    run ->(_env) { "success" }
+  end
+end
+
 run IsItDoneYet.build_app

data/is_it_done_yet.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'is_it_done_yet/version'
 
@@ -9,20 +10,16 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Erik Madsen']
   spec.email         = ['beatmadsen@gmail.com']
 
-  spec.summary       = 'Tracks status of Travis matrix build nodes'
-  spec.description   = '
-    In case you need to carry out build steps
-      in one of the nodes after the other nodes finish, e.g. deploying,
-      then you need a way of ascertaining the status of the other nodes.
-      This is what is_it_done_yet is for.
-  '
+  spec.summary       = 'Tracks statuses of CI build nodes'
+  spec.description   = 'In case you need to carry out build steps in one of the nodes of your CI project after the other nodes finish, e.g. deploying, then you need a way of ascertaining the status of the other nodes. This is what is_it_done_yet is for.'
   spec.homepage      = 'http://www.github.com/beatmadsen/is_it_done_yet'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -30,23 +27,26 @@ Gem::Specification.new do |spec|
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/}) ||
-      f.match(/knapsack/)
+      f.match(/knapsack/) ||
+      f.match(/travis/)
   end
   spec.bindir        = 'bin'
   spec.require_paths = ['lib']
 
   # Always
-  spec.add_dependency 'concurrent-ruby', '~> 1'
-  spec.add_dependency 'sinatra', '~> 1.4'
-  spec.add_dependency 'thin', '~> 1.7'
-  spec.add_dependency 'rack-contrib', '~> 1.4'
-  spec.add_dependency 'rack-token_auth', '~> 0.1'
-  spec.add_dependency 'json', '~> 2'
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'json'
+  spec.add_dependency 'rack-contrib'
+  spec.add_dependency 'rack-token_auth'
+  spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'thin'
 
   # Development
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rack-test', '~> 0.6'
-  spec.add_development_dependency 'knapsack', '~> 1.13'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'knapsack'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/is_it_done_yet.rb

@@ -1,96 +1,11 @@
+# frozen_string_literal: true
+
 require 'is_it_done_yet/version'
-require 'sinatra'
-require 'concurrent'
-require 'json'
-require 'time'
+require 'is_it_done_yet/web_app'
 require 'rack/contrib'
+require 'rack'
 
 module IsItDoneYet
-  class WebApp < ::Sinatra::Base
-    UNKNOWN_NODE = { errors: ['Unknown Node'] }.to_json
-    UNKNOWN_BUILD = { errors: ['Unknown Build'] }.to_json
-    NO_BUILD_STATE = { errors: ['You forgot build state'] }.to_json
-    TTL_SECONDS = 24 * 60 * 60
-
-    configure do
-      set :state, ::Concurrent::Map.new
-    end
-
-    helpers do
-      private
-
-      def key(build_id, node_id)
-        "#{build_id}|#{node_id}"
-      end
-
-      def house_keeping
-        expired_keys =
-          settings.state.each_pair.with_object([]) do |(key, (_b, time)), acc|
-            acc << key if time < Time.now - TTL_SECONDS
-          end
-
-        expired_keys.each { |key| settings.state.delete(key) }
-      end
-
-      def store(key, value)
-        settings.state[key] = [value, Time.now]
-      end
-
-      def retrieve(key)
-        build_state, _t = settings.state[key]
-        build_state
-      end
-
-      def retrieve_all(prefix)
-        settings.state
-                .each_pair
-                .select { |(key, _v)| key.start_with?(prefix) }
-                .map { |(key, (build_state, _t))| [key.split('|')[1], build_state] }
-                .to_h
-      end
-    end
-
-    before do
-      house_keeping
-
-      content_type :json
-    end
-
-    get '/builds/:build_id/nodes/:node_id' do
-      build_id, node_id = params.values_at('build_id', 'node_id')
-      k = key(build_id, node_id)
-
-      build_state = retrieve(k)
-
-      halt 404, UNKNOWN_NODE unless build_state
-
-      content_type :json
-      { build_state: build_state }.to_json
-    end
-
-    get '/builds/:build_id' do
-      build_id = params['build_id']
-
-      build_states = retrieve_all(build_id)
-
-      halt 404, UNKNOWN_BUILD unless build_states
-
-      content_type :json
-      { build_states: build_states }.to_json
-    end
-
-    post '/builds/:build_id/nodes/:node_id' do
-      build_state = params['build_state']
-      halt 400, NO_BUILD_STATE unless build_state
-
-      build_id, node_id = params.values_at('build_id', 'node_id')
-      k = key(build_id, node_id)
-      store(k, build_state)
-
-      200
-    end
-  end
-
   def self.build_app
     Rack::Builder.app do
       use Rack::PostBodyContentTypeParser

data/lib/is_it_done_yet/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IsItDoneYet
-  VERSION = "0.1.0"
+  VERSION = '0.6.0'
 end

data/lib/is_it_done_yet/web_app.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'is_it_done_yet/version'
+require 'sinatra'
+require 'concurrent'
+require 'json'
+require 'time'
+require 'rack/contrib'
+
+module IsItDoneYet
+  class WebApp < ::Sinatra::Base
+    UNKNOWN_NODE = { errors: ['Unknown Node'] }.to_json
+    ALREADY_EXISTS = { errors: ['Node already exists'] }.to_json
+    UNKNOWN_BUILD = { errors: ['Unknown Build'] }.to_json
+    NO_BUILD_STATE = { errors: ['You forgot build state'] }.to_json
+    TTL_SECONDS = 24 * 60 * 60
+
+    configure do
+      set :state, ::Concurrent::Map.new
+    end
+
+    helpers do
+      private
+
+      def key(build_id, node_id)
+        [build_id, node_id].freeze
+      end
+
+      def house_keeping
+        expired_keys =
+          settings.state.each_pair.with_object([]) do |(key, (_b, time)), acc|
+            acc << key if time < Time.now - TTL_SECONDS
+          end
+
+        expired_keys.each { |key| settings.state.delete(key) }
+      end
+
+      def store(key, value)
+        settings.state[key] = [value, Time.now]
+      end
+
+      def merge(key:, value_if_absent:, value_if_present:)
+        settings.state.merge_pair(key, [value_if_absent, Time.now]) do
+          [value_if_present, Time.now]
+        end
+      end
+
+      def retrieve(key)
+        build_state, _t = settings.state[key]
+        build_state
+      end
+
+      def retrieve_all(build_id)
+        settings.state
+                .each_pair
+                .select { |((b, _n), _v)| build_id == b }
+                .map { |((_b, node_id), (build_state, _t))| [node_id, build_state] }
+                .to_h
+      end
+
+      def clear_nodes(build_id)
+        state = settings.state
+        keys_for_build = state.keys.select { |(b, _n)| b == build_id }
+        keys_for_build.each { |key| state.delete(key) }
+      end
+    end
+
+    before do
+      house_keeping
+
+      content_type :json
+    end
+
+    get '/builds/:build_id/nodes/:node_id' do
+      build_id, node_id = params.values_at('build_id', 'node_id')
+      k = key(build_id, node_id)
+
+      build_state = retrieve(k)
+
+      halt 404, UNKNOWN_NODE unless build_state
+
+      { build_state: build_state }.to_json
+    end
+
+    get '/builds/:build_id' do
+      build_id = params['build_id']
+
+      build_states = retrieve_all(build_id)
+
+      halt 404, UNKNOWN_BUILD if build_states.to_a.empty?
+
+      { build_states: build_states }.to_json
+    end
+
+    delete '/builds/:build_id' do
+      build_id = params['build_id']
+
+      clear_nodes(build_id)
+
+      204
+    end
+
+    post '/builds/:build_id/nodes/:node_id' do
+      build_state = params['build_state']
+      halt 400, NO_BUILD_STATE unless build_state
+
+      build_id, node_id = params.values_at('build_id', 'node_id')
+      k = key(build_id, node_id)
+      halt 409, ALREADY_EXISTS if retrieve(k)
+
+      store(k, build_state)
+
+      201
+    end
+
+    # Example:
+    # PUT /builds/42/nodes/13?build_state=BUILDING&build_state_on_overwrite=REBUILDING
+    put '/builds/:build_id/nodes/:node_id' do
+      build_state, build_state_on_overwrite =
+        params.values_at('build_state', 'build_state_on_overwrite')
+      halt 400, NO_BUILD_STATE unless build_state
+
+      build_id, node_id = params.values_at('build_id', 'node_id')
+      k = key(build_id, node_id)
+
+      if build_state_on_overwrite
+        merge(
+          key: k,
+          value_if_absent: build_state,
+          value_if_present: build_state_on_overwrite
+        )
+      else
+        store(k, build_state)
+      end
+
+      204
+    end
+  end
+end

metadata

@@ -1,196 +1,229 @@
 --- !ruby/object:Gem::Specification
 name: is_it_done_yet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Erik Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: thin
+  name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-contrib
+  name: rack-token_auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-token_auth
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: knapsack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: knapsack
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   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: '1.13'
-description: "\n    In case you need to carry out build steps\n      in one of the
-  nodes after the other nodes finish, e.g. deploying,\n      then you need a way of
-  ascertaining the status of the other nodes.\n      This is what is_it_done_yet is
-  for.\n  "
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: In case you need to carry out build steps in one of the nodes of your
+  CI project after the other nodes finish, e.g. deploying, then you need a way of
+  ascertaining the status of the other nodes. This is what is_it_done_yet is for.
 email:
 - beatmadsen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- config.ru
+- examples/ci-clear
 - examples/ci-deploy
 - examples/ci-post
+- examples/ci-put
 - examples/ci-sync
 - examples/config.ru
 - is_it_done_yet.gemspec
 - lib/is_it_done_yet.rb
 - lib/is_it_done_yet/version.rb
+- lib/is_it_done_yet/web_app.rb
 homepage: http://www.github.com/beatmadsen/is_it_done_yet
 licenses:
 - MIT
@@ -204,16 +237,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.0.pre1
 signing_key: 
 specification_version: 4
-summary: Tracks status of Travis matrix build nodes
+summary: Tracks statuses of CI build nodes
 test_files: []

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.14.6
-bundler_args: --without production
-
-env:
-  global:
-    - MY_GLOBAL_VAR=123
-    - CI_NODE_TOTAL=2
-  matrix:
-    - CI_NODE_INDEX=0
-    - CI_NODE_INDEX=1
-
-script: bundle exec rake knapsack:rspec && examples/ci-sync && examples/ci-deploy
-
-after_success: examples/ci-post OK
-after_failure: examples/ci-post FAILED