avro_turf 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e1ca443d93f4f1c38b9626ad1a83db6352a4aac397256a8a3bfae2ca462d9c
-  data.tar.gz: 2621ae9378b2511cee81522247c5f4df883ee9c25efe92839cdc5af22543bc1f
+  metadata.gz: fffcc17349a4bbbcaa1204610da74800c9a519d4774af83c7059c47bb75efb1b
+  data.tar.gz: e5afce0fa557da110a0dd1fe73add073f994a72bb8e3a1e37865a3393f864c2b
 SHA512:
-  metadata.gz: 56f2e3885be65423da7be65fe067151b3fd270ce13af76455a0f71cccbf6d68b09661e75f882c50ea9745f9cdc21e78ce8bd527d8123fa4b0c094dfaf6baa03a
-  data.tar.gz: 4b8e92503870f8c83c8af5457786da3c83823706d957a96986488f2800166ae02846141e9eeb28c261c6b0e0f5d7922244f65dfb47e39bbc96a9a29fea075e55
+  metadata.gz: 06aac90715b06f0fdf04918ba73c2533a0cad0b9dff769e1bfc30a1488e0916fc3b38c8f4bee6efab5d667688bd9d407330c603f209ead30d67cb13b3b46c4a5
+  data.tar.gz: 1a3c95047a2522914394b181eaf01afaee84547d64a72d1aebe3534252f49168cebec0cf7edda8bc8a62f769dd22294eb3916d317a71a65305cb6c46ffba84ad

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## v1.19.0
+
+- Loosen excon dependency to allow 1.x (#220)
+
+## 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/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in avro_turf.gemspec
 gemspec
+
+gem 'gem-release'

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_authorization, 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/avro_turf.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "avro", ">= 1.11.3", "< 1.13"
-  spec.add_dependency "excon", "~> 0.104"
+  spec.add_dependency "excon", ">= 0.104", "< 2"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"

data/lib/avro_turf/confluent_schema_registry.rb

@@ -18,7 +18,8 @@ class AvroTurf::ConfluentSchemaRegistry
     client_key_data: nil,
     path_prefix: nil,
     connect_timeout: nil,
-    resolv_resolver: nil
+    resolv_resolver: nil,
+    retry_limit: nil
   )
     @path_prefix = path_prefix
     @schema_context_prefix = schema_context.nil? ? '' : ":.#{schema_context}:"
@@ -27,20 +28,26 @@ class AvroTurf::ConfluentSchemaRegistry
     headers = Excon.defaults[:headers].merge(
       "Content-Type" => CONTENT_TYPE
     )
-    headers[:proxy] = proxy unless proxy.nil?
-    @connection = Excon.new(
-      url,
+    params = {
       headers: headers,
       user: user,
       password: password,
+      proxy: proxy,
       ssl_ca_file: ssl_ca_file,
       client_cert: client_cert,
       client_key: client_key,
       client_key_pass: client_key_pass,
       client_cert_data: client_cert_data,
       client_key_data: client_key_data,
+      resolv_resolver: resolv_resolver,
       connect_timeout: connect_timeout,
-      resolv_resolver: resolv_resolver
+      retry_limit: retry_limit
+    }
+    # Remove nil params to allow Excon to use its default values
+    params.reject! { |_, v| v.nil? }
+    @connection = Excon.new(
+      url,
+      params
     )
   end
 
@@ -101,6 +108,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/messaging.rb

@@ -10,6 +10,7 @@ require 'avro_turf/schema_registry'
 require 'avro_turf/cached_schema_registry'
 
 class AvroTurf
+  class IncompatibleSchemaError < StandardError; end
 
   # Provides a way to encode and decode messages without having to embed schemas
   # in the encoded data. Confluent's Schema Registry[1] is used to register
@@ -77,7 +78,8 @@ class AvroTurf
       client_cert_data: nil,
       client_key_data: nil,
       connect_timeout: nil,
-      resolv_resolver: nil
+      resolv_resolver: nil,
+      retry_limit: nil
     )
       @logger = logger || Logger.new($stderr)
       @namespace = namespace
@@ -98,7 +100,8 @@ class AvroTurf
           client_key_data: client_key_data,
           path_prefix: registry_path_prefix,
           connect_timeout: connect_timeout,
-          resolv_resolver: resolv_resolver
+          resolv_resolver: resolv_resolver,
+          retry_limit: retry_limit
         )
       )
       @schemas_by_id = {}
@@ -216,11 +219,15 @@ class AvroTurf
     end
 
     # Providing subject and version to determine the schema,
-    # which skips the auto registeration of schema on the schema registry.
+    # which skips the auto registration of schema on the schema registry.
     # Fetch the schema from registry with the provided subject name and version.
     def fetch_schema(subject:, version: 'latest')
       schema_data = @registry.subject_version(subject, version)
       schema_id = schema_data.fetch('id')
+      schema_type = schema_data['schemaType']
+      if schema_type && schema_type != "AVRO"
+        raise IncompatibleSchemaError, "The #{schema_type} schema for #{subject} is incompatible."
+      end
       schema = Avro::Schema.parse(schema_data.fetch('schema'))
       [schema, schema_id]
     end

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.19.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
@@ -379,6 +377,18 @@ describe AvroTurf::Messaging do
       it 'gets schema from registry' do
         expect(subject).to eq([schema, schema_id])
       end
+
+      context "with an incompatible schema type" do
+        let(:response) { {'id' => schema_id, 'schema' => 'blah', 'schemaType' => schema_type } }
+        let(:schema_type) { 'PROTOBUF' }
+
+        it 'raises IncompatibleSchemaError' do
+          expect { subject }.to raise_error(
+            AvroTurf::IncompatibleSchemaError,
+            "The #{schema_type} schema for #{subj} is incompatible."
+          )
+        end
+      end
     end
 
     context 'using fetch_schema_by_id' do
@@ -474,8 +484,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"
@@ -506,6 +516,54 @@ describe AvroTurf::Messaging do
     end
   end
 
+  context 'with a connect timeout' do
+    let(:avro) {
+      AvroTurf::Messaging.new(
+        registry_url: registry_url,
+        schemas_path: "spec/schemas",
+        logger: logger,
+        client_cert: client_cert,
+        client_key: client_key,
+        client_key_pass: client_key_pass,
+        retry_limit: 5
+      )
+    }
+
+    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'
+
+    it 'passes the connect timeout setting to Excon' do
+      expect(Excon).to receive(:new).with(anything, hash_including(retry_limit: 5)).and_call_original
+      avro
+    end
+  end
+
+  context 'with a proxy' do
+    let(:proxy_url) { 'http://proxy.example.com' }
+    let(:avro) {
+      AvroTurf::Messaging.new(
+        registry_url: registry_url,
+        schemas_path: "spec/schemas",
+        logger: logger,
+        client_cert: client_cert,
+        client_key: client_key,
+        client_key_pass: client_key_pass,
+        proxy: proxy_url
+      )
+    }
+
+    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'
+
+    it 'passes the proxy setting to Excon' do
+      expect(Excon).to receive(:new).with(anything, hash_including(proxy: proxy_url)).and_call_original
+      avro
+    end
+  end
+
+
   context 'with a custom domain name resolver' do
     let(:resolv_resolver) { Resolv.new([Resolv::Hosts.new, Resolv::DNS.new(nameserver: ['127.0.0.1', '127.0.0.1'])]) }
     let(:avro) {

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

@@ -18,7 +18,7 @@ shared_examples_for "a confluent schema registry client" do |schema_context: nil
     {
       'Accept'=>'*/*',
       'Content-Type'=> AvroTurf::ConfluentSchemaRegistry::CONTENT_TYPE,
-      'Host'=> "#{URI.parse(registry_url).host}:80",
+      'Host'=> "#{URI.parse(registry_url).host}",
       'User-Agent'=> "excon/#{Excon::VERSION}"
     }
   end
@@ -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,13 @@
 --- !ruby/object:Gem::Specification
 name: avro_turf
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Daniel Schierbeck
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -34,16 +33,22 @@ dependencies:
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.104'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.104'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,7 +175,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - dasch@zendesk.com
 executables: []
@@ -236,6 +240,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,8 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A library that makes it easier to use the Avro serialization format from
   Ruby
@@ -290,5 +295,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