camunda-workflow 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91163be2d48427f50fe82e1240bf22aa15f7654d3acd3de3aa1394cdac2e86ae
-  data.tar.gz: ff93525a52db03d6e1e8a9d4134c72a381f76a875fc3bd85faa990c8fedb2934
+  metadata.gz: 9401504309d2afda4ebc29413c718c1c2ccaba1a560a21300688239e518be1b8
+  data.tar.gz: fdfeccc97db56ce156a8edb7adee0792d877c3badfe429a650c6f75f551720b4
 SHA512:
-  metadata.gz: e506b4c45d991b9ee7b539174ae3bc1b2a076e7ec015c86bb780803e802343c10443e8ee0b7cd9e78fb7b95decaee9212531ff6c91ebbf293333a37eb5a6834b
-  data.tar.gz: ab2167000389d74ba8de0b507876de7ae734bc2fea93b878a260cb9ef212974011bc45444274ac7071bb4c45054396d69b4759619744618273f3ee37cd4522a9
+  metadata.gz: 060af24f736f97e3b7652a3f2c58b53dd2f10f1655179d801de85525b2b0b8455f99783ea824faf8234e1549a59476cbcbd09784a51d5c1a63f3995ff089456a
+  data.tar.gz: '098a818250200d5bbb79289a6b89f1c591fac90b0e4b502d883d9af37443a69a715d75403aa0f1afc11ef7838d6cff31b74051afed1acd8ec5774fb856ac6021'

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
+## [v0.6.0](https://github.com/amalagaura/camunda-workflow/tree/v0.6.0) (2023-07-19)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.3.0...v0.6.0)
+
+**Closed issues:**
+
+- Upgrade rails development dependency [\#63](https://github.com/amalagaura/camunda-workflow/issues/63)
+- Not able to use it with Sidekiq [\#52](https://github.com/amalagaura/camunda-workflow/issues/52)
+- Migrate project to the Camunda Community Hub? [\#50](https://github.com/amalagaura/camunda-workflow/issues/50)
+
+**Merged pull requests:**
+
+- Bump camunda-workflow to 0.6.0 [\#73](https://github.com/amalagaura/camunda-workflow/pull/73) ([amalagaura](https://github.com/amalagaura))
+- Yashupadhyay16 upgrade rails version [\#71](https://github.com/amalagaura/camunda-workflow/pull/71) ([amalagaura](https://github.com/amalagaura))
+- Remove Gemfile.lock [\#70](https://github.com/amalagaura/camunda-workflow/pull/70) ([amalagaura](https://github.com/amalagaura))
+- Update Nokogiri [\#69](https://github.com/amalagaura/camunda-workflow/pull/69) ([amalagaura](https://github.com/amalagaura))
+- Github actions for CI [\#67](https://github.com/amalagaura/camunda-workflow/pull/67) ([amalagaura](https://github.com/amalagaura))
+- Bump rack from 2.2.4 to 2.2.6.3 [\#65](https://github.com/amalagaura/camunda-workflow/pull/65) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump postgresql from 42.2.25 to 42.3.8 in /lib/generators/camunda/spring\_boot/templates [\#60](https://github.com/amalagaura/camunda-workflow/pull/60) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump postgresql from 42.2.7 to 42.2.25 in /lib/generators/camunda/spring\_boot/templates [\#53](https://github.com/amalagaura/camunda-workflow/pull/53) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump nokogiri from 1.11.2 to 1.12.5 [\#51](https://github.com/amalagaura/camunda-workflow/pull/51) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump rexml from 3.2.4 to 3.2.5 [\#48](https://github.com/amalagaura/camunda-workflow/pull/48) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v0.3.0](https://github.com/amalagaura/camunda-workflow/tree/v0.3.0) (2021-04-07)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.2.3...v0.3.0)
+
+**Merged pull requests:**
+
+- Bump nokogiri from 1.10.10 to 1.11.2 [\#47](https://github.com/amalagaura/camunda-workflow/pull/47) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update gems [\#45](https://github.com/amalagaura/camunda-workflow/pull/45) ([amalagaura](https://github.com/amalagaura))
+- Bump rack from 2.1.1 to 2.2.3 [\#44](https://github.com/amalagaura/camunda-workflow/pull/44) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump nokogiri from 1.10.7 to 1.10.9 [\#43](https://github.com/amalagaura/camunda-workflow/pull/43) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump websocket-extensions from 0.1.4 to 0.1.5 [\#42](https://github.com/amalagaura/camunda-workflow/pull/42) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add HTTP status code for process definition start errors [\#41](https://github.com/amalagaura/camunda-workflow/pull/41) ([amalagaura](https://github.com/amalagaura))
+- Adding the ability to set an HTTP proxy for API calls [\#40](https://github.com/amalagaura/camunda-workflow/pull/40) ([dannykopping](https://github.com/dannykopping))
+- Checking if Rails is defined before calling it [\#38](https://github.com/amalagaura/camunda-workflow/pull/38) ([dannykopping](https://github.com/dannykopping))
+- Add ability to escalate user tasks and submit bpmn errors for user tasks [\#37](https://github.com/amalagaura/camunda-workflow/pull/37) ([amalagaura](https://github.com/amalagaura))
+
+## [v0.2.3](https://github.com/amalagaura/camunda-workflow/tree/v0.2.3) (2020-01-14)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.2.2...v0.2.3)
+
+**Closed issues:**
+
+- Handle BPMN errors of user tasks [\#36](https://github.com/amalagaura/camunda-workflow/issues/36)
+
 ## [v0.2.2](https://github.com/amalagaura/camunda-workflow/tree/v0.2.2) (2020-01-08)
 
 [Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.2.1...v0.2.2)
@@ -73,6 +120,13 @@
 
 - Add find\_by! to all Camunda Her models [\#14](https://github.com/amalagaura/camunda-workflow/pull/14) ([amalagaura](https://github.com/amalagaura))
 - Yarddoc documentation [\#12](https://github.com/amalagaura/camunda-workflow/pull/12) ([curatingbits](https://github.com/curatingbits))
+- Raise Submission errors if Camunda does not accept completion [\#11](https://github.com/amalagaura/camunda-workflow/pull/11) ([amalagaura](https://github.com/amalagaura))
+- Allow Poller to not exit its loop when there is a missing class and report error [\#8](https://github.com/amalagaura/camunda-workflow/pull/8) ([amalagaura](https://github.com/amalagaura))
+- Add rubocop rspec [\#6](https://github.com/amalagaura/camunda-workflow/pull/6) ([amalagaura](https://github.com/amalagaura))
+- Correct find\_by\_business\_key\_and\_task\_definition\_key! [\#5](https://github.com/amalagaura/camunda-workflow/pull/5) ([amalagaura](https://github.com/amalagaura))
+- added authentication via templates for spring\\_boot generator and Her [\#4](https://github.com/amalagaura/camunda-workflow/pull/4) ([curatingbits](https://github.com/curatingbits))
+- Refactor to return proper Her models after responses [\#3](https://github.com/amalagaura/camunda-workflow/pull/3) ([amalagaura](https://github.com/amalagaura))
+- Added tests for Camunda workflow [\#2](https://github.com/amalagaura/camunda-workflow/pull/2) ([curatingbits](https://github.com/curatingbits))
 
 ## [v0.1.3](https://github.com/amalagaura/camunda-workflow/tree/v0.1.3) (2019-12-06)
 
@@ -83,23 +137,11 @@
 - When there is a logic error in submitting a user task we are getting a MissingTask error instead [\#9](https://github.com/amalagaura/camunda-workflow/issues/9)
 - If a class does not exist, the Poller loop crashes [\#7](https://github.com/amalagaura/camunda-workflow/issues/7)
 
-**Merged pull requests:**
-
-- Raise Submission errors if Camunda does not accept completion [\#11](https://github.com/amalagaura/camunda-workflow/pull/11) ([amalagaura](https://github.com/amalagaura))
-- Allow Poller to not exit its loop when there is a missing class and report error [\#8](https://github.com/amalagaura/camunda-workflow/pull/8) ([amalagaura](https://github.com/amalagaura))
-- Add rubocop rspec [\#6](https://github.com/amalagaura/camunda-workflow/pull/6) ([amalagaura](https://github.com/amalagaura))
-
 ## [v0.1.2](https://github.com/amalagaura/camunda-workflow/tree/v0.1.2) (2019-11-27)
 
 [Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/fc9ab266909628118a892082abdff953f3bc7eca...v0.1.2)
 
-**Merged pull requests:**
-
-- Correct find\_by\_business\_key\_and\_task\_definition\_key! [\#5](https://github.com/amalagaura/camunda-workflow/pull/5) ([amalagaura](https://github.com/amalagaura))
-- added authentication via templates for spring\\_boot generator and Her [\#4](https://github.com/amalagaura/camunda-workflow/pull/4) ([curatingbits](https://github.com/curatingbits))
-- Refactor to return proper Her models after responses [\#3](https://github.com/amalagaura/camunda-workflow/pull/3) ([amalagaura](https://github.com/amalagaura))
-- Added tests for Camunda workflow [\#2](https://github.com/amalagaura/camunda-workflow/pull/2) ([curatingbits](https://github.com/curatingbits))
-
 
 
 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+

data/README.md

@@ -5,7 +5,7 @@
 
 ## An opinionated interface to Camunda for Ruby/Rails apps
 
-Camunda Workflow uses [Her](https://github.com/remiprev/her) to communicate with the [Camunda REST API](https://docs.camunda.org/manual/latest/reference/rest/). It executes [External Service Tasks](https://docs.camunda.org/manual/latest/user-guide/process-engine/external-tasks/) using a Ruby class corresponding to each Camunda external task.
+Camunda Workflow uses [Spyke](https://github.com/balvig/spyke) to communicate with the [Camunda REST API](https://docs.camunda.org/manual/latest/reference/rest/). It executes [External Service Tasks](https://docs.camunda.org/manual/latest/user-guide/process-engine/external-tasks/) using a Ruby class corresponding to each Camunda external task.
 
 
 ## Camunda Integration with Ruby

data/lib/camunda/deployment.rb

@@ -6,7 +6,8 @@
 # @note You must supply the paths of the BPMN files as a param titled file_names to deploy the BPMN file
 # and deploy BPMN, DMN, CMMN definitions in the Camunda engine.
 class Camunda::Deployment < Camunda::Model
-  collection_path 'deployment'
+  uri 'deployment/(:id)'
+
   # Deploys a new process definition to Camunda and returns an instance of Camunda::ProcessDefinition.
   # @note Only supporting .create which uses a POST on deployment/create.
   # @example
@@ -20,10 +21,9 @@ class Camunda::Deployment < Camunda::Model
     deployment_name ||= file_names.map { |file_name| File.basename(file_name) }.join(", ")
     tenant_id ||= Camunda::Workflow.configuration.tenant_id
     args = file_data(file_names).merge('deployment-name' => deployment_name, 'deployment-source' => deployment_source)
-    args.merge!("tenant-id": tenant_id) if tenant_id
-    response = post_raw('deployment/create', args)
-
-    deployed_process_definitions(response[:parsed_data][:data][:deployed_process_definitions])
+    args.merge!('tenant-id': tenant_id) if tenant_id
+    response = request(:post, "deployment/create", args)
+    deployed_process_definitions(response.body[:data][:deployed_process_definitions])
   end
 
   # Convenience method for dealing with files and IO that are to be uploaded
@@ -47,4 +47,8 @@ class Camunda::Deployment < Camunda::Model
 
     definitions_hash.values.map { |process_definition| Camunda::ProcessDefinition.new process_definition }
   end
+
+  def destroy(params={})
+    self.attributes = delete(params)
+  end
 end

data/lib/camunda/external_task.rb

@@ -14,9 +14,13 @@ require 'active_support/backtrace_cleaner'
 class Camunda::ExternalTask < Camunda::Model
   # Camunda engine doesn't searching on snake_case variables.
   include Camunda::VariableSerialization
-  # collection_path sets the path for Her in Camunda::Model
-  collection_path 'external-task'
-  custom_post :fetchAndLock, :unlock
+  uri 'external-task/(:id)'
+
+  %i[fetchAndLock unlock].each do |name|
+    define_singleton_method(name) do |hash|
+      with("external-task/#{name}").where(hash).post
+    end
+  end
 
   # @note long_polling_duration is defaulted to 30 seconds in Camunda::Workflow.configuration.
   # @return [Integer] default polling duration from Camunda::Workflow configuration
@@ -40,29 +44,27 @@ class Camunda::ExternalTask < Camunda::Model
   # @param input_variables [Hash] process variables
   def failure(exception, input_variables={})
     variables_information = "Input variables are #{input_variables.inspect}\n\n" if input_variables.present?
-    self.class.post_raw("#{collection_path}/#{id}/failure",
-                        workerId: worker_id, errorMessage: exception.message,
-                        errorDetails:
-                          variables_information.to_s + exception.message +
-                          backtrace_cleaner.clean(exception.backtrace).join("\n"))[:response]
+    self.class.request(:post, "external-task/#{id}/failure", workerId: worker_id, errorMessage: exception.message,
+                                                             errorDetails:
+                    variables_information.to_s + exception.message +
+                    backtrace_cleaner.clean(exception.backtrace).join("\n"))
   end
 
   # Reports the error to Camunda and creates an incident for the process instance.
   # @param bpmn_exception [Camunda::BpmnError]
   def bpmn_error(bpmn_exception)
-    self.class.post_raw("#{collection_path}/#{id}/bpmnError",
-                        workerId: worker_id, variables: serialize_variables(bpmn_exception.variables),
-                        errorCode: bpmn_exception.error_code, errorMessage: bpmn_exception.message)[:response]
+    self.class.request(:post, "external-task/#{id}/bpmnError",
+                       workerId: worker_id, variables: serialize_variables(bpmn_exception.variables),
+                       errorCode: bpmn_exception.error_code, errorMessage: bpmn_exception.message)
   end
 
   # Completes the process instance of a fetched task
   # @param variables [Hash] submitted when starting the process definition
   # @raise [Camunda::ExternalTask::SubmissionError] if Camunda does not accept the task submission
   def complete(variables={})
-    self.class.post_raw("#{collection_path}/#{id}/complete",
-                        workerId: worker_id, variables: serialize_variables(variables))[:response]
-        .tap do |response|
-      raise SubmissionError, response.body[:data][:message] unless response.success?
+    self.class.request(:post, "external-task/#{id}/complete", workerId: worker_id,
+                                                              variables: serialize_variables(variables)).tap do |response|
+      raise SubmissionError, response.errors["message"] unless response.errors.blank?
     end
   end
 
@@ -73,12 +75,6 @@ class Camunda::ExternalTask < Camunda::Model
     self.class.worker_id
   end
 
-  # Helper method for instances since collection_path is a class method
-  # @return [String]
-  def collection_path
-    self.class.collection_path
-  end
-
   # deserializes JSON attributes from variables returned by Camunda API
   def variables
     super.transform_values do |details|
@@ -145,7 +141,8 @@ class Camunda::ExternalTask < Camunda::Model
   # @param long_polling_duration [Integer]
   # @return [Camunda::ExternalTask]
   def self.fetch_and_queue(topics, lock_duration: nil, long_polling_duration: nil)
-    fetch_and_lock(topics, lock_duration: lock_duration, long_polling_duration: long_polling_duration).each do |task|
+    response = fetch_and_lock(topics, lock_duration: lock_duration, long_polling_duration: long_polling_duration)
+    response.each do |task|
       task.queue_task
     rescue Camunda::MissingImplementationClass => e
       task.failure(e)

data/lib/camunda/incident.rb

@@ -2,5 +2,5 @@
 # that happen in the process engine. Such incidents usually indicate some kind of problem
 # related to process execution. Incidents are reported on failures that occur.
 class Camunda::Incident < Camunda::Model
-  collection_path 'incident'
+  uri 'incident/(:id)'
 end

data/lib/camunda/model.rb

@@ -1,43 +1,12 @@
-require 'her/model'
-# This class in the main element of Her. It defines which API models will be bound to.
-class Camunda::Model
-  include Her::Model
-
-  def self.log_details?
-    defined?(Rails) && Rails.env.development?
-  end
-
-  # We use a lambda so that this is evaluated after Camunda::Workflow.configuration is set
-  api = lambda do
-    # Configuration for Her and Faraday requests and responses
-    Her::API.new(url: File.join(Camunda::Workflow.configuration.engine_url)) do |c|
-      c.path_prefix = Camunda::Workflow.configuration.engine_route_prefix
-      # Request
-      c.use Faraday::Request::Multipart
-      c.use FaradayMiddleware::EncodeJson
-      c.use Faraday::Request::BasicAuthentication, Camunda::Workflow.configuration.camunda_user,
-            Camunda::Workflow.configuration.camunda_password
-      # Response
-      c.use Faraday::Response::Logger, ActiveSupport::Logger.new($stdout), bodies: true if log_details?
-      c.use Her::Middleware::FirstLevelParseJSON
-
-      c.use Her::Middleware::SnakeCase
-      # Adapter
-      c.adapter :net_http
-
-      # HTTP proxy
-      c.proxy = Camunda::Workflow.configuration.http_proxy if Camunda::Workflow.configuration.http_proxy
-    end
-  end
-
-  use_api api
-
+require 'spyke/base'
+# This class in the main element of Spyke. It defines which API models will be bound to.
+class Camunda::Model < Spyke::Base
   # Returns result of find_by but raises an exception instead of returning nil
   # @param params [Hash] query parameters
   # @return [Camunda::Model]
   # @raise [Camunda::Model::RecordNotFound] if query returns no results
   def self.find_by!(params)
-    find_by(params).tap do |result|
+    with(base_path).where(params).first.tap do |result|
       raise Camunda::Model::RecordNotFound unless result
     end
   end
@@ -49,6 +18,10 @@ class Camunda::Model
     Camunda::Workflow.configuration.worker_id
   end
 
+  def self.base_path
+    uri.sub("(:id)", '')
+  end
+
   class RecordNotFound < StandardError
   end
 end

data/lib/camunda/process_definition.rb

@@ -6,7 +6,7 @@
 # @see Camunda::ProcessInstance
 class Camunda::ProcessDefinition < Camunda::Model
   include Camunda::VariableSerialization
-  collection_path 'process-definition'
+  uri 'process-definition/(:id)'
   # Starts an individual process instance by key and supplies process variables to be included in the process instance. In
   # the example below a business key is provided. A business key is a domain-specific identifier of a process instance,
   # it makes querying for task more efficient. The business key is displayed prominently in applications like Camunda Cockpit.
@@ -22,7 +22,7 @@ class Camunda::ProcessDefinition < Camunda::Model
     tenant_id = hash.delete(:tenant_id)
     tenant_id ||= Camunda::Workflow.configuration.tenant_id
 
-    response = post_raw start_path_for_key(key, tenant_id), hash
+    response = request(:post, start_path_for_key(key, tenant_id), hash)
     process_instance_result(response)
   end
 
@@ -37,7 +37,7 @@ class Camunda::ProcessDefinition < Camunda::Model
   # @raise [Camunda::ProcessEngineException] if submission was unsuccessful
   def start(hash={})
     hash[:variables] = serialize_variables(hash[:variables]) if hash[:variables]
-    response = self.class.post_raw "process-definition/#{id}/start", hash
+    response = self.class.request(:post, "process-definition/#{id}/start", hash)
     self.class.process_instance_result(response)
   end
 
@@ -49,11 +49,8 @@ class Camunda::ProcessDefinition < Camunda::Model
   end
 
   def self.process_instance_result(response)
-    unless response[:response].status == 200
-      raise Camunda::ProcessEngineException,
-            "#{response[:parsed_data][:data][:message]} HTTP Status: #{response[:response].status}"
-    end
+    raise Camunda::ProcessEngineException, response.errors["message"] unless response.errors.blank?
 
-    Camunda::ProcessInstance.new response[:parsed_data][:data]
+    Camunda::ProcessInstance.new response.body["data"]
   end
 end

data/lib/camunda/process_instance.rb

@@ -4,11 +4,11 @@
 # @see https://docs.camunda.org/manual/7.4/user-guide/process-engine/process-engine-concepts/
 # @see Camunda::ProcessDefinition
 class Camunda::ProcessInstance < Camunda::Model
-  collection_path 'process-instance'
+  uri 'process-instance/(:id)'
   # GETs the process instance and deserializes the variables
   def variables
-    response = self.class.get_raw "process-instance/#{id}/variables"
-    deserialize_variables response[:parsed_data][:data]
+    response = self.class.request(:get, "process-instance/#{id}/variables")
+    deserialize_variables response.body[:data]
   end
 
   private

data/lib/camunda/signal.rb

@@ -5,12 +5,12 @@
 #    `Camunda::Signal.create name: 'Signal Name', variables: {foo: "bar"}`
 class Camunda::Signal < Camunda::Model
   include Camunda::VariableSerialization
-  collection_path 'signal'
+  uri 'signal/(:id)'
   # Creates a signal within the process definition on the Camunda engine
   # @param hash [Hash] variables that are sent to Camunda engine
   # @return [{Symbol => Hash,Faraday::Response}]
   def self.create(hash={})
     hash[:variables] = serialize_variables(hash[:variables]) if hash[:variables]
-    post_raw collection_path, hash
+    request :post, 'signal', hash
   end
 end

data/lib/camunda/task.rb

@@ -1,10 +1,10 @@
 # Finds tasks by business key and task definition and allows you to report a task complete and update process variables.
 # If a business key isn't supplied when creating a process definition, you can still retrieve UserTasks by using
-# the `.find_by` helper provided by Her.
+# the `.find_by` helper.
 # @see Camunda::ProcessDefinition
 # @see https://github.com/remi/her
 # @example
-#   Camunda::Task.find_by(taskDefinitionKey: 'UserTask')
+#   Camunda::Task.find_by(taskDefinitionKey: "UserTask")
 # @example
 #   # You can get all tasks with the `.all.each` helper
 #   tasks = Camunda::Task.all.each
@@ -12,10 +12,10 @@
 #   tasks.each(&:complete!)
 class Camunda::Task < Camunda::Model
   include Camunda::VariableSerialization
-  collection_path 'task'
+  uri "task/(:id)"
 
   # @example
-  #   user_task = Camunda::Task.find_by_business_key_and_task_definition_key!('WorkflowBusinessKey','UserTask')
+  #   user_task = Camunda::Task.find_by_business_key_and_task_definition_key!("WorkflowBusinessKey","UserTask")
   # @param instance_business_key [String] the process instance business key
   # @param task_key [String] id/key of the user task
   # @return [Camunda::Task]
@@ -25,36 +25,34 @@ class Camunda::Task < Camunda::Model
 
   # Complete a task and updates process variables.
   # @example
-  #   user_task = Camunda::Task.find_by_business_key_and_task_definition_key!('WorkflowBusinessKey','UserTask')
+  #   user_task = Camunda::Task.find_by_business_key_and_task_definition_key!("WorkflowBusinessKey","UserTask")
   #   user_task.complete!
   # @param vars [Hash] variables to be submitted as part of task completion
   def complete!(vars={})
-    self.class.post_raw("#{self.class.collection_path}/#{id}/complete", variables: serialize_variables(vars))[:response]
+    self.class.request(:post, "task/#{id}/complete", variables: serialize_variables(vars))
         .tap do |response|
-      raise SubmissionError, response.body[:data][:message] unless response.success?
+      raise SubmissionError, response.errors["message"] unless response.errors.blank?
     end
   end
 
   def bpmn_error!(error_code, error_message, vars={})
-    self.class
-        .post_raw("#{self.class.collection_path}/#{id}/bpmnError", errorCode: error_code, errorMessage: error_message,
-                                                                   variables: serialize_variables(vars))[:response]
+    self.class.request(:post, "task/#{id}/bpmnError", errorCode: error_code, errorMessage: error_message,
+                                                      variables: serialize_variables(vars))
         .tap do |response|
-      raise SubmissionError, response.body[:data][:message] unless response.success?
+      raise SubmissionError, response.errors["message"] unless response.errors.blank?
     end
   end
 
   def bpmn_escalation!(escalation_code, vars={})
-    self.class
-        .post_raw("#{self.class.collection_path}/#{id}/bpmnEscalation", escalationCode: escalation_code,
-                                                                        variables: serialize_variables(vars))[:response]
+    self.class.request(:post, "task/#{id}/bpmnEscalation", escalationCode: escalation_code,
+                                                           variables: serialize_variables(vars))
         .tap do |response|
-      raise SubmissionError, response.body[:data][:message] unless response.success?
+      raise SubmissionError, response.errors["message"] unless response.errors.blank?
     end
   end
 
   # Error class when the task cannot be submitted. For instance if the bpmn process expects a variable and the variable
-  # isn't supplied, Camunda will not accept the task
+  # isn"t supplied, Camunda will not accept the task
   class SubmissionError < StandardError
   end
 end

data/lib/camunda/workflow/version.rb

@@ -1,5 +1,5 @@
 module Camunda
   module Workflow
-    VERSION = '0.6.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/camunda/workflow.rb

@@ -20,6 +20,7 @@ module Camunda
     #   end'
     def self.configure
       yield(configuration)
+      initialize_connection
     end
 
     # Access the Configuration class
@@ -27,7 +28,8 @@ module Camunda
     def self.configuration
       @configuration ||= Configuration.new
     end
-    # Default instance variables configurations for Her and camunda-workflow
+
+    # Default instance variables configurations for Spyke and camunda-workflow
     class Configuration
       # Sets the deult engine url for Camunda REST Api
       # @return [String] the url for Camunda deployment
@@ -84,6 +86,27 @@ module Camunda
                      end
       end
     end
+
+    def self.log_details?
+      defined?(Rails) && Rails.env.development?
+    end
+
+    def self.initialize_connection
+      Spyke::Base.connection = Faraday.new(url: File.join(configuration.engine_url, configuration.engine_route_prefix)) do |c|
+        c.request :multipart
+        c.request :json
+        c.request :authorization, :basic, Camunda::Workflow.configuration.camunda_user,
+                  Camunda::Workflow.configuration.camunda_password
+
+        c.use Faraday::Response::Logger, ActiveSupport::Logger.new($stdout), bodies: true if log_details?
+        c.use Camunda::FirstLevelParseJSON
+        c.use Camunda::Middleware::SnakeCase
+
+        c.adapter Faraday.default_adapter
+        # HTTP proxy
+        c.proxy = Camunda::Workflow.configuration.http_proxy if Camunda::Workflow.configuration.http_proxy
+      end
+    end
   end
 end
 

data/lib/camunda.rb

@@ -1,8 +1,7 @@
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/object/blank'
-require 'her'
+require 'spyke'
 require 'faraday'
-require 'faraday_middleware'
 require 'camunda/railtie' if defined?(Rails)
 # Top level module for camunda-workflow.
 module Camunda
@@ -19,31 +18,80 @@ module Camunda
       end
     end
   end
-  ##
-  # Responsible for handling deserialization of variables.
-  class Her::Middleware::SnakeCase < Faraday::Response::Middleware
-    # Check if variables are an Array or JSON and ensure variable names are transformed back from camelCase to snake_case.
-    # @param env [Array,Hash]
-    def on_complete(env)
-      return if env[:body].blank?
 
-      json = JSON.parse(env[:body])
-      case json
-      when Array
-        json.map { |hash| transform_hash!(hash) }
-      when Hash
-        transform_hash!(json)
+  module Middleware
+    class Camunda::FirstLevelParseJSON < Faraday::Middleware
+      # Taken from Her::Middleware::FirstLevelParseJSON
+      # Parse the response body
+      #
+      # @param [String] body The response body
+      # @return [Mixed] the parsed response
+      # @private
+      def parse(body)
+        json = JSON.parse body
+        if json.respond_to?(:keys)
+          errors = json.delete(:errors)
+          metadata = json.delete(:metadata)
+        end
+        errors ||= {}
+        metadata ||= {}
+        {
+          data: json,
+          errors: errors,
+          metadata: metadata
+        }
+      end
+
+      # This method is triggered when the response has been received. It modifies
+      # the value of `env[:body]`.
+      #
+      # @param [Hash] env The response environment
+      # @private
+      def on_complete(env)
+        str = case env[:status]
+              when 204
+                '{}'
+              when 200
+                env[:body]
+              when 400..599
+                env[:body] == '' ? '{}' : env[:body]
+              end
+
+        env[:body] = case env[:status]
+                     when 400..599
+                       { data: nil, metadata: {}, errors: JSON.parse(str) }
+                     else
+                       parse str
+                     end
       end
-      env[:body] = JSON.generate(json)
     end
 
-    private
+    # Responsible for handling deserialization of variables.
+    class Camunda::Middleware::SnakeCase < Faraday::Middleware
+      # Check if variables are an Array or JSON and ensure variable names are transformed back from camelCase to snake_case.
+      # @param env [Array,Hash]
+      def on_complete(env)
+        return if env[:body].blank?
+
+        json = JSON.parse(env[:body])
+        case json
+        when Array
+          json.map { |hash| transform_hash!(hash) }
+        when Hash
+          transform_hash!(json)
+        end
+        env[:body] = JSON.generate(json)
+      end
+
+      private
 
-    # Return a new hash with all keys converted by the block operation.
-    def transform_hash!(hash)
-      hash.deep_transform_keys!(&:underscore)
+      # Return a new hash with all keys converted by the block operation.
+      def transform_hash!(hash)
+        hash.deep_transform_keys!(&:underscore)
+      end
     end
   end
+
   # Error when class corresponding to Camunda bpmn task does not exist.
   class MissingImplementationClass < StandardError
     # Initializes message for MissingImplementationClass
@@ -51,9 +99,11 @@ module Camunda
       super "Class to run a Camunda activity does not exist. Ensure there is a class with name: #{class_name} available."
     end
   end
+
   # Error when deployment of process definition fails.
   class ProcessEngineException < StandardError
   end
+
   # Error when BPMN process cannot be deployed.
   class BpmnError < StandardError
     # Camunda BPMN error code

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camunda-workflow
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ankur Sethi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,42 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: spyke
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 7.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: her
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 7.1.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -68,61 +54,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: pry-rescue
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9.3
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9.3
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.2
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.2
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +227,8 @@ files:
 homepage: https://github.com/amalagaura/camunda-workflow
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: