kubeclient 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: ca55a9d279694fdfe302e2c0ed579b0d861a4e30
-  data.tar.gz: 20451ff5f5f26f4faac84bdc25a1593fb665c275
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmJlNzRjMTMwMWM0NzU3ZjlmODZmNDZmOWVmOTcxNGJkODI1MjRiMA==
+  data.tar.gz: !binary |-
+    OWZhYTM1ZWY1ZTViOGVmMGVkYzNiZmNjZTgyYzQwMDJjMTRlNjY1Yw==
 SHA512:
-  metadata.gz: 5e881043d6da7b76e7e649af1e69c463f1c367c78329d674fc498ac6030424a7a6258940b5a0932981d2bd20812946c5511022a8946bf3049d7d0045a34f5287
-  data.tar.gz: c86dde3beaa0b4cf0418a36177586cc342cfc28fd6ad6a198ae4098efd95873d21f00dbfa64bd62243c47e1fffd916b2ad1aaf733ba58980fd4eed867487998d
+  metadata.gz: !binary |-
+    YzM5ZjNjN2M1YTllMWE3NmNlYjJhZTY0Mzg5NWJlOGE4MzMyZDUyNzk4ZDZj
+    MTIyMTE1ODZmYzExMjM5NDQ2NDc0YTEyNTcyNWU1OTFkYzMyZTQzNzRjOWNj
+    ZGI5MDM4YmVhNWM4ZjE3YmFlNDJhMjY4NmI5ZjFmODBlOTkzNDI=
+  data.tar.gz: !binary |-
+    YzU3MjViNjAxYTI3NDk1YzU4NjM1NTdjNWUxZjBiNDJlMzFhZDVmODI4NTU2
+    MTdkNDE4MmVhMzY3YTg2OGI1ODBjNzU2MDk1M2VhOGZlMjBmMmZmN2M3ZDcw
+    NzdkZTlkZmU2YTFhNmQ4Y2YzNjhkMGU0MTNmODc4OWY0ZjAzYTA=

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+sudo: false
+cache: bundler

data/README.md

@@ -1,5 +1,10 @@
 # Kubeclient
 
+[![Gem Version](https://badge.fury.io/rb/kubeclient.svg)](http://badge.fury.io/rb/kubeclient)
+[![Build Status](https://travis-ci.org/abonas/kubeclient.svg)](https://travis-ci.org/abonas/kubeclient)
+[![Code Climate](http://img.shields.io/codeclimate/github/abonas/kubeclient.svg)](https://codeclimate.com/github/abonas/kubeclient)
+[![Dependency Status](https://gemnasium.com/abonas/kubeclient.svg)](https://gemnasium.com/abonas/kubeclient)
+
 A Ruby client for Kubernetes REST api.
 The client supports GET, POST, PUT, DELETE on pods, services and replication controllers.
 Also, GET and DELETE is supported for nodes.
@@ -30,6 +35,21 @@ or for the v3:
 
 `client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"`
 
+It is also possible to use https and configure ssl with:
+
+`client = Kubeclient::Client.new 'https://localhost:8443/api/' , "v1beta3"`
+`client.ssl_options(` <br>
+`  client_cert: OpenSSL::X509::Certificate.new(File.read('/path/to/client.crt')),` <br>
+`  client_key:  OpenSSL::PKey::RSA.new(File.read('/path/to/client.key')),` <br>
+`  ca_file:     '/path/to/ca.crt', ` <br>
+`  verify_ssl:  OpenSSL::SSL::VERIFY_PEER` <br>
+`)` <br>
+
+For testing and development purpose you can disable the ssl check with:
+
+`client.ssl_options(verify_ssl: OpenSSL::SSL::VERIFY_NONE)`
+
+
 Examples:
 
 1. Get all pods (and respectively: get_services, get_nodes, get_replication_controllers)
@@ -77,9 +97,13 @@ The below example is for v1beta1 <br>
 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>
+`watcher = client.watch_pods` <br>
+`watcher.each do |notice|` <br>
 `  # process notice data` <br>
 `end` <br>
+It is possible to interrupt the watcher from another thread with:
+<br>
+`watcher.finish` <br>
 
 ## Contributing
 
@@ -95,4 +119,4 @@ This client is tested with Minitest.
 Please run all tests before submitting a Pull Request, and add new tests for new functionality.
 
 Running tests: <br>
-`rake test`
+`rake test`

data/Rakefile

@@ -2,7 +2,8 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 
-task default: :test
+task default: [:test, :rubocop]
+
 task :test do
   Dir.glob('./test/*_test.rb').each { |file| require file }
 end

data/lib/kubeclient.rb

@@ -7,6 +7,7 @@ require 'kubeclient/pod'
 require 'kubeclient/node'
 require 'kubeclient/service'
 require 'kubeclient/replication_controller'
+require 'kubeclient/endpoint'
 require 'kubeclient/entity_list'
 require 'kubeclient/kube_exception'
 require 'kubeclient/watch'
@@ -16,21 +17,29 @@ module Kubeclient
   # Kubernetes Client
   class Client
     attr_reader :api_endpoint
-    ENTITIES = %w(Pod Service ReplicationController Node Event)
+    ENTITIES = %w(Pod Service ReplicationController Node Event Endpoint)
 
-    def initialize(api_endpoint, version)
-      api_endpoint += '/' unless api_endpoint.end_with? '/'
-      @api_endpoint = api_endpoint + version
+    def initialize(uri, version)
+      @api_endpoint = (uri.is_a? URI) ? uri : URI.parse(uri)
+      @api_endpoint.merge!(File.join(@api_endpoint.path, version))
       # version flag is needed to take care of the differences between
       # versions
       @api_version = version
+      ssl_options
     end
 
     private
 
     def rest_client
+      options = {
+        ssl_ca_file:      @ssl_options[:ca_file],
+        verify_ssl:       @ssl_options[:verify_ssl],
+        ssl_client_cert:  @ssl_options[:client_cert],
+        ssl_client_key:   @ssl_options[:client_key]
+      }
+
       # TODO: should a new one be created for every request?
-      RestClient::Resource.new(@api_endpoint)
+      RestClient::Resource.new(@api_endpoint, options)
     end
 
     def handling_kube_exception
@@ -53,6 +62,18 @@ module Kubeclient
       end
     end
 
+    public
+
+    def ssl_options(client_cert: nil, client_key: nil, ca_file: nil,
+                    verify_ssl: OpenSSL::SSL::VERIFY_PEER)
+      @ssl_options = {
+        ca_file:      ca_file,
+        verify_ssl:   verify_ssl,
+        client_cert:  client_cert,
+        client_key:   client_key
+      }
+    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
@@ -64,13 +85,13 @@ module Kubeclient
 
         result = JSON.parse(response)
 
-        resourceVersion = result.fetch('resourceVersion', nil)
-        if resourceVersion.nil?
-          resourceVersion = result.fetch('metadata', {})
-                                  .fetch('resourceVersion', nil)
+        resource_version = result.fetch('resourceVersion', nil)
+        if resource_version.nil?
+          resource_version =
+            result.fetch('metadata', {}).fetch('resourceVersion', nil)
         end
 
-        collection = EntityList.new(entity, resourceVersion)
+        collection = EntityList.new(entity, resource_version)
 
         result['items'].each do |item|
           collection.push(create_entity(item, entity))
@@ -82,10 +103,25 @@ module Kubeclient
       # 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
+        resource_name = get_resource_name(entity.to_s)
+
+        uri = api_endpoint.merge(
+          File.join(api_endpoint.path, 'watch', resource_name))
+
+        unless resourceVersion.nil?
+          uri.query = URI.encode_www_form(
+            'resourceVersion' => resourceVersion)
+        end
+
+        options = {
+          use_ssl:      uri.scheme == 'https',
+          ca_file:      @ssl_options[:ca_file],
+          verify_ssl:   @ssl_options[:verify_ssl],
+          client_cert:  @ssl_options[:client_cert],
+          client_key:   @ssl_options[:client_key]
+        }
+
+        WatchStream.new(uri, options)
       end
 
       # get a single entity of a specific type by id
@@ -126,8 +162,6 @@ module Kubeclient
       end
     end
 
-    public
-
     def all_entities
       ENTITIES.each_with_object({}) do |entity, result_hash|
         # method call for get each entities

data/lib/kubeclient/endpoint.rb

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

data/lib/kubeclient/version.rb

@@ -1,4 +1,4 @@
 # Kubernetes REST-API Client
 module Kubeclient
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/kubeclient/watch_stream.rb

@@ -4,26 +4,37 @@ require 'net/http'
 module Kubeclient
   # HTTP Stream used to watch changes on entities
   class WatchStream
-    def initialize(uri)
+    def initialize(uri, options)
       @uri = uri
+      @http = nil
+      @options = options.merge(read_timeout: nil)
     end
 
     def each
+      @finished = false
+      @http = Net::HTTP.start(@uri.host, @uri.port, @options)
+
       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
+      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
+    rescue Errno::EBADF
+      raise unless @finished
+    end
+
+    def finish
+      @finished = true
+      @http.finish if !@http.nil? && @http.started?
     end
   end
 end

data/test/json/endpoint_list_b3.json

@@ -0,0 +1,48 @@
+{
+  "kind": "EndpointsList",
+  "apiVersion": "v1beta3",
+  "metadata": {
+    "selfLink": "/api/v1beta3/namespaces/endpoints",
+    "resourceVersion": "39"
+  },
+  "items": [
+    {
+      "metadata": {
+        "name": "example",
+        "namespace": "default",
+        "selfLink": "/api/v1beta3/namespaces/default/endpoints/example",
+        "uid": "db467530-b6aa-11e4-974a-525400c903c1",
+        "resourceVersion": "38",
+        "creationTimestamp": "2015-02-17T08:42:46-05:00"
+      },
+      "endpoints": [
+        "172.17.0.63:80",
+        "172.17.0.64:80"
+      ]
+    },
+    {
+      "metadata": {
+        "name": "kubernetes",
+        "namespace": "default",
+        "selfLink": "/api/v1beta3/namespaces/default/endpoints/kubernetes",
+        "resourceVersion": "8",
+        "creationTimestamp": null
+      },
+      "endpoints": [
+        "192.168.122.4:6443"
+      ]
+    },
+    {
+      "metadata": {
+        "name": "kubernetes-ro",
+        "namespace": "default",
+        "selfLink": "/api/v1beta3/namespaces/default/endpoints/kubernetes-ro",
+        "resourceVersion": "7",
+        "creationTimestamp": null
+      },
+      "endpoints": [
+        "192.168.122.4:7080"
+      ]
+    }
+  ]
+}

data/test/kubeclient_test.rb

@@ -81,9 +81,13 @@ class KubeClientTest < MiniTest::Test
     stub_request(:get, /\/events/)
       .to_return(body: open_test_json_file('event_list_b3.json'), status: 200)
 
+    stub_request(:get, /\/endpoints/)
+      .to_return(body: open_test_json_file('endpoint_list_b3.json'),
+                 status: 200)
+
     client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1beta1'
     result = client.all_entities
-    assert_equal(5, result.keys.size)
+    assert_equal(6, result.keys.size)
     assert_instance_of(EntityList, result['node'])
     assert_instance_of(EntityList, result['service'])
     assert_instance_of(EntityList, result['replication_controller'])
@@ -92,6 +96,7 @@ class KubeClientTest < MiniTest::Test
     assert_instance_of(Service, result['service'][0])
     assert_instance_of(Node, result['node'][0])
     assert_instance_of(Event, result['event'][0])
+    assert_instance_of(Endpoint, result['endpoint'][0])
   end
 
   private

data/test/watch_test.rb

@@ -18,13 +18,14 @@ class WatchTest < MiniTest::Test
                  status: 200)
 
     client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1beta3'
-    client.watch_pods.with_index do |message, index|
-      assert_instance_of(WatchNotice, message)
-      assert_equal(expected[index]['type'], message.type)
-      assert_equal('Pod', message.object.kind)
-      assert_equal('php', message.object.metadata.name)
+
+    client.watch_pods.to_enum.with_index do |notice, index|
+      assert_instance_of(WatchNotice, notice)
+      assert_equal(expected[index]['type'], notice.type)
+      assert_equal('Pod', notice.object.kind)
+      assert_equal('php', notice.object.metadata.name)
       assert_equal(expected[index]['resourceVersion'],
-                   message.object.metadata.resourceVersion)
+                   notice.object.metadata.resourceVersion)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,98 +42,98 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   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: activesupport
   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: json
   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: recursive-open-struct
   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'
 description: A client for Kubernetes REST api
@@ -145,12 +145,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - kubeclient.gemspec
 - lib/kubeclient.rb
+- lib/kubeclient/endpoint.rb
 - lib/kubeclient/entity_list.rb
 - lib/kubeclient/event.rb
 - lib/kubeclient/kube_exception.rb
@@ -161,6 +163,7 @@ files:
 - lib/kubeclient/version.rb
 - lib/kubeclient/watch.rb
 - lib/kubeclient/watch_stream.rb
+- test/json/endpoint_list_b3.json
 - test/json/entity_list_b1.json
 - test/json/event_list_b3.json
 - test/json/get_all_nodes_b1.json
@@ -193,21 +196,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A client for Kubernetes REST api
 test_files:
+- test/json/endpoint_list_b3.json
 - test/json/entity_list_b1.json
 - test/json/event_list_b3.json
 - test/json/get_all_nodes_b1.json