summaryrefslogtreecommitdiff
path: root/lib/rest_client_wrapper.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rest_client_wrapper.rb')
-rw-r--r--lib/rest_client_wrapper.rb182
1 files changed, 0 insertions, 182 deletions
diff --git a/lib/rest_client_wrapper.rb b/lib/rest_client_wrapper.rb
deleted file mode 100644
index 30f04cc..0000000
--- a/lib/rest_client_wrapper.rb
+++ /dev/null
@@ -1,182 +0,0 @@
-require 'rest-client'
-module OpenTox
-
- class WrapperResult < String
- attr_accessor :content_type, :code
- end
-
- class RestClientWrapper
-
- # 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
-
- private
- def self.execute( rest_call, uri, payload=nil, headers={}, waiting_task=nil, wait=true )
-
- raise OpenTox::BadRequestError.new "uri is nil" unless uri
- raise OpenTox::BadRequestError.new "not a uri: "+uri.to_s unless uri.to_s.uri?
- raise "headers are no hash: "+headers.inspect unless headers==nil or headers.is_a?(Hash)
- 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 "__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 => 60})
- if rest_call=="post" || rest_call=="put"
- result = resource.send(rest_call, payload, headers)
- else
- result = resource.send(rest_call, headers)
- 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
-
- 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_for_completion 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 "task status: '"+task.status.to_s+"' but errorReport nil"
- 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