Class: TestAsdasdasd::PetController

Inherits:
BaseController show all
Defined in:
lib/test_asdasdasd/controllers/pet_controller.rb

Overview

PetController

Class Attribute Summary collapse

Attributes inherited from BaseController

#http_call_back, #http_client

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from TestAsdasdasd::BaseController

Class Attribute Details

.instance ⇒ Object

Returns the value of attribute instance.



12
13
14
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 12

def instance
  @instance
end

Instance Method Details

#add_pet(body) ⇒ Object

Add a new pet to the store the store

Parameters:

  • body (Pet) —

    Required parameter: Pet object that needs to be added to

Returns:

  • void response from the API call



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 23

def add_pet(body)
  # Prepare query url.
  _path_url = '/pet'
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 405
    raise APIException.new(
      'Invalid input',
      _context
    )
  end
  validate_response(_context)
end

#delete_pet(pet_id, api_key = nil) ⇒ Object

Deletes a pet

Parameters:

  • pet_id (Long) —

    Required parameter: Pet id to delete

  • api_key (String) (defaults to: nil) —

    Optional parameter: Example:

Returns:

  • void response from the API call



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 277

def delete_pet(pet_id,
               api_key = nil)
  # Prepare query url.
  _path_url = '/pet/{petId}'
  _path_url = APIHelper.append_url_with_template_parameters(
    _path_url,
    'petId' => pet_id
  )
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'api_key' => api_key
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.delete(
    _query_url,
    headers: _headers
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 400
    raise APIException.new(
      'Invalid ID supplied',
      _context
    )
  elsif _context.response.status_code == 404
    raise APIException.new(
      'Pet not found',
      _context
    )
  end
  validate_response(_context)
end

#find_pets_by_status(status) ⇒ Object

Multiple status values can be provided with comma separated strings need to be considered for filter

Parameters:

  • status (List of Status2Enum) —

    Required parameter: Status values that

Returns:

  • List of Pet response from the API call



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
136
137
138
139
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 101

def find_pets_by_status(status)
  # Prepare query url.
  _path_url = '/pet/findByStatus'
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_builder = APIHelper.append_url_with_query_parameters(
    _query_builder,
    {
      'status' => status
    },
    array_serialization: Configuration.array_serialization
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.get(
    _query_url,
    headers: _headers
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 400
    raise APIException.new(
      'Invalid status value',
      _context
    )
  end
  validate_response(_context)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  decoded.map { |element| Pet.from_hash(element) }
end

#find_pets_by_tags(tags) ⇒ Object

Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Parameters:

  • tags (List of String) —

    Required parameter: Tags to filter by

Returns:

  • List of Pet response from the API call



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
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 145

def find_pets_by_tags(tags)
  # Prepare query url.
  _path_url = '/pet/findByTags'
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_builder = APIHelper.append_url_with_query_parameters(
    _query_builder,
    {
      'tags' => tags
    },
    array_serialization: Configuration.array_serialization
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.get(
    _query_url,
    headers: _headers
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 400
    raise APIException.new(
      'Invalid tag value',
      _context
    )
  end
  validate_response(_context)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  decoded.map { |element| Pet.from_hash(element) }
end

#get_pet_by_id(pet_id) ⇒ Object

Returns a single pet

Parameters:

  • pet_id (Long) —

    Required parameter: ID of pet to return

Returns:

  • Pet response from the API call



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
222
223
224
225
226
227
228
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 188

def get_pet_by_id(pet_id)
  # Prepare query url.
  _path_url = '/pet/{petId}'
  _path_url = APIHelper.append_url_with_template_parameters(
    _path_url,
    'petId' => pet_id
  )
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.get(
    _query_url,
    headers: _headers
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 400
    raise APIException.new(
      'Invalid ID supplied',
      _context
    )
  elsif _context.response.status_code == 404
    raise APIException.new(
      'Pet not found',
      _context
    )
  end
  validate_response(_context)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  Pet.from_hash(decoded)
end

#instance ⇒ Object 



15
16
17
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 15

def instance
  self.class.instance
end

#update_pet(body) ⇒ Object

Update an existing pet the store

Parameters:

  • body (Pet) —

    Required parameter: Pet object that needs to be added to

Returns:

  • void response from the API call



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
93
94
95
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 57

def update_pet(body)
  # Prepare query url.
  _path_url = '/pet'
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.put(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 400
    raise APIException.new(
      'Invalid ID supplied',
      _context
    )
  elsif _context.response.status_code == 404
    raise APIException.new(
      'Pet not found',
      _context
    )
  elsif _context.response.status_code == 405
    raise APIException.new(
      'Validation exception',
      _context
    )
  end
  validate_response(_context)
end

#update_pet_with_form(pet_id, name = nil, status = nil) ⇒ Object

Updates a pet in the store with form data updated

Parameters:

  • pet_id (Long) —

    Required parameter: ID of pet that needs to be

  • name (String) (defaults to: nil) —

    Optional parameter: Updated name of the pet

  • status (String) (defaults to: nil) —

    Optional parameter: Updated status of the pet

Returns:

  • void response from the API call



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 236

def update_pet_with_form(pet_id,
                         name = nil,
                         status = nil)
  # Prepare query url.
  _path_url = '/pet/{petId}'
  _path_url = APIHelper.append_url_with_template_parameters(
    _path_url,
    'petId' => pet_id
  )
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare form parameters.
  _parameters = {
    'name' => name,
    'status' => status
  }
  _parameters = APIHelper.form_encode_parameters(_parameters)

  # Prepare and execute HttpRequest.
  _request = @http_client.post(
    _query_url,
    parameters: _parameters
  )
  _context = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _context.response.status_code == 405
    raise APIException.new(
      'Invalid input',
      _context
    )
  end
  validate_response(_context)
end

#upload_file(pet_id, additional_metadata = nil, file = nil) ⇒ Object

uploads an image pass to server

Parameters:

  • pet_id (Long) —

    Required parameter: ID of pet to update

  • additional_metadata (String) (defaults to: nil) —

    Optional parameter: Additional data to

  • file (File) (defaults to: nil) —

    Optional parameter: file to upload

Returns:

  • ApiResponse response from the API call



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/test_asdasdasd/controllers/pet_controller.rb', line 322

def upload_file(pet_id,
                additional_metadata = nil,
                file = nil)
  # Prepare query url.
  _path_url = '/pet/{petId}/uploadImage'
  _path_url = APIHelper.append_url_with_template_parameters(
    _path_url,
    'petId' => pet_id
  )
  _query_builder = Configuration.get_base_uri
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare form parameters.
  _parameters = {
    'additionalMetadata' => additional_metadata,
    'file' => file
  }
  _parameters = APIHelper.form_encode_parameters(_parameters)

  # Prepare and execute HttpRequest.
  _request = @http_client.post(
    _query_url,
    headers: _headers,
    parameters: _parameters
  )
  _context = execute_request(_request)
  validate_response(_context)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  ApiResponse.from_hash(decoded)
end