is_it_done_yet 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cded42ede28e4279d6d57be770449cb57cd4370
-  data.tar.gz: bdffab5e1c71d5781a93096d58f4ea10d0284588
+  metadata.gz: 1778acaba096d60e74ad95e7fae02e11a0a8cec0
+  data.tar.gz: 1fa88b4da2deae3f11f31765d86c7478ef2a6108
 SHA512:
-  metadata.gz: e92becf7e492523175a4bfc243b0ed44afe464a9143a425d8ccec1c69680e8f22fdd52c06229401f5dd910d99e9331061f303fad5467cf4a7ff84acb46ff5243
-  data.tar.gz: bd8ffb0dfbd1c7b0cc517c48fa90add9942a6f673680d488b4b683fd8eac38e87a911107f895b740cf0d99b1267450be302f5a4987d5b13c5facd8b0e0b95031
+  metadata.gz: 0a14bcf35ad70e435d7a817a7a6f8f05b2292f82f5fc385135ac69778a0509940175222f9880f1fc403541b077bd13757edca2db19ae94860726e31dd71b58bb
+  data.tar.gz: 1ef23febcd56156d6c72ec677f661da926102d6e9043e9f1ae3912ef53ce1a19deeb16b98af72648530e0954706a273f76efedd064b89e62356032e468793274

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 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/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,16 @@ 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 three endpoints:
+* `POST /builds/:build_id/nodes/:node_id`
+    - example request body: `{ "build_state" : "ok" }`
+* `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" }`
+
+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/is_it_done_yet.gemspec

@@ -9,20 +9,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,7 +26,8 @@ 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']

data/lib/is_it_done_yet/version.rb

@@ -1,3 +1,3 @@
 module IsItDoneYet
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/is_it_done_yet.rb

@@ -20,7 +20,7 @@ module IsItDoneYet
       private
 
       def key(build_id, node_id)
-        "#{build_id}|#{node_id}"
+        [build_id, node_id].freeze
       end
 
       def house_keeping
@@ -41,11 +41,11 @@ module IsItDoneYet
         build_state
       end
 
-      def retrieve_all(prefix)
+      def retrieve_all(build_id)
         settings.state
                 .each_pair
-                .select { |(key, _v)| key.start_with?(prefix) }
-                .map { |(key, (build_state, _t))| [key.split('|')[1], build_state] }
+                .select { |((b, _n), _v)| build_id == b }
+                .map { |((_b, node_id), (build_state, _t))| [node_id, build_state] }
                 .to_h
       end
     end
@@ -73,7 +73,7 @@ module IsItDoneYet
 
       build_states = retrieve_all(build_id)
 
-      halt 404, UNKNOWN_BUILD unless build_states
+      halt 404, UNKNOWN_BUILD if build_states.to_a.empty?
 
       content_type :json
       { build_states: build_states }.to_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: is_it_done_yet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Erik Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -164,10 +164,9 @@ dependencies:
     - - "~>"
       - !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  "
+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: []
@@ -176,7 +175,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -204,7 +203,7 @@ 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:
   - - ">="
@@ -215,5 +214,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 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