avro_turf 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e110697cb451e5315414f8086d32aa6e6c43444a462fcdaa678d1311302fcab8
-  data.tar.gz: a54afac8d7e8cb4a599695825ccb3d666d08ad800ccfe63229f14b6b42b26f11
+  metadata.gz: db17e2aed8677c0288cd1c817b2e4ecae50da47255663c2b0a75d64a43e91152
+  data.tar.gz: e88f6481337b05b80db9710283daf20818fcad9621c09ca9ebd75e533ca5135c
 SHA512:
-  metadata.gz: 78ee7cc3c12975d15bc621d9b3a96ed014cc8265536650f365ed80a861a06d53f3e9db9f7d698f71c02485df6f9b371944102404e76cc05e13816e12d312d97c
-  data.tar.gz: ac02799c0f25b88f8c9bfbbd0de48a2b3c39a7744ee1b90c6c87439b5a547db9456a2b3f89a9730303c76ea302159fdce9189f417e6424ecbac45da14682dd0d
+  metadata.gz: 3c226b186752b4feed4519d329e7789dc02ad29793d3573ca2832a182074010652c16746308f785320018bed528d00b241c9b6354b2a3271a72278812d552d56
+  data.tar.gz: c07515285fbd182752764d43c350d529f9a60bce1ad7d7aa6992cb1cda9fb958c189092d78a432a6e141eca380c8e9459857b29e2b038f03e32b645f5b4f0461

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## v1.6.0
+
+- Schema registry path prefix (#162)
+
 ## v1.5.0
 
 - Add CA cert file option (#157)

data/lib/avro_turf/confluent_schema_registry.rb

@@ -14,8 +14,10 @@ class AvroTurf::ConfluentSchemaRegistry
     client_key: nil,
     client_key_pass: nil,
     client_cert_data: nil,
-    client_key_data: nil
+    client_key_data: nil,
+    path_prefix: nil
   )
+    @path_prefix = path_prefix
     @logger = logger
     headers = {
       "Content-Type" => CONTENT_TYPE
@@ -122,6 +124,7 @@ class AvroTurf::ConfluentSchemaRegistry
 
   def request(path, **options)
     options = { expects: 200 }.merge!(options)
+    path = File.join(@path_prefix, path) unless @path_prefix.nil?
     response = @connection.request(path: path, **options)
     JSON.parse(response.body)
   end

data/lib/avro_turf/messaging.rb

@@ -26,28 +26,30 @@ class AvroTurf
 
     # Instantiate a new Messaging instance with the given configuration.
     #
-    # registry          - A schema registry object that responds to all methods in the
-    #                     AvroTurf::ConfluentSchemaRegistry interface.
-    # registry_url      - The String URL of the schema registry that should be used.
-    # schema_store      - A schema store object that responds to #find(schema_name, namespace).
-    # schemas_path      - The String file system path where local schemas are stored.
-    # namespace         - The String default schema namespace.
-    # logger            - The Logger that should be used to log information (optional).
-    # proxy             - Forward the request via  proxy (optional).
-    # user              - User for basic auth (optional).
-    # password          - Password for basic auth (optional).
-    # ssl_ca_file       - Name of file containing CA certificate (optional).
-    # client_cert       - Name of file containing client certificate (optional).
-    # client_key        - Name of file containing client private key to go with client_cert (optional).
-    # client_key_pass   - Password to go with client_key (optional).
-    # client_cert_data  - In-memory client certificate (optional).
-    # client_key_data   - In-memory client private key to go with client_cert_data (optional).
+    # registry             - A schema registry object that responds to all methods in the
+    #                        AvroTurf::ConfluentSchemaRegistry interface.
+    # registry_url         - The String URL of the schema registry that should be used.
+    # schema_store         - A schema store object that responds to #find(schema_name, namespace).
+    # schemas_path         - The String file system path where local schemas are stored.
+    # namespace            - The String default schema namespace.
+    # registry_path_prefix - The String URL path prefix used to namespace schema registry requests (optional).
+    # logger               - The Logger that should be used to log information (optional).
+    # proxy                - Forward the request via  proxy (optional).
+    # user                 - User for basic auth (optional).
+    # password             - Password for basic auth (optional).
+    # ssl_ca_file          - Name of file containing CA certificate (optional).
+    # client_cert          - Name of file containing client certificate (optional).
+    # client_key           - Name of file containing client private key to go with client_cert (optional).
+    # client_key_pass      - Password to go with client_key (optional).
+    # client_cert_data     - In-memory client certificate (optional).
+    # client_key_data      - In-memory client private key to go with client_cert_data (optional).
     def initialize(
       registry: nil,
       registry_url: nil,
       schema_store: nil,
       schemas_path: nil,
       namespace: nil,
+      registry_path_prefix: nil,
       logger: nil,
       proxy: nil,
       user: nil,
@@ -74,7 +76,8 @@ class AvroTurf
           client_key: client_key,
           client_key_pass: client_key_pass,
           client_cert_data: client_cert_data,
-          client_key_data: client_key_data
+          client_key_data: client_key_data,
+          path_prefix: registry_path_prefix
         )
       )
       @schemas_by_id = {}

data/lib/avro_turf/test/fake_prefixed_confluent_schema_registry_server.rb

@@ -0,0 +1,102 @@
+require 'sinatra/base'
+
+class FakePrefixedConfluentSchemaRegistryServer < FakeConfluentSchemaRegistryServer
+  post "/prefix/subjects/:subject/versions" do
+    schema = parse_schema
+    ids_for_subject = SUBJECTS[params[:subject]]
+
+    schemas_for_subject =
+      SCHEMAS.select
+             .with_index { |_, i| ids_for_subject.include?(i) }
+
+    if schemas_for_subject.include?(schema)
+      schema_id = SCHEMAS.index(schema)
+    else
+      SCHEMAS << schema
+      schema_id = SCHEMAS.size - 1
+      SUBJECTS[params[:subject]] = SUBJECTS[params[:subject]] << schema_id
+    end
+
+    { id: schema_id }.to_json
+  end
+
+  get "/prefix/schemas/ids/:schema_id" do
+    schema = SCHEMAS.at(params[:schema_id].to_i)
+    halt(404, SCHEMA_NOT_FOUND) unless schema
+    { schema: schema }.to_json
+  end
+
+  get "/prefix/subjects" do
+    SUBJECTS.keys.to_json
+  end
+
+  get "/prefix/subjects/:subject/versions" do
+    schema_ids = SUBJECTS[params[:subject]]
+    halt(404, SUBJECT_NOT_FOUND) if schema_ids.empty?
+    (1..schema_ids.size).to_a.to_json
+  end
+
+  get "/prefix/subjects/:subject/versions/:version" do
+    schema_ids = SUBJECTS[params[:subject]]
+    halt(404, SUBJECT_NOT_FOUND) if schema_ids.empty?
+
+    schema_id = if params[:version] == 'latest'
+                  schema_ids.last
+                else
+                  schema_ids.at(Integer(params[:version]) - 1)
+                end
+    halt(404, VERSION_NOT_FOUND) unless schema_id
+
+    schema = SCHEMAS.at(schema_id)
+
+    {
+      name: params[:subject],
+      version: schema_ids.index(schema_id) + 1,
+      id: schema_id,
+      schema: schema
+    }.to_json
+  end
+
+  post "/prefix/subjects/:subject" do
+    schema = parse_schema
+
+    # Note: this does not actually handle the same schema registered under
+    # multiple subjects
+    schema_id = SCHEMAS.index(schema)
+
+    halt(404, SCHEMA_NOT_FOUND) unless schema_id
+
+    {
+      subject: params[:subject],
+      id: schema_id,
+      version: SUBJECTS[params[:subject]].index(schema_id) + 1,
+      schema: schema
+    }.to_json
+  end
+
+  post "/prefix/compatibility/subjects/:subject/versions/:version" do
+    # The ruby avro gem does not yet include a compatibility check between schemas.
+    # See https://github.com/apache/avro/pull/170
+    raise NotImplementedError
+  end
+
+  get "/prefix/config" do
+    global_config.to_json
+  end
+
+  put "/prefix/config" do
+    global_config.merge!(parse_config).to_json
+  end
+
+  get "/prefix/config/:subject" do
+    CONFIGS.fetch(params[:subject], global_config).to_json
+  end
+
+  put "/prefix/config/:subject" do
+    config = parse_config
+    subject = params[:subject]
+    CONFIGS.fetch(subject) do
+      CONFIGS[subject] = {}
+    end.merge!(config).to_json
+  end
+end

data/lib/avro_turf/version.rb

@@ -1,3 +1,3 @@
 class AvroTurf
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/spec/messaging_spec.rb

@@ -1,6 +1,7 @@
 require 'webmock/rspec'
 require 'avro_turf/messaging'
 require 'avro_turf/test/fake_confluent_schema_registry_server'
+require 'avro_turf/test/fake_prefixed_confluent_schema_registry_server'
 
 describe AvroTurf::Messaging do
   let(:registry_url) { "http://registry.example.com" }
@@ -8,7 +9,7 @@ describe AvroTurf::Messaging do
   let(:client_key) { "test client key" }
   let(:client_key_pass) { "test client key password" }
   let(:logger) { Logger.new(StringIO.new) }
-
+  let(:path_prefix) { nil }
   let(:avro) {
     AvroTurf::Messaging.new(
       registry_url: registry_url,
@@ -72,7 +73,7 @@ describe AvroTurf::Messaging do
 
   shared_examples_for 'encoding and decoding with the schema from registry' do
     before do
-      registry = AvroTurf::ConfluentSchemaRegistry.new(registry_url, logger: logger)
+      registry = AvroTurf::ConfluentSchemaRegistry.new(registry_url, logger: logger, path_prefix: path_prefix)
       registry.register('person', schema)
       registry.register('people', schema)
     end
@@ -102,7 +103,7 @@ describe AvroTurf::Messaging do
 
   shared_examples_for 'encoding and decoding with the schema_id from registry' do
     before do
-      registry = AvroTurf::ConfluentSchemaRegistry.new(registry_url, logger: logger)
+      registry = AvroTurf::ConfluentSchemaRegistry.new(registry_url, logger: logger, path_prefix: path_prefix)
       registry.register('person', schema)
       registry.register('people', schema)
     end
@@ -399,4 +400,29 @@ describe AvroTurf::Messaging do
       end
     end
   end
-end
+
+  context 'with a registry path prefix' do
+    let(:path_prefix) { '/prefix' }
+
+    let(:avro) {
+      AvroTurf::Messaging.new(
+        registry_path_prefix: path_prefix,
+        registry_url: registry_url,
+        schemas_path: "spec/schemas",
+        logger: logger,
+        client_cert: client_cert,
+        client_key: client_key,
+        client_key_pass: client_key_pass
+      )
+    }
+
+    before do
+      stub_request(:any, /^#{registry_url}/).to_rack(FakePrefixedConfluentSchemaRegistryServer)
+      FakePrefixedConfluentSchemaRegistryServer.clear
+    end
+
+    it_behaves_like "encoding and decoding with the schema from schema store"
+    it_behaves_like 'encoding and decoding with the schema from registry'
+    it_behaves_like 'encoding and decoding with the schema_id from registry'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro_turf
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -196,6 +196,7 @@ files:
 - lib/avro_turf/schema_store.rb
 - lib/avro_turf/schema_to_avro_patch.rb
 - lib/avro_turf/test/fake_confluent_schema_registry_server.rb
+- lib/avro_turf/test/fake_prefixed_confluent_schema_registry_server.rb
 - lib/avro_turf/test/fake_schema_registry_server.rb
 - lib/avro_turf/version.rb
 - perf/address.avsc