nedforce-grape-swagger-ui 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b19d502ccef2c5deda67804f2e6db8fed86c354e
+  data.tar.gz: 3fe45a64973900ad23d4e696fd76c34c9aee69c8
+SHA512:
+  metadata.gz: 0e74d2d35a746e15cb0d938dd72b52af49d56e85a399dbc9a77c30acadfae3ea28ff37c0d938f8bda5452df46d7549a9e4701a4ba29662ad80c2a3a96a6a6ff3
+  data.tar.gz: 81fb3aefd1645be214f4cffbb954c302f5818450685f986fcdecbbf47c831b7f62ddd2339c750e00a9cc61c5138a95929d4ed913966be72bf298d6d27454aba2

data/.gitignore

@@ -0,0 +1,22 @@
+.project
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-swagger-ui.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Klaas Endrikat
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+Grape::Swagger::Ui
+===============
+
+[![Code Climate](https://codeclimate.com/github/kendrikat/grape-swagger-ui.png)](https://codeclimate.com/github/kendrikat/grape-swagger-ui)
+
+TODO/WIP: Write a gem description
+
+Integrates [swagger-ui] with your "grapified" Rails application.
+
+## Dependencies
+
+* [grape-swagger]
+> Add swagger compliant documentation to your grape API
+
+* [grape]
+> An opinionated micro-framework for creating REST-like APIs in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape-swagger-ui'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-swagger-ui
+
+## Usage example:
+
+    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
+
+    http://host:port/api/swagger
+
+else
+
+*Generate the main layout for customizations*
+
+	rails generate swagger:layout
+
+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 += %w(swagger_ui.js swagger_ui.css swagger_ui_print.css swagger_ui_screen.css)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+MIT License, full text of license see [here][License]
+
+*Free Software, Fuck Yeah!*
+
+[License]: https://github.com/kendrikat/grape-swagger-ui/blob/master/LICENSE.txt "LICENSE"
+[grape-swagger]: https://github.com/tim-vandecasteele/grape-swagger
+[grape]: https://github.com/intridea/grape
+[swagger-ui]: https://github.com/wordnik/swagger-ui/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/swagger_controller.rb

@@ -0,0 +1,8 @@
+class SwaggerController < ApplicationController
+
+  layout "swagger"
+
+  def index
+  end
+  
+end

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

@@ -0,0 +1,96 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="<%= I18n.locale.to_s %>" xml:lang="<%= I18n.locale.to_s %>" xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <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_screen, :media => :screen %>
+    <%= stylesheet_link_tag :swagger_ui_print, :media => :print %>
+    <%= csrf_meta_tags %>
+
+    <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";
+        }
+
+        hljs.configure({
+          highlightSizeThreshold: 5000
+        });
+
+        // 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: {}
+              });
+            }
+
+            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 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 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/grape-swagger-ui.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape-swagger-ui/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "nedforce-grape-swagger-ui"
+  gem.version       = Grape::Swagger::Ui::VERSION
+  gem.authors       = ["Klaas Endrikat"]
+  gem.email         = ["klaas.endrikat@googlemail.com"]
+  gem.description   = %q{swagger ui js integration for grape and grape-swagger}
+  gem.summary       = %q{swagger ui js integration for grape and grape-swagger}
+  gem.license       = 'MIT'
+  gem.homepage      = "https://github.com/nedforce/grape-swagger-ui"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "railties", ">= 3.1"
+end

data/lib/generators/swagger/layout/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a dedicated layout for the swagger-ui
+
+Example:
+    rails generate swagger:layout
+
+    This will create:
+        app/views/layouts/swagger.html.haml

data/lib/generators/swagger/layout/layout_generator.rb

@@ -0,0 +1,15 @@
+module Swagger
+  module Generators
+    class LayoutGenerator < ::Rails::Generators::Base
+      desc 'Setup a dedicated layout for the swagger-ui'
+
+      def self.source_root
+        File.expand_path('../templates', __FILE__)
+      end
+
+      def create_swagger_layout        
+        template 'swagger.html.haml', File.join('app', 'views', 'layouts', 'swagger.html.haml')
+      end        
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+!!!
+%html{ :xmlns => "http://www.w3.org/1999/xhtml", :lang => I18n.locale.to_s, "xml:lang" => I18n.locale.to_s }
+  %head
+    %title Swagger UI
+
+    = javascript_include_tag :swagger_ui
+    = stylesheet_link_tag :swagger_ui_screen, :media => :screen
+    = stylesheet_link_tag :swagger_ui_print, :media => :print
+    = csrf_meta_tags
+
+    :css
+      .swagger-ui-wrap {
+        max-width: 80%;
+        min-width: 960px;
+        margin-left: auto;
+        margin-right: auto;
+      }
+
+    :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({
+          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.swagger-section
+    #header
+      .swagger-ui-wrap
+        %a#logo{:href => "http://swagger.io"}
+          %span.logo__title swagger
+        %form#api_selector
+          .input
+            %input#input_baseUrl{:name => "baseUrl", :placeholder => "http://example.com/api", :type => "text"}/
+          .input
+            %input#input_apiKey{:name => "apiKey", :placeholder => "api_key", :type => "text"}
+          #auth_container
+          .input
+            %a#explore.header__btn{"data-sw-translate" => "", :href => "#"} Explore
+    #message-bar.swagger-ui-wrap{"data-sw-translate" => ""}  
+    #swagger-ui-container.swagger-ui-wrap
+

data/lib/grape-swagger-ui.rb

@@ -0,0 +1,19 @@
+require "grape-swagger-ui/version"
+require "grape-swagger-ui/routes"
+
+module Grape
+  module Swagger
+    module Ui
+      class Engine < ::Rails::Engine
+        config.draw_swagger_routes = true
+
+        initializer 'grape-swagger-ui.draw_routes' do |app|
+          if config.draw_swagger_routes && (!$rails_rake_task || (ARGV[0] =~ /routes\Z/))
+            app.routes.append{ Grape::Swagger::Ui::Routes.draw(self) }
+          end
+        end
+
+      end
+    end
+  end
+end