Class: Bandwidth::Messaging::APIController

Inherits:
BaseController show all
Defined in:
lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

Overview

APIController

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #validate_parameters, #validate_response

Constructor Details

#initialize(config, http_call_back: nil) ⇒ APIController

Returns a new instance of APIController.



10
11
12
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 10

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#create_message(user_id, body: nil) ⇒ BandwidthMessage

createMessage

Parameters:

  • user_id (String) —

    Required parameter: Example:

  • body (MessageRequest) (defaults to: nil) —

    Optional parameter: Example:

Returns:



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
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
360
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 297

def create_message(user_id,
                   body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{userId}/messages'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'userId' => user_id
  )
  _query_url = APIHelper.clean_url _query_builder

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

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  elsif _response.status_code == 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  elsif _response.status_code == 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  elsif _response.status_code == 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  elsif _response.status_code == 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  elsif _response.status_code == 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(_response, data: BandwidthMessage.from_hash(decoded))
end

#delete_media(user_id, media_id) ⇒ void

This method returns an undefined value.

deleteMedia

Parameters:

  • user_id (String) —

    Required parameter: Example:

  • media_id (String) —

    Required parameter: Example:



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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 236

def delete_media(user_id,
                 media_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{userId}/media/{mediaId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'userId' => user_id,
    'mediaId' => media_id
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  elsif _response.status_code == 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  elsif _response.status_code == 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  elsif _response.status_code == 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  elsif _response.status_code == 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  elsif _response.status_code == 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end

#get_media(user_id, media_id) ⇒ Binary

getMedia

Parameters:

  • user_id (String) —

    Required parameter: Example:

  • media_id (String) —

    Required parameter: Example:

Returns:

  • (Binary) —

    response from the API call



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
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
140
141
142
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 87

def get_media(user_id,
              media_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{userId}/media/{mediaId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'userId' => user_id,
    'mediaId' => media_id
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request, binary: true)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  elsif _response.status_code == 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  elsif _response.status_code == 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  elsif _response.status_code == 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  elsif _response.status_code == 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  elsif _response.status_code == 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response, data: _response.raw_body)
end

#list_media(user_id, continuation_token: nil) ⇒ List of Media

listMedia

Parameters:

  • user_id (String) —

    Required parameter: Example:

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

    Optional parameter: Example:

Returns:

  • (List of Media) —

    response from the API call



18
19
20
21
22
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
52
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
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 18

def list_media(user_id,
               continuation_token: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{userId}/media'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'userId' => user_id
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'Continuation-Token' => continuation_token
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  elsif _response.status_code == 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  elsif _response.status_code == 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  elsif _response.status_code == 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  elsif _response.status_code == 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  elsif _response.status_code == 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(_response,
                  data: decoded.map { |element| Media.from_hash(element) })
end

#upload_media(user_id, media_id, content_length, body, content_type: 'application/octet-stream', cache_control: nil) ⇒ void

This method returns an undefined value.

uploadMedia Example:application/octet-stream

Parameters:

  • user_id (String) —

    Required parameter: Example:

  • media_id (String) —

    Required parameter: Example:

  • content_length (Long) —

    Required parameter: Example:

  • body (File | UploadIO) —

    Required parameter: Example:

  • content_type (String) (defaults to: 'application/octet-stream') —

    Optional parameter:

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

    Optional parameter: Example:



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
184
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
222
223
224
225
226
227
228
229
230
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 153

def upload_media(user_id,
                 media_id,
                 content_length,
                 body,
                 content_type: 'application/octet-stream',
                 cache_control: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{userId}/media/{mediaId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'userId' => user_id,
    'mediaId' => media_id
  )
  _query_url = APIHelper.clean_url _query_builder

  if body.is_a? FileWrapper
    body_wrapper = body.file
    body_content_type = body.content_type
  else
    body_wrapper = body
    body_content_type = content_type
  end

  # Prepare headers.
  _headers = {
    'content-type' => body_content_type,
    'content-length' => body_wrapper.size.to_s,
    'Content-Length' => content_length,
    'Cache-Control' => cache_control
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.put(
    _query_url,
    headers: _headers,
    parameters: body_wrapper
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  elsif _response.status_code == 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  elsif _response.status_code == 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  elsif _response.status_code == 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  elsif _response.status_code == 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  elsif _response.status_code == 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end