bpm_manager 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 841a0935ace1f14235c9dc2fa14bdca27e1f543e
-  data.tar.gz: aa0675ebf62250bf9543908a0d80481815b20954
+  metadata.gz: 7e0c32b3f8f35c797fc808423a6ef8484ab43c00
+  data.tar.gz: 108c7f471962705828b55b5a1807ee4fe4bebddb
 SHA512:
-  metadata.gz: 77d7b4f65eda3aaaac843c84baecfba17642ea2edcf3c71ae9de0fbb2d238e1fbe483c1c85b644dbd024451d36dbb4a2f991d4aa23200df76d2066bec7c7f54e
-  data.tar.gz: 9b93335ee1160f34f271c6bb63b83fefe2aadc2bbacab9274d50448daa8ae5004cce1d9a75432bbab66f312d8de351537813f0a9877ccbc55262a42d0562cf3e
+  metadata.gz: 97969c19554e9fd7878f7d8ff4377105a89026a1825b3a148e2b3390d4528dcf734bdafc910843bf52ec216186797f8adc211bdc3e56c492b82d153d655aac2d
+  data.tar.gz: 9838036cb7e10a8ae882eee0d402a2c37e06bb08082a886c7cb977b647dd37d8d10c74c7eedf2864beb4781ce6b2087e29ba03b7df6e34c9484cd0a6876d8c45

data/README.md

@@ -1,5 +1,5 @@
 # BeatCoding BPM Manager Gem
-BPM Manager Gem for RedHat jBPM & Oracle BPM engines
+BPM Manager Gem for Red Hat jBPM & Oracle BPM engines
 
 Feel free to fork, contribute & distribute
 
@@ -29,8 +29,7 @@ First configure properly the gem using the bpm_manager.rb file in 'config/initia
 
 ```ruby
 BpmManager.configure do |config|
-  config.bpm_vendor     => 'RedHat'                 # or 'Oracle'
-  config.bpm_url        => 'bpm.company.com'        # without http:// or https://
+  config.bpm_url        => 'bpm.server.com'         # without http:// or https://
   config.bpm_url_suffix => '/business-central/rest' # could be also /jbpm-console/rest
   config.bpm_username   => 'scott'                  # your server username
   config.bpm_passowrd   => 'tiger'                  # your password
@@ -41,29 +40,32 @@ end
 Then make an API call like this:
 
 ```ruby
-result = BpmManager.deployments()
+result = BpmManager::RedHat.deployments()
 ```
 
-## Quick Examples
-
+## Quick Examples for Red Hat
 
 ```ruby
 # Get all the Deployments
-BpmManager.deployments
+BpmManager::RedHat.deployments
 
 # Get all the Tasks for an User ID
-BpmManager.tasks('foo@bar.com')
+BpmManager::RedHat.tasks('foo@bar.com')
 
 # Get all the Tasks with options (RedHat example). It supports all REST API options.
-BpmManager.tasks({:ownerId => 'foo@bar.com', :processInstanceId => 3})
+BpmManager::RedHat.tasks({:ownerId => 'foo@bar.com', :processInstanceId => 3})
 
 # Get all the Process Instances
-BpmManager.process_instances
+BpmManager::RedHat.process_instances
 
 # Get the Process Instance with ID = 3
-BpmManager.process_instance(3)
+BpmManager::RedHat.process_instance(3)
 ```
 
+## Note
+
+Tasks and Process structures includes a :data method in which returns the JSON raw data from server
+
 ## Contributing
 
 1. Fork it ( https://github.com/BeatCoding/bpm_manager/fork )

data/lib/bpm_manager/red_hat.rb

@@ -0,0 +1,89 @@
+require "rest-client"
+require "json"
+require "ostruct"
+
+module BpmManager
+  module RedHat
+    # Gets all server deployments
+    def self.deployments()
+      return JSON.parse(RestClient.get(BpmManager.uri('/deployment'), :accept => :json))
+    end
+    
+    # Gets all tasks, optionally you could specify an user id
+    def self.tasks(user_id = "")
+      self.structure_task_data(JSON.parse(RestClient.get(BpmManager.uri('/task/query' + (user_id.empty? ? '' : '?taskOwner=' + user_id)), :accept => :json)))
+    end
+    
+    # Gets all tasks with options
+    def self.tasks_with_opts(opts = {})
+      self.structure_task_data(JSON.parse(RestClient.get(BpmManager.uri('/task/query' + (opts.empty? ? '' : '?' + opts.map{|k,v| k.to_s + '=' + v.to_s}.join('&'))), :accept => :json)))
+    end
+  
+    # Gets all Process Instances
+    def self.process_instances
+      JSON.parse(RestClient.get(BpmManager.uri('/history/instances'), :accept => :json))
+    end
+  
+    # Gets a Process Instance
+    def self.process_instance(process_instance_id)
+      JSON.parse(RestClient.get(BpmManager.uri('/history/instance/' + process_instance_id.to_s), :accept => :json))
+    end
+  
+    # Gets a Process Instance Variables
+    def self.process_instance_variables(deployment_id, process_instance_id)
+      JSON.parse(RestClient.get(BpmManager.uri('/runtime/' + deployment_id.to_s + '/withvars/process/instance/' + process_instance_id.to_s), :accept => :json))['variables']
+    end
+    
+    # Assigns a Task for an User
+    def self.assign_task(task_id, user_id)
+      RestClient.post(URI.encode(BpmManager.uri('/task/' + task_id.to_s + '/delegate?targetEntityId=' + user_id.to_s)), :headers => {:content_type => :json, :accept => :json})
+    end
+  
+    # Releases a Task
+    def self.release_task(task_id)
+      RestClient.post(URI.encode(BpmManager.uri('/task/' + task_id.to_s + '/release')), :headers => {:content_type => :json, :accept => :json})
+    end
+  
+    # Completes a Task
+    def self.complete_task(task_id)
+      RestClient.post(URI.encode(BpmManager.uri('/task/' + task_id.to_s + '/complete')), :headers => {:content_type => :json, :accept => :json})
+    end
+    
+    private
+      def self.structure_task_data(input)
+        tasks = []
+        
+        unless input['taskSummaryList'].nil?
+          input['taskSummaryList'].each do |task|
+            my_task = OpenStruct.new
+            my_task.process = OpenStruct.new
+            
+            my_task.id = task['task-summary']['status']
+            my_task.process_instance_id = task['task-summary']['process-instance-id']
+            my_task.parent_id = task['task-summary']['parent_id']
+            my_task.created_on = Time.at(task['task-summary']['created-on']/1000)
+            my_task.active_on = Time.at(task['task-summary']['activation-time']/1000)
+            my_task.name = task['task-summary']['name']
+            my_task.owner = task['task-summary']['actual-owner']
+            my_task.status = task['task-summary']['status']
+            my_task.subject = task['task-summary']['subject']
+            my_task.description = task['task-summary']['description']
+            my_task.data = task['task-summary']
+            my_task.process.data = self.process_instance(task['task-summary']['process-instance-id'])
+            my_task.process.deployment_id = task['task-summary']['deployment-id']
+            my_task.process.id = my_task.process.data['process-id']
+            my_task.process.instance_id = my_task.process.data['process-instance-id']
+            my_task.process.start_on = Time.at(my_task.process.data['start']/1000)
+            my_task.process.name = my_task.process.data['process-name']
+            my_task.process.version = my_task.process.data['process-version']
+            my_task.process.creator = my_task.process.data['identity']
+            my_task.process.variables = self.process_instance_variables(my_task.process.deployment_id, my_task.process.instance_id)
+            
+            tasks << my_task
+          end
+        end
+        
+        return tasks
+      end
+  end
+end

data/lib/bpm_manager/version.rb

@@ -1,3 +1,3 @@
 module BpmManager
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

data/lib/bpm_manager.rb

@@ -1,6 +1,5 @@
 require "bpm_manager/version"
-require "rest-client"
-require "json"
+require "bpm_manager/red_hat"
 
 module BpmManager
   class << self
@@ -36,49 +35,4 @@ module BpmManager
         ''
     end
   end
-
-  # Gets all server deployments
-  def self.deployments()
-    return JSON.parse(RestClient.get(BpmManager.uri('/deployment'), :accept => :json))
-  end
-
-  # Gets all tasks, optionally you could specify an user id
-  def self.tasks(user_id = "")
-    return JSON.parse(RestClient.get(BpmManager.uri('/task/query' + (user_id.empty? ? '' : '?taskOwner=' + user_id)), :accept => :json))
-  end
-
-  # Gets all tasks with options
-  def self.tasks_with_opts(opts = {})
-    return JSON.parse(RestClient.get(BpmManager.uri('/task/query' + (opts.empty? ? '' : '?' + opts.map{|k,v| k.to_s + '=' + v.to_s}.join('&'))), :accept => :json))
-  end
-
-  # Gets all Process Instances
-  def self.process_instances
-    return JSON.parse(RestClient.get(BpmManager.uri('/history/instances'), :accept => :json))
-  end
-
-  # Gets a Process Instance
-  def self.process_instance(process_instance_id)
-    return JSON.parse(RestClient.get(BpmManager.uri('/history/instance/' + process_instance_id.to_s), :accept => :json))
-  end
-
-  # Gets a Process Instance Variables
-  def self.process_instance_variables(deployment_id, process_instance_id)
-    return JSON.parse(RestClient.get(BpmManager.uri('/runtime/' + deployment_id.to_s + '/withvars/process/instance/' + process_instance_id.to_s), :accept => :json))['variables']
-  end
-  
-  # Assigns a Task for an User
-  def self.assign_task(task_id, user_id)
-    RestClient.post(URI.encode(BpmManager.uri('/task/' + task_id.to_s + '/delegate?targetEntityId=' + user_id.to_s)), :headers => {:content_type => :json, :accept => :json})
-  end
-
-  # Releases a Task
-  def self.release_task(task_id)
-    RestClient.post(URI.encode(BpmManager.uri('/task/' + task_id.to_s + '/release')), :headers => {:content_type => :json, :accept => :json})
-  end
-
-  # Completes a Task
-  def self.complete_task(task_id)
-    RestClient.post(URI.encode(BpmManager.uri('/task/' + task_id.to_s + '/complete')), :headers => {:content_type => :json, :accept => :json})
-  end
 end

data/lib/generators/bpm_manager/bpm_manager.rb

@@ -1,9 +1,6 @@
 BpmManager.configure do |config|
-  # Sets the BPM engine vendor: [RedHat|Oracle]
-  config.bpm_vendor = "RedHat"
-
   # Sets the BPM URL or IP address without the http:// or https://
-  config.bpm_url = "bpm.company.com"
+  config.bpm_url = "bpm.server.com"
 
   # Sets the URL suffix like: '/business-central/rest' or '/jbpm-console/rest' 
   config.bpm_url_suffix = "/jbpm-console/rest"

data/spec/red_hat_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe BpmManager do
+  before :all do
+    BpmManager.configure do |config|
+      config.bpm_url = "bpm.server.com"
+      config.bpm_url_suffix = "/jbpm-console/rest"
+      config.bpm_username = "scott"
+      config.bpm_password = "tiger"
+      config.bpm_use_ssl = false
+    end
+  end
+  
+  describe "#uri" do
+    before :each do
+      @uri = BpmManager.uri('/test')
+    end
+    
+    it "expect to be a String" do
+      expect(@uri).to be_an_instance_of String
+    end
+  
+    it "expect to not be nil" do
+      expect(@uri).not_to eq(nil)
+    end
+  end
+  
+  describe "#configuration" do
+    before :each do
+      @config = BpmManager.configuration
+    end
+    
+    it "should be a class of type Configuration" do
+      expect(@config).to be_an_instance_of BpmManager::Configuration
+    end
+    
+    it 'must have all the accesors' do
+      expect(@config.methods.include? :bpm_vendor).to be true
+      expect(@config.methods.include? :bpm_url).to be true
+      expect(@config.methods.include? :bpm_username).to be true
+      expect(@config.methods.include? :bpm_password).to be true
+      expect(@config.methods.include? :bpm_use_ssl).to be true
+    end
+  end
+
+  describe "RedHat" do
+    describe "#deployments" do
+      before :each do
+        @deployments = BpmManager::RedHat.deployments
+      end
+      
+      it "must return something" do
+        expect(@deployments.length).to be > 0
+      end
+    end
+  
+    describe "#tasks" do
+      before :each do
+        @tasks = BpmManager::RedHat.tasks('foo@bar.com')
+      end
+      
+      it "task should include the all attributes" do
+        expect(@tasks.first.methods).to include(:id)
+        expect(@tasks.first.methods).to include(:process_instance_id)
+        expect(@tasks.first.methods).to include(:parent_id)
+        expect(@tasks.first.methods).to include(:created_on)
+        expect(@tasks.first.methods).to include(:active_on)
+        expect(@tasks.first.methods).to include(:name)
+        expect(@tasks.first.methods).to include(:owner)
+        expect(@tasks.first.methods).to include(:status)
+        expect(@tasks.first.methods).to include(:subject)
+        expect(@tasks.first.methods).to include(:description)
+        expect(@tasks.first.methods).to include(:data)
+        
+        expect(@tasks.first.process.methods).to include(:id)
+        expect(@tasks.first.process.methods).to include(:deployment_id)
+        expect(@tasks.first.process.methods).to include(:instance_id)
+        expect(@tasks.first.process.methods).to include(:start_on)
+        expect(@tasks.first.process.methods).to include(:name)
+        expect(@tasks.first.process.methods).to include(:version)
+        expect(@tasks.first.process.methods).to include(:creator)
+        expect(@tasks.first.process.methods).to include(:data)
+      end      
+    end
+    
+    describe "#tasks_with_opts" do
+      before :each do
+        @tasks = BpmManager::RedHat.tasks_with_opts(:processInstanceId => 1)
+      end
+      
+      it "task should include the all attributes" do
+        expect(@tasks.first.methods).to include(:id)
+        expect(@tasks.first.methods).to include(:process_instance_id)
+        expect(@tasks.first.methods).to include(:parent_id)
+        expect(@tasks.first.methods).to include(:created_on)
+        expect(@tasks.first.methods).to include(:active_on)
+        expect(@tasks.first.methods).to include(:name)
+        expect(@tasks.first.methods).to include(:owner)
+        expect(@tasks.first.methods).to include(:status)
+        expect(@tasks.first.methods).to include(:subject)
+        expect(@tasks.first.methods).to include(:description)
+        expect(@tasks.first.methods).to include(:data)
+        
+        expect(@tasks.first.process.methods).to include(:id)
+        expect(@tasks.first.process.methods).to include(:deployment_id)
+        expect(@tasks.first.process.methods).to include(:instance_id)
+        expect(@tasks.first.process.methods).to include(:start_on)
+        expect(@tasks.first.process.methods).to include(:name)
+        expect(@tasks.first.process.methods).to include(:version)
+        expect(@tasks.first.process.methods).to include(:creator)
+        expect(@tasks.first.process.methods).to include(:data)
+      end      
+    end
+  
+    describe "#process_instances" do
+      before :each do
+        @processes = BpmManager::RedHat.process_instances
+      end
+      
+      it "must return something" do
+        expect(@processes.length).to be > 0
+      end
+    end
+  
+    describe "#process_instance" do
+      before :each do
+        @process = BpmManager::RedHat.process_instance(1)
+      end
+      
+      it "must return something" do
+        expect(@process.length).to be > 0
+      end
+    end
+  
+    describe "#process_instance_variables" do
+      before :each do
+        @variables = BpmManager::RedHat.process_instance_variables('com.beatcoding.simpletask:SimpleTask:1.0',1)
+      end
+      
+      it "must return something" do
+        expect(@variables.length).to be > 0
+      end
+    end
+  
+    describe "#assign_task" do
+      before :each do
+        @result = BpmManager::RedHat.assign_task(1,'foo@bar.com')
+      end
+      
+      it "must return something" do
+        expect(@result.length).to be > 0
+      end
+    end
+  
+    describe "#release_task" do
+      before :each do
+        @result = BpmManager::RedHat.release_task(1)
+      end
+      
+      it "must return something" do
+        expect(@result.length).to be > 0
+      end
+    end
+    
+    # describe "#complete_task" do
+    #   before :each do
+    #     @result = BpmManager::RedHat.complete_task(1)
+    #   end
+      
+    #   it "must return something" do
+    #     expect(@result.length).to be > 0
+    #   end
+    # end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bpm_manager
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Ariel Presa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -81,10 +81,11 @@ files:
 - Rakefile
 - bpm_manager.gemspec
 - lib/bpm_manager.rb
+- lib/bpm_manager/red_hat.rb
 - lib/bpm_manager/version.rb
 - lib/generators/bpm_manager/bpm_manager.rb
 - lib/generators/bpm_manager/install_generator.rb
-- spec/module_spec.rb
+- spec/red_hat_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.beatcoding.com
 licenses:
@@ -111,5 +112,5 @@ signing_key:
 specification_version: 4
 summary: BPM Manager Gem for RedHat jBPM & Oracle BPM engines.
 test_files:
-- spec/module_spec.rb
+- spec/red_hat_spec.rb
 - spec/spec_helper.rb

data/spec/module_spec.rb

@@ -1,135 +0,0 @@
-require 'spec_helper'
-
-describe "BpmManager" do
-  before :all do
-    BpmManager.configure do |config|
-      config.bpm_vendor = "RedHat"
-      config.bpm_url = "bpm.company.com"
-      config.bpm_username = "scott"
-      config.bpm_password = "tiger"
-      config.bpm_use_ssl = false
-    end
-  end
-  
-  describe "#uri" do
-    before :each do
-      @uri = BpmManager.uri('/test')
-    end
-    
-    it "expect to be a String" do
-      expect(@uri).to be_an_instance_of String
-    end
-  
-    it "expect to not be nil" do
-      expect(@uri).not_to eq(nil)
-    end
-  end
-  
-  describe "#configuration" do
-    before :each do
-      @config = BpmManager.configuration
-    end
-    
-    it "should be a class of type Configuration" do
-      expect(@config).to be_an_instance_of BpmManager::Configuration
-    end
-    
-    it 'must have all the accesors' do
-      expect(@config.methods.include? :bpm_vendor).to be true
-      expect(@config.methods.include? :bpm_url).to be true
-      expect(@config.methods.include? :bpm_username).to be true
-      expect(@config.methods.include? :bpm_password).to be true
-      expect(@config.methods.include? :bpm_use_ssl).to be true
-    end
-  end
-  
-  describe "#deployments" do
-    before :each do
-      @deployments = BpmManager.deployments
-    end
-    
-    it "must return something" do
-      expect(@deployments.length).to be > 0
-    end
-  end
-
-  describe "#tasks" do
-    before :each do
-      @tasks = BpmManager.tasks('foo@bar.com')
-    end
-    
-    it "must return something" do
-      expect(@tasks.length).to be > 0
-    end
-  end
-
-  describe "#tasks_with_opts" do
-    before :each do
-      @tasks = BpmManager.tasks_with_opts(:ownerId => 'foo@bar.com', :taskId => 1)
-    end
-    
-    it "must return something" do
-      expect(@tasks.length).to be > 0
-    end
-  end
-
-  describe "#process_instances" do
-    before :each do
-      @processes = BpmManager.process_instances
-    end
-    
-    it "must return something" do
-      expect(@processes.length).to be > 0
-    end
-  end
-
-  describe "#process_instance" do
-    before :each do
-      @process = BpmManager.process_instance(1)
-    end
-    
-    it "must return something" do
-      expect(@process.length).to be > 0
-    end
-  end
-
-  describe "#process_instance_variables" do
-    before :each do
-      @variables = BpmManager.process_instance_variables('package.process:1.0',1)
-    end
-    
-    it "must return something" do
-      expect(@variables.length).to be > 0
-    end
-  end
-
-  describe "#assign_task" do
-    before :each do
-      @result = BpmManager.assign_task(1,'foo@bar.com')
-    end
-    
-    it "must return something" do
-      expect(@result.length).to be > 0
-    end
-  end
-
-  describe "#release_task" do
-    before :each do
-      @result = BpmManager.release_task(1)
-    end
-    
-    it "must return something" do
-      expect(@result.length).to be > 0
-    end
-  end
-
-  describe "#complete_task" do
-    before :each do
-      @result = BpmManager.complete_task(1)
-    end
-    
-    it "must return something" do
-      expect(@result.length).to be > 0
-    end
-  end
-end