avro_schema_registry-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31dd66f6c95e6bc63f0cb37cf0da57794f3d6c75
+  data.tar.gz: 69135493b57ccd5987f8780388cf27402222ff2b
+SHA512:
+  metadata.gz: 9a49cb4caff0ea7ada702076cfc5f815ef0425c428f6d40289c3632212608811549399951ff3d6e350a90e902c08978b1f241b656c91f73fc3d4f0cf045576b4
+  data.tar.gz: 386de0ce6a17c1eeec95196cf487d1e4406c9c5d19ed8e42d530d27d60659429c1922729cb3929630ab22cf2d2053d65b8a74fda14e5d79612d8fd74a1953680

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+Style/FileName:
+  Exclude:
+    - 'lib/avro_schema_registry-client.rb'
+    - 'spec/avro_schema_registry-client_spec.rb'

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# avro_schema_registry-client
+
+## v0.1.0
+- Initial version

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in avro_schema_registry-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Salsify, Inc
+
+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,79 @@
+# AvroSchemaRegistry::Client
+
+Client for the [avro-schema-registry](https://github.com/salsify/avro-schema-registry)
+app.
+
+This client extends [AvroTurf::ConfluentSchemaRegistry](https://github.com/dasch/avro_turf)
+to support [extensions](https://github.com/salsify/avro-schema-registry#extensions)
+provided by avro-schema-registry
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avro_schema_registry-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install avro_schema_registry-client
+
+## Usage
+
+Create a client:
+
+```ruby
+client = AvroSchemaRegistry::Client.new(registry_url, logger: logger)
+```
+
+Create a client that caches the responses for requests to fetch or register
+an `Avro::Schema`:
+
+```ruby
+cached_client = AvroSchemaRegistry::CachedClient.new(
+  AvroSchemaRegistry::Client.new(registry_url, logger: logger)
+)
+```
+
+### Fake Server
+
+This gem also provides a fake avro-schema-registry server that can be used in
+tests. This fake server depends on sinatra, which must be explicitly added
+as a dependency:
+
+```ruby
+require 'avro_schema_registry/test/fake_server'
+
+# before hook with rspec
+before do
+  WebMock.stub_request(:any, /^#{registry_url}/).to_rack(AvroSchemaRegistry::FakeServer)
+  AvroSchemaRegistry::FakeServer.clear
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/salsify/avro_schema_registry-client.## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/avro_schema_registry-client.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'avro_schema_registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'avro_schema_registry-client'
+  spec.version       = AvroSchemaRegistry::VERSION
+  spec.authors       = ['Salsify, Inc']
+  spec.email         = ['engineering@salsify.com']
+
+  spec.summary       = 'Client for the avro-schema-registry app'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/salsify/avro_schema_registry-client'
+
+  spec.license       = 'MIT'
+
+  # Set 'allowed_push_post' to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.47.2'
+  spec.add_development_dependency 'overcommit'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'simplecov'
+  # For AvroSchemaRegistry::FakeServer
+  spec.add_development_dependency 'sinatra'
+
+  spec.add_runtime_dependency 'avro_turf', '>= 0.8.0'
+  spec.add_runtime_dependency 'avro-resolution_canonical_form'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'avro_schema_registry-client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle update
+
+overcommit --install

data/lib/avro_schema_registry-client.rb

@@ -0,0 +1,3 @@
+require 'avro_schema_registry/version'
+require 'avro_schema_registry/client'
+require 'avro_schema_registry/cached_client'

data/lib/avro_schema_registry/cached_client.rb

@@ -0,0 +1,11 @@
+require 'avro_turf/cached_confluent_schema_registry'
+
+module AvroSchemaRegistry
+  class CachedClient < AvroTurf::CachedConfluentSchemaRegistry
+
+    # delegate additional method to upstream
+    def lookup_subject_schema(subject, schema)
+      @upstream.lookup_subject_schema(subject, schema)
+    end
+  end
+end

data/lib/avro_schema_registry/client.rb

@@ -0,0 +1,43 @@
+require 'avro_turf'
+require 'avro_turf/confluent_schema_registry'
+require 'avro-resolution_canonical_form'
+
+module AvroSchemaRegistry
+  class Client < AvroTurf::ConfluentSchemaRegistry
+
+    def lookup_subject_schema(subject, schema)
+      schema_object = if schema.is_a?(String)
+                        Avro::Schema.parse(schema)
+                      else
+                        schema
+                      end
+
+      data = get("/subjects/#{subject}/fingerprints/#{schema_object.sha256_resolution_fingerprint.to_s(16)}")
+      id = data.fetch('id')
+      @logger.info("Found schema for subject `#{subject}`; id = #{id}")
+      id
+    end
+
+    # Override register to first check if a schema is registered by fingerprint
+    # Also, allow additional params to be passed to register.
+    def register(subject, schema, **params)
+
+      lookup_subject_schema(subject, schema)
+    rescue Excon::Errors::NotFound
+      data = post("/subjects/#{subject}/versions",
+                  body: { schema: schema.to_s }.merge!(params).to_json)
+      id = data.fetch('id')
+      @logger.info("Registered schema for subject `#{subject}`; id = #{id}")
+      id
+
+    end
+
+    # Override to add support for additional params
+    def compatible?(subject, schema, version = 'latest', **params)
+      data = post("/compatibility/subjects/#{subject}/versions/#{version}",
+                  expects: [200, 404],
+                  body: { schema: schema.to_s }.merge!(params).to_json)
+      data.fetch('is_compatible', false) unless data.key?('error_code')
+    end
+  end
+end

data/lib/avro_schema_registry/test/fake_server.rb

@@ -0,0 +1,22 @@
+require 'avro_turf/test/fake_confluent_schema_registry_server'
+require 'avro-resolution_canonical_form'
+
+module AvroSchemaRegistry
+  class FakeServer < FakeConfluentSchemaRegistryServer
+    get '/subjects/:subject/fingerprints/:fingerprint' do
+      subject = params[:subject]
+      halt(404, SCHEMA_NOT_FOUND) unless SUBJECTS.key?(subject)
+
+      fingerprint = params[:fingerprint]
+      fingerprint = fingerprint.to_i.to_s(16) if /^\d+$/ =~ fingerprint
+
+      schema_id = SCHEMAS.find_index do |schema|
+        Avro::Schema.parse(schema).sha256_resolution_fingerprint.to_s(16) == fingerprint
+      end
+
+      halt(404, SCHEMA_NOT_FOUND) unless schema_id && SUBJECTS[subject].include?(schema_id)
+
+      { id: schema_id }.to_json
+    end
+  end
+end

data/lib/avro_schema_registry/version.rb

@@ -0,0 +1,3 @@
+module AvroSchemaRegistry
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: avro_schema_registry-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salsify, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.2
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  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: simplecov
+  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: sinatra
+  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: avro_turf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: avro-resolution_canonical_form
+  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: Client for the avro-schema-registry app
+email:
+- engineering@salsify.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- avro_schema_registry-client.gemspec
+- bin/console
+- bin/setup
+- lib/avro_schema_registry-client.rb
+- lib/avro_schema_registry/cached_client.rb
+- lib/avro_schema_registry/client.rb
+- lib/avro_schema_registry/test/fake_server.rb
+- lib/avro_schema_registry/version.rb
+homepage: https://github.com/salsify/avro_schema_registry-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Client for the avro-schema-registry app
+test_files: []