avro_turf 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e1ca443d93f4f1c38b9626ad1a83db6352a4aac397256a8a3bfae2ca462d9c
-  data.tar.gz: 2621ae9378b2511cee81522247c5f4df883ee9c25efe92839cdc5af22543bc1f
+  metadata.gz: 1c6f4cafa2c752c6b0dbe23703a4d2efccf558e11cec1c33db5a1af911cca43a
+  data.tar.gz: 61c9bc9c1963bb89f8b00c01ad0c4195d8cf48473ea191b3d91afa88361c7aa5
 SHA512:
-  metadata.gz: 56f2e3885be65423da7be65fe067151b3fd270ce13af76455a0f71cccbf6d68b09661e75f882c50ea9745f9cdc21e78ce8bd527d8123fa4b0c094dfaf6baa03a
-  data.tar.gz: 4b8e92503870f8c83c8af5457786da3c83823706d957a96986488f2800166ae02846141e9eeb28c261c6b0e0f5d7922244f65dfb47e39bbc96a9a29fea075e55
+  metadata.gz: 1b7792365879b2d4dab3f7a160687ba7308c8f5cb6f9d788506ad087bfb56056f867328bc5357ab011917588bb7e67219300c00e3cadcdef389b927f8cf398de
+  data.tar.gz: 834dcc062ca3e2a6f6b4eafecd8425abacad9ca64d972bbe03100def4e7af2adb706d2fcde541d31d6ff199e9b3ce51f47774269adc55191a7b6d9dc2ed5e224

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## v1.18.0
+
+- Add `compatibility_issues` method to `ConfluentSchemaRegistry` to debug compatibility issues between a schema versions for a given subject (#212)
+- Update tests to support `sinatra` version 4.1 that includes a new `host_authorization` parameter to permit only authorized requests
+
 ## v1.17.0
 
 - Add `register_schemas` option to `encode` method [#210](https://github.com/dasch/avro_turf/pull/210)

data/README.md

@@ -254,6 +254,9 @@ registry = AvroTurf::ConfluentSchemaRegistry.new("http://my-registry:8081/")
 
 # Returns true if the schema is compatible, nil if the subject or version is not registered, and false if incompatible.
 registry.compatible?("person", schema)
+
+# Returns an array of any breaking changes, nil if the subject or version is not registered
+registry.compatibility_issues("person", schema)
 ```
 
 The ConfluentSchemaRegistry client can also change the global compatibility level or the compatibility level for an individual subject using the [Config API](http://docs.confluent.io/3.1.2/schema-registry/docs/api.html#config):
@@ -270,17 +273,23 @@ fake schema registry server depends on Sinatra but it is _not_ listed as a runti
 dependency for AvroTurf. Sinatra must be added to your Gemfile or gemspec in order
 to use the fake server.
 
+Given the recent update in `sinatra` to fix [CVE-2024-21510](https://github.com/advisories/GHSA-hxx2-7vcw-mqr3) that included a new `HostAuthorization` middleware, the `FakeConfluentSchemaRegistryServer` is provided as a base implementation that has to be inherited into a new class and configured by the user so requests are properly authorised to the test registry host.
+
 Example using RSpec:
 
 ```ruby
 require 'avro_turf/test/fake_confluent_schema_registry_server'
 require 'webmock/rspec'
 
+class AuthorizedFakeConfluentSchemaRegistryServer < FakeConfluentSchemaRegistryServer
+  set :host_authentication, permitted_hosts: ['registry.example.com']
+end
+
 # within an example
 let(:registry_url) { "http://registry.example.com" }
 before do
-  stub_request(:any, /^#{registry_url}/).to_rack(FakeConfluentSchemaRegistryServer)
-  FakeConfluentSchemaRegistryServer.clear
+  stub_request(:any, /^#{registry_url}/).to_rack(AuthorizedFakeConfluentSchemaRegistryServer)
+  AuthorizedFakeConfluentSchemaRegistryServer.clear
 end
 
 # Messaging objects created with the same registry_url will now use the fake server.

data/lib/avro_turf/confluent_schema_registry.rb

@@ -101,6 +101,18 @@ class AvroTurf::ConfluentSchemaRegistry
     data.fetch('is_compatible', false) unless data.has_key?('error_code')
   end
 
+  # Check for specific schema compatibility issues
+  # Returns:
+  # - nil if the subject or version does not exist
+  # - a list of compatibility issues
+  # https://docs.confluent.io/platform/current/schema-registry/develop/api.html#sr-api-compatibility
+  def compatibility_issues(subject, schema, version = 'latest')
+    data = post("/compatibility/subjects/#{@schema_context_prefix}#{subject}/versions/#{version}",
+      expects: [200, 404], body: { schema: schema.to_s }.to_json, query: { verbose: true }, idempotent: true)
+
+    data.fetch('messages', []) unless data.has_key?('error_code')
+  end
+
   # Get global config
   def global_config
     get("/config", idempotent: true)

data/lib/avro_turf/schema_store.rb

@@ -92,6 +92,6 @@ class AvroTurf::SchemaStore
 
   def build_schema_path(fullname)
     *namespace, schema_name = fullname.split(".")
-    schema_path = File.join(@path, *namespace, schema_name + ".avsc")
+    File.join(@path, *namespace, "#{schema_name}.avsc")
   end
 end

data/lib/avro_turf/version.rb

@@ -1,3 +1,3 @@
 class AvroTurf
-  VERSION = "1.17.0"
+  VERSION = "1.18.0"
 end

data/spec/messaging_spec.rb

@@ -1,7 +1,5 @@
 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" }
@@ -61,8 +59,8 @@ describe AvroTurf::Messaging do
   end
 
   before do
-    stub_request(:any, /^#{registry_url}/).to_rack(FakeConfluentSchemaRegistryServer)
-    FakeConfluentSchemaRegistryServer.clear
+    stub_request(:any, /^#{registry_url}/).to_rack(AuthorizedFakeConfluentSchemaRegistryServer)
+    AuthorizedFakeConfluentSchemaRegistryServer.clear
   end
 
   before do
@@ -474,8 +472,8 @@ describe AvroTurf::Messaging do
     }
 
     before do
-      stub_request(:any, /^#{registry_url}/).to_rack(FakePrefixedConfluentSchemaRegistryServer)
-      FakePrefixedConfluentSchemaRegistryServer.clear
+      stub_request(:any, /^#{registry_url}/).to_rack(AuthorizedFakePrefixedConfluentSchemaRegistryServer)
+      AuthorizedFakePrefixedConfluentSchemaRegistryServer.clear
     end
 
     it_behaves_like "encoding and decoding with the schema from schema store"

data/spec/support/authorized_fake_confluent_schema_registry_server.rb

@@ -0,0 +1,5 @@
+require 'avro_turf/test/fake_confluent_schema_registry_server'
+
+class AuthorizedFakeConfluentSchemaRegistryServer < FakeConfluentSchemaRegistryServer
+  set :host_authorization, permitted_hosts: ['example.org', 'registry.example.com']
+end

data/spec/support/authorized_fake_prefixed_confluent_schema_registry_server.rb

@@ -0,0 +1,5 @@
+require 'avro_turf/test/fake_prefixed_confluent_schema_registry_server'
+
+class AuthorizedFakePrefixedConfluentSchemaRegistryServer < FakePrefixedConfluentSchemaRegistryServer
+  set :host_authorization, permitted_hosts: ['example.org', 'registry.example.com']
+end

data/spec/support/confluent_schema_registry_context.rb

@@ -26,9 +26,9 @@ shared_examples_for "a confluent schema registry client" do |schema_context: nil
   before do
     stub_request(:any, /^#{registry_url}/)
       .with(headers: headers)
-      .to_rack(FakeConfluentSchemaRegistryServer)
+      .to_rack(AuthorizedFakeConfluentSchemaRegistryServer)
 
-    FakeConfluentSchemaRegistryServer.clear
+    AuthorizedFakeConfluentSchemaRegistryServer.clear
   end
 
   describe "#register and #fetch" do

data/spec/test/fake_confluent_schema_registry_server_spec.rb

@@ -1,10 +1,9 @@
 require 'rack/test'
-require 'avro_turf/test/fake_confluent_schema_registry_server'
 
 describe FakeConfluentSchemaRegistryServer do
   include Rack::Test::Methods
 
-  def app; described_class; end
+  def app; AuthorizedFakeConfluentSchemaRegistryServer; end
 
   describe 'POST /subjects/:subject/versions' do
     it 'returns the same schema ID when invoked with same schema and same subject' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro_turf
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -236,6 +236,8 @@ files:
 - spec/schema_store_spec.rb
 - spec/schema_to_avro_patch_spec.rb
 - spec/spec_helper.rb
+- spec/support/authorized_fake_confluent_schema_registry_server.rb
+- spec/support/authorized_fake_prefixed_confluent_schema_registry_server.rb
 - spec/support/confluent_schema_registry_context.rb
 - spec/test/fake_confluent_schema_registry_server_spec.rb
 homepage: https://github.com/dasch/avro_turf
@@ -266,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: A library that makes it easier to use the Avro serialization format from
@@ -290,5 +292,7 @@ test_files:
 - spec/schema_store_spec.rb
 - spec/schema_to_avro_patch_spec.rb
 - spec/spec_helper.rb
+- spec/support/authorized_fake_confluent_schema_registry_server.rb
+- spec/support/authorized_fake_prefixed_confluent_schema_registry_server.rb
 - spec/support/confluent_schema_registry_context.rb
 - spec/test/fake_confluent_schema_registry_server_spec.rb