rdkafka 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e665ee94b4d29ec2c4d618540ed4588a6af3cfe8
-  data.tar.gz: 7ad4f0ca3651861441bbe6009a503105e2c7f8c7
+  metadata.gz: 67acc1069396798fdb93129b30145d277af826c3
+  data.tar.gz: 664621fc32610b18703d393c34e72d64d7f34527
 SHA512:
-  metadata.gz: 712032c6802290695e4a4be376829c76da6d346b9af8d365e218f3edad511931526553625e7acdf588d1b71779bac2bcbcab43ac0b599ca1be3f592d0aac9759
-  data.tar.gz: 60c30f707e2112aaa63603429208a8fb98778dd5c08d3b29f8c700e6646755fbf1803d1258cf9701ba985636f2eb0eb2eed9bf623dbf174ac85bd2a3fc1bc21a
+  metadata.gz: 471c14981fe5ba4c4b2a14d724236d498d483cb02b4f93c75217be5455e0c14c2bef319b5186ffd2b74504dfe5175c9727776d28493d4f9b0da2a335572b90b6
+  data.tar.gz: ee82ae7f498c4fbcb553df0368f9a3bcb9df1045b7b413e1cab6aff70a5f93fb57e309f5abb096cc8886b9393cda88dc444f6eed9ed828714bd6bb12933a0e5f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.2
+* `add_topic` now supports using a partition count
+* Add way to make errors clearer with an extra message
+* Show topics in subscribe error message
+* Show partition and topic in query watermark offsets error message
+
 # 0.3.1
 * Bump librdkafka to 0.11.1
 * Officially support ranges in `add_topic` for topic partition list.

data/lib/rdkafka/consumer.rb

@@ -39,7 +39,7 @@ module Rdkafka
       # Subscribe to topic partition list and check this was successful
       response = Rdkafka::Bindings.rd_kafka_subscribe(@native_kafka, tpl)
       if response != 0
-        raise Rdkafka::RdkafkaError.new(response)
+        raise Rdkafka::RdkafkaError.new(response, "Error subscribing to '#{topics.join(', ')}'")
       end
     ensure
       # Clean up the topic partition list
@@ -117,7 +117,7 @@ module Rdkafka
         timeout_ms
       )
       if response != 0
-        raise Rdkafka::RdkafkaError.new(response)
+        raise Rdkafka::RdkafkaError.new(response, "Error querying watermark offsets for partition #{partition} of #{topic}")
       end
 
       return low.read_int64, high.read_int64

data/lib/rdkafka/consumer/topic_partition_list.rb

@@ -37,11 +37,17 @@ module Rdkafka
       # @example Add a topic with assigned partitions
       #   tpl.add_topic("topic", (0..8))
       #
+      # @example Add a topic with all topics up to a count
+      #   tpl.add_topic("topic", 9)
+      #
       # @param topic [String] The topic's name
-      # @param partition [Array<Integer>, Range<Integer>] The topic's partition's
+      # @param partition [Array<Integer>, Range<Integer>, Integer] The topic's partitions or partition count
       #
       # @return [nil]
       def add_topic(topic, partitions=nil)
+        if partitions.is_a? Integer
+          partitions = (0..partitions - 1)
+        end
         if partitions.nil?
           Rdkafka::Bindings.rd_kafka_topic_partition_list_add(
             @tpl,

data/lib/rdkafka/error.rb

@@ -3,12 +3,13 @@ module Rdkafka
   class RdkafkaError < RuntimeError
     # The underlying raw error response
     # @return [Integer]
-    attr_reader :rdkafka_response
+    attr_reader :rdkafka_response, :message
 
     # @private
-    def initialize(response)
+    def initialize(response, message=nil)
       raise TypeError.new("Response has to be an integer") unless response.is_a? Integer
       @rdkafka_response = response
+      @message = message
     end
 
     # This error's code, for example `:partition_eof`, `:msg_size_too_large`.
@@ -25,7 +26,12 @@ module Rdkafka
     # Human readable representation of this error.
     # @return [String]
     def to_s
-      "#{Rdkafka::Bindings.rd_kafka_err2str(@rdkafka_response)} (#{code})"
+      message_part = if message
+                       "#{message} - "
+                     else
+                       ''
+                     end
+      "#{message_part}#{Rdkafka::Bindings.rd_kafka_err2str(@rdkafka_response)} (#{code})"
     end
 
     # Whether this error indicates the partition is EOF.

data/lib/rdkafka/version.rb

@@ -1,4 +1,4 @@
 module Rdkafka
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
   LIBRDKAFKA_VERSION = "0.11.1"
 end

data/spec/rdkafka/consumer/topic_partition_list_spec.rb

@@ -87,6 +87,31 @@ describe Rdkafka::Consumer::TopicPartitionList do
     ])
   end
 
+  it "should create a new list and add assigned topics as a count" do
+    list = Rdkafka::Consumer::TopicPartitionList.new
+
+    expect(list.count).to eq 0
+    expect(list.empty?).to be true
+
+    list.add_topic("topic1", 3)
+    list.add_topic("topic2", 2)
+
+    expect(list.count).to eq 5
+    expect(list.empty?).to be false
+
+    hash = list.to_h
+    expect(hash.count).to eq 2
+    expect(hash["topic1"]).to eq([
+      Rdkafka::Consumer::Partition.new(0, -1001),
+      Rdkafka::Consumer::Partition.new(1, -1001),
+      Rdkafka::Consumer::Partition.new(2, -1001)
+    ])
+    expect(hash["topic2"]).to eq([
+      Rdkafka::Consumer::Partition.new(0, -1001),
+      Rdkafka::Consumer::Partition.new(1, -1001)
+    ])
+  end
+
   describe "#to_s" do
     it "should return a human readable representation" do
       list = Rdkafka::Consumer::TopicPartitionList.new

data/spec/rdkafka/error_spec.rb

@@ -7,6 +7,10 @@ describe Rdkafka::RdkafkaError do
     }.to raise_error TypeError
   end
 
+  it "should create an error with a message" do
+    expect(Rdkafka::RdkafkaError.new(10, "message").message).to eq "message"
+  end
+
   describe "#code" do
     it "should handle an invalid response" do
       expect(Rdkafka::RdkafkaError.new(933975).code).to eq :err_933975?
@@ -29,6 +33,10 @@ describe Rdkafka::RdkafkaError do
     it "should return error messages from rdkafka" do
       expect(Rdkafka::RdkafkaError.new(10).to_s).to eq "Broker: Message size too large (msg_size_too_large)"
     end
+
+    it "should show the message if present" do
+      expect(Rdkafka::RdkafkaError.new(10, "Error explanation").to_s).to eq "Error explanation - Broker: Message size too large (msg_size_too_large)"
+    end
   end
 
   describe "#is_partition_eof?" do
@@ -40,4 +48,24 @@ describe Rdkafka::RdkafkaError do
       expect(Rdkafka::RdkafkaError.new(-191).is_partition_eof?).to be true
     end
   end
+
+  describe "#==" do
+    subject { Rdkafka::RdkafkaError.new(10, "Error explanation") }
+
+    it "should equal another error with the same content" do
+      expect(subject).to eq Rdkafka::RdkafkaError.new(10, "Error explanation")
+    end
+
+    it "should not equal another error with a different error code" do
+      expect(subject).to eq Rdkafka::RdkafkaError.new(20, "Error explanation")
+    end
+
+    it "should not equal another error with a different message" do
+      expect(subject).to eq Rdkafka::RdkafkaError.new(10, "Different error explanation")
+    end
+
+    it "should not equal another error with no message" do
+      expect(subject).to eq Rdkafka::RdkafkaError.new(10)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdkafka
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Thijs Cadier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-23 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi