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(authorization, create_user_body = nil) ⇒ Object

Create a User

Parameters:

  • authorization (String) —

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

  • create_user_body (CreateUserBody) (defaults to: nil) —

    Optional parameter: the content of the request

Returns:

  • CreateUserResponse response from the API call



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
143
144
145
146
147
148
149
150
 
# File 'lib/gonebusy/controllers/users_controller.rb', line 112

def create_user(authorization, 
                create_user_body = nil)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/users/new'
  _query_url = APIHelper.clean_url _query_builder

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

  # prepare and execute HttpRequest
  _request = @http_client.post _query_url, headers: _headers, parameters: create_user_body.to_json
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 422
    raise EntitiesErrorErrorException.new 'Unprocessable Entity', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  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(authorization, id) ⇒ 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



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

def get_user_by_id(authorization, 
                   id)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/users/{id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

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

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

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

#get_users(authorization, page = 1, per_page = 10) ⇒ 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) (defaults to: 1) —

    Optional parameter: Page offset to fetch.

  • per_page (Integer) (defaults to: 10) —

    Optional parameter: Number of results to return per page.

Returns:

  • GetUsersResponse response from the API call



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

def get_users(authorization, 
              page = 1, 
              per_page = 10)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/users'
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'page' => page,
    'per_page' => per_page
  }, array_serialization: Configuration.array_serialization
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

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

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  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(authorization, id, update_user_by_id_body = nil) ⇒ 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) (defaults to: nil) —

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

def update_user_by_id(authorization, 
                      id, 
                      update_user_by_id_body = nil)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/users/{id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => id
  }
  _query_url = APIHelper.clean_url _query_builder

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

  # prepare and execute HttpRequest
  _request = @http_client.put _query_url, headers: _headers, parameters: update_user_by_id_body.to_json
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif _context.response.status_code == 422
    raise EntitiesErrorErrorException.new 'Unprocessable Entity', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

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