waterdrop 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2ef3d3916d6b0e59c191c8a81ad88cc33424a4ee4ff4c7c12e65e5ad3c79ba3
+  data.tar.gz: 1e02c7ae97e7c85e1d4aa12fe5e7c2b5611add6d41b15949fc17830382e4d99d
+SHA512:
+  metadata.gz: c58aaaec32bbe3c1a930a0366447e5f69e3551619ad48ea243787b1fa487fdb3f17b5e17fd409ef956b0793dba3550a914ac15015e93cd4d81fa992f59040f7e
+  data.tar.gz: 00f6e291c053a46c650936a7d0e03a1c20f7631d5b597df30aa1b0f2ae614873b16c8bdf58a7081f3438e894d3f20c006e736826b2adf76e12c2be49e8f42b48

data/.coditsu/ci.yml

@@ -0,0 +1,3 @@
+repository_id: '76b3a28c-d72b-44c7-870b-e5217e2f0d5c'
+api_key: <%= ENV['CODITSU_API_KEY'] %>
+api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: karafka

data/.gitignore

@@ -0,0 +1,68 @@
+# bundler state
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+/ruby/
+app.god
+
+# minimal Rails specific artifacts
+db/*.sqlite3
+/log/*.log
+/tmp/*
+*.gem
+*.~
+/.coditsu/local.yml
+
+# various artifacts
+**.war
+*.rbc
+*.sassc
+.redcar/
+.capistrano/
+.sass-cache
+/config/god/sidekiq.rb
+/config/puma.rb
+/coverage.data
+/coverage/
+/doc/api/
+/doc/app/
+/doc/yard
+/doc/features.html
+/doc/specs.html
+/spec/tmp/*
+/cache
+/capybara*
+/capybara-*.html
+/gems
+/specifications
+rerun.txt
+pickle-email-*.html
+
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+#
+# Here are some files you may want to ignore globally:
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject
+
+# RubyMine project files
+.idea
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp
+
+# documentation
+.yardoc
+
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+waterdrop

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,35 @@
+services:
+  - docker
+
+dist: trusty
+cache: bundler
+
+git:
+  depth: false
+
+test: &test
+  stage: Test
+  language: ruby
+  before_install:
+    - yes | gem update --system
+  script: bundle exec rspec
+
+jobs:
+  include:
+    - <<: *test
+      rvm: 2.7.1
+    - <<: *test
+      rvm: 2.6.6
+    - <<: *test
+      rvm: 2.5.8
+
+    - stage: coditsu
+      language: ruby
+      rvm: 2.7.1
+      before_install:
+        - yes | gem update --system
+      script: \curl -sSL https://api.coditsu.io/run/ci | bash
+
+stages:
+  - test
+  - coditsu

data/CHANGELOG.md

@@ -0,0 +1,158 @@
+# WaterDrop changelog
+
+## 1.4.0 (2020-08-25)
+- Release to match Karafka 1.4 versioning.
+
+## 1.3.4 (2020-02-17)
+- Support for new `dry-configurable`
+
+## 1.3.3 (2019-01-06)
+- #119 - Support exactly once delivery and transactional messaging (kylekthompson)
+- #119 - Support delivery_boy 1.0 (kylekthompson)
+
+## 1.3.2 (2019-26-12)
+- Ruby 2.7.0 support
+- Fix missing `delegate` dependency on `ruby-kafka`
+
+## 1.3.1 (2019-10-21)
+- Ruby 2.6.5 support
+- Expose setting to optionally verify hostname on ssl certs #109 (tabdollahi)
+
+## 1.3.0 (2019-09-09)
+- Drop Ruby 2.4 support
+
+## 1.3.0.rc1 (2019-07-31)
+- Drop Ruby 2.3 support
+- Drop support for Kafka 0.10 in favor of native support for Kafka 0.11.
+- Ruby 2.6.3 support
+- Support message headers
+- `sasl_over_ssl` support
+- Unlock Ruby Kafka + provide support for 0.7 only
+- #60 - Rename listener to StdoutListener
+- Drop support for Kafka 0.10 in favor of native support for Kafka 0.11.
+- Support ruby-kafka 0.7
+- Support message headers
+- `sasl_over_ssl` support
+- `ssl_client_cert_key_password` support
+- #87 - Make stdout listener as instance
+- Use Zeitwerk for gem code loading
+- #93 - zstd compression support
+- #99 - schemas are renamed to contracts
+- Bump delivery_boy (0.2.7 => 0.2.8)
+
+## 1.2.5
+- Bump dependencies to match Karafka
+- drop jruby support
+- drop ruby 2.2 support
+
+## 1.2.4
+- Due to multiple requests, unlock of 0.7 with an additional post-install message
+
+## 1.2.3
+- Lock ruby-kafka to 0.6 (0.7 support targeted for WaterDrop 1.3)
+
+## 1.2.2
+- #55 - Codec settings unification and config applier
+
+## 1.2.1
+- #54 - compression_codec api sync with king-konf requirements
+
+## 1.2.0
+- #45 - Allow specifying a create time for messages
+- #47 - Support SCRAM once released
+- #49 - Add lz4 support once merged and released
+- #50 - Potential message loss in async mode
+- Ruby 2.5.0 support
+- Gem bump to match Karafka framework versioning
+- #48 - ssl_ca_certs_from_system
+- #52 - Use instrumentation compatible with Karafka 1.2
+
+## 1.0.1
+- Added high level retry on connection problems
+
+## 1.0.0
+
+- #37 - ack level for producer
+- Gem bump
+- Ruby 2.4.2 support
+- Raw ruby-kafka driver is now replaced with delivery_boy
+- Sync and async producers
+- Complete update of the API
+- Much better validations for config details
+- Complete API remodel - please read the new README
+- Renamed send_messages to deliver
+
+## 0.4
+- Bump to match Karafka
+- Renamed ```hosts``` to ```seed_brokers```
+- Removed the ```ssl``` scoping for ```kafka``` config namespace to better match Karafka conventions
+- Added ```client_id``` option on a root config level
+- Added ```logger``` option on a root config level
+- Auto Propagation of config down to ruby-kafka
+
+## 0.3.2
+- Removed support for Ruby 2.1.*
+- ~~Ruby 2.3.3 as default~~
+- Ruby 2.4.0 as default
+- Gem dump x2
+- Dry configurable config (#20)
+- added .rspec for default spec helper require
+- Added SSL capabilities
+- Coditsu instead of PG dev tools for quality control
+
+## 0.3.1
+- Dev tools update
+- Gem update
+- Specs updates
+- File naming convention fix from waterdrop to water_drop + compatibility file
+- Additional params (partition, etc) that can be passed into producer
+
+## 0.3.0
+- Driver change from Poseidon (not maintained) to Ruby-Kafka
+
+## 0.2.0
+- Version dump - this WaterDrop version no longer relies on Aspector to work
+- #17 - Logger for Aspector - WaterDrop no longer depends on Aspector
+- #8 - add send date as a default value added to a message - wont-fix. Should be implemented on a message level since WaterDrop just transports messages without adding additional stuff.
+- #11 - same as above
+
+## 0.1.13
+- Resolved bug #15. When you use waterdrop in aspect way, message will be automatically parse to JSON.
+
+## 0.1.12
+- Removed default to_json casting because of binary/other data types incompatibility. This is an incompatibility. If you use WaterDrop, please add a proper casting method to places where you use it.
+- Gem dump
+
+## 0.1.11
+- Poseidon options extractions and tweaks
+
+## 0.1.10
+- Switched raise_on_failure to ignore all StandardError failures (or not to), not just specific once
+- Reloading inside connection pool connection that seems to be broken (one that failed) - this should prevent from multiple issues (but not from single one) that are related to the connection
+
+## 0.1.9
+- Required acks and set to -1 (most secure but slower)
+- Added a proxy layer to to producer so we could replace Kafka with other messaging systems
+- Gem dump
+
+## 0.1.8
+- proper poseidon clients names (not duplicated)
+
+## 0.1.7
+- kafka_host, kafka_hosts and kafka_ports settings consistency fix
+
+## 0.1.6
+- Added null-logger gem
+
+## 0.1.5
+- raise_on_failure flag to ignore (if false) that message was not sent
+
+## 0.1.4
+- Renamed WaterDrop::Event to WaterDrop::Message to follow Apache Kafka naming convention
+
+## 0.1.3
+- Gems cleanup
+- Requirements fix
+
+## 0.1.2
+- Initial gem release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    waterdrop (1.4.0)
+      delivery_boy (>= 0.2, < 2.x)
+      dry-configurable (~> 0.8)
+      dry-monitor (~> 0.3)
+      dry-validation (~> 1.2)
+      ruby-kafka (>= 0.7.8)
+      zeitwerk (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    delivery_boy (1.0.1)
+      king_konf (~> 0.3)
+      ruby-kafka (~> 1.0)
+    diff-lcs (1.4.4)
+    digest-crc (0.6.1)
+      rake (~> 13.0)
+    docile (1.3.2)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-events (0.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.7)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-monitor (0.3.2)
+      dry-configurable (~> 0.5)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-events (~> 0.2)
+    dry-schema (1.5.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.4)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.5.4)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5)
+    king_konf (0.3.7)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby-kafka (1.2.0)
+      digest-crc
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  simplecov
+  waterdrop!
+
+BUNDLED WITH
+   2.1.4

data/MIT-LICENCE

@@ -0,0 +1,18 @@
+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,127 @@
+# WaterDrop
+
+[![Build Status](https://travis-ci.org/karafka/waterdrop.svg)](https://travis-ci.org/karafka/waterdrop)
+[![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Gem used to send messages to Kafka in an easy way with an extra validation layer. It is a part of the [Karafka](https://github.com/karafka/karafka) ecosystem.
+
+WaterDrop is based on Zendesks [delivery_boy](https://github.com/zendesk/delivery_boy) gem.
+
+It is:
+
+ - Thread safe
+ - Supports sync and async producers
+ - Working with 0.11+ Kafka
+
+## Installation
+
+```ruby
+gem install waterdrop
+```
+
+or add this to your Gemfile:
+
+```ruby
+gem 'waterdrop'
+```
+
+and run
+
+```
+bundle install
+```
+
+## Setup
+
+WaterDrop is a complex tool, that contains multiple configuration options. To keep everything organized, all the configuration options were divided into two groups:
+
+- WaterDrop options - options directly related to Karafka framework and it's components
+- Ruby-Kafka driver options - options related to Ruby-Kafka/Delivery boy
+
+To apply all those configuration options, you need to use the ```#setup``` method:
+
+```ruby
+WaterDrop.setup do |config|
+  config.deliver = true
+  config.kafka.seed_brokers = %w[kafka://localhost:9092]
+end
+```
+
+### WaterDrop configuration options
+
+| Option                      | Description                                                      |
+|-----------------------------|------------------------------------------------------------------|
+| client_id                   | This is how the client will identify itself to the Kafka brokers |
+| logger                      | Logger that we want to use                                       |
+| deliver                     | Should we send messages to Kafka                                 |
+
+### Ruby-Kafka driver and Delivery boy configuration options
+
+**Note:** We've listed here only **the most important** configuration options. If you're interested in all the options, please go to the [config.rb](https://github.com/karafka/waterdrop/blob/master/lib/water_drop/config.rb) file for more details.
+
+**Note:** All the options are subject to validations. In order to check what is and what is not acceptable, please go to the [config.rb validation schema](https://github.com/karafka/waterdrop/blob/master/lib/water_drop/schemas/config.rb) file.
+
+| Option                   | Description                                                                                                                                           |
+|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
+| raise_on_buffer_overflow | Should we raise an exception, when messages can't be sent in an async way due to the message buffer overflow or should we just drop them              |
+| delivery_interval        | The number of seconds between background message deliveries. Disable timer-based background deliveries by setting this to 0.                          |
+| delivery_threshold       | The number of buffered messages that will trigger a background message delivery. Disable buffer size based background deliveries by setting this to 0.|
+| required_acks            | The number of Kafka replicas that must acknowledge messages before they're considered as successfully written.                                        |
+| ack_timeout              | A timeout executed by a broker when the client is sending messages to it.                                                                             |
+| max_retries              | The number of retries when attempting to deliver messages.                                                                                            |
+| retry_backoff            | The number of seconds to wait after a failed attempt to send messages to a Kafka broker before retrying.                                              |
+| max_buffer_bytesize      | The maximum number of bytes allowed in the buffer before new messages are rejected.                                                                   |
+| max_buffer_size          | The maximum number of messages allowed in the buffer before new messages are rejected.                                                                |
+| max_queue_size           | The maximum number of messages allowed in the queue before new messages are rejected.                                                                 |
+| sasl_plain_username      | The username used to authenticate.                                                                                                                    |
+| sasl_plain_password      | The password used to authenticate.                                                                                                                    |
+
+This configuration can be also placed in *config/initializers* and can vary based on the environment:
+
+```ruby
+WaterDrop.setup do |config|
+  config.deliver = Rails.env.production?
+  config.kafka.seed_brokers = [Rails.env.production? ? 'kafka://prod-host:9091' : 'kafka://localhost:9092']
+end
+```
+
+## Usage
+
+To send Kafka messages, just use one of the producers:
+
+```ruby
+WaterDrop::SyncProducer.call('message', topic: 'my-topic')
+# or for async
+WaterDrop::AsyncProducer.call('message', topic: 'my-topic')
+```
+
+Both ```SyncProducer``` and ```AsyncProducer``` accept following options:
+
+| Option              | Required | Value type | Description                                                         |
+|-------------------- |----------|------------|---------------------------------------------------------------------|
+| ```topic```         | true     | String     | The Kafka topic that should be written to                           |
+| ```key```           | false    | String     | The key that should be set in the Kafka message                     |
+| ```partition```     | false    | Integer    | A specific partition number that should be written to               |
+| ```partition_key``` | false    | String     | A string that can be used to deterministically select the partition |
+| ```create_time```   | false    | Time       | The timestamp that should be set on the message                     |
+| ```headers```       | false    | Hash       | Headers for the message                                             |
+
+Keep in mind, that message you want to send should be either binary or stringified (to_s, to_json, etc).
+
+## References
+
+* [Karafka framework](https://github.com/karafka/karafka)
+* [WaterDrop Travis CI](https://travis-ci.org/karafka/waterdrop)
+* [WaterDrop Coditsu](https://app.coditsu.io/karafka/repositories/waterdrop)
+
+## Note on contributions
+
+First, thank you for considering contributing to WaterDrop! 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](https://coditsu.io) 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](https://app.coditsu.io/karafka/repositories/waterdrop/builds/commit_builds) of WaterDrop repository.
+
+[![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka/repositories/waterdrop/builds/commit_builds)