Class: KualiRice::KualiRESTInterface

Inherits:
Object
  • Object
show all
Includes:
KualiRice
Defined in:
lib/kuali-rice/KualiRESTInterface/RestAPI.rb,
lib/kuali-rice/KualiRESTInterface/DocumentActions.rb,
lib/kuali-rice/KualiRESTInterface/PersonInterface.rb

Constant Summary

Constants included from KualiRice

REMOTING_PATH

Instance Attribute Summary

Attributes included from KualiRice

#port, #server, #use_ssl

Instance Method Summary collapse

Methods included from KualiRice

#initialize

Instance Method Details

#acknowledge(docid, userID, annotation) ⇒ Object 



22
23
24
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 22

def acknowledge(docid, userID, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/acknowledge/userID/#{userID}/docid/#{docid}/annotation/#{annotation}", :post))
end

#approve(docid, userID, docTitle, annotation) ⇒ Object 



26
27
28
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 26

def approve(docid, userID, docTitle, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/approve/userID/#{userID}/docid/#{docid}/title/#{docTitle}/annotation/#{annotation}", :post))
end

#blanketApprove(docid, userID, docTitle, annotation) ⇒ Object 



30
31
32
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 30

def blanketApprove(docid, userID, docTitle, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/blanketApprove/userID/#{userID}/docid/#{docid}/title/#{docTitle}/annotation/#{annotation}", :post))
end

#cancel(docid, userID, annotation) ⇒ Object 



34
35
36
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 34

def cancel(docid, userID, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/cancel/userID/#{userID}/docid/#{docid}/annotation/#{annotation}", :post))
end

#countUserInboxItems(userID) ⇒ Object 



89
90
91
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 89

def countUserInboxItems(userID)
  rest_call("/simpleDocAction/actionitems/countinbox/#{userID}")  
end

#create(initiatorId, appDocId, docType, docTitle) ⇒ Object 



14
15
16
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 14

def create(initiatorId, appDocId, docType, docTitle)
  DocumentResponse.new(rest_call("/simpleDocAction/doc/create/initiatorID/#{initiatorId}/appid/#{appDocId}/type/#{docType}/title/#{docTitle}", :post))
end

#disapprove(docid, userID, annotation) ⇒ Object 



38
39
40
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 38

def disapprove(docid, userID, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/disapprove/userID/#{userID}/docid/#{docid}/annotation/#{annotation}", :post))
end

#findByRouteHeaderId(routeHeaderIdStr) ⇒ Object 



93
94
95
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 93

def findByRouteHeaderId(routeHeaderIdStr)
  createActionList(rest_call("/simpleDocAction/actionitems/findbyrouteheader/#{routeHeaderIdStr}"))  
end

#fyi(docid, userID) ⇒ Object 



42
43
44
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 42

def fyi(docid, userID)
  StandardResponse.new(rest_call("/simpleDocAction/doc/fyi/userID/#{userID}/docid/#{docid}", :post))
end

#getDocument(docid, userid) ⇒ Object 



10
11
12
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 10

def getDocument(docid, userid)
  DocumentResponse.new(rest_call("/simpleDocAction/doc/getdocument/userID/#{userid}/docid/#{docid}"))
end

#getPersonByEmployeeId(emplid) ⇒ Object 



10
11
12
 
# File 'lib/kuali-rice/KualiRESTInterface/PersonInterface.rb', line 10

def getPersonByEmployeeId(emplid)
  Person.new(rest_call("/personServiceREST/Person/byemployeeid/#{emplid}"))
end

#getPersonByExternalIdentifier(type, id) ⇒ Object 



18
19
20
 
# File 'lib/kuali-rice/KualiRESTInterface/PersonInterface.rb', line 18

def getPersonByExternalIdentifier(type, id)
  Person.new(rest_call("/personServiceREST/Person/byexternalid/type/#{type}/id/#{id}"))
end

#getPersonByPrincipalID(prncpl_id) ⇒ Object 



14
15
16
 
# File 'lib/kuali-rice/KualiRESTInterface/PersonInterface.rb', line 14

def getPersonByPrincipalID(prncpl_id)
  Person.new(rest_call("/personServiceREST/Person/byprincipalid/#{prncpl_id}"))
end

#getPersonByPrincipalName(prncpl_nm) ⇒ Object 



6
7
8
 
# File 'lib/kuali-rice/KualiRESTInterface/PersonInterface.rb', line 6

def getPersonByPrincipalName(prncpl_nm)
  Person.new(rest_call("/personServiceREST/Person/byprincipalname/#{prncpl_nm}"))
end

#getUserInbox(userID) ⇒ Object 



85
86
87
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 85

def getUserInbox(userID)
   createActionList(rest_call("/simpleDocAction/actionitems/getinbox/#{userID}"))          
end

#isUserInRouteLog(docid, userID) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 74

def isUserInRouteLog(docid, userID)
  xmldata = rest_call("/simpleDocAction/doc/isUserInRouteLog/userID/#{userID}/docid/#{docid}")  
  parseddata = XmlSimple.xml_in(xmldata) 
  
  if(parseddata['isUserInRouteLog'][0].eql?("true")) then 
    return true
  end
  
  return false
end

#ping ⇒ Object 



6
7
8
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 6

def ping
  rest_call("/simpleDocAction/ping")
end

#requestAdHocAckToGroup(docid, userID, recipientGroupId, annotation) ⇒ Object 



50
51
52
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 50

def requestAdHocAckToGroup(docid, userID, recipientGroupId, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/requestAdHocAckToGroup/userID/#{userID}/docid/#{docid}/recipientgroupid/#{recipientGroupId}/annotation/#{annotation}", :post))
end

#requestAdHocAckToUser(docid, userID, recipientId, annotation) ⇒ Object 



54
55
56
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 54

def requestAdHocAckToUser(docid, userID, recipientId,  annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/requestAdHocAckToUser/userID/#{userID}/docid/#{docid}/recipientid/#{recipientId}/annotation/#{annotation}", :post))
end

#requestAdHocApproveToGroup(docid, userID, recipientGroupId, annotation) ⇒ Object 



58
59
60
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 58

def requestAdHocApproveToGroup(docid, userID, recipientGroupId, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/requestAdHocApproveToGroup/userID/#{userID}/docid/#{docid}/recipientgroupid/#{recipientGroupId}/annotation/#{annotation}", :post))
end

#requestAdHocApproveToUser(docid, userID, recipientId, annotation) ⇒ Object 



62
63
64
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 62

def requestAdHocApproveToUser(docid, userID, recipientId,  annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/requestAdHocApproveToUser/userID/#{userID}/docid/#{docid}/recipientid/#{recipientId}/annotation/#{annotation}", :post))
end

#requestAdHocFyiToGroup(docid, userID, recipientGroupId, annotation) ⇒ Object 



66
67
68
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 66

def requestAdHocFyiToGroup(docid, userID, recipientGroupId, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/requestAdHocFyiToGroup/userID/#{userID}/docid/#{docid}/recipientgroupid/#{recipientGroupId}/annotation/#{annotation}", :post))
end

#requestAdHocFyiToUser(docid, userID, recipientId, annotation) ⇒ Object 



70
71
72
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 70

def requestAdHocFyiToUser(docid, userID, recipientId,  annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/requestAdHocFyiToUser/userID/#{userID}/docid/#{docid}/recipientid/#{recipientId}/annotation/#{annotation}", :post))  
end

#rest_call(path, verb = "get", post_data = "") ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/kuali-rice/KualiRESTInterface/RestAPI.rb', line 6

def rest_call (path, verb = "get", post_data = "")
              
  http = Net::HTTP.new(@server, @use_ssl ? 443 : @port)
  http.use_ssl = true if @use_ssl
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  
  path = REMOTING_PATH + path
  path = URI.escape(path)
  
  result = http.start { |http|
   response, body = (verb.eql?(:post) ? http.post(path, encode_params(post_data)) : http.get(path))
   body
  }
end

#route(docid, userID, docTitle, annotation) ⇒ Object 



46
47
48
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 46

def route(docid, userID, docTitle, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/route/userID/#{userID}/docid/#{docid}/title/#{docTitle}/annotation/#{annotation}", :post))
end

#save(docid, userID, docTitle, annotation) ⇒ Object 



18
19
20
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 18

def save(docid, userID, docTitle, annotation)
  StandardResponse.new(rest_call("/simpleDocAction/doc/save/userID/#{userID}/docid/#{docid}/title/#{docTitle}/annotation/#{annotation}", :post))
end

#sendNotification(message) ⇒ Object 



97
98
99
 
# File 'lib/kuali-rice/KualiRESTInterface/DocumentActions.rb', line 97

def sendNotification(message)
  rest_call("/simpleDocAction/notification/send/", :post, message)  
end