Skip to content

coditsu/karafka-coditsu

Repository files navigation

Karafka Coditsu

CircleCI

Coditsu overwrites for default Karafka classes

This library provides some simple helper classes for easier Karafka integration with Coditsu ecosystem.

Installation

Add this line to your application Gemfile:

gem 'karafka-coditsu',
    git: 'git@github.com:coditsu/karafka-coditsu.git',
    require: true,
    branch: :master

And then execute:

  $ bundle

Usage

Karafka Coditsu provides couple helper classes that simplify working with Karafka:

  • KarafkaCoditsu::AirbrakeListener - Listener for error only notifications upon Karafka problems.
  • KarafkaCoditsu::Parser - Default parser that namespaces the data within a 'value' scope.
  • KarafkaCoditsu::ResponseBuilder - Wraps up a builder for generating a pretty json with a internal compatible format with the event type included.

Note on contributions

First, thank you for considering contributing to Coditsu ecosystem! It's people like you that make the open source community such a great community!

Each pull request must pass all the RSpec specs and meet our quality requirements.

To check if everything is as it should be, we use Coditsu that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.

Coditsu will automatically check your work against our quality standards. You can find your commit check results on the builds page of Coditsu organization.

coditsu