Class: VeriCiteClient::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vericite_client/api_client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = Configuration.default) ⇒ ApiClient

Returns a new instance of ApiClient.



23
24
25
26
27
28
29
30
 
# File 'lib/vericite_client/api_client.rb', line 23

def initialize(config = Configuration.default)
  @config = config
  @user_agent = "ruby-vericite-#{VERSION}"
  @default_headers = {
    'Content-Type' => "application/json",
    'User-Agent' => @user_agent
  }
end

Instance Attribute Details

#config ⇒ Object

The Configuration object holding settings to be used in the API client.



16
17
18
 
# File 'lib/vericite_client/api_client.rb', line 16

def config
  @config
end

#default_headers ⇒ Hash

Defines the headers to be used in HTTP requests of all API calls by default.

Returns:

  • (Hash) 


21
22
23
 
# File 'lib/vericite_client/api_client.rb', line 21

def default_headers
  @default_headers
end

Class Method Details

.default ⇒ Object 



32
33
34
 
# File 'lib/vericite_client/api_client.rb', line 32

def self.default
  @@default ||= ApiClient.new
end

Instance Method Details

#build_collection_param(param, collection_format) ⇒ Object

Build parameter value according to the given collection format.

Parameters:

  • collection_format (String) —

    one of :csv, :ssv, :tsv, :pipes and :multi



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/vericite_client/api_client.rb', line 324

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 = {}) ⇒ Object 



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
 
# File 'lib/vericite_client/api_client.rb', line 62

def build_request(http_method, path, opts = {})
  url = build_request_url(path)
  http_method = http_method.to_sym.downcase

  header_params = @default_headers.merge(opts[:header_params] || {})
  query_params = opts[:query_params] || {}
  form_params = opts[:form_params] || {}

  if [:post, :patch, :put, :delete].include?(http_method)
    req_body = build_request_body(header_params, form_params, opts[:body])
    if @config.debugging
      @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
    end
  end
  uri = URI("#{url}?#{URI.encode_www_form(query_params)}")
  https = Net::HTTP.new(uri.host,uri.port)
  https.use_ssl = true
  rootCA = '/etc/ssl/certs'
  if File.directory? rootCA
    https.ca_path = rootCA
    https.verify_mode = OpenSSL::SSL::VERIFY_PEER
    https.verify_depth = 5
  else
    https.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end

  path = "#{uri.path}?#{uri.query}"
  case http_method
  when :put
    req = Net::HTTP::Put.new(uri)
  when :post
    req = Net::HTTP::Post.new(uri)
  when :get
    req = Net::HTTP::Get.new(uri)
  when :delete
    req = Net::HTTP::Delete.new(uri)
  end    
  req.body = req_body
  # Headers
  header_params.each do |key, value|
    if key == :consumer
      key = "consumer"
    elsif key == :consumerSecret
      key = "consumerSecret"
    end
    req.add_field(key, value)
  end 
  res = https.start{|con|
    con.request(req)
  }
end

#build_request_body(header_params, form_params, body) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/vericite_client/api_client.rb', line 236

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) ⇒ Object 



230
231
232
233
234
 
# File 'lib/vericite_client/api_client.rb', line 230

def build_request_url(path)
  # Add leading and trailing slashes to path
  path = "/#{path}".gsub(/\/+/, '/')
  URI.encode(@config.base_url + path)
end

#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Call an API with given options.

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    an array of 3 elements: the data deserialized from response body (could be nil), response status code and response headers.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/vericite_client/api_client.rb', line 40

def call_api(http_method, path, opts = {})
  response = build_request(http_method, path, opts)

  if @config.debugging
    @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
  end

  unless response.kind_of? Net::HTTPSuccess
    fail ApiError.new(:code => response.code,
                      :response_headers => response.to_hash,
                      :response_body => response.body),
         response.message
  end

  if opts[:return_type]
    data = deserialize(response, opts[:return_type])
  else
    data = nil
  end
  return data, response.code, response.to_hash
end

#convert_to_type(data, return_type) ⇒ Object

Convert data to the given return type.



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
 
# File 'lib/vericite_client/api_client.rb', line 155

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
    VeriCiteClient.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.

Parameters:

  • return_type (String) —

    some examples: “User”, “Array”, “Hash”



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
 
# File 'lib/vericite_client/api_client.rb', line 126

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.to_hash['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.

Returns:

  • (Tempfile) —

    the file downloaded

See Also:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/vericite_client/api_client.rb', line 198

def download_file(response)
  content_disposition = response.to_hash['Content-Disposition']
  if content_disposition
    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

#json_mime?(mime) ⇒ Boolean

Check if the given MIME is a JSON MIME. JSON MIME examples:

application/json
application/json; charset=UTF8
APPLICATION/JSON

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/vericite_client/api_client.rb', line 119

def json_mime?(mime)
   !!(mime =~ /\Aapplication\/json(;.*)?\z/i)
end

#object_to_hash(obj) ⇒ String

Convert object(non-array) to hash.

Parameters:

  • obj (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



314
315
316
317
318
319
320
 
# File 'lib/vericite_client/api_client.rb', line 314

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.

Parameters:

  • model (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/vericite_client/api_client.rb', line 300

def object_to_http_body(model)
  return model if model.nil? || model.is_a?(String)
  _body = nil
  if model.is_a?(Array)
    _body = model.map{|m| object_to_hash(m) }
  else
    _body = object_to_hash(model)
  end
  _body.to_json
end

#sanitize_filename(filename) ⇒ String

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

Parameters:

  • filename (String) —

    the filename to be sanitized

Returns:

  • (String) —

    the sanitized filename



226
227
228
 
# File 'lib/vericite_client/api_client.rb', line 226

def sanitize_filename(filename)
  filename.gsub /.*[\/\\]/, ''
end

#select_header_accept(accepts) ⇒ String

Return Accept header based on an array of accepts provided.

Parameters:

  • accepts (Array) —

    array for Accept

Returns:

  • (String) —

    the Accept header (e.g. application/json)



279
280
281
282
283
284
 
# File 'lib/vericite_client/api_client.rb', line 279

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.

Parameters:

  • content_types (Array) —

    array for Content-Type

Returns:

  • (String) —

    the Content-Type header (e.g. application/json)



289
290
291
292
293
294
295
 
# File 'lib/vericite_client/api_client.rb', line 289

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

#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object

Update hearder and query params based on authentication settings.



259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/vericite_client/api_client.rb', line 259

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

#uploadfile(path, file) ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/vericite_client/api_client.rb', line 342

def uploadfile(path, file)
  url = URI.parse(path)
  
  response = Net::HTTP.start(url.host) do |http|
    http.send_request("PUT", url.request_uri, (file.is_a?(String) ? file : file.read), {
      # This is required, or Net::HTTP will add a default unsigned content-type.
      "content-type" => "",
    })
  end
  unless response.kind_of? Net::HTTPSuccess
    fail ApiError.new(:code => response.code,
                      :response_headers => response.to_hash,
                      :response_body => response.body),
         response.message
  end
  response
end

#user_agent=(user_agent) ⇒ Object 



271
272
273
274
 
# File 'lib/vericite_client/api_client.rb', line 271

def user_agent=(user_agent)
  @user_agent = user_agent
  @default_headers['User-Agent'] = @user_agent
end