Class: DocuSign_eSign::ApiClient
- Inherits:
-
Object
- Object
- DocuSign_eSign::ApiClient
- Defined in:
- lib/docusign_esign/client/api_client.rb
Instance Attribute Summary collapse
-
#base_path ⇒ Object
Returns the value of attribute base_path.
-
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
-
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
-
#oauth_base_path ⇒ Object
Returns the value of attribute oauth_base_path.
Class Method Summary collapse
Instance Method Summary collapse
-
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
-
#build_request(http_method, path, opts = {}) ⇒ Typhoeus::Request
Builds the HTTP request.
-
#build_request_body(header_params, form_params, body) ⇒ String
Builds the HTTP request body.
- #build_request_url(path, opts) ⇒ Object
-
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
-
#convert_to_type(data, return_type) ⇒ Mixed
Convert data to the given return type.
-
#deserialize(response, return_type) ⇒ Object
Deserialize the response to the given return type.
-
#download_file(response) ⇒ Tempfile
Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename.
-
#generate_access_token(client_id, client_secret, code) ⇒ Object
GenerateAccessToken will exchange the authorization code for an access token and refresh tokens.
-
#get_authorization_uri(client_id, scopes, redirect_uri, response_type, state = nil) ⇒ String
Helper method to configure the OAuth accessCode/implicit flow parameters.
-
#get_oauth_base_path ⇒ Object
Helper method to get oauth base path.
-
#get_user_info(access_token) ⇒ OAuth::UserInfo
Get User Info method takes the accessToken to retrieve User Account Data.
-
#initialize(config = Configuration.default) ⇒ ApiClient
constructor
Initializes the ApiClient.
-
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME.
-
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
-
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
-
#request_jwt_application_token(client_id, private_key_or_filename, expires_in = 3600, scopes = OAuth::SCOPE_SIGNATURE) ⇒ OAuth::OAuthToken
Request JWT User Token.
-
#request_jwt_user_token(client_id, user_id, private_key_or_filename, expires_in = 3600, scopes = OAuth::SCOPE_SIGNATURE) ⇒ OAuth::OAuthToken
Request JWT User Token.
-
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path.
-
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
-
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
-
#set_base_path(base_path) ⇒ Object
Helper method to set base_path.
-
#set_default_header(header_name, header_value) ⇒ Object
Helper method to add default header params.
-
#set_oauth_base_path(oauth_base_path = nil) ⇒ Object
Helper method to set oauth base path.
-
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update hearder and query params based on authentication settings.
-
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header.
Constructor Details
#initialize(config = Configuration.default) ⇒ ApiClient
Initializes the ApiClient
36 37 38 39 40 41 42 43 |
# File 'lib/docusign_esign/client/api_client.rb', line 36 def initialize(config = Configuration.default) @config = config @user_agent = "Swagger-Codegen/3.15.0/ruby" @default_headers = { 'Content-Type' => "application/json", 'User-Agent' => @user_agent } end |
Instance Attribute Details
#base_path ⇒ Object
Returns the value of attribute base_path.
31 32 33 |
# File 'lib/docusign_esign/client/api_client.rb', line 31 def base_path @base_path end |
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
24 25 26 |
# File 'lib/docusign_esign/client/api_client.rb', line 24 def config @config end |
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
29 30 31 |
# File 'lib/docusign_esign/client/api_client.rb', line 29 def default_headers @default_headers end |
#oauth_base_path ⇒ Object
Returns the value of attribute oauth_base_path.
32 33 34 |
# File 'lib/docusign_esign/client/api_client.rb', line 32 def oauth_base_path @oauth_base_path end |
Class Method Details
Instance Method Details
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/docusign_esign/client/api_client.rb', line 368 def build_collection_param(param, collection_format) case collection_format when :csv param.join(',') when :ssv param.join(' ') when :tsv param.join("\t") when :pipes param.join('|') when :multi # return the array directly as typhoeus will handle it as expected param else fail "unknown collection format: #{collection_format.inspect}" end end |
#build_request(http_method, path, opts = {}) ⇒ Typhoeus::Request
Builds the HTTP request
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 |
# File 'lib/docusign_esign/client/api_client.rb', line 93 def build_request(http_method, path, opts = {}) url = build_request_url(path, opts) http_method = http_method.to_sym.downcase header_params = @default_headers.merge(opts[:header_params] || {}) # Add SDK default header header_params.store("X-DocuSign-SDK", "Ruby") query_params = opts[:query_params] || {} form_params = opts[:form_params] || {} update_params_for_auth! header_params, query_params, opts[:auth_names] # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false) _verify_ssl_host = @config.verify_ssl_host ? 2 : 0 req_opts = { :method => http_method, :headers => header_params, :params => query_params, :params_encoding => @config.params_encoding, :timeout => @config.timeout, :ssl_verifypeer => @config.verify_ssl, :ssl_verifyhost => _verify_ssl_host, :sslcert => @config.cert_file, :sslkey => @config.key_file, :verbose => @config.debugging } # set custom cert, if provided req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert if [:post, :patch, :put, :delete].include?(http_method) req_body = build_request_body(header_params, form_params, opts[:body]) req_opts.update :body => req_body if @config.debugging @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" end end Typhoeus::Request.new(url, req_opts) end |
#build_request_body(header_params, form_params, body) ⇒ String
Builds the HTTP request body
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/docusign_esign/client/api_client.rb', line 273 def build_request_body(header_params, form_params, body) # http form if header_params['Content-Type'] == 'application/x-www-form-urlencoded' || header_params['Content-Type'] == 'multipart/form-data' data = {} form_params.each do |key, value| case value when File, Array, nil # let typhoeus handle File, Array and nil parameters data[key] = value else data[key] = value.to_s end end elsif body data = body.is_a?(String) ? body : body.to_json else data = nil end data end |
#build_request_url(path, opts) ⇒ Object
260 261 262 263 264 265 |
# File 'lib/docusign_esign/client/api_client.rb', line 260 def build_request_url(path, opts) # Add leading and trailing slashes to path path = "/#{path}".gsub(/\/+/, '/') return Addressable::URI.encode("https://" + self.get_oauth_base_path + path) if opts[:oauth] Addressable::URI.encode(@config.base_url + path) end |
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
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 |
# File 'lib/docusign_esign/client/api_client.rb', line 53 def call_api(http_method, path, opts = {}) request = build_request(http_method, path, opts) response = request.run if @config.debugging @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" end unless response.success? if response.timed_out? fail ApiError.new('Connection timed out') elsif response.code == 0 # Errors from libcurl will be made visible here fail ApiError.new(:code => 0, :message => response.) else fail ApiError.new(:code => response.code, :response_headers => response.headers, :response_body => response.body), response. end end if opts[:return_type] data = deserialize(response, opts[:return_type]) else data = nil end return data, response.code, response.headers end |
#convert_to_type(data, return_type) ⇒ Mixed
Convert data to the given return type.
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 |
# File 'lib/docusign_esign/client/api_client.rb', line 185 def convert_to_type(data, return_type) return nil if data.nil? case return_type when 'String' data.to_s when 'Integer' data.to_i when 'Float' data.to_f when 'BOOLEAN' data == true when 'DateTime' # parse date time (expecting ISO 8601 format) DateTime.parse data when 'Date' # parse date time (expecting ISO 8601 format) Date.parse data when 'Object' # generic object (usually a Hash), return directly data when /\AArray<(.+)>\z/ # e.g. Array<Pet> sub_type = $1 data.map {|item| convert_to_type(item, sub_type) } when /\AHash\<String, (.+)\>\z/ # e.g. Hash<String, Integer> sub_type = $1 {}.tap do |hash| data.each {|k, v| hash[k] = convert_to_type(v, sub_type) } end else # models, e.g. Pet DocuSign_eSign.const_get(return_type).new.tap do |model| model.build_from_hash data end end end |
#deserialize(response, return_type) ⇒ Object
Deserialize the response to the given return type.
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 |
# File 'lib/docusign_esign/client/api_client.rb', line 153 def deserialize(response, return_type) body = response.body return nil if body.nil? || body.empty? # return response body directly for String return type return body if return_type == 'String' # handle file downloading - save response body into a tmp file and return the File instance return download_file(response) if return_type == 'File' # ensuring a default content type content_type = response.headers['Content-Type'] || 'application/json' fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type) begin data = JSON.parse("[#{body}]", :symbolize_names => true)[0] rescue JSON::ParserError => e if %w(String Date DateTime).include?(return_type) data = body else raise e end end convert_to_type data, return_type end |
#download_file(response) ⇒ Tempfile
Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/docusign_esign/client/api_client.rb', line 228 def download_file(response) content_disposition = response.headers['Content-Disposition'] if content_disposition and content_disposition =~ /filename=/i filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1] prefix = sanitize_filename(filename) else prefix = 'download-' end prefix = prefix + '-' unless prefix.end_with?('-') tempfile = nil encoding = response.body.encoding Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file| file.write(response.body) tempfile = file end @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\ "will be deleted automatically with GC. It's also recommended to delete the temp file "\ "explicitly with `tempfile.delete`" tempfile end |
#generate_access_token(client_id, client_secret, code) ⇒ Object
GenerateAccessToken will exchange the authorization code for an access token and refresh tokens.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/docusign_esign/client/api_client.rb', line 560 def generate_access_token(client_id, client_secret, code) raise ArgumentError.new('client_id cannot be empty') if client_id.empty? raise ArgumentError.new('client_secret cannot be empty') if client_secret.empty? raise ArgumentError.new('code cannot be empty') if code.empty? authcode = "Basic " + Base64.strict_encode64("#{client_id}:#{client_secret}") params = { :header_params => { "Authorization" => authcode, "Content-Type" => "application/x-www-form-urlencoded" }, :form_params => { "grant_type" => 'authorization_code', "code" => code, }, :return_type => 'OAuth::OAuthToken', :oauth => true } token, status_code, headers = self.call_api("POST", '/oauth/token', params) if status_code == 200 self.default_headers.store('Authorization', "#{token.token_type} #{token.access_token}") token end end |
#get_authorization_uri(client_id, scopes, redirect_uri, response_type, state = nil) ⇒ String
Helper method to configure the OAuth accessCode/implicit flow parameters
432 433 434 435 436 437 438 439 440 441 |
# File 'lib/docusign_esign/client/api_client.rb', line 432 def (client_id, scopes, redirect_uri, response_type, state=nil) self.oauth_base_path ||= self.get_oauth_base_path scopes = scopes.join(' ') if scopes.kind_of?(Array) scopes = OAuth::SCOPE_SIGNATURE if scopes.empty? uri = "https://%{base_path}/oauth/auth?response_type=%{response_type}&scope=%{scopes}&client_id=%{client_id}&redirect_uri=%{redirect_uri}" uri += "&state=%{state}" if state uri % {base_path: self.oauth_base_path, response_type:response_type, scopes: scopes, client_id: client_id, redirect_uri: redirect_uri, state: state} end |
#get_oauth_base_path ⇒ Object
Helper method to get oauth base path
415 416 417 418 419 420 421 |
# File 'lib/docusign_esign/client/api_client.rb', line 415 def get_oauth_base_path if !self.oauth_base_path self.set_oauth_base_path() end self.oauth_base_path end |
#get_user_info(access_token) ⇒ OAuth::UserInfo
Get User Info method takes the accessToken to retrieve User Account Data.
544 545 546 547 548 549 550 551 552 553 554 |
# File 'lib/docusign_esign/client/api_client.rb', line 544 def get_user_info(access_token) raise ArgumentError.new('Cannot find a valid access token. Cannot find a valid access token.') if access_token.empty? params = { :header_params => {"Authorization" => 'Bearer ' + access_token}, :return_type => 'OAuth::UserInfo', :oauth => true } data, status_code, headers = self.call_api("GET", '/oauth/userinfo', params) data end |
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME. JSON MIME examples:
application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*
145 146 147 |
# File 'lib/docusign_esign/client/api_client.rb', line 145 def json_mime?(mime) (mime == "*/*") || !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil? end |
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
358 359 360 361 362 363 364 |
# File 'lib/docusign_esign/client/api_client.rb', line 358 def object_to_hash(obj) if obj.respond_to?(:to_hash) obj.to_hash else obj end end |
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
344 345 346 347 348 349 350 351 352 353 |
# File 'lib/docusign_esign/client/api_client.rb', line 344 def object_to_http_body(model) return model if model.nil? || model.is_a?(String) local_body = nil if model.is_a?(Array) local_body = model.map{|m| object_to_hash(m) } else local_body = object_to_hash(model) end local_body.to_json end |
#request_jwt_application_token(client_id, private_key_or_filename, expires_in = 3600, scopes = OAuth::SCOPE_SIGNATURE) ⇒ OAuth::OAuthToken
Request JWT User Token
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 |
# File 'lib/docusign_esign/client/api_client.rb', line 500 def request_jwt_application_token(client_id, private_key_or_filename, expires_in = 3600,scopes=OAuth::SCOPE_SIGNATURE) raise ArgumentError.new('client_id cannot be empty') if client_id.empty? raise ArgumentError.new('private_key_or_filename cannot be empty') if private_key_or_filename.empty? scopes = scopes.join(' ') if scopes.kind_of?(Array) scopes = OAuth::SCOPE_SIGNATURE if scopes.empty? expires_in = 3600 if expires_in > 3600 now = Time.now.to_i claim = { "iss" => client_id, "aud" => self.get_oauth_base_path, "iat" => now, "exp" => now + expires_in, "scope"=> scopes } private_key = if private_key_or_filename.include?("-----BEGIN RSA PRIVATE KEY-----") private_key_or_filename else File.read(private_key_or_filename) end private_key_bytes = OpenSSL::PKey::RSA.new private_key token = JWT.encode claim, private_key_bytes, 'RS256' params = { :header_params => {"Content-Type" => "application/x-www-form-urlencoded"}, :form_params => { "assertion" => token, "grant_type" => OAuth::GRANT_TYPE_JWT }, :return_type => 'OAuth::OAuthToken', :oauth => true } data, status_code, headers = self.call_api("POST", "/oauth/token", params) raise ApiError.new('Some error accrued during process') if data.nil? self.set_default_header('Authorization', data.token_type + ' ' + data.access_token) data end |
#request_jwt_user_token(client_id, user_id, private_key_or_filename, expires_in = 3600, scopes = OAuth::SCOPE_SIGNATURE) ⇒ OAuth::OAuthToken
Request JWT User Token
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/docusign_esign/client/api_client.rb', line 450 def request_jwt_user_token(client_id, user_id, private_key_or_filename, expires_in = 3600,scopes=OAuth::SCOPE_SIGNATURE) raise ArgumentError.new('client_id cannot be empty') if client_id.empty? raise ArgumentError.new('user_id cannot be empty') if user_id.empty? raise ArgumentError.new('private_key_or_filename cannot be empty') if private_key_or_filename.empty? scopes = scopes.join(' ') if scopes.kind_of?(Array) scopes = OAuth::SCOPE_SIGNATURE if scopes.empty? expires_in = 3600 if expires_in > 3600 now = Time.now.to_i claim = { "iss" => client_id, "sub" => user_id, "aud" => self.get_oauth_base_path, "iat" => now, "exp" => now + expires_in, "scope"=> scopes } private_key = if private_key_or_filename.include?("-----BEGIN RSA PRIVATE KEY-----") private_key_or_filename else File.read(private_key_or_filename) end private_key_bytes = OpenSSL::PKey::RSA.new private_key token = JWT.encode claim, private_key_bytes, 'RS256' params = { :header_params => {"Content-Type" => "application/x-www-form-urlencoded"}, :form_params => { "assertion" => token, "grant_type" => OAuth::GRANT_TYPE_JWT }, :return_type => 'OAuth::OAuthToken', :oauth => true } data, status_code, headers = self.call_api("POST", "/oauth/token", params) raise ApiError.new('Some error accrued during process') if data.nil? self.set_default_header('Authorization', data.token_type + ' ' + data.access_token) data end |
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif
256 257 258 |
# File 'lib/docusign_esign/client/api_client.rb', line 256 def sanitize_filename(filename) filename.gsub(/.*[\/\\]/, '') end |
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
323 324 325 326 327 328 |
# File 'lib/docusign_esign/client/api_client.rb', line 323 def select_header_accept(accepts) return nil if accepts.nil? || accepts.empty? # use JSON when present, otherwise use all of the provided json_accept = accepts.find { |s| json_mime?(s) } return json_accept || accepts.join(',') end |
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
333 334 335 336 337 338 339 |
# File 'lib/docusign_esign/client/api_client.rb', line 333 def select_header_content_type(content_types) # use application/json by default return 'application/json' if content_types.nil? || content_types.empty? # use JSON when present, otherwise use the first one json_content_type = content_types.find { |s| json_mime?(s) } return json_content_type || content_types.first end |
#set_base_path(base_path) ⇒ Object
Helper method to set base_path
388 389 390 |
# File 'lib/docusign_esign/client/api_client.rb', line 388 def set_base_path(base_path) self.base_path = base_path end |
#set_default_header(header_name, header_value) ⇒ Object
Helper method to add default header params
591 592 593 |
# File 'lib/docusign_esign/client/api_client.rb', line 591 def set_default_header(header_name, header_value) @default_headers[header_name] = header_value end |
#set_oauth_base_path(oauth_base_path = nil) ⇒ Object
Helper method to set oauth base path
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/docusign_esign/client/api_client.rb', line 394 def set_oauth_base_path(oauth_base_path=nil) if oauth_base_path raise ArgumentError.new('OAuth base path should only include domain name (without https://)') if oauth_base_path.include? "//" self.oauth_base_path = oauth_base_path return end # did we need this check as we can determine it from base path #raise ArgumentError.new('oAuthBasePath cannot be empty') unless oauth_base_path # Derive OAuth Base Path if not given if self.base_path.start_with?("https://demo") or self.base_path.start_with?("http://demo") self.oauth_base_path = OAuth::DEMO_OAUTH_BASE_PATH elsif self.base_path.start_with?("https://stage") or self.base_path.start_with?("http://stage") self.oauth_base_path = OAuth::STAGE_OAUTH_BASE_PATH else self.oauth_base_path = OAuth::PRODUCTION_OAUTH_BASE_PATH end end |
#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object
Update hearder and query params based on authentication settings.
300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/docusign_esign/client/api_client.rb', line 300 def update_params_for_auth!(header_params, query_params, auth_names) Array(auth_names).each do |auth_name| auth_setting = @config.auth_settings[auth_name] next unless auth_setting case auth_setting[:in] when 'header' then header_params[auth_setting[:key]] = auth_setting[:value] when 'query' then query_params[auth_setting[:key]] = auth_setting[:value] else fail ArgumentError, 'Authentication token must be in `query` of `header`' end end end |
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header
315 316 317 318 |
# File 'lib/docusign_esign/client/api_client.rb', line 315 def user_agent=(user_agent) @user_agent = user_agent @default_headers['User-Agent'] = @user_agent end |