zenaton/zenaton-ruby

💎 Ruby gem to run and orchestrate background jobs with Zenaton Workflow Engine

⚠️ This repository is abandoned.

Easy Asynchronous Jobs Manager for Developers
Explore the docs »
Website · Examples in Ruby · Tutorial in Ruby

Table of contents

• Getting Started
  • Requirements
  • Installation
• Setup with Ruby on Rails
  • Client initialization
  • Worker Installation
• Setup with plain Ruby
  • Client Initialization
  • Worker Installation
• Usage
  • Writing a task
  • Writing a workflow
  • Lauching a workflow
• Documentation
• Development
• Contributing
• License
• Code of Conduct

Getting Started

Requirements

This gem has been tested with Ruby 2.3 and later.

Installation

Add this line to your application's Gemfile:

gem 'zenaton'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zenaton

Setup with Ruby on Rails

Client initialization

1. Create an initializer in config/initializers/zenaton.rb with the following:

Zenaton::Client.init(
  ENV['ZENATON_APP_ID'],
  ENV['ZENATON_API_TOKEN'],
  ENV['ZENATON_APP_ENV']
)

2. Add a .env file at the root of your project with your credentials:

ZENATON_API_URL=...
ZENATON_APP_ID=...
ZENATON_API_TOKEN=...

Don't forget to add it to your .gitignore:

$ echo ".env" >> .gitignore

3. Add the dotenv gem to your Gemfile to easily load these variables in development:

gem 'dotenv-rails', groups: [:development, :test]

Worker Installation

Your workflow's tasks will be executed on your worker servers. Please install a Zenaton worker on it:

$ curl https://install.zenaton.com | sh

that you can start and configure from your application directory with

$ zenaton start && zenaton listen --env=.env --rails

where .env is the env file containing your credentials.

Note In this example we created our workflows and tasks in the /app folder since Rails will autoload ruby files in that path. If you create your workflows and tasks somewhere else, ensure Rails loads them at boot time.

Your are now ready to write tasks and workflows !

Setup with plain Ruby

Client Initialization

You will need to export three environment variables: ZENATON_APP_ID, ZENATON_API_TOKEN, ZENATON_APP_ENV. You'll find them here.

Then you can initialize your Zenaton client:

require 'dotenv/load'
require 'zenaton'

Zenaton::Client.init(
  ENV['ZENATON_APP_ID'],
  ENV['ZENATON_API_TOKEN'],
  ENV['ZENATON_APP_ENV']
)

Worker Installation

Your workflow's tasks will be executed on your worker servers. Please install a Zenaton worker on it:

$ curl https://install.zenaton.com | sh

that you can start and configure with

$ zenaton start && zenaton listen --env=.env --boot=boot.rb

where .env is the env file containing your credentials, and boot.rb is a file that will be included before each task execution - this file should load all workflow classes.

Usage

For more detailed examples, please check Zenaton Ruby examples.

Writing a task

class MyTask < Zenaton::Interfaces::Task
  include Zenaton::Traits::Zenatonable

  def handle
    # Your task implementation
  end
end

Check the documentation for more details.

Writing a workflow

class MyWorkflow < Zenaton::Interfaces::Workflow
  include Zenaton::Traits::Zenatonable

  def handle
    # Your workflow implementation
  end
end

Note that your workflow implementation should be idempotent.

With Ruby on Rails, you may need to run $ spring stop to force Spring to load your app fresh.

Check the documentation for more details.

Lauching a workflow

We can start a workflow from anywhere in our application code with:

MyWorkflow.new.dispatch

Documentation

Please see https://zenaton.com/documentation/ruby/getting-started for complete documentation.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/zenaton/zenaton-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the zenaton-ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.