simple_kafka_consumer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaf8648e57f4f0e015d8409855ff5dfa127f09c3
+  data.tar.gz: ea11108291577064530a0a5728d0daa0dee2fdce
+SHA512:
+  metadata.gz: 872f04ac59f0bd87c1c34d293370caa796db5dd10ec9e44cd2a6f30239462cfe77204232ea70733c3227217c80c4d1e715bbbd147cf1e1323458a2db7f5609a6
+  data.tar.gz: 6b6b8d44c1c1f825131ce494e77cba1f8eaf71238935a6efe33fe86a2349dbf000e20c2c1d0267f621d3bffc57c1e1dd52ff104680489be28c20011634f50b35

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_kafka_consumer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff Ching
+
+MIT License
+
+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,79 @@
+# SimpleKafkaConsumer
+
+Write Kafka consumers in a model with retry
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_kafka_consumer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_kafka_consumer
+
+## Usage
+
+You will want to write your own consumer class that inherits from `SimpleKafkaConsumer::Consumer`. You will want to specify the `group_name` and `topic_name`. You'll also want to define the `consume` method which is the handler for batch of messages received.
+
+```ruby
+class MyConsumer < SimpleKafkaConsumer::Consumer
+  # the name used for coordinating multiple consumers
+  self.group_name = "my-group-name"
+
+  # the kafka topic we're reading from
+  self.topic_name = "my-topic-name"
+
+  # handle the messages
+  def consume(message)
+    puts message
+  end
+end
+```
+
+### Formatting
+
+You can have the consumer handle deserializing your data that is sent in the message. For example, if you used json as your message format:
+
+```ruby
+class MyConsumer
+  def parse(message)
+    JSON.parse(message)
+  end
+
+  # the message you're consuming is now a parsed json object
+  def consume(json_object)
+    puts json_object['name']
+  end
+end
+```
+
+### Creating and Running
+
+To create a consumer instance, you'll need to provide an array of kafka servers and an array of zookeeper servers. You can optionally provide a logger as well.
+
+```ruby
+# create a consumer
+kafka_servers = ["localhost:9092"]
+zookeeper_servers = ["localhost:2181"]
+consumer = MyConsumer.new(kafka_servers, zookeeper_servers, logger: nil)
+
+# run the consumer (loops and blocks)
+consumer.run
+```
+
+This gem utilizes the `poseidon_cluster` gem and consumers coordinate via zookeeper. Thus, you can run many consumers. The `group_name` is what's used to determine which messages have already been processed.
+
+## Contributing
+
+1. Fork it ( https://github.com/chingor13/simple_kafka_consumer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/simple_kafka_consumer.rb

@@ -0,0 +1,8 @@
+require "simple_kafka_consumer/version"
+require 'poseidon'
+require 'poseidon_cluster'
+require 'active_support/core_ext/class/attribute'
+
+module SimpleKafkaConsumer
+  autoload :Consumer, "simple_kafka_consumer/consumer"
+end

data/lib/simple_kafka_consumer/consumer.rb

@@ -0,0 +1,48 @@
+module SimpleKafkaConsumer
+  class Consumer    
+    class_attribute :group_name, :topic_name
+    attr_reader :consumer, :logger
+    def initialize(kafka_servers, zookeeper_servers, logger: nil)
+      @consumer = Poseidon::ConsumerGroup.new(
+        group_name, 
+        kafka_servers, 
+        zookeeper_servers, 
+        topic_name
+      )
+      @logger = logger
+    end
+
+    def run
+      debug "partitions: #{consumer.partitions}"
+      debug "claimed: #{consumer.claimed}"
+      consumer.fetch_loop do |partition, bulk|
+        bulk.each do |message|
+          consume(parse(message))
+        end
+      end
+    rescue ZK::Exceptions::OperationTimeOut => e
+      log e.message
+      retry
+    end
+
+    protected
+
+    def parse(message)
+      message
+    end
+
+    def log(message)
+      return false unless logger
+      logger.info message
+    end
+
+    def debug(message)
+      return false unless logger
+      logger.debug message
+    end
+
+    def consume(message)
+      puts "doing nothing"
+    end
+  end
+end

data/lib/simple_kafka_consumer/version.rb

@@ -0,0 +1,3 @@
+module SimpleKafkaConsumer
+  VERSION = "0.0.1"
+end

data/simple_kafka_consumer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_kafka_consumer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_kafka_consumer"
+  spec.version       = SimpleKafkaConsumer::VERSION
+  spec.authors       = ["Jeff Ching"]
+  spec.email         = ["jching@avvo.com"]
+  spec.summary       = %q{Write Kafka consumers in a model with retry}
+  spec.description   = %q{Write Kafka consumers in a model with retry}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.2.0"
+  spec.add_dependency "poseidon", "0.0.4"
+  spec.add_dependency "poseidon_cluster", "0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: simple_kafka_consumer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: poseidon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: poseidon_cluster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Write Kafka consumers in a model with retry
+email:
+- jching@avvo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_kafka_consumer.rb
+- lib/simple_kafka_consumer/consumer.rb
+- lib/simple_kafka_consumer/version.rb
+- simple_kafka_consumer.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Write Kafka consumers in a model with retry
+test_files: []
+has_rdoc: