X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d84737275793fcab0ac253c4abe734ad5e84ea12..7aeb2366c284475c34764abc2dbed1367ef3bbc3:/sdk/ruby/lib/arvados.rb diff --git a/sdk/ruby/lib/arvados.rb b/sdk/ruby/lib/arvados.rb index 5be1fd939e..d8a6be1b2d 100644 --- a/sdk/ruby/lib/arvados.rb +++ b/sdk/ruby/lib/arvados.rb @@ -1,25 +1,21 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: Apache-2.0 + require 'rubygems' -require 'google/api_client' require 'active_support/inflector' require 'json' +require 'fileutils' +require 'andand' + +require 'arvados/google_api_client' ActiveSupport::Inflector.inflections do |inflect| inflect.irregular 'specimen', 'specimens' inflect.irregular 'human', 'humans' end -module Kernel - def suppress_warnings - original_verbosity = $VERBOSE - $VERBOSE = nil - result = yield - $VERBOSE = original_verbosity - return result - end -end - class Arvados - class TransactionFailedError < StandardError end @@ -32,20 +28,22 @@ class Arvados @application_version ||= 0.0 @application_name ||= File.split($0).last - @config = self.load_config_file + @arvados_api_version = opts[:api_version] || 'v1' - @arvados_api_version = opts[:api_version] || - @config['ARVADOS_API_VERSION'] || - 'v1' - @arvados_api_host = opts[:api_host] || - @config['ARVADOS_API_HOST'] or - raise "#{$0}: no :api_host or ENV[ARVADOS_API_HOST] provided." - @arvados_api_token = opts[:api_token] || - @config['ARVADOS_API_TOKEN'] or - raise "#{$0}: no :api_token or ENV[ARVADOS_API_TOKEN] provided." + @config = nil + [[:api_host, 'ARVADOS_API_HOST'], + [:api_token, 'ARVADOS_API_TOKEN']].each do |op, en| + if opts[op] + config[en] = opts[op] + end + if !config[en] + raise "#{$0}: no :#{op} or ENV[#{en}] provided." + end + end if (opts[:suppress_ssl_warnings] or - @config['ARVADOS_API_HOST_INSECURE']) + %w(1 true yes).index(config['ARVADOS_API_HOST_INSECURE']. + andand.downcase)) suppress_warnings do OpenSSL::SSL.const_set 'VERIFY_PEER', OpenSSL::SSL::VERIFY_NONE end @@ -78,7 +76,7 @@ class Arvados each do |method| class << klass; self; end.class_eval do define_method method.name do |*params| - self.api_exec(method.name.to_sym, *params) + self.api_exec method, *params end end end @@ -86,7 +84,7 @@ class Arvados # Give the new class access to the API klass.instance_eval do @arvados = _arvados - # These should be pulled from the discovery document instead: + # TODO: Pull these from the discovery document instead. @api_models_sym = classname.underscore.split('/').last.pluralize.to_sym @api_model_sym = classname.underscore.split('/').last.to_sym end @@ -96,32 +94,15 @@ class Arvados # result looks like Arvados::A26949680::Job. namespace_class.const_set classname, klass - self.class.class_eval do - define_method classname.underscore do - klass - end + self.define_singleton_method classname.underscore do + klass end end end - class Google::APIClient - def discovery_document(api, version) - api = api.to_s - return @discovery_documents["#{api}:#{version}"] ||= - begin - response = self.execute!( - :http_method => :get, - :uri => self.discovery_uri(api, version), - :authenticated => false - ) - response.body.class == String ? JSON.parse(response.body) : response.body - end - end - end - def client @client ||= Google::APIClient. - new(:host => @arvados_api_host, + new(:host => config["ARVADOS_API_HOST"], :application_name => @application_name, :application_version => @application_version.to_s) end @@ -134,30 +115,57 @@ class Arvados $stderr.puts "#{File.split($0).last} #{$$}: #{message}" if @@debuglevel >= verbosity end - def load_config_file(config_file_path="~/.config/arvados/settings.conf") + def debuglog *args + self.class.debuglog *args + end + + def config(config_file_path="~/.config/arvados/settings.conf") + return @config if @config + # Initialize config settings with environment variables. config = {} config['ARVADOS_API_HOST'] = ENV['ARVADOS_API_HOST'] config['ARVADOS_API_TOKEN'] = ENV['ARVADOS_API_TOKEN'] config['ARVADOS_API_HOST_INSECURE'] = ENV['ARVADOS_API_HOST_INSECURE'] - config['ARVADOS_API_VERSION'] = ENV['ARVADOS_API_VERSION'] - - # Load settings from the config file. - lineno = 0 - File.open(File.expand_path config_file_path).each do |line| - lineno = lineno + 1 - # skip comments and blank lines - next if line.match('^\s*#') or not line.match('\S') - var, val = line.chomp.split('=', 2) - # allow environment settings to override config files. - if var and val - config[var] ||= val - else - warn "#{config_file}: #{lineno}: could not parse `#{line}'" + + if config['ARVADOS_API_HOST'] and config['ARVADOS_API_TOKEN'] + # Environment variables take precedence over the config file, so + # there is no point reading the config file. If the environment + # specifies a _HOST without asking for _INSECURE, we certainly + # shouldn't give the config file a chance to create a + # system-wide _INSECURE state for this user. + # + # Note: If we start using additional configuration settings from + # this file in the future, we might have to read the file anyway + # instead of returning here. + return (@config = config) + end + + begin + expanded_path = File.expand_path config_file_path + if File.exist? expanded_path + # Load settings from the config file. + lineno = 0 + File.open(expanded_path).each do |line| + lineno = lineno + 1 + # skip comments and blank lines + next if line.match('^\s*#') or not line.match('\S') + var, val = line.chomp.split('=', 2) + var.strip! + val.strip! + # allow environment settings to override config files. + if !var.empty? and val + config[var] ||= val + else + debuglog "#{expanded_path}: #{lineno}: could not parse `#{line}'", 0 + end + end end + rescue StandardError => e + debuglog "Ignoring error reading #{config_file_path}: #{e}", 0 end - config + @config = config end class Model @@ -174,22 +182,36 @@ class Arvados self.class.arvados.class.debuglog *args end def self.api_exec(method, parameters={}) - parameters = parameters. - merge(:api_token => @config['ARVADOS_API_TOKEN']) + api_method = arvados_api.send(api_models_sym).send(method.name.to_sym) parameters.each do |k,v| parameters[k] = v.to_json if v.is_a? Array or v.is_a? Hash end + # Look for objects expected by request.properties.(key).$ref and + # move them from parameters (query string) to request body. + body = nil + method.discovery_document['request']. + andand['properties']. + andand.each do |k,v| + if v.is_a? Hash and v['$ref'] + body ||= {} + body[k] = parameters.delete k.to_sym + end + end result = client. - execute(:api_method => arvados_api.send(api_models_sym).send(method), + execute(:api_method => api_method, :authenticated => false, - :parameters => parameters) + :parameters => parameters, + :body_object => body, + :headers => { + :authorization => 'Bearer '+arvados.config['ARVADOS_API_TOKEN'] + }) resp = JSON.parse result.body, :symbolize_names => true if resp[:errors] raise Arvados::TransactionFailedError.new(resp[:errors]) elsif resp[:uuid] and resp[:etag] self.new(resp) elsif resp[:items].is_a? Array - resp.merge(items: resp[:items].collect do |i| + resp.merge(:items => resp[:items].collect do |i| self.new(i) end) else @@ -234,4 +256,16 @@ class Arvados @attributes = j end end + + protected + + def suppress_warnings + original_verbosity = $VERBOSE + begin + $VERBOSE = nil + yield + ensure + $VERBOSE = original_verbosity + end + end end