is_it_done_yet 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1778acaba096d60e74ad95e7fae02e11a0a8cec0
-  data.tar.gz: 1fa88b4da2deae3f11f31765d86c7478ef2a6108
+  metadata.gz: acd12c54ad56816b78a4dce97b4959ca75f13392
+  data.tar.gz: 61d989bd6096d96b479d17b0823d360d8e374824
 SHA512:
-  metadata.gz: 0a14bcf35ad70e435d7a817a7a6f8f05b2292f82f5fc385135ac69778a0509940175222f9880f1fc403541b077bd13757edca2db19ae94860726e31dd71b58bb
-  data.tar.gz: 1ef23febcd56156d6c72ec677f661da926102d6e9043e9f1ae3912ef53ce1a19deeb16b98af72648530e0954706a273f76efedd064b89e62356032e468793274
+  metadata.gz: 5e90bcdbe755b2430d43f1e3f9e4579e5ed262beeeb7eb0179aa0dad1531c6683a8ecbfc6cf8d56fdb286e2d451e176e7759cca98910a933147ccd41c82d8cb1
+  data.tar.gz: a13eb75011f38fe0492df830e8f7a7a5a3d0c8cbc9816c08c7bfb548acb35a79a847454c1bd7acc68a4a755bf3c5817799dce0225af87a78151d0e75dbc41ba3

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 *.gem
+.byebug_history

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 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:

data/Rakefile

@@ -1,10 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+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,7 @@
 #!/usr/bin/env ruby
 
-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 +10,5 @@ require "is_it_done_yet"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/examples/ci-clear

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+# 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-post

@@ -46,5 +46,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-sync

@@ -8,7 +8,7 @@ require 'net/http'
 require 'uri'
 require 'json'
 
-OK_STATES = %w(OK GOOD).freeze
+OK_STATES = %w[OK GOOD].freeze
 SLEEP_TIME_SECONDS = 30
 
 env_ok = ENV['CI_NODE_INDEX'] &&
@@ -52,13 +52,17 @@ 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

data/examples/config.ru

@@ -4,8 +4,14 @@ 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
+map '/health_check' do
+  run ->(_env) { [200, { 'Content-Type' => 'text/plain' }, ['success']] }
+end
+
 run IsItDoneYet.build_app

data/is_it_done_yet.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'is_it_done_yet/version'
@@ -46,4 +47,5 @@ Gem::Specification.new do |spec|
   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 'byebug', '~> 9'
 end

data/lib/is_it_done_yet.rb

@@ -1,96 +1,9 @@
 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].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 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
-    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 if build_states.to_a.empty?
-
-      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,3 @@
 module IsItDoneYet
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'.freeze
 end

data/lib/is_it_done_yet/web_app.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: is_it_done_yet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Erik Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
 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.
@@ -183,6 +197,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/ci-clear
 - examples/ci-deploy
 - examples/ci-post
 - examples/ci-sync
@@ -190,6 +205,7 @@ files:
 - 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