Class: Apcera::ApiClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host = nil) ⇒ ApiClient

Returns a new instance of ApiClient.



21
22
23
24
25
26
27
28
29
 
# File 'lib/apcera/api_client.rb', line 21

def initialize(host = nil)
  @host = host || Configuration.base_url
  @format = 'json'
  @user_agent = "ruby-swagger-#{VERSION}"
  @default_headers = {
    'Content-Type' => "application/#{@format.downcase}",
    'User-Agent' => @user_agent
  }
end

Instance Attribute Details

#default_headers ⇒ Hash

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

Returns:

  • (Hash) 


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

def default_headers
  @default_headers
end

#host ⇒ Object

Returns the value of attribute host.



11
12
13
 
# File 'lib/apcera/api_client.rb', line 11

def host
  @host
end

#last_response ⇒ Object

Stores the HTTP response from the last API call using this API client.



19
20
21
 
# File 'lib/apcera/api_client.rb', line 19

def last_response
  @last_response
end

Instance Method Details

#build_request(http_method, path, opts = {}) ⇒ Object 



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
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/apcera/api_client.rb', line 56

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] || {}

  
  update_params_for_auth! header_params, query_params, opts[:auth_names]
  

  req_opts = {
    :method => http_method,
    :headers => header_params,
    :params => query_params,
    :ssl_verifypeer => Configuration.verify_ssl,
    :cainfo => Configuration.ssl_ca_cert,
    :verbose => Configuration.debugging
  }

  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 Configuration.debugging
        # JRS: If it contains a null, it is probably binary
        #
        if (!req_body.nil? && req_body !~ /\x00/ )
            Configuration.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
        else
            Configuration.logger.debug "HTTP request body param ~(Skipping likely binary body)"
        end
    end
  end

  Typhoeus::Request.new(url, req_opts)
end

#build_request_body(header_params, form_params, body) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/apcera/api_client.rb', line 202

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.dup
    data.each do |key, value|
      data[key] = value.to_s if value && !value.is_a?(File)
    end
  elsif body
    data = body.is_a?(String) ? body : body.to_json
  else
    data = nil
  end
  data
end

#build_request_url(path) ⇒ Object 



196
197
198
199
200
 
# File 'lib/apcera/api_client.rb', line 196

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

#call_api(http_method, path, opts = {}) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/apcera/api_client.rb', line 31

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

  # record as last response
  @last_response = response

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

  unless response.success?
    fail ApiError.new(:code => response.code,
                      :response_headers => response.headers,
                      :response_body => response.body),
         response.status_message
  end

  if opts[:return_type]
    deserialize(response, opts[:return_type])
  else
    nil
  end
end

#convert_to_type(data, return_type) ⇒ Object

Convert data to the given return type.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/apcera/api_client.rb', line 131

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, 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
    Apcera.const_get(return_type).new.tap do |model|
  # JRS
      if Configuration.debugging
    Configuration.logger.info "#{model.class.name} hash: " + JSON.pretty_generate(data)
      end
      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”



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

def deserialize(response, return_type)
  body = response.body
  return nil if body.nil? || body.empty?

  # 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'

  # JRS handle application/octet-stream by brute force
  #
  if content_type.start_with?('application/octet-stream')
        return body
  end

  unless content_type.start_with?('application/json')
    fail "Content-Type is not supported: #{content_type}"
  end

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

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:

  • (File) —

    the file downloaded

See Also:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/apcera/api_client.rb', line 178

def download_file(response)
  tmp_file = Tempfile.new '', Configuration.temp_folder_path
  content_disposition = response.headers['Content-Disposition']
  if content_disposition
    filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
    path = File.join File.dirname(tmp_file), filename
  else
    path = tmp_file.path
  end
  # close and delete temp file
  tmp_file.close!

  File.open(path, 'w') { |file| file.write(response.body) }
  Configuration.logger.info "File written to #{path}. Please move the file to a proper "\
                            "folder for further processing and delete the temp afterwards"
  File.new(path)
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



286
287
288
289
290
291
292
 
# File 'lib/apcera/api_client.rb', line 286

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/apcera/api_client.rb', line 265

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

  # JRS: might be binary, if it doesn't work w/ to_json just fall back
  #
  begin
    _body.to_json
  rescue
    _body
  end
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)



239
240
241
242
243
244
245
246
247
 
# File 'lib/apcera/api_client.rb', line 239

def select_header_accept(accepts)
  if accepts.empty?
    return
  elsif accepts.any?{ |s| s.casecmp('application/json') == 0 }
    'application/json' # look for json data by default
  else
    accepts.join(',')
  end
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)



252
253
254
255
256
257
258
259
260
 
# File 'lib/apcera/api_client.rb', line 252

def select_header_content_type(content_types)
  if content_types.empty?
    'application/json' # use application/json by default
  elsif content_types.any?{ |s| s.casecmp('application/json')==0 }
    'application/json' # use application/json if it's included
  else
    content_types[0] # otherwise, use the first one
  end
end

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

Update hearder and query params based on authentication settings.



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/apcera/api_client.rb', line 219

def update_params_for_auth!(header_params, query_params, auth_names)
  Array(auth_names).each do |auth_name|
    auth_setting = Configuration.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 



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

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