k8s-ruby 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fdbe69914558d8944b6191c2e53d7a73adf63ea0308bc8d403c1cdad1198f2a
-  data.tar.gz: 4cee76de1d1d119e89d003212025ee7d8d19ede51147980507d84e00ab941bfe
+  metadata.gz: 183bba7baad8957f70d6253e8e5bd85860da8b778555bc295a8343e9f585daa4
+  data.tar.gz: f20f5d31b7c89ad06b36d9c02da854f4821c6579f2fb21d6949d11ab98b3d06b
 SHA512:
-  metadata.gz: 278b48069ea325e39569f3861a845678e4fa76bf32ee85858ebe358a701c5a26712edb8e167beeec9c2f0601f6e701c5e48ea7273abffd5e6eac932432d7c1a3
-  data.tar.gz: 17a80bd59d27a6884ed311500da3a80432ffaa6bf365fb8a56b9ebd948590fa164a82a08f12e9001d6c35c6d2d54b3aeee05e8621e028fa642e992eb9d0f3a87
+  metadata.gz: a011892aa7043af43eafabb831b43b446786011187cbbbea10f122ed3b20b7d441d4e32f12d442c414df4488c497f708bf5b428c3d9cefff980c634fee58260d
+  data.tar.gz: 13b2d5f77b68c1702a27e8c22fff41e39d27854892b18455146b91c0d296b358fa5569573f8ca15e7fd02cc39e257d4d22320fa224a72255adf1b706d09481d0

data/.github/workflows/tests.yml

@@ -10,41 +10,48 @@ jobs:
   build-2-6:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - run: docker-compose build rspec-2.6
-      - run: docker-compose run rspec-2.6
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-2.6
+      - run: docker compose run rspec-2.6
 
   build-2-7:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - run: docker-compose build rspec-2.7
-      - run: docker-compose run rspec-2.7
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-2.7
+      - run: docker compose run rspec-2.7
 
   build-3-0:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - run: docker-compose build rspec-3.0
-      - run: docker-compose run rspec-3.0
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-3.0
+      - run: docker compose run rspec-3.0
 
   build-3-1:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - run: docker-compose build rspec-3.1
-      - run: docker-compose run rspec-3.1
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-3.1
+      - run: docker compose run rspec-3.1
 
   build-3-2:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - run: docker-compose build rspec-3.2
-      - run: docker-compose run rspec-3.2
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-3.2
+      - run: docker compose run rspec-3.2
 
   build-3-3:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - run: docker-compose build rspec-3.3
-      - run: docker-compose run rspec-3.3
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-3.3
+      - run: docker compose run rspec-3.3
+
+  build-3-4:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: docker compose build rspec-3.4
+      - run: docker compose run rspec-3.4

data/.gitignore

@@ -10,6 +10,7 @@
 .ruby-version
 .tool-versions
 /.byebug_history
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/Gemfile

@@ -2,7 +2,5 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-#  forked and upgraded to be compatible with ruby 3.1
-gem 'yaml-safe_load_stream3', '~> 0.1.2'
 # Specify your gem's dependencies in k8s-ruby.gemspec
 gemspec

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.17.0

data/docker-compose.yaml

@@ -43,3 +43,12 @@ services:
     volumes:
       - .:/app
     entrypoint: bundle exec rspec
+  rspec-3.4:
+    build:
+      context: .
+      args:
+        BASE_IMAGE: ruby:3.4
+    volumes:
+      - .:/app
+    entrypoint: bundle exec rspec
+

data/k8s-ruby.gemspec

@@ -21,22 +21,26 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = []
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = [">= 2.4", "< 3.4"]
+  spec.required_ruby_version = ">= 2.4"
 
   spec.add_runtime_dependency "excon", "~> 0.71"
   spec.add_runtime_dependency "dry-struct"
   spec.add_runtime_dependency "dry-types"
   spec.add_runtime_dependency "dry-configurable"
-  spec.add_runtime_dependency "recursive-open-struct", "~> 1.1.3"
-  spec.add_runtime_dependency "hashdiff", "~> 1.0.0"
+  spec.add_runtime_dependency "recursive-open-struct", "~> 1.1", ">= 1.1.3"
+  spec.add_runtime_dependency "hashdiff", "~> 1.0"
   spec.add_runtime_dependency "jsonpath", "~> 1.1"
-  spec.add_runtime_dependency "yajl-ruby", "~> 1.4.0"
+  spec.add_runtime_dependency "yajl-ruby", "~> 1.4"
   spec.add_runtime_dependency "yaml-safe_load_stream3"
+  spec.add_runtime_dependency "base64"
+  spec.add_runtime_dependency "eventmachine", "~> 1.2"
+  spec.add_runtime_dependency "faye-websocket", "~> 0.11"
+  spec.add_runtime_dependency "ruby-termios", "~> 1.1"
 
   spec.add_development_dependency "bundler", ">= 1.17", "< 3.0"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.7"
-  spec.add_development_dependency "webmock", "~> 3.6.2"
+  spec.add_development_dependency "webmock", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 0.82"
   spec.add_development_dependency "byebug", "~> 11.1"
 end

data/lib/k8s/resource_client/exec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module K8s
+  class ResourceClient
+    module Exec
+      def self.included(base)
+        base.include(InstanceMethods)
+        base.include(Logging)
+      end
+
+      module InstanceMethods
+        require "eventmachine"
+        require "faye/websocket"
+        require "termios"
+        require "tempfile"
+
+        # Executes arbitrary commands in a container.
+        #
+        # @param name [String] name of the pod
+        # @param namespace [String]
+        # @param container [String] name of the container to execute the command in
+        # @param command [Array<String>|String] command to execute. It accepts a single string or an array of strings if multiple arguments are needed.
+        # @param stdin [Boolean] whether to stream stdin to the container
+        # @param stdout [Boolean] whether to stream stdout from the container
+        # @param tty [Boolean] whether to allocate a tty for the container
+        # @yield [String] Optional block to yield the output of the command
+        # @return [String, nil] output of the command. It returns nil if a block is given or tty is true.
+        #
+        # @example
+        #   client.api('v1').resource('pods', namespace: 'default').exec(
+        #     name: 'test-pod',
+        #     container: 'shell',
+        #     command: '/bin/sh'
+        #   )
+        # @example Open a shell:
+        #   exec(name: 'my-pod', container: 'my-container', command: '/bin/sh')
+        # @example Execute single command:
+        #   exec(name: 'my-pod', container: 'my-container', command: 'date')
+        # @example Pass multiple arguments:
+        #   exec(name: 'my-pod', container: 'my-container', command: ['ls', '-la'])
+        # @example Yield the output of the command:
+        #  exec(
+        #    name: "test-pod",
+        #    container: "shell",
+        #    command: [ "watch", "date" ],
+        #  ) do |out|
+        #    puts "local time #{Time.now}"
+        #    puts "server time #{out}"
+        #  end
+        def exec(name:, namespace: @namespace, command:, container:, stdin: true, stdout: true, tty: true)
+          query = {
+            command: [command].flatten,
+            container: container,
+            stdin: !!stdin,
+            stdout: !!stdout,
+            tty: !!tty
+          }
+
+          exec_path = path(name, namespace: namespace, subresource: "exec")
+          output = StringIO.new
+
+          EM.run do
+            ws = @transport.build_ws_conn(exec_path, query)
+
+            ws.on :message do |event|
+              out = event.data.pack("C*")
+
+              if block_given?
+                yield(out)
+              elsif tty
+                print out
+              else
+                output.write(out)
+              end
+            end
+
+            ws.on :error do |event|
+              logger.error(event.message)
+            end
+
+            term_attributes_original = Termios.tcgetattr($stdin)
+            if tty
+              term_attributes = term_attributes_original.dup
+              term_attributes.lflag &= ~Termios::ECHO
+              term_attributes.lflag &= ~Termios::ICANON
+              Termios.tcsetattr($stdin, Termios::TCSANOW, term_attributes)
+
+              EM.open_keyboard(Module.new do
+                define_method(:receive_data) do |input|
+                  input = [0] + input.unpack("C*")
+                  ws.send(input)
+                end
+              end)
+            end
+
+            ws.on :close do
+              Termios.tcsetattr($stdin, Termios::TCSANOW, term_attributes_original)
+              EM.stop
+            end
+          end
+
+          return if tty
+
+          output.rewind
+          output.read
+        end
+      end
+    end
+  end
+end

data/lib/k8s/resource_client.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "resource_client/exec"
+
 module K8s
   # Per-APIResource type client.
   #
   # Used to get/list/update/patch/delete specific types of resources, optionally in some specific namespace.
+  #
   class ResourceClient
     # Common helpers used in both class/instance methods
     module Utils
@@ -36,6 +39,9 @@ module K8s
     include Utils
     extend Utils
 
+    # @!parse include K8s::ResourceClient::Exec
+    include Exec
+
     # Pipeline list requests for multiple resource types.
     #
     # Returns flattened array with mixed resource kinds.

data/lib/k8s/ruby/version.rb

@@ -3,6 +3,6 @@
 module K8s
   class Ruby
     # Updated on releases using semver.
-    VERSION = "0.16.0"
+    VERSION = "0.17.0"
   end
 end

data/lib/k8s/transport.rb

@@ -388,5 +388,50 @@ module K8s
         **options
       )
     end
+
+    # Returns a websocket connection using part of the current transport configuration.
+    # Will use same host and port returned by #server.
+    # @param resource_path [String]
+    # @param query [Hash]
+    # @return [Faye::WebSocket::Client]
+    def build_ws_conn(resource_path, query = {})
+      private_key_file = nil
+      cert_chain_file = nil
+
+      on_open_callbacks = []
+
+      if options[:client_cert] && options[:client_key]
+        private_key_file = options[:client_key]
+        cert_chain_file = options[:client_cert]
+      elsif options[:client_cert_data] && options[:client_key_data]
+        temp_file_path_from_data = lambda do |data|
+          temp_file = Tempfile.new
+          temp_file.write(data)
+          temp_file.close
+          on_open_callbacks << -> { temp_file.unlink }
+          temp_file.path
+        end
+        private_key_file = temp_file_path_from_data.call(options[:client_key_data])
+        cert_chain_file = temp_file_path_from_data.call(options[:client_cert_data])
+      end
+
+      url = server.gsub("http", "ws") +
+            resource_path +
+            Excon::Utils.query_string(query: query)
+
+      ws = Faye::WebSocket::Client.new(
+        url,
+        [],
+        headers: request_options[:headers],
+        tls: {
+          verify_peer: !!options[:ssl_verify_peer],
+          private_key_file: private_key_file,
+          cert_chain_file: cert_chain_file
+        }
+      )
+
+      ws.on(:open) { on_open_callbacks.each(&:call) }
+      ws
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k8s-ruby
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - rdx.net
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -72,6 +72,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
@@ -79,6 +82,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.3
 - !ruby/object:Gem::Dependency
@@ -87,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +121,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: yaml-safe_load_stream3
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +143,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  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'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: ruby-termios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -191,14 +253,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.2
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.2
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +329,7 @@ files:
 - lib/k8s/logging.rb
 - lib/k8s/resource.rb
 - lib/k8s/resource_client.rb
+- lib/k8s/resource_client/exec.rb
 - lib/k8s/ruby/version.rb
 - lib/k8s/stack.rb
 - lib/k8s/transport.rb
@@ -284,16 +347,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.4'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Kubernetes client library for Ruby