fake-kafka 0.0.1.pre.beta4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c7c0173148a3e19aec4d000b07d1722b0ad251bd2f30966ee650c7fd66d8e7a
+  data.tar.gz: 6293413cf7b847f93c9aeb2ddf1786083f01454b44363094b4657b4f10bc4641
+SHA512:
+  metadata.gz: 5a22c0ed2c542b7884933a6c229e76ee6305f3365731d2880cd86511e8c1b83f4caa0983acbadb00c57a197b24303433aa2e472c9008d85eab962206026ee37d
+  data.tar.gz: 1b49b8aedf524975fe08de1e2abecb10b7254c6d463f56d302fd439c2b856da6edc8d8070f39a81a101be2d1c7589036b29d8ea9a3b29debd29816600c066558

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fake-kafka.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    fake-kafka (0.0.1.pre.beta1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fake-kafka!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,101 @@
+# Fake::Kafka
+
+It is a drop in replacement for ruby-kafka driver, it works as In-memory driver, useful for development and test environments
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fake-kafka', git: 'git@github.com:catawiki/fake-kafka.git', tag: '0.0.1-beta4'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fake-kafka
+
+## Usage
+
+### Testing
+
+Add the following lines to replace your kafka driver with the in-memory one.
+
+For example for catbus add the following on you `spec/rails_helper.rb`
+
+```ruby
+require 'fake/kafka'
+Catbus.kafka = Fake::Kafka.new
+```
+
+#### Cleaning kafka memory (AKA 'databasecleaner')
+
+```ruby
+kafka.reset!
+```
+
+With catbus and rspec you can do something like this within your rails_helper.rb
+
+```ruby
+RSpec.configure do |config|
+  ...
+  config.around(:each) do |example|
+    ...
+    Catbus.kafka.reset!
+    ...
+  end
+end
+
+```
+
+#### Testing a consumer
+
+```ruby
+ describe 'consume' do
+    let(:payload) do
+      {
+        payload: {
+          YOUR_CONTENT_HERE
+        },
+        event_name: EVENT_NAME
+      }
+    end
+    before do
+      Catbus.kafka.deliver_message payload, topic: 'test_YOUR_TOPIC'
+    end
+    it 'should consume message' do
+      expect(Resque).to receive(:enqueue).with(described_class, payload.to_json)
+      Catbus.consumer.send(:consume)
+    end
+```
+
+#### Testing a producer
+```ruby
+ describe 'produce' do
+    let(:payload) do
+      {
+        payload: {
+        	YOUR_CONTENT_HERE
+        },
+        event_name: EVENT_NAME
+      }
+    end
+    it 'should consume message' do
+      expect(Catbus.kafka).to receive(:deliver_message).with(payload.to_json, topic: 'test_YOUR_TOPIC', key: nil)
+      YOUR_PRODUCER.process(PARAMS)
+    end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/catawiki/fake-kafka.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fake/kafka"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fake-kafka.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fake/kafka/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake-kafka"
+  spec.version       = Fake::Kafka::VERSION
+  spec.authors       = ["Sebastian Arcila Valenzuela"]
+  spec.email         = ["sebastianarcila@gmail.com"]
+
+  spec.summary       = %q{Fake Kafka Consumer and Producer.}
+  spec.description   = %q{In memory 'kafka' instruments design for testing integrations with kafka.}
+  spec.homepage      = "https://github.com/catawiki/fake-kafka"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fake/kafka.rb

@@ -0,0 +1,44 @@
+require 'fake/kafka/version'
+require 'fake/kafka/batch'
+require 'fake/kafka/message'
+require 'fake/kafka/consumer'
+require 'fake/kafka/producer'
+
+module Fake
+  class Kafka
+    attr_reader :messages, :paused_partitions
+
+    def initialize(*options)
+      @messages = []
+      @paused_partitions = {}
+    end
+
+    def paused?(topic, partition)
+      @paused_partitions[topic] ||= {}
+      !!@paused_partitions[topic][partition]
+    end
+
+    def deliver_message(value, topic:, key: nil)
+      @messages << Message.new(value, key, topic, 0, 0)
+    end
+
+    def messages_in(topic)
+      messages.select {|message| message.topic == topic }
+    end
+
+    def consumer(*options)
+      Consumer.new(self)
+    end
+
+    def producer(*)
+      Producer.new(self)
+    end
+
+    # Used to clean in-memory data
+    # Useful between test runs
+    def reset!
+      @messages = []
+      @paused_partitions = {}
+    end
+  end
+end

data/lib/fake/kafka/batch.rb

@@ -0,0 +1,10 @@
+class Fake::Kafka::Batch
+  attr_reader :topic, :partition, :messages, :highwater_mark_offset
+
+  def initialize(topic:, partition:, messages:, highwater_mark_offset:)
+    @topic = topic
+    @partition = partition
+    @messages = messages
+    @highwater_mark_offset = highwater_mark_offset
+  end
+end

data/lib/fake/kafka/consumer.rb

@@ -0,0 +1,43 @@
+class Fake::Kafka::Consumer
+  def initialize(kafka)
+    @kafka = kafka
+    @topics = []
+  end
+
+  def subscribe(topic, **)
+    @topics << topic.to_sym
+  end
+
+  def each_message(*options, &block)
+    @kafka.messages.each do |message|
+      next unless @topics.include?(message.topic.to_sym)
+
+      begin
+        block.call(message)
+      rescue StandardError => e
+        raise Kafka::ProcessingError.new(message.topic, message.partition, message.offset)
+      end
+    end
+  end
+
+  def each_batch(*options, &block)
+    begin
+      batch = Fake::Kafka::Batch.new(
+        topic: @kafka.messages.first.topic,
+        partition: @kafka.messages.first.partition,
+        messages: @kafka.messages,
+        highwater_mark_offset: @kafka.messages.first.offset
+      )
+      block.call(batch)
+    rescue StandardError => e
+      raise Kafka::ProcessingError.new(batch.topic, batch.partition, batch.highwater_mark_offset)
+    end
+  end
+
+  def pause(topic, partition, timeout:, max_timeout: nil, exponential_backoff: false)
+    @kafka.paused_partitions[topic] ||= {}
+    @kafka.paused_partitions[topic][partition] = true
+  end
+
+  def stop; end
+end

data/lib/fake/kafka/message.rb

@@ -0,0 +1,14 @@
+class Fake::Kafka::Message
+  attr_reader :key, :topic, :partition, :offset
+  def initialize(value, key, topic, partition, offset)
+    @value = value
+    @key = key
+    @topic = topic
+    @partition = partition
+    @offset = offset
+  end
+
+  def value
+    @value.to_json
+  end
+end

data/lib/fake/kafka/producer.rb

@@ -0,0 +1,16 @@
+class Fake::Kafka::Producer
+  def initialize(kafka)
+    @kafka = kafka
+    @buffer = []
+  end
+
+  def produce(value, **options)
+    @buffer << [value, options]
+  end
+
+  def deliver_messages
+    @buffer.each do |value, **options|
+      @kafka.deliver_message(value.to_s, **options)
+    end
+  end
+end

data/lib/fake/kafka/version.rb

@@ -0,0 +1,5 @@
+module Fake
+  class Kafka
+    VERSION = "0.0.1-beta4"
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fake-kafka
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.beta4
+platform: ruby
+authors:
+- Sebastian Arcila Valenzuela
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: In memory 'kafka' instruments design for testing integrations with kafka.
+email:
+- sebastianarcila@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fake-kafka.gemspec
+- lib/fake/kafka.rb
+- lib/fake/kafka/batch.rb
+- lib/fake/kafka/consumer.rb
+- lib/fake/kafka/message.rb
+- lib/fake/kafka/producer.rb
+- lib/fake/kafka/version.rb
+homepage: https://github.com/catawiki/fake-kafka
+licenses: []
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Fake Kafka Consumer and Producer.
+test_files: []