dpn_swagger_engine 2.0.0.rc

data/app/assets/stylesheets/swagger_engine/style.css

@@ -0,0 +1,250 @@
+.swagger-section #header a#logo {
+  font-size: 1.5em;
+  font-weight: bold;
+  text-decoration: none;
+  background: transparent url(../images/logo.png) no-repeat left center;
+  padding: 20px 0 20px 40px;
+}
+#text-head {
+  font-size: 80px;
+  font-family: 'Roboto', sans-serif;
+  color: #ffffff;
+  float: right;
+  margin-right: 20%;
+}
+.navbar-fixed-top .navbar-nav {
+  height: auto;
+}
+.navbar-fixed-top .navbar-brand {
+  height: auto;
+}
+.navbar-header {
+  height: auto;
+}
+.navbar-inverse {
+  background-color: #000;
+  border-color: #000;
+}
+#navbar-brand {
+  margin-left: 20%;
+}
+.navtext {
+  font-size: 10px;
+}
+.h1,
+h1 {
+  font-size: 60px;
+}
+.navbar-default .navbar-header .navbar-brand {
+  color: #a2dfee;
+}
+/* tag titles */
+.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a {
+  color: #393939;
+  font-family: 'Arvo', serif;
+  font-size: 1.5em;
+}
+.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a:hover {
+  color: black;
+}
+.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 {
+  color: #525252;
+  padding-left: 0px;
+  display: block;
+  clear: none;
+  float: left;
+  font-family: 'Arvo', serif;
+  font-weight: bold;
+}
+.navbar-default .navbar-collapse,
+.navbar-default .navbar-form {
+  border-color: #0A0A0A;
+}
+.container1 {
+  width: 1500px;
+  margin: auto;
+  margin-top: 0;
+  background-image: url('../images/shield.png');
+  background-repeat: no-repeat;
+  background-position: -40px -20px;
+  margin-bottom: 210px;
+}
+.container-inner {
+  width: 1200px;
+  margin: auto;
+  background-color: rgba(223, 227, 228, 0.75);
+  padding-bottom: 40px;
+  padding-top: 40px;
+  border-radius: 15px;
+}
+.header-content {
+  padding: 0;
+  width: 1000px;
+}
+.title1 {
+  font-size: 80px;
+  font-family: 'Vollkorn', serif;
+  color: #404040;
+  text-align: center;
+  padding-top: 40px;
+  padding-bottom: 100px;
+}
+#icon {
+  margin-top: -18px;
+}
+.subtext {
+  font-size: 25px;
+  font-style: italic;
+  color: #08b;
+  text-align: right;
+  padding-right: 250px;
+}
+.bg-primary {
+  background-color: #00468b;
+}
+.navbar-default .nav > li > a,
+.navbar-default .nav > li > a:focus {
+  color: #08b;
+}
+.navbar-default .nav > li > a,
+.navbar-default .nav > li > a:hover {
+  color: #08b;
+}
+.navbar-default .nav > li > a,
+.navbar-default .nav > li > a:focus:hover {
+  color: #08b;
+}
+.text-faded {
+  font-size: 25px;
+  font-family: 'Vollkorn', serif;
+}
+.section-heading {
+  font-family: 'Vollkorn', serif;
+  font-size: 45px;
+  padding-bottom: 10px;
+}
+hr {
+  border-color: #00468b;
+  padding-bottom: 10px;
+}
+.description {
+  margin-top: 20px;
+  padding-bottom: 200px;
+}
+.description li {
+  font-family: 'Vollkorn', serif;
+  font-size: 25px;
+  color: #525252;
+  margin-left: 28%;
+  padding-top: 5px;
+}
+.gap {
+  margin-top: 200px;
+}
+.troubleshootingtext {
+  color: rgba(255, 255, 255, 0.7);
+  padding-left: 30%;
+}
+.troubleshootingtext li {
+  list-style-type: circle;
+  font-size: 25px;
+  padding-bottom: 5px;
+}
+.overlay {
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  z-index: 1000;
+}
+.block.response_body.json:hover {
+  cursor: pointer;
+}
+.backdrop {
+  color: blue;
+}
+#myModal {
+  height: 100%;
+}
+.modal-backdrop {
+  bottom: 0;
+  position: fixed;
+}
+.curl {
+  padding: 10px;
+  font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace;
+  font-size: 0.9em;
+  max-height: 400px;
+  margin-top: 5px;
+  overflow-y: auto;
+  background-color: #fcf6db;
+  border: 1px solid #e5e0c6;
+  border-radius: 4px;
+}
+.curl_title {
+  font-size: 1.1em;
+  margin: 0;
+  padding: 15px 0 5px;
+  font-family: 'Open Sans', 'Helvetica Neue', Arial, sans-serif;
+  font-weight: 500;
+  line-height: 1.1;
+}
+.footer {
+  display: none;
+}
+.swagger-section .swagger-ui-wrap h2 {
+  padding: 0;
+}
+h2 {
+  margin: 0;
+  margin-bottom: 5px;
+}
+.markdown p {
+  font-size: 15px;
+  font-family: 'Arvo', serif;
+}
+.swagger-section .swagger-ui-wrap .code {
+  font-size: 15px;
+  font-family: 'Arvo', serif;
+}
+.swagger-section .swagger-ui-wrap b {
+  font-family: 'Arvo', serif;
+}
+#signin:hover {
+  cursor: pointer;
+}
+.dropdown-menu {
+  padding: 15px;
+}
+.navbar-right .dropdown-menu {
+  left: 0;
+  right: auto;
+}
+#signinbutton {
+  width: 100%;
+  height: 32px;
+  font-size: 13px;
+  font-weight: bold;
+  color: #08b;
+}
+.navbar-default .nav > li .details {
+  color: #000000;
+  text-transform: none;
+  font-size: 15px;
+  font-weight: normal;
+  font-family: 'Open Sans', sans-serif;
+  font-style: italic;
+  line-height: 20px;
+  top: -2px;
+}
+.navbar-default .nav > li .details:hover {
+  color: black;
+}
+#signout {
+  width: 100%;
+  height: 32px;
+  font-size: 13px;
+  font-weight: bold;
+  color: #08b;
+}

data/app/assets/stylesheets/swagger_engine/typography.css

@@ -0,0 +1,14 @@
+/* Google Font's Droid Sans */
+@font-face {
+  font-family: 'Droid Sans';
+  font-style: normal;
+  font-weight: 400;
+  src: local('Droid Sans'), local('DroidSans'), url('../fonts/DroidSans.ttf'), format('truetype');
+}
+/* Google Font's Droid Sans Bold */
+@font-face {
+  font-family: 'Droid Sans';
+  font-style: normal;
+  font-weight: 700;
+  src: local('Droid Sans Bold'), local('DroidSans-Bold'), url('../fonts/DroidSans-Bold.ttf'), format('truetype');
+}

data/app/controllers/swagger_engine/application_controller.rb

@@ -0,0 +1,16 @@
+module SwaggerEngine
+  class ApplicationController < ActionController::Base
+
+    before_filter :authenticate
+
+    protected
+    def authenticate
+      if SwaggerEngine.configuration.admin_username
+        authenticate_or_request_with_http_basic do |username, password|
+          username == SwaggerEngine.configuration.admin_username && password == SwaggerEngine.configuration.admin_password
+        end
+      end
+    end
+
+  end
+end

data/app/controllers/swagger_engine/swaggers_controller.rb

@@ -0,0 +1,29 @@
+require_dependency "swagger_engine/application_controller"
+
+module SwaggerEngine
+  class SwaggersController < ApplicationController
+    layout false
+
+    before_filter :load_json_files
+
+    def index
+      redirect_to swagger_path(@json_files.first[0]) if ( @json_files.size == 1 )
+    end
+
+    def show
+      respond_to do |format|
+        format.html { 
+          @swagger_json_url = swagger_path(params[:id], format: :json)
+        }
+        format.json { 
+          send_file @json_files[params[:id].to_sym], type: 'application/json', disposition: 'inline'
+        }
+      end
+    end
+
+    private
+    def load_json_files
+      @json_files ||= SwaggerEngine.configuration.json_files || { default: "#{Rails.root}/lib/swagger_engine/swagger.json" }
+    end
+  end
+end

data/app/helpers/swagger_engine/application_helper.rb

@@ -0,0 +1,4 @@
+module SwaggerEngine
+  module ApplicationHelper
+  end
+end

data/app/helpers/swagger_engine/swagger_helper.rb

@@ -0,0 +1,4 @@
+module SwaggerEngine
+  module SwaggerHelper
+  end
+end

data/app/views/layouts/swagger_engine/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SwaggerEngine</title>
+  <%= stylesheet_link_tag    "swagger_engine/application", media: "all" %>
+  <%= javascript_include_tag "swagger_engine/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/swagger_engine/swaggers/index.html.erb

@@ -0,0 +1,7 @@
+<ul>
+  <% @json_files.each_key do |k| %>
+    <li>
+      <%= link_to k, swagger_path(k) %>
+    </li>
+  <% end %>
+</ul>

data/app/views/swagger_engine/swaggers/o2c.html

@@ -0,0 +1,20 @@
+<script>
+var qp = null;
+if(window.location.hash) {
+  qp = location.hash.substring(1);
+}
+else {
+  qp = location.search.substring(1);
+}
+qp = qp ? JSON.parse('{"' + qp.replace(/&/g, '","').replace(/=/g,'":"') + '"}',
+  function(key, value) {
+    return key===""?value:decodeURIComponent(value) }
+  ):{}
+
+if (window.opener.swaggerUi.tokenUrl)
+    window.opener.processOAuthCode(qp);
+else
+    window.opener.onOAuthComplete(qp);
+
+window.close();
+</script>

data/app/views/swagger_engine/swaggers/show.html.erb

@@ -0,0 +1,121 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+
+  <!-- Content in this file is derived from swagger-ui:dist/index.html -->
+
+  <%#= favicon_link_tag 'favicon-32x32.png', rel: 'icon', type: 'image/png', sizes: '32x32' %>
+  <%#= favicon_link_tag 'favicon-16x16.png', rel: 'icon', type: 'image/png', sizes: '16x16' %>
+
+  <%= stylesheet_link_tag "swagger_engine/application" %>
+  <%= stylesheet_link_tag "swagger_engine/reset", media: "print" %>
+  <%= stylesheet_link_tag "swagger_engine/print", media: "print" %>
+
+  <%= javascript_include_tag "swagger_engine/application" %>
+
+  <%= 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 = '<%= @swagger_json_url %>';
+      }
+
+      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();
+          }
+
+          headerTokenAuthorization();
+        },
+        onFailure: function(data) {
+          log("Unable to Load SwaggerUI");
+        },
+        docExpansion: "none",
+        jsonEditor: true,
+        // apisSorter: "alpha",
+        defaultModelRendering: 'schema',
+        showRequestHeaders: false
+      });
+
+      // Custom code for DPN authorization token
+      function headerTokenAuthorization(){
+        var token = encodeURIComponent($('#input_apiKey')[0].value);
+        if(token && token.trim() != "") {
+            var tokenAuth = new SwaggerClient.ApiKeyAuthorization("Authorization", "Token token=" + token, "header"));
+            window.swaggerUi.api.clientAuthorizations.add("api_key", tokenAuth);
+            // var tokenAuth = new ApiKeyAuthorization("Authorization", "Token token=" + token, "header"));
+            // window.authorizations.add("api_key", tokenAuth);
+            log("added token " + token);
+        }
+      }
+
+      $('#input_apiKey').change(headerTokenAuthorization);
+
+      // A DPN authorization token that should work in development
+      var dpnToken = "hathi_token";
+      $('#input_apiKey').val(dpnToken);
+
+      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">
+      <img class="logo__img" alt="swagger" height="30" width="30" src="images/logo_small.png" />
+      <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 placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
+        <div class='input'><a id="explore" href="#" data-sw-translate>Explore</a></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/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/swagger_engine/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --binstubs .binstubs --path .gems
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+SwaggerEngine::Engine.routes.draw do
+  resources :swaggers, only: [:index, :show]
+  root to: 'swaggers#index'
+end

data/dpn_swagger_engine.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Maintain your gem's version:
+require 'swagger_engine/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = 'dpn_swagger_engine'
+  spec.version     = SwaggerEngine::VERSION
+  spec.authors     = ['batdevis', 'Darren Weber']
+  spec.email       = ['batdevis@gmail.com', 'dweber.consulting@gmail.com']
+  spec.homepage    = 'https://github.com/dpn-admin/dpn_swagger_engine'
+  spec.summary     = 'Mount swagger-ui as rails engine.'
+  spec.description = 'API docs for dpn-server.'
+  spec.license     = 'MIT'
+
+  # spec.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+  # spec.test_files = Dir["test/**/*"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'yard'
+end

data/lib/swagger_engine/engine.rb

@@ -0,0 +1,37 @@
+module SwaggerEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace SwaggerEngine
+
+    #https://gist.github.com/parndt/11381872
+=begin
+    initializer "swagger_engine.assets.precompile", group: :all do |app|
+      app.config.assets.precompile += ['swagger_engine/print.css', 'swagger_engine/reset.css']
+    end
+=end
+    config.to_prepare do
+      Rails.application.config.assets.precompile += ['swagger_engine/print.css', 'swagger_engine/reset.css']
+    end
+
+  end
+
+  class Configuration
+    #[{ default: "swagger.json" }]
+    attr_accessor :json_files
+    attr_accessor :admin_username
+    attr_accessor :admin_password
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  module_function
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield(configuration)
+  end
+end

data/lib/swagger_engine/version.rb

@@ -0,0 +1,4 @@
+module SwaggerEngine
+  # Major version number matches DPN REST API version
+  VERSION = '2.0.0.rc'.freeze
+end

data/lib/swagger_engine.rb

@@ -0,0 +1,7 @@
+require 'swagger_engine/engine'
+require 'swagger_engine/version'
+
+# Mount swagger-ui as a rails engine to document and explore the
+# DPN REST API within the dpn-server project.
+module SwaggerEngine
+end

data/lib/tasks/swagger_engine_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :swagger_engine do
+#   # Task goes here
+# end