camunda-workflow 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dd0d8f1bbbb13c972089fe86ab7cf262172fb705f30f1f9fa3066576a872b30
-  data.tar.gz: eaa229a71c5bc895a595844b5de02beda7730d7c93fe9873a2956a9869684f0f
+  metadata.gz: 9c08d0a47fdc375095f8a12a412e8fd338cba6c01de753777a2c007a184d6caa
+  data.tar.gz: 34141274cb6a630312651883a7502819e9b236fb870275a82d9561f4adae6561
 SHA512:
-  metadata.gz: dfbb1a31c30b6b87a3007f056ea61a7f066dc7ad6a001e222df69409991382b703fdb06ad613f5d42ec3b7366272e1148e6693c165597ae5629f8f7db5b09ffc
-  data.tar.gz: e28096ce39c4eecdcfa057d3a9939eea3e919500c568d28bf3f4217a5601a8a3fbe7b5d30e79223b4528b2af49a700a6ae8113bfd4a9fdaa11931670271bf54e
+  metadata.gz: aa811d101d80ea3e5bd6408c17e28215118a2c223d469bb9e60a7f8ad5ebcc991264fb3f19cd31a2a6f5fccc8f5e085220e04421fd4fa183327297fb18a28535
+  data.tar.gz: 833f866515b6555a0e05f893aef5d3a6603b6f933708ed5b77641fb8d9b4db4b06935bb632ef04973097a013fdc7a35858a0d1d8d918f3f0c680f616f4ca1c29

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [Unreleased](https://github.com/amalagaura/camunda-workflow/tree/HEAD)
+
+[Full Changelog](https://github.com/amalagaura/camunda-workflow/compare/fc9ab266909628118a892082abdff953f3bc7eca...HEAD)
+
+**Merged pull requests:**
+
+- 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

@@ -1,4 +1,6 @@
-[![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
@@ -82,7 +84,21 @@ Camunda::Workflow.configure do |config|
   config.engine_route_prefix = 'rest'
 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. 
 
+```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
+```
 #### Generating a jar for deployment
 `mvn package spring-boot:repackage`
 
@@ -155,7 +171,9 @@ For testing from the console
 ### User Tasks
 #### Mark a user task complete
 ```ruby
-  Camunda::Task.mark_task_completed!(business_key, task_key, {})
+  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')
 ```
 
 ### Rspec Helpers

data/lib/camunda/model.rb

@@ -8,6 +8,8 @@ class Camunda::Model
       # 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 Rails.env.development?
       c.use Her::Middleware::FirstLevelParseJSON

data/lib/camunda/task.rb

@@ -3,7 +3,7 @@ class Camunda::Task < Camunda::Model
   collection_path 'task'
 
   def self.find_by_business_key_and_task_definition_key!(instance_business_key, task_key)
-    find_by(instanceBusinessKey: instance_business_key, taskDefinitionKey: task_key).tap do |ct|
+    find_by(processInstanceBusinessKey: instance_business_key, taskDefinitionKey: task_key).tap do |ct|
       unless ct
         raise MissingTask, "Could not find Camunda Task with processInstanceBusinessKey: #{instance_business_key} " \
               "and taskDefinitionKey #{task_key}"
@@ -11,12 +11,7 @@ class Camunda::Task < Camunda::Model
     end
   end
 
-  def self.mark_task_completed!(instance_business_key, task_key, variables={})
-    ct = find_by_business_key_and_task_definition_key!(instance_business_key, task_key)
-    ct.complete! variables
-  end
-
-  def complete!(vars)
+  def complete!(vars={})
     self.class.post_raw("#{self.class.collection_path}/#{id}/complete", variables: serialize_variables(vars))[:response]
         .tap do |response|
       raise MissingTask unless response.success?

data/lib/camunda/workflow.rb

@@ -16,10 +16,14 @@ module Camunda
       attr_accessor :max_polling_tasks
       attr_accessor :long_polling_duration
       attr_accessor :tenant_id
+      attr_accessor :camunda_user
+      attr_accessor :camunda_password
 
       def initialize
         @engine_url = 'http://localhost:8080'
         @engine_route_prefix = 'rest-engine'
+        @camunda_user = ''
+        @camunda_password = ''
         @worker_id = '0'
         @lock_duration = 14.days
         @max_polling_tasks = 2

data/lib/camunda/workflow/version.rb

@@ -0,0 +1,5 @@
+module Camunda
+  module Workflow
+    VERSION = '0.1.2'.freeze
+  end
+end

data/lib/generators/camunda/spring_boot/USAGE

@@ -1,5 +1,5 @@
 Description:
-    One time install of Java Camunda application to do unit testing of your BPMN process
+    One time install of Java Camunda application to do unit testing of your BPMN process.
 
 Example:
     rails generate camunda:unit_tests

data/lib/generators/camunda/spring_boot/templates/Camunda.java

@@ -16,8 +16,13 @@ package camunda;
  * limitations under the License.
  */
 import org.camunda.bpm.spring.boot.starter.annotation.EnableProcessApplication;
+import org.camunda.bpm.engine.rest.security.auth.ProcessEngineAuthenticationFilter;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.web.servlet.FilterRegistrationBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 
 @SpringBootApplication
 @EnableProcessApplication("camunda-bpm-springboot")
@@ -25,4 +30,16 @@ public class Camunda {
   public static void main(String... args) {
     SpringApplication.run(Camunda.class, args);
   }
+
+  @Bean
+  @ConditionalOnProperty(name="camunda.authentication", havingValue="true")
+  public FilterRegistrationBean authenticationFilter() {
+    FilterRegistrationBean registration = new FilterRegistrationBean();
+    registration.setFilter(new ProcessEngineAuthenticationFilter());
+    registration.addUrlPatterns("/rest/*");
+    registration.addInitParameter("authentication-provider", "org.camunda.bpm.engine.rest.security.auth.impl.HttpBasicAuthenticationProvider");
+    registration.setName("camunda-auth");
+    registration.setOrder(1);
+    return registration;
+  }
 }

data/lib/generators/camunda/spring_boot/templates/application.properties

@@ -46,3 +46,5 @@ spring.datasource.driverClassName=org.h2.Driver
 #camunda.bpm.license-file=file:${user.home}/.camunda/license.txt
 
 server.port=${CAMUNDA_PORT:8080}
+#To turn on HTTP Basic Auth for Camunda, set the below variable to true or set an environment variable.
+camunda.authentication=${CAMUNDA_AUTH:false}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camunda-workflow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ankur Sethi
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.75.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.75.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +172,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
@@ -176,6 +191,7 @@ files:
 - lib/camunda/task.rb
 - lib/camunda/variable_serialization.rb
 - lib/camunda/workflow.rb
+- lib/camunda/workflow/version.rb
 - lib/generators/camunda/bpmn_classes/USAGE
 - lib/generators/camunda/bpmn_classes/bpmn_classes_generator.rb
 - lib/generators/camunda/bpmn_classes/templates/bpmn_class.rb.template
@@ -203,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="