qyu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9b20d25c456278bced692a847ebacc7f6d47793b84dd4aea02df255ddb441b3
+  data.tar.gz: 00006250c1b37a994c7cbe344fe786a7487c35495538d661506cac37e2e3eba1
+SHA512:
+  metadata.gz: a9752fc4799da6be2ce17a797a7621019fe4fc39da356f39861fbbf069f3785708ba702030ab8c4c3c58ac08398b7e66086da278031bcbc7ef2fde90850a0066
+  data.tar.gz: 1234718f10d09022557ffb1b939a4976b43ea51e1ecf941adb981f658d61c1427edffd8582e47fdd8bf94c220df07c1754b24f80f9cfa4c003015bf37054040a

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec failure tracking
+.rspec_status
+
+# byebug history
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

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 oss@findhotel.net. 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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in qyu.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 FindHotel B.V.
+
+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,90 @@
+# Qyu 九
+
+[![Gem Version](https://img.shields.io/gem/v/qyu.svg)](https://rubygems.org/gems/qyu)
+[![Build Status](https://travis-ci.org/FindHotel/qyu.svg)](https://travis-ci.org/FindHotel/qyu)
+
+## Requirements:
+* Ruby 2.4.0 or newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qyu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qyu
+
+## Configuration
+To start using Qyu; you need a queue configuration and a state store configuration. Here's an example:
+```ruby
+Qyu.configure(
+  queue: {
+    type: :memory
+  },
+  store: {
+    type: :memory,
+    lease_period: 60
+  },
+  # optional Defaults to STDOUT
+  logger: Logger.new(STDOUT)
+)
+```
+
+## Usage
+TODO: Write usage instructions here
+
+## Plugins
+The memory queue and store is just for testing purposes. For production; use one of the following:
+
+#### Stores
+*ActiveRecord:* https://github.com/FindHotel/qyu-store-activerecord    
+*Redis:* https://github.com/FindHotel/qyu-store-redis
+
+#### Queues
+*Amazon SQS:* https://github.com/FindHotel/qyu-queue-sqs    
+*Redis:* https://github.com/FindHotel/qyu-queue-redis
+
+## Glossary
+
+#### Workflow
+The workflow specifies the entry points (`starts`), the tasks, their order, eventual dependencies between them, and synchronisation conditions.
+
+#### Job
+A job is essentially a collection of tasks and an initial JSON payload.
+
+#### Task
+A task is one unit of work. It is an instance of an entry from a workflow. You can think of it as the workflow's entries define the classes, while a task is a materialised instance of it, saved in the state store and enqueued on the message queue.
+
+In the state store a task has:
+* `id`
+* `name` - it appears as the key in the workflow's `tasks`
+* `queue_name` - the queue where the task was enqueued on creation
+* `payload` - the entry/input parameters for the particular task
+* `parent_task_id` - the ID of the task which created/enqueued the current task
+
+When a task is created (saved & enqueued) then its `id` is put in a JSON message `{  task_id: task.id}` and enqueued on the specified task's message queue.
+When a worker picks up the message from the queue, decodes the task id, and retrieves it from the state store.
+
+#### Worker
+A worker is sitting on a queue, waiting for something.
+
+#### Sync Worker
+A worker waiting for other workers to finish
+
+## 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/FindHotel/qyu.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qyu"
+
+# 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/server

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'qyu'
+require 'qyu/ui'
+
+queue_configuration = {
+  type: :memory
+}
+
+store_configuration = {
+  type: :memory
+}
+
+Qyu.config = Qyu::Config.new(queue: queue_configuration, store: store_configuration)
+Qyu::UI.run!

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/examples/bin/simple

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../simple/create_workflow'
+require_relative '../simple/enqueue_job'
+require_relative '../simple/worker'
+
+SimpleWorker.new.run

data/examples/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+
+require 'qyu'
+logger = Logger.new(STDOUT)
+logger.level = :info
+
+Qyu.configure(
+  queue: {
+    type: :memory
+  },
+  store: {
+    type: :memory,
+    lease_period: 60
+  },
+  logger: logger
+)
+
+Qyu.test_connections

data/examples/simple/create_workflow.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../config'
+
+descriptor = {
+  'starts' => %w(
+    print_hello
+  ),
+  'tasks' => {
+    'print_hello' => {
+      'queue' => 'print-hello'
+    }
+  }
+}
+
+name = 'say-hello'
+Qyu.logger.info "Creating workflow #{name}"
+Qyu::Workflow.create(name: name, descriptor: descriptor)

data/examples/simple/enqueue_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../config'
+
+payload = { 'times' => 5 }
+Qyu.logger.info "Enqueuing job with payload #{payload}"
+job = Qyu::Job.create(workflow: 'say-hello', payload: payload)
+job.start

data/examples/simple/worker.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../config'
+
+class SimpleWorker
+  def initialize
+    @worker = Qyu::Worker.new do
+      callback :execute, :before do
+        Qyu.logger.info 'Waiting for task..'
+      end
+
+      callback :execute, :after do
+        Qyu.logger.info 'Done'
+      end
+
+      # Payload validation
+      validates :times, presence: true, type: :integer
+    end
+  end
+
+  def run
+    # Consumes message from print-hello queue
+    @worker.work('print-hello') do |task|
+      task.payload['times'].times do |i|
+        Qyu.logger.info "#{i + 1}. Hello"
+      end
+    rescue StandardError => ex
+      Qyu.logger.error 'OMG :('
+      Qyu.logger.error ex.message
+    end
+  end
+end

data/lib/qyu.rb

@@ -0,0 +1,74 @@
+require 'active_support'
+require 'json'
+require 'logger'
+require 'time'
+require 'securerandom'
+require 'qyu/version'
+require 'qyu/config'
+require 'qyu/factory'
+require 'qyu/utils'
+require 'qyu/errors'
+require 'qyu/models'
+require 'qyu/queue'
+require 'qyu/store'
+require 'qyu/workers'
+
+module Qyu
+  class << self
+    def configure(queue:, store:, logger: nil)
+      self.config = Qyu::Config.new(
+        queue: queue,
+        store: store
+      )
+      self.logger = logger || default_logger unless defined?(@@__logger)
+      self.test_connections
+    end
+
+    def config
+      fail 'Undefined configuration' unless defined?(@@__config)
+
+      @@__config
+    end
+    alias configuration config
+
+    def configured?
+      defined?(@@__config)
+    end
+
+    def logger=(logger)
+      @@__logger = logger
+    end
+
+    def logger
+      @@__logger ||= default_logger
+    end
+
+    def queue
+      @@__queue ||= Qyu::Factory::QueueFactory.get(config.queue)
+    end
+
+    def store
+      @@__store ||= Qyu::Factory::StoreFactory.get(config.store)
+    end
+
+    def test_connections
+      queue
+      store
+    end
+
+    private
+
+    def config=(config)
+      fail 'Can not re-define configuration' if configured?
+      fail 'Invalid configuration' unless config.is_a?(Qyu::Config)
+
+      @@__config = config
+    end
+
+    def default_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::DEBUG
+      logger
+    end
+  end
+end