karafka 1.4.8 → 1.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624bb74796f9a31d5f1fa77e4af091561d766f5ca5c99c3e47a8b34389632576
-  data.tar.gz: 64bc5533d00673463b48ccc113dc2de28184f16936aa8027a4a67688bb03e3b4
+  metadata.gz: 54b5bde8c7a61dbf95021a53f40a5789eb29a5b297e6639a616eac5a0883391d
+  data.tar.gz: faae48e60cba546b503a222b4c02e5165e7b6934bfab4414d0116e30b4f79089
 SHA512:
-  metadata.gz: 3ae786e5f8ea92765e23bf94ef914e6a7433d3866716f540f8d129b3d0ecb67557bc2245522370b828e4a4ff4e5d20eeb9ad54f0cc04ea2b973d38a3d0fda729
-  data.tar.gz: 9fe396828adf9b12b3e70286143c6738a7ece2ed8ce8a211b505f59085a54e9a3b4c99fea8424314f0d8793c4523ff68f2eb2153816f6325b35072bc07ba8879
+  metadata.gz: ca53d510bd6a0e2c6efb7cec8a4b298c5668ef738943b1fa97acace0b7f9a4a89e9e2f1e45ba0ae3e3202613b4259ff8e1408a7ebf727566f11863bf4f7c637b
+  data.tar.gz: a5f735ca604ef83fb324c1c011ad4f3f9cdfa57009c3eb88a852b1a9c41bffdad7f87fd936c1b5b95076b38535fcaa38dd3aa9afdac355098f071578fef81dad

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Karafka framework changelog
 
+## 1.4.9 (2021-09-29)
+- fix `dry-configurable` deprecation warnings for default value as positional argument
+
 ## 1.4.8 (2021-09-08)
 - Allow 'rails' in Gemfile to enable rails-aware generator (rewritten)
 
@@ -31,7 +34,7 @@
 
 ## 1.4.0 (2020-09-05)
 - Rename `Karafka::Params::Metadata` to `Karafka::Params::BatchMetadata`
-` Rename consumer `#metadata` to `#batch_metadata`
+- Rename consumer `#metadata` to `#batch_metadata`
 - Separate metadata (including Karafka native metadata) from the root of params (backwards compatibility preserved thanks to rabotyaga)
 - Remove metadata hash dependency
 - Remove params dependency on a hash in favour of PORO

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka (1.4.8)
+    karafka (1.4.9)
       dry-configurable (~> 0.8)
       dry-inflector (~> 0.1)
       dry-monitor (~> 0.3)
@@ -31,15 +31,14 @@ GEM
     digest-crc (0.6.4)
       rake (>= 12.0.0, < 14.0.0)
     docile (1.4.0)
-    dry-configurable (0.12.1)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.8.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-configurable (~> 0.13, >= 0.13.0)
     dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
     dry-events (0.3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
@@ -48,13 +47,13 @@ GEM
     dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
-    dry-monitor (0.4.0)
-      dry-configurable (~> 0.5)
+    dry-monitor (0.5.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
       dry-core (~> 0.5, >= 0.5)
       dry-events (~> 0.2)
-    dry-schema (1.7.1)
+    dry-schema (1.8.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-configurable (~> 0.13, >= 0.13.0)
       dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
@@ -65,13 +64,12 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.6.0)
+    dry-validation (1.7.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.5, >= 1.5.2)
+      dry-schema (~> 1.8, >= 1.8.0)
     envlogic (1.1.3)
       dry-inflector (~> 0.1)
     factory_bot (6.2.0)
@@ -110,7 +108,7 @@ GEM
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    waterdrop (1.4.2)
+    waterdrop (1.4.3)
       delivery_boy (>= 0.2, < 2.x)
       dry-configurable (~> 0.8)
       dry-monitor (~> 0.3)
@@ -133,4 +131,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.2.26
+   2.2.28

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://github.com/karafka/karafka/actions/workflows/ci.yml/badge.svg)](https://github.com/karafka/karafka/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/karafka.svg)](http://badge.fury.io/rb/karafka)
-[![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka)
+[![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
 
 **Note**: We're finishing the new Karafka `2.0` but for now, please use `1.4`. All the documentation presented here refers to `1.4`
 
@@ -10,6 +10,24 @@
 
 Framework used to simplify Apache Kafka based Ruby applications development.
 
+```ruby
+# Define what topics you want to consume with which consumers
+Karafka::App.consumer_groups.draw do
+  topic 'system_events' do
+    consumer EventsConsumer
+  end
+end
+
+# And create your consumers, within which your messages will be processed
+class EventsConsumer < ApplicationConsumer
+  # Example that utilizes ActiveRecord#insert_all and Karafka batch processing
+  def consume
+    # Store all of the incoming Kafka events locally in an efficient way
+    Event.insert_all params_batch.payloads
+  end
+end
+```
+
 Karafka allows you to capture everything that happens in your systems in large scale, providing you with a seamless and stable core for consuming and processing this data, without having to focus on things that are not your business domain.
 
 Karafka not only handles incoming messages but also provides tools for building complex data-flow applications that receive and send messages.
@@ -35,7 +53,7 @@ Karafka based applications can be easily deployed to any type of infrastructure,
 
 ## Support
 
-Karafka has a [Wiki pages](https://github.com/karafka/karafka/wiki) for almost everything and a pretty decent [FAQ](https://github.com/karafka/karafka/wiki/FAQ). It covers the whole installation, setup, and deployment along with other useful details on how to run Karafka.
+Karafka has [Wiki pages](https://github.com/karafka/karafka/wiki) for almost everything and a pretty decent [FAQ](https://github.com/karafka/karafka/wiki/FAQ). It covers the whole installation, setup, and deployment along with other useful details on how to run Karafka.
 
 If you have any questions about using Karafka, feel free to join our [Gitter](https://gitter.im/karafka/karafka) chat channel.
 
@@ -65,10 +83,6 @@ and follow the instructions from the [example app Wiki](https://github.com/karaf
 
 If you need more details and know how on how to start Karafka with a clean installation, read the [Getting started page](https://github.com/karafka/karafka/wiki/Getting-started) section of our Wiki.
 
-## Notice
-
-Karafka framework and Karafka team are __not__ related to Kafka streaming service called CloudKarafka in any matter. We don't recommend nor discourage usage of their platform.
-
 ## References
 
 * [Karafka framework](https://github.com/karafka/karafka)
@@ -77,23 +91,8 @@ Karafka framework and Karafka team are __not__ related to Kafka streaming servic
 
 ## Note on contributions
 
-First, thank you for considering contributing to Karafka! 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/commit_builds) of Karafka organization.
-
-[![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka/commit_builds)
-
-## Contributors
-
-This project exists thanks to all the people who contribute.
-<a href="https://github.com/karafka/karafka/graphs/contributors"><img src="https://opencollective.com/karafka/contributors.svg?width=890" /></a>
-
-## Sponsors
+First, thank you for considering contributing to the Karafka ecosystem! It's people like you that make the open source community such a great community!
 
-We are looking for sustainable sponsorship. If your company is relying on Karafka framework or simply want to see Karafka evolve faster to meet your requirements, please consider backing the project.
+Each pull request must pass all the RSpec specs, integration tests and meet our quality requirements.
 
-Please contact [Maciej Mensfeld](mailto:maciej@mensfeld.pl) directly for more details.
+Fork it, update and wait for the Github Actions results.

data/lib/karafka/setup/config.rb

@@ -24,89 +24,89 @@ module Karafka
       #   default Kafka groups namespaces and identify that app in kafka
       setting :client_id
       # What backend do we want to use to process messages
-      setting :backend, :inline
+      setting :backend, default: :inline
       # option logger [Instance] logger that we want to use
-      setting :logger, ::Karafka::Instrumentation::Logger.new
+      setting :logger, default: ::Karafka::Instrumentation::Logger.new
       # option monitor [Instance] monitor that we will to use (defaults to Karafka::Monitor)
-      setting :monitor, ::Karafka::Instrumentation::Monitor.new
+      setting :monitor, default: ::Karafka::Instrumentation::Monitor.new
       # Mapper used to remap consumer groups ids, so in case users migrate from other tools
       # or they need to maintain their own internal consumer group naming conventions, they
       # can easily do it, replacing the default client_id + consumer name pattern concept
-      setting :consumer_mapper, Routing::ConsumerMapper.new
+      setting :consumer_mapper, default: Routing::ConsumerMapper.new
       # Mapper used to remap names of topics, so we can have a clean internal topic naming
       # despite using any Kafka provider that uses namespacing, etc
       # It needs to implement two methods:
       #   - #incoming - for remapping from the incoming message to our internal format
       #   - #outgoing - for remapping from internal topic name into outgoing message
-      setting :topic_mapper, Routing::TopicMapper.new
+      setting :topic_mapper, default: Routing::TopicMapper.new
       # Default serializer for converting whatever we want to send to kafka to json
-      setting :serializer, Karafka::Serialization::Json::Serializer.new
+      setting :serializer, default: Karafka::Serialization::Json::Serializer.new
       # Default deserializer for converting incoming data into ruby objects
-      setting :deserializer, Karafka::Serialization::Json::Deserializer.new
+      setting :deserializer, default: Karafka::Serialization::Json::Deserializer.new
       # If batch_fetching is true, we will fetch kafka messages in batches instead of 1 by 1
       # @note Fetching does not equal consuming, see batch_consuming description for details
-      setting :batch_fetching, true
+      setting :batch_fetching, default: true
       # If batch_consuming is true, we will have access to #params_batch instead of #params.
       # #params_batch will contain params received from Kafka (may be more than 1) so we can
       # process them in batches
-      setting :batch_consuming, false
+      setting :batch_consuming, default: false
       # option shutdown_timeout [Integer, nil] the number of seconds after which Karafka no
       #   longer wait for the consumers to stop gracefully but instead we force terminate
       #   everything.
-      setting :shutdown_timeout, 60
+      setting :shutdown_timeout, default: 60
 
       # option kafka [Hash] - optional - kafka configuration options
       setting :kafka do
         # Array with at least one host
-        setting :seed_brokers, %w[kafka://127.0.0.1:9092]
+        setting :seed_brokers, default: %w[kafka://127.0.0.1:9092]
         # option session_timeout [Integer] the number of seconds after which, if a client
         #   hasn't contacted the Kafka cluster, it will be kicked out of the group.
-        setting :session_timeout, 30
+        setting :session_timeout, default: 30
         # Time that a given partition will be paused from fetching messages, when message
         # consumption fails. It allows us to process other partitions, while the error is being
         # resolved and also "slows" things down, so it prevents from "eating" up all messages and
         # consuming them with failed code. Use `nil` if you want to pause forever and never retry.
-        setting :pause_timeout, 10
+        setting :pause_timeout, default: 10
         # option pause_max_timeout [Integer, nil] the maximum number of seconds to pause for,
         #   or `nil` if no maximum should be enforced.
-        setting :pause_max_timeout, nil
+        setting :pause_max_timeout, default: nil
         # option pause_exponential_backoff [Boolean] whether to enable exponential backoff
-        setting :pause_exponential_backoff, false
+        setting :pause_exponential_backoff, default: false
         # option offset_commit_interval [Integer] the interval between offset commits,
         #   in seconds.
-        setting :offset_commit_interval, 10
+        setting :offset_commit_interval, default: 10
         # option offset_commit_threshold [Integer] the number of messages that can be
         #   processed before their offsets are committed. If zero, offset commits are
         #   not triggered by message consumption.
-        setting :offset_commit_threshold, 0
+        setting :offset_commit_threshold, default: 0
         # option heartbeat_interval [Integer] the interval between heartbeats; must be less
         #   than the session window.
-        setting :heartbeat_interval, 10
+        setting :heartbeat_interval, default: 10
         # option offset_retention_time [Integer] The length of the retention window, known as
         #   offset retention time
-        setting :offset_retention_time, nil
+        setting :offset_retention_time, default: nil
         # option fetcher_max_queue_size [Integer] max number of items in the fetch queue that
         #   are stored for further processing. Note, that each item in the queue represents a
         #   response from a single broker
-        setting :fetcher_max_queue_size, 10
+        setting :fetcher_max_queue_size, default: 10
         # option assignment_strategy [Object] a strategy determining the assignment of
         #   partitions to the consumers.
-        setting :assignment_strategy, Karafka::AssignmentStrategies::RoundRobin.new
+        setting :assignment_strategy, default: Karafka::AssignmentStrategies::RoundRobin.new
         # option max_bytes_per_partition [Integer] the maximum amount of data fetched
         #   from a single partition at a time.
-        setting :max_bytes_per_partition, 1_048_576
+        setting :max_bytes_per_partition, default: 1_048_576
         #  whether to consume messages starting at the beginning or to just consume new messages
-        setting :start_from_beginning, true
+        setting :start_from_beginning, default: true
         # option resolve_seed_brokers [Boolean] whether to resolve each hostname of the seed
         # brokers
-        setting :resolve_seed_brokers, false
+        setting :resolve_seed_brokers, default: false
         # option min_bytes [Integer] the minimum number of bytes to read before
         #   returning messages from the server; if `max_wait_time` is reached, this
         #   is ignored.
-        setting :min_bytes, 1
+        setting :min_bytes, default: 1
         # option max_bytes [Integer] the maximum number of bytes to read before returning messages
         #   from each broker.
-        setting :max_bytes, 10_485_760
+        setting :max_bytes, default: 10_485_760
         # option max_wait_time [Integer, Float] max_wait_time is the maximum number of seconds to
         #   wait before returning data from a single message fetch. By setting this high you also
         #   increase the fetching throughput - and by setting it low you set a bound on latency.
@@ -114,65 +114,65 @@ module Karafka
         #   time specified. The default value is one second. If you want to have at most five
         #   seconds of latency, set `max_wait_time` to 5. You should make sure
         #   max_wait_time * num brokers + heartbeat_interval is less than session_timeout.
-        setting :max_wait_time, 1
+        setting :max_wait_time, default: 1
         # option automatically_mark_as_consumed [Boolean] should we automatically mark received
         # messages as consumed (processed) after non-error consumption
-        setting :automatically_mark_as_consumed, true
+        setting :automatically_mark_as_consumed, default: true
         # option reconnect_timeout [Integer] How long should we wait before trying to reconnect to
         # Kafka cluster that went down (in seconds)
-        setting :reconnect_timeout, 5
+        setting :reconnect_timeout, default: 5
         # option connect_timeout [Integer] Sets the number of seconds to wait while connecting to
         # a broker for the first time. When ruby-kafka initializes, it needs to connect to at
         # least one host.
-        setting :connect_timeout, 10
+        setting :connect_timeout, default: 10
         # option socket_timeout [Integer] Sets the number of seconds to wait when reading from or
         # writing to a socket connection to a broker. After this timeout expires the connection
         # will be killed. Note that some Kafka operations are by definition long-running, such as
         # waiting for new messages to arrive in a partition, so don't set this value too low
-        setting :socket_timeout, 30
+        setting :socket_timeout, default: 30
         # option partitioner [Object, nil] the partitioner that should be used by the client
-        setting :partitioner, nil
+        setting :partitioner, default: nil
 
         # SSL authentication related settings
         # option ca_cert [String, nil] SSL CA certificate
-        setting :ssl_ca_cert, nil
+        setting :ssl_ca_cert, default: nil
         # option ssl_ca_cert_file_path [String, nil] SSL CA certificate file path
-        setting :ssl_ca_cert_file_path, nil
+        setting :ssl_ca_cert_file_path, default: nil
         # option ssl_ca_certs_from_system [Boolean] Use the CA certs from your system's default
         #   certificate store
-        setting :ssl_ca_certs_from_system, false
+        setting :ssl_ca_certs_from_system, default: false
         # option ssl_verify_hostname [Boolean] Verify the hostname for client certs
-        setting :ssl_verify_hostname, true
+        setting :ssl_verify_hostname, default: true
         # option ssl_client_cert [String, nil] SSL client certificate
-        setting :ssl_client_cert, nil
+        setting :ssl_client_cert, default: nil
         # option ssl_client_cert_key [String, nil] SSL client certificate password
-        setting :ssl_client_cert_key, nil
+        setting :ssl_client_cert_key, default: nil
         # option sasl_gssapi_principal [String, nil] sasl principal
-        setting :sasl_gssapi_principal, nil
+        setting :sasl_gssapi_principal, default: nil
         # option sasl_gssapi_keytab [String, nil] sasl keytab
-        setting :sasl_gssapi_keytab, nil
+        setting :sasl_gssapi_keytab, default: nil
         # option sasl_plain_authzid [String] The authorization identity to use
-        setting :sasl_plain_authzid, ''
+        setting :sasl_plain_authzid, default: ''
         # option sasl_plain_username [String, nil] The username used to authenticate
-        setting :sasl_plain_username, nil
+        setting :sasl_plain_username, default: nil
         # option sasl_plain_password [String, nil] The password used to authenticate
-        setting :sasl_plain_password, nil
+        setting :sasl_plain_password, default: nil
         # option sasl_scram_username [String, nil] The username used to authenticate
-        setting :sasl_scram_username, nil
+        setting :sasl_scram_username, default: nil
         # option sasl_scram_password [String, nil] The password used to authenticate
-        setting :sasl_scram_password, nil
+        setting :sasl_scram_password, default: nil
         # option sasl_scram_mechanism [String, nil] Scram mechanism, either 'sha256' or 'sha512'
-        setting :sasl_scram_mechanism, nil
+        setting :sasl_scram_mechanism, default: nil
         # option sasl_over_ssl [Boolean] whether to enforce SSL with SASL
-        setting :sasl_over_ssl, true
+        setting :sasl_over_ssl, default: true
         # option ssl_client_cert_chain [String, nil] client cert chain or nil if not used
-        setting :ssl_client_cert_chain, nil
+        setting :ssl_client_cert_chain, default: nil
         # option ssl_client_cert_key_password [String, nil] the password required to read
         #   the ssl_client_cert_key
-        setting :ssl_client_cert_key_password, nil
+        setting :ssl_client_cert_key_password, default: nil
         # @param sasl_oauth_token_provider [Object, nil] OAuthBearer Token Provider instance that
         #   implements method token.
-        setting :sasl_oauth_token_provider, nil
+        setting :sasl_oauth_token_provider, default: nil
       end
 
       # Namespace for internal settings that should not be modified
@@ -180,18 +180,18 @@ module Karafka
       # non global state
       setting :internal do
         # option routing_builder [Karafka::Routing::Builder] builder instance
-        setting :routing_builder, Routing::Builder.new
+        setting :routing_builder, default: Routing::Builder.new
         # option status [Karafka::Status] app status
-        setting :status, Status.new
+        setting :status, default: Status.new
         # option process [Karafka::Process] process status
         # @note In the future, we need to have a single process representation for all the karafka
         #   instances
-        setting :process, Process.new
+        setting :process, default: Process.new
         # option fetcher [Karafka::Fetcher] fetcher instance
-        setting :fetcher, Fetcher.new
+        setting :fetcher, default: Fetcher.new
         # option configurators [Array<Object>] all configurators that we want to run after
         #   the setup
-        setting :configurators, [Configurators::WaterDrop.new]
+        setting :configurators, default: [Configurators::WaterDrop.new]
       end
 
       class << self

data/lib/karafka/version.rb

@@ -3,5 +3,5 @@
 # Main module namespace
 module Karafka
   # Current Karafka version
-  VERSION = '1.4.8'
+  VERSION = '1.4.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.4.9
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -36,7 +36,7 @@ cert_chain:
   R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
   pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
   -----END CERTIFICATE-----
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -191,7 +191,6 @@ files:
 - ".coditsu/ci.yml"
 - ".console_irbrc"
 - ".diffend.yml"
-- ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/ci.yml"
@@ -306,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: Ruby based framework for working with Apache Kafka

data/.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-open_collective: karafka