zenaton 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d50e2fc00f50096e323f479b78167ea23d4011d10e40c01bfe45396669ad055
-  data.tar.gz: f5a6432736d591d7b5f9e43bb949b9969f269a198a489785d35a09431f1f5671
+  metadata.gz: a28c9df01efe5b8a7a242e2d25b12ea713b33895104fc28b61e0359c25a38f60
+  data.tar.gz: a06c860ed8c3c049ab31005369ac84d37d3fe24f3d2cc7501cd4b6314bcfc591
 SHA512:
-  metadata.gz: 3726c43b970e79f7d3f1ae6eaae62c894b55634658acdfdbeedaac4befec3e5463264f0f111f1673549e936a7344d6fa31b5890ca756609a57eac618d0a68dc4
-  data.tar.gz: 8578394854d77f89fa83d7156e06e16382c26f543ac46475bf98fafa4b0b53ade3915a0d8fb9dbcca160e8fbf9550576760ccd6e903821fa317d4071b3de3aa6
+  metadata.gz: 15be902a6bcaf15248c3374eb86439f05a59acb0788cadfe05347bbc159925a2cf73596a9d8cd3519e77961789a888ba46cb66df19f69a60a1325999ac531af8
+  data.tar.gz: 8a1f6f4f34b040a7c10c5b2f52d8999389b0cde4b0c100ece7784e9e13c8443e173c90616a66cce1c1431afe1a86b6f36d533c01f8219f688d67edc199cfb44e

data/.rubocop.yml

@@ -16,5 +16,10 @@ Metrics/ClassLength:
     - 'lib/zenaton/client.rb'
     - 'lib/zenaton/services/serializer.rb'
 
+Metrics/ModuleLength:
+  Enabled: true
+  Exclude:
+    - 'lib/zenaton/traits/with_timestamp.rb'
+
 Style/NumericLiterals:
   Enabled: false

data/CHANGELOG.md

@@ -4,7 +4,21 @@ 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]
+## [0.4.0] - 2019-03-25
+### Added
+- Calling `#dispatch` on tasks now allows to process tasks asynchronously
+
+### Changes
+- Update Zenaton engine URL to point to the new subdomain.
+
+### Fixed
+- When creating a `Wait` task which uses both `#at` (to specify time) and either
+  `#day_of_month` or `#monday` et al (to set day), it was surprising that the
+  wait task only waited for next week/month when it would make sense to wait for
+  later the same day. For example, on a Monday at 1 p.m, it waits for a couple
+  of hours if you create a wait task with `.monday(1).at("15")`. Otherwise the
+  previous behaviour of waiting for next week is preserved.
+- Fix encoding of query parameters when searching for existing workflows
 
 ## [0.3.1] - 2018-10-02
 ### Fixed
@@ -59,7 +73,8 @@ available.
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/zenaton/zenaton-ruby/compare/v0.3.1...HEAD
+[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
 [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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zenaton (0.3.1)
+    zenaton (0.4.0)
       activesupport
       tzinfo-data
 

data/README.md

@@ -1,6 +1,8 @@
 # Zenaton library for Ruby
-[![Gem Version](https://badge.fury.io/rb/zenaton.svg)](https://badge.fury.io/rb/zenaton)
-[![CircleCI](https://circleci.com/gh/zenaton/zenaton-ruby/tree/master.svg?style=shield&circle-token=99da357820821f49236b1e2f20657100fb382bd8)](https://circleci.com/gh/zenaton/zenaton-ruby/tree/master)
+[![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)
 

data/lib/zenaton/client.rb

@@ -11,7 +11,7 @@ module Zenaton
   class Client
     include Singleton
 
-    ZENATON_API_URL = 'https://zenaton.com/api/v1' # Zenaton api url
+    ZENATON_API_URL = 'https://api.zenaton.com/v1' # Zenaton api url
     ZENATON_WORKER_URL = 'http://localhost' # Default worker url
     DEFAULT_WORKER_PORT = 4001 # Default worker port
     WORKER_API_VERSION = 'v_newton' # Default worker api version
@@ -28,6 +28,8 @@ module Zenaton
     ATTR_DATA = 'data' # Parameter name for json payload
     ATTR_PROG = 'programming_language' # Parameter name for the language
     ATTR_MODE = 'mode' # Parameter name for the worker update mode
+    # Parameter name for task maximum processing time
+    ATTR_MAX_PROCESSING_TIME = 'maxProcessingTime'
 
     PROG = 'Ruby' # The current programming language
 
@@ -62,23 +64,49 @@ module Zenaton
 
     # Gets the url for the workers
     # @param resource [String] the endpoint for the worker
-    # @param params [String] url encoded parameters to include in request
+    # @param params [Hash|String] query params to be url encoded
     # @return [String] the workers url with parameters
-    def worker_url(resource = '', params = '')
+    def worker_url(resource = '', params = {})
       base_url = ENV['ZENATON_WORKER_URL'] || ZENATON_WORKER_URL
       port = ENV['ZENATON_WORKER_PORT'] || DEFAULT_WORKER_PORT
-      url = "#{base_url}:#{port}/api/#{WORKER_API_VERSION}/#{resource}?"
-      add_app_env(url, params)
+      url = "#{base_url}:#{port}/api/#{WORKER_API_VERSION}/#{resource}"
+
+      if params.is_a?(Hash)
+        append_params_to_url(url, params)
+      else
+        add_app_env("#{url}?", params)
+      end
     end
 
     # Gets the url for zenaton api
     # @param resource [String] the endpoint for the api
-    # @param params [String] url encoded parameters to include in request
+    # @param params [Hash|String] query params to be url encoded
     # @return [String] the api url with parameters
-    def website_url(resource = '', params = '')
+    def website_url(resource = '', params = {})
       api_url = ENV['ZENATON_API_URL'] || ZENATON_API_URL
-      url = "#{api_url}/#{resource}?#{API_TOKEN}=#{@api_token}&"
-      add_app_env(url, params)
+      url = "#{api_url}/#{resource}"
+
+      if params.is_a?(Hash)
+        params[API_TOKEN] = @api_token
+        append_params_to_url(url, params)
+      else
+        add_app_env("#{url}?#{API_TOKEN}=#{@api_token}&", params)
+      end
+    end
+
+    # Start a single task
+    # @param task [Zenaton::Interfaces::Task]
+    def start_task(task)
+      max_processing_time = if task.respond_to?(:max_processing_time)
+                              task.max_processing_time
+                            end
+      @http.post(
+        worker_url('tasks'),
+        ATTR_PROG => PROG,
+        ATTR_NAME => class_name(task),
+        ATTR_DATA => @serializer.encode(@properties.from(task)),
+        ATTR_MAX_PROCESSING_TIME => max_processing_time
+      )
     end
 
     # Start the specified workflow
@@ -123,7 +151,8 @@ module Zenaton
     # @param custom_id [String] the custom ID of the workflow
     # @return [Zenaton::Interfaces::Workflow, nil]
     def find_workflow(workflow_name, custom_id)
-      params = "#{ATTR_ID}=#{custom_id}&#{ATTR_NAME}=#{workflow_name}&#{ATTR_PROG}=#{PROG}" # rubocop:disable Metrics/LineLength
+      params = { ATTR_ID => custom_id, ATTR_NAME => workflow_name }
+      params[ATTR_PROG] = PROG
       data = @http.get(instance_website_url(params))['data']
       data && @properties.object_from(
         data['name'],
@@ -152,18 +181,34 @@ module Zenaton
 
     private
 
+    # DEPRECATED: This implementation does not safely encode the parameters to
+    # be passed as query params in a get request. This method gets called by
+    # agents up to version 0.4.5
     def add_app_env(url, params)
+      deprecation_warning = <<~WARN
+        [WARNING] You are running a Zenaton agent with a version <= 0.4.5
+                  Please consider upgrading to a more recent version.
+      WARN
+      warn(deprecation_warning)
+
       app_env = @app_env ? "#{APP_ENV}=#{@app_env}&" : ''
       app_id = @app_id ? "#{APP_ID}=#{@app_id}&" : ''
 
       "#{url}#{app_env}#{app_id}#{params}"
     end
 
+    def append_params_to_url(url, params)
+      params[APP_ENV] = @app_env if @app_env
+      params[APP_ID] = @app_id if @app_id
+
+      "#{url}?#{URI.encode_www_form(params)}"
+    end
+
     def instance_website_url(params)
       website_url('instances', params)
     end
 
-    def instance_worker_url(params = '')
+    def instance_worker_url(params = {})
       worker_url('instances', params)
     end
 
@@ -199,7 +244,7 @@ module Zenaton
     end
 
     def update_instance(workflow_name, custom_id, mode)
-      params = "#{ATTR_ID}=#{custom_id}"
+      params = { ATTR_ID => custom_id }
       url = instance_worker_url(params)
       options = {
         ATTR_PROG => PROG,

data/lib/zenaton/engine.rb

@@ -53,7 +53,7 @@ module Zenaton
       if job.is_a? Interfaces::Workflow
         @client.start_workflow(job)
       else
-        job.handle
+        @client.start_task(job)
       end
     end
 

data/lib/zenaton/traits/with_timestamp.rb

@@ -27,12 +27,14 @@ module Zenaton
       # @return Array<Integer, NilClass>
       def _get_timestamp_or_duration
         return [nil, nil] unless @buffer
+
         now, now_dup = _init_now_then
         @_mode = nil
         @buffer.each do |time_unit, time_value|
           now_dup = _apply(time_unit, time_value, now, now_dup)
         end
         return [nil, diff_in_seconds(now, now_dup)] if @_mode.nil?
+
         [now_dup.to_i, nil]
       end
 
@@ -51,7 +53,7 @@ module Zenaton
       # rubocop:disable Metrics/MethodLength
       def _apply(method, value, now, now_dup)
         if WEEKDAYS.include?(method)
-          _weekday(value, method, now_dup)
+          _weekday(value, method, now, now_dup)
         elsif method == :timestamp
           _timestamp(value)
         elsif method == :at
@@ -64,8 +66,9 @@ module Zenaton
       end
       # rubocop:enable Metrics/MethodLength
 
-      def _weekday(value, day, now_dup)
+      def _weekday(value, day, now, now_dup)
         _set_mode(MODE_WEEK_DAY)
+        value -= 1 if later_today?(now, day)
         value.times { |_n| now_dup = now_dup.next_occurring(day) }
         now_dup
       end
@@ -77,8 +80,7 @@ module Zenaton
 
       def _at(time, now, now_dup)
         _set_mode(MODE_AT)
-        hour, min, sec = time.split(':').map(&:to_i)
-        now_dup = now_dup.change(hour: hour, min: min, sec: sec || 0)
+        now_dup = set_time_from_string(now_dup, time)
         now_dup += delay if now > now_dup
         now_dup
       end
@@ -99,7 +101,7 @@ module Zenaton
       def _day_of_month(day, now, now_dup)
         _set_mode(MODE_MONTH_DAY)
         now_dup = now_dup.change(day: day)
-        now_dup += 1.month if now > now_dup
+        now_dup += 1.month if now >= now_dup && !later_today?(now, day)
         now_dup
       end
 
@@ -107,6 +109,7 @@ module Zenaton
         error = 'Incompatible definition in Wait methods'
         raise ExternalError,  error if mode == @_mode
         raise ExternalError, error if timestamp_mode_set?(mode)
+
         @_mode = mode if @_mode.nil? || @_mode == MODE_AT
       end
 
@@ -114,10 +117,32 @@ module Zenaton
         (!@_mode.nil? && MODE_TIMESTAMP == mode) || (@_mode == MODE_TIMESTAMP)
       end
 
+      def later_today?(now, day)
+        today?(now, day) && later?(now)
+      end
+
+      def today?(now, day)
+        wday = WEEKDAYS[now.wday - 1]
+        now.mday == day || wday == day
+      end
+
+      def later?(now)
+        time = @buffer[:at]
+        return false unless time
+
+        now < set_time_from_string(now.dup, time)
+      end
+
+      def set_time_from_string(now, string_time)
+        hour, min, sec = string_time.split(':').map(&:to_i)
+        now.change(hour: hour, min: min, sec: sec || 0)
+      end
+
       class_methods do
         def timezone=(timezone)
           error = 'Unknown timezone'
           raise ExternalError, error unless valid_timezone?(timezone)
+
           @@_timezone = timezone
         end
 

data/lib/zenaton/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenaton
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Zenaton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -239,8 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Zenaton ruby library