Skip to content

Commit 3cb9d09

Browse files
fehguyfehguy
committed
Merge branch 'ruby-void-response' of ssh://github.com/xhh/swagger-codegen into xhh-ruby-void-response
2 parents d83a275 + 9cf4c66 commit 3cb9d09

File tree

5 files changed

+71
-56
lines changed

5 files changed

+71
-56
lines changed

‎modules/swagger-codegen/src/main/resources/ruby/api.mustache‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module {{moduleName}}
1212
{{#allParams}}{{#required}} # @param {{paramName}} {{description}}
1313
{{/required}}{{/allParams}} # @param [Hash] opts the optional parameters
1414
{{#allParams}}{{^required}} # @option opts [{{dataType}}] :{{paramName}} {{description}}
15-
{{/required}}{{/allParams}} # @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
15+
{{/required}}{{/allParams}} # @return [{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}nil{{/returnType}}]
1616
def self.{{nickname}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
1717
{{#allParams}}{{#required}}
1818
# verify the required parameter '{{paramName}}' is set
@@ -51,8 +51,9 @@ module {{moduleName}}
5151
{{/bodyParam}}
5252

5353
{{#returnType}}response = Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
54-
{{#returnContainer}}response.map {|response| {{/returnContainer}}obj = {{returnBaseType}}.new() and obj.build_from_hash(response){{#returnContainer}} }{{/returnContainer}}{{/returnType}}{{^returnType}} Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make{{/returnType}}
55-
end
54+
{{#returnContainer}}response.map {|response| {{/returnContainer}}obj = {{returnBaseType}}.new() and obj.build_from_hash(response){{#returnContainer}} }{{/returnContainer}}{{/returnType}}{{^returnType}}Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
55+
nil{{/returnType}}
56+
end
5657
{{/operation}}
5758
end
5859
{{/operations}}

‎samples/client/petstore/ruby/lib/swagger_client/api/pet_api.rb‎

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class PetApi
99
#
1010
# @param [Hash] opts the optional parameters
1111
# @option opts [Pet] :body Pet object that needs to be added to the store
12-
# @return void
12+
# @return [nil]
1313
def self.update_pet(opts = {})
1414

1515

@@ -37,14 +37,15 @@ def self.update_pet(opts = {})
3737
post_body = Swagger::Request.object_to_http_body(opts[:'body'])
3838

3939

40-
Swagger::Request.new(:PUT, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
41-
end
40+
Swagger::Request.new(:PUT, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
41+
nil
42+
end
4243

4344
# Add a new pet to the store
4445
#
4546
# @param [Hash] opts the optional parameters
4647
# @option opts [Pet] :body Pet object that needs to be added to the store
47-
# @return void
48+
# @return [nil]
4849
def self.add_pet(opts = {})
4950

5051

@@ -72,14 +73,15 @@ def self.add_pet(opts = {})
7273
post_body = Swagger::Request.object_to_http_body(opts[:'body'])
7374

7475

75-
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
76-
end
76+
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
77+
nil
78+
end
7779

7880
# Finds Pets by status
7981
# Multiple status values can be provided with comma seperated strings
8082
# @param [Hash] opts the optional parameters
8183
# @option opts [array[string]] :status Status values that need to be considered for filter
82-
# @return array[Pet]
84+
# @return [array[Pet]]
8385
def self.find_pets_by_status(opts = {})
8486

8587

@@ -110,13 +112,13 @@ def self.find_pets_by_status(opts = {})
110112

111113
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
112114
response.map {|response| obj = Pet.new() and obj.build_from_hash(response) }
113-
end
115+
end
114116

115117
# Finds Pets by tags
116118
# Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
117119
# @param [Hash] opts the optional parameters
118120
# @option opts [array[string]] :tags Tags to filter by
119-
# @return array[Pet]
121+
# @return [array[Pet]]
120122
def self.find_pets_by_tags(opts = {})
121123

122124

@@ -147,13 +149,13 @@ def self.find_pets_by_tags(opts = {})
147149

148150
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
149151
response.map {|response| obj = Pet.new() and obj.build_from_hash(response) }
150-
end
152+
end
151153

152154
# Find pet by ID
153155
# Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
154156
# @param pet_id ID of pet that needs to be fetched
155157
# @param [Hash] opts the optional parameters
156-
# @return Pet
158+
# @return [Pet]
157159
def self.get_pet_by_id(pet_id, opts = {})
158160

159161
# verify the required parameter 'pet_id' is set
@@ -186,15 +188,15 @@ def self.get_pet_by_id(pet_id, opts = {})
186188

187189
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
188190
obj = Pet.new() and obj.build_from_hash(response)
189-
end
191+
end
190192

191193
# Updates a pet in the store with form data
192194
#
193195
# @param pet_id ID of pet that needs to be updated
194196
# @param [Hash] opts the optional parameters
195197
# @option opts [string] :name Updated name of the pet
196198
# @option opts [string] :status Updated status of the pet
197-
# @return void
199+
# @return [nil]
198200
def self.update_pet_with_form(pet_id, opts = {})
199201

200202
# verify the required parameter 'pet_id' is set
@@ -227,15 +229,16 @@ def self.update_pet_with_form(pet_id, opts = {})
227229
post_body = nil
228230

229231

230-
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
231-
end
232+
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
233+
nil
234+
end
232235

233236
# Deletes a pet
234237
#
235238
# @param pet_id Pet id to delete
236239
# @param [Hash] opts the optional parameters
237240
# @option opts [string] :api_key
238-
# @return void
241+
# @return [nil]
239242
def self.delete_pet(pet_id, opts = {})
240243

241244
# verify the required parameter 'pet_id' is set
@@ -267,16 +270,17 @@ def self.delete_pet(pet_id, opts = {})
267270
post_body = nil
268271

269272

270-
Swagger::Request.new(:DELETE, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
271-
end
273+
Swagger::Request.new(:DELETE, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
274+
nil
275+
end
272276

273277
# uploads an image
274278
#
275279
# @param pet_id ID of pet to update
276280
# @param [Hash] opts the optional parameters
277281
# @option opts [string] :additional_metadata Additional data to pass to server
278282
# @option opts [file] :file file to upload
279-
# @return void
283+
# @return [nil]
280284
def self.upload_file(pet_id, opts = {})
281285

282286
# verify the required parameter 'pet_id' is set
@@ -309,7 +313,8 @@ def self.upload_file(pet_id, opts = {})
309313
post_body = nil
310314

311315

312-
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
313-
end
316+
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
317+
nil
318+
end
314319
end
315320
end

‎samples/client/petstore/ruby/lib/swagger_client/api/store_api.rb‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class StoreApi
88
# Returns pet inventories by status
99
# Returns a map of status codes to quantities
1010
# @param [Hash] opts the optional parameters
11-
# @return map[string,int]
11+
# @return [map[string,int]]
1212
def self.get_inventory(opts = {})
1313

1414

@@ -38,13 +38,13 @@ def self.get_inventory(opts = {})
3838

3939
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
4040
response.map {|response| obj = map.new() and obj.build_from_hash(response) }
41-
end
41+
end
4242

4343
# Place an order for a pet
4444
#
4545
# @param [Hash] opts the optional parameters
4646
# @option opts [Order] :body order placed for purchasing the pet
47-
# @return Order
47+
# @return [Order]
4848
def self.place_order(opts = {})
4949

5050

@@ -74,13 +74,13 @@ def self.place_order(opts = {})
7474

7575
response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
7676
obj = Order.new() and obj.build_from_hash(response)
77-
end
77+
end
7878

7979
# Find purchase order by ID
8080
# For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
8181
# @param order_id ID of pet that needs to be fetched
8282
# @param [Hash] opts the optional parameters
83-
# @return Order
83+
# @return [Order]
8484
def self.get_order_by_id(order_id, opts = {})
8585

8686
# verify the required parameter 'order_id' is set
@@ -113,13 +113,13 @@ def self.get_order_by_id(order_id, opts = {})
113113

114114
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
115115
obj = Order.new() and obj.build_from_hash(response)
116-
end
116+
end
117117

118118
# Delete purchase order by ID
119119
# For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
120120
# @param order_id ID of the order that needs to be deleted
121121
# @param [Hash] opts the optional parameters
122-
# @return void
122+
# @return [nil]
123123
def self.delete_order(order_id, opts = {})
124124

125125
# verify the required parameter 'order_id' is set
@@ -150,7 +150,8 @@ def self.delete_order(order_id, opts = {})
150150
post_body = nil
151151

152152

153-
Swagger::Request.new(:DELETE, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
154-
end
153+
Swagger::Request.new(:DELETE, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
154+
nil
155+
end
155156
end
156157
end

‎samples/client/petstore/ruby/lib/swagger_client/api/user_api.rb‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class UserApi
99
# This can only be done by the logged in user.
1010
# @param [Hash] opts the optional parameters
1111
# @option opts [User] :body Created user object
12-
# @return void
12+
# @return [nil]
1313
def self.create_user(opts = {})
1414

1515

@@ -37,14 +37,15 @@ def self.create_user(opts = {})
3737
post_body = Swagger::Request.object_to_http_body(opts[:'body'])
3838

3939

40-
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
41-
end
40+
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
41+
nil
42+
end
4243

4344
# Creates list of users with given input array
4445
#
4546
# @param [Hash] opts the optional parameters
4647
# @option opts [array[User]] :body List of user object
47-
# @return void
48+
# @return [nil]
4849
def self.create_users_with_array_input(opts = {})
4950

5051

@@ -72,14 +73,15 @@ def self.create_users_with_array_input(opts = {})
7273
post_body = Swagger::Request.object_to_http_body(opts[:'body'])
7374

7475

75-
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
76-
end
76+
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
77+
nil
78+
end
7779

7880
# Creates list of users with given input array
7981
#
8082
# @param [Hash] opts the optional parameters
8183
# @option opts [array[User]] :body List of user object
82-
# @return void
84+
# @return [nil]
8385
def self.create_users_with_list_input(opts = {})
8486

8587

@@ -107,15 +109,16 @@ def self.create_users_with_list_input(opts = {})
107109
post_body = Swagger::Request.object_to_http_body(opts[:'body'])
108110

109111

110-
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
111-
end
112+
Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
113+
nil
114+
end
112115

113116
# Logs user into the system
114117
#
115118
# @param [Hash] opts the optional parameters
116119
# @option opts [string] :username The user name for login
117120
# @option opts [string] :password The password for login in clear text
118-
# @return string
121+
# @return [string]
119122
def self.login_user(opts = {})
120123

121124

@@ -147,12 +150,12 @@ def self.login_user(opts = {})
147150

148151
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
149152
obj = string.new() and obj.build_from_hash(response)
150-
end
153+
end
151154

152155
# Logs out current logged in user session
153156
#
154157
# @param [Hash] opts the optional parameters
155-
# @return void
158+
# @return [nil]
156159
def self.logout_user(opts = {})
157160

158161

@@ -180,14 +183,15 @@ def self.logout_user(opts = {})
180183
post_body = nil
181184

182185

183-
Swagger::Request.new(:GET, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
184-
end
186+
Swagger::Request.new(:GET, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
187+
nil
188+
end
185189

186190
# Get user by user name
187191
#
188192
# @param username The name that needs to be fetched. Use user1 for testing.
189193
# @param [Hash] opts the optional parameters
190-
# @return User
194+
# @return [User]
191195
def self.get_user_by_name(username, opts = {})
192196

193197
# verify the required parameter 'username' is set
@@ -220,14 +224,14 @@ def self.get_user_by_name(username, opts = {})
220224

221225
response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
222226
obj = User.new() and obj.build_from_hash(response)
223-
end
227+
end
224228

225229
# Updated user
226230
# This can only be done by the logged in user.
227231
# @param username name that need to be deleted
228232
# @param [Hash] opts the optional parameters
229233
# @option opts [User] :body Updated user object
230-
# @return void
234+
# @return [nil]
231235
def self.update_user(username, opts = {})
232236

233237
# verify the required parameter 'username' is set
@@ -258,14 +262,15 @@ def self.update_user(username, opts = {})
258262
post_body = Swagger::Request.object_to_http_body(opts[:'body'])
259263

260264

261-
Swagger::Request.new(:PUT, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
262-
end
265+
Swagger::Request.new(:PUT, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
266+
nil
267+
end
263268

264269
# Delete user
265270
# This can only be done by the logged in user.
266271
# @param username The name that needs to be deleted
267272
# @param [Hash] opts the optional parameters
268-
# @return void
273+
# @return [nil]
269274
def self.delete_user(username, opts = {})
270275

271276
# verify the required parameter 'username' is set
@@ -296,7 +301,8 @@ def self.delete_user(username, opts = {})
296301
post_body = nil
297302

298303

299-
Swagger::Request.new(:DELETE, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
300-
end
304+
Swagger::Request.new(:DELETE, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make
305+
nil
306+
end
301307
end
302308
end

‎samples/client/petstore/ruby/spec/pet_spec.rb‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@
7575

7676
it "should create a pet" do
7777
pet = SwaggerClient::Pet.new('id' => 10002, 'name' => "RUBY UNIT TESTING")
78-
SwaggerClient::PetApi.add_pet(:body => pet)
78+
result = SwaggerClient::PetApi.add_pet(:body => pet)
79+
# nothing is returned
80+
result.should be_nil
7981

8082
pet = SwaggerClient::PetApi.get_pet_by_id(10002)
8183
pet.id.should == 10002

0 commit comments

Comments
 (0)