wooga-kafka-rb 0.0.7

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,62 @@
+# 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'
+    producer = Kafka::Producer.new
+    message = Kafka::Message.new("some random message content")
+    producer.send(message)
+
+### Sending a sequence of messages
+
+    require 'kafka'
+    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'
+    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
+
+### Consuming messages one by one
+
+    require 'kafka'
+    consumer = Kafka::Consumer.new
+    messages = consumer.consume
+
+
+### Consuming messages using a block loop
+
+    require 'kafka'
+    consumer = Kafka::Consumer.new
+    consumer.loop do |messages|
+        puts "Received"
+        puts messages
+    end
+
+
+Contact for questions
+
+alejandrocrosa at(@) gmail.com
+
+http://twitter.com/alejandrocrosa

data/Rakefile

@@ -0,0 +1,74 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'rspec/core/rake_task'
+
+spec = Gem::Specification.new do |s|
+  s.name = %q{wooga-kafka-rb}
+  s.version = "0.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alejandro Crosa", "Stefan Mees", "Tim Lossen"]
+  s.autorequire = %q{kafka-rb}
+  s.date = %q{2011-01-13}
+  s.description = %q{kafka-rb allows you to produce and consume messages using the Kafka distributed publish/subscribe messaging service.}
+  s.email = %q{alejandrocrosa@gmail.com}
+  s.extra_rdoc_files = ["LICENSE"]
+  s.files = ["LICENSE", "README.md", "Rakefile", "lib/kafka", "lib/kafka/batch.rb", "lib/kafka/consumer.rb", "lib/kafka/io.rb", "lib/kafka/message.rb", "lib/kafka/producer.rb", "lib/kafka/request_type.rb", "lib/kafka/error_codes.rb", "lib/kafka.rb", "spec/batch_spec.rb", "spec/consumer_spec.rb", "spec/io_spec.rb", "spec/kafka_spec.rb", "spec/message_spec.rb", "spec/producer_spec.rb", "spec/spec_helper.rb"]
+  s.homepage = %q{http://github.com/wooga/kafka-rb}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby client for the Kafka distributed publish/subscribe messaging service}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :default => :rspec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(-fs --color)
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "Run all examples with RCov"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end

data/lib/kafka/batch.rb

@@ -0,0 +1,28 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kafka
+  class Batch
+    attr_accessor :messages
+
+    def initialize
+      self.messages = []
+    end
+
+    def << (message)
+      self.messages << message
+    end
+  end
+end

data/lib/kafka/consumer.rb

@@ -0,0 +1,113 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kafka
+  class Consumer
+
+    include Kafka::IO
+
+    MAX_SIZE = 1024 * 1024        # 1 megabyte
+    DEFAULT_POLLING_INTERVAL = 2  # 2 seconds
+    MAX_OFFSETS = 1
+    EARLIEST_OFFSET = -2
+
+    attr_accessor :topic, :partition, :offset, :max_size, :request_type, :polling
+
+    def initialize(options = {})
+      self.topic        = options[:topic]     || "test"
+      self.partition    = options[:partition] || 0
+      self.host         = options[:host]      || "localhost"
+      self.port         = options[:port]      || 9092
+      self.offset       = options[:offset]
+      self.max_size     = options[:max_size]  || MAX_SIZE
+      self.polling      = options[:polling]   || DEFAULT_POLLING_INTERVAL
+      connect(host, port)
+    end
+
+    def loop(&block)
+      messages = []
+      while (true) do
+        messages = consume
+        block.call(messages) if messages && !messages.empty?
+        sleep(polling)
+      end
+    end
+
+    def consume
+      self.offset ||= fetch_earliest_offset
+      send_consume_request
+      data = read_data_response
+      parse_message_set_from(data)
+    rescue SocketError
+      nil
+    end
+
+    def fetch_earliest_offset
+      send_offsets_request
+      read_offsets_response
+    end
+
+    def send_offsets_request
+      write(encoded_request_size)
+      write(encode_request(Kafka::RequestType::OFFSETS, topic, partition, EARLIEST_OFFSET, MAX_OFFSETS))
+    end
+
+    def read_offsets_response
+      read_data_response[4,8].reverse.unpack('q')[0]
+    end
+
+    def send_consume_request
+      write(encoded_request_size)
+      write(encode_request(Kafka::RequestType::FETCH, topic, partition, offset, max_size))
+    end
+
+    def read_data_response
+      data_length = read(4).unpack("N").shift
+      data = read(data_length)
+      # TODO: inspect error code instead of skipping it
+      data[2, data.length]
+    end
+
+    def encoded_request_size
+      size = 2 + 2 + topic.length + 4 + 8 + 4
+      [size].pack("N")
+    end
+
+    def encode_request(request_type, topic, partition, offset, max_size)
+      request_type = [request_type].pack("n")
+      topic        = [topic.length].pack('n') + topic
+      partition    = [partition].pack("N")
+      offset       = [offset].pack("q").reverse # DIY 64bit big endian integer
+      max_size     = [max_size].pack("N")
+      request_type + topic + partition + offset + max_size
+    end
+
+    def parse_message_set_from(data)
+      messages = []
+      processed = 0
+      length = data.length - 4
+      while (processed <= length) do
+        message_size = data[processed, 4].unpack("N").shift + 4
+        message_data = data[processed, message_size]
+        break unless message_data.size == message_size
+        messages << Kafka::Message.parse_from(message_data)
+        processed += message_size
+      end
+      self.offset += processed
+      messages
+    end
+
+  end
+end

data/lib/kafka/error_codes.rb

@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module Kafka
+  module ErrorCodes
+    NO_ERROR                = 0
+    OFFSET_OUT_OF_RANGE     = 1
+    INVALID_MESSAGE_CODE    = 2
+    WRONG_PARTITION_CODE    = 3
+    INVALID_RETCH_SIZE_CODE = 4
+
+    STRINGS = {
+      0 => 'No error',
+      1 => 'Offset out of range',
+      2 => 'Invalid message code',
+      3 => 'Wrong partition code',
+      4 => 'Invalid retch size code',
+    }
+
+    def self.to_s(code)
+      STRINGS[code] || 'Unknown error'
+    end
+  end
+end

data/lib/kafka/io.rb

@@ -0,0 +1,54 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+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.socket = TCPSocket.new(self.host, self.port)
+    rescue
+      self.disconnect
+      raise
+    end
+
+    def disconnect
+      self.socket.close rescue nil
+      self.socket = nil
+    end
+
+    def read(length)
+      self.socket.read(length) || raise(SocketError, "no data")
+    rescue
+      self.disconnect
+      raise SocketError, "cannot read: #{$!.message}"
+    end
+
+    def write(data)
+      self.reconnect unless self.socket
+      self.socket.write(data)
+    rescue
+      self.disconnect
+      raise SocketError, "cannot write: #{$!.message}"
+    end
+
+  end
+end

data/lib/kafka/message.rb

@@ -0,0 +1,49 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+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, checksum = nil)
+      self.magic    = magic
+      self.payload  = payload
+      self.checksum = checksum || self.calculate_checksum
+    end
+
+    def calculate_checksum
+      Zlib.crc32(self.payload)
+    end
+
+    def valid?
+      self.checksum == Zlib.crc32(self.payload)
+    end
+
+    def self.parse_from(binary)
+      size     = binary[0, 4].unpack("N").shift.to_i
+      magic    = binary[4, 1].unpack("C").shift
+      checksum = binary[5, 4].unpack("N").shift
+      payload  = binary[9, size] # 5 = 1 + 4 is Magic + Checksum
+      return Kafka::Message.new(payload, magic, checksum)
+    end
+  end
+end