sneakers-laces 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0c52511ab7dd40a16bebd3315581e6543205829d3473689d8d05bf546bc4b4b
+  data.tar.gz: d7a643d5a140b97ed083d01d59ad81beb88f35a6c1c735c00a3b63d689426e18
+SHA512:
+  metadata.gz: e561b8eb24290121f9201c80fddf2bca90e7ca28bbba0ae64f6ef4bd0474417e9961f97c0143795f55c20cfa24a35a4c9e83b2398e19e38e498fef1904b6d056
+  data.tar.gz: 345fad59c3b609c618568ec4fc6450a09343440d73d413b38c7c99e5152b350f2c1873f10b329943d271ad778c9d5638ecacc4f12d137bda519030f6e8f729db

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-gemset
+/.ruby-version
+/Gemfile.lock
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-rspec
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Naming/ConstantName:
+  Exclude:
+    - 'lib/sneakers/laces/worker.rb'
+
+Style/MutableConstant:
+  Exclude:
+    - 'lib/sneakers/laces/worker.rb'
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/sneakers/laces/queue_manager.rb'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+sudo: required
+
+services:
+  - rabbitmq
+
+rvm:
+  - "2.5.1"
+
+cache:
+  bundler: true
+
+script: 'bundle exec rspec'

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sneakers-laces.gemspec
+gemspec
+
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rustam Sharshenov
+
+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,77 @@
+# Laces for [sneakers](https://github.com/jondot/sneakers) [![Build Status](https://travis-ci.org/sharshenov/sneakers-laces.svg?branch=master)](https://travis-ci.org/sharshenov/sneakers-laces) [![Gem Version](https://badge.fury.io/rb/sneakers-laces.svg)](https://badge.fury.io/rb/sneakers-laces)
+
+The project allows you to manage Sneakers queue processing dynamically. It uses RabbitMQ HTTP API to manage queues and utilizes [live restart](https://github.com/treasure-data/serverengine#live-restart) to reload workers.
+
+It can be helpful for processing IO-jobs grouped by some criteria without waiting for jobs with other criterias to be executed. Imagine requesting some remote API on user basis. Requests of particular user can be executed in parallel and should not be postponed by requests of other users.
+
+With help of the Sneakers::Laces you can declare worker classes with multiple queues per worker class. When you declare or delete a queue the worker is gracefully reloads itself without main process restart(Side effect: It is a docker-friendly solution).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sneakers-laces'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sneakers-laces
+
+## Usage on consumer-side
+
+Declare your workers and run instance
+```ruby
+require 'sneakers/laces'
+
+# Be sure to configure Sneakers same way as on producer side
+Sneakers.configure
+
+class RequestAPIWorker
+  include Sneakers::Laces::Worker
+
+  from_tag :api_requester
+
+  def work(message)
+    logger.info("Doing some API request for #{message}")
+    ack!
+  end
+end
+
+require 'sneakers/laces/runner'
+
+Sneakers::Laces::Runner.new.run
+```
+
+## Usage on producer-side
+
+```ruby
+require 'sneakers/laces'
+
+# Be sure to configure Sneakers same way as on consumer side
+Sneakers.configure
+
+queue_manager = Sneakers::Laces::QueueManager.new
+
+# This will declare queue, bindings, and send message to reload workers
+queue_manager.declare_queue name: 'user_1', worker_tag: 'api_requester'
+queue_manager.declare_queue name: 'user_2', worker_tag: 'api_requester'
+
+Sneakers.publish('user 1', to_queue: 'user_1')
+Sneakers.publish('user 2', to_queue: 'user_2')
+
+# This will delete queue and send message to reload workers
+queue_manager.delete_queue name: 'user_2', worker_tag: 'api_requester'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/sharshenov/sneakers-laces).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/lib/sneakers/laces.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rabbitmq/http/client'
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'sneakers/laces/version'
+require 'sneakers/laces/configuration'
+require 'sneakers/laces/queue_manager'
+require 'sneakers/laces/worker_manager'
+require 'sneakers/laces/worker'
+require 'sneakers/laces/reload_worker'
+require 'sneakers'
+
+module Sneakers
+  module Laces
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield(config)
+        @api_client = nil # ensure api client uses actual endpoint
+      end
+
+      def api_client
+        @api_client ||= RabbitMQ::HTTP::Client.new(config.rabbitmq_api_endpoint)
+      end
+
+      def reload(worker_tag:)
+        Sneakers.publish('reload, please', routing_key: ReloadWorker.routing_key(worker_tag: worker_tag))
+      end
+    end
+  end
+end

data/lib/sneakers/laces/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sneakers
+  module Laces
+    class Configuration
+      attr_writer :rabbitmq_api_endpoint,
+                  :vhost
+
+      def vhost
+        @vhost || Sneakers::CONFIG.fetch(:vhost)
+      end
+
+      def rabbitmq_api_endpoint
+        @rabbitmq_api_endpoint || ENV.fetch('RABBITMQ_API_ENDPOINT') { 'http://guest:guest@localhost:15672/' }
+      end
+    end
+  end
+end

data/lib/sneakers/laces/queue_manager.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Sneakers
+  module Laces
+    class QueueManager
+      WORKER_TAG_ARGUMENT = 'x-worker-tag'
+
+      def declare_queue(name:, worker_tag:, routing_key: nil, binding_arguments: [], params: {}, reload: true)
+        api_client.declare_queue  vhost,
+                                  name,
+                                  params_with_worker_tag(worker_tag, params)
+
+        api_client.bind_queue(vhost, name, exchange, (routing_key || name), binding_arguments)
+
+        reload_worker(worker_tag) if reload
+      end
+
+      def grouped_queues
+        filtered_queues.group_by { |q| q.arguments[WORKER_TAG_ARGUMENT] }
+      end
+
+      def list_queues
+        api_client.list_queues(vhost)
+      rescue Faraday::ResourceNotFound
+        Sneakers.logger.error("Vhost '#{vhost}' does not exist.")
+        []
+      end
+
+      def delete_queue(name:, worker_tag:, reload: true)
+        api_client.delete_queue vhost, name
+
+        reload_worker(worker_tag) if reload
+      rescue Faraday::ResourceNotFound
+        false
+      end
+
+      def queue_info(name:)
+        api_client.queue_info vhost, name
+      end
+
+      private
+
+      def reload_worker(worker_tag)
+        Sneakers::Laces.reload(worker_tag: worker_tag)
+      end
+
+      def filtered_queues
+        list_queues.select { |q| q.arguments[WORKER_TAG_ARGUMENT].present? }
+      end
+
+      def params_with_worker_tag(worker_tag, params = {})
+        Sneakers::CONFIG.fetch(:queue_options).merge(params.deep_symbolize_keys).tap do |p|
+          p[:arguments][WORKER_TAG_ARGUMENT] = worker_tag
+        end
+      end
+
+      def api_client
+        Sneakers::Laces.api_client
+      end
+
+      def vhost
+        Sneakers::Laces.config.vhost
+      end
+
+      def exchange
+        Sneakers::CONFIG.fetch(:exchange)
+      end
+    end
+  end
+end

data/lib/sneakers/laces/reload_worker.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sneakers
+  module Laces
+    class ReloadWorker
+      DEFAULT_OPTS = {
+        threads:      1,
+        queue_options: {
+          exclusive:   true,
+          auto_delete: true,
+          durable:     false
+        }
+      }.freeze
+
+      class << self
+        def configure(worker_tags:)
+          routing_keys = worker_tags.map { |tag| routing_key(worker_tag: tag) }
+
+          return if routing_keys.blank?
+
+          include Sneakers::Worker
+
+          # empty queue name makes consumer use dynamic one
+          from_queue '', DEFAULT_OPTS.merge(routing_key: routing_keys)
+        end
+
+        def routing_key(worker_tag:)
+          ['reload', worker_tag].join(':')
+        end
+      end
+
+      def work(_msg)
+        # USR1 signal forces serverengine to gracefully restart child processes
+        # https://github.com/treasure-data/serverengine#live-restart
+        Process.kill('USR1', Process.pid)
+      ensure
+        ack!
+      end
+    end
+  end
+end

data/lib/sneakers/laces/runner.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'sneakers/runner'
+
+module Sneakers
+  module Laces
+    class Runner
+      def run
+        Sneakers::Runner.new(runner_config).run
+      end
+
+      def runner_config
+        -> { WorkerManager.new.workers }
+      end
+    end
+  end
+end

data/lib/sneakers/laces/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sneakers
+  module Laces
+    VERSION = '0.1.1'
+  end
+end

data/lib/sneakers/laces/worker.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Sneakers
+  module Laces
+    module Worker
+      Classes = []
+
+      def self.included(base)
+        base.extend ClassMethods
+        Classes << base if base.is_a? Class
+      end
+
+      module ClassMethods
+        attr_reader :worker_opts
+        attr_reader :worker_tag
+
+        def from_tag(tag, opts = { routing_key: [] })
+          @worker_tag   = tag.to_s
+          @worker_opts  = opts
+        end
+      end
+    end
+  end
+end

data/lib/sneakers/laces/worker_manager.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sneakers
+  module Laces
+    class WorkerManager
+      cattr_accessor :workers_by_queues do
+        {}
+      end
+
+      def initialize(worker_classes = [])
+        @worker_classes = worker_classes
+        configure_reload_worker
+      end
+
+      def workers
+        workers = [ReloadWorker]
+
+        worker_classes.map do |worker_class|
+          grouped_queues.fetch(worker_class.worker_tag, []).map do |queue|
+            workers << workers_by_queues[queue.name] ||= build_worker_class(worker_class, queue)
+          end
+        end
+
+        workers
+      end
+
+      private
+
+      def configure_reload_worker
+        ReloadWorker.configure(worker_tags: worker_classes.map(&:worker_tag))
+      end
+
+      def worker_classes
+        @worker_classes.any? ? @worker_classes : Sneakers::Laces::Worker::Classes
+      end
+
+      def build_worker_class(worker_class, queue)
+        Class.new(worker_class) do
+          include Sneakers::Worker
+
+          from_queue  queue.fetch(:name),
+                      worker_class.worker_opts.deep_merge(arguments: queue.fetch(:arguments))
+        end
+      end
+
+      def grouped_queues
+        @grouped_queues ||= QueueManager.new.grouped_queues
+      end
+    end
+  end
+end

data/sneakers-laces.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sneakers/laces/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'sneakers-laces'
+  spec.version  = Sneakers::Laces::VERSION
+  spec.authors  = ['Rustam Sharshenov']
+  spec.email    = ['rustam@sharshenov.com']
+
+  spec.summary      = 'Configure your Sneakers worker on-the-fly'
+  spec.description  = 'Subscribe your Sneakers workers to queues by name regexes without process restart'
+  spec.homepage     = 'https://github.com/sharshenov/sneakers-laces'
+  spec.license      = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'rabbitmq_http_api_client'
+  spec.add_dependency 'sneakers'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: sneakers-laces
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Rustam Sharshenov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: rabbitmq_http_api_client
+  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: sneakers
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Subscribe your Sneakers workers to queues by name regexes without process
+  restart
+email:
+- rustam@sharshenov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sneakers/laces.rb
+- lib/sneakers/laces/configuration.rb
+- lib/sneakers/laces/queue_manager.rb
+- lib/sneakers/laces/reload_worker.rb
+- lib/sneakers/laces/runner.rb
+- lib/sneakers/laces/version.rb
+- lib/sneakers/laces/worker.rb
+- lib/sneakers/laces/worker_manager.rb
+- sneakers-laces.gemspec
+homepage: https://github.com/sharshenov/sneakers-laces
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Configure your Sneakers worker on-the-fly
+test_files: []