karafka 1.0.0 → 1.2.0

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

@@ -3,10 +3,13 @@
 module Karafka
   module Setup
     # Configurators module is used to enclose all the external dependencies configurations
+    # upon which Karafka depents
     class Configurators
-      # Karafka has come components that it relies on (like Celluloid or Sidekiq)
+      # Karafka has some components that it relies on (like Sidekiq)
       # We need to configure all of them only when the framework was set up.
       # Any class that descends from this one will be automatically invoked upon setup (after it)
+      # @note This should be used only for internal Karafka dependencies configuration
+      #   End users configuration should go to the after_init block
       # @example Configure an Example class
       #   class ExampleConfigurator < Base
       #     def setup
@@ -15,18 +18,9 @@ module Karafka
       #     end
       #   end
       class Base
-        extend ActiveSupport::DescendantsTracker
-
-        attr_reader :config
-
-        # @param config [Karafka::Config] config instance
-        # @return [Karafka::Config::Base] configurator for a given component
-        def initialize(config)
-          @config = config
-        end
-
+        # @param _config [Karafka::Config] config instance
         # This method needs to be implemented in a subclass
-        def setup
+        def self.setup(_config)
           raise NotImplementedError
         end
       end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Setup
+    class Configurators
+      # Karafka::Params::Params are dynamically built based on user defined parent class
+      # so we cannot just require it, we need to initialize it after user is done with
+      # the framework configuration. This is a configurator that does exactly that.
+      class Params < Base
+        # Builds up Karafka::Params::Params class with user defined parent class
+        # @param config [Karafka::Setup::Config] Config we can user to setup things
+        def self.setup(config)
+          return if defined? Karafka::Params::Params
+
+          Karafka::Params.const_set(
+            'Params',
+            Class
+              .new(config.params_base_class)
+              .tap { |klass| klass.include(Karafka::Params::Dsl) }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -6,22 +6,23 @@ module Karafka
       # Class responsible for setting up WaterDrop configuration
       class WaterDrop < Base
         # Sets up a WaterDrop settings
-        def setup
-          dynamic_params = Connection::ConfigAdapter.client(nil)
-
+        # @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 self.setup(config)
           ::WaterDrop.setup do |water_config|
-            water_config.send_messages = true
-            water_config.raise_on_failure = true
-            water_config.connection_pool = config.connection_pool
+            water_config.deliver = true
+
+            config.to_h.except(:kafka).each do |k, v|
+              key_assignment = :"#{k}="
+              next unless water_config.respond_to?(key_assignment)
+              water_config.public_send(key_assignment, v)
+            end
 
-            # Automigration of all the attributes that should be accepted by waterdrop
-            # based on what we use in karafka ruby-kafka initialization
-            dynamic_params.each do |key, value|
-              key_assignment = :"#{key}="
-              # We decide whether we should set it on a kafka scope of waterdrop config or on the
-              # main scope
-              scope = water_config.kafka.respond_to?(key_assignment) ? :kafka : :itself
-              water_config.public_send(scope).public_send(key_assignment, value)
+            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

data/lib/karafka/setup/dsl.rb

@@ -0,0 +1,22 @@
+# 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)
+        initialize!
+      end
+
+      # @return [Karafka::Config] config instance
+      def config
+        Setup::Config.config
+      end
+    end
+  end
+end

data/lib/karafka/templates/{application_controller.rb.example → application_consumer.rb.example}

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# Application controller from which all Karafka controllers should inherit
+# 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 ApplicationController < Karafka::BaseController
-end
+ApplicationConsumer = Class.new(Karafka::BaseConsumer)

data/lib/karafka/templates/karafka.rb.example

@@ -15,24 +15,37 @@ Karafka::Loader.load(Karafka::App.root)
 
 class KarafkaApp < Karafka::App
   setup do |config|
-    config.kafka.seed_brokers = %w( 127.0.0.1:9092 )
+    config.kafka.seed_brokers = %w[kafka://127.0.0.1:9092]
     config.client_id = 'example_app'
     config.backend = :inline
-    config.batch_consuming = true
+    config.batch_fetching = true
+    # Uncomment this for Rails app integration
+    # config.logger = Rails.logger
   end
 
+  after_init do |config|
+    # Put here all the things you want to do after the Karafka framework
+    # initialization
+  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(Karafka::Instrumentation::Listener)
+
   consumer_groups.draw do
     # topic :example do
-    #   controller ExampleController
+    #   consumer ExampleConsumer
     # end
 
     # consumer_group :bigger_group do
     #   topic :test do
-    #     controller TestController
+    #     consumer TestConsumer
     #   end
     #
     #   topic :test2 do
-    #     controller Test2Controller
+    #     consumer Test2Consumer
     #   end
     # end
   end

data/lib/karafka/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -10,162 +10,176 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-kafka
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: celluloid
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: envlogic
+  name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: waterdrop
+  name: dry-monitor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: envlogic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: dry-validation
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '11.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: ruby-kafka
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: waterdrop
+  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'
 description: Framework used to simplify Apache Kafka based Ruby applications development
 email:
 - maciej@coditsu.io
@@ -177,7 +191,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".console_irbrc"
-- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -190,15 +203,18 @@ files:
 - Gemfile.lock
 - MIT-LICENCE
 - README.md
-- Rakefile
 - bin/karafka
+- config/errors.yml
 - karafka.gemspec
 - lib/karafka.rb
 - lib/karafka/app.rb
 - lib/karafka/attributes_map.rb
 - lib/karafka/backends/inline.rb
-- lib/karafka/base_controller.rb
+- lib/karafka/base_consumer.rb
 - lib/karafka/base_responder.rb
+- lib/karafka/callbacks.rb
+- lib/karafka/callbacks/config.rb
+- lib/karafka/callbacks/dsl.rb
 - lib/karafka/cli.rb
 - lib/karafka/cli/base.rb
 - lib/karafka/cli/console.rb
@@ -206,46 +222,54 @@ files:
 - lib/karafka/cli/info.rb
 - lib/karafka/cli/install.rb
 - lib/karafka/cli/server.rb
+- lib/karafka/connection/client.rb
 - lib/karafka/connection/config_adapter.rb
+- lib/karafka/connection/delegator.rb
 - lib/karafka/connection/listener.rb
-- lib/karafka/connection/messages_consumer.rb
-- lib/karafka/connection/messages_processor.rb
-- lib/karafka/controllers/includer.rb
-- lib/karafka/controllers/responders.rb
-- lib/karafka/controllers/single_params.rb
+- lib/karafka/consumers/callbacks.rb
+- lib/karafka/consumers/includer.rb
+- lib/karafka/consumers/responders.rb
+- lib/karafka/consumers/single_params.rb
 - lib/karafka/errors.rb
 - lib/karafka/fetcher.rb
 - lib/karafka/helpers/class_matcher.rb
 - lib/karafka/helpers/config_retriever.rb
 - lib/karafka/helpers/multi_delegator.rb
+- lib/karafka/instrumentation/listener.rb
+- lib/karafka/instrumentation/logger.rb
+- lib/karafka/instrumentation/monitor.rb
 - lib/karafka/loader.rb
-- lib/karafka/logger.rb
-- lib/karafka/monitor.rb
-- lib/karafka/params/params.rb
+- lib/karafka/params/dsl.rb
 - lib/karafka/params/params_batch.rb
 - lib/karafka/parsers/json.rb
 - lib/karafka/patches/dry_configurable.rb
-- lib/karafka/persistence.rb
+- lib/karafka/patches/ruby_kafka.rb
+- lib/karafka/persistence/client.rb
+- lib/karafka/persistence/consumer.rb
+- lib/karafka/persistence/topic.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/mapper.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/schemas/config.rb
 - lib/karafka/schemas/consumer_group.rb
+- lib/karafka/schemas/consumer_group_topic.rb
 - lib/karafka/schemas/responder_usage.rb
 - lib/karafka/schemas/server_cli_options.rb
 - lib/karafka/server.rb
 - lib/karafka/setup/config.rb
 - lib/karafka/setup/configurators/base.rb
-- lib/karafka/setup/configurators/celluloid.rb
+- lib/karafka/setup/configurators/params.rb
 - lib/karafka/setup/configurators/water_drop.rb
+- lib/karafka/setup/dsl.rb
 - lib/karafka/status.rb
-- lib/karafka/templates/application_controller.rb.example
+- lib/karafka/templates/application_consumer.rb.example
 - lib/karafka/templates/application_responder.rb.example
 - lib/karafka/templates/karafka.rb.example
 - lib/karafka/version.rb
@@ -270,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby based framework for working with Apache Kafka