kafka-rb 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Alejandro Crosa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# kafka-rb
+kafka-rb allows you to produce messages to the Kafka distributed publish/subscribe messaging service.
+
+## Requirements
+You need to have access to your Kafka instance and be able to connect through TCP. You can obtain a copy and instructions on how to setup kafka at https://github.com/kafka-dev/kafka
+
+## Installation
+sudo gem install kafka-rb
+
+(the code works fine with JRuby, Ruby 1.8x and Ruby 1.9.x)
+
+## Usage
+
+### Sending a simple message
+
+require 'kafka-rb'
+
+producer = Kafka::Producer.new
+
+message = Kafka::Message.new("some random message content")
+
+producer.send(message)
+
+### sending a sequence of messages
+
+require 'kafka-rb'
+
+producer = Kafka::Producer.new
+
+message1 = Kafka::Message.new("some random message content")
+
+message2 = Kafka::Message.new("some more content")
+
+producer.send([message1, message2])
+
+### batching a bunch of messages using the block syntax
+
+require 'kafka-rb'
+
+producer = Kafka::Producer.new
+
+producer.batch do |messages|
+
+  puts "Batching a send of multiple messages.."
+
+  messages << Kafka::Message.new("first message to send")
+
+  messages << Kafka::Message.new("second message to send")
+
+end
+
+* they will be sent all at once, after the block execution

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = 'kafka-rb'
+GEM_NAME = 'Kafka Client Producer'
+GEM_VERSION = '0.0.1'
+AUTHORS = ['Alejandro Crosa']
+EMAIL = "alejandrocrosa@gmail.com"
+HOMEPAGE = "http://github.com/acrosa/kafka-rb"
+SUMMARY = "A Ruby client for the Kafka distributed publish/subscribe messaging service"
+DESCRIPTION = "kafka-rb allows you to produce messages to the Kafka distributed publish/subscribe messaging service."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["LICENSE"]
+  s.summary = SUMMARY
+  s.description = DESCRIPTION
+  s.authors = AUTHORS
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_development_dependency "rspec"
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.md Rakefile) + Dir.glob("{lib,tasks,spec}/**/*")
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end

data/lib/kafka/io.rb

@@ -0,0 +1,30 @@
+module Kafka
+  module IO
+    attr_accessor :socket, :host, :port
+
+    def connect(host, port)
+      raise ArgumentError, "No host or port specified" unless host && port
+      self.host = host
+      self.port = port
+      self.socket = TCPSocket.new(host, port)
+    end
+
+    def reconnect
+      self.disconnect
+      self.socket = self.connect(self.host, self.port)
+    end
+
+    def disconnect
+      self.socket.close rescue nil
+      self.socket = nil
+    end
+
+    def write(data)
+      self.reconnect unless self.socket
+      self.socket.write(data)
+    rescue Errno::ECONNRESET, Errno::EPIPE, Errno::ECONNABORTED
+      self.reconnect
+      self.socket.write(data) # retry
+    end
+  end
+end

data/lib/kafka/message.rb

@@ -0,0 +1,25 @@
+module Kafka
+
+  # A message. The format of an N byte message is the following:
+  # 1 byte "magic" identifier to allow format changes
+  # 4 byte CRC32 of the payload
+  # N - 5 byte payload
+  class Message
+    MAGIC_IDENTIFIER_DEFAULT = 0
+    attr_accessor :magic, :checksum, :payload
+
+    def initialize(payload = nil, magic = MAGIC_IDENTIFIER_DEFAULT)
+      self.magic = magic
+      self.payload = payload
+      self.checksum = self.calculate_checksum
+    end
+
+    def calculate_checksum
+      Zlib.crc32(self.payload)
+    end
+
+    def valid?
+      self.checksum == Zlib.crc32(self.payload)
+    end
+  end
+end

data/lib/kafka/producer.rb

@@ -0,0 +1,49 @@
+module Kafka
+  class Producer
+
+    include Kafka::IO
+
+    PRODUCE_REQUEST_ID = 0
+
+    attr_accessor :topic, :partition
+
+    def initialize(options = {})
+      self.topic = options[:topic] || "test"
+      self.partition = options[:partition] || 0
+      self.host = options[:host] || "localhost"
+      self.port = options[:port] || 9092
+      self.connect(self.host, self.port)
+    end
+
+    def encode(message)
+      [message.magic].pack("C") + [message.calculate_checksum].pack("N") + message.payload.to_s
+    end
+
+    def encode_request(topic, partition, messages)
+      message_set = Array(messages).collect { |message|
+        encoded_message = self.encode(message)
+        [encoded_message.length].pack("N") + encoded_message
+      }.join("")
+
+      request   = [PRODUCE_REQUEST_ID].pack("n")
+      topic     = [topic.length].pack("n") + topic
+      partition = [partition].pack("N")
+      messages  = [message_set.length].pack("N") + message_set
+
+      data = request + topic + partition + messages
+
+      return [data.length].pack("N") + data
+    end
+
+    def send(messages)
+      self.write(self.encode_request(self.topic, self.partition, messages))
+    end
+
+    def batch(&block)
+      batch = Kafka::Batch.new
+      block.call( batch )
+      self.send(batch.messages)
+      batch.messages.clear
+    end
+  end
+end

data/lib/kafka.rb

@@ -0,0 +1,9 @@
+require 'socket'
+require 'zlib'
+require File.join(File.dirname(__FILE__), "kafka", "io")
+require File.join(File.dirname(__FILE__), "kafka", "batch")
+require File.join(File.dirname(__FILE__), "kafka", "message")
+require File.join(File.dirname(__FILE__), "kafka", "producer")
+
+module Kafka
+end

data/lib/test.rb

@@ -0,0 +1,32 @@
+$KCODE = 'UTF-8'
+
+require 'zlib'
+
+PRODUCE_REQUEST_ID = 0
+
+def encode_message(message)
+    # <MAGIC_BYTE: char> <CRC32: int> <PAYLOAD: bytes>
+    data = [0].pack("C").to_s + [Zlib.crc32(message)].pack('N').to_s + message
+    # print ("CHECKSUM " + Zlib.crc32(message).to_s)
+    # print ("MES " + data.length.to_s)
+    return data
+end
+# encode_message("ale")
+
+def encode_produce_request(topic, partition, messages)
+    encoded = messages.collect { |m| encode_message(m) }
+    message_set = encoded.collect { |e| puts "Message size #{e.length}"; [e.length].pack("N") + e }.join("")
+
+    puts "MESSAGE"
+    puts message_set.inspect
+
+    data = [PRODUCE_REQUEST_ID].pack("n") + \
+           [topic.length].pack("n") + topic.to_s + \
+           [partition].pack("N") + \
+           [message_set.length].pack("N") + message_set
+    puts "DATA " + message_set.length.to_s
+    return [data.length].pack("N") + data
+end
+
+socket = TCPSocket.open("localhost", 9092)
+socket.write encode_produce_request("test", 0, ["ale"])

data/spec/io_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class IOTest
+  include Kafka::IO
+end
+
+describe IO do
+
+  before(:each) do
+    @mocked_socket = mock(TCPSocket)
+    TCPSocket.stub!(:new).and_return(@mocked_socket) # don't use a real socket
+    @io = IOTest.new
+    @io.connect("somehost", 9093)
+  end
+
+  describe "default methods" do
+    it "has a socket, a host and a port" do
+      [:socket, :host, :port].each do |m|
+        @io.should respond_to(m.to_sym)
+      end
+    end
+
+    it "raises an exception if no host and port is specified" do
+      lambda {
+        io = IOTest.new
+        io.connect
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should remember the port and host on connect" do
+      @io.connect("somehost", 9093)
+      @io.host.should eql("somehost")
+      @io.port.should eql(9093)
+    end
+
+    it "should write to a socket" do
+      data = "some data"
+      @mocked_socket.should_receive(:write).with(data).and_return(9)
+      @io.write(data).should eql(9)
+    end
+
+    it "should disconnect" do
+      @io.should respond_to(:disconnect)
+      @mocked_socket.should_receive(:close).and_return(nil)
+      @io.disconnect
+    end
+
+    it "should reconnect" do
+      @mocked_socket.should_receive(:close)
+      @io.should_receive(:connect)
+      @io.reconnect
+    end
+
+    it "should reconnect on a broken pipe error" do
+      [Errno::ECONNABORTED, Errno::EPIPE, Errno::ECONNRESET].each do |error|
+        @mocked_socket.should_receive(:write).exactly(:twice).and_raise(error)
+        @mocked_socket.should_receive(:close).exactly(:once).and_return(nil)
+        lambda {
+          @io.write("some data to send")
+        }.should raise_error(error)
+      end
+    end
+  end
+end

data/spec/kafka_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Kafka do
+
+  before(:each) do
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Message do
+
+  before(:each) do
+    @message = Message.new
+  end
+
+  describe "Kafka Message" do
+    it "should have a default magic number" do
+      Message::MAGIC_IDENTIFIER_DEFAULT.should eql(0)
+    end
+
+    it "should have a magic field, a checksum and a payload" do
+      [:magic, :checksum, :payload].each do |field|
+        @message.should respond_to(field.to_sym)
+      end
+    end
+
+    it "should set a default value of zero" do
+      @message.magic.should eql(Kafka::Message::MAGIC_IDENTIFIER_DEFAULT)
+    end
+
+    it "should allow to set a custom magic number" do
+      @message = Message.new("ale", 1)
+      @message.magic.should eql(1)
+    end
+
+    it "should calculate the checksum (crc32 of a given message)" do
+      @message.payload = "ale"
+      @message.calculate_checksum.should eql(1120192889)
+      @message.payload = "alejandro"
+      @message.calculate_checksum.should eql(2865078607)
+    end
+
+    it "should say if the message is valid using the crc32 signature" do
+      @message.payload  = "alejandro"
+      @message.checksum = 2865078607
+      @message.valid?.should eql(true)
+      @message.checksum = 0
+      @message.valid?.should eql(false)
+    end
+  end
+end

data/spec/producer_spec.rb

@@ -0,0 +1,95 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Producer do
+
+  before(:each) do
+    @mocked_socket = mock(TCPSocket)
+    TCPSocket.stub!(:new).and_return(@mocked_socket) # don't use a real socket
+    @producer = Producer.new
+  end
+
+  describe "Kafka Producer" do
+    it "should have a PRODUCE_REQUEST_ID" do
+      Producer::PRODUCE_REQUEST_ID.should eql(0)
+    end
+
+    it "should have a topic and a partition" do
+      @producer.should respond_to(:topic)
+      @producer.should respond_to(:partition)
+    end
+
+    it "should set a topic and partition on initialize" do
+      @producer = Producer.new({ :host => "localhost", :port => 9092, :topic => "testing" })
+      @producer.topic.should eql("testing")
+      @producer.partition.should eql(0)
+      @producer = Producer.new({ :topic => "testing", :partition => 3 })
+      @producer.partition.should eql(3)
+    end
+
+    it "should set default host and port if none is specified" do
+      @producer = Producer.new
+      @producer.host.should eql("localhost")
+      @producer.port.should eql(9092)
+    end
+
+    describe "Message Encoding" do
+      it "should encode a message" do
+        message = Kafka::Message.new("alejandro")
+        full_message = [message.magic].pack("C") + [message.calculate_checksum].pack("N") + message.payload
+        @producer.encode(message).should eql(full_message)
+      end
+      
+      it "should encode an empty message" do
+        message = Kafka::Message.new()
+        full_message = [message.magic].pack("C") + [message.calculate_checksum].pack("N") + message.payload.to_s
+        @producer.encode(message).should eql(full_message)
+      end
+    end
+
+    describe "Request Encoding" do
+      it "should binary encode an empty request" do
+        bytes = @producer.encode_request("test", 0, [])
+        bytes.length.should eql(20)
+        bytes.should eql("\000\000\000\020\000\000\000\004test\000\000\000\000\000\000\000\000")
+      end
+
+      it "should binary encode a request with a message, using a specific wire format" do
+        message = Kafka::Message.new("ale")
+        bytes = @producer.encode_request("test", 3, message)
+        data_size  = bytes[0, 4].unpack("N").shift
+        request_id = bytes[4, 2].unpack("n").shift
+        topic_length = bytes[6, 2].unpack("n").shift
+        topic = bytes[8, 4]
+        partition = bytes[12, 4].unpack("N").shift
+        messages_length = bytes[16, 4].unpack("N").shift
+        messages = bytes[20, messages_length]
+
+        bytes.length.should eql(32)
+        data_size.should eql(28)
+        request_id.should eql(0)
+        topic_length.should eql(4)
+        topic.should eql("test")
+        partition.should eql(3)
+        messages_length.should eql(12)
+      end
+    end
+  end
+
+  it "should send messages" do
+    @producer.should_receive(:write).and_return(32)
+    message = Kafka::Message.new("ale")
+    @producer.send(message).should eql(32)
+  end
+
+  describe "Message Batching" do
+    it "should batch messages and send them at once" do
+      message1 = Kafka::Message.new("one")
+      message2 = Kafka::Message.new("two")
+      @producer.should_receive(:send).with([message1, message2]).exactly(:once).and_return(nil)
+      @producer.batch do |messages|
+        messages << message1
+        messages << message2
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'kafka'
+
+include Kafka

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: kafka-rb
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alejandro Crosa
+autorequire: kafka-rb
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: kafka-rb allows you to produce messages to the Kafka distributed publish/subscribe messaging service.
+email: alejandrocrosa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/kafka/io.rb
+- lib/kafka/message.rb
+- lib/kafka/producer.rb
+- lib/kafka.rb
+- lib/test.rb
+- spec/io_spec.rb
+- spec/kafka_spec.rb
+- spec/message_spec.rb
+- spec/producer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/acrosa/kafka-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Kafka distributed publish/subscribe messaging service
+test_files: []
+