Class: Camunda::Model

Inherits:

Spyke::Base

• Object
• Spyke::Base
• Camunda::Model

Defined in:

lib/camunda/model.rb

Overview

This class in the main element of Spyke. It defines which API models will be bound to.

Direct Known Subclasses

Deployment, ExternalTask, Incident, ProcessDefinition, ProcessInstance, Signal, Task

Defined Under Namespace

Classes: RecordNotFound

Class Method Summary

• .base_path ⇒ Object
• .find_by!(params) ⇒ Camunda::Model

  Returns result of find_by but raises an exception instead of returning nil.

• .worker_id ⇒ String

  Returns the worker id.

Class Method Details

.base_path ⇒ Object

# File 'lib/camunda/model.rb', line 21

def self.base_path
  uri.sub("(:id)", '')
end

.find_by!(params) ⇒ Camunda::Model

Returns result of find_by but raises an exception instead of returning nil

Parameters:

• params (Hash) —

  query parameters

Returns:

• (Camunda::Model)

Raises:

• (Camunda::Model::RecordNotFound) —

  if query returns no results

# File 'lib/camunda/model.rb', line 8

def self.find_by!(params)
  with(base_path).where(params).first.tap do |result|
    raise Camunda::Model::RecordNotFound unless result
  end
end

.worker_id ⇒ String

Note:

default worker id is set in Camunda::Workflow.configuration

Returns the worker id

Returns:

• (String) —

  id of worker

# File 'lib/camunda/model.rb', line 17

def self.worker_id
  Camunda::Workflow.configuration.worker_id
end