Skip to content

[REQ] [RUBY] [FARADAY] Allow middleware to be configured #10495

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
wing328 merged 7 commits into from
Oct 4, 2021
Merged

[REQ] [RUBY] [FARADAY] Allow middleware to be configured #10495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6efdc50
feat: allow configuring middleware in setup
Sep 29, 2021
7a2f8ec
fix: stop requiring Faraday middleware unnecessarily
Sep 29, 2021
1122bfb
Merge branch 'master' into ruby-faraday--allow-middleware-to-be-confi…
Sep 29, 2021
4644c11
chore: regenerate petstore samples
Sep 29, 2021
e9d07bf
chore: regenerate openapi3 client
Sep 29, 2021
99d774c
chore: ci fails so rebuild
Sep 30, 2021
c015b43
Merge branch 'master' into ruby-faraday--allow-middleware-to-be-confi…
johngallagher Oct 2, 2021
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
1 change: 1 addition & 0 deletions modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
conn.basic_auth(config.username, config.password)
@config.configure_middleware(conn)
if opts[:header_params]["Content-Type"] == "multipart/form-data"
conn.request :multipart
conn.request :url_encoded
Expand Down
35 changes: 35 additions & 0 deletions modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ module {{moduleName}}
@ssl_ca_file = nil
@ssl_client_cert = nil
@ssl_client_key = nil
@middlewares = []
@request_middlewares = []
@response_middlewares = []
@timeout = 60
{{/isFaraday}}
{{^isFaraday}}
Expand Down Expand Up @@ -346,5 +349,37 @@ module {{moduleName}}

url
end

{{#isFaraday}}
# Adds middleware to the stack
def use(*middleware)
@middlewares << middleware
end

# Adds request middleware to the stack
def request(*middleware)
@request_middlewares << middleware
end

# Adds response middleware to the stack
def response(*middleware)
@response_middlewares << middleware
end

# Set up middleware on the connection
def configure_middleware(connection)
@middlewares.each do |middleware|
connection.use(*middleware)
end

@request_middlewares.each do |middleware|
connection.request(*middleware)
end

@response_middlewares.each do |middleware|
connection.response(*middleware)
end
end
{{/isFaraday}}
end
end
1 change: 1 addition & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/api_client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ def call_api(http_method, path, opts = {})

connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
conn.basic_auth(config.username, config.password)
@config.configure_middleware(conn)
if opts[:header_params]["Content-Type"] == "multipart/form-data"
conn.request :multipart
conn.request :url_encoded
Expand Down
33 changes: 33 additions & 0 deletions samples/client/petstore/ruby-faraday/lib/petstore/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@ def initialize
@ssl_ca_file = nil
@ssl_client_cert = nil
@ssl_client_key = nil
@middlewares = []
@request_middlewares = []
@response_middlewares = []
@timeout = 60
@debugging = false
@inject_format = false
Expand Down Expand Up @@ -354,5 +357,35 @@ def server_url(index, variables = {}, servers = nil)

url
end

# Adds middleware to the stack
def use(*middleware)
@middlewares << middleware
end

# Adds request middleware to the stack
def request(*middleware)
@request_middlewares << middleware
end

# Adds response middleware to the stack
def response(*middleware)
@response_middlewares << middleware
end

# Set up middleware on the connection
def configure_middleware(connection)
@middlewares.each do |middleware|
connection.use(*middleware)
end

@request_middlewares.each do |middleware|
connection.request(*middleware)
end

@response_middlewares.each do |middleware|
connection.response(*middleware)
end
end
end
end
1 change: 1 addition & 0 deletions samples/client/petstore/ruby/lib/petstore/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,5 +359,6 @@ def server_url(index, variables = {}, servers = nil)

url
end

end
end
1 change: 1 addition & 0 deletions ...enapi3/client/extensions/x-auth-id-alias/ruby-client/lib/x_auth_id_alias/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,5 +313,6 @@ def server_url(index, variables = {}, servers = nil)

url
end

end
end
1 change: 1 addition & 0 deletions samples/openapi3/client/features/dynamic-servers/ruby/lib/dynamic_servers/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,5 +350,6 @@ def server_url(index, variables = {}, servers = nil)

url
end

end
end
1 change: 1 addition & 0 deletions ...penapi3/client/features/generate-alias-as-model/ruby-client/lib/petstore/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,5 +266,6 @@ def server_url(index, variables = {}, servers = nil)

url
end

end
end