karafka 0.5.0

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

@@ -0,0 +1,19 @@
+module Karafka
+  module Setup
+    class Configurators
+      # Class responsible for setting up WaterDrop configuration
+      class WaterDrop < Base
+        # Sets up a WaterDrop settings
+        def setup
+          ::WaterDrop.setup do |water_config|
+            water_config.send_messages = true
+            water_config.connection_pool_size = config.concurrency
+            water_config.connection_pool_timeout = 1
+            water_config.kafka_hosts = config.kafka.hosts
+            water_config.raise_on_failure = true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Karafka
+  module Setup
+    class Configurators
+      # Class responsible for setting up WorkerGlass settings
+      class WorkerGlass < Base
+        # Sets up a Karafka logger as celluloid logger
+        def setup
+          ::WorkerGlass.logger = ::Karafka.logger
+        end
+      end
+    end
+  end
+end

data/lib/karafka/status.rb

@@ -0,0 +1,23 @@
+module Karafka
+  # App status monitor
+  class Status
+    include Singleton
+
+    # Available states and their transitions
+    STATES = {
+      initializing: :initialize!,
+      running: :run!,
+      stopped: :stop!
+    }.freeze
+
+    STATES.each do |state, transition|
+      define_method :"#{state}?" do
+        @status == state
+      end
+
+      define_method transition do
+        @status = state
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+ENV['RACK_ENV'] ||= 'development'
+ENV['KARAFKA_ENV'] ||= ENV['RACK_ENV']
+
+Bundler.require(:default, ENV['KARAFKA_ENV'])
+
+Karafka::Loader.new.load(Karafka::App.root)
+
+# App class
+class App < Karafka::App
+  setup do |config|
+    config.kafka = { hosts: %w( 127.0.0.1:9092 ) }
+    config.name = 'example_app'
+    config.redis = {
+      url: 'redis://localhost:6379'
+    }
+  end
+
+  routes.draw do
+    # topic :example do
+    #   controller ExampleController
+    #   interchanger CustomInterchanger
+    # end
+  end
+end
+
+App.boot!

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

@@ -0,0 +1,5 @@
+# Application controller from which all Karafka controllers 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

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

@@ -0,0 +1,9 @@
+# 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/application_worker.rb.example

@@ -0,0 +1,12 @@
+# Application worker from which all workers should inherit
+# You can rename it if it would conflict with your current code base (in case you're integrating
+# Karafka with other frameworks). Karafka will use first direct descendant of Karafka::BaseWorker
+# to build worker classes
+class ApplicationWorker < Karafka::BaseWorker
+  # You can disable WorkerGlass components if you want to
+  prepend WorkerGlass::Timeout
+  prepend WorkerGlass::Reentrancy
+
+  # If you remove WorkerGlass::Timeout, this line will be useless as well
+  self.timeout = 60
+end

data/lib/karafka/templates/config.ru.example

@@ -0,0 +1,13 @@
+%w(
+  puma
+  sidekiq/web
+).each { |lib| require lib }
+
+require Karafka.boot_file
+
+use Rack::Auth::Basic, 'Protected Area' do |username, password|
+  username == 'sidekiq' &&
+    password == 'Pa$$WorD!'
+end
+
+run Sidekiq::Web

data/lib/karafka/templates/sidekiq.yml.example

@@ -0,0 +1,26 @@
+# Sample configuration file for Sidekiq.
+# Options here can still be overridden by cmd line args.
+# Place this file at config/sidekiq.yml and Sidekiq will
+# pick it up automatically.
+
+:verbose: true
+:concurrency: 10
+
+# Set timeout to 8 on Heroku, longer if you manage your own systems.
+:timeout: 8
+
+# Sidekiq will run this file through ERB when reading it so you can
+# even put in dynamic logic, like a host-specific queue.
+## http://www.mikeperham.com/2013/11/13/advanced-sidekiq-host-specific-queues/
+#:queues:
+#  - all
+#  - high
+#  - highest321
+
+# you can override concurrency based on environment
+production:
+  :concurrency: 10
+development:
+  :concurrency: 1
+test:
+  :concurrency: 1

data/lib/karafka/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# Main module namespace
+module Karafka
+  # Current Karafka version
+  VERSION = '0.5.0'
+end

data/lib/karafka/workers/builder.rb

@@ -0,0 +1,49 @@
+module Karafka
+  # Internal stuff related to workers
+  module Workers
+    # Builder is used to check if there is a proper controller with the same name as
+    # a controller and if not, it will create a default one using Karafka::BaseWorker
+    # This is used as a building layer between controllers and workers. it will be only used
+    # when user does not provide his own worker that should perform controller stuff
+    class Builder
+      # @param controller_class [Karafka::BaseController] descendant of Karafka::BaseController
+      # @example Create a worker builder
+      #   Karafka::Workers::Builder.new(SuperController)
+      def initialize(controller_class)
+        @controller_class = controller_class
+      end
+
+      # @return [Class] Sidekiq worker class that already exists or new build based
+      #   on the provided controller_class name
+      # @example Controller: SuperController
+      #   build #=> SuperWorker
+      # @example Controller: Videos::NewVideosController
+      #   build #=> Videos::NewVideosWorker
+      def build
+        return matcher.match if matcher.match
+        klass = Class.new(base)
+        matcher.scope.const_set(matcher.name, klass)
+      end
+
+      private
+
+      # @return [Class] descendant of Karafka::BaseWorker from which all other workers
+      #   should inherit
+      # @raise [Karafka::Errors::BaseWorkerDescentantMissing] raised when Karafka cannot detect
+      #   direct Karafka::BaseWorker descendant from which it could build workers
+      def base
+        Karafka::BaseWorker.subclasses.first || raise(Errors::BaseWorkerDescentantMissing)
+      end
+
+      # @return [Karafka::Helpers::ClassMatcher] matcher instance for matching between controller
+      #   and appropriate worker
+      def matcher
+        @matcher ||= Helpers::ClassMatcher.new(
+          @controller_class,
+          from: 'Controller',
+          to: 'Worker'
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: karafka
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+- Pavlo Vavruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.15
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: worker-glass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: envlogic
+  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: waterdrop
+  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: 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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+description: " Microframework used to simplify Kafka based Ruby applications "
+email:
+- maciej@mensfeld.pl
+- pavlo.vavruk@gmail.com
+executables:
+- karafka
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENCE
+- README.md
+- Rakefile
+- bin/karafka
+- karafka.gemspec
+- lib/karafka.rb
+- lib/karafka/app.rb
+- lib/karafka/base_controller.rb
+- lib/karafka/base_responder.rb
+- lib/karafka/base_worker.rb
+- lib/karafka/capistrano.rb
+- lib/karafka/capistrano/karafka.cap
+- 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/routes.rb
+- lib/karafka/cli/server.rb
+- lib/karafka/cli/worker.rb
+- lib/karafka/connection/consumer.rb
+- lib/karafka/connection/listener.rb
+- lib/karafka/connection/message.rb
+- lib/karafka/connection/topic_consumer.rb
+- lib/karafka/errors.rb
+- lib/karafka/fetcher.rb
+- lib/karafka/helpers/class_matcher.rb
+- lib/karafka/helpers/multi_delegator.rb
+- lib/karafka/loader.rb
+- lib/karafka/logger.rb
+- lib/karafka/monitor.rb
+- lib/karafka/params/interchanger.rb
+- lib/karafka/params/params.rb
+- lib/karafka/patches/dry/configurable/config.rb
+- lib/karafka/process.rb
+- lib/karafka/responders/builder.rb
+- lib/karafka/responders/topic.rb
+- lib/karafka/responders/usage_validator.rb
+- lib/karafka/routing/builder.rb
+- lib/karafka/routing/route.rb
+- lib/karafka/routing/router.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/sidekiq.rb
+- lib/karafka/setup/configurators/water_drop.rb
+- lib/karafka/setup/configurators/worker_glass.rb
+- lib/karafka/status.rb
+- lib/karafka/templates/app.rb.example
+- lib/karafka/templates/application_controller.rb.example
+- lib/karafka/templates/application_responder.rb.example
+- lib/karafka/templates/application_worker.rb.example
+- lib/karafka/templates/config.ru.example
+- lib/karafka/templates/sidekiq.yml.example
+- lib/karafka/version.rb
+- lib/karafka/workers/builder.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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby based Microframework for handling Apache Kafka incoming messages
+test_files: []