/rom-kafka

Apache Kafka support for Ruby Object Mapper

Primary LanguageRubyMIT LicenseMIT

ROM::Kafka

Gem Version Build Status Dependency Status Code Climate Coverage Inline docs

Apache Kafka support for Ruby Object Mapper on top of poseidon driver.

Installation

Add this line to your application's Gemfile:

# Gemfile
gem "rom-kafka"

Then execute:

bundle

Or add it manually:

gem install rom-kafka

Usage

See the corresponding Guide on rom-rb.org.

Before v0.1.0 the gem is in alpha stage.

Compatibility

Compatible to ROM 2.0+, Apache Kafka 0.8+.

Tested under rubies supported by ROM.

Uses RSpec 3.0+ for testing and hexx-suit dev/test tools collection.

Contributing

  • Fork the project
  • Create your feature branch (git checkout -b my-new-feature)
  • Add tests for it
  • Run rubocop and inch --pedantic to ensure the style and inline docs are ok
  • Run rake mutant or rake exhort to ensure 100% mutant-proof coverage
  • Commit your changes (git commit -am '[UPDATE] Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request

License

See the MIT LICENSE.