capistrano-karafka 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 369db3566eeacd1e9a68a38f222fadd990856a74
+  data.tar.gz: 294d4ac5bf51d1d87a760b6547335c300a3686b8
+SHA512:
+  metadata.gz: 2033aa8fa0476cf716c31a2917ff2ab7e32b4d33cd7b959e0abd4a6c1feb345e71eda6221a761484709da52a2332beda6cd52e5a367165344d482cf4e368c120
+  data.tar.gz: 5741accff7643074cf38f844df021f0368e1ae622c49fc378dda8e7ebd06b36f8b357451632bff500d5cfdd4168fb6c782697c85c49f8b46cf136b94315f5a7e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+capistrano-karafka

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Capistrano Karafka changelog
+
+## 1.0.0
+
+- Gem init
+- Capistrano integration via #install_plugin
+- Code quality remarks

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-karafka.gemspec
+gemspec

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,61 @@
+# Capistrano Karafka
+
+[![Gem Version](https://badge.fury.io/rb/capistrano-karafka.svg)](http://badge.fury.io/rb/capistrano-karafka)
+[![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)
+
+Karafka integration for Capistrano.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'capistrano-karafka'
+```
+
+or:
+
+```ruby
+  gem 'capistrano-karafka' , group: :development
+```
+
+And then execute:
+
+```
+  $ bundle
+```
+
+## Usage
+
+In your **Capfile**
+
+```ruby
+require 'capistrano/karafka'
+install_plugin Capistrano::Karafka
+```
+
+Take a look at the [set_defaults](https://github.com/karafka/capistrano-karafka/blob/master/lib/capistrano/karafka.rb#L16) method for options you can set. For example, to specify a different pidfile than default:
+
+```ruby
+set :karafka_pid, ->{ File.join(shared_path, 'tmp', 'pids', 'karafka0') }
+```
+
+## References
+
+* [Karafka framework](https://github.com/karafka/karafka)
+* [Capistrano Karafka](https://github.com/karafka/capistrano-karafka)
+* [Waterdrop](https://github.com/karafka/waterdrop)
+* [Envlogic](https://github.com/karafka/envlogic)
+* [Worker Glass](https://github.com/karafka/worker-glass)
+* [Null Logger](https://github.com/karafka/null-logger)
+
+## Note on Patches/Pull Requests
+
+Fork the project.
+Make your feature addition or bug fix.
+Add tests for it. This is important so I don't break it in a future version unintentionally.
+Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull). Send me a pull request. Bonus points for topic branches.
+
+[![coditsu](https://coditsu.io/assets/quality_bar.png)](https://coditsu.io)
+
+Each pull request must pass our quality requirements. To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combinse multiple linters and code analyzers. Unfortunately, for now it is invite-only based, so just ping us and we will give you access to the quality results.

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/capistrano-karafka.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'capistrano/karafka/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'capistrano-karafka'
+  spec.version     = Capistrano::Karafka::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Maciej Mensfeld']
+  spec.email       = %w[maciej@coditsu.io]
+  spec.homepage    = 'https://github.com/karafka/capistrano-karafka'
+  spec.summary     = 'Karafka integration for Capistrano'
+  spec.description = 'Karafka integration for Capistrano'
+  spec.license     = 'MIT'
+
+  spec.add_dependency 'capistrano', '~> 3.8'
+  spec.add_dependency 'capistrano-bundler'
+  spec.add_dependency 'karafka', '~> 0'
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+end

data/lib/capistrano-karafka.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/capistrano/karafka.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'capistrano/bundler'
+require 'capistrano/plugin'
+
+# Capistrano stuff
+module Capistrano
+  # Karafka Capistrano integration
+  class Karafka < Capistrano::Plugin
+    # Defines all the capistrano tasks by taking them from the rake cap file
+    def define_tasks
+      eval_rakefile File.expand_path('../tasks/karafka.cap', __FILE__)
+    end
+
+    # Default values for Karafka settings
+    def set_defaults
+      set_if_empty :karafka_role, :app
+      set_if_empty :karafka_default_hooks, -> { true }
+      set_if_empty :karafka_env, -> { fetch(:karafka_env, fetch(:environment)) }
+      set_if_empty :karafka_pid, -> { File.join(shared_path, 'tmp', 'pids', 'karafka.pid') }
+    end
+
+    # Deploy hooks registration
+    def register_hooks
+      after 'deploy:finished', 'karafka:restart'
+    end
+  end
+end

data/lib/capistrano/karafka/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Capistrano
+  class Karafka
+    # Current capistrano integration gem version
+    VERSION = '1.0.0'
+  end
+end

data/lib/capistrano/tasks/karafka.cap

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# @note Inspired by Puma capistrano handlers
+# @see https://github.com/seuros/capistrano-puma/blob/master/lib/capistrano/tasks/puma.rake
+namespace :karafka do
+  desc 'Stop Karafka'
+  task :stop do
+    on roles(fetch(:karafka_role)) do |_host|
+      within shared_path do
+        # If there's no pidfile it means that Karafka is not running
+        next unless test "cat #{fetch(:karafka_pid)}"
+
+        # Send a kill signal to a given process
+        execute "kill -INT `cat #{fetch(:karafka_pid)}`"
+
+        # And wait until it finishes. We wait because we don't want to start next process until
+        # the previous one is stopped. That way we won't have problems with Kafka registering and
+        # deregistering processes from topics (although nothing bad would happen. It would just
+        # take more time to rebalance)
+        loop do
+          break unless test "cat #{fetch(:karafka_pid)}"
+          info 'Waiting for Karafka to stop'
+          sleep 5
+        end
+      end
+    end
+  end
+
+  desc 'Start Karafka'
+  task :start do
+    on roles(fetch(:karafka_role)) do |_host|
+      within current_path do
+        # We use all 3 because when combined with Sinatra/Rails it will use their parts as well
+        # so we want to set proper env for any of them
+        with(
+          KARAFKA_ENV: fetch(:karafka_env),
+          RAILS_ENV: fetch(:rails_env),
+          RACK_ENV: fetch(:rack_env)
+        ) do
+          execute :bundle, "exec karafka server -d -p #{fetch(:karafka_pid)}"
+        end
+      end
+    end
+  end
+
+  desc 'Restart Karafka'
+  task :restart do
+    invoke 'karafka:stop'
+    invoke 'karafka:start'
+  end
+
+  desc 'Status Karafka'
+  task :status do
+    on roles(fetch(:karafka_role)) do |_host|
+      if test "cat #{fetch(:karafka_pid)}"
+        pid = capture "cat #{fetch(:karafka_pid)}"
+
+        if test "ps -p #{pid} > /dev/null"
+          info "Karafka is started: #{pid}"
+        else
+          error 'Karafka is not started but pidfile exists'
+        end
+      else
+        info 'Karafka is not started'
+      end
+    end
+  end
+
+  task :add_default_hooks do
+    after 'deploy:finished', 'karafka:restart'
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-karafka
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: capistrano-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: karafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Karafka integration for Capistrano
+email:
+- maciej@coditsu.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENCE
+- README.md
+- Rakefile
+- capistrano-karafka.gemspec
+- lib/capistrano-karafka.rb
+- lib/capistrano/karafka.rb
+- lib/capistrano/karafka/version.rb
+- lib/capistrano/tasks/karafka.cap
+homepage: https://github.com/karafka/capistrano-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.6.11
+signing_key: 
+specification_version: 4
+summary: Karafka integration for Capistrano
+test_files: []