loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Add support of Bearer Basic Authorization to Ruby client (#2856)

Browse Source 
* Support for Bearer in Ruby Client

* Update README.mustache

* Update README.mustache

* Update api_doc.mustache

* Update api_doc.mustache

* Update api_doc.mustache

* samples

* Uncommited changes

* Formatting

* More Formatting

* Fomatting

* More formatting

* More formatting

* Even more formatting

* Even more formatting

* More formatting

* Even more formatting

* More formatting

* More formatting
This commit is contained in:
Sergey Moiseev 2019-05-15 16:17:57 +03:00 committed by William Cheng
parent c353f79342
commit 87414352a5
6 changed files with 33 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
modules/openapi-generator/src/main/resources/ruby-client/README.mustache vendored
View File

@ -65,10 +65,12 @@ Please follow the [installation](#installation) procedure and then run the follo
require '{{{gemName}}}'
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
# Setup authorization
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{^isBasicBearer}}
# Configure HTTP basic authorization: {{{name}}}
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'{{/isBasic}}{{#isApiKey}}
config.username = 'YOUR_USERNAME'
config.password = 'YOUR_PASSWORD'{{/isBasicBearer}}{{#isBasicBearer}}
# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
# Configure API key authorization: {{{name}}}
config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
@ -128,7 +130,10 @@ Class | Method | HTTP request | Description
- **API key parameter name**: {{keyParamName}}
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
{{/isApiKey}}
{{#isBasic}}- **Type**: HTTP basic authentication
{{#isBasic}}
{{^isBasicBearer}}- **Type**: HTTP basic authentication
{{/isBasicBearer}}{{#isBasicBearer}}- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
{{/isBasicBearer}}
{{/isBasic}}
{{#isOAuth}}

6
modules/openapi-generator/src/main/resources/ruby-client/api_doc.mustache vendored
View File

@ -27,10 +27,12 @@ Method | HTTP request | Description
require '{{{gemName}}}'
{{#hasAuthMethods}}
# setup authorization
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{^isBasicBearer}}
# Configure HTTP basic authorization: {{{name}}}
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'{{/isBasic}}{{#isApiKey}}
config.password = 'YOUR PASSWORD'{{/isBasicBearer}}{{#isBasicBearer}}
# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
# Configure API key authorization: {{{name}}}
config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)

14
modules/openapi-generator/src/main/resources/ruby-client/configuration.mustache vendored
View File

@ -199,6 +199,7 @@ module {{moduleName}}
},
{{/isApiKey}}
{{#isBasic}}
{{^isBasicBearer}}
'{{name}}' =>
{
type: 'basic',
@ -206,6 +207,19 @@ module {{moduleName}}
key: 'Authorization',
value: basic_auth_token
},
{{/isBasicBearer}}
{{#isBasicBearer}}
'{{name}}' =>
{
type: 'bearer',
in: 'header',
{{#bearerFormat}}
format: '{{{.}}}',
{{/bearerFormat}}
key: 'Authorization',
value: "Bearer #{access_token}"
},
{{/isBasicBearer}}
{{/isBasic}}
{{#isOAuth}}
'{{name}}' =>

2
samples/openapi3/client/petstore/ruby/README.md
View File

@ -180,7 +180,7 @@ Class | Method | HTTP request | Description
### bearer_test
- **Type**: HTTP basic authentication
- **Type**: Bearer authentication (JWT)
### http_basic_test

5
samples/openapi3/client/petstore/ruby/docs/FakeApi.md
View File

@ -547,9 +547,8 @@ Fake endpoint to test group parameters (optional)
require 'petstore'
# setup authorization
Petstore.configure do |config|
# Configure HTTP basic authorization: bearer_test
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure Bearer authorization (JWT): bearer_test
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = Petstore::FakeApi.new

5
samples/openapi3/client/petstore/ruby/lib/petstore/configuration.rb
View File

@ -212,10 +212,11 @@ module Petstore
},
'bearer_test' =>
{
type: 'basic',
type: 'bearer',
in: 'header',
format: 'JWT',
key: 'Authorization',
value: basic_auth_token
value: "Bearer #{access_token}"
},
'http_basic_test' =>
{