camunda-workflow 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26afcbe78e6942a4b7871af82ed02b95b4023ffbd3ed9f1cda282bb5637e3d94
-  data.tar.gz: 11fd425078ce229b16195172e479aae6031d304463a8f084998ec23060b76d79
+  metadata.gz: 59fd3142d352f68570b4fc0ad558e0853035f733127e11fd384e3b1749103423
+  data.tar.gz: 20d53613e7b3d4d81cc3221d9f4bfce1cec3f80d017448cf05bc29e19f26297a
 SHA512:
-  metadata.gz: 9e680bb4ef2e5f6cc8fd31e0087091970a23585911fb3b7d61636b2b68d963b3da333f7da635a8f34a92210bf1bed1e7b95ac002753242ca836d281183eb9bff
-  data.tar.gz: 6ac54d4e5de0629529e30aeab2ffc7651794395950f49411be4e0ddab8c405e50090439568ab59850dc2dfdbfe52bdd7eb61ac1e64cb74223fb2bc6cc51d6f24
+  metadata.gz: 4cf2d0f7ac7bb1ced5bf8d8f840fecf238d9202788c283da01794c1857926a4882fa60a065c3ca2cda094c0eed81afff09592202aeaf84ee28d298e67c2169c9
+  data.tar.gz: 81f51922568cda9e16826715f8fd209859a2a3ab14bf74c3767eeb2b1e60655830e301e795478f76fe9d45af22c3b1650d4a7afd3e37a89629946b6c478d7890

data/README.md

@@ -153,7 +153,7 @@ It will fail to start. Create a postgres database as a service in PCF and bind i
 
 ## Usage
 
- ### Add to your Gemfile
+### Add to your Gemfile
 ```ruby
   gem 'camunda-workflow'
 ```
@@ -198,6 +198,16 @@ Poller will need to run in a separate process or thread and needs to be running
  Camunda::Poller.fetch_and_queue %w[CamundaWorkflow]
  ```
 
+#### Running the poller in a separate thread
+We have had success with running a long running thread in a Rails app using [Rufus Scheduler](https://github.com/jmettraux/rufus-scheduler). Something like:
+
+```
+rufus_scheduler.in('10.seconds') do
+  Camunda::Poller.fetch_and_queue %w[Topics]
+end
+```
+
+
 #### Fetch tasks For testing from the console
 
 ```ruby

data/lib/camunda.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/string/inflections.rb'
-require 'active_support/core_ext/object/blank.rb'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/blank'
 require 'her'
 require 'faraday'
 require 'faraday_middleware'
@@ -10,6 +10,7 @@ module Camunda
   class << self
     # Allows setting the logger to a custom logger
     attr_writer :logger
+
     # Default is output to the standard output stream.
     # @return [Object] instance which is used for logging
     def logger
@@ -27,9 +28,10 @@ module Camunda
       return if env[:body].blank?
 
       json = JSON.parse(env[:body])
-      if json.is_a?(Array)
+      case json
+      when Array
         json.map { |hash| transform_hash!(hash) }
-      elsif json.is_a?(Hash)
+      when Hash
         transform_hash!(json)
       end
       env[:body] = JSON.generate(json)

data/lib/camunda/external_task.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/string/inflections.rb'
+require 'active_support/core_ext/string/inflections'
 require 'active_support/backtrace_cleaner'
 # External Tasks are the task entity for camunda. We can query the topic and lock the task. After the task
 # is locked, the external task of the process instance can be worked and completed. Below is an excerpt from the Camunda
@@ -133,6 +133,25 @@ class Camunda::ExternalTask < Camunda::Model
                  topics: topic_details
   end
 
+  # Locking means that the task is reserved for this worker for a certain duration beginning with the time of fetching and
+  # prevents that another worker can fetch the same task while the lock is valid. Locking duration is set in the the
+  # Camunda::Workflow configuration. Before an external task can be completed, it must be locked.
+  #
+  # This method calls fetch_and_lock and then queues the jobs that were retrieved
+  # @example
+  #   task = Camunda::ExternalTask.fetch_and_queue("CamundaWorkflow")
+  # @param topics [Array<String>] definition keys
+  # @param lock_duration [Integer]
+  # @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|
+      task.queue_task
+    rescue Camunda::MissingImplementationClass => e
+      task.failure(e)
+    end
+  end
+
   # Returns the class name which is supposed to implement this task
   # @return [String] modularized class name of bpmn task implementation
   def task_class_name

data/lib/camunda/model.rb

@@ -3,6 +3,10 @@ require 'her/model'
 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
@@ -14,12 +18,15 @@ class Camunda::Model
       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 Rails.env.development?
+      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
 

data/lib/camunda/poller.rb

@@ -15,12 +15,7 @@ class Camunda::Poller
   # @param long_polling_duration [Integer] long polling time, default is set to Camunda::Workflow.configuration
   def self.fetch_and_queue(topics, lock_duration: nil, long_polling_duration: nil)
     loop do
-      Camunda::ExternalTask
-        .fetch_and_lock(topics, lock_duration: lock_duration, long_polling_duration: long_polling_duration).each do |task|
-        task.queue_task
-      rescue Camunda::MissingImplementationClass => e
-        task.failure(e)
-      end
+      Camunda::ExternalTask.fetch_and_queue(topics, lock_duration: lock_duration, long_polling_duration: long_polling_duration)
     end
   end
 end

data/lib/camunda/process_definition.rb

@@ -23,9 +23,7 @@ class Camunda::ProcessDefinition < Camunda::Model
     tenant_id ||= Camunda::Workflow.configuration.tenant_id
 
     response = post_raw start_path_for_key(key, tenant_id), hash
-    raise Camunda::ProcessEngineException, response[:parsed_data][:data][:message] unless response[:response].status == 200
-
-    Camunda::ProcessInstance.new response[:parsed_data][:data]
+    process_instance_result(response)
   end
 
   # Starts an individual process instance for a process definition. The below example shows how to start a process
@@ -40,9 +38,7 @@ class Camunda::ProcessDefinition < Camunda::Model
   def start(hash={})
     hash[:variables] = serialize_variables(hash[:variables]) if hash[:variables]
     response = self.class.post_raw "process-definition/#{id}/start", hash
-    raise Camunda::ProcessEngineException, response[:parsed_data][:data][:message] unless response[:response].status == 200
-
-    Camunda::ProcessInstance.new response[:parsed_data][:data]
+    self.class.process_instance_result(response)
   end
 
   # Sets path to include tenant_id if a tenant_id is provided with a process definition on deployment.
@@ -51,4 +47,13 @@ class Camunda::ProcessDefinition < Camunda::Model
     path << "/tenant-id/#{tenant_id}" if tenant_id
     "#{path}/start"
   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
+
+    Camunda::ProcessInstance.new response[:parsed_data][:data]
+  end
 end

data/lib/camunda/variable_serialization.rb

@@ -41,9 +41,10 @@ module Camunda
       # @param json [Array,Hash]
       # @return [Hash] returns hash with camelCase keys
       def transform_json(json)
-        if json.is_a?(Array)
+        case json
+        when Array
           json.map { |element| transform_json(element) }
-        elsif json.is_a?(Hash)
+        when Hash
           camelcase_keys(json)
         else
           json

data/lib/camunda/workflow.rb

@@ -11,7 +11,7 @@ module Camunda
     # Implements Configuration class and sets default instance variables. The default variables can be overridden by creating an
     # initializer file within your rails application and setting the variables like in the example below.
     # @note if HTTP Basic Auth is used with the Camunda engine, this is where you would set a camunda_user and camunda_password
-    # using the creditials from a user setup in Camunda Admin.
+    # using the credentials from a user setup in Camunda Admin.
     # @example
     #   'Camunda::Workflow.configure do |config|
     #     config.engine_url = 'http://localhost:8080'
@@ -64,6 +64,9 @@ module Camunda
       # Can configure the backtrace silencer
       # @return [Array<String>] List of backtrace silencer strings which are used to clean incident backtraces
       attr_accessor :backtrace_silencer_lines
+      # Configure an HTTP proxy for all requests to use
+      # @return [String] The defined HTTP proxy
+      attr_accessor :http_proxy
 
       def initialize
         @engine_url = 'http://localhost:8080'

data/lib/camunda/workflow/version.rb

@@ -1,5 +1,5 @@
 module Camunda
   module Workflow
-    VERSION = '0.2.3'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/generators/camunda/spring_boot/spring_boot_generator.rb

@@ -35,9 +35,7 @@ module Camunda
         ignores << '.cfignore' if File.exist?('.cfignore')
         ignores.each do |file|
           append_to_file file do
-            "\n# BPMN Java app\n" +
-              File.join(java_app_path, 'target') +
-              "\n"
+            "\n# BPMN Java app\n#{File.join(java_app_path, 'target')}\n"
           end
         end
       end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: camunda-workflow
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ankur Sethi
 - Duggan Roberts
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-11-22 00:00:00.000000000 Z
@@ -242,7 +242,7 @@ homepage: https://github.com/amalagaura/camunda-workflow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Opinionated Ruby integration with Camunda
 test_files: []