Class: Gonebusy::UsersController

Inherits:
BaseController show all
Defined in:
lib/gonebusy/controllers/users_controller.rb

Constant Summary collapse

@@instance = 
UsersController.new

Instance Attribute Summary

Attributes inherited from BaseController

#http_call_back, #http_client

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from Gonebusy::BaseController

Class Method Details

.instance ⇒ Object

Singleton instance of the controller class



7
8
9
 
# File 'lib/gonebusy/controllers/users_controller.rb', line 7

def self.instance
  @@instance
end

Instance Method Details

#create_user(options = Hash.new) ⇒ Object

Create a User

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • create_user_body (CreateUserBody) —

    Required parameter: the content of the request

Returns:

  • CreateUserResponse response from the API call



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
172
173
174
175
176
177
178
179
180
 
# File 'lib/gonebusy/controllers/users_controller.rb', line 133

def create_user(options = Hash.new)

  # the base uri for api requests

  _query_builder = Configuration.base_uri.dup

  # prepare query string for API call

  _query_builder << '/users/new'

  # validate and preprocess url

  _query_url = APIHelper.clean_url _query_builder

  # prepare headers

  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8',
    'Authorization' => Configuration.authorization,
    'Authorization' => options['authorization']
  }

  # create the HttpRequest object for the call

  _request = @http_client.post _query_url, headers: _headers, parameters: options['create_user_body'].to_json

  # apply authentication

  CustomAuth.apply(_request)

  # execute the request

  _context = execute_request(_request)

  # endpoint error handling using HTTP status codes.

  if _context.response.status_code == 400
    raise EntitiesErrorException.new '400 - Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorException.new '403 - Forbidden', _context
  elsif _context.response.status_code == 422
    raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
  elsif _context.response.status_code == 500
    raise APIException.new '500 - Unexpected error', _context
  end

  # global error handling using HTTP status codes.

  validate_response(_context)

  # return appropriate response type

  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return CreateUserResponse.from_hash(decoded)
end

#get_user_by_id(options = Hash.new) ⇒ Object

Return a User by id.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • id (String) —

    Required parameter: Example:

Returns:

  • GetUserByIdResponse response from the API call



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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/gonebusy/controllers/users_controller.rb', line 76

def get_user_by_id(options = Hash.new)

  # the base uri for api requests

  _query_builder = Configuration.base_uri.dup

  # prepare query string for API call

  _query_builder << '/users/{id}'

  # process optional query parameters

  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => options['id']
  }

  # validate and preprocess url

  _query_url = APIHelper.clean_url _query_builder

  # prepare headers

  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => options['authorization']
  }

  # create the HttpRequest object for the call

  _request = @http_client.get _query_url, headers: _headers

  # apply authentication

  CustomAuth.apply(_request)

  # execute the request

  _context = execute_request(_request)

  # endpoint error handling using HTTP status codes.

  if _context.response.status_code == 400
    raise EntitiesErrorException.new '400 - Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorException.new '403 - Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorException.new '404 - Not Found', _context
  elsif _context.response.status_code == 500
    raise APIException.new '500 - Unexpected error', _context
  end

  # global error handling using HTTP status codes.

  validate_response(_context)

  # return appropriate response type

  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetUserByIdResponse.from_hash(decoded)
end

#get_users(options = Hash.new) ⇒ Object

Return all Users that your account has access to. Includes your own User as well as any Users for which you are the Account Manager.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • page (Integer) —

    Optional parameter: Page offset to fetch.

  • per_page (Integer) —

    Optional parameter: Number of results to return per page.

Returns:

  • GetUsersResponse response from the API call



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
231
232
233
234
235
236
237
 
# File 'lib/gonebusy/controllers/users_controller.rb', line 187

def get_users(options = Hash.new)

  # the base uri for api requests

  _query_builder = Configuration.base_uri.dup

  # prepare query string for API call

  _query_builder << '/users'

  # process optional query parameters

  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'page' => options['page'],
    'per_page' => options['per_page']
  }

  # validate and preprocess url

  _query_url = APIHelper.clean_url _query_builder

  # prepare headers

  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => options['authorization']
  }

  # create the HttpRequest object for the call

  _request = @http_client.get _query_url, headers: _headers

  # apply authentication

  CustomAuth.apply(_request)

  # execute the request

  _context = execute_request(_request)

  # endpoint error handling using HTTP status codes.

  if _context.response.status_code == 400
    raise EntitiesErrorException.new '400 - Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorException.new '403 - Forbidden', _context
  elsif _context.response.status_code == 500
    raise APIException.new '500 - Unexpected error', _context
  end

  # global error handling using HTTP status codes.

  validate_response(_context)

  # return appropriate response type

  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetUsersResponse.from_hash(decoded)
end

#update_user_by_id(options = Hash.new) ⇒ Object

Update a User by id, with params.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • id (String) —

    Required parameter: Example:

  • update_user_by_id_body (UpdateUserByIdBody) —

    Required parameter: the content of the request

Returns:

  • UpdateUserByIdResponse response from the API call



16
17
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
 
# File 'lib/gonebusy/controllers/users_controller.rb', line 16

def update_user_by_id(options = Hash.new)

  # the base uri for api requests

  _query_builder = Configuration.base_uri.dup

  # prepare query string for API call

  _query_builder << '/users/{id}'

  # process optional query parameters

  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => options['id']
  }

  # validate and preprocess url

  _query_url = APIHelper.clean_url _query_builder

  # prepare headers

  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8',
    'Authorization' => Configuration.authorization,
    'Authorization' => options['authorization']
  }

  # create the HttpRequest object for the call

  _request = @http_client.put _query_url, headers: _headers, parameters: options['update_user_by_id_body'].to_json

  # apply authentication

  CustomAuth.apply(_request)

  # execute the request

  _context = execute_request(_request)

  # endpoint error handling using HTTP status codes.

  if _context.response.status_code == 400
    raise EntitiesErrorException.new '400 - Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorException.new '403 - Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorException.new '404 - Not Found', _context
  elsif _context.response.status_code == 422
    raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
  elsif _context.response.status_code == 500
    raise APIException.new '500 - Unexpected error', _context
  end

  # global error handling using HTTP status codes.

  validate_response(_context)

  # return appropriate response type

  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return UpdateUserByIdResponse.from_hash(decoded)
end