grape-swagger-ui 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02eba1747238825a0d90879adb81e84c87c805ff
-  data.tar.gz: 2a4c67cf5189e641a3e27f937bc4a6387d5505bb
+  metadata.gz: c7e74c225b173b884858eff45aa6dda7b451d9bf
+  data.tar.gz: 40ce002bcd5c185be1fc5ca2bbc11bea0101fe9c
 SHA512:
-  metadata.gz: 319eddc0d9ac5472cf638109d97ff39f6a5a6d0e67d791cfa6d88a55428eeaaafc64ad85f883bd3420f249eb98b9340b7340e93044808a7e6f81e87160a972aa
-  data.tar.gz: bb394e1d2170e96855e5eb53eabada6f4961d5614475c0692c333968c74c015afaf7ddf61746d1f75c0c7dce50699faf7ed6c75d5f47b4b56e9189c8f711ab1b
+  metadata.gz: 80a484beff310bd15f208ee157238b7f8a4f08e99fb7b44ee4627e10281a87d3786703a35772a943c9da6f89259235c3c1e14356ce337417e8cec9fe4ae941c0
+  data.tar.gz: 7d49aacaf6fe37e28da760666ed11543a85bf75e461502e6814aff13f0c34f7b3c5aa68935e8503b82ac6ff72f8bb10b4d7ed3dc9f83dc030a5b3eadbef7979c

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 *.iml
 atlassian-ide-plugin.xml
 .idea/
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Change Log
+
+## [Unreleased](https://github.com/kendrikat/grape-swagger-ui/tree/HEAD)
+
+[Full Changelog](https://github.com/kendrikat/grape-swagger-ui/compare/v0.0.3...HEAD)
+
+**Closed issues:**
+
+- Swagger UI needs to be updated  [\#9](https://github.com/kendrikat/grape-swagger-ui/issues/9)
+
+## [v0.0.3](https://github.com/kendrikat/grape-swagger-ui/tree/v0.0.3) (2016-08-09)
+[Full Changelog](https://github.com/kendrikat/grape-swagger-ui/compare/v0.0.2...v0.0.3)
+
+**Closed issues:**
+
+- Routing not working [\#6](https://github.com/kendrikat/grape-swagger-ui/issues/6)
+- haml issue in rails 4 [\#4](https://github.com/kendrikat/grape-swagger-ui/issues/4)
+
+**Merged pull requests:**
+
+- Support swagger spec 2.0 [\#8](https://github.com/kendrikat/grape-swagger-ui/pull/8) ([dangnm](https://github.com/dangnm))
+
+## [v0.0.2](https://github.com/kendrikat/grape-swagger-ui/tree/v0.0.2) (2015-01-14)
+[Full Changelog](https://github.com/kendrikat/grape-swagger-ui/compare/v0.0.1...v0.0.2)
+
+**Closed issues:**
+
+- License missing from gemspec [\#2](https://github.com/kendrikat/grape-swagger-ui/issues/2)
+
+**Merged pull requests:**
+
+- update for swagger-ui 2.0.24 [\#5](https://github.com/kendrikat/grape-swagger-ui/pull/5) ([alexagranov](https://github.com/alexagranov))
+- assets path mistake in swagger-ui.js [\#3](https://github.com/kendrikat/grape-swagger-ui/pull/3) ([dfang](https://github.com/dfang))
+- Optional form fields are not being send with request [\#1](https://github.com/kendrikat/grape-swagger-ui/pull/1) ([camol](https://github.com/camol))
+
+## [v0.0.1](https://github.com/kendrikat/grape-swagger-ui/tree/v0.0.1) (2013-02-25)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -5,12 +5,7 @@ Grape::Swagger::Ui
 
 TODO/WIP: Write a gem description
 
-Integrates [swagger-ui] with your "grapified" Rails3 application.
-
-** UPDATE FOR 0.0.9 **
--
-
-- The property for specifying your Swagger endpoint on SwaggerUi has been renamed from 'discoveryUrl' to just 'url'.  This has been updated in the index page template 'swagger.html.erb' but you will need to either regenerate or manually edit your existing page.
+Integrates [swagger-ui] with your "grapified" Rails application.
 
 ## Dependencies
 
@@ -36,11 +31,15 @@ Or install it yourself as:
 
 ## Usage example:
 
-    # class YourAPI < Grape::API
-    add_swagger_documentation :format => :json,
-                              :api_version => 'v1',
-                              :base_path => "http://#{Rails.configuration.default_host}/api/",
-                              :hide_documentation_path => true
+    class YourAPI < Grape::API
+      version 'v1'
+      format :json
+      ...
+      add_swagger_documentation :add_version => true,
+                                :base_path => '/api'
+    end
+
+*See https://github.com/ruby-grape/grape-swagger#configure for more configuration settings.*
 
 If your api path is "api/v1" just go to
 
@@ -57,11 +56,8 @@ and change the initializer.
 Since this is a seperate layout and if you want to use this in your staging environment you need to precompile it.
 
 	#staging.rb
-	config.assets.precompile += ["swagger_ui.css", "swagger_ui.js"]
-
-## Version
+	config.assets.precompile += %w(swagger_ui.js swagger_ui.css swagger_ui_print.css swagger_ui_screen.css)
 
-0.0.9
 
 ## Contributing
 

data/app/views/layouts/swagger.html.erb

@@ -4,79 +4,93 @@
     <title>Swagger UI</title>
     <%= javascript_include_tag :swagger_ui %>
     <%= stylesheet_link_tag "//fonts.googleapis.com/css?family=Droid+Sans:400,700" %>
-    <%= stylesheet_link_tag :swagger_ui, :media => :all %>
+    <%= stylesheet_link_tag :swagger_ui_screen, :media => :screen %>
+    <%= stylesheet_link_tag :swagger_ui_print, :media => :print %>
     <%= csrf_meta_tags %>
 
-    <script>
+    <script type="text/javascript">
+      $(function () {
+        var url = window.location.search.match(/url=([^&]+)/);
+        if (url && url.length > 1) {
+          url = decodeURIComponent(url[1]);
+        } else {
+          url = "http://<%= request.host%>:<%=request.port%>/api/v1/swagger_doc";
+        }
 
-        $(function () {
-            $.ajaxPrefilter(function (o, options) {
-                options.headers = {'X-CSRF-Token': '#{form_authenticity_token.to_s}'}
-            });
+        hljs.configure({
+          highlightSizeThreshold: 5000
         });
 
-        $(function () {
-            window.swaggerUi = new SwaggerUi({
-                url: "http://<%= request.host%>:<%=request.port%>/api/swagger_doc",
-                apiKey: "",
-                dom_id: "swagger-ui-container",
-                supportHeaderParams: false,
-                supportedSubmitMethods: ['get', 'post', 'put'],
-                onComplete: function (swaggerApi, swaggerUi) {
-                    log("Loaded SwaggerUI");
-                    if (typeof initOAuth == "function") {
-                        /*
-                         initOAuth({
-                         clientId: "your-client-id",
-                         realm: "your-realms",
-                         appName: "your-app-name"
-                         });
-                         */
-                    }
-                    $('pre code').each(function (i, e) {
-                        hljs.highlightBlock(e)
-                    });
-                },
-                onFailure: function (data) {
-                    log("Unable to Load SwaggerUI");
-                },
-                docExpansion: "none",
-                sorter: "alpha"
-            });
+        // Pre load translate...
+        if(window.SwaggerTranslator) {
+          window.SwaggerTranslator.translate();
+        }
+        window.swaggerUi = new SwaggerUi({
+          url: url,
+          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: {}
+              });
+            }
 
-            $('#input_apiKey').change(function () {
-                var key = $('#input_apiKey')[0].value;
-                log("key: " + key);
-                if (key && key.trim() != "") {
-                    log("added key " + key);
-                    window.authorizations.add("key", new ApiKeyAuthorization("api_key", key, "query"));
-                }
-            })
-            window.swaggerUi.load();
+            if(window.SwaggerTranslator) {
+              window.SwaggerTranslator.translate();
+            }
+          },
+          onFailure: function(data) {
+            log("Unable to Load SwaggerUI");
+          },
+          docExpansion: "none",
+          jsonEditor: false,
+          defaultModelRendering: 'schema',
+          showRequestHeaders: false
         });
 
+        $('#input_apiKey').change(function() {
+          var key = $('#input_apiKey')[0].value;
+          if(key && key.trim() != "") {
+            swaggerUi.api.clientAuthorizations.add("key", new SwaggerClient.ApiKeyAuthorization("api_key", key, "query"));
+          }
+        })
 
+        window.swaggerUi.load();
+
+        function log() {
+          if ('console' in window) {
+            console.log.apply(console, arguments);
+          }
+        }
+    });
     </script>
+
 </head>
-<body class="swagger-section">
-<div id="header">
-    <div class="swagger-ui-wrap">
-        <a href="http://swagger.wordnik.com" id="logo">Swagger</a>
 
-        <form id="api_selector">
-            <div class="input">
-                <input id="input_baseUrl" name="baseUrl" placeholder="http://example.com/api" type="text"></input>
-            </div>
-            <div class="input">
-                <input id="input_apiKey" name="apiKey" placeholder="api_key" type="text"></input>
-            </div>
-            <div class="input">
-                <a href="#" id="explore">Explore</a>
-            </div>
-        </form>
-    </div>
+
+<body class="swagger-section">
+<div id='header'>
+  <div class="swagger-ui-wrap">
+    <a id="logo" href="http://swagger.io"><span class="logo__title">swagger</span></a>
+    <form id='api_selector'>
+      <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
+      <div class="input">
+				<input id="input_apiKey" name="apiKey" placeholder="api_key" type="text"></input>
+			</div>
+      <div id='auth_container'></div>
+      <div class='input'><a id="explore" class="header__btn" href="#" data-sw-translate>Explore</a></div>
+    </form>
+  </div>
 </div>
-<div class="swagger-ui-wrap" id="message-bar">&nbsp;</div>
-<div class="swagger-ui-wrap" id="swagger-ui-container"></div>
+
+<div id="message-bar" class="swagger-ui-wrap" data-sw-translate>&nbsp;</div>
+<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
 </body>
+
 </html>

data/lib/generators/swagger/layout/templates/swagger.html.haml

@@ -4,7 +4,8 @@
     %title Swagger UI
 
     = javascript_include_tag :swagger_ui
-    = stylesheet_link_tag :swagger_ui, :media => :all
+    = stylesheet_link_tag :swagger_ui_screen, :media => :screen
+    = stylesheet_link_tag :swagger_ui_print, :media => :print
     = csrf_meta_tags
 
     :css
@@ -14,36 +15,82 @@
         margin-left: auto;
         margin-right: auto;
       }
-    
-    :javascript
-      $(function(){
-        $.ajaxPrefilter(function(o, options){
-          options.headers = { 'X-CSRF-Token': '#{form_authenticity_token.to_s}' }
-        });      
-      });
 
+    :javascript
       $(function () {
+        var url = window.location.search.match(/url=([^&]+)/);
+        if (url && url.length > 1) {
+          url = decodeURIComponent(url[1]);
+        } else {
+          url = "http://#{request.host}:#{request.port}/api/v1/swagger_doc";
+        }
+
+        hljs.configure({
+          highlightSizeThreshold: 5000
+        });
+
+        // Pre load translate...
+        if(window.SwaggerTranslator) {
+          window.SwaggerTranslator.translate();
+        }
         window.swaggerUi = new SwaggerUi({
-          discoveryUrl: "http://#{request.host}:#{request.port}/api/swagger_doc.json",
-          apiKey:"",
-          dom_id:"swagger-ui-container",
-          supportHeaderParams: false,
-          supportedSubmitMethods: ['get', 'post', 'put']
+          url: url,
+          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: {}
+              });
+            }
+
+            if(window.SwaggerTranslator) {
+              window.SwaggerTranslator.translate();
+            }
+          },
+          onFailure: function(data) {
+            log("Unable to Load SwaggerUI");
+          },
+          docExpansion: "none",
+          jsonEditor: false,
+          defaultModelRendering: 'schema',
+          showRequestHeaders: false
         });
+
+        $('#input_apiKey').change(function() {
+          var key = $('#input_apiKey')[0].value;
+          if(key && key.trim() != "") {
+            swaggerUi.api.clientAuthorizations.add("key", new SwaggerClient.ApiKeyAuthorization("api_key", key, "query"));
+          }
+        })
+
         window.swaggerUi.load();
+
+        function log() {
+          if ('console' in window) {
+            console.log.apply(console, arguments);
+          }
+        }
       });
 
-  %body
+  %body.swagger-section
     #header
       .swagger-ui-wrap
-        %a#logo{ href: "http://swagger.wordnik.com" } Swagger
+        %a#logo{:href => "http://swagger.io"}
+          %span.logo__title swagger
         %form#api_selector
           .input
-            %input#input_baseUrl{ placeholder: "http://example.com/api", name: "baseUrl", type: "text" }
+            %input#input_baseUrl{:name => "baseUrl", :placeholder => "http://example.com/api", :type => "text"}/
           .input
-            %input#input_apiKey{ placeholder: "api_key", name: "apiKey", type: "text" }
+            %input#input_apiKey{:name => "apiKey", :placeholder => "api_key", :type => "text"}
+          #auth_container
           .input
-            %a#explore{ href: "#"} Explore
+            %a#explore.header__btn{"data-sw-translate" => "", :href => "#"} Explore
+    #message-bar.swagger-ui-wrap{"data-sw-translate" => ""}  
+    #swagger-ui-container.swagger-ui-wrap
 
-    #message-bar.swagger-ui-wrap  
-    #swagger-ui-container.swagger-ui-wrap

data/lib/grape-swagger-ui/version.rb

@@ -1,7 +1,7 @@
 module Grape
   module Swagger
     module Ui
-      VERSION = "0.0.9"
+      VERSION = "0.1.0"
     end
   end
 end

data/vendor/assets/javascripts/lang/en.js

@@ -0,0 +1,56 @@
+'use strict';
+
+/* jshint quotmark: double */
+window.SwaggerTranslator.learn({
+    "Warning: Deprecated":"Warning: Deprecated",
+    "Implementation Notes":"Implementation Notes",
+    "Response Class":"Response Class",
+    "Status":"Status",
+    "Parameters":"Parameters",
+    "Parameter":"Parameter",
+    "Value":"Value",
+    "Description":"Description",
+    "Parameter Type":"Parameter Type",
+    "Data Type":"Data Type",
+    "Response Messages":"Response Messages",
+    "HTTP Status Code":"HTTP Status Code",
+    "Reason":"Reason",
+    "Response Model":"Response Model",
+    "Request URL":"Request URL",
+    "Response Body":"Response Body",
+    "Response Code":"Response Code",
+    "Response Headers":"Response Headers",
+    "Hide Response":"Hide Response",
+    "Headers":"Headers",
+    "Try it out!":"Try it out!",
+    "Show/Hide":"Show/Hide",
+    "List Operations":"List Operations",
+    "Expand Operations":"Expand Operations",
+    "Raw":"Raw",
+    "can't parse JSON.  Raw result":"can't parse JSON.  Raw result",
+    "Example Value":"Example Value",
+    "Model Schema":"Model Schema",
+    "Model":"Model",
+    "Click to set as parameter value":"Click to set as parameter value",
+    "apply":"apply",
+    "Username":"Username",
+    "Password":"Password",
+    "Terms of service":"Terms of service",
+    "Created by":"Created by",
+    "See more at":"See more at",
+    "Contact the developer":"Contact the developer",
+    "api version":"api version",
+    "Response Content Type":"Response Content Type",
+    "Parameter content type:":"Parameter content type:",
+    "fetching resource":"fetching resource",
+    "fetching resource list":"fetching resource list",
+    "Explore":"Explore",
+    "Show Swagger Petstore Example Apis":"Show Swagger Petstore Example Apis",
+    "Can't read from server.  It may not have the appropriate access-control-origin settings.":"Can't read from server.  It may not have the appropriate access-control-origin settings.",
+    "Please specify the protocol for":"Please specify the protocol for",
+    "Can't read swagger JSON from":"Can't read swagger JSON from",
+    "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"
+});