Skip to content

[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jimschubert merged 6 commits into from
Sep 24, 2020
Merged

[ruby] Support for per-operation servers #7415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
24bb511
Support server configuration per operation
jirikuncar Sep 14, 2020
148117d
regenerated+tests
jirikuncar Sep 15, 2020
cc38d72
Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers
jirikuncar Sep 15, 2020
bbf6c89
base_url fix
jirikuncar Sep 15, 2020
4f2bbbf
support not templated urls
jirikuncar Sep 15, 2020
767cade
revert update of ruby docs
jirikuncar Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions bin/configs/ruby-features-dynamic-servers.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
gemVersion: 1.0.0
moduleName: DynamicServers
gemName: dynamic_servers
skipFormModel: "true"
4 changes: 3 additions & 1 deletion ...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
GlobalFeature.XMLStructureDefinitions,
GlobalFeature.Callbacks,
GlobalFeature.LinkObjects,
GlobalFeature.ParameterStyling
GlobalFeature.ParameterStyling,
GlobalFeature.ParameterizedServer,
GlobalFeature.MultiServer
)
.includeSchemaSupportFeatures(
SchemaSupportFeature.Polymorphism
Expand Down
1 change: 1 addition & 0 deletions modules/openapi-generator/src/main/resources/ruby-client/api.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

new_options = opts.merge(
:operation => :"{{classname}}.{{operationId}}",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand Down
4 changes: 2 additions & 2 deletions modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
filename.gsub(/.*[\/\\]/, '')
end

def build_request_url(path)
def build_request_url(path, opts = {})
# Add leading and trailing slashes to path
path = "/#{path}".gsub(/\/+/, '/')
@config.base_url + path
@config.base_url(opts[:operation]) + path
end

# Update hearder and query params based on authentication settings.
Expand Down
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
# @option opts [Object] :body HTTP body (JSON/XML)
# @return [Typhoeus::Request] A Typhoeus Request
def build_request(http_method, path, request, opts = {})
url = build_request_url(path)
url = build_request_url(path, opts)
http_method = http_method.to_sym.downcase

header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down
2 changes: 1 addition & 1 deletion ...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
# @option opts [Object] :body HTTP body (JSON/XML)
# @return [Typhoeus::Request] A Typhoeus Request
def build_request(http_method, path, opts = {})
url = build_request_url(path)
url = build_request_url(path, opts)
http_method = http_method.to_sym.downcase

header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down
78 changes: 73 additions & 5 deletions modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
# Defines url base path
attr_accessor :base_path

# Define server configuration index
attr_accessor :server_index

# Define server operation configuration index
attr_accessor :server_operation_index

# Default server variables
attr_accessor :server_variables

# Default server operation variables
attr_accessor :server_operation_variables

# Defines API keys used with API Key authentications.
#
# @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
@scheme = '{{scheme}}'
@host = '{{host}}'
@base_path = '{{contextPath}}'
@server_index = 0
@server_operation_index = {}
@server_variables = {}
@server_operation_variables = {}
@api_key = {}
@api_key_prefix = {}
@timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
@base_path = '' if @base_path == '/'
end

def base_url
"#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
# Returns base URL for specified operation based on server settings
def base_url(operation = nil)
index = server_operation_index.fetch(operation, server_index)
return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
end

# Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
]
end

def operation_server_settings
{
{{#apiInfo}}
{{#apis}}
{{#operations}}
{{#operation}}
{{#servers}}
{{#-first}}
"{{{classname}}}.{{{nickname}}}": [
{{/-first}}
{
url: "{{{url}}}",
description: "{{{description}}}{{^description}}No description provided{{/description}}",
{{#variables}}
{{#-first}}
variables: {
{{/-first}}
{{{name}}}: {
description: "{{{description}}}{{^description}}No description provided{{/description}}",
default_value: "{{{defaultValue}}}",
{{#enumValues}}
{{#-first}}
enum_values: [
{{/-first}}
"{{{.}}}"{{^-last}},{{/-last}}
{{#-last}}
]
{{/-last}}
{{/enumValues}}
}{{^-last}},{{/-last}}
{{#-last}}
}
{{/-last}}
{{/variables}}
}{{^-last}},{{/-last}}
{{#-last}}
],
{{/-last}}
{{/servers}}
{{/operation}}
{{/operations}}
{{/apis}}
{{/apiInfo}}
}
end

# Returns URL based on server settings
#
# @param index array index of the server settings
# @param variables hash of variable and the corresponding value
def server_url(index, variables = {})
servers = server_settings
def server_url(index, variables = {}, servers = nil)
servers = server_settings if servers == nil

# check array index out of bound
if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
server = servers[index]
url = server[:url]

return url unless server.key? :variables

# go through variable and assign a value
server[:variables].each do |name, variable|
if variables.key?(name)
if (server[:variables][name][:enum_values].include?variables[name])
if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
url.gsub! "{" + name.to_s + "}", variables[name]
else
fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"AnotherFakeApi.call_123_test_special_tags",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"DefaultApi.foo_get",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand Down
15 changes: 15 additions & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.fake_health_get",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
auth_names = opts[:auth_names] || ['http_signature_test']

new_options = opts.merge(
:operation => :"FakeApi.fake_http_signature_test",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.fake_outer_boolean_serialize",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.fake_outer_composite_serialize",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.fake_outer_number_serialize",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.fake_outer_string_serialize",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_body_with_file_schema",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_body_with_query_params",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_client_model",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
auth_names = opts[:auth_names] || ['http_basic_test']

new_options = opts.merge(
:operation => :"FakeApi.test_endpoint_parameters",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_enum_parameters",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
auth_names = opts[:auth_names] || ['bearer_test']

new_options = opts.merge(
:operation => :"FakeApi.test_group_parameters",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_inline_additional_properties",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_json_form_data",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
auth_names = opts[:auth_names] || []

new_options = opts.merge(
:operation => :"FakeApi.test_query_parameter_collection_format",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand Down
1 change: 1 addition & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
auth_names = opts[:auth_names] || ['api_key_query']

new_options = opts.merge(
:operation => :"FakeClassnameTags123Api.test_classname",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand Down
9 changes: 9 additions & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.add_pet",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.delete_pet",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.find_pets_by_status",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.find_pets_by_tags",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
auth_names = opts[:auth_names] || ['api_key']

new_options = opts.merge(
:operation => :"PetApi.get_pet_by_id",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.update_pet",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.update_pet_with_form",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.upload_file",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
auth_names = opts[:auth_names] || ['petstore_auth']

new_options = opts.merge(
:operation => :"PetApi.upload_file_with_required_file",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[ruby] Support for per-operation servers by jirikuncar · Pull Request #7415 · OpenAPITools/openapi-generator · GitHub
Skip to content
[ruby] Support for per-operation servers#7415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jimschubert
merged 6 commits into

from

Sep 24, 2020
 Merged


[ruby] Support for per-operation servers
#7415
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
24bb511

Support server configuration per operation


jirikuncar Sep 14, 2020
148117d

regenerated+tests


jirikuncar Sep 15, 2020
cc38d72

Merge remote-tracking branch 'upstream/master' into ruby/dynamic-servers


jirikuncar Sep 15, 2020
bbf6c89

base_url fix


jirikuncar Sep 15, 2020
4f2bbbf

support not templated urls


jirikuncar Sep 15, 2020
767cade

revert update of ruby docs


jirikuncar Sep 15, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
bin/configs/ruby-features-dynamic-servers.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
generatorName: ruby
outputDir: samples/openapi3/client/features/dynamic-servers/ruby/
inputSpec: modules/openapi-generator/src/test/resources/3_0/features/dynamic-servers.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
 gemVersion: 1.0.0
 moduleName: DynamicServers
 gemName: dynamic_servers
 skipFormModel: "true"

4 changes: 3 additions & 1 deletion
...openapi-generator/src/main/java/org/openapitools/codegen/languages/RubyClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,7 +83,9 @@ public RubyClientCodegen() {
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
 GlobalFeature.LinkObjects,
 GlobalFeature.ParameterStyling
 GlobalFeature.ParameterStyling,
 GlobalFeature.ParameterizedServer,
 GlobalFeature.MultiServer
 )
 .includeSchemaSupportFeatures(
 SchemaSupportFeature.Polymorphism
Expand Down

1 change: 1 addition & 0 deletions
modules/openapi-generator/src/main/resources/ruby-client/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,6 +182,7 @@ module {{moduleName}}
 auth_names = opts[:auth_names] || [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]

 new_options = opts.merge(
 :operation => :"{{classname}}.{{operationId}}",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

4 changes: 2 additions & 2 deletions
modules/openapi-generator/src/main/resources/ruby-client/api_client.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -177,10 +177,10 @@ module {{moduleName}}
 filename.gsub(/.*[\/\\]/, '')
 end

 def build_request_url(path)
 def build_request_url(path, opts = {})
 # Add leading and trailing slashes to path
 path = "/#{path}".gsub(/\/+/, '/')
 @config.base_url + path
 @config.base_url(opts[:operation]) + path
 end

 # Update hearder and query params based on authentication settings.
Expand Down

2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, request, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

2 changes: 1 addition & 1 deletion
...les/openapi-generator/src/main/resources/ruby-client/api_client_typhoeus_partial.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@
 # @option opts [Object] :body HTTP body (JSON/XML)
 # @return [Typhoeus::Request] A Typhoeus Request
 def build_request(http_method, path, opts = {})
 url = build_request_url(path)
 url = build_request_url(path, opts)
 http_method = http_method.to_sym.downcase

 header_params = @default_headers.merge(opts[:header_params] || {})
Expand Down

78 changes: 73 additions & 5 deletions
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,18 @@ module {{moduleName}}
 # Defines url base path
 attr_accessor :base_path

 # Define server configuration index
 attr_accessor :server_index

 # Define server operation configuration index
 attr_accessor :server_operation_index

 # Default server variables
 attr_accessor :server_variables

 # Default server operation variables
 attr_accessor :server_operation_variables

 # Defines API keys used with API Key authentications.
 #
 # @return [Hash] key: parameter name, value: parameter value (API key)
Expand DownExpand Up@@ -92,6 +104,10 @@ module {{moduleName}}
 @scheme = '{{scheme}}'
 @host = '{{host}}'
 @base_path = '{{contextPath}}'
 @server_index = 0
 @server_operation_index = {}
 @server_variables = {}
 @server_operation_variables = {}
 @api_key = {}
 @api_key_prefix = {}
 @timeout = 0
Expand DownExpand Up@@ -143,8 +159,12 @@ module {{moduleName}}
 @base_path = '' if @base_path == '/'
 end

 def base_url
 "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
 # Returns base URL for specified operation based on server settings
 def base_url(operation = nil)
 index = server_operation_index.fetch(operation, server_index)
 return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

 server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
 end

 # Gets API key (with prefix if set).
Expand DownExpand Up@@ -244,12 +264,58 @@ module {{moduleName}}
 ]
 end

 def operation_server_settings
 {
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 {{#operation}}
 {{#servers}}
 {{#-first}}
 "{{{classname}}}.{{{nickname}}}": [
 {{/-first}}
 {
 url: "{{{url}}}",
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 {{#variables}}
 {{#-first}}
 variables: {
 {{/-first}}
 {{{name}}}: {
 description: "{{{description}}}{{^description}}No description provided{{/description}}",
 default_value: "{{{defaultValue}}}",
 {{#enumValues}}
 {{#-first}}
 enum_values: [
 {{/-first}}
 "{{{.}}}"{{^-last}},{{/-last}}
 {{#-last}}
 ]
 {{/-last}}
 {{/enumValues}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 }
 {{/-last}}
 {{/variables}}
 }{{^-last}},{{/-last}}
 {{#-last}}
 ],
 {{/-last}}
 {{/servers}}
 {{/operation}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}
 }
 end

 # Returns URL based on server settings
 #
 # @param index array index of the server settings
 # @param variables hash of variable and the corresponding value
 def server_url(index, variables = {})
 servers = server_settings
 def server_url(index, variables = {}, servers = nil)
 servers = server_settings if servers == nil

 # check array index out of bound
 if (index < 0 || index >= servers.size)
Expand All@@ -259,10 +325,12 @@ module {{moduleName}}
 server = servers[index]
 url = server[:url]

 return url unless server.key? :variables

 # go through variable and assign a value
 server[:variables].each do |name, variable|
 if variables.key?(name)
 if (server[:variables][name][:enum_values].include?variables[name])
 if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
 url.gsub! "{" + name.to_s + "}", variables[name]
 else
 fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/another_fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def call_123_test_special_tags_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"AnotherFakeApi.call_123_test_special_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/default_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,7 @@ def foo_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"DefaultApi.foo_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

15 changes: 15 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ def fake_health_get_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_health_get",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -124,6 +125,7 @@ def fake_http_signature_test_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['http_signature_test']

 new_options = opts.merge(
 :operation => :"FakeApi.fake_http_signature_test",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -182,6 +184,7 @@ def fake_outer_boolean_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_boolean_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -240,6 +243,7 @@ def fake_outer_composite_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_composite_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -298,6 +302,7 @@ def fake_outer_number_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_number_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -356,6 +361,7 @@ def fake_outer_string_serialize_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.fake_outer_string_serialize",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -416,6 +422,7 @@ def test_body_with_file_schema_with_http_info(file_schema_test_class, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_file_schema",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -481,6 +488,7 @@ def test_body_with_query_params_with_http_info(query, user, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_body_with_query_params",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -545,6 +553,7 @@ def test_client_model_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_client_model",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -713,6 +722,7 @@ def test_endpoint_parameters_with_http_info(number, double, pattern_without_deli
 auth_names = opts[:auth_names] || ['http_basic_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_endpoint_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -825,6 +835,7 @@ def test_enum_parameters_with_http_info(opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_enum_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -909,6 +920,7 @@ def test_group_parameters_with_http_info(required_string_group, required_boolean
 auth_names = opts[:auth_names] || ['bearer_test']

 new_options = opts.merge(
 :operation => :"FakeApi.test_group_parameters",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -969,6 +981,7 @@ def test_inline_additional_properties_with_http_info(request_body, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_inline_additional_properties",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1037,6 +1050,7 @@ def test_json_form_data_with_http_info(param, param2, opts = {})
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_json_form_data",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -1124,6 +1138,7 @@ def test_query_parameter_collection_format_with_http_info(pipe, ioutil, http, ur
 auth_names = opts[:auth_names] || []

 new_options = opts.merge(
 :operation => :"FakeApi.test_query_parameter_collection_format",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

1 change: 1 addition & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/fake_classname_tags123_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,6 +68,7 @@ def test_classname_with_http_info(client, opts = {})
 auth_names = opts[:auth_names] || ['api_key_query']

 new_options = opts.merge(
 :operation => :"FakeClassnameTags123Api.test_classname",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down

9 changes: 9 additions & 0 deletions
samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ def add_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.add_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -125,6 +126,7 @@ def delete_pet_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.delete_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -188,6 +190,7 @@ def find_pets_by_status_with_http_info(status, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_status",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -251,6 +254,7 @@ def find_pets_by_tags_with_http_info(tags, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.find_pets_by_tags",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -313,6 +317,7 @@ def get_pet_by_id_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['api_key']

 new_options = opts.merge(
 :operation => :"PetApi.get_pet_by_id",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -373,6 +378,7 @@ def update_pet_with_http_info(pet, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -439,6 +445,7 @@ def update_pet_with_form_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.update_pet_with_form",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -507,6 +514,7 @@ def upload_file_with_http_info(pet_id, opts = {})
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand DownExpand Up@@ -579,6 +587,7 @@ def upload_file_with_required_file_with_http_info(pet_id, required_file, opts =
 auth_names = opts[:auth_names] || ['petstore_auth']

 new_options = opts.merge(
 :operation => :"PetApi.upload_file_with_required_file",
 :header_params => header_params,
 :query_params => query_params,
 :form_params => form_params,
Expand Down
Loading