is_it_done_yet 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3370c312f841a7cb85eacf8a0f52945c3cd662dce2e45788d3c9e60908866ae0
-  data.tar.gz: 481779c28ea71076b0c9dd9ffb902d53bf9aa4bc94896608ff6a433bc7c39f6d
+  metadata.gz: acc0a7adff69366d84c25bbfdc1341baccf2f648cb42778a5bc7bcabaf1a2e26
+  data.tar.gz: 66fb306eb3ca271c5355fbefae632f924b42eaf6e9ec4d896b7fc91ce4f5780a
 SHA512:
-  metadata.gz: 7c9e4dc318b6ce443062e9d7dd796e36ead41989e7671ccbe3df0e0ebe99d5cbba4290c5b71408abcf83ff9f622facb6dd07c23194136d741339eb4f1e26ee7c
-  data.tar.gz: 032acfa618083162944e0d9253ce094a7682db09a18957b2d925363d1c886d376a1240cf1c9929e14984504d7503007c6f30838f0a18c96f6a8763e41a2d6543
+  metadata.gz: 810ae7248094df3dfa2b23a621e85bf9a42c60a75fdde2f413e4df247f802d3a9e84106f35191b16d48ef206acf5db1af53ea1dd8dcd66bc15a18d2aca1e3149
+  data.tar.gz: 5acb53f6362ccba9876de3698a88fb70ed78b3e5a3af45e5f77d5d04140dee519aaa94b1c4b3b67696fb3345a2a5e5972060cce01d10349f86195a918230ddea

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 0.7.0
+
+Runs on current Ruby.
+
+* Sinatra moves from 2.x to 4.x and Rack from 2.x to 3.x. Sinatra 2 requires
+  ostruct, which left the standard library, so the gem could not even be loaded
+  on Ruby 4.
+* JSON request bodies, which the README documents as the way to use this API,
+  returned 500 on Ruby 4. rack-contrib parses them by calling JSON.parse with
+  create_additions, a keyword json 3 removed, and Ruby 4 ships json 3. The app
+  now supplies its own parser to the middleware.
+* thin and rack-token_auth are no longer dependencies. The README always said
+  the deployer brings their own server and auth middleware, and the library
+  never required either.
+* Requires Ruby 3.2 or newer.
+* The published gem no longer carries the Rakefile, Gemfile, CI config or
+  development scripts.
+* The example config.ru returned a bare string where Rack needs a status,
+  headers and body, and used `use` where it needed `map`.
+
 # 0.6.0
 
 Bumping dependencies

data/README.md

@@ -6,7 +6,7 @@ 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).
+An example Travis build configuration that takes advantage of a deployed `is_it_done_yet` service is available in [examples](examples/.travis.yml).
 
 ## Installation
 

data/examples/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+
+bundler_args: --without production
+
+env:
+  global:
+    - CI_NODE_TOTAL=2
+  matrix:
+    - CI_NODE_INDEX=0
+    - CI_NODE_INDEX=1
+
+before_script: examples/ci-put BUILDING REBUILDING
+
+script: bundle exec rake knapsack:rspec && examples/ci-sync && examples/ci-deploy
+
+after_success: examples/ci-put OK
+after_failure: examples/ci-put FAILED

data/examples/config.ru

@@ -6,16 +6,16 @@ require 'rack/token_auth'
 require 'is_it_done_yet'
 Bundler.require
 
-# Shared secret authentication
+# Shared secret authentication. The gem does not depend on rack-token_auth, so
+# add it, and a server such as puma, to your own Gemfile. Which middleware and
+# which server to run are yours to choose.
 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
+map '/health_check' do
+  run ->(_env) { [200, { 'content-type' => 'text/plain' }, ['success']] }
 end
 
 run IsItDoneYet.build_app

data/lib/is_it_done_yet/version.rb

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

data/lib/is_it_done_yet.rb

@@ -2,13 +2,19 @@
 
 require 'is_it_done_yet/version'
 require 'is_it_done_yet/web_app'
+require 'json'
 require 'rack/contrib'
 require 'rack'
 
 module IsItDoneYet
+  # rack-contrib's own parser calls JSON.parse with create_additions, which json
+  # 3 removed, so every JSON request body fails there on Ruby 4. The middleware
+  # takes a parser block, so supply one that does not use the removed keyword.
+  PARSE_JSON_BODY = ->(body) { JSON.parse(body) }
+
   def self.build_app
     Rack::Builder.app do
-      use Rack::PostBodyContentTypeParser
+      use Rack::JSONBodyParser, &PARSE_JSON_BODY
       run WebApp
     end
   end

metadata

@@ -1,99 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: is_it_done_yet
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Erik Madsen
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rack-contrib
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rack-token_auth
+  name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: thin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,26 +186,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- config.ru
+- examples/.travis.yml
 - 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
@@ -229,7 +204,10 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  source_code_uri: http://www.github.com/beatmadsen/is_it_done_yet
+  changelog_uri: http://www.github.com/beatmadsen/is_it_done_yet/blob/master/CHANGELOG.md
+  bug_tracker_uri: http://www.github.com/beatmadsen/is_it_done_yet/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -237,15 +215,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.0.pre1
-signing_key: 
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Tracks statuses of CI build nodes
 test_files: []

data/.github/workflows/ruby.yml

@@ -1,33 +0,0 @@
-# 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,15 +0,0 @@
-git /.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-*.gem
-.byebug_history
-
-.DS_Store

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at beatmadsen@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -1,79 +0,0 @@
-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/Rakefile

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

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/config.ru

@@ -1,19 +0,0 @@
-# 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/is_it_done_yet.gemspec

@@ -1,52 +0,0 @@
-# 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'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'is_it_done_yet'
-  spec.version       = IsItDoneYet::VERSION
-  spec.authors       = ['Erik Madsen']
-  spec.email         = ['beatmadsen@gmail.com']
-
-  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'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/}) ||
-      f.match(/knapsack/) ||
-      f.match(/travis/)
-  end
-  spec.bindir        = 'bin'
-  spec.require_paths = ['lib']
-
-  # Always
-  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'
-  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