camunda-workflow 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f9e45eda5edf72f257ab51baba32f2220b0827a288d7a8b2ab273ff2835738
-  data.tar.gz: db225b2cda8437c4bec69cf70f351037174c35bef5a0dbf57155162e813ff996
+  metadata.gz: 59fd3142d352f68570b4fc0ad558e0853035f733127e11fd384e3b1749103423
+  data.tar.gz: 20d53613e7b3d4d81cc3221d9f4bfce1cec3f80d017448cf05bc29e19f26297a
 SHA512:
-  metadata.gz: 184e3cca0f5ac05638470045b50aa053a7f31ff36be976e8ed429d5bdd6b4270643e8b2d79d38fb448f8d256ce5d6e7f8c9b303e12451c43e05609ac174e2344
-  data.tar.gz: 73b2bb72fa227bf85cd9fe5f9d54e3f61040b9760d0157d43ea90530de12fb4856b51aa7869fd45aeffb13cdfa84b2fc509b803a255af2352edc6ca47c25f72f
+  metadata.gz: 4cf2d0f7ac7bb1ced5bf8d8f840fecf238d9202788c283da01794c1857926a4882fa60a065c3ca2cda094c0eed81afff09592202aeaf84ee28d298e67c2169c9
+  data.tar.gz: 81f51922568cda9e16826715f8fd209859a2a3ab14bf74c3767eeb2b1e60655830e301e795478f76fe9d45af22c3b1650d4a7afd3e37a89629946b6c478d7890

data/CHANGELOG.md

@@ -1,5 +1,66 @@
 # Changelog
 
+## [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)
+
+**Closed issues:**
+
+- The task for Message End Events is on the parent node of camunda:type="external" [\#34](https://github.com/amalagaura/camunda-workflow/issues/34)
+- Error in documentation regarding deployment of BPMN files.  [\#32](https://github.com/amalagaura/camunda-workflow/issues/32)
+
+**Merged pull requests:**
+
+- Camunda calls the external task from bpmn:endEvent [\#35](https://github.com/amalagaura/camunda-workflow/pull/35) ([amalagaura](https://github.com/amalagaura))
+- fixed documentation on README [\#33](https://github.com/amalagaura/camunda-workflow/pull/33) ([curatingbits](https://github.com/curatingbits))
+
+## [v0.2.1](https://github.com/amalagaura/camunda-workflow/tree/v0.2.1) (2019-12-28)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.2.0...v0.2.1)
+
+**Closed issues:**
+
+- Include gems via Railtie instead of by copying the .rake file [\#29](https://github.com/amalagaura/camunda-workflow/issues/29)
+- Remove check for what bpmn\_perform returns. Ignore if not a hash. [\#27](https://github.com/amalagaura/camunda-workflow/issues/27)
+
+**Merged pull requests:**
+
+- Remove startup error instructions [\#31](https://github.com/amalagaura/camunda-workflow/pull/31) ([amalagaura](https://github.com/amalagaura))
+- create railtie to include rake tasks [\#30](https://github.com/amalagaura/camunda-workflow/pull/30) ([curatingbits](https://github.com/curatingbits))
+
+## [v0.2.0](https://github.com/amalagaura/camunda-workflow/tree/v0.2.0) (2019-12-20)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.1.5...v0.2.0)
+
+**Closed issues:**
+
+- Change the diagrams symlink to resources and change the symlink structure  [\#25](https://github.com/amalagaura/camunda-workflow/issues/25)
+- remove listen note since it seems to have gone away [\#23](https://github.com/amalagaura/camunda-workflow/issues/23)
+- Rename fetch\_and\_execute to fetch\_and\_queue [\#22](https://github.com/amalagaura/camunda-workflow/issues/22)
+- Add a backtrace silencer to remove extra backtrace information from exceptions reported to Camunda [\#18](https://github.com/amalagaura/camunda-workflow/issues/18)
+
+**Merged pull requests:**
+
+- Ignore if a Hash is not returned from bpmn\_perform [\#28](https://github.com/amalagaura/camunda-workflow/pull/28) ([amalagaura](https://github.com/amalagaura))
+- Change symlink structure and change bpmn/diagrams to bpmn/resources [\#26](https://github.com/amalagaura/camunda-workflow/pull/26) ([amalagaura](https://github.com/amalagaura))
+- Change fetch\_and\_execute to fetch\_and\_queue [\#24](https://github.com/amalagaura/camunda-workflow/pull/24) ([amalagaura](https://github.com/amalagaura))
+- Add backtrace cleaner to only relevant lines for error incidents [\#21](https://github.com/amalagaura/camunda-workflow/pull/21) ([amalagaura](https://github.com/amalagaura))
+
+## [v0.1.5](https://github.com/amalagaura/camunda-workflow/tree/v0.1.5) (2019-12-19)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.1.4...v0.1.5)
+
+**Closed issues:**
+
+- Add some more screenshots [\#16](https://github.com/amalagaura/camunda-workflow/issues/16)
+
+**Merged pull requests:**
+
+- Upgrading gems and changing bpmn error message [\#20](https://github.com/amalagaura/camunda-workflow/pull/20) ([amalagaura](https://github.com/amalagaura))
+- Rake feature [\#19](https://github.com/amalagaura/camunda-workflow/pull/19) ([curatingbits](https://github.com/curatingbits))
+- Update readme with screenshots [\#17](https://github.com/amalagaura/camunda-workflow/pull/17) ([amalagaura](https://github.com/amalagaura))
+- Add assert scenario test for sample.bpmn [\#15](https://github.com/amalagaura/camunda-workflow/pull/15) ([curatingbits](https://github.com/curatingbits))
+
 ## [v0.1.4](https://github.com/amalagaura/camunda-workflow/tree/v0.1.4) (2019-12-11)
 
 [Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/v0.1.3...v0.1.4)
@@ -26,6 +87,7 @@
 
 - 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)
 
@@ -33,7 +95,6 @@
 
 **Merged pull requests:**
 
-- 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))

data/CONTRIBUTING.md

@@ -7,7 +7,7 @@ Make sure whatever you are adding has specs. We should be able to maintain 100%
 
 ### Camunda interactions
 
-We are using VCR to record interactions with a local Camunda engine. If you wish to try this run a camunda engine listening on `/rest`. `/rest` is the default of the spring boot application that we generate with this gem. This is different from the default `/rest-engine` of the default downloadable distribution.
+We are using VCR to record interactions with a local Camunda engine. 
 
 You can for instance upgrade the Camunda version, delete the `spec/vcr` folder and then re-run the specs with `bundle exec rspec`
 
@@ -17,4 +17,4 @@ This project is in the worldwide [public domain](LICENSE.md). As stated in [CONT
 
 > This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
 >
-> All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
+> All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

data/README.md

@@ -1,136 +1,142 @@
-[![Build Status](https://travis-ci.com/amalagaura/camunda-workflow.svg?branch=master)](https://travis-ci.com/amalagaura/camunda-workflow) 
+[![Build Status](https://travis-ci.com/amalagaura/camunda-workflow.svg?branch=master)](https://travis-ci.com/amalagaura/camunda-workflow)
 [![Gem Version](https://badge.fury.io/rb/camunda-workflow.svg)](https://badge.fury.io/rb/camunda-workflow)
 [![Inline docs](http://inch-ci.org/github/amalagaura/camunda-workflow.svg?branch=master)](http://inch-ci.org/github/amalagaura/camunda-workflow)
 # Camunda Workflow
 
 ## An opinionated interface to Camunda for Ruby/Rails apps
 
-[Her](https://github.com/remiprev/her) is used to communicate with the [Camunda REST API](https://docs.camunda.org/manual/latest/reference/rest/) with a Ruby class corresponding to a Camunda external task.  
+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.
 
-### Add to your Gemfile
-```ruby
-  gem 'camunda-workflow'
-```
 
 ## Camunda Integration with Ruby
-The process definitions key becomes the module name of your implementation classes and must be set to the name of a ruby style constant. 
-    
-![image](https://user-images.githubusercontent.com/498234/70742441-899ecf00-1ceb-11ea-9eb8-42dbb08dbd2d.png)
 
+The Camunda model process definition key is the module name of your implementation classes.
 
-An external task is created with a Ruby class name for the id. And the process definition key should be set as the topic name. 
+  ![image](https://user-images.githubusercontent.com/498234/71268690-82934480-231b-11ea-9c58-0500b7ace028.png)
 
-![image](https://user-images.githubusercontent.com/498234/70742635-fd40dc00-1ceb-11ea-8518-0fa5f6ea8028.png)
+An external task is created with a Ruby class name for the id. And the process definition key should be set as the topic name.
 
-Tasks are pulled and fetched and locked and then run. We expect classes (ActiveJob) to implement each external task.
+![image](https://user-images.githubusercontent.com/498234/71268753-af475c00-231b-11ea-8b39-89d2f306539b.png)
+
+Tasks are fetched, locked and then queued. We expect classes (ActiveJob) to implement each external task. So, according to the above screenshots, the poller and queuer will expect a class called `SomeProcess::SomeTask` to be implemented in your app.
 
 ### Integration with your worker classes
 
-The module `ExternalTaskJob` should be included in your job implementation classes. The job implementation classes can inherit from `ActiveJob::Base`, or use `Sidekiq::Worker` or use some other system for job queuing.
+Worker classes should inherit from `CamundaJob`. It is generated with `rails g camunda:install`.
 
-Currently we call `perform_later` on job implementation classes. If we want to make this more flexible, we need to make the method used to queue jobs configurable. `perform_later` for ActiveJob, `perform_async` for Sidekiq, or `perform` if no background task system is used.
+`perform` is implemented on  `Camunda::ExternalTaskJob`. It calls `bpmn_perform` with variables from Camunda and returns the results back to Camunda.
+```
+class CamundaJob < ApplicationJob
+  # If using Sidekiq, change to include Sidekiq::Worker instead of inheriting from ApplicationJob
+  include Camunda::ExternalTaskJob
+end
 
-### Implementing `bpmn_perform`
+class SomeProcess::SomeTask < CamundaJob
+  def bpmn_perform(variables)
+    do_something(variables[:foo])
 
-`bpmn_perform` is your implementation of the service task.
+    # A hash returned will become variables in the Camunda BPMN process instance
+    { foo: 'bar', foo2: { json: "str" }, array_var: ["str"] }
+  end
+end
+```
 
+### Exceptions create Camunda incidents
+If your implementation throws an exception, it is caught and then sent to Camunda with a stack trace.
+![image](https://user-images.githubusercontent.com/498234/71266361-35f93a80-2316-11ea-96ed-6501ef68f849.png)
+
+![image](https://user-images.githubusercontent.com/498234/71269561-a22b6c80-231d-11ea-80af-b748ba7eb09a.png)
 ### Supporting bpmn exceptions
 
-Camunda supports throwing bpmn exceptions on a service task to communicate logic errors and not underlying code errors. These expected errors are thrown with 
+Camunda supports throwing bpmn exceptions on a service task to communicate logic errors and not underlying code errors. These expected errors are thrown with
 ```ruby
-raise Camunda::BpmnError.new error_code: 'bpmn-error', message: "Special BPMN error", variables: { bpmn: 'error' }
+class SomeProcess::SomeTask < CamundaJob
+  def bpmn_perform(variables)
+    result = do_something(variables[:foo])
+
+    if result == :expected
+      { foo: 'bar', foo2: { json: "str" }, array_var: ["str"] }
+    else
+      raise Camunda::BpmnError.new error_code: 'bpmn-error', message: "Special BPMN error", variables: { bpmn: 'error' }
+    end
+  end
+end
 ```
 
 ## Generators
 
-### BPMN ActiveJob install
+### Java Spring Boot App install
 ```bash
-rails generate camunda:install
+rails generate camunda:spring_boot
 ```
+Creates a skeleton Java Spring Boot app, which also contains the minimal files to run unit tests on a BPMN file. The Spring boot app can be used to
+start a Camunda instance with a REST api and also be deployed to PCF by generating a Spring Boot jar and pushing it.
 
-Creates `app/jobs/camunda_job.rb`. A class which inherits from ApplicationJob and includes `ExternalTaskJob`. It can be changed to include
- Sidekiq::Worker instead.  
-
-All of the BPMN worker classes will inherit from this class
-
-### Java Spring Boot App install
+ ### BPMN ActiveJob install
 ```bash
-rails generate camunda:spring_boot
+rails generate camunda:install
 ```
-Creates a skeleton Java Spring Boot app, which also contains the minimal files to run unit tests on a BPMN file. This can be used to
-start a Camunda instance with a REST api. This can also be deployed to PCF by generating a Spring Boot jar and pushing it.
+Creates `app/jobs/camunda_job.rb`. A class that inherits from ApplicationJob and includes `ExternalTaskJob`. It can be changed to include  `Sidekiq::Worker` instead.
+
+All of the BPMN worker classes will inherit from this class
 
 ### BPMN Classes
 ```bash
 rails generate camunda:bpmn_classes
 ```
-
-Parses the BPMN file and creates task classes according to the ID of the process file and the ID of 
-each task. It checks each task and only creates it if the topic name is the same as the process ID. This 
-allows one to have some tasks be handled outside the Rails app. It confirms that the ID's are valid Ruby constant names. 
+Parses the BPMN file and creates task classes according to the ID of the process file and the ID of each task. It checks each task and only creates it if the topic name is the same as the process ID. This allows one to have some tasks be handled outside the Rails app. It confirms that the ID's are valid Ruby constant names.
 
 #### Starting the Camunda server for development
 
-[Java 7](https://www.java.com/en/) and [Apache Maven](https://maven.apache.org/install.html) are requirements to run 
-[Spring](https://docs.spring.io/spring-boot/docs/1.5.21.RELEASE/reference/html/getting-started-system-requirements.html). 
-Make sure all requirements for Spring are satisfied before starting Camunda engine via spring boot.
+[Java 7](https://www.java.com/en/) and [Apache Maven](https://maven.apache.org/install.html) are requirements to run the Camunda server. We are using the [Spring](https://docs.spring.io/spring-boot/docs/1.5.21.RELEASE/reference/html/getting-started-system-requirements.html) distribution.  The Camunda application has a `pom.xml`, which Maven uses to install the required dependencies.
 
-Start the application: 
+Start the application:
 ```bash
- cd bpmn/java_app
-```
-```bash 
+cd bpmn/java_app
 mvn spring-boot:run
-```
-The following Rake commands are available to maintain the spring boot server. 
-
-```Bash
-# Install the spring-boot app dependencies. 
-rake camunda:install
-```
-We suggest (not required) running the install command before running the spring boot server for the first time or if the pom.xml file is updated. The 
-install cleans up artifacts created by prior builds and installs the package dependencies into the local repository.
 
-```bash
-# Start the Camunda spring boot app
+# Or use the included rake task:
+# Start the Camunda spring boot app with `mvn spring-boot:run`
 rake camunda:run
 ```
 
+If you create Java based unit tests for your bpmn file they can be run with an included rake task as well.
+
+
+#### Running java unit tests
 ```bash
-# Runs spring boot test suite
+cd bpmn/java_app
+mvn clean test
+
+# Or use the included rake task:
+# Runs spring boot test suite with `mvn clean test`
 rake camunda:test
 ```
- 
-
-Camunda-workflow defaults to an in-memory, h2 database engine. If you rather use a Postgres database engine, comment out the 
-h2 database engine settings in the `pom.xml` file located in `bpmn/java_app`. Default settings for using Postgres are available in the `pom.xml` file. 
-You will need to create a Postgres database on localhost called `camunda`. 
 
-#### Engine Route Prefix using the Java Spring Boot app
-The default engine route prefix for the provided Java Spring Boot app is `rest`. If you choose to download and use the Camunda distribution,
-the engine prefix is `rest-engine`. Camunda-workflow is configured to use `rest-engine`.
+Camunda-workflow defaults to an in-memory, h2 database engine. If you rather use a Postgres database engine, comment out the h2 database engine settings in the `pom.xml` file located in `bpmn/java_app`. Default settings for using Postgres are available in the `pom.xml` file.
+You will need to create a Postgres database on localhost called `camunda`.
 
-To override the default engine route prefix to allow your rails application to use the route prefix of `rest`, you need to add an initializer file
-in your rails app with the below code. 
+### Configuration
+#### Engine Route Prefix of the Java Spring Boot app
+The default engine route prefix for the provided Java Spring Boot app is `rest`. If you choose to download and use the Camunda distribution, the engine prefix is `rest-engine`. Camunda-workflow is configured to use `rest` by default.
 
+To override the default engine route prefix, you need to add an initializer file in your rails app.
 
 ```ruby
 # filename initializers/camunda.rb
 Camunda::Workflow.configure do |config|
-  config.engine_route_prefix = 'rest'
+  config.engine_route_prefix = 'rest-engine'
 end
 ```
 #### Enable HTTP Basic Auth for Java Spring Boot app
-To add authentication to Camunda's REST API within the Java Spring Boot app change the `camunda.authentication` variable located in the
-`application.properties` (bpmn/java_app/src/main/resources) file to `true`. Creating an environment variable `ENV['CAMUNDA_AUTH']` and setting a value of `true` or `false` will 
-set the value as well. When HTTP Basic Auth is enabled, it's required that a user with the appropriate permissions is setup in Camunda. 
-Otherwise, the request will return as `401 unauthorized`. Users are set up within the admin dashboard of Camunda and used to authenticate by passing an Authorization header during requests to the REST API. Below is how to configure 
-the `camunda_user` and `camunda_password` to be used in the header request to authenticate using HTTP Basic Auth. 
+
+Authentication can be enabled in the Camunda Java Spring Boot app by setting an environment variable `CAMUNDA_AUTH` to `true` or `false` or by setting the `camunda.authentication` variable  located in the  `application.properties` (bpmn/java_app/src/main/resources) file to `true`.
+
+When HTTP Basic Auth is enabled, it's required that a user with the appropriate permissions is setup in Camunda.  Otherwise, the request will return as `401 unauthorized`. Users are set up within the admin dashboard of Camunda and used to authenticate by passing an Authorization header during requests to the REST API. Below is how to configure the `camunda_user` and `camunda_password` to be used in the header request to authenticate using HTTP Basic Auth.
 
 ```ruby
 # filename initializers/camunda.rb
 Camunda::Workflow.configure do |config|
-  config.engine_route_prefix = 'rest'
   config.camunda_user = ENV['CAMUNDA_USER']
   config.camunda_password = ENV['CAMUNDA_PASSWORD']
 end
@@ -145,19 +151,18 @@ The jar is in `target/camunda-bpm-springboot.jar`
 
 It will fail to start. Create a postgres database as a service in PCF and bind it to the application. The Springboot application is configured for Postgres and will then be able to start.
 
-#### Running java unit tests
-```bash
-# Run in bpmn/java_app directory
-mvn clean test
+## Usage
+
+### Add to your Gemfile
+```ruby
+  gem 'camunda-workflow'
 ```
 
-## Usage
 ### Deploying a model
-Uses a default name, etc. Below outlines how to deploy a process using the included sample.bpmn
-file created by the generator. Alternatively you can deploy using Camunda Modeler
+Uses a default name, etc. Below outlines how to deploy a process using the included sample.bpmn file created by the generator. Alternatively you can deploy using Camunda Modeler
 
 ```ruby
-  Camunda::Deployment.create file_name: 'bpmn/diagrams/sample.bpmn'
+ Camunda::Deployment.create file_names: ['bpmn/diagrams/sample.bpmn']
 ```
 ### Processes
 
@@ -176,47 +181,54 @@ will be converted to:
 
 #### Destroy a process
 ```ruby
-  Camunda::ProcessInstance.destroy_existing start_response.id
-```
+ Camunda::ProcessInstance.destroy_existing start_response.id
+ ```
 
 ### Tasks
 
 #### Fetch tasks and queue with ActiveJob
 
-The poller will run as an infinite loop with long polling to fetch tasks, queue, and run them. Topic is the process definition key, 
-as show in the screenshot example from the Camunda Modeler.
+The poller runs an infinite loop with long polling to fetch tasks, queue, and run them. The topic is the process definition key, as shown in the screenshot example from the Camunda Modeler.
+
+Below will run the poller to fetch, lock, and run a task for the example process definition located in the `starting a process` detailed above.
 
-Below will run the poller to fetch, lock, and run a task for the example process definition located in 
-the `starting a process` detailed above.
+Poller will need to run in a separate process or thread and needs to be running constantly in order to poll Camunda and queue jobs.
 
 ```ruby
-  Camunda::Poller.fetch_and_execute %w[CamundaWorkflow]
+ 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
-  tasks = Camunda::ExternalTask.fetch_and_lock %w[CamundaWorkflow]
-``` 
+#### Fetch tasks For testing from the console
 
+```ruby
+tasks = Camunda::ExternalTask.fetch_and_lock %w[CamundaWorkflow]
+```
 #### Run a task
 
 ```ruby
-  tasks.each(&:run_now)
-```
+tasks.each(&:run_now)
+ ```
 
 
 ### User Tasks
 #### Mark a user task complete
 ```ruby
-  task = Camunda::Task.find_by_business_key_and_task_definition_key!(instance_business_key, task_key)
-  # Or you can query Camunda::Task with other parameters like assignee 
-  task.complete!(var1: 'value')
+ # Or you can query Camunda::Task with other parameters like assignee task.complete!(var1: 'value')
+Camunda::Task.find_by_business_key_and_task_definition_key!(instance_business_key, task_key).complete!
 ```
 
 ### Rspec Helpers
-RSpec helpers can will validate your application to make sure it has a class for every External task in a given BPMN file.
+RSpec helpers validate your application to make sure it has a class for every External task in a given BPMN file.
 ```ruby
 require 'camunda/matchers'
 
@@ -228,30 +240,6 @@ RSpec.describe "BPMN Diagrams" do
   end
 end
 ```
-#### Note: 
-
-If you get an error
-  
-        ** ERROR: directory is already being watched! **
-         
-        Directory: bpmn/java_app/src/main/resources
-        is already being watched through: bpmn/diagrams
-             
-        MORE INFO: https://github.com/guard/listen/wiki/Duplicate-directory-errors
-        
-It is because ActionMailer preview causes test/mailers/previews to get added to the Rails EventedFileChecker
-by default. RSpec is supposed to override it, but it is not
-appropriately overridden for EventedFileChecker and/or you don't have spec/mailers/preview existing. If that 
-directory does not exist, it goes to the first common directory that exists, which is your Rails root folder. 
-So EventedFileChecker is listening to your entire Rails folder. Not a big problem, but it causes a problem 
-for our created symlink.
-
-So add: 
-      
-        config.action_mailer.show_previews = false
-              
-to your `development.rb` file to solve listen errors about a symlink. Unless you are using ActionMailer 
-previews, in which case you should have the directory created already.
 
 ## Contributing
 

data/lib/camunda.rb

@@ -1,14 +1,16 @@
-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'
+require 'camunda/railtie' if defined?(Rails)
 # Top level module for camunda-workflow.
 module Camunda
   # Camunda class
   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
@@ -26,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/bpmn_xml.rb

@@ -20,9 +20,14 @@ class Camunda::BpmnXML
 
   # creates a new instance of Camunda::BpmnXML::Task
   def external_tasks
-    @doc.xpath('//*[@camunda:type="external"]').map do |task|
+    @doc.xpath('(//bpmn:serviceTask[@camunda:type="external"]|//bpmn:sendTask[@camunda:type="external"])').map do |task|
       Task.new(task)
-    end
+    end +
+      @doc.xpath('//bpmn:endEvent/bpmn:messageEventDefinition[@camunda:type="external"]').map do |child_node|
+        task = child_node.parent.dup
+        task["topic"] = child_node["topic"]
+        Task.new(task)
+      end
   end
 
   # We may have tasks with different topics. Returns classes with topics which are the same as the BPMN process id

data/lib/camunda/deployment.rb

@@ -10,7 +10,7 @@ class Camunda::Deployment < Camunda::Model
   # 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
-  #   pd = Camunda::Deployment.create(file_names: ['bpmn/diagrams/sample.bpmn']).first
+  #   pd = Camunda::Deployment.create(file_names: ['bpmn/resources/sample.bpmn']).first
   # @param files_names [Array<String>] file paths of the bpmn file for deployment
   # @param tenant_id [String] supplied when a single Camunda installation should serve more than one tenant
   # @param deployment_source [String] the source of where the deployment occurred.

data/lib/camunda/external_task.rb

@@ -1,4 +1,5 @@
-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
 # documentation regarding the ExternalTask process.
@@ -41,7 +42,9 @@ class Camunda::ExternalTask < Camunda::Model
     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.full_message)[:response]
+                        errorDetails:
+                          variables_information.to_s + exception.message +
+                          backtrace_cleaner.clean(exception.backtrace).join("\n"))[:response]
   end
 
   # Reports the error to Camunda and creates an incident for the process instance.
@@ -130,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
@@ -144,6 +166,17 @@ class Camunda::ExternalTask < Camunda::Model
       raise Camunda::MissingImplementationClass, task_class_name unless klass
     end
   end
+
+  private
+
+  def backtrace_cleaner
+    @backtrace_cleaner ||= ActiveSupport::BacktraceCleaner.new.tap do |bc|
+      Camunda::Workflow.configuration.backtrace_silencer_lines.each do |line|
+        bc.add_silencer { |exception_line| exception_line =~ /#{line}/ }
+      end
+    end
+  end
+
   # If the BPMN file expects a variable and the variable isn't supplied with an SubmissionError will be raised
   # indicating that the variable does not exist.
   class SubmissionError < StandardError

data/lib/camunda/external_task_job.rb

@@ -13,8 +13,7 @@ module Camunda::ExternalTaskJob
   # @raise [Camunda::ExternalTask::SubmissionError] if Camunda does not accept the submission of the task
   def perform(id, input_variables)
     output_variables = bpmn_perform(input_variables)
-    output_variables = {} if output_variables.nil?
-    raise ArgumentError, "Expected a hash, got #{output_variables}" unless output_variables.is_a?(Hash)
+    output_variables = {} unless output_variables.is_a?(Hash)
 
     report_completion id, output_variables
   rescue Camunda::BpmnError => e

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

@@ -1,20 +1,21 @@
 # The poller will run as an infinite loop with long polling to fetch tasks, queue, and run them.
-# Topic is the process definition key. Below will run the poller to fetch, lock, and run a task for the
+# Topic is the process definition key. Below will run the poller to fetch, lock, and queue a task for the
 # example process definition with an id of CamundaWorkflow.
 # @example
-#   Camunda::Poller.fetch_and_execute %w[CamundaWorkflow]
+#   Camunda::Poller.fetch_and_queue %w[CamundaWorkflow]
 class Camunda::Poller
+  # @deprecated Please use {#fetch_and_queue} instead
+  def self.fetch_and_execute(topics, lock_duration: nil, long_polling_duration: nil)
+    warn "[DEPRECATION] `fetch_and_execute` is deprecated.  Please use `fetch_and_queue` instead."
+    fetch_and_queue(topics, lock_duration: lock_duration, long_polling_duration: long_polling_duration)
+  end
+
   # @param topics [Array] process definition keys
   # @param lock_duration [Integer] lock duration time, default time is set in Camunda::Workflow.configuration
   # @param long_polling_duration [Integer] long polling time, default is set to Camunda::Workflow.configuration
-  def self.fetch_and_execute(topics, lock_duration: nil, long_polling_duration: nil)
+  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/railtie.rb

@@ -0,0 +1,6 @@
+module Camunda
+  # Railtie that includes rake tasks for camunda-workflow
+  class Railtie < Rails::Railtie
+    rake_tasks { load "tasks/camunda.rake" }
+  end
+end

data/lib/camunda/task.rb

@@ -35,6 +35,24 @@ class Camunda::Task < Camunda::Model
     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]
+        .tap do |response|
+      raise SubmissionError, response.body[:data][:message] unless response.success?
+    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]
+        .tap do |response|
+      raise SubmissionError, response.body[:data][:message] unless response.success?
+    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
   class SubmissionError < StandardError

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'
@@ -61,16 +61,23 @@ module Camunda
       # Camunda password is supplied with the Camunda user to authenticate using HTTP Basic Auth.
       # @return [String] Camunda password for HTTP Basic Auth
       attr_accessor :camunda_password
+      # 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'
-        @engine_route_prefix = 'rest-engine'
+        @engine_route_prefix = 'rest'
         @camunda_user = ''
         @camunda_password = ''
         @worker_id = '0'
         @lock_duration = 14.days
         @max_polling_tasks = 2
         @long_polling_duration = 30.seconds
+        @backtrace_silencer_lines = %w[gems/activesupport gems/sidekiq gems/activejob gems/i18n gems/actionpack]
         @tenant_id = if defined?(Rails)
                        Rails.env.test? ? 'test-environment' : nil
                      end

data/lib/camunda/workflow/version.rb

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

data/lib/generators/camunda/spring_boot/USAGE

@@ -9,4 +9,4 @@ Example:
 
     with a sample BPMN file and Unit Test.
 
-    The suggested location for your BPMN file is in `bpmn/diagrams`. `bpmn/java_app/src/main/resources` is a symlink to that.
+    The suggested location for your BPMN file is in `bpmn/resources` which symlinks to `bpmn/java_app/src/main/resources`.

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

@@ -5,28 +5,28 @@ module Camunda
     # Spring Boot jar and pushing it.
     class SpringBootGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
-      class_option :app_path, type: :string, default: 'bpmn/java_app'
-      class_option :diagram_path, type: :string, default: 'bpmn/diagrams'
+      class_option :bpmn_folder_name, type: :string, default: 'bpmn'
+      class_option :java_app_folder_name, type: :string, default: 'java_app'
+      class_option :resources_folder_name, type: :string, default: 'resources'
 
-      # Links resources to a top level diagrams folder
+      # Links resources to the java app resources folder
       def link_resources_folder
-        create_link File.join(bpmn_app_path, 'src/main/resources/'), File.join('../../../diagrams')
-      end
-
-      # Copies a sample bpmn file to help demonstrate the usage for camunda-workflow
-      def copy_sample_bpmn
-        copy_file 'sample.bpmn', File.join(diagram_path, 'sample.bpmn'), ''
-        copy_file 'ProcessScenarioTest.java', File.join(bpmn_app_path, 'src/test/java/unittest/ProcessScenarioTest.java')
+        create_link resources_path, File.join(java_app_folder_name, 'src/main/resources/')
       end
 
       # Copies all spring boot files into a rails application and provides a Camunda engine for testing.
       def copy_java_app_files
-        copy_file 'pom.xml', File.join(bpmn_app_path, 'pom.xml')
-        copy_file 'camunda.cfg.xml', File.join(bpmn_app_path, 'src/test/resources/camunda.cfg.xml')
-        copy_file 'logback.xml', File.join(bpmn_app_path, 'src/main/resources/logback.xml')
-        copy_file 'application.properties', File.join(bpmn_app_path, 'src/main/resources/application.properties')
-        copy_file 'Camunda.java', File.join(bpmn_app_path, 'src/main/java/camunda/Camunda.java')
-        copy_file 'camunda.rake', 'lib/tasks/camunda.rake'
+        copy_file 'pom.xml', File.join(java_app_path, 'pom.xml')
+        copy_file 'camunda.cfg.xml', File.join(java_app_path, 'src/test/resources/camunda.cfg.xml')
+        copy_file 'logback.xml', File.join(java_app_path, 'src/main/resources/logback.xml')
+        copy_file 'application.properties', File.join(java_app_path, 'src/main/resources/application.properties')
+        copy_file 'Camunda.java', File.join(java_app_path, 'src/main/java/camunda/Camunda.java')
+      end
+
+      # Copies a sample bpmn file to help demonstrate the usage for camunda-workflow
+      def copy_sample_bpmn
+        copy_file 'sample.bpmn', File.join(resources_path, 'sample.bpmn')
+        copy_file 'ProcessScenarioTest.java', File.join(java_app_path, 'src/test/java/unittest/ProcessScenarioTest.java')
       end
 
       # Add spring boot files to .gitignore
@@ -35,50 +35,31 @@ module Camunda
         ignores << '.cfignore' if File.exist?('.cfignore')
         ignores.each do |file|
           append_to_file file do
-            "\n# BPMN Java app\n" +
-              File.join(bpmn_app_path, 'target') +
-              "\n"
+            "\n# BPMN Java app\n#{File.join(java_app_path, 'target')}\n"
           end
         end
       end
 
-      # Provides instruction regarding an error with EventedFileChecker listening on the entire Rails folder.
-      def output_error_instructions
-        puts <<~DOC
-          If you get an error when starting your Rails app
-
-          ** ERROR: directory is already being watched! **
-
-          Directory: bpmn/java_app/src/main/resources
-          is already being watched through: bpmn/diagrams
-
-          MORE INFO: https://github.com/guard/listen/wiki/Duplicate-directory-errors
-
-          It is because ActionMailer preview causes test/mailers/previews to get added to the Rails EventedFileChecker
-          by default. RSpec is supposed to override it, but it is not overridden properly for EventedFileChecker and/or
-          you don't have spec/mailers/preview existing. If that directory does not exist it goes to the first common
-          directory that exists which is your Rails root folder.
-
-          So EventedFileChecker is listening to your entire Rails folder. Not a big problem, but it causes a problem
-          for our created symlink.
-
-          So add:
+      private
 
-             config.action_mailer.show_previews = false
+      def bpmn_folder_name
+        options['bpmn_folder_name']
+      end
 
-          to your development.rb file to solve Listen errors about a symlink. Unless you are using ActionMailer
-          previews in which case you should have the directory created already.
-        DOC
+      def java_app_folder_name
+        options['java_app_folder_name']
       end
 
-      private
+      def resources_folder_name
+        options['resources_folder_name']
+      end
 
-      def bpmn_app_path
-        options['app_path']
+      def resources_path
+        File.join(bpmn_folder_name, resources_folder_name)
       end
 
-      def diagram_path
-        options['diagram_path']
+      def java_app_path
+        File.join(bpmn_folder_name, java_app_folder_name)
       end
     end
   end

data/lib/generators/camunda/spring_boot/templates/pom.xml

@@ -12,10 +12,10 @@
   <description>A Process Application for [Camunda BPM](http://docs.camunda.org).</description>
 
   <properties>
-    <camunda.version>7.12.0-alpha3</camunda.version>
+    <camunda.version>7.12.0</camunda.version>
     <!--
     Adjust if you want to use Camunda Enterprise Edition (EE):
-    <camunda.version>7.11.0-ee</camunda.version>
+    <camunda.version>7.12.0-ee</camunda.version>
     Make sure you also switch to the ee webapp dependency
     and EE repository below
     -->

data/lib/{generators/camunda/spring_boot/templates → tasks}/camunda.rake

@@ -15,11 +15,6 @@ namespace :camunda do
   # Runs spring boot test suite e.g. mvn test.
   desc 'Runs test suite for Camunda spring-boot application'
   task :test do
-    system('mvn test', chdir: mvn_path)
-  end
-  # Installs the spring-boot app dependencies mvn clean install.
-  desc 'Installs spring-boot dependencies for Camunda spring-boot app.'
-  task :install do
-    system('mvn clean install -DskipTests=true', chdir: mvn_path)
+    system('mvn clean test', chdir: mvn_path)
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: camunda-workflow
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  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
@@ -215,6 +215,7 @@ files:
 - lib/camunda/poller.rb
 - lib/camunda/process_definition.rb
 - lib/camunda/process_instance.rb
+- lib/camunda/railtie.rb
 - lib/camunda/signal.rb
 - lib/camunda/task.rb
 - lib/camunda/variable_serialization.rb
@@ -233,15 +234,15 @@ files:
 - lib/generators/camunda/spring_boot/templates/ProcessScenarioTest.java
 - lib/generators/camunda/spring_boot/templates/application.properties
 - lib/generators/camunda/spring_boot/templates/camunda.cfg.xml
-- lib/generators/camunda/spring_boot/templates/camunda.rake
 - lib/generators/camunda/spring_boot/templates/logback.xml
 - lib/generators/camunda/spring_boot/templates/pom.xml
 - lib/generators/camunda/spring_boot/templates/sample.bpmn
+- lib/tasks/camunda.rake
 homepage: https://github.com/amalagaura/camunda-workflow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -257,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: []