zenaton 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db17bf2caf28d2e2c9f8c610e0c882f53543af959af846e63f25dc4b9cf71d88
-  data.tar.gz: 28ae921a4fcfd86ab11c726238db69350341190fae32e897dc1c518562baec64
+  metadata.gz: 8a6590eba29150d752565e62505dbbf6ec2a6a0a66f3867e853d76dd102e0991
+  data.tar.gz: dc34cb351261f71e21c4ee692b11622c794a9827e53b5344ed1b1728b1cfd046
 SHA512:
-  metadata.gz: 5974cd83124ff35a036dce13e4800095f2a3c37923a6c568b5315140f44fb62390858545403ed52873a29ff432b7e785ed20c80c29e5fe467b75274ae40745ac
-  data.tar.gz: 548fc102b9aa3861efa4cb538845589f02ab32baefabd7821201cdb2992b01cbb07b90a75294a04032c036a70db2d06477880bb7a6f579ec228574607d893abe
+  metadata.gz: 71b975257fc54acf682d52c4b5fc4be318c7bd50f5b1dd81045277021d2f3d8a9eaf53c7822157d9decee33f0f8049d57d29ad7cdc6f3e2219d45fe1fd2a8540
+  data.tar.gz: 92fee9e3987c2e13f36f75cf68dbe6aa8995e608825732f8091a5e04ed1341e022b12b8808f0fc51c96908ea680eacfbc62f36ddda1483962a3eac948dd517c0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zenaton (0.2.0)
+    zenaton (0.2.1)
       activesupport
       httparty
       tzinfo-data
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -26,7 +26,7 @@ GEM
     hashdiff (0.3.7)
     httparty (0.16.2)
       multi_xml (>= 0.5.2)
-    i18n (1.0.1)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     json (2.1.0)

data/README.md

@@ -27,9 +27,9 @@ Or install it yourself as:
 
     $ gem install zenaton
 
-## Usage
+## Usage in plain Ruby
 
-For more detailed examples, please check [Zenaton Ruby examples](https://github.com/zenaton/example-ruby).
+For more detailed examples, please check [Zenaton Ruby examples](https://github.com/zenaton/examples-ruby).
 
 ### Client Initialization
 
@@ -93,6 +93,78 @@ that you can start and configure with
 
 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 inside a Ruby on Rails application
+
+### Client initialization
+
+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
+```
+
+Then create an initializer in `config/initializers/zenaton.rb` with the
+following:
+```ruby
+Zenaton::Client.init(
+  Rails.application.credentials.zenaton[:app_id],
+  Rails.application.credentials.zenaton[:api_token],
+  Rails.env.production? ? 'production' : 'dev'
+)
+```
+
+### Writing Workflows and Tasks
+
+We can create a workflow in `app/workflows/my_workflow.rb`.
+
+```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).
+
+And we can create a task in `app/tasks/my_task.rb`.
+```ruby
+class MyTask < Zenaton::Interfaces::Task
+  include Zenatonable
+
+  def handle
+    # Your task implementation
+  end
+end
+```
+
+### Lauching a workflow
+
+We can start a workflow from anywhere in our application code with:
+```ruby
+MyWorkflow.new.dispatch
+```
+
+### 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.
+
 ## Documentation
 
 Please see https://zenaton.com/documentation for complete documentation.

data/lib/zenaton/services/properties.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 require 'singleton'
+require 'json/add/core'
+require 'json/add/rational'
+require 'json/add/complex'
+require 'json/add/bigdecimal'
+require 'json/add/ostruct'
 
 module Zenaton
   module Services
@@ -8,15 +13,36 @@ module Zenaton
     # to create new objects with a given set of instance variables.
     class Properties
       # Handle (de)serializaton separately for these classes.
-      SPECIAL_CASES = [Time, Date, DateTime].freeze
+      SPECIAL_CASES = [
+        ::Complex,
+        ::Date,
+        ::DateTime,
+        ::Range,
+        ::Rational,
+        ::Regexp,
+        ::Symbol,
+        ::Time,
+        defined?(::OpenStruct) ? ::OpenStruct : nil,
+        defined?(::BigDecimal) ? ::BigDecimal : nil
+      ].compact.freeze
+
+      NUMERIC_INITIALIATION = [
+        ::Rational,
+        ::Complex,
+        defined?(::BigDecimal) ? ::BigDecimal : nil
+      ].compact.freeze
 
       # Returns an allocated instance of the given class name
       # @param class_name [String] the name of the class to allocate
       # @return [Object]
       def blank_instance(class_name)
         klass = Object.const_get(class_name)
-        if klass < Singleton
+        if klass < ::Singleton
           klass.instance
+        elsif NUMERIC_INITIALIATION.include?(klass)
+          Kernel.send(klass.to_s, 1, 1)
+        elsif klass == Symbol
+          :place_holder
         else
           klass.allocate
         end
@@ -70,72 +96,20 @@ module Zenaton
       end
 
       def from_complex_type(object)
-        case object.class.name
-        when 'Time'
-          from_time(object)
-        when 'Date'
-          from_date(object)
-        when 'DateTime'
-          from_date_time(object)
+        JSON.parse(object.to_json).tap do |attributes|
+          attributes.delete('json_class')
         end
       end
 
-      def from_time(object)
-        nanoseconds = [object.tv_usec * 1_000]
-        object.respond_to?(:tv_nsec) && nanoseconds << object.tv_nsec
-        { 's' => object.tv_sec, 'n' => nanoseconds.max }
-      end
-
-      def from_date(object)
-        { 'y' => object.year, 'm' => object.month,
-          'd' => object.day, 'sg' => object.start }
-      end
-
-      def from_date_time(object)
-        {
-          'y' => object.year, 'm' => object.month, 'd' => object.day,
-          'H' => object.hour, 'M' => object.minute, 'S' => object.sec,
-          'of' => object.offset.to_s, 'sg' => object.start
-        }
-      end
-
       def set_complex_type(object, props)
-        case object.class.name
-        when 'Time'
-          return_time(object, props)
-        when 'Date'
-          return_date(props)
-        when 'DateTime'
-          return_date_time(props)
-        end
-      end
-
-      def return_time(object, props)
-        if object.respond_to?(:tv_usec)
-          Time.at(props['s'], Rational(props['n'], 1000))
-        else
-          Time.at(props['s'], props['n'] / 1000)
-        end
-      end
-
-      def return_date(props)
-        Date.civil(*props.values_at('y', 'm', 'd', 'sg'))
-      end
-
-      def return_date_time(props)
-        args = props.values_at('y', 'm', 'd', 'H', 'M', 'S')
-        of_a, of_b = props['of'].split('/')
-        args << if of_b && of_b != 0
-                  Rational(of_a.to_i, of_b.to_i)
-                else
-                  of_a
-                end
-        args << props['sg']
-        DateTime.civil(*args) # rubocop:disable Style/DateTime
+        props['json_class'] = object.class.name
+        JSON(props.to_json)
       end
 
       def special_case?(object)
-        SPECIAL_CASES.include?(object.class)
+        SPECIAL_CASES.include?(object.class) \
+          || object.is_a?(Struct) \
+          || object.is_a?(Exception)
       end
     end
   end

data/lib/zenaton/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenaton
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Zenaton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport