avrodrome 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f7de094626cff1e717b4cc1373d35986cbc4cb22c1017a1567cf85396cee212
+  data.tar.gz: 4e061d33e75aa5d03bc69c60904239d1693cd357ab611daf6c087a3a1e713b16
+SHA512:
+  metadata.gz: b0ad39cac524ccd311a1dbcf6684b056e7b2804bfffc8920247cc9881318274a8391ed8648a49c6ce6866991522ceb0b9d558b70c0b5e7de4b33852013381d2b
+  data.tar.gz: 72c2a01daa9f6214be11df8f62e3dd074d8e0168b9c1b27ab5230f4cfe8bf95cb4d700ae8760812dd8d82d08eaf17b2ad14c43c3acc4ac2d444f56a0c66d8940

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in avrodrome.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    avrodrome (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    faker (1.9.1)
+      i18n (>= 0.7)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  avrodrome!
+  bundler (~> 1.17)
+  faker (~> 1.9)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Adam Carlile
+
+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,56 @@
+# Avrodrome
+
+Avrodrome, just like an aerodrome is a place to store aircraft, avrodrome is a place to store Avro schemas. Designed to be use as an in memory drop in replacement for `AvroTurf/Avromatic` registry, instead of using `Webmock` and stubbing calls for testing. It can also be used in development, as it will behave exactly like talking to an Avro schema registry
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avrodrome'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install avrodrome
+
+## Configuration
+
+```ruby
+Avrodrome.configure do |config|
+	config.logger = Logger.new(STDOUT) #Default
+end
+```
+
+## Usage
+
+Designed to be used as a replacement for the registry class in `AvroTurf/Avromatic`
+
+```ruby
+require 'avrodrome'
+
+Avromatic.configure do |config|
+	config.schema_store = Avro::Builder::SchemaStore.new(path: 'path/to/store')
+	config.schema_registry = Avrodrome.build_adaptor
+	config.build_messaging!
+end
+```
+
+or
+
+```ruby
+avro = AvroTurf::Messaging.new(registry: Avrodrome.build_adaptor)
+avro.encode({...})
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adamcarlile/avrodrome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/avrodrome.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "avrodrome/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "avrodrome"
+  spec.version       = Avrodrome::VERSION
+  spec.authors       = ["Adam Carlile"]
+  spec.email         = ["hello@adamcarlile.com"]
+
+  spec.summary       = "An in memory drop in replacement for an Avro Schema Registry"
+  spec.homepage      = "https://github.com/adamcarlile/avrodrome"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "faker", "~> 1.9"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "avrodrome"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/avrodrome.rb

@@ -0,0 +1,37 @@
+require "ostruct"
+require "logger"
+
+require "avrodrome/version"
+
+require "avrodrome/schema"
+require "avrodrome/subject"
+require "avrodrome/registry"
+require "avrodrome/adaptor"
+
+
+module Avrodrome
+  module_function
+
+  def build_adaptor
+    Avrodrom::Adaptor.new
+  end
+
+  def version
+    Avrodrome::VERSION
+  end
+
+  def config
+    @config ||= OpenStruct.new.tap do |c|
+      c.logger = Logger.new(STDOUT)
+    end
+  end
+
+  def configure(&block)
+    yield(config)
+  end
+
+  def logger
+    config.logger
+  end
+
+end

data/lib/avrodrome/adaptor.rb

@@ -0,0 +1,98 @@
+module Avrodrome
+  class Adaptor
+    attr_reader :registry, :logger
+
+    def initialize(logger: Avrodrome.logger, registry: Avrodrome::Registry.new)
+      @logger   = logger
+      @registry = registry
+    end
+
+    def fetch(id)
+      logger.info "Fetching schema with id #{id}"
+      registry.find(id)&.body&.to_s || errors[:not_found]
+    end
+
+    def register(subject, schema)
+      registered_schema = registry.register!(subject, schema)
+      logger.info "Registered schema for subject `#{subject}`; id = #{registered_schema.id}"
+      registered_schema.id
+    end
+
+    # List all subjects
+    def subjects
+      registry.subjects.map(&:name)
+    end
+
+    # List all versions for a subject
+    def subject_versions(subject_name)
+      subject = registry.subject(subject_name)
+      return errors[:subject_not_found] unless subject
+      subject.schemas.map(&:version)
+    end
+
+    # Get a specific version for a subject
+    def subject_version(subject_name, version = 'latest')
+      subject = registry.subject(subject_name)
+      return errors[:subject_not_found] unless subject
+      version = nil if version == 'latest'
+      subject.version(version) || errors[:version_not_found]
+    end
+
+    # Check if a schema exists. Returns nil if not found.
+    def check(subject_name, schema)
+      subject = registry.subject(subject_name)
+      return errors[:subject_not_found] unless subject
+      subject.check(schema)&.to_hash
+    end
+
+    # AC: Assume short lived in memory store, no historic schemas for now 
+    #
+    # Check if a schema is compatible with the stored version.
+    # Returns:
+    # - true if compatible
+    # - nil if the subject or version does not exist
+    # - false if incompatible
+    # http://docs.confluent.io/3.1.2/schema-registry/docs/api.html#compatibility
+    def compatible?(subject, schema, version = 'latest')
+      true
+      # data = post("/compatibility/subjects/#{subject}/versions/#{version}",
+      #             expects: [200, 404],
+      #             body: { schema: schema.to_s }.to_json)
+      # data.fetch('is_compatible', false) unless data.has_key?('error_code')
+    end
+
+    # Get global config
+    def global_config
+      @gloabl_config ||= { "compatibilityLevel" => "BACKWARD" }
+    end
+
+    # Update global config
+    def update_global_config(config)
+      global_config.merge!(config)
+    end
+
+    # Get config for subject
+    def subject_config(subject)
+      subject = registry.subject(subject)
+      return errors[:subject_not_found] unless subject
+      subject.config
+    end
+
+    # Update config for subject
+    def update_subject_config(subject, config)
+      subject = registry.subject(subject)
+      return errors[:subject_not_found] unless subject
+      subject.config.merge!(config)
+    end
+
+    private
+    
+    def errors
+      @errors ||= {
+        not_found: { error_code: 404, message: "HTTP 404 Not Found" },
+        version_not_found: { error_code: 40402, message: "Version not found." },
+        subject_not_found: { error_code: 40401, message: "Subject not found." }
+      }
+    end
+  end
+end

data/lib/avrodrome/registry.rb

@@ -0,0 +1,30 @@
+module Avrodrome
+  class Registry
+    
+    def subjects
+      @subjects ||= []
+    end
+    
+    def schemas
+      subjects.map(&:schemas).flatten
+    end
+    
+    def register!(subject_name, schema)
+      subject = subjects.detect {|x| x.name == subject_name } || (Avrodrome::Subject.new(name: subject_name).tap { |x| subjects << x } )
+      subject.register!(schema: schema, id: next_id)
+    end
+    
+    def find(id)
+      schemas.detect {|x| x.id == id }
+    end
+    
+    def subject(name)
+      subjects.detect {|x| x.name == name }
+    end
+    
+    def next_id
+      (subjects.sum(&:total_schemas) || 0) + 1 
+    end
+
+  end
+end

data/lib/avrodrome/schema.rb

@@ -0,0 +1,26 @@
+module Avrodrome
+  class Schema
+    attr_reader :body, :id, :version, :name
+    
+    def initialize(body:, id:, version:, name:)
+      @body = body
+      @id = id
+      @version = version
+      @name = name
+    end
+
+    def to_hash
+      {
+        subject: name,
+        version: version,
+        id: id,
+        schema: body.to_s
+      }
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+  end
+end

data/lib/avrodrome/subject.rb

@@ -0,0 +1,48 @@
+module Avrodrome
+  class Subject
+    attr_reader :name
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def config
+      @config ||= {}
+    end
+
+    def find(id)
+      schemas.detect {|x| x.id == id}
+    end
+
+    def version(version=nil)
+      if version
+        schemas.detect {|x| x.version == version }
+      else
+        schemas.last
+      end
+    end
+
+    def check(schema)
+      schemas.detect {|x| x.body == schema }
+    end
+
+    def schemas
+      @schemas ||= []
+    end
+
+    def register!(schema:, id:, version: next_version)
+      Avrodrome::Schema.new(body: schema, id: id, version: version, name: name).tap { |x| schemas << x }
+    end
+
+    def total_schemas
+      schemas.count
+    end
+
+    private
+
+    def next_version
+      schemas.count + 1
+    end
+
+  end
+end

data/lib/avrodrome/version.rb

@@ -0,0 +1,3 @@
+module Avrodrome
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: avrodrome
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Carlile
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: 
+email:
+- hello@adamcarlile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- avrodrome.gemspec
+- bin/console
+- bin/setup
+- lib/avrodrome.rb
+- lib/avrodrome/adaptor.rb
+- lib/avrodrome/registry.rb
+- lib/avrodrome/schema.rb
+- lib/avrodrome/subject.rb
+- lib/avrodrome/version.rb
+homepage: https://github.com/adamcarlile/avrodrome
+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: []
+rubygems_version: 3.0.0.beta3
+signing_key: 
+specification_version: 4
+summary: An in memory drop in replacement for an Avro Schema Registry
+test_files: []