ntswf 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e76f1bb295ab949307ec10635edd173860a203ce
-  data.tar.gz: 622559c42321d9b560df16f4739bbbabf4d600a8
+  metadata.gz: eaca998680d15e5774111c72cec550bf007f4b3b
+  data.tar.gz: 85ef085caee9057b275ac3dbea0283f7bc4a3226
 SHA512:
-  metadata.gz: 679c86ad4a385e8998d4e7cfb9977daf87d5e0d6bc2c49187f766c3a3755b3dddf834dcb2918b400362827d50d77926b65f6baaa4eebd8db58b344fb7937a962
-  data.tar.gz: 9a8dbf9d473f27a162a90d3f8930a6bd512609ce8cc8bb703951df1bec9796af4b9d35efcadae84d1bc0cf2f763099980af2467d1c3615aa948a2ffb13b1dae1
+  metadata.gz: d1c424625e79cf8b2dd61467b75653a339f64d892d0e117e16f28c643c5ee6ca8e33f6db15d04b94ded33a429602e471810ca58a2b973d96dc62a1e821ba2992
+  data.tar.gz: 0d5a73d6197c85cfec21f61fa26e372daff066fb2b663e57eaba14bd8b6ea40b8894ff050cd752e7dc5ddb26ce0e08779a40d7d08dd0c04e269791e96d37cb7c

data/README.md

@@ -39,7 +39,7 @@ Ntswf.create(:decision_worker, config).process_decisions
 ```
 config = {domain: 'my_domain', unit: 'my_worker'} # ...
 worker = Ntswf.create(:activity_worker, config)
-worker.on_task ->(task) { Ntswf.result task.params['my_param'] }
+worker.on_activity ->(task) { {outcome: task.params['my_param']} }
 worker.process_activities
 ```
 

data/lib/ntswf/activity_worker.rb

@@ -47,11 +47,6 @@ module Ntswf
 
     protected
 
-    def activity_task_list
-      activity_task_lists[default_unit] or raise Errors::InvalidArgument.new(
-          "Missing activity task list configuration for default unit '#{default_unit}'")
-    end
-
     def process_single_task(activity_task)
       returned_hash = @task_callback.call(describe(activity_task)) if @task_callback
       process_returned_hash(activity_task, returned_hash)
@@ -93,4 +88,4 @@ module Ntswf
       end
     end
   end
-end
+end

data/lib/ntswf/base.rb

@@ -6,16 +6,20 @@ module Ntswf
   module Base
     # @param config [Hash] A configuration with the following keys:
     # @option config [String] :access_key_id
-    #   AWS credential (deprecated, should use swf option)
+    #   *deprecated:* AWS credential. Deprecated, use :swf instead.
     # @option config [Hash] :activity_task_lists
-    #   The task list names for activities as hash (see also *:unit*)
-    # @option config [String] :decision_task_list The task list name for decisions
-    # @option config [String] :domain The SWF domain name
+    #   The task list names for activities per :unit.
+    # @option config [String] :decision_task_list
+    #   *deprecated:* The task list name for decisions.
+    #   Deprecated, use :decision_task_lists instead.
+    # @option config [Hash] :decision_task_lists
+    #   The task list names for decisions per :unit.
+    # @option config [String] :domain The SWF domain name.
     # @option config [String] :execution_id_prefix
     #   (value of :unit) Workflow ID prefix
-    #   (see {Client#start_execution}'s *:execution_id* for allowed values)
+    #   (see {Client#start_execution}'s :execution_id for allowed values).
     # @option config [Numeric] :execution_version
-    #   Value allowing clients to reject future execution versions
+    #   Value allowing clients to reject future execution versions.
     # @option config [String] :identity_suffix
     #   When polling for a task, the suffix will be appended to the (default) identity
     #   (<hostname>:<pid>), delimited by a ":".
@@ -25,17 +29,16 @@ module Ntswf
     #   A random ID is stored at the given path, and prepended to task list names and execution IDs.
     # @option config [String] :pidfile
     #   A path receiving the current PID for looping methods. Causes exit, if
-    #   overwritten by another process. See {Worker#in_subprocess}
+    #   overwritten by another process. See {Worker#in_subprocess}.
     # @option config [String] :secret_access_key
-    #   AWS credential (deprecated, should use swf option)
-    # @option config [Numeric] :subprocess_retries (0) see {Worker#in_subprocess}
+    #   *deprecated:* AWS credential. Deprecated, use :swf instead.
+    # @option config [Numeric] :subprocess_retries (0) See {Worker#in_subprocess}.
     # @option config [AWS::SimpleWorkflow] :swf
-    #   AWS simple workflow object (created e.g. with AWS::SimpleWorkflow.new)
-    # @option config [String] :unit This worker/client's activity task list key
-    # @raise [Errors::InvalidArgument] If a task list name is invalid
+    #   AWS simple workflow object (created e.g. with AWS::SimpleWorkflow.new).
+    # @option config [String] :unit This worker/client's activity task list key.
+    # @raise [Errors::InvalidArgument] If a task list name is invalid.
     def configure(config)
       @config = OpenStruct.new(config)
-      autocomplete_task_list_names!
       raise_if_invalid_task_list
     end
 
@@ -74,12 +77,24 @@ module Ntswf
     end
 
     def activity_task_lists
-      @config.activity_task_lists
+      autocompleted_activity_task_lists || {}
     end
 
-    def decision_task_list
-      @config.decision_task_list or raise Errors::InvalidArgument.new(
-          "Missing decision task list configuration")
+    def activity_task_list(unit: nil)
+      unit ||= default_unit
+      activity_task_lists[unit] or raise Errors::InvalidArgument.new(
+          "Missing activity task list configuration for unit '#{unit}'")
+    end
+
+    def decision_task_lists
+      autocompleted_decision_task_lists || fallback_decision_task_lists
+    end
+
+    def decision_task_list(unit: nil)
+      unit ||= default_unit
+      decision_task_lists[unit] || decision_task_lists[default_unit] or
+          raise Errors::InvalidArgument.new(
+          "Missing decision task list configuration for unit '#{unit}'")
     end
 
     def default_unit
@@ -131,8 +146,7 @@ module Ntswf
     end
 
     def raise_if_invalid_task_list
-      atl_values = activity_task_lists.values if activity_task_lists
-      [*atl_values, *@config.decision_task_list].each do |task_list|
+      all_task_list_names.each do |task_list|
         if task_list.include?(separator)
           raise Errors::InvalidArgument.new(
               "Invalid config '#{task_list}': Separator '#{separator}' is reserved for internal use.")
@@ -144,13 +158,26 @@ module Ntswf
       end
     end
 
-    def autocomplete_task_list_names!
-      @config.decision_task_list = autocomplete(@config.decision_task_list, "master-dtl")
-      if @config.activity_task_lists
-        @config.activity_task_lists.each do |key, value|
-          @config.activity_task_lists[key] = autocomplete(value, "#{key}-atl")
-        end
-      end
+    def all_task_list_names
+      [*activity_task_lists.values, *decision_task_lists.values, *@config.decision_task_list]
+    end
+
+    def autocompleted_activity_task_lists
+      autocompleted_task_lists(@config.activity_task_lists, :atl)
+    end
+
+    def autocompleted_decision_task_lists
+      autocompleted_task_lists(@config.decision_task_lists, :dtl)
+    end
+
+    def autocompleted_task_lists(raw_task_lists, suffix)
+      Hash(raw_task_lists).map do |unit, name|
+        {unit => autocomplete(name, "#{unit}-#{suffix}")}
+      end.reduce(:merge)
+    end
+
+    def fallback_decision_task_lists
+      {default_unit => autocomplete(@config.decision_task_list, "master-dtl")}
     end
 
     def autocomplete(value, fallback)

data/lib/ntswf/client.rb

@@ -10,6 +10,9 @@ module Ntswf
     # The options configure the control flow of the task.
     # Excluding *:execution_id* they will be stored in the *input* argument of the task as JSON.
     # @param options [Hash] The task's options. Keys with special meaning:
+    # @option options [String] :activity_task_list
+    #   The activity task list that this execution's activity tasks are routed to.
+    #   Should be +nil+ if the execution is not bound to a specific activity task list.
     # @option options [String] :execution_id
     #   Mandatory workflow ID suffix, allowed IDs are documented at docs.amazonwebservices.com
     #   (WorkflowId Property)
@@ -21,7 +24,8 @@ module Ntswf
     # @option options [Array<String>] :tag_list
     #   Additional strings that will be added to to the tag list of the workflow execution.
     # @option options [String] :unit
-    #   The executing unit's key, a corresponding activity task list must be configured
+    #   The executing unit's key.
+    #   Corresponding task lists must be configured. See {Base#configure}.
     # @option options [Numeric] :version
     #   Optional minimum version of the client. The task may be rescheduled by older clients.
     # @return [Hash]
@@ -67,12 +71,13 @@ module Ntswf
 
     def start_swf_workflow_execution(options)
       execution_id = options.delete(:execution_id)
+      unit = options[:unit]
       workflow_type.start_execution(
         child_policy: :terminate,
         execution_start_to_close_timeout: 48 * 3600,
         input: options.to_json,
-        tag_list: [options[:unit].to_s, options[:name].to_s] + Array(options[:tag_list]),
-        task_list: decision_task_list,
+        tag_list: [unit.to_s, options[:name].to_s] + Array(options[:tag_list]),
+        task_list: decision_task_list(unit: unit),
         task_start_to_close_timeout: 10 * 60,
         workflow_id: workflow_id(execution_id_prefix, execution_id),
       )

data/lib/ntswf/decision_worker.rb

@@ -94,10 +94,8 @@ module Ntswf
     def schedule(task, data_providing_event)
       input = data_providing_event.attributes.input
       options = parse_input(input)
-      app_in_charge = options['unit'] || guess_app_from(data_providing_event)
-      task_list = activity_task_lists[app_in_charge]
-      raise Errors::InvalidArgument.new(
-          "Missing activity task list config for #{app_in_charge.inspect}") unless task_list
+      task_list = options['activity_task_list'] ||
+          activity_task_list(unit: options['unit'] || guess_app_from(data_providing_event))
 
       task.schedule_activity_task(activity_type, {
         heartbeat_timeout: :none,
@@ -132,4 +130,4 @@ module Ntswf
       data_providing_event.workflow_execution.workflow_type.name[/\w+/]
     end
   end
-end
+end

data/lib/ntswf/worker.rb

@@ -66,4 +66,4 @@ module Ntswf
     end
 
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ntswf
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-v1
@@ -81,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Not That Simple Workflow