Class: SwaggerPetstore::UserController

Inherits:
BaseController show all
Defined in:
lib/swagger_petstore/controllers/user_controller.rb

Overview

UserController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from SwaggerPetstore::BaseController

Instance Method Details

#create_user(body) ⇒ void

This method returns an undefined value.

This can only be done by the logged in user.

Parameters:

  • body (User) —

    Required parameter: Created user object



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 168

def create_user(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user',
                                 Server::SERVER1)
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('global')))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('default',
                            'successful operation',
                            APIException))
    .execute
end

#create_users_with_array_input(body) ⇒ void

This method returns an undefined value.

Creates list of users with given input array

Parameters:

  • body (List of User) —

    Required parameter: List of user object



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 12

def create_users_with_array_input(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/createWithArray',
                                 Server::SERVER1)
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('global')))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('default',
                            'successful operation',
                            APIException))
    .execute
end

#create_users_with_list_input(body) ⇒ void

This method returns an undefined value.

Creates list of users with given input array

Parameters:

  • body (List of User) —

    Required parameter: List of user object



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 32

def create_users_with_list_input(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/createWithList',
                                 Server::SERVER1)
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('global')))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('default',
                            'successful operation',
                            APIException))
    .execute
end

#delete_user(username) ⇒ void

This method returns an undefined value.

This can only be done by the logged in user. deleted

Parameters:

  • username (String) —

    Required parameter: The name that needs to be



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 106

def delete_user(username)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/user/{username}',
                                 Server::SERVER1)
               .template_param(new_parameter(username, key: 'username')
                                .should_encode(true))
               .auth(Single.new('global')))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('400',
                            'Invalid username supplied',
                            APIException)
               .local_error('404',
                            'User not found',
                            APIException))
    .execute
end

#get_user_by_name(username) ⇒ User

Get user by user name fetched. Use user1 for testing.

Parameters:

  • username (String) —

    Required parameter: The name that needs to be

Returns:

  • (User) —

    response from the API call



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 53

def get_user_by_name(username)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/{username}',
                                 Server::SERVER1)
               .template_param(new_parameter(username, key: 'username')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('global')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(User.method(:from_hash))
               .local_error('400',
                            'Invalid username supplied',
                            APIException)
               .local_error('404',
                            'User not found',
                            APIException))
    .execute
end

#login_user(username, password) ⇒ String

Logs user into the system clear text

Parameters:

  • username (String) —

    Required parameter: The user name for login

  • password (String) —

    Required parameter: The password for login in

Returns:

  • (String) —

    response from the API call



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 130

def (username,
               password)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/login',
                                 Server::SERVER1)
               .query_param(new_parameter(username, key: 'username'))
               .query_param(new_parameter(password, key: 'password'))
               .auth(Single.new('global')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:deserialize_primitive_types))
               .deserialize_into(proc do |response| response.to_s end)
               .is_primitive_response(true)
               .local_error('400',
                            'Invalid username/password supplied',
                            APIException))
    .execute
end

#logout_user ⇒ void

This method returns an undefined value.

Logs out current logged in user session



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 151

def logout_user
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/logout',
                                 Server::SERVER1)
               .auth(Single.new('global')))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('default',
                            'successful operation',
                            APIException))
    .execute
end

#update_user(username, body) ⇒ void

This method returns an undefined value.

This can only be done by the logged in user. updated

Parameters:

  • username (String) —

    Required parameter: name that need to be

  • body (User) —

    Required parameter: Updated user object



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/swagger_petstore/controllers/user_controller.rb', line 79

def update_user(username,
                body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/user/{username}',
                                 Server::SERVER1)
               .template_param(new_parameter(username, key: 'username')
                                .should_encode(true))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('global')))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('400',
                            'Invalid user supplied',
                            APIException)
               .local_error('404',
                            'User not found',
                            APIException))
    .execute
end