k8s-client 0.4.2 → 0.5.0

data/k8s-client.gemspec

@@ -28,9 +28,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "deep_merge", "~> 1.2.1"
   spec.add_runtime_dependency "recursive-open-struct", "~> 1.1.0"
   spec.add_runtime_dependency 'hashdiff', '~> 0.3.7'
+  spec.add_runtime_dependency 'jsonpath', '~> 0.9.5'
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "webmock", "~> 3.4.2"
+  spec.add_development_dependency "rubocop", "~> 0.59"
 end

data/lib/k8s-client.rb

@@ -1,17 +1,3 @@
-# Kubernetes client library
-module K8s
-  require 'k8s/api/metav1'
-  require 'k8s/api/version'
+# frozen_string_literal: true
 
-  require 'k8s/config'
-  require 'k8s/logging'
-
-  require 'k8s/api_client'
-  require "k8s/client"
-  require "k8s/error"
-  require 'k8s/resource'
-  require 'k8s/resource_client'
-  require 'k8s/stack'
-  require 'k8s/transport'
-  require 'k8s/util'
-end
+require_relative 'k8s/client'

data/lib/k8s/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-types'
 require 'dry-struct'
 
@@ -17,7 +19,7 @@ module K8s
       # @param data [Hash]
       # @return [self]
       def self.from_json(data)
-        return new(data)
+        new(data)
       end
 
       # @return [String]

data/lib/k8s/api/metav1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'k8s/api'
 
 module K8s

data/lib/k8s/api/metav1/api_group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K8s
   module API
     module MetaV1

data/lib/k8s/api/metav1/api_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K8s
   module API
     module MetaV1

data/lib/k8s/api/metav1/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K8s
   module API
     module MetaV1

data/lib/k8s/api/metav1/object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'k8s/api/metav1/status'
 
 module K8s

data/lib/k8s/api/metav1/status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K8s
   module API
     module MetaV1

data/lib/k8s/api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K8s
   module API
     # GET /version

data/lib/k8s/api_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K8s
   # Per-APIGroup/version client.
   #
@@ -11,7 +13,6 @@ module K8s
       else
         File.join('/api', api_version)
       end
-
     end
 
     # @param transport [K8s::Transport]
@@ -22,9 +23,7 @@ module K8s
     end
 
     # @return [String]
-    def api_version
-      @api_version
-    end
+    attr_reader :api_version
 
     # @param path [Array<String>] join path from parts
     # @return [String]
@@ -38,17 +37,14 @@ module K8s
     end
 
     # @param api_resources [Array<K8s::API::MetaV1::APIResource>]
-    def api_resources=(api_resources)
-      @api_resources = api_resources
-    end
+    attr_writer :api_resources
 
     # Force-update APIResources
     #
     # @return [Array<K8s::API::MetaV1::APIResource>]
     def api_resources!
-      @api_resources = @transport.get(self.path,
-        response_class: K8s::API::MetaV1::APIResourceList,
-      ).resources
+      @api_resources = @transport.get(path,
+                                      response_class: K8s::API::MetaV1::APIResourceList).resources
     end
 
     # Cached APIResources
@@ -58,18 +54,20 @@ module K8s
       @api_resources || api_resources!
     end
 
+    # @param resource_name [String]
+    def find_api_resource(resource_name)
+      found_resource = api_resources.find{ |api_resource| api_resource.name == resource_name }
+      raise K8s::Error::UndefinedResource, "Unknown resource #{resource_name} for #{@api_version}" unless found_resource
+
+      found_resource
+    end
+
     # @param resource_name [String]
     # @param namespace [String, nil]
     # @raise [K8s::Error] unknown resource
     # @return [K8s::ResourceClient]
     def resource(resource_name, namespace: nil)
-      unless api_resource = api_resources.find{ |api_resource| api_resource.name == resource_name }
-        raise K8s::Error::UndefinedResource, "Unknown resource #{resource_name} for #{@api_version}"
-      end
-
-      ResourceClient.new(@transport, self, api_resource,
-        namespace: namespace,
-      )
+      ResourceClient.new(@transport, self, find_api_resource(resource_name), namespace: namespace)
     end
 
     # @param resource [K8s::Resource]
@@ -82,13 +80,11 @@ module K8s
         raise K8s::Error::UndefinedResource, "Invalid apiVersion=#{resource.apiVersion} for #{@api_version} client"
       end
 
-      unless api_resource = api_resources.find{ |api_resource| api_resource.kind == resource.kind }
-        raise K8s::Error::UndefinedResource, "Unknown resource kind=#{resource.kind} for #{@api_version}"
-      end
+      found_resource = api_resources.find{ |api_resource| api_resource.kind == resource.kind }
+      raise K8s::Error::UndefinedResource, "Unknown resource kind=#{resource.kind} for #{@api_version}" unless found_resource
 
-      ResourceClient.new(@transport, self, api_resource,
-        namespace: resource.metadata.namespace || namespace,
-      )
+      ResourceClient.new(@transport, self, found_resource,
+                         namespace: resource.metadata.namespace || namespace)
     end
 
     # TODO: skip non-namespaced resources if namespace is given, or ignore namespace?
@@ -96,9 +92,10 @@ module K8s
     # @param namespace [String, nil]
     # @return [Array<K8s::ResourceClient>]
     def resources(namespace: nil)
-      api_resources.map{ |api_resource| ResourceClient.new(@transport, self, api_resource,
-        namespace: namespace,
-      ) }
+      api_resources.map{ |api_resource|
+        ResourceClient.new(@transport, self, api_resource,
+                           namespace: namespace)
+      }
     end
 
     # Pipeline list requests for multiple resource types.
@@ -109,9 +106,9 @@ module K8s
     # @param options @see [K8s::ResourceClient#list]
     # @return [Array<K8s::Resource>]
     def list_resources(resources = nil, **options)
-      resources ||= self.resources.select{|resource| resource.list? }
+      resources ||= self.resources.select(&:list?)
 
-      ResourceClient.list(resource, @transport, **options)
+      ResourceClient.list(resources, @transport, **options)
     end
   end
 end

data/lib/k8s/client.rb

@@ -1,6 +1,22 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'base64'
 
+require 'k8s/api/metav1'
+require 'k8s/api/version'
+
+require 'k8s/config'
+require 'k8s/logging'
+
+require 'k8s/api_client'
+require "k8s/error"
+require 'k8s/resource'
+require 'k8s/resource_client'
+require 'k8s/stack'
+require 'k8s/transport'
+require 'k8s/util'
+
 module K8s
   # @param server [String] http/s URL
   # @param options [Hash] @see Transport.new
@@ -18,8 +34,9 @@ module K8s
     # @param options [Hash] @see Transport.config
     # @return [K8s::Client]
     def self.config(config, namespace: nil, **options)
-      new(Transport.config(config, **options),
-        namespace: namespace,
+      new(
+        Transport.config(config, **options),
+        namespace: namespace
       )
     end
 
@@ -40,8 +57,9 @@ module K8s
     # @raise [K8s::Error]
     # @return [K8s::API::Version]
     def version
-      @transport.get('/version',
-        response_class: K8s::API::Version,
+      @transport.get(
+        '/version',
+        response_class: K8s::API::Version
       )
     end
 
@@ -56,9 +74,10 @@ module K8s
     #
     # @return [Array<String>]
     def api_groups!
-      @api_groups = @transport.get('/apis',
-        response_class: K8s::API::MetaV1::APIGroupList,
-      ).groups.map{|api_group| api_group.versions.map{|api_version| api_version.groupVersion} }.flatten
+      @api_groups = @transport.get(
+        '/apis',
+        response_class: K8s::API::MetaV1::APIGroupList
+      ).groups.map{ |api_group| api_group.versions.map(&:groupVersion) }.flatten
     end
 
     # Cached /apis preferred group apiVersions
@@ -72,14 +91,14 @@ module K8s
     # @param skip_missing [Boolean] return APIClient without api_resources? if 404
     # @return [Array<APIClient>]
     def apis(api_versions = nil, prefetch_resources: false, skip_missing: false)
-      api_versions ||= ['v1'] + self.api_groups
+      api_versions ||= ['v1'] + api_groups
 
       if prefetch_resources
         # api groups that are missing their api_resources
         api_paths = api_versions
-          .uniq
-          .select{|api_version| !api(api_version).api_resources? }
-          .map{|api_version| APIClient.path(api_version) }
+                    .uniq
+                    .reject{ |api_version| api(api_version).api_resources? }
+                    .map{ |api_version| APIClient.path(api_version) }
 
         # load into APIClient.api_resources=
         @transport.gets(*api_paths, response_class: K8s::API::MetaV1::APIResourceList, skip_missing: skip_missing).each do |api_resource_list|
@@ -87,7 +106,7 @@ module K8s
         end
       end
 
-      api_versions.map{|api_version| api(api_version) }
+      api_versions.map{ |api_version| api(api_version) }
     end
 
     # @param namespace [String, nil]
@@ -104,7 +123,7 @@ module K8s
     # @param options @see K8s::ResourceClient#list
     # @return [Array<K8s::Resource>]
     def list_resources(resources = nil, **options)
-      resources ||= self.resources.select{|resource| resource.list? }
+      resources ||= self.resources.select(&:list?)
 
       ResourceClient.list(resources, @transport, **options)
     end
@@ -137,7 +156,7 @@ module K8s
     # @return [Array<K8s::Resource, nil>] matching resources array 1:1
     def get_resources(resources)
       # prefetch api resources, skip missing APIs
-      resource_apis = apis(resources.map{ |resource| resource.apiVersion }, prefetch_resources: true, skip_missing: true)
+      resource_apis = apis(resources.map(&:apiVersion), prefetch_resources: true, skip_missing: true)
 
       # map each resource to excon request options, or nil if resource is not (yet) defined
       requests = resources.zip(resource_apis).map{ |resource, api_client|
@@ -148,7 +167,7 @@ module K8s
         {
           method: 'GET',
           path: resource_client.path(resource.metadata.name, namespace: resource.metadata.namespace),
-          response_class: resource_client.resource_class,
+          response_class: resource_client.resource_class
         }
       }
 

data/lib/k8s/client/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module K8s
   class Client
     # Updated on releases using semver.
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

data/lib/k8s/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-struct'
 require 'dry-types'
 require 'yaml'
@@ -11,7 +13,7 @@ module K8s
     transform_keys do |key|
       case key
       when String
-        key.gsub('-', '_').to_sym
+        key.tr('-', '_').to_sym
       else
         key
       end
@@ -20,7 +22,6 @@ module K8s
 
   # @see https://godoc.org/k8s.io/client-go/tools/clientcmd/api/v1#Config
   class Config < ConfigStruct
-
     # Common dry-types for config
     class Types
       include Dry::Types.module
@@ -41,6 +42,12 @@ module K8s
       attribute :cluster, Cluster
     end
 
+    # structured user auth provider
+    class UserAuthProvider < ConfigStruct
+      attribute :name, Types::String
+      attribute :config, Types::Strict::Hash
+    end
+
     # structured user
     class User < ConfigStruct
       attribute :client_certificate, Types::String.optional.default(nil)
@@ -54,7 +61,7 @@ module K8s
       attribute :as_user_extra, Types::Hash.optional.default(nil)
       attribute :username, Types::String.optional.default(nil)
       attribute :password, Types::String.optional.default(nil)
-      attribute :auth_provider, Types::Strict::Hash.optional.default(nil)
+      attribute :auth_provider, UserAuthProvider.optional.default(nil)
       attribute :exec, Types::Strict::Hash.optional.default(nil)
       attribute :extensions, Types::Strict::Array.optional.default(nil)
     end
@@ -93,23 +100,23 @@ module K8s
     # @param path [String]
     # @return [K8s::Config]
     def self.load_file(path)
-      return new(YAML.load_file(path))
+      new(YAML.load_file(path))
     end
 
     # TODO: raise error if not found
     # @return [K8s::Config::Context]
     def context(name = current_context)
-      contexts.find{|context| context.name == name}.context
+      contexts.find{ |context| context.name == name }.context
     end
 
     # @return [K8s::Config::Cluster]
     def cluster(name = context.cluster)
-      clusters.find{|cluster| cluster.name == name}.cluster
+      clusters.find{ |cluster| cluster.name == name }.cluster
     end
 
     # @return [K8s::Config::User]
     def user(name = context.user)
-      users.find{|user| user.name == name}.user
+      users.find{ |user| user.name == name }.user
     end
   end
 end

data/lib/k8s/error.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module K8s
   # Top-level class for all errors raised by this gem.
   class Error < StandardError
-
     # Kube API error, related to a HTTP response with a non-2xx code
     class API < Error
       extend Forwardable
@@ -30,34 +31,34 @@ module K8s
       end
     end
 
-    # specific API error subtypes for HTTP status codes
-    # Hash{Integer => Class<API>}
-    HTTP_STATUS_ERRORS = {}
-
-    # define a new API error type on the module for the given HTTP status code
-    #
-    # @param code [Integer] HTTP status code
-    # @param name [Symbol] API error class name
-    def self.define_status_error(code, name)
-      HTTP_STATUS_ERRORS[code] = self.const_set(name, Class.new(API))
-    end
+    BadRequest = Class.new(API).freeze
+    Unauthorized = Class.new(API).freeze
+    Forbidden = Class.new(API).freeze
+    NotFound = Class.new(API).freeze
+    MethodNotAllowed = Class.new(API).freeze
+    Conflict = Class.new(API).freeze # XXX: also AlreadyExists?
+    Invalid = Class.new(API).freeze
+    Timeout = Class.new(API).freeze
+    InternalError = Class.new(API).freeze
+    ServiceUnavailable = Class.new(API).freeze
+    ServerTimeout = Class.new(API).freeze
 
-    define_status_error 400, :BadRequest
-    define_status_error 401, :Unauthorized
-    define_status_error 403, :Forbidden
-    define_status_error 404, :NotFound
-    define_status_error 405, :MethodNotAllowed
-    define_status_error 409, :Conflict # XXX: also AlreadyExists?
-    define_status_error 422, :Invalid
-    define_status_error 429, :Timeout
-    define_status_error 500, :InternalError
-    define_status_error 503, :ServiceUnavailable
-    define_status_error 504, :ServerTimeout
+    HTTP_STATUS_ERRORS = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      409 => Conflict,
+      422 => Invalid,
+      429 => Timeout,
+      500 => InternalError,
+      503 => ServiceUnavailable,
+      504 => ServerTimeout
+    }.freeze
 
     # Attempt to create a ResourceClient for an unknown resource type.
     # The client cannot construct the correct API URL without having the APIResource definition.
-    class UndefinedResource < Error
-
-    end
+    UndefinedResource = Class.new(Error)
   end
 end