beez 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/beez.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/beez/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "beez"
+  spec.version       = Beez::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierrelouis.gottfrois@gmail.com"]
+
+  spec.summary       = %q{Simple, efficient ruby workers for Zeebe business processes.}
+  spec.description   = %q{Simple, efficient ruby workers for Zeebe business processes.}
+  spec.homepage      = "https://github.com/gottfrois/beez"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gottfrois/beez"
+  spec.metadata["changelog_uri"] = "https://github.com/gottfrois/beez/CHANGELOG.md"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "zeebe-client", "~> 0.7"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "beez"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bpmn/order-process.bpmn

@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:zeebe="http://camunda.org/schema/zeebe/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_0roiw93" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Zeebe Modeler" exporterVersion="0.9.1">
+  <bpmn:process id="order-process" isExecutable="true">
+    <bpmn:startEvent id="StartEvent_1" name="Order Placed">
+      <bpmn:outgoing>SequenceFlow_0l1itgv</bpmn:outgoing>
+    </bpmn:startEvent>
+    <bpmn:serviceTask id="ServiceTask_1uaxkgt" name="Initiate Payment">
+      <bpmn:extensionElements>
+        <zeebe:taskDefinition type="initiate-payment" />
+      </bpmn:extensionElements>
+      <bpmn:incoming>SequenceFlow_0l1itgv</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_05wimmt</bpmn:outgoing>
+    </bpmn:serviceTask>
+    <bpmn:sequenceFlow id="SequenceFlow_0l1itgv" sourceRef="StartEvent_1" targetRef="ServiceTask_1uaxkgt" />
+    <bpmn:intermediateCatchEvent id="IntermediateCatchEvent_178qswy" name="Payment Received">
+      <bpmn:incoming>SequenceFlow_05wimmt</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_0sdhelb</bpmn:outgoing>
+      <bpmn:messageEventDefinition messageRef="Message_1jdabrh" />
+    </bpmn:intermediateCatchEvent>
+    <bpmn:sequenceFlow id="SequenceFlow_05wimmt" sourceRef="ServiceTask_1uaxkgt" targetRef="IntermediateCatchEvent_178qswy" />
+    <bpmn:exclusiveGateway id="ExclusiveGateway_0xtem5z" name="Order Value?" default="SequenceFlow_1of2ef2">
+      <bpmn:incoming>SequenceFlow_0sdhelb</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_1of2ef2</bpmn:outgoing>
+      <bpmn:outgoing>SequenceFlow_1qfaoce</bpmn:outgoing>
+    </bpmn:exclusiveGateway>
+    <bpmn:sequenceFlow id="SequenceFlow_0sdhelb" sourceRef="IntermediateCatchEvent_178qswy" targetRef="ExclusiveGateway_0xtem5z" />
+    <bpmn:serviceTask id="ServiceTask_0ms04gz" name="Ship Without Insurance">
+      <bpmn:extensionElements>
+        <zeebe:taskDefinition type="ship-without-insurance" />
+      </bpmn:extensionElements>
+      <bpmn:incoming>SequenceFlow_1of2ef2</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_1pxhmpe</bpmn:outgoing>
+    </bpmn:serviceTask>
+    <bpmn:sequenceFlow id="SequenceFlow_1of2ef2" sourceRef="ExclusiveGateway_0xtem5z" targetRef="ServiceTask_0ms04gz" />
+    <bpmn:serviceTask id="ServiceTask_0tw27bj" name="Ship With Insurance">
+      <bpmn:extensionElements>
+        <zeebe:taskDefinition type="ship-with-insurance" />
+      </bpmn:extensionElements>
+      <bpmn:incoming>SequenceFlow_1qfaoce</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_0dvg03l</bpmn:outgoing>
+    </bpmn:serviceTask>
+    <bpmn:sequenceFlow id="SequenceFlow_1qfaoce" name="&#62;$100" sourceRef="ExclusiveGateway_0xtem5z" targetRef="ServiceTask_0tw27bj">
+      <bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">=orderValue &gt;= 100</bpmn:conditionExpression>
+    </bpmn:sequenceFlow>
+    <bpmn:exclusiveGateway id="ExclusiveGateway_0y9y7j8">
+      <bpmn:incoming>SequenceFlow_1pxhmpe</bpmn:incoming>
+      <bpmn:incoming>SequenceFlow_0dvg03l</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_0p15rvb</bpmn:outgoing>
+    </bpmn:exclusiveGateway>
+    <bpmn:sequenceFlow id="SequenceFlow_1pxhmpe" sourceRef="ServiceTask_0ms04gz" targetRef="ExclusiveGateway_0y9y7j8" />
+    <bpmn:sequenceFlow id="SequenceFlow_0dvg03l" sourceRef="ServiceTask_0tw27bj" targetRef="ExclusiveGateway_0y9y7j8" />
+    <bpmn:endEvent id="EndEvent_146mj14" name="Order Fulfilled">
+      <bpmn:incoming>SequenceFlow_0p15rvb</bpmn:incoming>
+    </bpmn:endEvent>
+    <bpmn:sequenceFlow id="SequenceFlow_0p15rvb" sourceRef="ExclusiveGateway_0y9y7j8" targetRef="EndEvent_146mj14" />
+  </bpmn:process>
+  <bpmn:message id="Message_1jdabrh" name="payment-received">
+    <bpmn:extensionElements>
+      <zeebe:subscription correlationKey="=orderId" />
+    </bpmn:extensionElements>
+  </bpmn:message>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="order-process">
+      <bpmndi:BPMNEdge id="SequenceFlow_0p15rvb_di" bpmnElement="SequenceFlow_0p15rvb">
+        <di:waypoint x="801" y="121" />
+        <di:waypoint x="851" y="121" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_0dvg03l_di" bpmnElement="SequenceFlow_0dvg03l">
+        <di:waypoint x="701" y="231" />
+        <di:waypoint x="776" y="231" />
+        <di:waypoint x="776" y="146" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_1pxhmpe_di" bpmnElement="SequenceFlow_1pxhmpe">
+        <di:waypoint x="701" y="121" />
+        <di:waypoint x="751" y="121" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_1qfaoce_di" bpmnElement="SequenceFlow_1qfaoce">
+        <di:waypoint x="526" y="146" />
+        <di:waypoint x="526" y="231" />
+        <di:waypoint x="601" y="231" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="543" y="210" width="31" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_1of2ef2_di" bpmnElement="SequenceFlow_1of2ef2">
+        <di:waypoint x="551" y="121" />
+        <di:waypoint x="601" y="121" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_0sdhelb_di" bpmnElement="SequenceFlow_0sdhelb">
+        <di:waypoint x="451" y="121" />
+        <di:waypoint x="501" y="121" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_05wimmt_di" bpmnElement="SequenceFlow_05wimmt">
+        <di:waypoint x="365" y="121" />
+        <di:waypoint x="415" y="121" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="SequenceFlow_0l1itgv_di" bpmnElement="SequenceFlow_0l1itgv">
+        <di:waypoint x="215" y="121" />
+        <di:waypoint x="265" y="121" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
+        <dc:Bounds x="179" y="103" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="165" y="146" width="65" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="ServiceTask_1uaxkgt_di" bpmnElement="ServiceTask_1uaxkgt">
+        <dc:Bounds x="265" y="81" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="IntermediateCatchEvent_178qswy_di" bpmnElement="IntermediateCatchEvent_178qswy">
+        <dc:Bounds x="415" y="103" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="410" y="146" width="46" height="27" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="ExclusiveGateway_0xtem5z_di" bpmnElement="ExclusiveGateway_0xtem5z" isMarkerVisible="true">
+        <dc:Bounds x="501" y="96" width="50" height="50" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="493" y="72" width="65" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="ServiceTask_0ms04gz_di" bpmnElement="ServiceTask_0ms04gz">
+        <dc:Bounds x="601" y="81" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="ServiceTask_0tw27bj_di" bpmnElement="ServiceTask_0tw27bj">
+        <dc:Bounds x="601" y="191" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="ExclusiveGateway_0y9y7j8_di" bpmnElement="ExclusiveGateway_0y9y7j8" isMarkerVisible="true">
+        <dc:Bounds x="751" y="96" width="50" height="50" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="EndEvent_146mj14_di" bpmnElement="EndEvent_146mj14">
+        <dc:Bounds x="851" y="103" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="834" y="146" width="70" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

data/examples/workers.rb

@@ -0,0 +1,49 @@
+require "beez"
+
+module Workers
+  class InitiatePaymentWorker
+    include ::Beez::Worker
+
+    type "initiate-payment"
+    max_jobs_to_activate 5
+    poll_interval 1
+    timeout 30
+
+    def process(job)
+      rand(35).times do |i|
+        logger.info "Processing job #{job.type} #{job.key} by waiting #{i}s"
+        sleep 1
+      end
+    end
+  end
+
+  class ShipWithInsuranceWorker
+    include ::Beez::Worker
+
+    type "ship-with-insurance"
+    max_jobs_to_activate 5
+    poll_interval 1
+
+    def process(job)
+      rand(35).times do |i|
+        logger.info "Processing job #{job.type} #{job.key} by waiting #{i}s"
+        sleep 1
+      end
+    end
+  end
+
+  class ShipWithoutInsuranceWorker
+    include ::Beez::Worker
+
+    type "ship-without-insurance"
+    max_jobs_to_activate 5
+    poll_interval 1
+
+    def process(job)
+      rand(35).times do |i|
+        logger.info "Processing job #{job.type} #{job.key} by waiting #{i}s"
+        sleep 1
+      end
+    end
+  end
+end

data/exe/beez

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "beez/cli"
+
+begin
+  cli = ::Beez::CLI.instance
+  cli.parse
+  cli.run
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/lib/beez.rb

@@ -0,0 +1,26 @@
+require 'concurrent'
+
+require 'beez/configurable'
+require 'beez/Loggable'
+require 'beez/client'
+require 'beez/worker'
+require 'beez/version'
+
+module Beez
+  extend ::Beez::Configurable
+  extend ::Beez::Loggable
+
+  # class Error < StandardError; end
+
+  def self.register_worker(worker)
+    self.workers << worker
+  end
+
+  def self.workers
+    @workers ||= []
+  end
+
+  def self.client
+    @client ||= ::Beez::Client.new
+  end
+end

data/lib/beez/cli.rb

@@ -0,0 +1,143 @@
+require 'singleton'
+require 'optparse'
+require 'fileutils'
+require 'beez'
+require 'beez/launcher'
+
+$stdout.sync = true
+
+module Beez
+  class CLI
+    include Singleton
+
+    attr_accessor :launcher
+
+    def parse(argv = ARGV)
+      parse_options(argv)
+    end
+
+    def run
+      boot
+
+      self_read, self_write = IO.pipe
+      sigs = %w[INT TERM]
+      sigs.each do |sig|
+        trap sig do
+          self_write.write("#{sig}\n")
+        end
+      rescue ArgumentError
+        logger.warn "Signal #{sig} not supported"
+      end
+
+      launch(self_read)
+    end
+
+    private
+
+    def parse_options(argv)
+      option_parser.parse!(argv)
+    end
+
+    def option_parser
+      OptionParser.new.tap do |p|
+        p.on "-e", "--env ENV", "Application environment" do |arg|
+          config.env = arg
+        end
+
+        p.on "-r", "--require [PATH|DIR]", "Location of Rails application with workers or file to require" do |arg|
+          if !File.exist?(arg) ||
+              (File.directory?(arg) && !File.exist?("#{arg}/config/application.rb"))
+            raise ArgumentError, "#{arg} is not a ruby file nor a rails application"
+          else
+            config.require = arg
+          end
+        end
+
+        p.on "-t", "--timeout NUM", "Shutdown timeout" do |arg|
+          timeout = Integer(arg)
+          raise ArgumentError, "timeout must be a positive integer" if timeout <= 0
+          config.timeout = timeout
+        end
+
+        p.on "-v", "--verbose", "Print more verbose output" do |arg|
+          ::Beez.logger.level = ::Logger::DEBUG
+        end
+
+        p.on "-V", "--version", "Print version and exit" do |arg|
+          puts "Beez #{::Beez::VERSION}"
+          exit(0)
+        end
+
+        p.banner = "Usage: beez [options]"
+        p.on_tail "-h", "--help", "Show help" do
+          puts p
+
+          exit(1)
+        end
+      end
+    end
+
+    def boot
+      ENV["RACK_ENV"] = ENV["RAILS_ENV"] = config.env
+
+      if File.directory?(config.require)
+        require 'rails'
+        if ::Rails::VERSION::MAJOR < 4
+          raise "Beez does not supports this version of Rails"
+        else
+          require File.expand_path("#{config.require}/config/environment.rb")
+          logger.info "Booted Rails #{::Rails.version} application in #{config.env} environment"
+        end
+      else
+        require config.require
+      end
+    end
+
+    def launch(self_read)
+      @launcher = ::Beez::Launcher.new
+
+      if config.env == "development" && $stdout.tty?
+        logger.info "Starting processing, hit Ctrl-C to stop"
+      end
+
+      begin
+        launcher.start
+
+        while readable_io = IO.select([self_read])
+          signal = readable_io.first[0].gets.strip
+          handle_signal(signal)
+        end
+      rescue Interrupt
+        logger.info "Shutting down"
+        launcher.stop
+        logger.info "Bye!"
+
+        exit(0)
+      end
+    end
+
+    def handle_signal(signal)
+      handler = signal_handlers[signal]
+      if handler
+        handler.call(self)
+      else
+        logger.warn "No signal handler for #{signal}"
+      end
+    end
+
+    def signal_handlers
+      {
+        "INT" => ->(cli) { raise Interrupt },
+        "TERM" => ->(cli) { raise Interrupt },
+      }
+    end
+
+    def config
+      ::Beez.config
+    end
+
+    def logger
+      ::Beez.logger
+    end
+  end
+end

data/lib/beez/client.rb

@@ -0,0 +1,97 @@
+require 'zeebe/client'
+
+module Beez
+  class Client
+
+    attr_reader :client
+
+    def initialize(url: ::Beez.config.zeebe_url, opts: :this_channel_is_insecure)
+      @client = ::Zeebe::Client::GatewayProtocol::Gateway::Stub.new(url, opts)
+    end
+
+    def activate_jobs(params = {})
+      run(:activate_jobs,
+        ::Zeebe::Client::GatewayProtocol::ActivateJobsRequest.new(params)
+      )
+    end
+
+    def cancel_workflow_instance(params = {})
+      run(:cancel_workflow_instance,
+        ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceRequest.new(params)
+      )
+    end
+
+    def complete_job(params = {})
+      run(:complete_job,
+        ::Zeebe::Client::GatewayProtocol::CompleteJobRequest.new(params)
+      )
+    end
+
+    def create_workflow_instance(params = {})
+      run(:create_workflow_instance,
+        ::Zeebe::Client::GatewayProtocol::CreateWorkflowInstanceRequest.new(params)
+      )
+    end
+
+    def deploy_workflow(params = {})
+      run(:deploy_workflow,
+        ::Zeebe::Client::GatewayProtocol::DeployWorkflowRequest.new(params)
+      )
+    end
+
+    def fail_job(params = {})
+      run(:fail_job,
+        ::Zeebe::Client::GatewayProtocol::FailJobRequest.new(params)
+      )
+    end
+
+    def throw_error(params = {})
+      run(:throw_error,
+        ::Zeebe::Client::GatewayProtocol::ThrowErrorRequest.new(params)
+      )
+    end
+
+    def publish_message(params = {})
+      run(:publish_message,
+        ::Zeebe::Client::GatewayProtocol::PublishMessageRequest.new(params)
+      )
+    end
+
+    def resolve_incident(params = {})
+      run(:resolve_incident,
+        ::Zeebe::Client::GatewayProtocol::ResolveIncidentRequest.new(params)
+      )
+    end
+
+    def set_variables(params = {})
+      run(:set_variables,
+        ::Zeebe::Client::GatewayProtocol::SetVariablesRequest.new(params)
+      )
+    end
+
+    def topology(params = {})
+      run(:topology,
+        ::Zeebe::Client::GatewayProtocol::TopologyRequest.new(params)
+      )
+    end
+
+    def update_job_retries(params = {})
+      run(:update_job_retries,
+        ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesRequest.new(params)
+      )
+    end
+
+    private
+
+    def run(method, params = {})
+      client.public_send(method, params)
+    rescue ::GRPC::Unavailable => exception
+      logger.error exception.message
+      raise exception
+    end
+
+    def logger
+      ::Beez.logger
+    end
+  end
+end