metatron 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe8d0dcac1a47b872ca203dea9ec4e816e07fdb2bb14fd01f6458ca4b7789cef
-  data.tar.gz: 255bc8c1efdd1c173455f3b28533ceffd70e34115aad86dba1f685dfceba1318
+  metadata.gz: 9252f0668ef9d7bb533e87c696ee1c19968bfc2029b9c9992c2defe42360e8d7
+  data.tar.gz: f0570ad8ffd6ba0256316dce95f0143e5972117851f0e6080d4ff6a773fa8461
 SHA512:
-  metadata.gz: ca1ba6ad7b4b5aa5677b6e7bbd30fe7b643f1f9459232a950d97684430fec3d3c7b710c327aa5a98e8d9324ebe457950df9acb1b50df0678eb875b2f869b6a8d
-  data.tar.gz: 1c7bc21979e3087dd5e55a381d7fddb9ade45159a72a105ba6d306dd60a8cb34828bad8d9a3ee7db6e1025f5b839e287a3bc21daaa834cb8aa49f31ade19943d
+  metadata.gz: 8b80a57ab9b8deccfe861e08baedf2c220319443a89d38f3607dc20f8654243b29cb84d35c0da0a4c795f4619be6d32d1c8cb9ee799705046799456f79e5b7ba
+  data.tar.gz: 0d29f8ad2e9b74338ddf8ff2aaaf219541e069e5ae9cbad6cc2bc8ad6e30d65c9c723231d2cd86fc55778ae19bd9161cd60f1e5ac700a9159ebb166fe34fbf15

data/.rubocop.yml

@@ -56,3 +56,6 @@ Style/StringLiteralsInInterpolation:
 Style/StringConcatenation:
   Exclude:
   - 'Rakefile'
+
+RSpec/ExampleLength:
+  Max: 10

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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. 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/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing
+
+## How to Contribute Code
+
+I'm so glad you're reading this, because we need volunteer developers to help this project grow and thrive!
+
+Before you begin, ensure that your contribution is associated with a [GitHub issue](https://github.com/jgnagy/metatron/issues). If there isn't an existing issue, please create one.
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature-branch`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature-branch`)
+5. Create a new [Pull Request](http://help.github.com/pull-requests/)
+
+### Testing
+
+Please make sure that your code passes the existing tests and add tests for any new functionality. Please write [RSpec](https://rspec.info/) examples for new features you add or modify.
+
+To execute the tests, run `bundle exec rake spec`.
+
+### Coding Style
+
+This project uses [Rubocop](https://rubocop.org/) to enforce a consistent coding style. Please make sure that your code passes the Rubocop checks.
+
+To execute Rubocop, run `bundle exec rake rubocop`.
+
+### Documentation
+
+Please make sure that your code is well documented. If you add new features, please add documentation for them. This project uses [YARD](https://yardoc.org/) for documentation, so please add YARD tags to your code when appropriate.
+
+### License
+
+By contributing your code, you agree to license your contribution under the terms of the [MIT License](LICENSE.txt).
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Reporting Bugs
+
+Please use the [GitHub issue tracker](https://github.com/jgnagy/metatron/issues) to report any bugs.
+
+## Suggesting Enhancements
+
+If you have ideas for enhancements or improvements please use the [GitHub issue tracker](https://github.com/jgnagy/metatron/issues) to suggest them.
+
+Thank you for your interest in contributing!

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    metatron (0.4.2)
+    metatron (0.5.0)
       json (~> 2.6)
-      puma (~> 6.3)
       sinatra (~> 3.1)
       sinatra-contrib (~> 3.1)
 
@@ -27,7 +26,6 @@ GEM
     multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
-    nio4r (2.6.0)
     nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.15.4-x86_64-linux)
@@ -36,8 +34,6 @@ GEM
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
-    puma (6.4.0)
-      nio4r (~> 2.0)
     racc (1.7.3)
     rack (2.2.8)
     rack-protection (3.1.0)

data/README.md

@@ -2,9 +2,9 @@
 
 Metatron is a Ruby library for creating [Metacontroller](https://metacontroller.github.io/metacontroller/)-based custom Kubernetes controllers.
 
-The intention is to make it as easy as possible to use Ruby to manage [custom resources](https://kubernetes.io/docs/concepts/api-extension/custom-resources/) within your Kubernetes infrastructure. No Golang required to listen for and respond to resources based on your own [CustomResourceDefinition](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/) or to modify existing kubernetes resources via a [DecoratorController](https://metacontroller.github.io/metacontroller/api/decoratorcontroller.html).
+The intention is to make it as easy as possible to use Ruby to manage [custom resources](https://kubernetes.io/docs/concepts/api-extension/custom-resources/) within your Kubernetes infrastructure. No Golang required!
 
-Your Ruby code doesn't have to have any _real_ knowledge of the Kubernetes environment in which it operates; Metacontroller takes care of all the Kubernetes interactions and Metatron handles providing the JSON interface. Just write a `sync` method that can receive and respond with the appropriate Hashes and you're on your way!
+For more information, see the [Metatron Wiki on GitHub](https://github.com/jgnagy/metatron/wiki)!
 
 ## Usage
 
@@ -107,7 +107,7 @@ spec:
           namespace: blog-controller
           port: 9292
           protocol: http
-        path: /sync
+        path: /blogs/sync
 ```
 
 Before applying the above though, we'll need to actually create a service that can response to sync requests. That's where Metatron comes in!
@@ -120,7 +120,8 @@ As Metatron is a tool for creating Ruby projects, you'll need a few prerequistes
 $ git init blog_controller && cd blog_controller
 ```
 
-We'll need a `Gemfile` to ensure we have Metatron installed:
+We'll need a `Gemfile` to ensure we have installed both Metatron and a
+[`rack`][] compatible server:
 
 ```ruby
 # frozen_string_literal: true
@@ -128,9 +129,12 @@ We'll need a `Gemfile` to ensure we have Metatron installed:
 source "https://rubygems.org"
 
 gem "metatron"
+gem "puma"
 ```
 
-We'll also need a `config.ru` file to instruct [`rack`](https://github.com/rack/rack) how to route requests:
+[`rack`]: https://github.com/rack/rack
+
+We'll also need a `config.ru` file to instruct [`rack`][] how to route requests:
 
 ```ruby
 # frozen_string_literal: true
@@ -138,7 +142,7 @@ We'll also need a `config.ru` file to instruct [`rack`](https://github.com/rack/
 # \ -s puma
 
 require "metatron"
-require_relative "./lib/blog_controller/sync"
+require_relative "./lib/blog_controller/composite_controller"
 
 use Rack::ShowExceptions
 use Rack::Deflater
@@ -147,7 +151,7 @@ mappings = {
   # This one is built-in to Metatron and is useful for monitoring
   "/ping" => Metatron::Controllers::Ping.new,
   # We'll need to make this one
-  "/sync" => BlogController::Sync.new
+  "/blogs" => BlogController::CompositeController.new
 }
 
 run Rack::URLMap.new(mappings)
@@ -177,13 +181,13 @@ ENTRYPOINT ["bundle", "exec"]
 CMD ["puma"]
 ```
 
-*Phew*, ok, with all that out of the way, we can get started with our development. We'll need to create a `Metatron::SyncController` subclass with a `sync` method. We'll put this in `lib/blog_controller/sync.rb`:
+*Phew*, ok, with all that out of the way, we can get started with our development. We'll need to create a `Metatron::CompositeController` subclass with a `sync` method. We'll put this in `lib/blog_controller/composite_controller.rb`:
 
 ```ruby
 # frozen_string_literal: true
 
 module BlogController
-  class Sync < Metatron::SyncController
+  class CompositeController < Metatron::CompositeController
     # This method needs to return a Hash which will be converted to JSON
     # It should have the keys "status" (a Hash) and "children" (an Array)
     def sync
@@ -326,7 +330,7 @@ Try POSTing a request via `curl` and inspecting the JSON response to see what yo
 $ curl \
   -H "Content-Type: application/json" \
   --data '{"parent": {"metadata": {"name": "foo"}, "spec": {"replicas": 1, "image": "nginx:latest"}}}' \
-  http://localhost:9292/sync
+  http://localhost:9292/blogs/sync
 ```
 
 Once we've confirmed this works, we'll need to publish our image somewhere and run it. Make sure you update the Service details in `blog-controller.yaml` to reflect its actual location.

data/Rakefile

@@ -16,4 +16,36 @@ task :demo do
   system("rackup --host 0.0.0.0 -P #{File.expand_path(".")}/tmp/daemon.pid")
 end
 
+desc "automatically bump the gem's version"
+task :bump, [:type] do |_t, args|
+  type = args[:type] || ENV["TYPE"] || "patch"
+  current_version = Metatron::VERSION
+  new_version = calculate_new_version(type)
+  puts "Bumping gem version from #{current_version} to #{new_version}"
+  update_version(new_version)
+end
+
 task default: %i[spec rubocop yard]
+
+def calculate_new_version(type)
+  version = Metatron::VERSION.split(".").map(&:to_i)
+  case type
+  when "patch"
+    version[2] += 1
+  when "minor"
+    version[1] += 1
+    version[2] = 0
+  when "major"
+    version[0] += 1
+    version[1] = 0
+    version[2] = 0
+  end
+
+  version.join(".")
+end
+
+def update_version(new_version)
+  file = File.read("lib/metatron/version.rb")
+  new_contents = file.gsub(/VERSION = "(.+)"/, %(VERSION = "#{new_version}"))
+  File.write("lib/metatron/version.rb", new_contents)
+end

data/lib/metatron/composite_controller.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Metatron
+  # Implementes a Metacontroller CompositeController
+  # @see https://metacontroller.github.io/metacontroller/api/compositecontroller.html
+  class CompositeController < Controller
+    options "/sync" do
+      headers "Access-Control-Allow-Methods" => ["POST"]
+      halt 200
+    end
+
+    post "/sync" do
+      if (provided_etag = calculate_sync_etag)
+        etag provided_etag
+      end
+
+      data = sync
+      data[:children] = data[:children]&.map { |c| c.respond_to?(:render) ? c.render : c }
+      halt(data.to_json)
+    end
+
+    options "/finalize" do
+      headers "Access-Control-Allow-Methods" => ["POST"]
+      halt 200
+    end
+
+    post "/finalize" do
+      # finalize calls should be rare and unique enough that we don't need to worry about ETags
+
+      data = finalize
+      data[:children] = data[:children]&.map { |c| c.respond_to?(:render) ? c.render : c }
+      halt(data.to_json)
+    end
+
+    options "/customize" do
+      headers "Access-Control-Allow-Methods" => ["POST"]
+      halt 200
+    end
+
+    post "/customize" do
+      if (provided_etag = calculate_customize_etag)
+        etag provided_etag
+      end
+
+      halt(customize.to_json)
+    end
+
+    def calculate_customize_etag = nil
+    def calculate_sync_etag = nil
+    def customize = raise NotImplementedError
+    def finalize = raise NotImplementedError
+    def sync = raise NotImplementedError
+  end
+end

data/lib/metatron/version.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
 module Metatron
-  VERSION = [
-    0, # major
-    4, # minor
-    2  # patch
-  ].join(".")
+  VERSION = "0.5.0"
 end

data/lib/metatron.rb

@@ -46,6 +46,6 @@ require "metatron/templates/service"
 require "metatron/templates/service_account"
 require "metatron/templates/stateful_set"
 require "metatron/controller"
-require "metatron/sync_controller"
+require "metatron/composite_controller"
 require "metatron/controllers/ping"
 require "metatron/railtie" if defined? Rails::Railtie

data/metatron.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 3.1"
 
   spec.add_runtime_dependency "json",                 "~> 2.6"
-  spec.add_runtime_dependency "puma",                 "~> 6.3"
   spec.add_runtime_dependency "sinatra",              "~> 3.1"
   spec.add_runtime_dependency "sinatra-contrib",      "~> 3.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metatron
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2023-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.3'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -246,6 +232,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -253,10 +241,10 @@ files:
 - Rakefile
 - bin/console
 - lib/metatron.rb
+- lib/metatron/composite_controller.rb
 - lib/metatron/controller.rb
 - lib/metatron/controllers/ping.rb
 - lib/metatron/railtie.rb
-- lib/metatron/sync_controller.rb
 - lib/metatron/template.rb
 - lib/metatron/templates/cluster_role.rb
 - lib/metatron/templates/cluster_role_binding.rb

data/lib/metatron/sync_controller.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metatron
-  # Used for "normal" sync requests
-  class SyncController < Controller
-    options "/" do
-      headers "Access-Control-Allow-Methods" => ["POST"]
-      halt 200
-    end
-
-    post "/" do
-      if (provided_etag = calculate_etag)
-        etag provided_etag
-      end
-
-      data = sync
-      data[:children] = data[:children]&.map { |c| c.respond_to?(:render) ? c.render : c }
-      halt(data.to_json)
-    end
-
-    def calculate_etag = nil
-    def sync = raise NotImplementedError
-  end
-end