schema_registry 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d530b329c2ffc4f471bed84fc897843fdc932b
-  data.tar.gz: b770be7557c4c038494147e5aed96d1052d3f486
+  metadata.gz: 2899eb9d0ac483c1f750a4e0abd8254fcd276696
+  data.tar.gz: f67cd142dbf9e9454115e8381de05645a60b5dae
 SHA512:
-  metadata.gz: 8c45a230a3a73add3ec82751dcdc275979d5cd27f38c769157c819864da2ad8beae1de676c0dd960d854487a1e50dddbb8d3e839ca950b743253e3644e045c77
-  data.tar.gz: 7bf8a528e69c471c4d25ae299fd00d0a0ca68c0dfa5d42a3fa7148cd950829a192cd22fce37a001517f549741c41e33fa1b315e78e30cd810c5c39d530889bab
+  metadata.gz: 37e0bb51c00b9b0d6600f3176a187fef49652368a6b60d8e7ffc554526f356e86b949bdbdad2aeb2942a6648a40b847835225105da77b2ee62f5f5c781be30d3
+  data.tar.gz: 6af7faeb40307bd2b547f503b42654fc51fa61e5fc2ace719a91007be23a8afb082229042dd21b25c4d94029057302ab5c8b96e23ac99ce516a0dee32db3ed50

data/README.md

@@ -23,6 +23,41 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+
+### TLS
+
+The registry does support client TLS cerificates as a means of authenticating w/ the schema registry.  
+
+You have two options of passing options to net/http.  You can pass in all the config as named parameters
+
+##### Example
+
+```ruby
+    @client = SchemaRegistry::Client.new(
+      'https://testschmreg.domain.com:8082',
+      cert: OpenSSL::X509::Certificate.new(File.read('./client.crt')), 
+      key: OpenSSL::PKey::RSA.new(File.read('./client.key')),
+      ca_file: './ca.pem',
+      verify_mode: OpenSSL::SSL::VERIFY_PEER
+    )
+```
+
+The second option is to use a helper static method to avoid having to handle the encoding.
+
+##### Helper Example
+
+```ruby
+    @client = SchemaRegistry::Client.new(
+      "https://testschmreg.domain.com:8082",
+      SchemaRegistry::Client.connection_options(
+        client_certificate: './client.crt', 
+        client_key: './client.key',
+        ca_certificate: "./ca.pem",
+        verify_mode: :verify_peer
+      )
+    )
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/schema_registry/fork )

data/lib/schema_registry/client.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'json'
+require 'openssl'
 
 module SchemaRegistry
   class ResponseError < Error
@@ -12,6 +13,7 @@ module SchemaRegistry
   end
 
   InvalidResponse = Class.new(SchemaRegistry::Error)
+  ServerError = Class.new(SchemaRegistry::ResponseError)
 
   RESPONSE_ERROR_CODES = {
     40401 => (SubjectNotFound           = Class.new(SchemaRegistry::ResponseError)),
@@ -26,11 +28,12 @@ module SchemaRegistry
 
   class Client
 
-    attr_reader :endpoint, :username, :password
+    attr_reader :endpoint, :username, :password, :http_options
 
-    def initialize(endpoint, username = nil, password = nil)
+    def initialize(endpoint, username = nil, password = nil, **http_options)
       @endpoint = URI(endpoint)
       @username, @password = username, password
+      @http_options = http_options
     end
 
     def schema(id)
@@ -54,8 +57,48 @@ module SchemaRegistry
       request(:put, "/config", compatibility: level)
     end
 
+    # Build options hash for net/http based on params provided. Primary for selectivly adding TLS config options for MTLS
+    def self.connection_options(**config)
+      options = {}
+
+      unless config[:verify_mode].nil?
+        options[:verify_mode] = OpenSSL::SSL.const_get(config[:verify_mode].upcase)
+      end
+
+      unless config[:ca_certificate].nil?
+        if File.exist?(config[:ca_certificate])
+          options[:ca_file] = config[:ca_certificate]
+        else
+          raise ArgumentError, "ca file not found [#{config[:ca_certificate]}]"
+        end
+      end
+
+      unless config[:client_key].nil?
+        if File.exist?(config[:client_key])
+          options[:key] = OpenSSL::PKey::RSA.new(File.read(config[:client_key]))
+        else
+          raise ArgumentError, "client key file not found [#{config[:client_key]}]"
+        end
+      end
+
+      unless config[:client_certificate].nil?
+        if File.exist?(config[:client_certificate])
+          options[:cert] = OpenSSL::X509::Certificate.new(File.read(config[:client_certificate]))
+        else
+          raise ArgumentError, "client cert file not found [#{config[:client_certificate]}]"
+        end
+      end
+      options
+    end
+
     def request(method, path, body = nil)
-      Net::HTTP.start(endpoint.host, endpoint.port, use_ssl: endpoint.scheme == 'https') do |http|
+
+      # build config for http client
+      default_options = {
+        use_ssl: endpoint.scheme == 'https'
+      }.merge!(@http_options)
+
+      Net::HTTP.start(endpoint.host, endpoint.port, default_options) do |http|
         request_class = case method
           when :get;    Net::HTTP::Get
           when :post;   Net::HTTP::Post
@@ -80,6 +123,9 @@ module SchemaRegistry
             raise SchemaRegistry::InvalidResponse, "Invalid JSON in response: #{e.message}"
           end
 
+        when Net::HTTPInternalServerError
+          raise SchemaRegistry::ServerError, "Schema registy responded with a server error: #{esponse.code.to_i}"
+
         when Net::HTTPForbidden
           message = username.nil? ? "Unauthorized" : "User `#{username}` failed to authenticate"
           raise SchemaRegistry::UnauthorizedRequest.new(response.code.to_i, message)

data/lib/schema_registry/version.rb

@@ -1,3 +1,3 @@
 module SchemaRegistry
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: schema_registry
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Willem van Bergen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: avro
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 description: Ruby client for Confluent Inc.'s schema-registry. The schema-registry
@@ -75,8 +75,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - Makefile
@@ -101,17 +101,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for Confluent Inc.'s schema-registry