karafka 1.4.0.rc1

data/lib/karafka/setup/configurators/water_drop.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Setup
+    # Configurators are used to post setup some of the components of Karafka after the core
+    # framework is initialized
+    module Configurators
+      # Class responsible for setting up WaterDrop configuration
+      class WaterDrop
+        # Sets up a WaterDrop settings
+        # @param config [Karafka::Setup::Config] Config we can user to setup things
+        # @note This will also inject Karafka monitor as a default monitor into WaterDrop,
+        #   so we have the same monitor within whole Karafka framework (same with logger)
+        def call(config)
+          ::WaterDrop.setup do |water_config|
+            water_config.deliver = true
+
+            config.to_h.reject { |k, _v| k == :kafka }.each do |k, v|
+              key_assignment = :"#{k}="
+              next unless water_config.respond_to?(key_assignment)
+
+              water_config.public_send(key_assignment, v)
+            end
+
+            config.kafka.to_h.each do |k, v|
+              key_assignment = :"#{k}="
+              next unless water_config.kafka.respond_to?(key_assignment)
+
+              water_config.kafka.public_send(key_assignment, v)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/setup/dsl.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Setup
+    # Dsl for allowing to work with the configuration from the Karafka::App
+    # @note Despite providing methods, everything is still persisted and fetched
+    # from the Karafka::Setup::Config
+    module Dsl
+      # Sets up the whole configuration
+      # @param [Block] block configuration block
+      def setup(&block)
+        Setup::Config.setup(&block)
+      end
+
+      # @return [Karafka::Config] config instance
+      def config
+        Setup::Config.config
+      end
+    end
+  end
+end

data/lib/karafka/status.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Karafka
+  # App status monitor
+  class Status
+    # Available states and their transitions
+    STATES = {
+      initializing: :initialize!,
+      initialized: :initialized!,
+      running: :run!,
+      stopping: :stop!
+    }.freeze
+
+    private_constant :STATES
+
+    STATES.each do |state, transition|
+      define_method :"#{state}?" do
+        @status == state
+      end
+
+      define_method transition do
+        @status = state
+        # Trap context disallows to run certain things that we instrument
+        # so the state changes are executed from a separate thread
+        Thread.new { Karafka.monitor.instrument("app.#{state}") }.join
+      end
+    end
+  end
+end

data/lib/karafka/templates/application_consumer.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Application consumer from which all Karafka consumers should inherit
+# You can rename it if it would conflict with your current code base (in case you're integrating
+# Karafka with other frameworks)
+class ApplicationConsumer < Karafka::BaseConsumer
+end

data/lib/karafka/templates/application_responder.rb.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Application responder from which all Karafka responders should inherit
+# You can rename it if it would conflict with your current code base (in case you're integrating
+# Karafka with other frameworks)
+class ApplicationResponder < Karafka::BaseResponder
+  # This method needs to be implemented in each of the responders
+  # def respond(data)
+  #   respond_to :topic, data.to_json
+  # end
+end

data/lib/karafka/templates/karafka.rb.erb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+<% if rails? -%>
+ENV['RAILS_ENV'] ||= 'development'
+ENV['KARAFKA_ENV'] = ENV['RAILS_ENV']
+require ::File.expand_path('../config/environment', __FILE__)
+Rails.application.eager_load!
+
+# This lines will make Karafka print to stdout like puma or unicorn
+if Rails.env.development?
+  Rails.logger.extend(
+    ActiveSupport::Logger.broadcast(
+      ActiveSupport::Logger.new($stdout)
+    )
+  )
+end
+<% else -%>
+# This file is auto-generated during the install process.
+# If by any chance you've wanted a setup for Rails app, either run the `karafka:install`
+# command again or refer to the install templates available in the source codes
+
+ENV['RACK_ENV'] ||= 'development'
+ENV['KARAFKA_ENV'] ||= ENV['RACK_ENV']
+Bundler.require(:default, ENV['KARAFKA_ENV'])
+
+# Zeitwerk custom loader for loading the app components before the whole
+# Karafka framework configuration
+APP_LOADER = Zeitwerk::Loader.new
+APP_LOADER.enable_reloading
+
+%w[
+  lib
+  app/consumers
+  app/responders
+  app/workers
+].each(&APP_LOADER.method(:push_dir))
+
+APP_LOADER.setup
+APP_LOADER.eager_load
+<% end -%>
+
+class KarafkaApp < Karafka::App
+  setup do |config|
+    config.kafka.seed_brokers = %w[kafka://127.0.0.1:9092]
+    config.client_id = 'example_app'
+<% if rails? -%>
+    config.logger = Rails.logger
+<% end -%>
+  end
+
+  # Comment out this part if you are not using instrumentation and/or you are not
+  # interested in logging events for certain environments. Since instrumentation
+  # notifications add extra boilerplate, if you want to achieve max performance,
+  # listen to only what you really need for given environment.
+  Karafka.monitor.subscribe(WaterDrop::Instrumentation::StdoutListener.new)
+  Karafka.monitor.subscribe(Karafka::Instrumentation::StdoutListener.new)
+  Karafka.monitor.subscribe(Karafka::Instrumentation::ProctitleListener.new)
+
+  # Uncomment that in order to achieve code reload in development mode
+  # Be aware, that this might have some side-effects. Please refer to the wiki
+  # for more details on benefits and downsides of the code reload in the
+  # development mode
+  #
+  # Karafka.monitor.subscribe(
+  #   Karafka::CodeReloader.new(
+  #     <%= rails? ? '*Rails.application.reloaders' : 'APP_LOADER' %>
+  #   )
+  # )
+
+  consumer_groups.draw do
+    # topic :example do
+    #   consumer ExampleConsumer
+    # end
+
+    # consumer_group :bigger_group do
+    #   topic :test do
+    #     consumer TestConsumer
+    #   end
+    #
+    #   topic :test2 do
+    #     consumer Test2Consumer
+    #   end
+    # end
+  end
+end
+
+Karafka.monitor.subscribe('app.initialized') do
+  # Put here all the things you want to do after the Karafka framework
+  # initialization
+end
+
+KarafkaApp.boot!

data/lib/karafka/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Main module namespace
+module Karafka
+  # Current Karafka version
+  VERSION = '1.4.0.rc1'
+end

metadata

@@ -0,0 +1,325 @@
+--- !ruby/object:Gem::Specification
+name: karafka
+version: !ruby/object:Gem::Version
+  version: 1.4.0.rc1
+platform: ruby
+authors:
+- Maciej Mensfeld
+- Pavlo Vavruk
+- Adam Gwozdowski
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
+  ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjAwODExMDkxNTM3WhcNMjEwODExMDkx
+  NTM3WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDCpXsCgmINb6lHBXXBdyrgsBPSxC4/
+  2H+weJ6L9CruTiv2+2/ZkQGtnLcDgrD14rdLIHK7t0o3EKYlDT5GhD/XUVhI15JE
+  N7IqnPUgexe1fbZArwQ51afxz2AmPQN2BkB2oeQHXxnSWUGMhvcEZpfbxCCJH26w
+  hS0Ccsma8yxA6hSlGVhFVDuCr7c2L1di6cK2CtIDpfDaWqnVNJEwBYHIxrCoWK5g
+  sIGekVt/admS9gRhIMaIBg+Mshth5/DEyWO2QjteTodItlxfTctrfmiAl8X8T5JP
+  VXeLp5SSOJ5JXE80nShMJp3RFnGw5fqjX/ffjtISYh78/By4xF3a25HdWH9+qO2Z
+  tx0wSGc9/4gqNM0APQnjN/4YXrGZ4IeSjtE+OrrX07l0TiyikzSLFOkZCAp8oBJi
+  Fhlosz8xQDJf7mhNxOaZziqASzp/hJTU/tuDKl5+ql2icnMv5iV/i6SlmvU29QNg
+  LCV71pUv0pWzN+OZbHZKWepGhEQ3cG9MwvkCAwEAAaN3MHUwCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFImGed2AXS070ohfRidiCEhXEUN+MB0GA1Ud
+  EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
+  c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKiHpwoENVrMi94V1zD4o8/6G3AU
+  gWz4udkPYHTZLUy3dLznc/sNjdkJFWT3E6NKYq7c60EpJ0m0vAEg5+F5pmNOsvD3
+  2pXLj9kisEeYhR516HwXAvtngboUcb75skqvBCU++4Pu7BRAPjO1/ihLSBexbwSS
+  fF+J5OWNuyHHCQp+kGPLtXJe2yUYyvSWDj3I2//Vk0VhNOIlaCS1+5/P3ZJThOtm
+  zJUBI7h3HgovwRpcnmk2mXTmU4Zx/bCzX8EA6VY0khEvnmiq7S6eBF0H9qH8KyQ6
+  EkVLpvmUDFcf/uNaBQdazEMB5jYtwoA8gQlANETNGPi51KlkukhKgaIEDMkBDJOx
+  65N7DzmkcyY0/GwjIVIxmRhcrCt1YeCUElmfFx0iida1/YRm6sB2AXqScc1+ECRi
+  2DND//YJUikn1zwbz1kT70XmHd97B4Eytpln7K+M1u2g1pHVEPW4owD/ammXNpUy
+  nt70FcDD4yxJQ+0YNiHd0N8IcVBM1TMIVctMNQ==
+  -----END CERTIFICATE-----
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dry-monitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: envlogic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: waterdrop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Framework used to simplify Apache Kafka based Ruby applications development
+email:
+- maciej@mensfeld.pl
+- pavlo.vavruk@gmail.com
+- adam99g@gmail.com
+executables:
+- karafka
+extensions: []
+extra_rdoc_files: []
+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"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENCE
+- README.md
+- bin/karafka
+- certs/mensfeld.pem
+- config/errors.yml
+- docker-compose.yml
+- karafka.gemspec
+- lib/karafka.rb
+- lib/karafka/app.rb
+- lib/karafka/attributes_map.rb
+- lib/karafka/backends/inline.rb
+- lib/karafka/base_consumer.rb
+- lib/karafka/base_responder.rb
+- lib/karafka/cli.rb
+- lib/karafka/cli/base.rb
+- lib/karafka/cli/console.rb
+- lib/karafka/cli/flow.rb
+- lib/karafka/cli/info.rb
+- lib/karafka/cli/install.rb
+- lib/karafka/cli/server.rb
+- lib/karafka/code_reloader.rb
+- lib/karafka/connection/api_adapter.rb
+- lib/karafka/connection/batch_delegator.rb
+- lib/karafka/connection/builder.rb
+- lib/karafka/connection/client.rb
+- lib/karafka/connection/listener.rb
+- lib/karafka/connection/message_delegator.rb
+- lib/karafka/consumers/batch_metadata.rb
+- lib/karafka/consumers/callbacks.rb
+- lib/karafka/consumers/includer.rb
+- lib/karafka/consumers/responders.rb
+- lib/karafka/consumers/single_params.rb
+- lib/karafka/contracts.rb
+- lib/karafka/contracts/config.rb
+- lib/karafka/contracts/consumer_group.rb
+- lib/karafka/contracts/consumer_group_topic.rb
+- lib/karafka/contracts/responder_usage.rb
+- lib/karafka/contracts/server_cli_options.rb
+- lib/karafka/errors.rb
+- lib/karafka/fetcher.rb
+- lib/karafka/helpers/class_matcher.rb
+- lib/karafka/helpers/config_retriever.rb
+- lib/karafka/helpers/inflector.rb
+- lib/karafka/helpers/multi_delegator.rb
+- lib/karafka/instrumentation/logger.rb
+- lib/karafka/instrumentation/monitor.rb
+- lib/karafka/instrumentation/proctitle_listener.rb
+- lib/karafka/instrumentation/stdout_listener.rb
+- lib/karafka/params/batch_metadata.rb
+- lib/karafka/params/builders/batch_metadata.rb
+- lib/karafka/params/builders/params.rb
+- lib/karafka/params/builders/params_batch.rb
+- lib/karafka/params/metadata.rb
+- lib/karafka/params/params.rb
+- lib/karafka/params/params_batch.rb
+- lib/karafka/patches/ruby_kafka.rb
+- lib/karafka/persistence/client.rb
+- lib/karafka/persistence/consumers.rb
+- lib/karafka/persistence/topics.rb
+- lib/karafka/process.rb
+- lib/karafka/responders/builder.rb
+- lib/karafka/responders/topic.rb
+- lib/karafka/routing/builder.rb
+- lib/karafka/routing/consumer_group.rb
+- lib/karafka/routing/consumer_mapper.rb
+- lib/karafka/routing/proxy.rb
+- lib/karafka/routing/router.rb
+- lib/karafka/routing/topic.rb
+- lib/karafka/routing/topic_mapper.rb
+- lib/karafka/serialization/json/deserializer.rb
+- lib/karafka/serialization/json/serializer.rb
+- lib/karafka/server.rb
+- lib/karafka/setup/config.rb
+- lib/karafka/setup/configurators/water_drop.rb
+- lib/karafka/setup/dsl.rb
+- lib/karafka/status.rb
+- lib/karafka/templates/application_consumer.rb.erb
+- lib/karafka/templates/application_responder.rb.erb
+- lib/karafka/templates/karafka.rb.erb
+- lib/karafka/version.rb
+- log/.gitkeep
+homepage: https://github.com/karafka/karafka
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby based framework for working with Apache Kafka
+test_files: []