Merge pull request #3368 from wing328/ruby_fix_rspec

[Ruby] fix default rspec test cases for Ruby API client

Author: wing328

modules/swagger-codegen/src/main/resources/ruby/api_client_spec.mustache

@@ -43,53 +43,6 @@ describe {{moduleName}}::ApiClient do
     end
   end
 
-  describe "#update_params_for_auth!" do
-    it "sets header api-key parameter with prefix" do
-      {{moduleName}}.configure do |c|
-        c.api_key_prefix['api_key'] = 'PREFIX'
-        c.api_key['api_key'] = 'special-key'
-      end
-
-      api_client = {{moduleName}}::ApiClient.new
-
-      config2 = {{moduleName}}::Configuration.new do |c|
-        c.api_key_prefix['api_key'] = 'PREFIX2'
-        c.api_key['api_key'] = 'special-key2'
-      end
-      api_client2 = {{moduleName}}::ApiClient.new(config2)
-
-      auth_names = ['api_key', 'unknown']
-
-      header_params = {}
-      query_params = {}
-      api_client.update_params_for_auth! header_params, query_params, auth_names
-      expect(header_params).to eq({'api_key' => 'PREFIX special-key'})
-      expect(query_params).to eq({})
-
-      header_params = {}
-      query_params = {}
-      api_client2.update_params_for_auth! header_params, query_params, auth_names
-      expect(header_params).to eq({'api_key' => 'PREFIX2 special-key2'})
-      expect(query_params).to eq({})
-    end
-
-    it "sets header api-key parameter without prefix" do
-      {{moduleName}}.configure do |c|
-        c.api_key_prefix['api_key'] = nil
-        c.api_key['api_key'] = 'special-key'
-      end
-
-      api_client = {{moduleName}}::ApiClient.new
-
-      header_params = {}
-      query_params = {}
-      auth_names = ['api_key', 'unknown']
-      api_client.update_params_for_auth! header_params, query_params, auth_names
-      expect(header_params).to eq({'api_key' => 'special-key'})
-      expect(query_params).to eq({})
-    end
-  end
-
   describe "params_encoding in #build_request" do
     let(:config) { {{moduleName}}::Configuration.new }
     let(:api_client) { {{moduleName}}::ApiClient.new(config) }
@@ -155,49 +108,18 @@ describe {{moduleName}}::ApiClient do
       expect(data).to be_instance_of(Hash)
       expect(data).to eq({:message => 'Hello'})
     end
-
-    it "handles Hash<String, Pet>" do
-      api_client = {{moduleName}}::ApiClient.new
-      headers = {'Content-Type' => 'application/json'}
-      response = double('response', headers: headers, body: '{"pet": {"id": 1}}')
-      data = api_client.deserialize(response, 'Hash<String, Pet>')
-      expect(data).to be_instance_of(Hash)
-      expect(data.keys).to eq([:pet])
-
-      pet = data[:pet]
-      expect(pet).to be_instance_of({{moduleName}}::Pet)
-      expect(pet.id).to eq(1)
-    end
-
-    it "handles Hash<String, Hash<String, Pet>>" do
-      api_client = {{moduleName}}::ApiClient.new
-      headers = {'Content-Type' => 'application/json'}
-      response = double('response', headers: headers, body: '{"data": {"pet": {"id": 1}}}')
-      result = api_client.deserialize(response, 'Hash<String, Hash<String, Pet>>')
-      expect(result).to be_instance_of(Hash)
-      expect(result.keys).to match_array([:data])
-
-      data = result[:data]
-      expect(data).to be_instance_of(Hash)
-      expect(data.keys).to match_array([:pet])
-
-      pet = data[:pet]
-      expect(pet).to be_instance_of({{moduleName}}::Pet)
-      expect(pet.id).to eq(1)
-    end
   end
 
   describe "#object_to_hash" do
     it "ignores nils and includes empty arrays" do
-      api_client = {{moduleName}}::ApiClient.new
-      pet = {{moduleName}}::Pet.new
-      pet.id = 1
-      pet.name = ''
-      pet.status = nil
-      pet.photo_urls = nil
-      pet.tags = []
-      expected = {id: 1, name: '', tags: []}
-      expect(api_client.object_to_hash(pet)).to eq(expected)
+      # uncomment below to test object_to_hash for model
+      #api_client = {{moduleName}}::ApiClient.new
+      #_model = {{moduleName}}::ModelName.new
+      # update the model attribute below
+      #_model.id = 1 
+      # update the expected value (hash) below
+      #expected = {id: 1, name: '', tags: []}
+      #expect(api_client.object_to_hash(_model)).to eq(expected)
     end
   end
 

modules/swagger-codegen/src/main/resources/ruby/configuration_spec.mustache

@@ -8,21 +8,26 @@ describe {{moduleName}}::Configuration do
   let(:config) { {{moduleName}}::Configuration.default }
 
   before(:each) do
-    {{moduleName}}.configure do |c|
-      c.host = 'petstore.swagger.io'
-      c.base_path = 'v2'
-    end
+    # uncomment below to setup host and base_path
+    #require 'URI'
+    #uri = URI.parse("{{{basePath}}}")
+    #{{moduleName}}.configure do |c|
+    #  c.host = uri.host
+    #  c.base_path = uri.path
+    #end
   end
 
   describe '#base_url' do
     it 'should have the default value' do
-      expect(config.base_url).to eq('http://petstore.swagger.io/v2')
+      # uncomment below to test default value of the base path
+      #expect(config.base_url).to eq("{{{basePath}}}")
     end
 
     it 'should remove trailing slashes' do
       [nil, '', '/', '//'].each do |base_path|
         config.base_path = base_path
-        expect(config.base_url).to eq('http://petstore.swagger.io')
+        # uncomment below to test trailing slashes
+        #expect(config.base_url).to eq("{{{basePath}}}")
       end
     end
   end

samples/client/petstore-security-test/ruby/README.md

@@ -1,14 +1,14 @@
 # petstore
 
-Petstore - the Ruby gem for the Swagger Petstore */ ' \" 
+Petstore - the Ruby gem for the Swagger Petstore */ ' \" =_end -- \\r\\n \\n \\r
 
-This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" 
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =_end --       
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 1.0.0 */ ' \" 
+- API version: 1.0.0 */ ' \" =_end -- \\r\\n \\n \\r
 - Package version: 1.0.0
-- Build date: 2016-06-28T17:34:19.923+08:00
+- Build date: 2016-07-14T18:21:54.437+08:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -58,25 +58,25 @@ require 'petstore'
 api_instance = Petstore::FakeApi.new
 
 opts = { 
-  test_code_inject____end: "test_code_inject____end_example" # String | To test code injection */ ' \" 
+  test_code_inject____end____rn_n_r: "test_code_inject____end____rn_n_r_example" # String | To test code injection */ ' \" =_end -- \\r\\n \\n \\r
 }
 
 begin
-  #To test code injection */ ' \" 
-  api_instance.test_code_inject____end(opts)
+  #To test code injection */ ' \" =_end -- \\r\\n \\n \\r
+  api_instance.test_code_inject____end__rn_n_r(opts)
 rescue Petstore::ApiError => e
-  puts "Exception when calling FakeApi->test_code_inject____end: #{e}"
+  puts "Exception when calling FakeApi->test_code_inject____end__rn_n_r: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://petstore.swagger.io */ ' " =end/v2 */ ' " =end*
+All URIs are relative to *https://petstore.swagger.io */ ' \" =_end -- \\r\\n \\n \\r/v2 */ ' \" =_end -- \\r\\n \\n \\r*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*Petstore::FakeApi* | [**test_code_inject____end**](docs/FakeApi.md#test_code_inject____end) | **PUT** /fake | To test code injection */ ' \" 
+*Petstore::FakeApi* | [**test_code_inject____end__rn_n_r**](docs/FakeApi.md#test_code_inject____end__rn_n_r) | **PUT** /fake | To test code injection */ ' \" =_end -- \\r\\n \\n \\r
 
 
 ## Documentation for Models
@@ -90,7 +90,7 @@ Class | Method | HTTP request | Description
 ### api_key
 
 - **Type**: API key
-- **API key parameter name**: api_key  */ ' " =end
+- **API key parameter name**: api_key  */ ' " =end -- \r\n \n \r
 - **Location**: HTTP header
 
 ### petstore_auth
@@ -99,6 +99,6 @@ Class | Method | HTTP request | Description
 - **Flow**: implicit
 - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
 - **Scopes**: 
-  - write:pets: modify pets in your account  */ ' " =end
-  - read:pets: read your pets  */ ' " =end
+  - write:pets: modify pets in your account  */ ' " =end -- \r\n \n \r
+  - read:pets: read your pets  */ ' " =end -- \r\n \n \r
 

samples/client/petstore-security-test/ruby/docs/FakeApi.md

@@ -1,16 +1,16 @@
 # Petstore::FakeApi
 
-All URIs are relative to *https://petstore.swagger.io */ ' " =end/v2 */ ' " =end*
+All URIs are relative to *https://petstore.swagger.io */ ' \" =_end -- \\r\\n \\n \\r/v2 */ ' \" =_end -- \\r\\n \\n \\r*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**test_code_inject____end**](FakeApi.md#test_code_inject____end) | **PUT** /fake | To test code injection */ ' \" 
+[**test_code_inject____end__rn_n_r**](FakeApi.md#test_code_inject____end__rn_n_r) | **PUT** /fake | To test code injection */ ' \" =_end -- \\r\\n \\n \\r
 
 
-# **test_code_inject____end**
-> test_code_inject____end(opts)
+# **test_code_inject____end__rn_n_r**
+> test_code_inject____end__rn_n_r(opts)
 
-To test code injection */ ' \" 
+To test code injection */ ' \" =_end -- \\r\\n \\n \\r
 
 ### Example
 ```ruby
@@ -20,22 +20,22 @@ require 'petstore'
 api_instance = Petstore::FakeApi.new
 
 opts = { 
-  test_code_inject____end: "test_code_inject____end_example" # String | To test code injection */ ' \" 
+  test_code_inject____end____rn_n_r: "test_code_inject____end____rn_n_r_example" # String | To test code injection */ ' \" =_end -- \\r\\n \\n \\r
 }
 
 begin
-  #To test code injection */ ' \" 
-  api_instance.test_code_inject____end(opts)
+  #To test code injection */ ' \" =_end -- \\r\\n \\n \\r
+  api_instance.test_code_inject____end__rn_n_r(opts)
 rescue Petstore::ApiError => e
-  puts "Exception when calling FakeApi->test_code_inject____end: #{e}"
+  puts "Exception when calling FakeApi->test_code_inject____end__rn_n_r: #{e}"
 end
 ```
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **test_code_inject____end** | **String**| To test code injection */ ' \"  | [optional] 
+ **test_code_inject____end____rn_n_r** | **String**| To test code injection */ ' \" =_end -- \\r\\n \\n \\r | [optional] 
 
 ### Return type
 
@@ -47,8 +47,8 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, */  " =end
- - **Accept**: application/json, */  " =end
+ - **Content-Type**: application/json, */  \" =_end --       
+ - **Accept**: application/json, */  \" =_end --       
 
 
 

samples/client/petstore-security-test/ruby/docs/ModelReturn.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**_return** | **Integer** | property description  */ ' \"  | [optional] 
+**_return** | **Integer** | property description  */ ' \" =_end -- \\r\\n \\n \\r | [optional] 
 
 

samples/client/petstore-security-test/ruby/lib/petstore.rb

@@ -1,10 +1,10 @@
 =begin
-#Swagger Petstore */ ' \" 
+#Swagger Petstore */ ' \" =_end -- \\r\\n \\n \\r
 
-#This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" 
+#This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =_end --       
 
-OpenAPI spec version: 1.0.0 */ ' \" 
-Contact: [email protected] */ ' \" 
+OpenAPI spec version: 1.0.0 */ ' \" =_end -- \\r\\n \\n \\r
+Contact: [email protected] */ ' \" =_end -- \\r\\n \\n \\r
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

samples/client/petstore-security-test/ruby/lib/petstore/api/fake_api.rb

@@ -1,10 +1,10 @@
 =begin
-#Swagger Petstore */ ' \" 
+#Swagger Petstore */ ' \" =_end -- \\r\\n \\n \\r
 
-#This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" 
+#This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =_end --       
 
-OpenAPI spec version: 1.0.0 */ ' \" 
-Contact: [email protected] */ ' \" 
+OpenAPI spec version: 1.0.0 */ ' \" =_end -- \\r\\n \\n \\r
+Contact: [email protected] */ ' \" =_end -- \\r\\n \\n \\r
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,24 +31,24 @@ def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
 
-    # To test code injection */ ' \" 
+    # To test code injection */ ' \" =_end -- \\r\\n \\n \\r
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :test_code_inject____end To test code injection */ ' \" 
+    # @option opts [String] :test_code_inject____end____rn_n_r To test code injection */ ' \" =_end -- \\r\\n \\n \\r
     # @return [nil]
-    def test_code_inject____end(opts = {})
-      test_code_inject____end_with_http_info(opts)
+    def test_code_inject____end__rn_n_r(opts = {})
+      test_code_inject____end__rn_n_r_with_http_info(opts)
       return nil
     end
 
-    # To test code injection */ ' \" 
+    # To test code injection */ ' \" =_end -- \\r\\n \\n \\r
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :test_code_inject____end To test code injection */ ' \" 
+    # @option opts [String] :test_code_inject____end____rn_n_r To test code injection */ ' \" =_end -- \\r\\n \\n \\r
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def test_code_inject____end_with_http_info(opts = {})
+    def test_code_inject____end__rn_n_r_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: FakeApi.test_code_inject____end ..."
+        @api_client.config.logger.debug "Calling API: FakeApi.test_code_inject____end__rn_n_r ..."
       end
       # resource path
       local_var_path = "/fake".sub('{format}','json')
@@ -60,16 +60,16 @@ def test_code_inject____end_with_http_info(opts = {})
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json', '*/  " =end']
+      local_header_accept = ['application/json', '*/  \" =_end --       ']
       local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
 
       # HTTP header 'Content-Type'
-      local_header_content_type = ['application/json', '*/  " =end']
+      local_header_content_type = ['application/json', '*/  \" =_end --       ']
       header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
 
       # form parameters
       form_params = {}
-      form_params["test code inject */ &#39; &quot; &#x3D;end"] = opts[:'test_code_inject____end'] if !opts[:'test_code_inject____end'].nil?
+      form_params["test code inject */ &#39; &quot; &#x3D;end -- \r\n \n \r"] = opts[:'test_code_inject____end____rn_n_r'] if !opts[:'test_code_inject____end____rn_n_r'].nil?
 
       # http body (model)
       post_body = nil
@@ -81,7 +81,7 @@ def test_code_inject____end_with_http_info(opts = {})
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FakeApi#test_code_inject____end\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: FakeApi#test_code_inject____end__rn_n_r\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end