1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
module OpenTox
class WrapperResult < String
attr_accessor :content_type, :code
end
class RestClientWrapper
# create REST class methods
[:head,:get,:post,:put,:dealete].each do |method|
#define_singleton_method method do |uri,args={},headers={},waiting_task=nil, wait=true|
define_singleton_method method do |uri,payload={},headers={},waiting_task=nil, wait=true|
args={}
args[:method] = method
args[:url] = uri
args[:timeout] = 600
args[:payload] = payload
args[:headers] = headers
#raise OpenTox::BadRequestError.new "Empty URI." unless uri # error raised at method call
raise OpenTox::BadRequestError.new "Invalid URI: '#{uri}'" unless URI.valid? uri
raise OpenTox::BadRequestError.new "Unreachable URI: '#{uri}'" unless URI.accessible? uri
=begin
raise "headers are no hash: "+headers.inspect unless headers==nil or headers.is_a?(Hash)
# TODO: loop over accept, contant_type, subjectid
raise OpenTox::BadRequestError.new "accept should go into the headers" if payload and payload.is_a?(Hash) and payload[:accept]
raise OpenTox::BadRequestError.new "content_type should go into the headers" if payload and payload.is_a?(Hash) and payload[:content_type]
raise OpenTox::BadRequestError.new "subjectid should go into the headers" if payload and payload.is_a?(Hash) and payload[:subjectid]
raise "__waiting_task__ must be 'nil' or '(sub)task', is "+waiting_task.class.to_s if
waiting_task!=nil and !(waiting_task.is_a?(Task) || waiting_task.is_a?(SubTask))
headers.each{ |k,v| headers.delete(k) if v==nil } if headers #remove keys with empty values, as this can cause problems
## PENDING partner services accept subjectid only in header
headers = {} unless headers
#headers[:subjectid] = payload.delete(:subjectid) if payload and payload.is_a?(Hash) and payload.has_key?(:subjectid)
# PENDING needed for NUTA, until we finally agree on how to send subjectid
#headers[:subjectid] = payload.delete(:subjectid) if uri=~/ntua/ and payload and payload.is_a?(Hash) and payload.has_key?(:subjectid)
=end
begin
#$logger.debug "RestCall: "+method.to_s+" "+uri.to_s+" "+headers.inspect+" "+args.inspect
request = RestClient::Request.new(args)
result = request.execute do |response, request, result|
unless response.code < 400 or URI.task? uri
$logger.error "#{uri} returned #{result.inspect}"
raise OpenTox::RestCallError result.inspect
end
return response
end
# ignore error codes from Task services (may contain eg 500 which causes exceptions in RestClient and RDF::Reader
#LOGGER.debug "result body size: #{result.body.size}"
# PENDING NTUA does return errors with 200
raise RestClient::ExceptionWithResponse.new(result) if uri=~/ntua/ and result.body =~ /about.*http:\/\/anonymous.org\/error/
# result is a string, with the additional fields content_type and code
res = WrapperResult.new(result.body)
res.content_type = result.headers[:content_type]
raise "content-type not set" unless res.content_type
res.code = result.code
# TODO: Ambit returns task representation with 200 instead of result URI
return res if res.code==200 || !wait
while (res.code==201 || res.code==202)
res = wait_for_task(res, uri, waiting_task)
end
raise "illegal status code: '"+res.code.to_s+"'" unless res.code==200
return res
rescue RestClient::RequestTimeout => ex
received_error ex.message, 408, nil, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue Errno::ETIMEDOUT => ex
received_error ex.message, 408, nil, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue Errno::ECONNREFUSED => ex
received_error ex.message, 500, nil, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue RestClient::ExceptionWithResponse => ex
# error comming from a different webservice,
received_error ex.http_body, ex.http_code, ex.response.net_http_res.content_type, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue OpenTox::RestCallError => ex
# already a rest-error, probably comes from wait_for_task, just pass through
raise ex
rescue => ex
# some internal error occuring in rest-client-wrapper, just pass through
raise ex
end
end
end
=begin
# performs a GET REST call
# raises OpenTox::Error if call fails (rescued in overwrite.rb -> halt 502)
# per default: waits for Task to finish and returns result URI of Task
# @param [String] uri destination URI
# @param [optional,Hash] headers contains params like accept-header
# @param [optional,OpenTox::Task] waiting_task (can be a OpenTox::Subtask as well), progress is updated accordingly
# @param [wait,Boolean] wait set to false to NOT wait for task if result is task
# @return [OpenTox::WrapperResult] a String containing the result-body of the REST call
def self.get(uri, headers={}, waiting_task=nil, wait=true )
execute( "get", uri, nil, headers, waiting_task, wait)
end
# performs a POST REST call
# raises OpenTox::Error if call fails (rescued in overwrite.rb -> halt 502)
# per default: waits for Task to finish and returns result URI of Task
# @param [String] uri destination URI
# @param [optional,String] payload data posted to the service
# @param [optional,Hash] headers contains params like accept-header
# @param [optional,OpenTox::Task] waiting_task (can be a OpenTox::Subtask as well), progress is updated accordingly
# @param [wait,Boolean] wait set to false to NOT wait for task if result is task
# @return [OpenTox::WrapperResult] a String containing the result-body of the REST call
def self.post(uri, payload=nil, headers={}, waiting_task=nil, wait=true )
execute( "post", uri, payload, headers, waiting_task, wait )
end
# performs a PUT REST call
# raises OpenTox::Error if call fails (rescued in overwrite.rb -> halt 502)
# @param [String] uri destination URI
# @param [optional,Hash] headers contains params like accept-header
# @param [optional,String] payload data put to the service
# @return [OpenTox::WrapperResult] a String containing the result-body of the REST call
def self.put(uri, payload=nil, headers={} )
execute( "put", uri, payload, headers )
end
# performs a DELETE REST call
# raises OpenTox::Error if call fails (rescued in overwrite.rb -> halt 502)
# @param [String] uri destination URI
# @param [optional,Hash] headers contains params like accept-header
# @return [OpenTox::WrapperResult] a String containing the result-body of the REST call
def self.delete(uri, headers=nil )
execute( "delete", uri, nil, headers)
end
def self.head(uri)
execute("head",uri)
end
private
def self.execute( rest_call, uri, payload=nil, headers={}, waiting_task=nil, wait=true )
raise OpenTox::BadRequestError.new "Empty URI." unless uri
raise OpenTox::BadRequestError.new "Invalid URI: '#{uri}'" unless URI.valid? uri
raise OpenTox::BadRequestError.new "Unreachable URI: '#{uri}'" unless URI.accessible? uri
raise "headers are no hash: "+headers.inspect unless headers==nil or headers.is_a?(Hash)
# TODO: loop over accept, contant_type, subjectid
raise OpenTox::BadRequestError.new "accept should go into the headers" if payload and payload.is_a?(Hash) and payload[:accept]
raise OpenTox::BadRequestError.new "content_type should go into the headers" if payload and payload.is_a?(Hash) and payload[:content_type]
raise OpenTox::BadRequestError.new "subjectid should go into the headers" if payload and payload.is_a?(Hash) and payload[:subjectid]
raise "__waiting_task__ must be 'nil' or '(sub)task', is "+waiting_task.class.to_s if
waiting_task!=nil and !(waiting_task.is_a?(Task) || waiting_task.is_a?(SubTask))
headers.each{ |k,v| headers.delete(k) if v==nil } if headers #remove keys with empty values, as this can cause problems
## PENDING partner services accept subjectid only in header
headers = {} unless headers
#headers[:subjectid] = payload.delete(:subjectid) if payload and payload.is_a?(Hash) and payload.has_key?(:subjectid)
# PENDING needed for NUTA, until we finally agree on how to send subjectid
#headers[:subjectid] = payload.delete(:subjectid) if uri=~/ntua/ and payload and payload.is_a?(Hash) and payload.has_key?(:subjectid)
begin
#LOGGER.debug "RestCall: "+rest_call.to_s+" "+uri.to_s+" "+headers.inspect+" "+payload.inspect
resource = RestClient::Resource.new(uri,{:timeout => 600})
if rest_call=="post" || rest_call=="put"
result = resource.send(rest_call, payload, headers){|response, request, result| return response }
elsif rest_call == "head"
result = resource.send(rest_call){ |response, request, result| return response }
else
result = resource.send(rest_call, headers){|response, request, result| return response }
end
# ignore error codes from Task services (may contain eg 500 which causes exceptions in RestClient and RDF::Reader
unless result.code < 400 or URI.task? @uri
$logger.error "#{@uri} returned #{result}"
raise OpenTox::RestCallError result
end
#LOGGER.debug "result body size: #{result.body.size}"
# PENDING NTUA does return errors with 200
raise RestClient::ExceptionWithResponse.new(result) if uri=~/ntua/ and result.body =~ /about.*http:\/\/anonymous.org\/error/
# result is a string, with the additional fields content_type and code
res = WrapperResult.new(result.body)
res.content_type = result.headers[:content_type]
raise "content-type not set" unless res.content_type
res.code = result.code
# TODO: Ambit returns task representation with 200 instead of result URI
return res if res.code==200 || !wait
while (res.code==201 || res.code==202)
res = wait_for_task(res, uri, waiting_task)
end
raise "illegal status code: '"+res.code.to_s+"'" unless res.code==200
return res
rescue RestClient::RequestTimeout => ex
received_error ex.message, 408, nil, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue Errno::ETIMEDOUT => ex
received_error ex.message, 408, nil, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue Errno::ECONNREFUSED => ex
received_error ex.message, 500, nil, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue RestClient::ExceptionWithResponse => ex
# error comming from a different webservice,
received_error ex.http_body, ex.http_code, ex.response.net_http_res.content_type, {:rest_uri => uri, :headers => headers, :payload => payload}
rescue OpenTox::RestCallError => ex
# already a rest-error, probably comes from wait_for_task, just pass through
raise ex
rescue => ex
# some internal error occuring in rest-client-wrapper, just pass through
raise ex
end
end
=end
def self.wait_for_task( res, base_uri, waiting_task=nil )
#TODO remove TUM hack
res.content_type = "text/uri-list" if base_uri =~/tu-muenchen/ and res.content_type == "application/x-www-form-urlencoded;charset=UTF-8"
task = nil
case res.content_type
when /application\/rdf\+xml/
task = OpenTox::Task.from_rdfxml(res)
when /yaml/
task = OpenTox::Task.from_yaml(res)
when /text\//
raise "uri list has more than one entry, should be a task" if res.content_type=~/text\/uri-list/ and res.split("\n").size > 1 #if uri list contains more then one uri, its not a task
task = OpenTox::Task.find(res.to_s.chomp) if res.to_s.uri?
else
raise "unknown content-type for task : '"+res.content_type.to_s+"'"+" base-uri: "+base_uri.to_s+" content: "+res[0..200].to_s
end
#LOGGER.debug "result is a task '"+task.uri.to_s+"', wait for completion"
task.wait waiting_task
unless task.completed? # maybe task was cancelled / error
if task.errorReport
received_error task.errorReport, task.http_code, nil, {:rest_uri => task.uri, :rest_code => task.http_code}
else
raise "status of task '"+task.uri.to_s+"' is no longer running (hasStatus is '"+task.status+
"'), but it is neither completed nor has an errorReport"
end
end
res = WrapperResult.new task.result_uri
res.code = task.http_code
res.content_type ="text/uri-list"
return res
end
def self.received_error( body, code, content_type=nil, params=nil )
# try to parse body
report = nil
if body.is_a?(OpenTox::ErrorReport)
report = body
else
case content_type
when /yaml/
report = YAML.load(body)
when /rdf/
report = OpenTox::ErrorReport.from_rdf(body)
end
end
unless report
# parsing was not successfull
# raise 'plain' RestCallError
err = OpenTox::RestCallError.new("REST call returned error: '"+body.to_s+"'")
err.rest_params = params
raise err
else
# parsing sucessfull
# raise RestCallError with parsed report as error cause
err = OpenTox::RestCallError.new("REST call subsequent error")
err.errorCause = report
err.rest_params = params
raise err
end
end
end
end
|
