kafka_rest_client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f604a5dc722bd5ab97847866e46f6326774bc4b5
-  data.tar.gz: 3d0d283bb69fe749ea2beb0c633e8f4119a190e7
+  metadata.gz: 9497ee5597ab5815d3ed45ccf8cda2b727b52dcf
+  data.tar.gz: d5cae81efa60f85790db320eec4add0bc816dd1d
 SHA512:
-  metadata.gz: b1f3a451c16bd800b1c521aea53faf45dfd4610d326f7c7b201daf975e6114e2260046de1bbc424f15a3afbb70c46ee63f5b3dbe167bbb331a07f9a7d876fcad
-  data.tar.gz: 2806b9c5e14cddc9df9ca8e17225830f54594860651758aeec031946a196abee1e552d1d53e9a64c478f333669c887875b1a0ae414650ff70f2cd28f90e8433a
+  metadata.gz: 83020327a759b9911b1ce1bf81a88d08d39743ca43967b7ee39408a45787271f2cb0b10e110efe3104e786577e4b3b0eee567a29570562dfd3e4bae8391a86b6
+  data.tar.gz: 8a3aa2ce7671c8ec923e63f99675092ce3340c2fea9a087964b598a95505b9a55b7f612bba5e25d92fdc378ce6da288919e4b0e7a3a2d2ceb93a9151d28a7b1e

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby client to interact with [Kafka REST Proxy](http://docs.confluent.io/1.0.1/kafka-rest/docs/index.html)
 
-**Current Version:** 0.1.0
+**Current Version:** 0.2.1
 
 **Supported Ruby versions:** 2.0, 2.1, 2.2
 
@@ -11,37 +11,43 @@ A Ruby client to interact with [Kafka REST Proxy](http://docs.confluent.io/1.0.1
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kafka_rest_client', git: 'git@github.com:FundingCircle/kafka_rest_client.git', tag: 'v0.1.0'
+gem 'kafka_rest_client', git: 'git@github.com:FundingCircle/kafka_rest_client.git', tag: 'v0.2.1'
 ```
 
 ## Usage
+### Configuration
 
-### Producing events
 ```ruby
-require 'kafka_rest_client'
-
 # Configure global settings
+# The client is disabled if kafka_proxy_url and schema_registry_url are not set
 KafkaRestClient.configure do |config|
   config.kafka_proxy_url = ENV['KAFKA_PROXY_URL']
   config.schema_registry_url = ENV['SCHEMA_REGISTRY_URL']
   config.timeout = 10
   config.logger = Rails.logger
 end
+```
+
+### Producing events
+```ruby
+require 'kafka_rest_client'
 
 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
+# The schema_id will be fetched from the schema registry by looking up a schema
+# with the "#{topic}-value" 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
+# The schema_id will be fetched from the schema registry by looking up a schema
+# with the "#{topic}-value" 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
+# Produce an event providing the full schema as a JSON string
 schema = {
   type: 'record',
   name: 'IceCreamMelted',
@@ -71,6 +77,8 @@ 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 Net::ReadTimeout => e
+ # Rescue read timeout errors
 end
 ```
 

data/kafka_rest_client.gemspec

@@ -4,9 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'kafka_rest_client'
-  spec.version       = '0.2.0'
+  spec.version       = '0.2.1'
   spec.authors       = ['Funding Circle Engineering']
   spec.email         = ['engineering+kafka_rest_client@fundingcircle.com']
+  spec.licenses      = ['BSD-3-Clause']
 
   spec.summary       = 'Ruby client for interacting with Kafka REST Proxy'
   spec.description   = 'Ruby client for interacting with Kafka REST Proxy'

data/lib/kafka_rest_client/configuration.rb

@@ -5,6 +5,10 @@ module KafkaRestClient
     attr_accessor :kafka_proxy_url, :schema_registry_url, :timeout, :logger
     class << self
       attr_accessor :current
+
+      def current
+        @current ||= Configuration.new
+      end
     end
 
     def initialize(options = {})
@@ -15,12 +19,12 @@ module KafkaRestClient
     end
 
     def timeout
-      @timeout ||= 30
+      @timeout ||= 30 # seconds
     end
 
     def logger
       @logger ||= Logger.new(STDOUT).tap do |logger|
-        # Set level too high so we don't log anything
+        # Set level too high so we don't log anything by default
         logger.level = Logger::FATAL
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kafka_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Funding Circle Engineering
@@ -159,7 +159,8 @@ files:
 - lib/kafka_rest_client/configuration.rb
 - lib/kafka_rest_client/errors.rb
 homepage: http://github.com/FundingCircle/kakfa_rest_client
-licenses: []
+licenses:
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []