rafka 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd21afb5b92c9e7c0e712459ca3f3af0ce3fe823
+  data.tar.gz: 1c5868fa247da36d91d14b176586620e6c7a1298
+SHA512:
+  metadata.gz: 3fe0b6acbf267039e172a49f8022e9d1a90ea8f33b7e472f7fb442b645a9bfe8105bc5151943fc7fb309fd6abcbf0ce6c9d066658190a7d590cdb5e2f49bdead
+  data.tar.gz: 07cc6ca0d115cf69cd8e189756583dbe2325a74ac90bfc7cc27c9326df41c1f079f73a267e4f2b7d637a9e870000a5d7a683a72f54efccaf8e3231193de015e5

data/CHANGELOG.md

@@ -0,0 +1 @@
+TODO

data/README.md

@@ -0,0 +1,73 @@
+rafka-rb: Ruby driver for Rafka
+===============================================================================
+[![Gem Version](https://badge.fury.io/rb/rafka.svg)](https://badge.fury.io/rb/rafka-rb)
+[![Documentation](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/skroutz/rafka-rb)
+
+Rafka is a thin Ruby client library for [Rafka](https://github.com/skroutz/rafka-rb),
+providing a consumer and a producer with simple semantics. It is backed by
+[redis-rb](https://github.com/redis/redis-rb).
+
+View the [API documentation](http://www.rubydoc.info/github/skroutz/rafka-rb).
+
+Status
+-------------------------------------------------------------------------------
+
+Rafka is not yet stable and therefore is _not_ recommended for production use.
+
+
+
+
+
+
+
+
+
+Getting started
+-------------------------------------------------------------------------------
+Install rafka-rb:
+
+```shell
+$ gem install rafka
+```
+
+If you're using Bundler, add it to your Gemfile:
+```ruby
+gem "rafka"
+```
+and run `bundle install`.
+
+
+
+
+
+
+
+Usage
+-------------------------------------------------------------------------------
+
+### Producer
+
+```ruby
+require "rafka"
+
+prod = Rafka::Producer.new(host: "localhost", port: 6380)
+prod.produce("greetings", "Hello there!") # produce to topic "greetings"
+```
+
+
+
+
+### Consumer
+
+```ruby
+require "rafka"
+
+cons = Rafka::Consumer.new(topic: "greetings", group: "myapp", id: "greeter1")
+cons.consume # => "Hello there!"
+
+# with a block
+cons.consume { |msg| puts "Received: #{msg.value}" } # => "Hello there!"
+```
+
+`Rafka::Consumer#consume` automatically commits the offsets when the given block
+is executed without raising any exceptions.

data/lib/rafka.rb

@@ -0,0 +1,18 @@
+require "redis"
+
+require "rafka/errors"
+require "rafka/generic_commands"
+require "rafka/message"
+require "rafka/version"
+
+require "rafka/consumer"
+require "rafka/producer"
+
+module Rafka
+  DEFAULTS = {
+    host: "localhost",
+    port: 6380,
+    reconnect_attempts: 0,
+  }
+end
+

data/lib/rafka/consumer.rb

@@ -0,0 +1,75 @@
+require 'securerandom'
+
+module Rafka
+  class Consumer
+    include GenericCommands
+
+    REQUIRED = [:group, :topic]
+
+    # The underlying Redis client object
+    attr_reader :redis
+
+    # Create a new client instance.
+    #
+    # @param [Hash] opts
+    # @option opts [String] :host ("localhost") server hostname
+    # @option opts [Fixnum] :port (6380) server port
+    # @option opts [String] :topic Kafka topic to consume (required)
+    # @option opts [String] :group Kafka consumer group name (required)
+    # @option opts [String] :id (random) Kafka consumer id
+    # @option opts [Hash] :redis_opts ({}) Optional configuration for the
+    #   underlying Redis client
+    def initialize(opts={})
+      opts[:redis_opts] = {} if !opts[:redis_opts]
+      opts = parse_opts(opts)
+      client_id = "#{opts[:group]}:#{opts[:id]}"
+      @redis = Redis.new(host: opts[:host], port: opts[:port], id: client_id)
+      @topic = "topics:#{opts[:topic]}"
+    end
+
+    # Fetch the next message.
+    #
+    # @param timeout [Fixnum] the time in seconds to wait for a message
+    #
+    # @raise [MalformedMessage] if the message from Rafka cannot be parsed
+    #
+    # @return [nil, Message] the message, if any
+    #
+    # @example
+    #   consume(5) { |msg| puts "I received #{msg.value}" }
+    def consume(timeout=5)
+      msg = @redis.blpop(@topic, timeout: timeout)
+
+      return if !msg
+
+      msg = Message.new(msg)
+
+      begin
+        raised = false
+        yield(msg) if block_given?
+      rescue => e
+        raised = true
+        raise e
+      end
+
+      msg
+    ensure
+      if msg && !raised
+        @redis.rpush("acks", "#{msg.topic}:#{msg.partition}:#{msg.offset}")
+      end
+    end
+
+    private
+
+    def parse_opts(opts)
+      options = DEFAULTS.dup.merge(opts).merge(opts[:redis_opts])
+      options[:id] = SecureRandom.hex if !options[:id]
+
+      REQUIRED.each do |opt|
+        raise "#{opt.inspect} option not provided" if !options[opt]
+      end
+
+      options
+    end
+  end
+end

data/lib/rafka/errors.rb

@@ -0,0 +1,14 @@
+module Rafka
+  class Error < StandardError
+  end
+
+  class MalformedMessage < Error
+    def initialize(msg)
+      @msg = msg
+    end
+
+    def to_s
+      "The message #{@msg.inspect} could not be parsed"
+    end
+  end
+end

data/lib/rafka/generic_commands.rb

@@ -0,0 +1,14 @@
+module Rafka
+  # Commands available on both {Producer} and {Consumer}.
+  module GenericCommands
+    # @see https://redis.io/commands/ping
+    def ping
+      @redis.ping
+    end
+
+    # @see https://redis.io/commands/quit
+    def quit
+      @redis.quit
+    end
+  end
+end

data/lib/rafka/message.rb

@@ -0,0 +1,17 @@
+module Rafka
+  # Message represents a message consumed from a topic.
+  class Message
+    attr :topic, :partition, :offset, :value
+
+    def initialize(msg)
+      if !msg.is_a?(Array) || msg.size != 8
+        raise MalformedMessage.new(msg)
+      end
+
+      @topic     = msg[1]
+      @partition = msg[3]
+      @offset    = msg[5]
+      @value     = msg[7]
+    end
+  end
+end

data/lib/rafka/producer.rb

@@ -0,0 +1,49 @@
+module Rafka
+  class Producer
+    # Access the underlying Redis client object
+    attr_reader :redis
+
+    # Create a new client instance.
+    #
+    # @param [Hash] opts
+    # @option opts [String] :host ("localhost") server hostname
+    # @option opts [Fixnum] :port (6380) server port
+    # @options opts [Hash] :redis_opts Configuration options for the underlying
+    #   Redis client
+    #
+    # @return [Producer]
+    def initialize(opts = {})
+      opts[:redis_opts] = {} if !opts[:redis_opts]
+      opts = parse_opts(opts)
+      @redis = Redis.new(host: opts[:host], port: opts[:port])
+    end
+
+    # Produce a message. This is a non-blocking operation.
+    #
+    # @param topic [String]
+    # @param message [#to_s]
+    #
+    # @example
+    #   produce("greetings", "Hello there!")
+    def produce(topic, message)
+      @redis.rpushx("topics:#{topic}", message.to_s)
+    end
+
+    # Flush any buffered messages. Blocks until all messages are flushed or
+    # timeout exceeds.
+    #
+    # @param timeout_ms [Fixnum] (5000) The timeout in milliseconds
+    #
+    # @return [Fixnum] The number of unflushed messages
+    def flush(timeout_ms=5000)
+      @redis.dump(timeout_ms.to_s)
+    end
+
+    private
+
+    def parse_opts(opts)
+      options = DEFAULTS.dup.merge(opts).merge(opts[:redis_opts])
+      options
+    end
+  end
+end

data/lib/rafka/version.rb

@@ -0,0 +1,3 @@
+module Rafka
+  VERSION = "0.0.1".freeze
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rafka
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Agis Anastasopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client library for Rafka, with consumer and producer implementations.
+email:
+- agis.anast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/rafka.rb
+- lib/rafka/consumer.rb
+- lib/rafka/errors.rb
+- lib/rafka/generic_commands.rb
+- lib/rafka/message.rb
+- lib/rafka/producer.rb
+- lib/rafka/version.rb
+homepage: https://github.com/skroutz/rafka-rb
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby driver for Rafka
+test_files: []