operaton-bpm-client 0.1.0

data/lib/operaton/bpm/client/variable/impl/mapper/string_value_mapper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "primitive_value_mapper"
+require_relative "../../../../engine/variable/variables"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Mapper
+            # Mirrors org.operaton.bpm.client.variable.impl.mapper.StringValueMapper
+            class StringValueMapper < PrimitiveValueMapper
+              def initialize
+                super(Engine::Variable::ValueType::STRING)
+              end
+
+              def convert_to_typed_value(untyped_value)
+                Engine::Variable::Variables.string_value(untyped_value.value)
+              end
+
+              def read_typed_value(typed_value_field)
+                Engine::Variable::Variables.string_value(typed_value_field.value)
+              end
+
+              def write_value(string_value, typed_value_field)
+                typed_value_field.value = string_value.value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/mapper/xml_value_mapper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "primitive_value_mapper"
+require_relative "../../client_values"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Mapper
+            # Mirrors org.operaton.bpm.client.variable.impl.mapper.XmlValueMapper
+            class XmlValueMapper < PrimitiveValueMapper
+              def initialize
+                super(ClientValues::XML)
+              end
+
+              def convert_to_typed_value(untyped_value)
+                ClientValues.xml_value(untyped_value.value)
+              end
+
+              def write_value(xml_value, typed_value_field)
+                typed_value_field.value = xml_value.value
+              end
+
+              def read_typed_value(typed_value_field)
+                ClientValues.xml_value(typed_value_field.value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/type/json_type_impl.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../../../../engine/variable/value_type"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Type
+            # Mirrors org.operaton.bpm.client.variable.impl.type.JsonTypeImpl
+            class JsonTypeImpl < Engine::Variable::PrimitiveValueType
+              JSON_TYPE_NAME = "json"
+
+              def initialize
+                super(JSON_TYPE_NAME) { |v| v.is_a?(String) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/type/xml_type_impl.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../../../../engine/variable/value_type"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Type
+            # Mirrors org.operaton.bpm.client.variable.impl.type.XmlTypeImpl
+            class XmlTypeImpl < Engine::Variable::PrimitiveValueType
+              XML_TYPE_NAME = "xml"
+
+              def initialize
+                super(XML_TYPE_NAME) { |v| v.is_a?(String) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/typed_value_field.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          # Mirrors org.operaton.bpm.client.variable.impl.TypedValueField
+          class TypedValueField
+            attr_accessor :value, :type, :value_info
+
+            def self.from_json(hash)
+              field = new
+              field.value = hash["value"]
+              field.type = hash["type"]
+              field.value_info = hash["valueInfo"] || {}
+              field
+            end
+
+            def as_json
+              {
+                "value" => value,
+                "type" => type,
+                "valueInfo" => value_info
+              }
+            end
+
+            def to_s
+              "TypedValueField [type=#{type}, value=#{value}, valueInfo=#{value_info}]"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/typed_values.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative "typed_value_field"
+require_relative "variable_value"
+require_relative "../../impl/external_task_client_logger"
+require_relative "../../../engine/variable/variables"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          # Mirrors org.operaton.bpm.client.variable.impl.TypedValues
+          class TypedValues
+            def initialize(serializers)
+              @serializers = serializers
+            end
+
+            # Serializes a Hash (or Engine::Variable::VariableMap) of variables
+            # into a map of variable name => TypedValueField.
+            def serialize_variables(variables)
+              result = {}
+              return result if variables.nil?
+
+              if variables.is_a?(Engine::Variable::VariableMap)
+                variables.keys.each do |variable_name|
+                  result[variable_name] = serialize_variable(variable_name,
+                                                             variables.get_value_typed(variable_name))
+                end
+              else
+                variables.each do |variable_name, variable_value|
+                  result[variable_name] = serialize_variable(variable_name, variable_value)
+                end
+              end
+
+              result
+            end
+
+            # Mirrors wrapVariables: builds lazily-deserialized VariableValue
+            # objects out of the raw TypedValueFields received from the engine.
+            def wrap_variables(external_task, variables)
+              execution_id = external_task.execution_id
+              result = {}
+
+              variables&.each do |variable_name, variable_value|
+                type_name = variable_value.type
+                if type_name && !type_name.empty?
+                  variable_value.type = type_name[0].downcase + type_name[1..]
+                end
+                result[variable_name] = VariableValue.new(execution_id, variable_name, variable_value, @serializers)
+              end
+
+              result
+            end
+
+            protected
+
+            def serialize_variable(variable_name, variable_value)
+              typed_value = create_typed_value(variable_value)
+              to_typed_value_field(typed_value)
+            rescue StandardError => e
+              raise logger.cannot_serialize_variable(variable_name, e)
+            end
+
+            def to_typed_value_field(typed_value)
+              serializer = find_serializer(typed_value)
+
+              if typed_value.is_a?(Engine::Variable::UntypedValue)
+                typed_value = serializer.convert_to_typed_value(typed_value)
+              end
+
+              typed_value_field = TypedValueField.new
+              serializer.write_value(typed_value, typed_value_field)
+
+              value_type = typed_value.type
+              typed_value_field.value_info = value_type.value_info(typed_value)
+              type_name = value_type.name
+              typed_value_field.type = type_name[0].upcase + type_name[1..]
+              typed_value_field
+            end
+
+            def find_serializer(typed_value)
+              @serializers.find_mapper_for_typed_value(typed_value)
+            end
+
+            def create_typed_value(value)
+              return value if value.is_a?(Engine::Variable::TypedValue)
+
+              Engine::Variable::Variables.untyped_value(value)
+            end
+
+            def logger
+              Client::Impl::ExternalTaskClientLogger.client_logger
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/value/deferred_file_value_impl.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../../../engine/variable/typed_value"
+require_relative "../../value/deferred_file_value"
+require_relative "../../../impl/engine_client_exception"
+require_relative "../../../impl/external_task_client_logger"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Value
+            # Mirrors org.operaton.bpm.client.variable.impl.value.DeferredFileValueImpl
+            class DeferredFileValueImpl < Engine::Variable::FileValue
+              include Variable::Value::DeferredFileValue
+
+              attr_accessor :variable_name, :execution_id
+
+              def initialize(filename, engine_client)
+                super(filename)
+                @engine_client = engine_client
+                @is_loaded = false
+              end
+
+              def loaded?
+                @is_loaded
+              end
+
+              # Returns the file content, fetching it from the engine on first access.
+              def value
+                load_content unless loaded?
+                super
+              end
+
+              def to_s
+                "DeferredFileValueImpl [mimeType=#{mime_type}, filename=#{filename}, " \
+                  "type=#{type}, isTransient=#{transient?}, isLoaded=#{loaded?}]"
+              end
+
+              protected
+
+              def load_content
+                bytes = @engine_client.get_local_binary_variable(variable_name, execution_id)
+                set_value(bytes)
+                @is_loaded = true
+              rescue Client::Impl::EngineClientException => e
+                raise Client::Impl::ExternalTaskClientLogger.client_logger
+                                                            .handled_engine_client_exception("loading deferred file", e)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/value/json_value_impl.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../../../../engine/variable/typed_value"
+require_relative "../../value/json_value"
+require_relative "../type/json_type_impl"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Value
+            # Mirrors org.operaton.bpm.client.variable.impl.value.JsonValueImpl
+            class JsonValueImpl < Engine::Variable::PrimitiveTypeValue
+              include Variable::Value::JsonValue
+
+              def initialize(value, is_transient = false)
+                super(value, ClientValues::JSON, is_transient)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/value/xml_value_impl.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../../../../engine/variable/typed_value"
+require_relative "../../value/xml_value"
+require_relative "../type/xml_type_impl"
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          module Value
+            # Mirrors org.operaton.bpm.client.variable.impl.value.XmlValueImpl
+            class XmlValueImpl < Engine::Variable::PrimitiveTypeValue
+              include Variable::Value::XmlValue
+
+              def initialize(value, is_transient = false)
+                super(value, ClientValues::XML, is_transient)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/value_mapper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          # Mirrors org.operaton.bpm.client.variable.impl.ValueMapper
+          module ValueMapper
+            def type
+              raise NotImplementedError
+            end
+
+            def write_value(typed_value, typed_value_field)
+              raise NotImplementedError
+            end
+
+            def read_value(typed_value_field, deserialize_value)
+              raise NotImplementedError
+            end
+
+            def can_handle_typed_value(typed_value)
+              raise NotImplementedError
+            end
+
+            def can_handle_typed_value_field(typed_value_field)
+              raise NotImplementedError
+            end
+
+            def convert_to_typed_value(untyped_value)
+              raise NotImplementedError
+            end
+
+            def serialization_dataformat
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/value_mappers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          # Mirrors org.operaton.bpm.client.variable.impl.ValueMappers
+          module ValueMappers
+            def find_mapper_for_typed_value(typed_value)
+              raise NotImplementedError
+            end
+
+            def find_mapper_for_typed_value_field(typed_value_field)
+              raise NotImplementedError
+            end
+
+            def add_mapper(mapper)
+              raise NotImplementedError
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/impl/variable_value.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Impl
+          # Mirrors org.operaton.bpm.client.variable.impl.VariableValue —
+          # lazily deserialized variable value received from the engine.
+          class VariableValue
+            def initialize(execution_id, variable_name, typed_value_field, mappers)
+              @execution_id = execution_id
+              @variable_name = variable_name
+              @typed_value_field = typed_value_field
+              @mappers = mappers
+              @serializer = nil
+              @cached_value = nil
+            end
+
+            def value
+              typed_value&.value
+            end
+
+            def typed_value(deserialize_value = true)
+              if deserialize_value && @cached_value.is_a?(Engine::Variable::ObjectValue) &&
+                 !@cached_value.deserialized?
+                @cached_value = nil
+              end
+
+              if @cached_value.nil?
+                @cached_value = serializer.read_value(@typed_value_field, deserialize_value)
+
+                if @cached_value.is_a?(Value::DeferredFileValueImpl)
+                  @cached_value.execution_id = @execution_id
+                  @cached_value.variable_name = @variable_name
+                end
+              end
+
+              @cached_value
+            end
+
+            def serializer
+              @serializer ||= @mappers.find_mapper_for_typed_value_field(@typed_value_field)
+            end
+
+            def to_s
+              "VariableValue [cachedValue=#{@cached_value}, executionId=#{@execution_id}, " \
+                "variableName=#{@variable_name}, typedValueField=#{@typed_value_field}]"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/value/deferred_file_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Value
+          # Mirrors org.operaton.bpm.client.variable.value.DeferredFileValue —
+          # a file value whose content is lazily fetched from the engine.
+          module DeferredFileValue
+            def loaded?
+              raise NotImplementedError
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/value/json_value.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Value
+          # Mirrors org.operaton.bpm.client.variable.value.JsonValue — a marker
+          # for string-typed JSON values; implemented by Impl::Value::JsonValueImpl.
+          module JsonValue
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/variable/value/xml_value.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      module Variable
+        module Value
+          # Mirrors org.operaton.bpm.client.variable.value.XmlValue — a marker
+          # for string-typed XML values; implemented by Impl::Value::XmlValueImpl.
+          module XmlValue
+          end
+        end
+      end
+    end
+  end
+end

data/lib/operaton/bpm/client/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Operaton
+  module Bpm
+    module Client
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/operaton/bpm/client.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Ruby recreation of the Operaton external task client
+# (org.operaton.bpm.client). The namespace mirrors the Java packages:
+#
+#   org.operaton.bpm.client            -> Operaton::Bpm::Client
+#   org.operaton.bpm.client.impl       -> Operaton::Bpm::Client::Impl
+#   org.operaton.bpm.client.task       -> Operaton::Bpm::Client::Task
+#   org.operaton.bpm.client.topic      -> Operaton::Bpm::Client::Topic
+#   org.operaton.bpm.client.backoff    -> Operaton::Bpm::Client::Backoff
+#   org.operaton.bpm.client.variable   -> Operaton::Bpm::Client::Variable
+#   org.operaton.bpm.engine.variable   -> Operaton::Bpm::Engine::Variable
+#
+# Exception classes from org.operaton.bpm.client.exception live directly
+# under Operaton::Bpm::Client.
+
+require_relative "client/version"
+require_relative "client/exceptions"
+
+# engine variable commons (org.operaton.bpm.engine.variable)
+require_relative "engine/variable/value_type"
+require_relative "engine/variable/typed_value"
+require_relative "engine/variable/variable_map"
+require_relative "engine/variable/variables"
+
+# core interfaces
+require_relative "client/url_resolver"
+require_relative "client/external_task_client"
+require_relative "client/external_task_client_builder"
+
+# impl
+require_relative "client/impl/external_task_client_logger"
+require_relative "client/impl/engine_client_logger"
+require_relative "client/impl/engine_client_exception"
+require_relative "client/impl/engine_rest_exception_dto"
+require_relative "client/impl/permanent_url_resolver"
+require_relative "client/impl/request_dto"
+require_relative "client/impl/object_mapper"
+require_relative "client/impl/request_executor"
+require_relative "client/impl/engine_client"
+require_relative "client/impl/external_task_client_impl"
+require_relative "client/impl/external_task_client_builder_impl"
+
+# backoff
+require_relative "client/backoff/backoff_strategy"
+require_relative "client/backoff/error_aware_backoff_strategy"
+require_relative "client/backoff/exponential_backoff_strategy"
+require_relative "client/backoff/exponential_error_backoff_strategy"
+
+# interceptor
+require_relative "client/interceptor/client_request_context"
+require_relative "client/interceptor/client_request_interceptor"
+require_relative "client/interceptor/impl/client_request_context_impl"
+require_relative "client/interceptor/impl/request_interceptor_handler"
+require_relative "client/interceptor/auth/basic_auth_provider"
+
+# spi
+require_relative "client/spi/data_format"
+require_relative "client/spi/data_format_provider"
+require_relative "client/spi/data_format_configurator"
+
+# task
+require_relative "client/task/external_task"
+require_relative "client/task/external_task_handler"
+require_relative "client/task/external_task_service"
+require_relative "client/task/ordering_config"
+require_relative "client/task/sorting_dto"
+require_relative "client/task/impl/external_task_impl"
+require_relative "client/task/impl/external_task_service_impl"
+require_relative "client/task/impl/dto/bpmn_error_request_dto"
+require_relative "client/task/impl/dto/complete_request_dto"
+require_relative "client/task/impl/dto/extend_lock_request_dto"
+require_relative "client/task/impl/dto/failure_request_dto"
+require_relative "client/task/impl/dto/lock_request_dto"
+require_relative "client/task/impl/dto/set_variables_request_dto"
+
+# topic
+require_relative "client/topic/topic_subscription"
+require_relative "client/topic/topic_subscription_builder"
+require_relative "client/topic/impl/topic_subscription_impl"
+require_relative "client/topic/impl/topic_subscription_builder_impl"
+require_relative "client/topic/impl/topic_subscription_manager"
+require_relative "client/topic/impl/topic_subscription_manager_logger"
+require_relative "client/topic/impl/dto/fetch_and_lock_request_dto"
+require_relative "client/topic/impl/dto/fetch_and_lock_response_dto"
+require_relative "client/topic/impl/dto/topic_request_dto"
+
+# variable
+require_relative "client/variable/client_values"
+require_relative "client/variable/value/json_value"
+require_relative "client/variable/value/xml_value"
+require_relative "client/variable/value/deferred_file_value"
+require_relative "client/variable/impl/typed_value_field"
+require_relative "client/variable/impl/typed_values"
+require_relative "client/variable/impl/value_mapper"
+require_relative "client/variable/impl/value_mappers"
+require_relative "client/variable/impl/default_value_mappers"
+require_relative "client/variable/impl/variable_value"
+require_relative "client/variable/impl/abstract_typed_value_mapper"
+require_relative "client/variable/impl/type/json_type_impl"
+require_relative "client/variable/impl/type/xml_type_impl"
+require_relative "client/variable/impl/value/json_value_impl"
+require_relative "client/variable/impl/value/xml_value_impl"
+require_relative "client/variable/impl/value/deferred_file_value_impl"
+require_relative "client/variable/impl/mapper/primitive_value_mapper"
+require_relative "client/variable/impl/mapper/number_value_mapper"
+require_relative "client/variable/impl/mapper/boolean_value_mapper"
+require_relative "client/variable/impl/mapper/byte_array_value_mapper"
+require_relative "client/variable/impl/mapper/date_value_mapper"
+require_relative "client/variable/impl/mapper/double_value_mapper"
+require_relative "client/variable/impl/mapper/file_value_mapper"
+require_relative "client/variable/impl/mapper/integer_value_mapper"
+require_relative "client/variable/impl/mapper/json_value_mapper"
+require_relative "client/variable/impl/mapper/long_value_mapper"
+require_relative "client/variable/impl/mapper/null_value_mapper"
+require_relative "client/variable/impl/mapper/object_value_mapper"
+require_relative "client/variable/impl/mapper/short_value_mapper"
+require_relative "client/variable/impl/mapper/string_value_mapper"
+require_relative "client/variable/impl/mapper/xml_value_mapper"
+require_relative "client/variable/impl/format/json/json_data_format"
+require_relative "client/variable/impl/format/json/json_data_format_provider"