schema_registry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ae27f7cfce0bff061ce4ac247a11bae184d2bbd
+  data.tar.gz: aa3fbeeeb5a04273d70588ee319d730d0644fe2a
+SHA512:
+  metadata.gz: eba53efa53ede87f404ed70cf7405f5af0ccc10650796dd19038b8100bab76d16927b7e1bf0cfd2b6fe24b9780683b5aea38618b1e4ec71a640ae2231a8e6c91
+  data.tar.gz: 572a7592030e7e576da373f112fa9961603dad0037072410e100bc5488899adb0d925215a85bbf5d0a636952a07d5b8660cb280674af17c36ded03226ca5be3c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schema_registry.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Willem van Bergen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# SchemaRegistry
+
+Ruby client for Confluent Inc.'s schema-registry. The schema-registry holds AVRO schemas for different
+subjects, and can ensure backward and/or forward compatiblity between different schema versions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schema_registry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schema_registry
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/schema_registry/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/schema_registry.rb

@@ -0,0 +1,18 @@
+module SchemaRegistry
+
+  module Compatibility
+    FORWARD  = "FORWARD".freeze
+    BACKWARD = "BACKWARD".freeze
+    FULL     = "FULL".freeze
+    NONE     = "NONE".freeze
+
+    LEVELS = [NONE, FORWARD, BACKWARD, FULL].freeze
+  end
+
+  class Error < ::StandardError
+  end
+end
+
+require 'schema_registry/client'
+require 'schema_registry/subject'
+require 'schema_registry/version'

data/lib/schema_registry/client.rb

@@ -0,0 +1,71 @@
+require 'net/http'
+require 'json'
+
+module SchemaRegistry
+  class ResponseError < Error
+    attr_reader :code
+
+    def initialize(code, message)
+      @code = code
+      super(message)
+    end
+  end
+
+  class Client
+
+    attr_reader :endpoint, :username, :password
+
+    def initialize(endpoint, username = nil, password = nil)
+      @endpoint = URI(endpoint)
+      @username, @password = username, password
+    end
+
+    def schema(id)
+      request(:get, "/schemas/ids/#{id}")['schema']
+    end
+
+    def subjects
+      data = request(:get, "/subjects")
+      data.map { |subject| SchemaRegistry::Subject.new(self, subject) }
+    end
+
+    def subject(name)
+      SchemaRegistry::Subject.new(self, name)
+    end
+
+    def default_compatibility_level
+      request(:get, "/config")["compatibilityLevel"]
+    end
+
+    def default_compatibility_level=(level)
+      request(:put, "/config", compatibility: level)
+    end
+
+    def request(method, path, body = nil)
+      Net::HTTP.start(endpoint.host, endpoint.port, use_ssl: endpoint.scheme == 'https') do |http|
+        request_class = case method
+          when :get;    Net::HTTP::Get
+          when :post;   Net::HTTP::Post
+          when :put;    Net::HTTP::Put
+          when :delete; Net::HTTP::Delete
+          else raise ArgumentError, "Unsupported request method"
+        end
+
+        request = request_class.new(path)
+        request.basic_auth(username, password) if username && password
+        request['Accept'] = "application/vnd.schemaregistry.v1+json"
+        if body
+          request['Content-Type'] = "application/json"
+          request.body = JSON.dump(body)
+        end
+
+        response = http.request(request)
+        response_data = JSON.parse(response.body)
+        case response
+          when Net::HTTPOK; response_data
+          else raise SchemaRegistry::ResponseError.new(response_data['error_code'], response_data['message'])
+        end
+      end
+    end
+  end
+end

data/lib/schema_registry/subject.rb

@@ -0,0 +1,40 @@
+module SchemaRegistry
+
+  class Subject
+    attr_reader :client, :name
+
+    def initialize(client, name)
+      @client, @name = client, name
+    end
+
+    def versions
+      client.request(:get, "/subjects/#{name}/versions")
+    end
+
+    def version(version)
+      client.request(:get, "/subjects/#{name}/versions/#{version}")
+    end
+
+    def verify_schema(schema_json)
+      client.request(:post, "/subjects/#{name}", schema: schema_json)
+    end
+
+    def update_schema(schema_json)
+      client.request(:post, "/subjects/#{name}/versions", schema: schema_json)["id"]
+    end
+
+    def compatibility_level
+      response = client.request(:get, "/config/#{name}")
+      response["compatibilityLevel"]
+    end
+
+    def compatibility_level=(level)
+      response = client.request(:put, "/config/#{name}", compatibility: level)
+    end
+
+    def compatible?(schema, version = "latest")
+      response = client.request(:post, "/compatibility/subjects/#{name}/versions/#{version}", schema: schema)
+      response["is_compatible"]
+    end
+  end
+end

data/lib/schema_registry/version.rb

@@ -0,0 +1,3 @@
+module SchemaRegistry
+  VERSION = "0.0.1"
+end

data/schema_registry.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schema_registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema_registry"
+  spec.version       = SchemaRegistry::VERSION
+  spec.authors       = ["Willem van Bergen"]
+  spec.email         = ["willem@railsdoctors.com"]
+  spec.summary       = %q{Ruby client for Confluent Inc.'s schema-registry}
+  spec.description   = %q{Ruby client for Confluent Inc.'s schema-registry. The schema-registry holds AVRO schemas for different subjects, and can ensure backward and/or forward compatiblity between different schema versions.}
+  spec.homepage      = "http://confluent.io/docs/current/schema-registry/docs/index.html"
+  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.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "avro", "~> 1.7"
+end

data/test/fixtures/schemas/test-v1.avsc

@@ -0,0 +1,13 @@
+{
+  "namespace": "org.vanbergen.test",
+  "name": "Test",
+  "doc": "Only used for testing",
+  "type": "record",
+  "fields": [
+    {
+      "type": "string",
+      "name": "data"
+    }
+  ],
+  "metafata_field": "present"
+}

data/test/functional/schema_registry_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class SchemaRegistryTest < Minitest::Test
+
+  def setup
+    raise "The SCHEMA_REGISTRY_URI environment variable must be set" if ENV['SCHEMA_REGISTRY_URI'].nil?
+    @client = SchemaRegistry::Client.new(ENV['SCHEMA_REGISTRY_URI'])
+  end
+
+  def test_global_compatibility_level
+    old_level = @client.default_compatibility_level
+    assert_equal SchemaRegistry::Compatibility::BACKWARD, old_level
+
+    @client.default_compatibility_level = SchemaRegistry::Compatibility::FULL
+
+    current_level = @client.default_compatibility_level
+    assert_equal current_level, SchemaRegistry::Compatibility::FULL
+  ensure
+    @client.default_compatibility_level = old_level
+  end
+
+  def test_register_schema_for_subject
+    schema = schema_fixture('test', 1)
+
+    subject = @client.subject('test.schema_registry')
+    schema_id = subject.update_schema(schema)
+    assert schema_id > 0
+
+    assert_equal ['test.schema_registry'], @client.subjects.map(&:name)
+
+    registered_schema = @client.schema(schema_id)
+    schema_info = subject.verify_schema(schema)
+    assert_equal schema_id, schema_info['id']
+
+    assert_equal Avro::Schema.parse(schema), Avro::Schema.parse(registered_schema)
+
+    parsed_schema = JSON.parse(registered_schema)
+    assert_equal 'Only used for testing', parsed_schema['doc']
+    assert_equal 'present', parsed_schema['metafata_field']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'pp'
+require 'avro'
+require 'schema_registry'
+
+def schema_fixture(name, version = 1, suffix = nil)
+  schema_dirname = File.expand_path("../fixtures/schemas", __FILE__)
+  schema_filename = "#{name}-v#{version}"
+  schema_filename += suffix ? "-#{suffix}.avsc" : ".avsc"
+  File.read(File.join(schema_dirname, schema_filename))
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: schema_registry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-13 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
+  holds AVRO schemas for different subjects, and can ensure backward and/or forward
+  compatiblity between different schema versions.
+email:
+- willem@railsdoctors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schema_registry.rb
+- lib/schema_registry/client.rb
+- lib/schema_registry/subject.rb
+- lib/schema_registry/version.rb
+- schema_registry.gemspec
+- test/fixtures/schemas/test-v1.avsc
+- test/functional/schema_registry_test.rb
+- test/test_helper.rb
+homepage: http://confluent.io/docs/current/schema-registry/docs/index.html
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Ruby client for Confluent Inc.'s schema-registry
+test_files:
+- test/fixtures/schemas/test-v1.avsc
+- test/functional/schema_registry_test.rb
+- test/test_helper.rb