zenaton 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a28c9df01efe5b8a7a242e2d25b12ea713b33895104fc28b61e0359c25a38f60
-  data.tar.gz: a06c860ed8c3c049ab31005369ac84d37d3fe24f3d2cc7501cd4b6314bcfc591
+  metadata.gz: 6e51aae796ecf047bcbc9c4b3b4e4fd971191a1ebee24075b9576df8248c9c3a
+  data.tar.gz: a53ce602e5edeab270bebb30b11d108c568c35e1994002376989d1e9a1ce1f3d
 SHA512:
-  metadata.gz: 15be902a6bcaf15248c3374eb86439f05a59acb0788cadfe05347bbc159925a2cf73596a9d8cd3519e77961789a888ba46cb66df19f69a60a1325999ac531af8
-  data.tar.gz: 8a1f6f4f34b040a7c10c5b2f52d8999389b0cde4b0c100ece7784e9e13c8443e173c90616a66cce1c1431afe1a86b6f36d533c01f8219f688d67edc199cfb44e
+  metadata.gz: 51cef86daef5b85dd46fbc4d98305d58ad277b4ee36360266a66268ecc86a9ec1fd5d3bc1ec0c0e1702af33c1f2998471f80828f52d9e88f5425512d2767d4f5
+  data.tar.gz: 73230ed0fa51c178553ed28a39d24f21841b2f825d558453733de02c71a871a7ca29bfb65bd734f7d0f9db71f4e6035f24f5253bd5eec51f7dfdbd951e0e22a4

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Changes
+
+### Added
+
+## [0.4.1] - 2019-06-04
+ ### Changes
+- Fix symbol json encoding breaking compatibility with some gems
+
+### Added
+- Added `event_data` property when sending event
+
 ## [0.4.0] - 2019-03-25
 ### Added
 - Calling `#dispatch` on tasks now allows to process tasks asynchronously
@@ -73,8 +85,9 @@ available.
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/zenaton/zenaton-ruby/compare/v0.4.0...HEAD
-[0.3.1]: https://github.com/zenaton/zenaton-ruby/compare/v0.3.1...v0.4.0
+[Unreleased]: https://github.com/zenaton/zenaton-ruby/compare/v0.4.1...HEAD
+[0.4.1]: https://github.com/zenaton/zenaton-ruby/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/zenaton/zenaton-ruby/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/zenaton/zenaton-ruby/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/zenaton/zenaton-ruby/compare/v0.2.3...v0.3.0
 [0.2.3]: https://github.com/zenaton/zenaton-ruby/compare/v0.2.2...v0.2.3

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    zenaton (0.4.0)
+    zenaton (0.4.1)
       activesupport
       tzinfo-data
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -17,13 +17,13 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.1)
     hashdiff (0.3.7)
-    i18n (1.1.0)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     json (2.1.0)
@@ -73,7 +73,7 @@ GEM
     timecop (0.9.1)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    tzinfo-data (1.2018.5)
+    tzinfo-data (1.2019.1)
       tzinfo (>= 1.0.0)
     unicode-display_width (1.4.0)
     vcr (4.0.0)
@@ -99,4 +99,4 @@ DEPENDENCIES
   zenaton!
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -1,19 +1,58 @@
-# Zenaton library for Ruby
-[![Gem Version](https://img.shields.io/gem/v/zenaton.svg)](https://rubygems.org/gems/zenaton)
-[![Gem Downloads](https://img.shields.io/gem/dt/zenaton.svg)](https://rubygems.org/gems/zenaton)
-[![CircleCI](https://img.shields.io/circleci/project/github/zenaton/zenaton-ruby/master.svg)](https://circleci.com/gh/zenaton/zenaton-ruby/tree/master)
-[![License](https://img.shields.io/github/license/zenaton/zenaton-ruby.svg)](LICENSE.txt)
-
-This Zenaton library for Ruby lets you code and launch workflows using Zenaton platform. You can sign up for an account at [https://zenaton/com](http://zenaton.com)
-
-**DISCLAIMER** The ruby library is currently in public beta. Please open an
-issue if you find any bugs.
-
-## Requirements
+<p align="center">
+<img src="https://user-images.githubusercontent.com/36400935/58254828-e5176880-7d6b-11e9-9094-3f46d91faeee.png" /><br>
+  Easy Asynchronous Jobs Manager for Developers <br>
+  <a href="https://zenaton.com/documentation/ruby/getting-started/">
+    <strong> Explore the docs » </strong>
+  </a> <br>
+  <a href="https://zenaton.com"> Website </a>
+     ·
+  <a href="https://github.com/zenaton/examples-ruby"> Examples in Ruby </a>
+   ·
+  <a href="https://app.zenaton.com/tutorial/ruby"> Tutorial in Ruby </a>
+
+  <p align="center">
+  <a href="https://rubygems.org/gems/zenaton"><img src="https://img.shields.io/gem/v/zenaton.svg" alt="Gem Version"></a>
+  <a href="https://circleci.com/gh/zenaton/zenaton-ruby/tree/master" rel="nofollow" target="_blank"><img src="https://img.shields.io/circleci/project/github/zenaton/zenaton-ruby/master.svg" alt="CircleCI" style="max-width:100%;"></a>
+  <a href="/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/zenaton/zenaton-ruby.svg" alt="License" style="max-width:100%;"></a>
+</p>
+</p>
+
+<details>
+  <summary><strong>Table of contents</strong></summary>
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Getting Started](#getting-started)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+- [Setup with Ruby on Rails](#setup-with-ruby-on-rails)
+  - [Client initialization](#client-initialization)
+  - [Worker Installation](#worker-installation)
+- [Setup with plain Ruby](#setup-with-plain-ruby)
+  - [Client Initialization](#client-initialization)
+  - [Worker Installation](#worker-installation-1)
+- [Usage](#usage)
+  - [Writing a task](#writing-a-task)
+  - [Writing a workflow](#writing-a-workflow)
+  - [Lauching a workflow](#lauching-a-workflow)
+- [Documentation](#documentation)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+</details>
+
+## Getting Started
+
+### Requirements
 
 This gem has been tested with Ruby 2.3 and later.
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -29,58 +68,38 @@ Or install it yourself as:
 
     $ gem install zenaton
 
-## Usage in plain Ruby
+## Setup with Ruby on Rails
 
-For more detailed examples, please check [Zenaton Ruby examples](https://github.com/zenaton/examples-ruby).
-
-### Client Initialization
+### Client initialization
 
-You will need to export three environment variables: `ZENATON_APP_ID`, `ZENATON_API_TOKEN`, `ZENATON_APP_ENV`. You'll find them [here](https://zenaton/app/api).
+1. Create an initializer in `config/initializers/zenaton.rb` with the following:
 
-Then you can initialize your Zenaton client:
 ```ruby
-require 'dotenv/load' # We are using dotenv to load the variables from a .env file
-require 'zenaton'
-
-app_id = ENV['ZENATON_APP_ID']
-api_token = ENV['ZENATON_API_TOKEN']
-app_env = ENV['ZENATON_APP_ENV']
-
-Zenaton::Client.init(app_id, api_token, app_env)
+Zenaton::Client.init(
+  ENV['ZENATON_APP_ID'],
+  ENV['ZENATON_API_TOKEN'],
+  ENV['ZENATON_APP_ENV']
+)
 ```
 
-### Writing Workflows and Tasks
-
-Writing a workflow is as simple as:
+2. Add a `.env` file at the root of your project with [your credentials](https://app.zenaton.com/api):
 
-```ruby
-class MyWorkflow < Zenaton::Interfaces::Worflow
-  include Zenatonable
-
-  def handle
-    # Your workflow implementation
-  end
-end
 ```
-Note that your workflow implementation should be idempotent. See [documentation](https://zenaton.com/app/documentation#workflow-basics-implementation).
+ZENATON_API_URL=...
+ZENATON_APP_ID=...
+ZENATON_API_TOKEN=...
+```
 
-Writing a task is as simple as:
-```ruby
-class MyTask < Zenaton::Interfaces::Task
-  include Zenatonable
+Don't forget to add it to your `.gitignore`:
 
-  def handle
-    # Your task implementation
-  end
-end
+```bash
+$ echo ".env" >> .gitignore
 ```
 
-### Launching a workflow
-
-Once your Zenaton client is initialized, you can start a workflow with
+3. Add the [dotenv gem](https://github.com/bkeepers/dotenv) to your `Gemfile` to easily load these variables in development:
 
 ```ruby
-MyWorkflow.new.dispatch
+gem 'dotenv-rails', groups: [:development, :test]
 ```
 
 ### Worker Installation
@@ -89,54 +108,58 @@ Your workflow's tasks will be executed on your worker servers. Please install a
 
     $ curl https://install.zenaton.com | sh
 
-that you can start and configure with
+that you can start and configure from your application directory with
 
-    $ zenaton start && zenaton listen --env=.env --boot=boot.rb
+    $ zenaton start && zenaton listen --env=.env --rails
 
-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.
+where `.env` is the env file containing [your credentials](https://app.zenaton.com/api).
 
-## Usage inside a Ruby on Rails application
+**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.
 
-### Client initialization
+Your are now ready to [write tasks and workflows](#usage) !
 
-Edit your application secrets with `rails credentials:edit` and add your Zenaton
-credentials to it (you'll find them [here](https://zenaton/app/api)). For
-example:
-```yml
-zenaton:
-  app_id: 123456
-  api_token: abcdefgh
-```
+## 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](https://app.zenaton.com/api).
+
+Then you can initialize your Zenaton client:
 
-Then create an initializer in `config/initializers/zenaton.rb` with the
-following:
 ```ruby
+require 'dotenv/load'
+require 'zenaton'
+
 Zenaton::Client.init(
-  Rails.application.credentials.zenaton[:app_id],
-  Rails.application.credentials.zenaton[:api_token],
-  Rails.env.production? ? 'production' : 'dev'
+  ENV['ZENATON_APP_ID'],
+  ENV['ZENATON_API_TOKEN'],
+  ENV['ZENATON_APP_ENV']
 )
 ```
 
-### Writing Workflows and Tasks
+### Worker Installation
 
-We can create a workflow in `app/workflows/my_workflow.rb`.
+Your workflow's tasks will be executed on your worker servers. Please install a Zenaton worker on it:
 
-```ruby
-class MyWorkflow < Zenaton::Interfaces::Worflow
-  include Zenatonable
+    $ curl https://install.zenaton.com | sh
 
-  def handle
-    # Your workflow implementation
-  end
-end
-```
-Note that your workflow implementation should be idempotent. See [documentation](https://zenaton.com/app/documentation#workflow-basics-implementation).
+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](https://app.zenaton.com/api), 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](https://github.com/zenaton/examples-ruby).
+
+### Writing a task
 
-And we can create a task in `app/tasks/my_task.rb`.
 ```ruby
 class MyTask < Zenaton::Interfaces::Task
-  include Zenatonable
+  include Zenaton::Traits::Zenatonable
 
   def handle
     # Your task implementation
@@ -144,32 +167,37 @@ class MyTask < Zenaton::Interfaces::Task
 end
 ```
 
-### Lauching a workflow
+[Check the documentation for more details.](https://zenaton.com/documentation/ruby/tasks)
+
+### Writing a workflow
 
-We can start a workflow from anywhere in our application code with:
 ```ruby
-MyWorkflow.new.dispatch
+class MyWorkflow < Zenaton::Interfaces::Workflow
+  include Zenaton::Traits::Zenatonable
+
+  def handle
+    # Your workflow implementation
+  end
+end
 ```
 
-### Worker Installation
+Note that your workflow implementation should be idempotent.
 
-Your workflow's tasks will be executed on your worker servers. Please install a Zenaton worker on it:
+With Ruby on Rails, you may need to run `$ spring stop` to force Spring to load your app fresh.
 
-    $ curl https://install.zenaton.com | sh
+[Check the documentation for more details.](https://zenaton.com/documentation/ruby/workflow-basics)
 
-that you can start and configure from your application directory with
-
-    $ zenaton start && zenaton listen --env=.env --rails
+### Lauching a workflow
 
-where `.env` is the env file containing your credentials.
+We can start a workflow from anywhere in our application code with:
 
-**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.
+```ruby
+MyWorkflow.new.dispatch
+```
 
 ## Documentation
 
-Please see https://zenaton.com/documentation for complete documentation.
+Please see https://zenaton.com/documentation/ruby/getting-started for complete documentation.
 
 ## Development
 

data/lib/zenaton/client.rb

@@ -33,8 +33,9 @@ module Zenaton
 
     PROG = 'Ruby' # The current programming language
 
-    EVENT_INPUT = 'event_input' # Parameter name for event data
+    EVENT_INPUT = 'event_input' # Parameter name for event input
     EVENT_NAME = 'event_name' # Parameter name for event name
+    EVENT_DATA = 'event_data' # Parameter name for event data
 
     WORKFLOW_KILL = 'kill' # Worker update mode to stop a worker
     WORKFLOW_PAUSE = 'pause' # Worker udpate mode to pause a worker
@@ -174,7 +175,8 @@ module Zenaton
         ATTR_NAME => workflow_name,
         ATTR_ID => custom_id,
         EVENT_NAME => event.class.name,
-        EVENT_INPUT => @serializer.encode(@properties.from(event))
+        EVENT_INPUT => @serializer.encode(@properties.from(event)),
+        EVENT_DATA => @serializer.encode(event)
       }
       @http.post(send_event_url, body)
     end

data/lib/zenaton/services/properties.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
 require 'singleton'
-require 'json/add/core'
+require 'json/add/date'
+require 'json/add/date_time'
+require 'json/add/exception'
+require 'json/add/range'
+require 'json/add/regexp'
+require 'json/add/struct'
+require 'json/add/time'
 require 'json/add/rational'
 require 'json/add/complex'
 require 'json/add/bigdecimal'
@@ -97,14 +103,22 @@ module Zenaton
       end
 
       def from_complex_type(object)
-        JSON.parse(object.to_json).tap do |attributes|
-          attributes.delete('json_class')
+        if object.is_a?(Symbol)
+          { 's' => object.to_s }
+        else
+          JSON.parse(object.to_json).tap do |attributes|
+            attributes.delete('json_class')
+          end
         end
       end
 
       def set_complex_type(object, props)
-        props['json_class'] = object.class.name
-        JSON(props.to_json)
+        if object.is_a?(Symbol)
+          props['s'].to_sym
+        else
+          props['json_class'] = object.class.name
+          JSON(props.to_json)
+        end
       end
 
       def special_case?(object)

data/lib/zenaton/version.rb

@@ -2,5 +2,5 @@
 
 module Zenaton
   # This gem's current version
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenaton
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Zenaton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport