flowable 1.0.0

data/lib/flowable_client/resources/process_definitions.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module FlowableClient
+  module Resources
+    class ProcessDefinitions < Base
+      BASE_PATH = 'service/repository/process-definitions'
+
+      # List all process definitions
+      # @param options [Hash] Query parameters
+      # @option options [String] :key Filter by key
+      # @option options [String] :keyLike Filter by key pattern
+      # @option options [String] :name Filter by name
+      # @option options [String] :nameLike Filter by name pattern
+      # @option options [Integer] :version Filter by version
+      # @option options [String] :deploymentId Filter by deployment
+      # @option options [Boolean] :latest Only return latest versions
+      # @option options [Boolean] :suspended Filter by suspension state
+      # @option options [String] :tenantId Filter by tenant
+      # @return [Hash] Paginated list of process definitions
+      def list(**options)
+        params = paginate_params(options)
+        %i[key keyLike name nameLike resourceName resourceNameLike
+           category categoryLike categoryNotEquals deploymentId
+           startableByUser tenantId tenantIdLike].each do |key|
+          params[key] = options[key] if options[key]
+        end
+        params[:version] = options[:version] if options[:version]
+        params[:latest] = options[:latest] if options.key?(:latest)
+        params[:suspended] = options[:suspended] if options.key?(:suspended)
+        params[:withoutTenantId] = options[:withoutTenantId] if options.key?(:withoutTenantId)
+
+        client.get(BASE_PATH, params)
+      end
+
+      # Get a specific process definition
+      # @param process_definition_id [String] The process definition ID
+      # @return [Hash] Process definition details
+      def get(process_definition_id)
+        client.get("#{BASE_PATH}/#{process_definition_id}")
+      end
+
+      # Get process definition by key (returns latest version)
+      # @param key [String] The process definition key
+      # @param tenant_id [String] Optional tenant ID
+      # @return [Hash] Process definition details
+      def get_by_key(key, tenant_id: nil)
+        params = { key: key, latest: true }
+        params[:tenantId] = tenant_id if tenant_id
+
+        result = client.get(BASE_PATH, params)
+        result['data']&.first
+      end
+
+      # Update the category of a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @param category [String] The new category
+      # @return [Hash] Updated process definition
+      def update_category(process_definition_id, category)
+        client.put("#{BASE_PATH}/#{process_definition_id}", { category: category })
+      end
+
+      # Suspend a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @param include_instances [Boolean] Also suspend running instances
+      # @param date [String] Effective date (ISO-8601)
+      # @return [Hash] Updated process definition
+      def suspend(process_definition_id, include_instances: false, date: nil)
+        body = { action: 'suspend', includeProcessInstances: include_instances }
+        body[:date] = date if date
+        client.put("#{BASE_PATH}/#{process_definition_id}", body)
+      end
+
+      # Activate a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @param include_instances [Boolean] Also activate suspended instances
+      # @param date [String] Effective date (ISO-8601)
+      # @return [Hash] Updated process definition
+      def activate(process_definition_id, include_instances: false, date: nil)
+        body = { action: 'activate', includeProcessInstances: include_instances }
+        body[:date] = date if date
+        client.put("#{BASE_PATH}/#{process_definition_id}", body)
+      end
+
+      # Get the BPMN XML content of a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @return [String] BPMN XML content
+      def resource_data(process_definition_id)
+        client.get("#{BASE_PATH}/#{process_definition_id}/resourcedata")
+      end
+
+      alias resource_content resource_data
+
+      # Get the BPMN model as JSON
+      # @param process_definition_id [String] The process definition ID
+      # @return [Hash] BPMN model structure
+      def model(process_definition_id)
+        client.get("#{BASE_PATH}/#{process_definition_id}/model")
+      end
+
+      # Get process diagram image (PNG)
+      # @param process_definition_id [String] The process definition ID
+      # @return [String] Binary image data
+      def diagram(process_definition_id)
+        client.get("#{BASE_PATH}/#{process_definition_id}/image")
+      end
+
+      alias image diagram
+
+      # Get all candidate starters for a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @return [Array<Hash>] List of identity links
+      def identity_links(process_definition_id)
+        client.get("#{BASE_PATH}/#{process_definition_id}/identitylinks")
+      end
+
+      # Add a candidate starter (user) to a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @param user_id [String] The user ID
+      # @return [Hash] Created identity link
+      def add_candidate_user(process_definition_id, user_id)
+        client.post("#{BASE_PATH}/#{process_definition_id}/identitylinks", { user: user_id })
+      end
+
+      # Add a candidate starter (group) to a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @param group_id [String] The group ID
+      # @return [Hash] Created identity link
+      def add_candidate_group(process_definition_id, group_id)
+        client.post("#{BASE_PATH}/#{process_definition_id}/identitylinks", { group: group_id })
+      end
+
+      # Remove a candidate starter from a process definition
+      # @param process_definition_id [String] The process definition ID
+      # @param family [String] 'users' or 'groups'
+      # @param identity_id [String] The user or group ID
+      # @return [Boolean] true if successful
+      def remove_candidate(process_definition_id, family, identity_id)
+        client.delete("#{BASE_PATH}/#{process_definition_id}/identitylinks/#{family}/#{identity_id}")
+      end
+    end
+  end
+end

data/lib/flowable_client/resources/process_instances.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module FlowableClient
+  module Resources
+    class ProcessInstances < Base
+      BASE_PATH = 'service/runtime/process-instances'
+
+      # List all process instances
+      # @param options [Hash] Query parameters
+      # @option options [String] :id Filter by instance ID
+      # @option options [String] :processDefinitionKey Filter by definition key
+      # @option options [String] :processDefinitionId Filter by definition ID
+      # @option options [String] :businessKey Filter by business key
+      # @option options [String] :involvedUser Filter by involved user
+      # @option options [Boolean] :suspended Filter suspended instances
+      # @option options [String] :tenantId Filter by tenant
+      # @return [Hash] Paginated list of process instances
+      def list(**options)
+        params = paginate_params(options)
+        %i[id processDefinitionKey processDefinitionId businessKey
+           involvedUser superProcessInstanceId tenantId tenantIdLike].each do |key|
+          params[key] = options[key] if options[key]
+        end
+        params[:suspended] = options[:suspended] if options.key?(:suspended)
+        params[:withoutTenantId] = options[:withoutTenantId] if options.key?(:withoutTenantId)
+        params[:includeProcessVariables] = options[:includeProcessVariables] if options.key?(:includeProcessVariables)
+
+        client.get(BASE_PATH, params)
+      end
+
+      # Get a specific process instance
+      # @param process_instance_id [String] The process instance ID
+      # @return [Hash] Process instance details
+      def get(process_instance_id)
+        client.get("#{BASE_PATH}/#{process_instance_id}")
+      end
+
+      # Start a new process instance by process definition ID
+      # @param process_definition_id [String] The process definition ID
+      # @param variables [Hash] Optional variables (name => value)
+      # @param business_key [String] Optional business key
+      # @param return_variables [Boolean] Return variables in response
+      # @return [Hash] Created process instance
+      def start_by_id(process_definition_id, variables: {}, business_key: nil, return_variables: false)
+        body = { processDefinitionId: process_definition_id }
+        body[:businessKey] = business_key if business_key
+        body[:variables] = build_variables_array(variables) unless variables.empty?
+        body[:returnVariables] = return_variables if return_variables
+
+        client.post(BASE_PATH, body)
+      end
+
+      # Start a new process instance by process definition key
+      # @param process_definition_key [String] The process definition key
+      # @param variables [Hash] Optional variables (name => value)
+      # @param business_key [String] Optional business key
+      # @param tenant_id [String] Optional tenant ID
+      # @param return_variables [Boolean] Return variables in response
+      # @return [Hash] Created process instance
+      def start_by_key(process_definition_key, variables: {}, business_key: nil, tenant_id: nil,
+                       return_variables: false)
+        body = { processDefinitionKey: process_definition_key }
+        body[:businessKey] = business_key if business_key
+        body[:tenantId] = tenant_id if tenant_id
+        body[:variables] = build_variables_array(variables) unless variables.empty?
+        body[:returnVariables] = return_variables if return_variables
+
+        client.post(BASE_PATH, body)
+      end
+
+      # Delete a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param delete_reason [String] Reason for deletion
+      # @return [Boolean] true if successful
+      def delete(process_instance_id, delete_reason: nil)
+        params = {}
+        params[:deleteReason] = delete_reason if delete_reason
+        client.delete("#{BASE_PATH}/#{process_instance_id}", params)
+      end
+
+      # Suspend a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @return [Hash] Updated process instance
+      def suspend(process_instance_id)
+        client.put("#{BASE_PATH}/#{process_instance_id}", { action: 'suspend' })
+      end
+
+      # Activate a suspended process instance
+      # @param process_instance_id [String] The process instance ID
+      # @return [Hash] Updated process instance
+      def activate(process_instance_id)
+        client.put("#{BASE_PATH}/#{process_instance_id}", { action: 'activate' })
+      end
+
+      # Query process instances with complex filters
+      # @param query [Hash] Query body with filters and variable conditions
+      # @return [Hash] Paginated list of process instances
+      def query(query)
+        client.post('service/query/process-instances', query)
+      end
+
+      # Get the diagram/image for a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @return [String] Binary image data
+      def diagram(process_instance_id)
+        client.get("#{BASE_PATH}/#{process_instance_id}/diagram")
+      end
+
+      # --- Identity Links ---
+
+      # Get involved people for a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @return [Array<Hash>] List of identity links
+      def identity_links(process_instance_id)
+        client.get("#{BASE_PATH}/#{process_instance_id}/identitylinks")
+      end
+
+      # Add an involved user to a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param user_id [String] The user ID
+      # @param type [String] Type of involvement (e.g., 'participant')
+      # @return [Hash] Created identity link
+      def add_involved_user(process_instance_id, user_id, type: 'participant')
+        client.post(
+          "#{BASE_PATH}/#{process_instance_id}/identitylinks",
+          { userId: user_id, type: type }
+        )
+      end
+
+      # Remove an involved user from a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param user_id [String] The user ID
+      # @param type [String] Type of involvement
+      # @return [Boolean] true if successful
+      def remove_involved_user(process_instance_id, user_id, type)
+        client.delete("#{BASE_PATH}/#{process_instance_id}/identitylinks/users/#{user_id}/#{type}")
+      end
+
+      # --- Variables ---
+
+      # Get all variables for a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @return [Array<Hash>] List of variables
+      def variables(process_instance_id)
+        client.get("#{BASE_PATH}/#{process_instance_id}/variables")
+      end
+
+      # Get a specific variable from a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param variable_name [String] The variable name
+      # @return [Hash] Variable details
+      def variable(process_instance_id, variable_name)
+        client.get("#{BASE_PATH}/#{process_instance_id}/variables/#{variable_name}")
+      end
+
+      # Create variables on a process instance (fails if exists)
+      # @param process_instance_id [String] The process instance ID
+      # @param variables [Hash] Variables to create (name => value)
+      # @return [Array<Hash>] Created variables
+      def create_variables(process_instance_id, variables)
+        client.post(
+          "#{BASE_PATH}/#{process_instance_id}/variables",
+          build_variables_array(variables)
+        )
+      end
+
+      # Create or update variables on a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param variables [Hash] Variables to set (name => value)
+      # @return [Array<Hash>] Updated variables
+      def set_variables(process_instance_id, variables)
+        client.put(
+          "#{BASE_PATH}/#{process_instance_id}/variables",
+          build_variables_array(variables)
+        )
+      end
+
+      # Update a single variable on a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param name [String] Variable name
+      # @param value [Object] Variable value
+      # @param type [String] Optional explicit type
+      # @return [Hash] Updated variable
+      def update_variable(process_instance_id, name, value, type: nil)
+        body = { name: name, value: value }
+        body[:type] = type || infer_type(value)
+
+        client.put("#{BASE_PATH}/#{process_instance_id}/variables/#{name}", body)
+      end
+
+      # Delete a variable from a process instance
+      # @param process_instance_id [String] The process instance ID
+      # @param variable_name [String] The variable name
+      # @return [Boolean] true if successful
+      def delete_variable(process_instance_id, variable_name)
+        client.delete("#{BASE_PATH}/#{process_instance_id}/variables/#{variable_name}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: flowable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jakub Polak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A comprehensive Ruby client for interacting with Flowable CMMN and BPMN
+  engines via REST API. Supports deployments, case/process definitions, instances,
+  tasks, variables, history, and more.
+email:
+- jakub.polak.vz@gmail.com
+executables:
+- flowable
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/flowable
+- lib/flowable.rb
+- lib/flowable/flowable.rb
+- lib/flowable/resources/base.rb
+- lib/flowable/resources/bpmn_deployments.rb
+- lib/flowable/resources/bpmn_history.rb
+- lib/flowable/resources/case_definitions.rb
+- lib/flowable/resources/case_instances.rb
+- lib/flowable/resources/deployments.rb
+- lib/flowable/resources/executions.rb
+- lib/flowable/resources/history.rb
+- lib/flowable/resources/plan_item_instances.rb
+- lib/flowable/resources/process_definitions.rb
+- lib/flowable/resources/process_instances.rb
+- lib/flowable/resources/tasks.rb
+- lib/flowable/version.rb
+- lib/flowable/workflow.rb
+- lib/flowable_client/resources/bpmn_history.rb
+- lib/flowable_client/resources/process_definitions.rb
+- lib/flowable_client/resources/process_instances.rb
+homepage: https://github.com/kupolak/flowable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kupolak/flowable
+  source_code_uri: https://github.com/kupolak/flowable
+  changelog_uri: https://github.com/kupolak/flowable/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/kupolak/flowable#readme
+  bug_tracker_uri: https://github.com/kupolak/flowable/issues
+  rubygems_mfa_required: 'true'
+post_install_message: |
+  Thank you for installing flowable!
+
+  Quick start:
+    require 'flowable'
+    client = Flowable::Client.new(
+      host: 'localhost',
+      port: 8080,
+      username: 'rest-admin',
+      password: 'test'
+    )
+
+  CLI usage:
+    flowable --help
+
+  Documentation: https://github.com/kupolak/flowable
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby client for Flowable CMMN and BPMN REST API
+test_files: []