soapforce 0.1.2 → 0.1.3

data/lib/soapforce/client.rb

@@ -387,6 +387,44 @@ module Soapforce
       sobject ? SObject.new(sobject) : nil
     end
 
+    # ProcessSubmitRequest
+    #   request = {objectId: .., comments: ..., nextApproverIds: [...] }
+    # ProcessWorkItemRequest
+    #   request = {action: .., workitemId: .., comments: ..., nextApproverIds: [...] }
+    #
+    # Returns Hash of process status.
+    def process(request)
+
+      # approverIds is optional if Approval is configured to auto-assign the approver.
+      # Ensure approver ids is an array.
+      approver_ids = request[:approverIds] || []
+      approver_ids = approver_ids.is_a?(Array) ? approver_ids : [approver_ids]
+
+      request_type = request[:workitemId] ? "ProcessWorkitemRequest" : "ProcessSubmitRequest"
+
+      # Unfortunately had to use XML since I could not figure out
+      # how to get Savon2 to include the proper xsi:type attribute
+      # on the actions element.
+      xml = "<tns:actions xsi:type=\"tns:#{request_type}\">"
+      # Account for Submit or Workitem Request
+      if request[:objectId]
+        xml << "<tns:objectId>#{request[:objectId]}</tns:objectId>"
+      else
+        xml << "<tns:action>#{request[:action]}</tns:action>"
+        xml << "<tns:workitemId>#{request[:workitemId]}</tns:workitemId>"
+      end
+
+      xml << "<tns:comments>#{request[:comments]}</tns:comments>"
+      approver_ids.each do |aid|
+        xml <<  "<tns:nextApproverIds>#{aid}</tns:nextApproverIds>"
+      end
+      xml << "</tns:actions>"
+
+      call_soap_api(:process, xml)
+    end
+
+    # Helpers
+
     def field_list(sobject)
       description = describe(sobject)
       field_list = description[:fields].collect {|c| c[:name] }

data/lib/soapforce/version.rb

@@ -1,3 +1,3 @@
 module Soapforce
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/soapforce.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{A ruby client for the Salesforce SOAP API based on Savon.}
   gem.summary       = %q{Wraps Savon with helper methods and custom types for interacting with the Salesforce SOAP API.}
   gem.homepage      = "https://github.com/TinderBox/soapforce"
+  gem.license       = 'MIT'
 
   ignores  = File.readlines('.gitignore').grep(/\S+/).map(&:chomp)
   dotfiles = %w[.gitignore .travis.yml]

data/spec/fixtures/process_submit_request_response.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com">
+	<soapenv:Body>
+		<processResponse>
+			<result>
+				<actorIds>005i0000000Fi7vAAC</actorIds>
+				<entityId>a00i0000007JBLJAA4</entityId>
+				<instanceId>04gi00000009u5ZAAQ</instanceId>
+				<instanceStatus>Pending</instanceStatus>
+				<newWorkitemIds>04ii000000098uLAAQ</newWorkitemIds>
+				<success>true</success>
+			</result>
+		</processResponse>
+	</soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/process_workitem_request_response.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com">
+	<soapenv:Body>
+		<processResponse>
+			<result>
+				<entityId>a00i0000007JBLJAA4</entityId>
+				<instanceId>04gi00000009u5PAAQ</instanceId>
+				<instanceStatus>Removed</instanceStatus>
+				<success>true</success>
+			</result>
+		</processResponse>
+	</soapenv:Body>
+</soapenv:Envelope>

data/spec/lib/client_spec.rb

@@ -376,7 +376,41 @@ describe Soapforce::Client do
       }.to raise_error(Savon::Error)
     end
 
+  end
+
+  describe "process" do
+
+    it "process submit request without approvers" do
+
+      @body = '<tns:process><tns:actions xsi:type="tns:ProcessSubmitRequest"><tns:objectId>a00i0000007JBLJAA4</tns:objectId><tns:comments>Submitting for Approval</tns:comments></tns:actions></tns:process>'
+
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'process_submit_request_response'})
+      response = subject.process({objectId: "a00i0000007JBLJAA4", comments: "Submitting for Approval"})
+
+      response[:success].should be_true
+      response[:new_workitem_ids].should == "04ii000000098uLAAQ"
+    end
+
+    it "process submit request with approvers" do
 
+      @body = '<tns:process><tns:actions xsi:type="tns:ProcessSubmitRequest"><tns:objectId>a00i0000007JBLJAA4</tns:objectId><tns:comments>Submitting for Approval</tns:comments><tns:nextApproverIds>abcde12345</tns:nextApproverIds></tns:actions></tns:process>'
+
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'process_submit_request_response'})
+      response = subject.process({objectId: "a00i0000007JBLJAA4", comments: "Submitting for Approval", approverIds: "abcde12345"})
+
+      response[:success].should be_true
+      response[:new_workitem_ids].should == "04ii000000098uLAAQ"
+    end
+
+    it "process workitem request" do
+      @body = '<tns:process><tns:actions xsi:type="tns:ProcessWorkitemRequest"><tns:action>Removed</tns:action><tns:workitemId>a00i0000007JBLJAA4</tns:workitemId><tns:comments>Recalling Request</tns:comments></tns:actions></tns:process>'
+
+      stub = stub_api_request(endpoint, {with_body: @body, fixture: 'process_workitem_request_response'})
+      response = subject.process({action: "Removed", workitemId: "a00i0000007JBLJAA4", comments: "Recalling Request"})
+
+      response[:success].should be_true
+      response[:instance_status].should == "Removed"
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soapforce
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -107,6 +107,8 @@ files:
 - spec/fixtures/get_user_info_response.xml
 - spec/fixtures/login_response.xml
 - spec/fixtures/org_id_response.xml
+- spec/fixtures/process_submit_request_response.xml
+- spec/fixtures/process_workitem_request_response.xml
 - spec/fixtures/query_all_response.xml
 - spec/fixtures/query_more_response.xml
 - spec/fixtures/query_response.xml
@@ -123,7 +125,8 @@ files:
 - spec/support/fixture_helpers.rb
 - test.rb
 homepage: https://github.com/TinderBox/soapforce
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -158,6 +161,8 @@ test_files:
 - spec/fixtures/get_user_info_response.xml
 - spec/fixtures/login_response.xml
 - spec/fixtures/org_id_response.xml
+- spec/fixtures/process_submit_request_response.xml
+- spec/fixtures/process_workitem_request_response.xml
 - spec/fixtures/query_all_response.xml
 - spec/fixtures/query_more_response.xml
 - spec/fixtures/query_response.xml