kubeclient 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGQ5MGYzNzY1NzNiZGYyYTVkN2JjNmM3ZTIxNDNjMDc4ZjEwYTNkYQ==
-  data.tar.gz: !binary |-
-    MDkzZTkyYzhlNzViMDdiYmFlMjRjNTM4YmRkNjViYWYyNTZjNzNmMA==
+SHA1:
+  metadata.gz: ae09dbbbec4a787210bc1a0da2e5a7d9c832bf5d
+  data.tar.gz: 97bf049dda0f6e3cc60c485349ea2da2540aa806
 SHA512:
-  metadata.gz: !binary |-
-    MzcwYjI4NTFkMTFlOTMyMDljYTAzYWFhNTI4ZGMwNTg3ZWY5ZDY1MDgxNjBh
-    ZjZhNmM0ZmIwYWM5NDVkZjA3MzAyNjNhNDkwY2RhYmJmMTc2ZGY5OGM5NjQ1
-    ZjJiODA4ODg3YjZiOTIzODU2YzgxMjgxM2M0YmY1ZmY1YjgyZmM=
-  data.tar.gz: !binary |-
-    ZmFjNzNjYTc3OGUwYWU1NGRmNzRhNjIxOWZjMmVkZTVhZDAzYzg1YTI3MjZl
-    ZTRkNTcxYTk4N2RmOWQyMDhhMjYzZGZhZWY3N2IyNzIwYTZiYzVkMmU5ZjU0
-    YzhkOGFjYTk2ZjE5MzFlYTlhYmRkYzkwYTYyOWZiM2UwOGQ5YTI=
+  metadata.gz: fdd7085f59fad729afc1641dc61dc78c82b989bd02f8bd1dbebdbd27cd0e63c9cf644b7fd1df54e411d89e830d99bc596bae6cc66be82720dd8b058edece836b
+  data.tar.gz: ddb87120503b364ca0e79eb84a1e9baeb52cccb3850b5ea134e0555cc840c828f8093374ea6fe8bb97e4936b50781848c560954da114531a07c63c011e7291f6

data/.rubocop.yml

@@ -0,0 +1,6 @@
+MethodLength:
+  Enabled: false
+ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/README.md

@@ -74,6 +74,13 @@ The below example is for v1beta1 <br>
  is a convenience method instead of calling each entity's get method separately. <br>
 `client.get_all_entities`
 
+7. Receive entity updates <br>
+It is possible to receive live update notices watching the relevant entities:
+<br>
+`client.watch_pods.each do |notice|` <br>
+`  # process notice data` <br>
+`end` <br>
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/kubeclient/fork )

data/Rakefile

@@ -1,7 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
-task :default => :test
+task default: :test
 task :test do
-  Dir.glob('./test/*_test.rb').each { |file| require file}
+  Dir.glob('./test/*_test.rb').each { |file| require file }
 end
+
+RuboCop::RakeTask.new

data/kubeclient.gemspec

@@ -4,27 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'kubeclient/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "kubeclient"
+  spec.name          = 'kubeclient'
   spec.version       = Kubeclient::VERSION
-  spec.authors       = ["Alissa Bonas"]
-  spec.email         = ["abonas@redhat.com"]
-  spec.summary       = %q{A client for Kubernetes REST api}
-  spec.description   = "A client for Kubernetes REST api"
-  spec.homepage      = "https://github.com/abonas/kubeclient"
-  spec.license       = "MIT"
+  spec.authors       = ['Alissa Bonas']
+  spec.email         = ['abonas@redhat.com']
+  spec.summary       = 'A client for Kubernetes REST api'
+  spec.description   = 'A client for Kubernetes REST api'
+  spec.homepage      = 'https://github.com/abonas/kubeclient'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop'
   spec.add_dependency 'rest-client'
   spec.add_dependency 'activesupport'
   spec.add_dependency 'json'
   spec.add_dependency 'recursive-open-struct'
-
 end

data/lib/kubeclient/entity_list.rb

@@ -1,10 +1,11 @@
+# Kubernetes Entity List
 class EntityList < Array
   attr_reader :kind, :resourceVersion
 
-  def initialize(kind,resource_version)
+  def initialize(kind, resource_version)
     @kind = kind
+    # rubocop:disable Style/VariableName
     @resourceVersion = resource_version
     super()
   end
-
-end
+end

data/lib/kubeclient/event.rb

@@ -0,0 +1,4 @@
+require 'recursive_open_struct'
+
+class Event <  RecursiveOpenStruct
+end

data/lib/kubeclient/kube_exception.rb

@@ -1,3 +1,4 @@
+# Kubernetes HTTP Exceptions
 class KubeException < Exception
   attr_reader :error_code, :message
 
@@ -7,7 +8,6 @@ class KubeException < Exception
   end
 
   def to_s
-    "HTTP status code " + @error_code.to_s + ", " + @message
+    'HTTP status code ' + @error_code.to_s + ', ' + @message
   end
-
-end
+end

data/lib/kubeclient/node.rb

@@ -1,4 +1,4 @@
 require 'recursive_open_struct'
-class Node <  RecursiveOpenStruct
 
-end
+class Node <  RecursiveOpenStruct
+end

data/lib/kubeclient/pod.rb

@@ -1,4 +1,4 @@
 require 'recursive_open_struct'
-class Pod < RecursiveOpenStruct
 
+class Pod < RecursiveOpenStruct
 end

data/lib/kubeclient/replication_controller.rb

@@ -1,4 +1,4 @@
 require 'recursive_open_struct'
-class ReplicationController <  RecursiveOpenStruct
 
-end
+class ReplicationController <  RecursiveOpenStruct
+end

data/lib/kubeclient/service.rb

@@ -1,5 +1,4 @@
 require 'recursive_open_struct'
 
 class Service  < RecursiveOpenStruct
-
 end

data/lib/kubeclient/version.rb

@@ -1,3 +1,4 @@
+# Kubernetes REST-API Client
 module Kubeclient
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/kubeclient/watch.rb

@@ -0,0 +1,4 @@
+require 'recursive_open_struct'
+
+class WatchNotice <  RecursiveOpenStruct
+end

data/lib/kubeclient/watch_stream.rb

@@ -0,0 +1,29 @@
+require 'json'
+require 'net/http'
+
+module Kubeclient
+  # HTTP Stream used to watch changes on entities
+  class WatchStream
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def each
+      buffer = ''
+      Net::HTTP.start(@uri.host, @uri.port) do |http|
+        request = Net::HTTP::Get.new @uri
+        http.request request do |response|
+          unless response.is_a? Net::HTTPSuccess
+            fail KubeException.new(response.code, response.message)
+          end
+          response.read_body do |chunk|
+            buffer << chunk
+            while (line = buffer.slice!(/.+\n/))
+              yield WatchNotice.new(JSON.parse(line))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kubeclient.rb

@@ -2,133 +2,142 @@ require 'kubeclient/version'
 require 'json'
 require 'rest-client'
 require 'active_support/inflector'
+require 'kubeclient/event'
 require 'kubeclient/pod'
 require 'kubeclient/node'
 require 'kubeclient/service'
 require 'kubeclient/replication_controller'
 require 'kubeclient/entity_list'
 require 'kubeclient/kube_exception'
-
+require 'kubeclient/watch'
+require 'kubeclient/watch_stream'
 
 module Kubeclient
+  # Kubernetes Client
   class Client
-   attr_reader :api_endpoint
-   ENTITIES = %w(Pod Service ReplicationController Node)
-
-    def initialize(api_endpoint,version)
-      if !api_endpoint.end_with? "/"
-         api_endpoint = api_endpoint + "/"
-      end
-      @api_endpoint = api_endpoint+version
-      #version flag is needed to take care of the differences between versions
+    attr_reader :api_endpoint
+    ENTITIES = %w(Pod Service ReplicationController Node Event)
+
+    def initialize(api_endpoint, version)
+      api_endpoint += '/' unless api_endpoint.end_with? '/'
+      @api_endpoint = api_endpoint + version
+      # version flag is needed to take care of the differences between
+      # versions
       @api_version = version
     end
 
     private
+
     def rest_client
-      #todo should a new one be created for every request?
+      # TODO: should a new one be created for every request?
       RestClient::Resource.new(@api_endpoint)
     end
 
+    def handling_kube_exception
+      yield
+    rescue RestClient::Exception => e
+      raise KubeException.new(e.http_code, JSON.parse(e.response)['message'])
+    end
+
     protected
+
     def create_entity(hash, entity)
       entity.classify.constantize.new(hash)
     end
 
     def get_resource_name(entity)
-      if @api_version == "v1beta1"
-        entity_name = entity.pluralize.camelize(:lower)
+      if @api_version == 'v1beta1'
+        entity.pluralize.camelize(:lower)
       else
-        entity_name = entity.pluralize.downcase
+        entity.pluralize.downcase
       end
-      entity_name
     end
 
+    ENTITIES.each do |entity|
+      # get all entities of a type e.g. get_nodes, get_pods, etc.
+      define_method("get_#{entity.underscore.pluralize}") do
+        # TODO: labels support
+        # TODO: namespace support?
+        response = handling_kube_exception do
+          rest_client[get_resource_name(entity)].get # nil, labels
+        end
 
-    public
-
-   ENTITIES.each do |entity|
-
-     #get all entities of a type e.g. get_nodes, get_pods, etc.
-     define_method("get_#{entity.underscore.pluralize}") do |labels=nil|
-       #todo labels support
-       #todo namespace support?
-       begin
-         response = rest_client[get_resource_name(entity)].get # nil, labels
-       rescue  RestClient::Exception => e
-         exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
-         raise exception
-       end
         result = JSON.parse(response)
-        if @api_version == "v1beta1"
-          collection = EntityList.new(entity,result["resourceVersion"])
-        else
-          collection = EntityList.new(entity,result["metadata"]["resourceVersion"])
+
+        resourceVersion = result.fetch('resourceVersion', nil)
+        if resourceVersion.nil?
+          resourceVersion = result.fetch('metadata', {})
+                                  .fetch('resourceVersion', nil)
+        end
+
+        collection = EntityList.new(entity, resourceVersion)
+
+        result['items'].each do |item|
+          collection.push(create_entity(item, entity))
         end
-        result["items"].each { |item | collection.push(create_entity(item, entity))  }
+
         collection
-     end
-
-     #get a single entity of a specific type by id
-     define_method("get_#{entity.underscore}") do |id|
-       begin
-         response = rest_client[get_resource_name(entity)+"/#{id}"].get
-       rescue  RestClient::Exception => e
-         exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
-         raise exception
-       end
-         result = JSON.parse(response)
-         create_entity(result, entity)
-     end
-
-     define_method("delete_#{entity.underscore}") do |id|
-       begin
-         rest_client[get_resource_name(entity)+"/" +id].delete
-       rescue  RestClient::Exception => e
-         exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
-         raise exception
-       end
-
-     end
-
-     define_method("create_#{entity.underscore}") do |entity_config|
-       #to_hash should be called because of issue #9 in recursive open struct
-       hash = entity_config.to_hash
-       begin
-         rest_client[get_resource_name(entity)].post(hash.to_json)
-       rescue  RestClient::Exception => e
-         exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
-         raise exception
-       end
-     end
-
-     define_method("update_#{entity.underscore}") do |entity_config|
-       id = entity_config.id
-       #to_hash should be called because of issue #9 in recursive open struct
-       hash = entity_config.to_hash
-       #temporary solution to delete id till this issue is solved: https://github.com/GoogleCloudPlatform/kubernetes/issues/3085
-       hash.delete(:id)
-       begin
-         rest_client[get_resource_name(entity)+"/#{id}"].put(hash.to_json)
-       rescue  RestClient::Exception => e
-         exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
-         raise exception
-       end
-     end
-
-   end
-
-   public
-   def get_all_entities
-      result_hash = {}
-      ENTITIES.each do |entity|
+      end
+
+      # watch all entities of a type e.g. watch_nodes, watch_pods, etc.
+      define_method("watch_#{entity.underscore.pluralize}") \
+          do |resourceVersion = nil|
+        uri = URI.parse(api_endpoint + '/watch/' + get_resource_name(entity))
+        uri.query = URI.encode_www_form(
+          'resourceVersion' => resourceVersion) unless resourceVersion.nil?
+        WatchStream.new(uri).to_enum
+      end
+
+      # get a single entity of a specific type by id
+      define_method("get_#{entity.underscore}") do |id|
+        response = handling_kube_exception do
+          rest_client[get_resource_name(entity) + "/#{id}"].get
+        end
+        result = JSON.parse(response)
+        create_entity(result, entity)
+      end
+
+      define_method("delete_#{entity.underscore}") do |id|
+        handling_kube_exception do
+          rest_client[get_resource_name(entity) + "/#{id}"].delete
+        end
+      end
+
+      define_method("create_#{entity.underscore}") do |entity_config|
+        # to_hash should be called because of issue #9 in recursive open
+        # struct
+        hash = entity_config.to_hash
+        handling_kube_exception do
+          rest_client[get_resource_name(entity)].post(hash.to_json)
+        end
+      end
+
+      define_method("update_#{entity.underscore}") do |entity_config|
+        id = entity_config.id
+        # to_hash should be called because of issue #9 in recursive open
+        # struct
+        hash = entity_config.to_hash
+        # TODO: temporary solution to delete id till this issue is solved
+        # https://github.com/GoogleCloudPlatform/kubernetes/issues/3085
+        hash.delete(:id)
+        handling_kube_exception do
+          rest_client[get_resource_name(entity) + "/#{id}"].put(hash.to_json)
+        end
+      end
+    end
+
+    public
+
+    # FIXME: fix the accessor names
+    # rubocop:disable Style/AccessorMethodName
+    def get_all_entities
+      ENTITIES.each_with_object({}) do |entity, result_hash|
         # method call for get each entities
         # build hash of entity name to array of the entities
         method_name = "get_#{entity.underscore.pluralize}"
         key_name = entity.underscore
         result_hash[key_name] = send(method_name)
       end
-     result_hash
     end
   end
 end