kafka_rest_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55eaec42836887d93b9460701cdca823c0f63f77
-  data.tar.gz: b6eeb11b3fa7c973c2b3d51fe00631f5b92b63d6
+  metadata.gz: f604a5dc722bd5ab97847866e46f6326774bc4b5
+  data.tar.gz: 3d0d283bb69fe749ea2beb0c633e8f4119a190e7
 SHA512:
-  metadata.gz: d9af06c6d72c0284905b76883f4dfc338eae7c6d39bfdb54ffefede69cd8b6462b1ac761085fced8340d9a274b7f76a46ae0ded6d59c5979fe13b9a1f49fa456
-  data.tar.gz: 3ac7cd879e202aea4ef4010099f3816455cd796d9545b316768a54098905a57e8b30f915fdb50acaae0b1f02f9b264d9f48b7e3e49261e4c2c0b977927366c3c
+  metadata.gz: b1f3a451c16bd800b1c521aea53faf45dfd4610d326f7c7b201daf975e6114e2260046de1bbc424f15a3afbb70c46ee63f5b3dbe167bbb331a07f9a7d876fcad
+  data.tar.gz: 2806b9c5e14cddc9df9ca8e17225830f54594860651758aeec031946a196abee1e552d1d53e9a64c478f333669c887875b1a0ae414650ff70f2cd28f90e8433a

data/README.md

@@ -31,11 +31,24 @@ end
 producer = KafkaRestClient::AvroProducer.new
 
 # Produce a single event using the topic name and payload
+# The schema will be fetched from the schema registry based on the topic name
 producer.produce('ice-cream-melted', { temperature: 35, unit: 'celsius' })
 
 # Produce multiple events
+# The schema will also be fetched from the schema registry based on the topic name
 producer.produce('ice-cream-melted', [{ temperature: 35, unit: 'celsius' }])
 
+# Produce an event providing the schema id
+producer.produce('ice-cream-melted', { temperature: 35, unit: 'celsius' }, value_schema_id: 1)
+
+# Produce an event providing the full schema
+schema = {
+  type: 'record',
+  name: 'IceCreamMelted',
+  fields: [{ name: 'Temperature', type: 'string' }, { name: 'Unit', type: 'string' }]
+}
+producer.produce('ice-cream-melted', { temperature: 35, unit: 'celsius' }, value_schema: schema.to_json)
+
 # Produce event objects by relying on #to_json and #as_json when using Rails ActiveSupport
 class IceCreamMeltedEvent
   attr_reader :temperature, :unit
@@ -58,8 +71,6 @@ rescue KafkaRestClient::SchemaNotFoundError => e
  # Schema has not been registered in the schema registry
 rescue KafkaRestClient::TopicNotFoundError => e
  # Topic does not exist in Kafka, create it with confluent tools
-rescue KafkaRestClient::Error => e
- # Rescue any error raised by the library
 end
 ```
 

data/kafka_rest_client.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'kafka_rest_client'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Funding Circle Engineering']
   spec.email         = ['engineering+kafka_rest_client@fundingcircle.com']
 

data/lib/kafka_rest_client/avro_producer.rb

@@ -22,9 +22,9 @@ module KafkaRestClient
       end
     end
 
-    def produce(topic, events)
+    def produce(topic, events, options = {})
       if enabled?
-        payload  = build_event_payload(topic, Array(events))
+        payload  = build_event_payload(topic, Array(events), options)
         response = post_event_to_kafka(topic, payload)
         config.logger.debug("Produced to Kafka topic #{topic}: #{payload.inspect}")
         response
@@ -33,11 +33,16 @@ module KafkaRestClient
 
     private
 
-    def build_event_payload(topic, events)
-      {
-        value_schema_id: get_latest_schema(topic).fetch('id'),
-        records: events.map { |event| { value: event } }
-      }
+    def build_event_payload(topic, events, options)
+      payload = { records: events.map { |event| { value: event } } }.merge(
+        options.select { |k, _| [:value_schema_id, :value_schema].include?(k) }
+      )
+
+      if !options[:value_schema_id] && !options[:value_schema]
+        payload[:value_schema_id] = get_latest_schema(topic).fetch('id')
+      end
+
+      payload
     end
 
     def get_latest_schema(topic)
@@ -55,7 +60,7 @@ module KafkaRestClient
       elsif response.code == 503
         fail BadGateway, "Bad gateway: #{response.body}"
       else
-        fail "Unexpected error: #{response.body}"
+        fail Error, "HTTP status: #{response.code} #{response.body}"
       end
     end
 
@@ -71,7 +76,7 @@ module KafkaRestClient
         config.logger.debug("#{message[:records].count} event(s) published on #{topic}")
         JSON.parse(response.body)
       elsif response.code == 404
-        fail SchemaNotFoundError,
+        fail TopicNotFoundError,
              "Topic #{topic} not found in schema registry"
       elsif response.code == 422
         fail SchemaValidationError,
@@ -82,7 +87,7 @@ module KafkaRestClient
       elsif response.code == 503
         fail BadGateway, "Bad gateway: #{response.body}"
       else
-        fail "Unexpected error: #{response.body}"
+        fail Error, "HTTP status: #{response.code} #{response.body}"
       end
     end
   end

data/lib/kafka_rest_client/errors.rb

@@ -5,6 +5,9 @@ module KafkaRestClient
   # Exception raised when the desired schema is not found (404 response code)
   class SchemaNotFoundError < Error; end
 
+  # Exception raised when the desired topic is not found (404 response code)
+  class TopicNotFoundError < Error; end
+
   # Exception raised on an internal server error (500 response code)
   class InternalServerError < Error; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kafka_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Funding Circle Engineering