assistor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 076ce5c505b2401756f570d5cd6d7029620d5f8c
+  data.tar.gz: 8f0aa2a897cd547bb6d816809fdc1f57a8926ffb
+SHA512:
+  metadata.gz: 00b36cf07fd1bec003667a0d2fd5e78d426eb1af3ffaa8b90410fda844b4baf1fb406c67e3a9a86f18ed21a9bf4478c72ccb441839a5f2d2ad629a8b8bce83ba
+  data.tar.gz: 96745595c9bb58ffe73c0a065213775ca501d5ccd3603c5010e5ff2b489833b1c11f5be9a0dabe4faff771e7ba0ec5d4af43dd8c1d8d7fb1c8982d0f22a32e83

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@tkowalewski.pl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomasz Kowalewski
+
+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,100 @@
+# Assistor
+
+Simple background processing framework for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'assistor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install assistor
+
+## Usage
+
+### 1. Signals
+Assistor daemon respond to signals
+
+* `QUIT` - Graceful shutdown, waits for assistants to finish their current request before finishing
+* `TERM` / `INT` - Quick shutdown, kills all assistants immediately
+* `USR1` - Increment the number of assistant processes by one
+* `USR2` - Decrement the number of assistant processes by one
+
+and assistants
+
+* `QUIT` - Graceful shutdown, waits for assistant to finish their current request before finishing
+* `TERM` / `INT` - Quick shutdown
+
+
+## Example
+```ruby
+#!/usr/bin/env ruby
+
+require 'assistor'
+
+class ExampleJob < Assistor::AbstractJob
+  def initialize(i)
+    @i = i
+  end
+
+  def run
+    sleep @i
+  end
+
+  def fail(exception)
+    ExceptionHandler.handle exception
+  end
+end
+
+class ExampleQueue < Assistor::AbstractQueue
+  def initialize
+    @queue = []
+  end
+
+  def push(job)
+    @queue.push job
+  end
+
+  def pop
+    @queue.pop
+  end
+end
+
+queue = ExampleQueue.new
+(1..100).each do |i|
+  queue.push ExampleJob.new i
+end
+
+configuration = Assistor::Configuration.new
+configuration.id = 'example'
+configuration.size = 3
+configuration.delay = 0.2
+configuration.log_file = File.join(File.expand_path('..',  __FILE__), 'example.log')
+configuration.pid_file = File.join(File.expand_path('..',  __FILE__), 'example.pid')
+
+Assistor::Daemon.new(configuration).run(queue)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tkowalewski/assistor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/assistor.rb

@@ -0,0 +1,15 @@
+require 'logger'
+require 'tmpdir'
+
+require 'assistor/version'
+require 'assistor/log_file'
+require 'assistor/pid_file'
+require 'assistor/configuration'
+require 'assistor/abstract_job'
+require 'assistor/abstract_queue'
+require 'assistor/assistant'
+require 'assistor/assistant_group'
+require 'assistor/daemon'
+
+module Assistor
+end

data/lib/assistor/abstract_job.rb

@@ -0,0 +1,15 @@
+module Assistor
+  class AbstractJob
+    def id
+      @id ||= SecureRandom.uuid
+    end
+
+    def run
+      raise NotImplementedError
+    end
+
+    def fail(exception)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/assistor/abstract_queue.rb

@@ -0,0 +1,7 @@
+module Assistor
+  class AbstractQueue
+    def pop
+      raise NotImplementedError
+    end
+  end
+end

data/lib/assistor/assistant.rb

@@ -0,0 +1,112 @@
+module Assistor
+  class Assistant
+    extend Forwardable
+
+    def_delegators :@configuration, :log_file
+
+    attr_reader :pid
+
+    def initialize(configuration, job)
+      @configuration = configuration
+      @job = job
+    end
+
+    def id
+      @id ||= [@configuration.id, @job.id].join ':'
+    end
+
+    def name
+      @name ||= [:assistor, id].join ':'
+    end
+
+    def assist
+      @pid = Process.fork do
+        start
+        process
+        stop
+      end
+      detach
+    rescue => e
+      log_file.error e
+    end
+
+    def assists?
+      Process.kill(0, pid)
+    rescue Errno::ESRCH
+      false
+    end
+
+    private
+
+    def start
+      log_file.reopen
+      handle_signals
+      set_process_title
+    end
+
+    def process
+      with_pid_file { @job.run }
+    rescue => e
+      log_file.error e
+      @job.fail e
+    end
+
+    def stop
+      return if pid_file.exist?
+      exit!(0)
+    rescue => e
+      log_file.error e
+    end
+
+    def stop!
+      pid_file.delete
+      exit!(1)
+    rescue => e
+      log_file.error e
+    end
+
+    def handle_signals
+      handle_term_signal
+      handle_int_signal
+      handle_quit_signal
+    end
+
+    def handle_term_signal
+      Signal.trap('TERM') do
+        Thread.new { stop! }.join
+        exit
+      end
+    end
+
+    def handle_int_signal
+      Signal.trap('INT') do
+        Thread.new { stop! }.join
+        exit
+      end
+    end
+
+    def handle_quit_signal
+      Signal.trap('QUIT') do
+        Thread.new { stop }.join
+      end
+    end
+
+    def set_process_title
+      $0 = name
+    end
+
+    def detach
+      Process.detach pid
+    end
+
+    def pid_file
+      @pid_file ||= PidFile.new File.join(Dir.tmpdir, format('%s.pid', Process.pid))
+    end
+
+    def with_pid_file
+      pid_file.create Process.pid
+      yield
+      pid_file.delete pid_file
+    end
+  end
+end

data/lib/assistor/assistant_group.rb

@@ -0,0 +1,50 @@
+module Assistor
+  class AssistantGroup
+    attr_reader :size
+
+    def initialize(size)
+      @size = size
+      @assistants = []
+    end
+
+    def add(assistant)
+      @assistants << assistant
+    end
+
+    def flush
+      @assistants.delete_if { |assistant| !assistant.assists? }
+    end
+
+    def filled?
+      @assistants.size >= size
+    end
+
+    def wait
+      @assistants.each do |assistant|
+        begin
+          Process.wait(assistant.pid)
+        rescue Errno::ECHILD
+          next
+        end
+      end
+    end
+
+    def stop
+      @assistants.each do |assistant|
+        begin
+          Process.kill(:INT, assistant.pid)
+        rescue Errno::ESRCH
+          next
+        end
+      end
+    end
+
+    def increase
+      @size += 1
+    end
+
+    def decrease
+      @size -= 1
+    end
+  end
+end

data/lib/assistor/configuration.rb

@@ -0,0 +1,14 @@
+module Assistor
+  class Configuration
+    attr_accessor :id, :size, :delay
+    attr_reader :log_file, :pid_file
+
+    def log_file=(file)
+      @log_file = LogFile.new file
+    end
+
+    def pid_file=(file)
+      @pid_file = PidFile.new file
+    end
+  end
+end

data/lib/assistor/daemon.rb

@@ -0,0 +1,126 @@
+module Assistor
+  class Daemon
+    extend Forwardable
+
+    def_delegators :@configuration, :id, :size, :delay, :log_file, :pid_file
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def name
+      [:assistor, id].join ':'
+    end
+
+    def run(queue)
+      start
+      loop do
+        sleep(delay) unless assist(queue)
+      end
+      stop
+    rescue => e
+      log_file.error e
+    end
+
+    private
+
+    def start
+      daemonize
+      log_file.reopen
+      handle_signals
+      set_process_title
+      pid_file.create pid
+    end
+
+    def stop
+      assistant_group.wait
+      assistant_group.flush
+      pid_file.delete
+      exit!(0)
+    rescue => e
+      log_file.error e
+    end
+
+    def stop!
+      assistant_group.stop
+      assistant_group.flush
+      pid_file.delete
+      exit!(1)
+    rescue => e
+      log_file.error e
+    end
+
+    def assist(queue)
+      assistant_group.flush
+      return if assistant_group.filled?
+      return unless job = queue.pop
+
+      assistant = Assistant.new(@configuration, job)
+      assistant.assist
+
+      assistant_group.add(assistant)
+    rescue => e
+      log_file.error e
+    end
+
+    def daemonize
+      Process.daemon(true, true)
+    end
+
+    def increase
+      assistant_group.increase
+    end
+
+    def decrease
+      assistant_group.decrease
+    end
+
+    def set_process_title
+      $0 = name
+    end
+
+    def pid
+      @pid ||= Process.pid
+    end
+
+    def handle_signals
+      handle_term_signal
+      handle_int_signal
+      handle_quit_signal
+      handle_usr1_signal
+      handle_usr2_signal
+    end
+
+    def handle_term_signal
+      Signal.trap('TERM') do
+        Thread.new { stop! }.join
+        exit
+      end
+    end
+
+    def handle_int_signal
+      Signal.trap('INT') do
+        Thread.new { stop! }.join
+        exit
+      end
+    end
+
+    def handle_quit_signal
+      Signal.trap('QUIT') do
+        Thread.new { stop }.join
+      end
+    end
+
+    def handle_usr1_signal
+      Signal.trap('USR1') { increase }
+    end
+
+    def handle_usr2_signal
+      Signal.trap('USR2') { decrease }
+    end
+
+    def assistant_group
+      @assistant_group ||= AssistantGroup.new(size)
+    end
+  end
+end

data/lib/assistor/log_file.rb

@@ -0,0 +1,18 @@
+module Assistor
+  class LogFile
+    extend Forwardable
+
+    def_delegators :@logger, :debug, :error, :fatal, :info, :unknown, :warn
+
+    def initialize(log_file)
+      @log_file = log_file
+      @logger = Logger.new(log_file)
+    end
+
+    def reopen
+      $stderr.reopen @log_file, 'a+'
+      $stdout.reopen $stderr
+      $stdout.sync = $stderr.sync = true
+    end
+  end
+end

data/lib/assistor/pid_file.rb

@@ -0,0 +1,19 @@
+module Assistor
+  class PidFile
+    def initialize(pid_file)
+      @pid_file = pid_file
+    end
+
+    def create(pid)
+      File.write @pid_file, pid
+    end
+
+    def delete
+      File.delete @pid_file
+    end
+
+    def exist?
+      File.exist? @pid_file
+    end
+  end
+end

data/lib/assistor/version.rb

@@ -0,0 +1,3 @@
+module Assistor
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: assistor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Kowalewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+description: Simple background processing framework for Ruby
+email:
+- me@tkowalewski.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/assistor.rb
+- lib/assistor/abstract_job.rb
+- lib/assistor/abstract_queue.rb
+- lib/assistor/assistant.rb
+- lib/assistor/assistant_group.rb
+- lib/assistor/configuration.rb
+- lib/assistor/daemon.rb
+- lib/assistor/log_file.rb
+- lib/assistor/pid_file.rb
+- lib/assistor/version.rb
+homepage: https://github.com/tkowalewski/assistor
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple background processing framework for Ruby
+test_files: []