5 class NotLoggedInException < StandardError
7 class InvalidApiResponseException < StandardError
10 @@profiling_enabled = Rails.configuration.profiling_enabled
13 # An API client object suitable for handling API requests on behalf
14 # of the current thread.
15 def self.new_or_current
16 Thread.current[:arvados_api_client] ||= new
21 @client_mtx = Mutex.new
24 def api(resources_kind, action, data=nil)
28 @client_mtx.synchronize do
29 @api_client = HTTPClient.new
30 if Rails.configuration.arvados_insecure_https
31 @api_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
33 # Use system CA certificates
34 @api_client.ssl_config.add_trust_ca('/etc/ssl/certs')
39 api_token = Thread.current[:arvados_api_token]
42 resources_kind = class_kind(resources_kind).pluralize if resources_kind.is_a? Class
43 url = "#{self.arvados_v1_base}/#{resources_kind}#{action}"
45 # Clean up /arvados/v1/../../discovery/v1 to /discovery/v1
46 url.sub! '/arvados/v1/../../', '/'
48 query = {"api_token" => api_token}
51 if v.is_a? String or v.nil?
58 query[k] = JSON.dump(v)
62 query["_method"] = "GET"
64 if @@profiling_enabled
65 query["_profile"] = "true"
68 header = {"Accept" => "application/json"}
70 profile_checkpoint { "Prepare request #{url} #{query[:uuid]} #{query[:where]}" }
71 msg = @client_mtx.synchronize do
76 profile_checkpoint 'API transaction'
78 if msg.status_code == 401
79 raise NotLoggedInException.new
85 resp = Oj.load(json, :symbol_keys => true)
87 raise InvalidApiResponseException.new json
89 if not resp.is_a? Hash
90 raise InvalidApiResponseException.new json
92 if msg.status_code != 200
93 errors = resp[:errors]
94 errors = errors.join("\n\n") if errors.is_a? Array
95 raise "#{errors} [API: #{msg.status_code}]"
98 Rails.logger.info "API client: " \
99 "#{resp.delete(:_profile)[:request_time]} request_time"
101 profile_checkpoint 'Parse response'
105 def self.patch_paging_vars(ary, items_available, offset, limit)
107 (class << ary; self; end).class_eval { attr_accessor :items_available }
108 ary.items_available = items_available
111 (class << ary; self; end).class_eval { attr_accessor :offset }
115 (class << ary; self; end).class_eval { attr_accessor :limit }
121 def unpack_api_response(j, kind=nil)
122 if j.is_a? Hash and j[:items].is_a? Array and j[:kind].match(/(_list|List)$/)
123 ary = j[:items].collect { |x| unpack_api_response x, x[:kind] }
124 self.class.patch_paging_vars(ary, j[:items_available], j[:offset], j[:limit])
125 elsif j.is_a? Hash and (kind || j[:kind])
126 oclass = self.kind_class(kind || j[:kind])
129 childkind = j["#{k.to_s}_kind".to_sym]
131 j[k] = self.unpack_api_response(j[k], childkind)
134 oclass.new.private_reload(j)
143 def arvados_login_url(params={})
144 if Rails.configuration.respond_to? :arvados_login_base
145 uri = Rails.configuration.arvados_login_base
147 uri = self.arvados_v1_base.sub(%r{/arvados/v\d+.*}, '/login')
150 uri += '?' << params.collect { |k,v|
151 CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
156 def arvados_logout_url(params={})
157 arvados_login_url(params).sub('/login','/logout')
161 Rails.configuration.arvados_v1_base
165 @@discovery ||= api '../../discovery/v1/apis/arvados/v1/rest', ''
169 kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
172 def class_kind(resource_class)
173 resource_class.to_s.underscore
177 def profile_checkpoint label=nil
178 return if !@@profiling_enabled
179 label = yield if block_given?
181 if label and @profile_t0
182 Rails.logger.info "API client: #{t - @profile_t0} #{label}"