swagger_ui_engine 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6fff974d9f7d8667215be02d2b198551fe8b80
-  data.tar.gz: 0ff2b58a74369dabfb951a7e9c385eca9fc0e13a
+  metadata.gz: 523b130aea7593cd7682b8281962c30e5b2a0277
+  data.tar.gz: 23e0cbdee181c30db11d677fe3d296409de836be
 SHA512:
-  metadata.gz: 777136dcf3369e1a715f32e91281eeb0f6ac2101811df40208da9595233fe17007dd313ab0bb1e77c8612a8b6df9583e9d9309eedcfac6a11438ae0773be9659
-  data.tar.gz: 96779d30916340800fb2f3766009f49aa7b2a28c0ca8a8b2c5fdc8599f1adb8ba0b258dd35ec55ef5f9b8f2e60a357ecb39273a9fa3b7889b5a4eb6aa8d71ada
+  metadata.gz: 488bbc670b69c113d6960e7aec42c76bf6736cfe12ac2b1a0ee79d53559f8d98900189fe2cdd0690528727450fa1019d0f4e92eee9287d3656f0b5c72d3b9912
+  data.tar.gz: 9fbca2dd081d43b86db825e1e7079bd7c85b9fb43d2c208c9ff0ec55b56483af04b9f9fad85e89817e9720d3e51bd10fd0da11bb50c35c00334222ff52044634

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## master
 
+## 1.0.1
+
+* Support OAuth2 authentication
+* Support loading Swagger UI translations
+* Add return link for multiple API versions
+* Add `de` translation
+* Refactor helpers
+
+## 1.0.0
+
+* Rails 5 dependency. It is compatible with previous versions.
+* Support API versioning/multiple APIs definitions
+* Add basic HTTP auth support
+* Add `validator_enabled` configurable option
+* Refactor Configuration class definition
+* Refactor controllers
+* Redefine gem summary and description
+
 ## 0.0.5
 
 * Support Swagger UI version 2.2.10

data/app/assets/javascripts/swagger_ui_engine/lang/ca.js

@@ -49,5 +49,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Finalitzada la càrrega del recurs informatiu. Renderitzant Swagger UI",
     "Unable to read api":"No es pot llegir l'api",
     "from path":"des de la ruta",
-    "server returned":"el servidor ha retornat"
+    "server returned":"el servidor ha retornat",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/de.js

@@ -0,0 +1,58 @@
+'use strict';
+
+/* jshint quotmark: double */
+window.SwaggerTranslator.learn({
+    "Warning: Deprecated":"Warnung: Deprecated",
+    "Implementation Notes":"Implementierungshinweise",
+    "Response Class":"Response Class",
+    "Status":"Status",
+    "Parameters":"Parameter",
+    "Parameter":"Parameter",
+    "Value":"Wert",
+    "Description":"Beschreibung",
+    "Parameter Type":"Parametertyp",
+    "Data Type":"Datentyp",
+    "Response Messages":"Response Messages",
+    "HTTP Status Code":"HTTP Status Code",
+    "Reason":"Grund",
+    "Response Model":"Response Model",
+    "Request URL":"Request URL",
+    "Response Body":"Response Body",
+    "Response Code":"Response Code",
+    "Response Headers":"Response Headers",
+    "Hide Response":"Response ausblenden",
+    "Headers":"Headers",
+    "Try it out!":"Ausprobieren",
+    "Show/Hide":"Einblenden/Ausblenden",
+    "List Operations":"Endpunkte anzeigen",
+    "Expand Operations":"Endpunkte ausklappen",
+    "Raw":"Raw",
+    "can't parse JSON.  Raw result":"Parsen von JSON fehlgeschlagen.  Raw result",
+    "Example Value":"Beispielwert",
+    "Model Schema":"Schemamodell",
+    "Model":"Modell",
+    "Click to set as parameter value":"Klicken um Parameter zu setzen",
+    "apply":"anlegen",
+    "Username":"Benutzername",
+    "Password":"Passwort",
+    "Terms of service":"Nutzungsbedingungen",
+    "Created by":"Erstellt von",
+    "See more at":"Mehr unter",
+    "Contact the developer":"Entwickler kontaktieren",
+    "api version":"API-Version",
+    "Response Content Type":"Response Content Type",
+    "Parameter content type:":"Parameter Content Type:",
+    "fetching resource":"Lade Ressourcen",
+    "fetching resource list":"Lade Liste der Ressourcen",
+    "Explore":"Erkunde",
+    "Show Swagger Petstore Example Apis":"Anzeigen der Swagger Petstore Example Apis",
+    "Can't read from server.  It may not have the appropriate access-control-origin settings.":"Lesen vom Server nicht möglich. Prüfen Sie die 'access-control-origin' Einstellungen.",
+    "Please specify the protocol for":"Bitte geben Sie das Protokoll an",
+    "Can't read swagger JSON from":"Swagger JSON kann nicht gelesen werden",
+    "Finished Loading Resource Information. Rendering Swagger UI":"Ressourceninformationen sind geladen. Rendern der Swagger UI",
+    "Unable to read api":"API kann nicht gelesen werden",
+    "from path":"von Pfad",
+    "server returned":"Server antwortet",
+    "Authorize":"Autorisieren",
+    "Back to the list":"Zurück zur Liste",
+});

data/app/assets/javascripts/swagger_ui_engine/lang/el.js

@@ -52,5 +52,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Ολοκλήρωση Φόρτωσης Πληροφορικών Πόρου. Παρουσίαση Swagger UI",
     "Unable to read api":"Αδυναμία ανάγνωσης api",
     "from path":"από το μονοπάτι",
-    "server returned":"ο εξυπηρετηρής επέστρεψε"
+    "server returned":"ο εξυπηρετηρής επέστρεψε",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/en.js

@@ -52,5 +52,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Finished Loading Resource Information. Rendering Swagger UI",
     "Unable to read api":"Unable to read api",
     "from path":"from path",
-    "server returned":"server returned"
+    "server returned":"server returned",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/es.js

@@ -49,5 +49,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Finalizada la carga del recurso de Información. Mostrando Swagger UI",
     "Unable to read api":"No se puede leer la api",
     "from path":"desde ruta",
-    "server returned":"el servidor retornó"
+    "server returned":"el servidor retornó",
+    "Authorize":"Authorize",
+    "Back to the list":"Volver a la lista",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/fr.js

@@ -50,5 +50,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Chargement des informations terminé. Affichage de Swagger UI",
     "Unable to read api":"Impossible de lire l'api",
     "from path":"à partir du chemin",
-    "server returned":"réponse du serveur"
+    "server returned":"réponse du serveur",
+    "Authorize":"Authorize",
+    "Back to the list":"Retour à la liste",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/geo.js

@@ -52,5 +52,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"რესურსების ჩატვირთვა სრულდება. Swagger UI რენდერდება",
     "Unable to read api":"api წაკითხვა ვერ მოხერხდა",
     "from path":"მისამართიდან",
-    "server returned":"სერვერმა დააბრუნა"
+    "server returned":"სერვერმა დააბრუნა",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/it.js

@@ -48,5 +48,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Lettura informazioni risorse termianta. Swagger UI viene mostrata",
     "Unable to read api":"Impossibile leggere la api",
     "from path":"da cartella",
-    "server returned":"il server ha restituito"
+    "server returned":"il server ha restituito",
+    "Authorize":"Authorize",
+    "Back to the list":"Torna all'elenco",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/ja.js

@@ -52,5 +52,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"リソース情報の読み込みが完了しました. Swagger UIを描画しています",
     "Unable to read api":"APIを読み込めません",
     "from path":"次のパスから",
-    "server returned":"サーバからの返答"
+    "server returned":"サーバからの返答",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/ko-kr.js

@@ -49,5 +49,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"리소스 정보 불러오기 완료. Swagger UI 랜더링",
     "Unable to read api":"api를 읽을 수 없습니다.",
     "from path":"다음 경로로 부터",
-    "server returned":"서버 응답함."
+    "server returned":"서버 응답함.",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/pl.js

@@ -49,5 +49,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Ukończono Ładowanie Informacji o Zasobie. Renderowanie Swagger UI",
     "Unable to read api":"Nie można odczytać api",
     "from path":"ze ścieżki",
-    "server returned":"serwer zwrócił"
+    "server returned":"serwer zwrócił",
+    "Authorize": "Autoryzuj",
+    "Back to the list":"Powrót do listy",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/pt.js

@@ -49,5 +49,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Carregar informação de recurso finalizada. Renderizando Swagger UI",
     "Unable to read api":"Não foi possível ler api",
     "from path":"do caminho",
-    "server returned":"servidor retornou"
+    "server returned":"servidor retornou",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/ru.js

@@ -52,5 +52,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Загрузка информации о ресурсах завершена. Рендерим",
     "Unable to read api":"Не удалось прочитать api",
     "from path":"по адресу",
-    "server returned":"сервер сказал"
+    "server returned":"сервер сказал",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/tr.js

@@ -49,5 +49,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"Kaynak baglantısı tamamlandı. Swagger UI gösterime hazırlanıyor",
     "Unable to read api":"api okunamadı",
     "from path":"yoldan",
-    "server returned":"sunucuya dönüldü"
+    "server returned":"sunucuya dönüldü",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lang/zh-cn.js

@@ -52,5 +52,7 @@ window.SwaggerTranslator.learn({
     "Finished Loading Resource Information. Rendering Swagger UI":"已加载资源信息。正在渲染Swagger UI",
     "Unable to read api":"无法读取api",
     "from path":"从路径",
-    "server returned":"服务器返回"
+    "server returned":"服务器返回",
+    "Authorize":"Authorize",
+    "Back to the list":"Back to the list",
 });

data/app/assets/javascripts/swagger_ui_engine/lib/swagger-oauth.js

@@ -1 +1 @@
-function handleLogin(){var e=[],o=window.swaggerUiAuth.authSchemes||window.swaggerUiAuth.securityDefinitions;if(o){var i,n=o;for(i in n){var a=n[i];if("oauth2"===a.type&&a.scopes){var t;if(Array.isArray(a.scopes)){var p;for(p=0;p<a.scopes.length;p++)e.push(a.scopes[p])}else for(t in a.scopes)e.push({scope:t,description:a.scopes[t],OAuthSchemeKey:i})}}}for(window.swaggerUi.api&&window.swaggerUi.api.info&&(appName=window.swaggerUi.api.info.title),$(".api-popup-dialog").remove(),popupDialog=$(['<div class="api-popup-dialog">','<div class="api-popup-title">Select OAuth2.0 Scopes</div>','<div class="api-popup-content">',"<p>Scopes are used to grant an application different levels of access to data on behalf of the end user. Each API may declare one or more scopes.",'<a href="#">Learn how to use</a>',"</p>","<p><strong>"+appName+"</strong> API requires the following scopes. Select which ones you want to grant to Swagger UI.</p>",'<ul class="api-popup-scopes">',"</ul>",'<p class="error-msg"></p>','<div class="api-popup-actions"><button class="api-popup-authbtn api-button green" type="button">Authorize</button><button class="api-popup-cancel api-button gray" type="button">Cancel</button></div>',"</div>","</div>"].join("")),$(document.body).append(popupDialog),popup=popupDialog.find("ul.api-popup-scopes").empty(),p=0;p<e.length;p++)t=e[p],str='<li><input type="checkbox" id="scope_'+p+'" scope="'+t.scope+'"" oauthtype="'+t.OAuthSchemeKey+'"/><label for="scope_'+p+'">'+t.scope,t.description&&($.map(o,function(e,o){return o}).length>1?str+='<br/><span class="api-scope-desc">'+t.description+" ("+t.OAuthSchemeKey+")</span>":str+='<br/><span class="api-scope-desc">'+t.description+"</span>"),str+="</label></li>",popup.append(str);var r=$(window),s=r.width(),c=r.height(),l=r.scrollTop(),d=popupDialog.outerWidth(),u=popupDialog.outerHeight(),h=(c-u)/2+l,g=(s-d)/2;popupDialog.css({top:(h<0?0:h)+"px",left:(g<0?0:g)+"px"}),popupDialog.find("button.api-popup-cancel").click(function(){popupMask.hide(),popupDialog.hide(),popupDialog.empty(),popupDialog=[]}),$("button.api-popup-authbtn").unbind(),popupDialog.find("button.api-popup-authbtn").click(function(){function e(e){return e.vendorExtensions["x-tokenName"]||e.tokenName}popupMask.hide(),popupDialog.hide();var o,i=window.swaggerUi.api.authSchemes,n=window.location,a=location.pathname.substring(0,location.pathname.lastIndexOf("/")),t=n.protocol+"//"+n.host+a+"/o2c.html",p=window.oAuthRedirectUrl||t,r=null,s=[],c=popup.find("input:checked"),l=[];for(k=0;k<c.length;k++){var d=$(c[k]).attr("scope");s.indexOf(d)===-1&&s.push(d);var u=$(c[k]).attr("oauthtype");l.indexOf(u)===-1&&l.push(u)}window.enabledScopes=s;for(var h in i)if(i.hasOwnProperty(h)&&l.indexOf(h)!=-1){var g=i[h].flow;if("oauth2"!==i[h].type||!g||"implicit"!==g&&"accessCode"!==g){if("oauth2"===i[h].type&&g&&"application"===g){var w=i[h];return window.swaggerUi.tokenName=e(w)||"access_token",void clientCredentialsFlow(s,w.tokenUrl,h)}if(i[h].grantTypes){var c=i[h].grantTypes;for(var f in c)if(c.hasOwnProperty(f)&&"implicit"===f){var w=c[f];w.loginEndpoint.url;r=w.loginEndpoint.url+"?response_type=token",window.swaggerUi.tokenName=e(w)}else if(c.hasOwnProperty(f)&&"accessCode"===f){var w=c[f];w.tokenRequestEndpoint.url;r=w.tokenRequestEndpoint.url+"?response_type=code",window.swaggerUi.tokenName=e(w)}}}else{var w=i[h];r=w.authorizationUrl+"?response_type="+("implicit"===g?"token":"code"),window.swaggerUi.tokenName=e(w)||"access_token",window.swaggerUi.tokenUrl="accessCode"===g?w.tokenUrl:null,o=h}}redirect_uri=p,r+="&redirect_uri="+encodeURIComponent(p),r+="&realm="+encodeURIComponent(realm),r+="&client_id="+encodeURIComponent(clientId),r+="&scope="+encodeURIComponent(s.join(scopeSeparator)),r+="&state="+encodeURIComponent(o);for(var h in additionalQueryStringParams)r+="&"+h+"="+encodeURIComponent(additionalQueryStringParams[h]);window.open(r)}),popupMask.show(),popupDialog.show()}function handleLogout(){for(key in window.swaggerUi.api.clientAuthorizations.authz)window.swaggerUi.api.clientAuthorizations.remove(key);window.enabledScopes=null,$(".api-ic.ic-on").addClass("ic-off"),$(".api-ic.ic-on").removeClass("ic-on"),$(".api-ic.ic-warning").addClass("ic-error"),$(".api-ic.ic-warning").removeClass("ic-warning")}function initOAuth(e){var o=e||{},i=[];return appName=o.appName||i.push("missing appName"),popupMask=o.popupMask||$("#api-common-mask"),popupDialog=o.popupDialog||$(".api-popup-dialog"),clientId=o.clientId||i.push("missing client id"),clientSecret=o.clientSecret||null,realm=o.realm||i.push("missing realm"),scopeSeparator=o.scopeSeparator||" ",additionalQueryStringParams=o.additionalQueryStringParams||{},i.length>0?void log("auth unable initialize oauth: "+i):($("pre code").each(function(e,o){hljs.highlightBlock(o)}),$(".api-ic").unbind(),void $(".api-ic").click(function(e){$(e.target).hasClass("ic-off")?handleLogin():handleLogout()}))}function clientCredentialsFlow(e,o,i){var n={client_id:clientId,client_secret:clientSecret,scope:e.join(" "),grant_type:"client_credentials"};$.ajax({url:o,type:"POST",data:n,success:function(e,o,n){onOAuthComplete(e,i)},error:function(e,o,i){onOAuthComplete("")}})}var appName,popupMask,popupDialog,clientId,realm,redirect_uri,clientSecret,scopeSeparator,additionalQueryStringParams;window.processOAuthCode=function(e){var o=e.state,i=window.location,n=location.pathname.substring(0,location.pathname.lastIndexOf("/")),a=i.protocol+"//"+i.host+n+"/o2c.html",t=window.oAuthRedirectUrl||a,p={client_id:clientId,code:e.code,grant_type:"authorization_code",redirect_uri:t};clientSecret&&(p.client_secret=clientSecret),$.ajax({url:window.swaggerUiAuth.tokenUrl,type:"POST",data:p,success:function(e,i,n){onOAuthComplete(e,o)},error:function(e,o,i){onOAuthComplete("")}})},window.onOAuthComplete=function(e,o){if(e)if(e.error){var i=$("input[type=checkbox],.secured");i.each(function(e){i[e].checked=!1}),alert(e.error)}else{var n=e[window.swaggerUiAuth.tokenName];if(o||(o=e.state),n){var a=null;$.each($(".auth .api-ic .api_information_panel"),function(e,o){var i=o;if(i&&i.childNodes){var n=[];$.each(i.childNodes,function(e,o){var i=o.innerHTML;i&&n.push(i)});for(var t=[],p=0;p<n.length;p++){var r=n[p];window.enabledScopes&&window.enabledScopes.indexOf(r)==-1&&t.push(r)}t.length>0?(a=o.parentNode.parentNode,$(a.parentNode).find(".api-ic.ic-on").addClass("ic-off"),$(a.parentNode).find(".api-ic.ic-on").removeClass("ic-on"),$(a).find(".api-ic").addClass("ic-warning"),$(a).find(".api-ic").removeClass("ic-error")):(a=o.parentNode.parentNode,$(a.parentNode).find(".api-ic.ic-off").addClass("ic-on"),$(a.parentNode).find(".api-ic.ic-off").removeClass("ic-off"),$(a).find(".api-ic").addClass("ic-info"),$(a).find(".api-ic").removeClass("ic-warning"),$(a).find(".api-ic").removeClass("ic-error"))}}),"undefined"!=typeof window.swaggerUi&&(window.swaggerUi.api.clientAuthorizations.add(window.swaggerUiAuth.OAuthSchemeKey,new SwaggerClient.ApiKeyAuthorization("Authorization","Bearer "+n,"header")),window.swaggerUi.load())}}};
+function handleLogin(){var e=[],o=window.swaggerUiAuth.authSchemes||window.swaggerUiAuth.securityDefinitions;if(o){var i,n=o;for(i in n){var a=n[i];if("oauth2"===a.type&&a.scopes){var t;if(Array.isArray(a.scopes)){var p;for(p=0;p<a.scopes.length;p++)e.push(a.scopes[p])}else for(t in a.scopes)e.push({scope:t,description:a.scopes[t],OAuthSchemeKey:i})}}}for(window.swaggerUi.api&&window.swaggerUi.api.info&&(appName=window.swaggerUi.api.info.title),$(".api-popup-dialog").remove(),popupDialog=$(['<div class="api-popup-dialog">','<div class="api-popup-title">Select OAuth2.0 Scopes</div>','<div class="api-popup-content">',"<p>Scopes are used to grant an application different levels of access to data on behalf of the end user. Each API may declare one or more scopes.",'<a href="#">Learn how to use</a>',"</p>","<p><strong>"+appName+"</strong> API requires the following scopes. Select which ones you want to grant to Swagger UI.</p>",'<ul class="api-popup-scopes">',"</ul>",'<p class="error-msg"></p>','<div class="api-popup-actions"><button class="api-popup-authbtn api-button green" type="button" data-sw-translate>Authorize</button><button class="api-popup-cancel api-button gray" type="button">Cancel</button></div>',"</div>","</div>"].join("")),$(document.body).append(popupDialog),popup=popupDialog.find("ul.api-popup-scopes").empty(),p=0;p<e.length;p++)t=e[p],str='<li><input type="checkbox" id="scope_'+p+'" scope="'+t.scope+'"" oauthtype="'+t.OAuthSchemeKey+'"/><label for="scope_'+p+'">'+t.scope,t.description&&($.map(o,function(e,o){return o}).length>1?str+='<br/><span class="api-scope-desc">'+t.description+" ("+t.OAuthSchemeKey+")</span>":str+='<br/><span class="api-scope-desc">'+t.description+"</span>"),str+="</label></li>",popup.append(str);var r=$(window),s=r.width(),c=r.height(),l=r.scrollTop(),d=popupDialog.outerWidth(),u=popupDialog.outerHeight(),h=(c-u)/2+l,g=(s-d)/2;popupDialog.css({top:(h<0?0:h)+"px",left:(g<0?0:g)+"px"}),popupDialog.find("button.api-popup-cancel").click(function(){popupMask.hide(),popupDialog.hide(),popupDialog.empty(),popupDialog=[]}),$("button.api-popup-authbtn").unbind(),popupDialog.find("button.api-popup-authbtn").click(function(){function e(e){return e.vendorExtensions["x-tokenName"]||e.tokenName}popupMask.hide(),popupDialog.hide();var o,i=window.swaggerUi.api.authSchemes,n=window.location,a=location.pathname.substring(0,location.pathname.lastIndexOf("/")),t=n.protocol+"//"+n.host+a+"/o2c.html",p=window.oAuthRedirectUrl||t,r=null,s=[],c=popup.find("input:checked"),l=[];for(k=0;k<c.length;k++){var d=$(c[k]).attr("scope");s.indexOf(d)===-1&&s.push(d);var u=$(c[k]).attr("oauthtype");l.indexOf(u)===-1&&l.push(u)}window.enabledScopes=s;for(var h in i)if(i.hasOwnProperty(h)&&l.indexOf(h)!=-1){var g=i[h].flow;if("oauth2"!==i[h].type||!g||"implicit"!==g&&"accessCode"!==g){if("oauth2"===i[h].type&&g&&"application"===g){var w=i[h];return window.swaggerUi.tokenName=e(w)||"access_token",void clientCredentialsFlow(s,w.tokenUrl,h)}if(i[h].grantTypes){var c=i[h].grantTypes;for(var f in c)if(c.hasOwnProperty(f)&&"implicit"===f){var w=c[f];w.loginEndpoint.url;r=w.loginEndpoint.url+"?response_type=token",window.swaggerUi.tokenName=e(w)}else if(c.hasOwnProperty(f)&&"accessCode"===f){var w=c[f];w.tokenRequestEndpoint.url;r=w.tokenRequestEndpoint.url+"?response_type=code",window.swaggerUi.tokenName=e(w)}}}else{var w=i[h];r=w.authorizationUrl+"?response_type="+("implicit"===g?"token":"code"),window.swaggerUi.tokenName=e(w)||"access_token",window.swaggerUi.tokenUrl="accessCode"===g?w.tokenUrl:null,o=h}}redirect_uri=p,r+="&redirect_uri="+encodeURIComponent(p),r+="&realm="+encodeURIComponent(realm),r+="&client_id="+encodeURIComponent(clientId),r+="&scope="+encodeURIComponent(s.join(scopeSeparator)),r+="&state="+encodeURIComponent(o);for(var h in additionalQueryStringParams)r+="&"+h+"="+encodeURIComponent(additionalQueryStringParams[h]);window.open(r)}),popupMask.show(),popupDialog.show()}function handleLogout(){for(key in window.swaggerUi.api.clientAuthorizations.authz)window.swaggerUi.api.clientAuthorizations.remove(key);window.enabledScopes=null,$(".api-ic.ic-on").addClass("ic-off"),$(".api-ic.ic-on").removeClass("ic-on"),$(".api-ic.ic-warning").addClass("ic-error"),$(".api-ic.ic-warning").removeClass("ic-warning")}function initOAuth(e){var o=e||{},i=[];return appName=o.appName||i.push("missing appName"),popupMask=o.popupMask||$("#api-common-mask"),popupDialog=o.popupDialog||$(".api-popup-dialog"),clientId=o.clientId||i.push("missing client id"),clientSecret=o.clientSecret||null,realm=o.realm||i.push("missing realm"),scopeSeparator=o.scopeSeparator||" ",additionalQueryStringParams=o.additionalQueryStringParams||{},i.length>0?void log("auth unable initialize oauth: "+i):($("pre code").each(function(e,o){hljs.highlightBlock(o)}),$(".api-ic").unbind(),void $(".api-ic").click(function(e){$(e.target).hasClass("ic-off")?handleLogin():handleLogout()}))}function clientCredentialsFlow(e,o,i){var n={client_id:clientId,client_secret:clientSecret,scope:e.join(" "),grant_type:"client_credentials"};$.ajax({url:o,type:"POST",data:n,success:function(e,o,n){onOAuthComplete(e,i)},error:function(e,o,i){onOAuthComplete("")}})}var appName,popupMask,popupDialog,clientId,realm,redirect_uri,clientSecret,scopeSeparator,additionalQueryStringParams;window.processOAuthCode=function(e){var o=e.state,i=window.location,n=location.pathname.substring(0,location.pathname.lastIndexOf("/")),a=i.protocol+"//"+i.host+n+"/o2c.html",t=window.oAuthRedirectUrl||a,p={client_id:clientId,code:e.code,grant_type:"authorization_code",redirect_uri:t};clientSecret&&(p.client_secret=clientSecret),$.ajax({url:window.swaggerUiAuth.tokenUrl,type:"POST",data:p,success:function(e,i,n){onOAuthComplete(e,o)},error:function(e,o,i){onOAuthComplete("")}})},window.onOAuthComplete=function(e,o){if(e)if(e.error){var i=$("input[type=checkbox],.secured");i.each(function(e){i[e].checked=!1}),alert(e.error)}else{var n=e[window.swaggerUiAuth.tokenName];if(o||(o=e.state),n){var a=null;$.each($(".auth .api-ic .api_information_panel"),function(e,o){var i=o;if(i&&i.childNodes){var n=[];$.each(i.childNodes,function(e,o){var i=o.innerHTML;i&&n.push(i)});for(var t=[],p=0;p<n.length;p++){var r=n[p];window.enabledScopes&&window.enabledScopes.indexOf(r)==-1&&t.push(r)}t.length>0?(a=o.parentNode.parentNode,$(a.parentNode).find(".api-ic.ic-on").addClass("ic-off"),$(a.parentNode).find(".api-ic.ic-on").removeClass("ic-on"),$(a).find(".api-ic").addClass("ic-warning"),$(a).find(".api-ic").removeClass("ic-error")):(a=o.parentNode.parentNode,$(a.parentNode).find(".api-ic.ic-off").addClass("ic-on"),$(a.parentNode).find(".api-ic.ic-off").removeClass("ic-off"),$(a).find(".api-ic").addClass("ic-info"),$(a).find(".api-ic").removeClass("ic-warning"),$(a).find(".api-ic").removeClass("ic-error"))}}),"undefined"!=typeof window.swaggerUi&&(window.swaggerUi.api.clientAuthorizations.add(window.swaggerUiAuth.OAuthSchemeKey,new SwaggerClient.ApiKeyAuthorization("Authorization","Bearer "+n,"header")),window.swaggerUi.load())}}};

data/app/assets/javascripts/swagger_ui_engine/swagger-ui.js

@@ -4,7 +4,7 @@
  * @link http://swagger.io
  * @license Apache-2.0
  */
-(function(){/* jshint ignore:start */ 
+(function(){/* jshint ignore:start */
  {(function() {
   var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
 templates['apikey_auth'] = template({"1":function(container,depth0,helpers,partials,data) {
@@ -29,7 +29,7 @@ templates['apikey_auth'] = template({"1":function(container,depth0,helpers,parti
     + "        </div>\n    </div>\n</div>\n";
 },"useData":true});
 templates['auth_button'] = template({"compiler":[7,">= 4.0.0"],"main":function(container,depth0,helpers,partials,data) {
-    return "<a class='authorize__btn' href=\"#\">Authorize</a>\n";
+    return "<a class='authorize__btn' href=\"#\" data-sw-translate>Authorize</a>\n";
 },"useData":true});
 templates['auth_button_operation'] = template({"1":function(container,depth0,helpers,partials,data) {
     return "        authorize__btn_operation_login\n";
@@ -685,7 +685,7 @@ templates['resource'] = template({"1":function(container,depth0,helpers,partials
     + ((stack1 = (helpers.sanitize || (depth0 && depth0.sanitize) || helpers.helperMissing).call(depth0 != null ? depth0 : {},(depth0 != null ? depth0.url : depth0),{"name":"sanitize","hash":{},"data":data})) != null ? stack1 : "")
     + "' data-sw-translate>Raw</a>\n    </li>\n";
 },"compiler":[7,">= 4.0.0"],"main":function(container,depth0,helpers,partials,data) {
-    var stack1, helper, options, alias1=depth0 != null ? depth0 : {}, alias2=helpers.helperMissing, buffer = 
+    var stack1, helper, options, alias1=depth0 != null ? depth0 : {}, alias2=helpers.helperMissing, buffer =
   "<div class='heading'>\n  <h2>\n    <a href='#!/"
     + ((stack1 = (helpers.sanitize || (depth0 && depth0.sanitize) || alias2).call(alias1,(depth0 != null ? depth0.id : depth0),{"name":"sanitize","hash":{},"data":data})) != null ? stack1 : "")
     + "' class=\"toggleEndpointList\" data-id=\""
@@ -797,7 +797,7 @@ templates['status_code'] = template({"1":function(container,depth0,helpers,parti
     + ((stack1 = helpers.each.call(alias1,(depth0 != null ? depth0.headers : depth0),{"name":"each","hash":{},"fn":container.program(1, data, 0),"inverse":container.noop,"data":data})) != null ? stack1 : "")
     + "    </tbody>\n  </table>\n</td>";
 },"useData":true});
-})();} 
+})();}
  /* jshint ignore:end */
 'use strict';
 
@@ -24827,7 +24827,7 @@ SwaggerUi.partials.signature = (function () {
     return result;
   };
   */
-  
+
   var getPrefix = function (name, xml) {
     var result = name || '';
 
@@ -24965,7 +24965,7 @@ SwaggerUi.partials.signature = (function () {
 
     if (namespace) {
       attrs.push(namespace);
-    }   
+    }
 
     if (!properties && !additionalProperties) { return getErrorMessage(); }
 
@@ -25010,10 +25010,10 @@ SwaggerUi.partials.signature = (function () {
     var output, index;
     config = config || {};
     config.modelsToIgnore = config.modelsToIgnore || [];
-   
+
     var descriptor = _.isString($ref) ? getDescriptorByRef($ref, name, models, config)
         : getDescriptor(name, definition, models, config);
-    
+
     if (!descriptor) {
       return getErrorMessage();
     }
@@ -25064,7 +25064,7 @@ SwaggerUi.partials.signature = (function () {
     else {
         name = name || model.name;
     }
-    
+
     if (config.modelsToIgnore.indexOf($ref) > -1) {
       type = 'loop';
       config.loopTo = modelType;
@@ -25075,7 +25075,7 @@ SwaggerUi.partials.signature = (function () {
     if (!model.definition) {
       return null;
     }
-    return new Descriptor(name, type, model.definition, models, config);    
+    return new Descriptor(name, type, model.definition, models, config);
   }
 
   function getDescriptor (name, definition, models, config){

data/app/assets/stylesheets/swagger_ui_engine/application.css

@@ -2,4 +2,5 @@
  *= require ./lib/typography.css
  *= require ./lib/reset.css
  *= require ./lib/screen.css
+ *= require ./custom.css
  */

data/app/assets/stylesheets/swagger_ui_engine/custom.css

@@ -0,0 +1,7 @@
+#swagger-ui-container {
+  margin-bottom: 30px;
+}
+
+.swagger-return-link {
+  padding-bottom: 30px;
+}

data/app/controllers/swagger_ui_engine/application_controller.rb

@@ -1,6 +1,7 @@
 module SwaggerUiEngine
   class ApplicationController < ActionController::Base
-    include AuthConfigParser
+    include SwaggerUiEngine::AuthConfigParser
+    include SwaggerUiEngine::TranslationHelper
 
     protect_from_forgery with: :exception
     layout false

data/app/controllers/swagger_ui_engine/docs_controller.rb

@@ -1,9 +1,13 @@
 module SwaggerUiEngine
   class DocsController < ApplicationController
-    include ConfigParser
-    include SwaggerUiDefaults
+    include SwaggerUiEngine::ConfigParser
+    include SwaggerUiEngine::OauthConfigParser
+    include SwaggerUiEngine::SwaggerUiDefaults
 
-    before_action :set_configs
+    before_action :set_configs, :set_oauth_configs
+
+    def oauth2
+    end
 
     def index
       # backward compatibility for defining single doc url in strings
@@ -12,6 +16,7 @@ module SwaggerUiEngine
     end
 
     def show
+      @single_doc_url = single_doc_url? || single_doc_url_hash?
       @swagger_url = @swagger_url[params[:id].to_sym] unless single_doc_url?
     end
 
@@ -26,6 +31,15 @@ module SwaggerUiEngine
       @validator_url = set_validator_url
     end
 
+    def set_oauth_configs
+      @oauth_app_name = set_oauth_app_name
+      @oauth_client_id = set_oauth_client_id
+      @oauth_client_secret = set_oauth_client_secret
+      @oauth_realm = set_oauth_realm
+      @oauth_query_string_params = set_oauth_query_string_params
+      @oauth_scope_separator = set_oauth_scope_separator
+    end
+
     def single_doc_url?
       @swagger_url.is_a?(String)
     end

data/app/helpers/swagger_ui_engine/auth_config_parser.rb

@@ -0,0 +1,19 @@
+module SwaggerUiEngine
+  module AuthConfigParser
+    def admin_username
+      configuration.admin_username
+    end
+
+    def admin_password
+      configuration.admin_password
+    end
+
+    def basic_authentication_enabled?
+      admin_username && admin_password
+    end
+
+    def configuration
+      SwaggerUiEngine.configuration
+    end
+  end
+end

data/app/helpers/swagger_ui_engine/config_parser.rb

@@ -0,0 +1,39 @@
+module SwaggerUiEngine
+  module ConfigParser
+    def set_doc_expansion
+      configuration.doc_expansion || default_doc_expansion
+    end
+
+    def set_json_editor
+      configuration.json_editor || default_json_editor
+    end
+
+    def set_model_rendering
+      configuration.model_rendering || default_model_rendering
+    end
+
+    def set_request_headers
+      configuration.request_headers || default_request_headers
+    end
+
+    def set_show_operation_ids
+      configuration.show_operation_ids || default_show_operation_ids
+    end
+
+    def set_swagger_url
+      configuration.swagger_url || default_swagger_url
+    end
+
+    def set_validator_url
+      validator_enabled ? default_validator_url : 'null'
+    end
+
+    def validator_enabled
+      configuration.validator_enabled || false
+    end
+
+    def configuration
+      SwaggerUiEngine.configuration
+    end
+  end
+end

data/app/helpers/swagger_ui_engine/oauth_config_parser.rb

@@ -0,0 +1,31 @@
+module SwaggerUiEngine
+  module OauthConfigParser
+    def set_oauth_app_name
+      configuration.oauth_app_name || 'your-app-name'
+    end
+
+    def set_oauth_client_id
+      configuration.oauth_client_id || 'your-client-id'
+    end
+
+    def set_oauth_client_secret
+      configuration.oauth_client_secret || 'your-client-secret-if-required'
+    end
+
+    def set_oauth_realm
+      configuration.oauth_realm || 'your-realms'
+    end
+
+    def set_oauth_scope_separator
+      configuration.oauth_scope_separator || ' '
+    end
+
+    def set_oauth_query_string_params
+      configuration.oauth_query_string_params || {}
+    end
+
+    def configuration
+      SwaggerUiEngine.configuration
+    end
+  end
+end

data/app/helpers/swagger_ui_engine/swagger_ui_defaults.rb

@@ -0,0 +1,27 @@
+module SwaggerUiEngine
+  module SwaggerUiDefaults
+    def default_swagger_url
+      'http://petstore.swagger.io/v2/swagger.json'
+    end
+
+    def default_doc_expansion
+      'none'
+    end
+
+    def default_json_editor
+      false
+    end
+
+    def default_model_rendering
+      'schema'
+    end
+
+    def default_request_headers
+      false
+    end
+
+    def default_validator_url
+      '//online.swagger.io/validator'
+    end
+  end
+end

data/app/helpers/swagger_ui_engine/translation_helper.rb

@@ -0,0 +1,16 @@
+module SwaggerUiEngine
+  module TranslationHelper
+    def load_translation_file
+      return unless translator_enabled?
+      javascript_include_tag('swagger_ui_engine/lang/translator', lang_file_path)
+    end
+
+    def lang_file_path
+      "swagger_ui_engine/lang/#{I18n.locale.to_s.downcase}.js"
+    end
+
+    def translator_enabled?
+      SwaggerUiEngine.configuration.translator_enabled
+    end
+  end
+end

data/app/views/swagger_ui_engine/docs/show.html.erb

@@ -11,6 +11,7 @@
     <%= stylesheet_link_tag "swagger_ui_engine/print", media: "print" %>
 
     <%= javascript_include_tag "swagger_ui_engine/application" %>
+    <%= load_translation_file %>
     <%= csrf_meta_tags %>
 
     <script type="text/javascript">
@@ -33,17 +34,18 @@
         window.swaggerUi = new SwaggerUi({
           url: url,
           validatorUrl: "<%= @validator_url %>",
+          oauth2RedirectUrl: "<%= oauth2_docs_path %>",
           dom_id: "swagger-ui-container",
           supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
           onComplete: function(swaggerApi, swaggerUi){
             if(typeof initOAuth == "function") {
               initOAuth({
-                clientId: "your-client-id",
-                clientSecret: "your-client-secret-if-required",
-                realm: "your-realms",
-                appName: "your-app-name",
-                scopeSeparator: " ",
-                additionalQueryStringParams: {}
+                clientId: "<%= @oauth_client_id %>",
+                clientSecret: "<%= @oauth_client_secret %>",
+                realm: "<%= @oauth_realm %>",
+                appName: "<%= @oauth_app_name %>",
+                scopeSeparator: "<%= @oauth_scope_separator %>",
+                additionalQueryStringParams: "<%= @oauth_query_string_params %>"
               });
             }
 
@@ -86,5 +88,10 @@
 
     <div id="message-bar" class="swagger-ui-wrap" data-sw-translate>&nbsp;</div>
     <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
+    <% unless @single_doc_url %>
+      <div class="swagger-ui-wrap">
+        <a href="<%= docs_path %>" class="swagger-return-link" data-sw-translate>Back to the list</a>
+      </div>
+    <% end %>
   </body>
 </html>

data/config/routes.rb

@@ -1,6 +1,11 @@
 SwaggerUiEngine::Engine.routes.draw do
   scope format: false do
-    resources :docs, only: [:index, :show]
+    resources :docs, only: [:index, :show] do
+      collection do
+        get 'oauth2', to: 'docs#oauth2', format: false
+      end
+    end
+
     root to: 'docs#index'
   end
 end

data/lib/swagger_ui_engine/configuration.rb

@@ -7,8 +7,15 @@ module SwaggerUiEngine
       :doc_expansion,
       :json_editor,
       :model_rendering,
+      :oauth_client_id,
+      :oauth_client_secret,
+      :oauth_realm,
+      :oauth_app_name,
+      :oauth_scope_separator,
+      :oauth_query_string_params,
       :request_headers,
       :swagger_url,
+      :translator_enabled,
       :validator_enabled,
     ].freeze
 

data/lib/swagger_ui_engine/engine.rb

@@ -8,10 +8,12 @@ module SwaggerUiEngine
         swagger_ui_engine/lib/reset.css
         swagger_ui_engine/lib/screen.css
         swagger_ui_engine/lib/print.css
+        swagger_ui_engine/custom.css
         swagger_ui_engine/print.css
         swagger_ui_engine/logo_small.png
         swagger_ui_engine/favicon-32x32.png
         swagger_ui_engine/favicon-16x16.png
+        swagger_ui_engine/lang/*.js
       )
 
       Rails.application.config.assets.paths << Rails.root.join('vendor', 'assets', 'fonts')

data/lib/swagger_ui_engine/version.rb

@@ -1,4 +1,4 @@
 module SwaggerUiEngine
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
   SWAGGER_UI_VERSION = '2.2.10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_ui_engine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ZuzannaSt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,6 +55,7 @@ files:
 - app/assets/images/swagger_ui_engine/wordnik_api.png
 - app/assets/javascripts/swagger_ui_engine/application.js
 - app/assets/javascripts/swagger_ui_engine/lang/ca.js
+- app/assets/javascripts/swagger_ui_engine/lang/de.js
 - app/assets/javascripts/swagger_ui_engine/lang/el.js
 - app/assets/javascripts/swagger_ui_engine/lang/en.js
 - app/assets/javascripts/swagger_ui_engine/lang/es.js
@@ -85,11 +86,11 @@ files:
 - app/assets/javascripts/swagger_ui_engine/lib/object-assign-pollyfill.js
 - app/assets/javascripts/swagger_ui_engine/lib/sanitize-html.min.js
 - app/assets/javascripts/swagger_ui_engine/lib/swagger-oauth.js
-- app/assets/javascripts/swagger_ui_engine/o2c.html
 - app/assets/javascripts/swagger_ui_engine/swagger-ui.js
 - app/assets/javascripts/swagger_ui_engine/swagger-ui.min.js
 - app/assets/javascripts/swagger_ui_engine/swagger.json
 - app/assets/stylesheets/swagger_ui_engine/application.css
+- app/assets/stylesheets/swagger_ui_engine/custom.css
 - app/assets/stylesheets/swagger_ui_engine/lib/print.css.erb
 - app/assets/stylesheets/swagger_ui_engine/lib/reset.css
 - app/assets/stylesheets/swagger_ui_engine/lib/screen.css.erb
@@ -98,10 +99,13 @@ files:
 - app/assets/stylesheets/swagger_ui_engine/print.css
 - app/controllers/swagger_ui_engine/application_controller.rb
 - app/controllers/swagger_ui_engine/docs_controller.rb
-- app/helpers/auth_config_parser.rb
-- app/helpers/config_parser.rb
-- app/helpers/swagger_ui_defaults.rb
+- app/helpers/swagger_ui_engine/auth_config_parser.rb
+- app/helpers/swagger_ui_engine/config_parser.rb
+- app/helpers/swagger_ui_engine/oauth_config_parser.rb
+- app/helpers/swagger_ui_engine/swagger_ui_defaults.rb
+- app/helpers/swagger_ui_engine/translation_helper.rb
 - app/views/swagger_ui_engine/docs/index.html.erb
+- app/views/swagger_ui_engine/docs/ouath2.html.erb
 - app/views/swagger_ui_engine/docs/show.html.erb
 - config/routes.rb
 - lib/swagger_ui_engine.rb

data/app/helpers/auth_config_parser.rb

@@ -1,17 +0,0 @@
-module AuthConfigParser
-  def admin_username
-    configuration.admin_username
-  end
-
-  def admin_password
-    configuration.admin_password
-  end
-
-  def basic_authentication_enabled?
-    admin_username && admin_password
-  end
-
-  def configuration
-    SwaggerUiEngine.configuration
-  end
-end

data/app/helpers/config_parser.rb

@@ -1,37 +0,0 @@
-module ConfigParser
-  def set_doc_expansion
-    configuration.doc_expansion || default_doc_expansion
-  end
-
-  def set_json_editor
-    configuration.json_editor || default_json_editor
-  end
-
-  def set_model_rendering
-    configuration.model_rendering || default_model_rendering
-  end
-
-  def set_request_headers
-    configuration.request_headers || default_request_headers
-  end
-
-  def set_show_operation_ids
-    configuration.show_operation_ids || default_show_operation_ids
-  end
-
-  def set_swagger_url
-    configuration.swagger_url || default_swagger_url
-  end
-
-  def set_validator_url
-    validator_enabled ? default_validator_url : 'null'
-  end
-
-  def validator_enabled
-    configuration.validator_enabled || false
-  end
-
-  def configuration
-    SwaggerUiEngine.configuration
-  end
-end

data/app/helpers/swagger_ui_defaults.rb

@@ -1,25 +0,0 @@
-module SwaggerUiDefaults
-  def default_swagger_url
-    'http://petstore.swagger.io/v2/swagger.json'
-  end
-
-  def default_doc_expansion
-    'none'
-  end
-
-  def default_model_rendering
-    'schema'
-  end
-
-  def default_json_editor
-    false
-  end
-
-  def default_request_headers
-    false
-  end
-
-  def default_validator_url
-    '//online.swagger.io/validator'
-  end
-end