swagger_ui_generator 0.0.1

data/lib/swagger_ui_generator.rb

@@ -0,0 +1,5 @@
+require "swagger_ui_generator/version"
+
+module SwaggerUiGenerator
+  # Your code goes here...
+end

data/lib/swagger_ui_generator/importer.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+require 'nokogiri'
+
+module SwaggerUiGenerator
+  class Importer
+    def import
+      cleanup
+      ensure_directory_structure
+      copy_dependencies
+      generate_template
+    end
+
+    def cleanup
+      FileUtils.rm_rf Dir[destination_path("**/*")]
+    end
+
+    def ensure_directory_structure
+      FileUtils.mkdir_p destination_path("public/swagger")
+    end
+
+    def copy_dependencies
+      generate_script_with_custom_throbber_path
+
+      %w( lib css ).each do |dir|
+        src = source_path("#{ dir }/*")
+        dst = destination_path("public/swagger/#{ dir }")
+
+        FileUtils.mkdir_p dst
+        FileUtils.cp_r Dir[src], dst
+      end
+
+      FileUtils.cp source_path("images/throbber.gif"), destination_path("public/swagger")
+    end
+
+    def generate_script_with_custom_throbber_path
+      script = IO.read(source_path('swagger-ui.js')).gsub(%r{'images/throbber.gif'}, "'/swagger/throbber.gif'")
+      File.open(destination_path("public/swagger/swagger-ui.js"), 'w') do |js|
+        js.write script
+      end
+    end
+
+    def generate_template
+      ui_doc.at('title').content = "__@title__"
+
+      script_el = ui_doc.at('script:not([src])')
+      script = script_el.content.split(/\n/).map do |line|
+        if line =~ /url:\s*"http/
+          '      url: window.location.protocol + "//" + window.location.host + "__@api_spec_path__",'
+        else
+          line
+        end
+      end
+      script_el.native_content = script.join("\n")
+
+      (ui_doc / 'script[src]').each do |el|
+        el['src'] = "/swagger/#{ el['src'] }"
+      end
+
+      (ui_doc / 'link[rel="stylesheet"]').each do |el|
+        el['href'] = "/swagger/#{ el['href'] }" if el['href'].start_with? 'css'
+      end
+
+      ui_doc.at('a#logo').remove
+      (ui_doc / 'form#api_selector .icon-btn').each { |el| el.remove }
+
+      File.open(destination_path("public/api-docs.html.erb"), 'w') do |out|
+        out.write ui_doc.to_xhtml(indent:2, indent_text:" ").gsub(/__(.*)__/, '<%= \1 %>')
+      end
+    end
+
+    def source_path(path)
+      source_base.join(path)
+    end
+
+    def destination_path(path)
+      destination_base.join(path)
+    end
+
+    private
+
+    def ui_doc
+      @ui_doc ||= Nokogiri::HTML(IO.read(source_path("index.html")).gsub("\r\n", "\n"))
+    end
+
+    def source_base
+      @src ||= relative_path("../../../vendor/swagger-ui/dist")
+    end
+
+    def destination_base
+      @dst ||= relative_path("../../generators/swagger_ui_generator/install/templates")
+    end
+
+    def relative_path(path)
+      Pathname.new(File.expand_path(path, __FILE__))
+    end
+  end
+end

data/lib/swagger_ui_generator/version.rb

@@ -0,0 +1,3 @@
+module SwaggerUiGenerator
+  VERSION = "0.0.1"
+end

data/swagger_ui_generator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger_ui_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger_ui_generator"
+  spec.version       = SwaggerUiGenerator::VERSION
+  spec.authors       = ["Solomon White"]
+  spec.email         = ["rubysolo@gmail.com"]
+  spec.summary       = %q{Swagger UI Generator}
+  spec.description   = %q{Rails generator to build Swagger UI API doc viewer}
+  spec.homepage      = "http://github.com/rubysolo/swagger_ui_generator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", ">= 3.1"
+
+  spec.add_runtime_dependency "railties", ">= 3.1"
+  spec.add_runtime_dependency "nokogiri"
+end

data/test/lib/generators/swagger_ui_generator/install_generator_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+require 'generators/swagger_ui_generator/install/install_generator'
+require 'nokogiri'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests SwaggerUiGenerator::Generators::InstallGenerator
+  destination Rails.root
+
+  setup :prepare_destination
+
+  test "generates swagger ui app" do
+    run_generator
+
+    assert_file "public/swagger/swagger-ui.js"
+    assert_file "public/api-docs.html", %r{/swagger/swagger-ui.js}
+
+    css_files = %w(
+      highlight.default.css
+      screen.css
+    )
+
+    css_files.each do |css|
+      assert_file "public/swagger/css/#{ css }"
+      assert_file "public/api-docs.html", %r{/swagger/css/#{ css }}
+    end
+
+    js_files = %w(
+      shred.bundle.js
+      jquery-1.8.0.min.js
+      jquery.slideto.min.js
+      jquery.wiggle.min.js
+      jquery.ba-bbq.min.js
+      handlebars-1.0.0.js
+      underscore-min.js
+      backbone-min.js
+      swagger.js
+      highlight.7.3.pack.js
+    )
+
+    js_files.each do |js|
+      assert_file "public/swagger/lib/#{ js }"
+      assert_file "public/api-docs.html", %r{/swagger/lib/#{ js }}
+    end
+  end
+
+  test "uses default location for @api_spec_path" do
+    run_generator
+    assert_file "public/api-docs.html", %r{window\.location\.host \+ "/swagger/api-docs.json"}
+  end
+
+  test "uses custom location for @api_spec_path" do
+    run_generator %w(--api-spec-path /api/v2/docs.json)
+    assert_file "public/api-docs.html", %r{window\.location\.host \+ "/api/v2/docs.json"}
+  end
+
+  test "does not modify font stylesheet" do
+    run_generator
+    assert_file "public/api-docs.html" do |html|
+      doc = Nokogiri::HTML(html)
+      css_hrefs = (doc / 'link[rel="stylesheet"]').map { |el| el['href'] }
+      font_href = css_hrefs.reject { |href| href.start_with? '/swagger' }.first
+
+      assert font_href
+      assert_equal 'https://fonts.googleapis.com/css?family=Droid+Sans:400,700', font_href
+    end
+  end
+
+  test 'imports the throbber gif and modifies the path appropriately' do
+    run_generator
+    assert_file "public/swagger/throbber.gif"
+    assert_file "public/swagger/swagger-ui.js", %r{'/swagger/throbber.gif'}
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler.require
+
+require 'test/unit'
+require 'rails/all'
+require 'rails/generators'
+require 'rails/generators/test_case'
+
+class TestApp < Rails::Application
+  config.root = File.dirname(__FILE__)
+end
+Rails.application = TestApp
+
+module Rails
+  def self.root
+    @root ||= File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'rails'))
+  end
+end
+Rails.application.config.root = Rails.root

data/vendor/swagger-ui/.gitignore

@@ -0,0 +1,22 @@
+wordnik*.zip
+.DS_STORE
+*.ipr
+*.iml
+*.iws
+lib/*.jar
+META-INF/
+web/
+index
+lib/*.zip
+dk/
+index_dict
+logs
+src/main/java/com/wordnik/env/Version.scala
+lib/*.pom
+version.properties
+reports/*
+.sass-cache
+swagger-ui.sublime-workspace
+.idea
+.project
+node_modules/*

data/vendor/swagger-ui/.npmignore

@@ -0,0 +1,7 @@
+*.sublime-*
+example.html
+*.tgz
+.classpath
+.project
+.npmignore
+node_modules

data/vendor/swagger-ui/Cakefile

@@ -0,0 +1,132 @@
+fs          = require 'fs'
+path        = require 'path'
+{exec}      = require 'child_process'
+less        = require 'less'
+
+sourceFiles  = [
+  'SwaggerUi'
+  'view/HeaderView'
+  'view/MainView'
+  'view/ResourceView'
+  'view/OperationView'
+  'view/StatusCodeView'
+  'view/ParameterView'
+  'view/SignatureView'
+  'view/ContentTypeView'
+  'view/ResponseContentTypeView'
+  'view/ParameterContentTypeView'
+]
+
+
+task 'clean', 'Removes distribution', ->
+  console.log 'Clearing dist...'
+  exec 'rm -rf dist'
+
+task 'dist', 'Build a distribution', ->
+  console.log "Build distribution in ./dist"
+  fs.mkdirSync('dist') if not path.existsSync('dist')
+  fs.mkdirSync('dist/lib') if not path.existsSync('dist/lib')
+
+  appContents = new Array remaining = sourceFiles.length
+  for file, index in sourceFiles then do (file, index) ->
+    console.log "   : Reading src/main/coffeescript/#{file}.coffee"
+    fs.readFile "src/main/coffeescript/#{file}.coffee", 'utf8', (err, fileContents) ->
+      throw err if err
+      appContents[index] = fileContents
+      precompileTemplates() if --remaining is 0
+
+  precompileTemplates= ->
+    console.log '   : Precompiling templates...'
+    templateFiles  = fs.readdirSync('src/main/template')
+    templateContents = new Array remaining = templateFiles.length
+    for file, index in templateFiles then do (file, index) ->
+      console.log "   : Compiling src/main/template/#{file}"
+      exec "handlebars src/main/template/#{file} -f dist/_#{file}.js", (err, stdout, stderr) ->
+        throw err if err
+        fs.readFile 'dist/_' + file + '.js', 'utf8', (err, fileContents) ->
+          throw err if err
+          templateContents[index] = fileContents
+          fs.unlink 'dist/_' + file + '.js'
+          if --remaining is 0
+            templateContents.push '\n\n'
+            fs.writeFile 'dist/_swagger-ui-templates.js', templateContents.join('\n\n'), 'utf8', (err) ->
+              throw err if err
+              build()
+
+
+  build = ->
+    console.log '   : Collecting Coffeescript source...'
+
+    appContents.push '\n\n'
+    fs.writeFile 'dist/_swagger-ui.coffee', appContents.join('\n\n'), 'utf8', (err) ->
+      throw err if err
+      console.log '   : Compiling...'
+      exec 'coffee --compile dist/_swagger-ui.coffee', (err, stdout, stderr) ->
+        throw err if err
+        fs.unlink 'dist/_swagger-ui.coffee'
+        console.log '   : Combining with javascript...'
+        exec 'cat src/main/javascript/doc.js dist/_swagger-ui-templates.js dist/_swagger-ui.js > dist/swagger-ui.js', (err, stdout, stderr) ->
+          throw err if err
+          fs.unlink 'dist/_swagger-ui.js'
+          fs.unlink 'dist/_swagger-ui-templates.js'
+          console.log '   : Minifying all...'
+          exec 'java -jar "./bin/yuicompressor-2.4.7.jar" --type js -o ' + 'dist/swagger-ui.min.js ' + 'dist/swagger-ui.js', (err, stdout, stderr) ->
+            throw err if err
+            lessc()
+
+  lessc = ->
+    # Someone who knows CoffeeScript should make this more Coffee-licious
+    console.log '   : Compiling LESS...'
+
+    less.render fs.readFileSync("src/main/less/screen.less", 'utf8'), (err, css) ->
+      console.log err
+      fs.writeFileSync("src/main/html/css/screen.css", css)
+    pack()
+
+  pack = ->
+    console.log '   : Packaging...'
+    exec 'cp -r lib dist'
+    console.log '   : Copied swagger-ui libs'
+    exec 'cp -r node_modules/swagger-client/lib/swagger.js dist/lib'
+    console.log '   : Copied swagger dependencies'
+    exec 'cp -r src/main/html/* dist'
+    console.log '   : Copied html dependencies'
+    console.log '   !'
+
+task 'spec', "Run the test suite", ->
+  exec "open spec.html", (err, stdout, stderr) ->
+    throw err if err
+
+task 'watch', 'Watch source files for changes and autocompile', ->
+  # Function which watches all files in the passed directory
+  watchFiles = (dir) ->
+    files = fs.readdirSync(dir)
+    for file, index in files then do (file, index) ->
+      console.log "   : " + dir + "/#{file}"
+      fs.watchFile dir + "/#{file}", (curr, prev) ->
+        if +curr.mtime isnt +prev.mtime
+          invoke 'dist'
+
+  notify "Watching source files for changes..."
+
+  # Watch specific source files
+  for file, index in sourceFiles then do (file, index) ->
+    console.log "   : " + "src/main/coffeescript/#{file}.coffee"
+    fs.watchFile "src/main/coffeescript/#{file}.coffee", (curr, prev) ->
+      if +curr.mtime isnt +prev.mtime
+        invoke 'dist'
+
+  # watch all files in these folders
+  watchFiles("src/main/template")
+  watchFiles("src/main/javascript")
+  watchFiles("src/main/html")
+  watchFiles("src/main/less")
+  watchFiles("src/test")
+
+notify = (message) ->
+  return unless message?
+  console.log message
+#  options =
+#    title: 'CoffeeScript'
+#    image: 'bin/CoffeeScript.png'
+#  try require('growl') message, options

data/vendor/swagger-ui/README.md

@@ -0,0 +1,110 @@
+Swagger UI
+==========
+
+Swagger UI is part of [Swagger](http://swagger.wordnik.com/) project.  The Swagger project allows you to produce, visualize and consume your OWN RESTful services.  No proxy or 3rd party services required.  Do it your own way.
+
+Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically
+generate beautiful documentation and sandbox from a [Swagger-compliant](https://github.com/wordnik/swagger-core/wiki) API. Because Swagger UI has no dependencies, you can host it in any server environment, or on your local machine.
+
+How to Use It
+-------------
+
+### Download
+You can use the swagger-ui code AS-IS!  No need to build or recompile--just clone this repo and use the pre-built files in the `dist` folder.  If you like swagger-ui as-is, stop here.
+
+### Build
+You can rebuild swagger-ui on your own to tweak it or just so you can say you did.  To do so, follow these steps:
+
+1. install [handlebars](http://handlebarsjs.com/)
+2. install java
+3. npm install
+4. npm run-script build
+5. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser
+
+### Use
+Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.wordnik.com/api/api-docs) service and show its APIs.  You can enter your own server url and click explore to view the API.
+
+### Customize
+You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories:
+
+-    dist: Contains a distribution which you can deploy on a server or load from your local machine.
+-    bin: Contains files used by swagger-ui for its build/test. These are not required by the distribution.
+-    lib: Contains javascript dependencies which swagger-ui depends on
+-    node_modules: Contains node modules which swagger-ui uses for its development.
+-    src
+    -    src/main/coffeescript: main code in CoffeeScript
+    -    src/main/templates: [handlebars](http://handlebarsjs.com/) templates used to render swagger-ui
+    -    src/main/html: the html files, some images and css
+    -    src/main/javascript: some legacy javascript referenced by CoffeeScript code
+
+### SwaggerUi
+To use swagger-ui you should take a look at the [source of swagger-ui html page](https://github.com/wordnik/swagger-ui/tree/master/src/main/html) and customize it. This basically requires you to instantiate a SwaggerUi object and call load() on it as below:
+
+```javascript
+    window.swaggerUi = new SwaggerUi({
+        url:"http://petstore.swagger.wordnik.com/api/api-docs",
+        dom_id:"swagger-ui-container"
+    });
+
+    window.swaggerUi.load();
+```
+* *url* parameter should point to a resource listing url as per [Swagger Spec](https://github.com/wordnik/swagger-core/wiki)
+* *dom_id parameter* is the the id of a dom element inside which SwaggerUi will put the user interface for swagger
+* *booleanValues* SwaggerUI renders boolean data types as a dropdown. By default it provides a 'true' and 'false' string as the possible choices. You can use this parameter to change the values in dropdown to be something else, for example 0 and 1 by setting booleanValues to new Array(0, 1)
+* *docExpansion* controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details)
+* *onComplete* is a callback function parameter which can be passed to be notified of when SwaggerUI has completed rendering successfully.
+* *onFailure* is a callback function parameter which can be passed to be notified of when SwaggerUI encountered a failure was unable to render.
+* All other parameters are explained in greater detail below
+
+
+### HTTP Methods and API Invocation
+swagger-ui supports invocation of all HTTP methods APIs including GET, PUT, POST, DELETE, PATCH, OPTIONS.  These are handled in the [swagger-js](https://github.com/wordnik/swagger-js) project, please see there for specifics on their usage.
+
+
+### Header Parameters
+Header params are supported through a pluggable mechanism in [swagger-js](https://github.com/wordnik/swagger-js).  You can see the [index.html](https://github.com/wordnik/swagger-ui/blob/master/dist/index.html) for a sample of how to dynamically set headers:
+
+```js
+// add a new ApiKeyAuthorization when the api-key changes in the ui.
+$('#input_apiKey').change(function() {
+  var key = $('#input_apiKey')[0].value;
+  if(key && key.trim() != "") {
+    window.authorizations.add("key", new ApiKeyAuthorization("api_key", key, "header"));
+  }
+})
+```
+
+This will add header `api_key` with value `key` on every call to the server.  You can substitute `query` to send the values as a query param.
+
+### Custom Header Parameters - (For Basic auth etc)
+If you have some header parameters which you need to send with every request, use the headers as below:
+
+```js
+window.authorizations.add("key", new ApiKeyAuthorization("Authorization", "XXXX", "header"));
+```
+
+Note!  You can pass multiple header params on a single request, just use unique names for them (`key` is used in the above example).
+
+How to Improve It
+-----------------
+
+Create your own fork of [wordnik/swagger-ui](https://github.com/wordnik/swagger-ui)
+
+To share your changes, [submit a pull request](https://github.com/wordnik/swagger-ui/pull/new/master).
+
+Since the javascript files are compiled from coffeescript, please submit changes in the *.coffee files!  We have to reject changes only in the .js files as they will be lost on each build of the ui.
+
+License
+-------
+
+Copyright 2011-2013 Wordnik, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.