ddy_swagger_docs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d8b03caa1ac5c2e318cb3f61ffee4cd51ff8f3
+  data.tar.gz: 52adf92b2d46187e054fc721e4d4858fd5f23015
+SHA512:
+  metadata.gz: 0584f7d0ab2cb934d912d7cf736240c968e069c4e436edb4b7a14e7f49fafc5cb9587e1e5e614a862c6b2176612b2107df69868ffc417f9b2ced7f9709b1c66c
+  data.tar.gz: c9fea2b243ce052b45bd38b09d1179069cbc34d34386bf5da8e37b3cce4171aa8563990d2e35c73c72439a4ab156a3abe3cd4e8f5757561e06c905c4a17b2664

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log
+spec/dummy/tmp
+spec/dummy/log
+spec/dummy/vendor

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+swagger_docs

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jan van der Pas
+
+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,195 @@
+# Swagger Docs
+
+Swagger Docs, is a gem which includes the [Swagger::Docs](https://github.com/richhollis/swagger-docs) gem and the assets for the SwaggerUI.
+
+## Goal of Swagger Docs
+
+To easily setup API documentation with Swagger and the SwaggerUI.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Use this to fetch the gem from Gitlab
+gem 'swagger_docs', git: 'git@lab.digidentity.eu:jvanderpas/swagger_docs.git'
+
+# Use this to fetch the gem from RubyGems.org
+gem 'ddy_swagger_docs', require: 'swagger_docs'
+```
+
+## Configuration
+
+1. Add the stylesheet and javascript manifests to your assets:
+
+    ```
+    # app/assets/javascripts/application.js
+    //= require swagger_docs
+    ```
+
+    ```
+    # app/assets/stylesheets/application.css
+    *= require swagger_docs
+    ```
+
+2. Add the `Swagger::Docs` configuration to your initializers:
+
+    ```ruby
+    # config/initializers/swagger_docs.rb
+    class Swagger::Docs::Config
+      def self.transform_path(path, api_version)
+        # Make a distinction between the APIs and API documentation paths.
+        "api/#{path}"
+      end
+    end
+    
+    Swagger::Docs::Config.register_apis(
+        {
+            '1.0' => {
+                api_extension_type: :json,
+                controller_base_path: '',
+                api_file_path: 'public/api',
+                base_path: 'http://localhost:3000',
+                clean_directory: true,
+                camelize_model_properties: false,
+                attributes: {
+                    info: {
+                        title: 'Dummy API',
+                        description: 'JSON-based API accessible only for authorized users. Resource objects can be retrieved and written via this API. Keep in mind that any tries you do via this API will be done via the currently logged in profile.'
+                    }
+                }
+            }
+        }
+    )
+    ```
+
+3. Create a page in which you want to display the SwaggerUI, and add:
+
+    ```html
+    <div class="swagger-section">
+        <div class="swagger-ui-wrap" id="message-bar"></div>
+        <div class="swagger-ui-wrap" id="swagger-ui-container"></div>
+    </div>
+    ```
+
+4. Visit the page and verify that the SwaggerUI is displayed.
+
+
+
+## Usage
+
+Write the API documentation with the `Swagger::Docs` DSL in your controllers:
+
+```ruby
+module Api
+  class PostsController < BaseController
+
+    swagger_controller :users, 'Posts'
+
+    swagger_model :Post do
+      description 'Post'
+      property :id, :string, :required, '#id', example: '1430311887'
+      property :title, :string, :required, '#title', example: 'My morning breakfast'
+      property :body, :text, :optional, '#body', example: 'Every morning I make myself a cup of coffee, some orange juice and a bowl of muesli.'
+    end
+
+    swagger_api :index do
+      summary 'Lists Posts'
+      response :ok, nil
+    end
+
+    def index
+      @posts = Post.all
+
+      render json: @posts
+    end
+
+    swagger_api :show do
+      summary 'Find a Post'
+      param :path, :id, :string, :required, 'Post#id'
+      response :ok, nil, :Post
+      response :not_found
+    end
+
+    def show
+      @post = Post.find(params[:id])
+
+      render json: @post
+    end
+
+    swagger_api :create do
+      summary 'Create a Post'
+      param :body, :post, :post_params, :required
+      response :created, nil, :Post
+      response :unprocessable_entity, 'Unprocessable entity. Contains a JSON array of error messages.'
+    end
+
+    def create
+      @post = Post.create(post_params)
+
+      if @post.persisted?
+        render json: @post, status: :created
+      else
+        render json: { errors: @post.errors.messages }, status: :unprocessable_entity
+      end
+    end
+
+    swagger_api :update do
+      summary 'Update a Post'
+      param :path, :id, :string, :required, 'Post#id'
+      param :body, :post, :post_params, :required
+      response :accepted, nil, :Post
+      response :unprocessable_entity, 'Unprocessable entity. Contains a JSON array of error messages.'
+      response :not_found
+    end
+
+    def update
+      @post = Post.find(params[:id])
+
+      if @post.update_attributes(post_params)
+        render json: @post, status: :accepted
+      else
+        render json: { errors: @post.errors.messages }, status: :unprocessable_entity
+      end
+    end
+
+    swagger_api :destroy do
+      summary 'Delete a Post'
+      param :path, :id, :string, :required, 'Post#id'
+      response :no_content, 'No content. Successful deleted the resource.'
+      response :unprocessable_entity, 'Unprocessable entity. Contains a JSON array of error messages.'
+      response :not_found
+    end
+
+    def destroy
+      @post = Post.find(params[:id])
+
+      if @post.destroy
+        head :no_content
+      else
+        render json: { errors: @post.errors.messages }, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    swagger_model :post_params do
+      description 'Post params'
+      property :title, :string, :required, '#title', example: 'My lunch'
+      property :body, :string, :optional, '#body', example: 'During the lunch I make myself two sandwiches with peanut butter and jam.'
+    end
+
+    def post_params
+      params.require(:post).permit(:title, :body)
+    end
+
+  end
+end
+```
+
+Generate the Swagger API documentation using a `Rake` task:
+
+`$ rake swagger:docs`
+
+
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger_docs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/swagger_docs.rb

@@ -0,0 +1,10 @@
+require 'swagger/docs'
+
+require 'swagger_docs/version'
+
+module SwaggerDocs
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/swagger_docs/version.rb

@@ -0,0 +1,3 @@
+module SwaggerDocs
+  VERSION = '0.0.1'
+end

data/swagger_docs.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger_docs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ddy_swagger_docs'
+  spec.version       = SwaggerDocs::VERSION
+  spec.authors       = ['Jan van der Pas']
+  spec.email         = ['jvanderpas@digidentity.eu']
+
+  spec.summary       = %q{Swagger Docs, a gem which contains the SwaggerUI assets}
+  spec.description   = %q{Swagger Docs, a gem which contains the SwaggerUI assets}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  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.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rails'
+
+  spec.add_runtime_dependency 'railties'
+  spec.add_runtime_dependency 'swagger-docs'
+end

data/vendor/assets/index.html

@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Swagger UI</title>
+  <link href='stylesheets/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='stylesheets/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='stylesheets/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='stylesheets/reset.css' media='print' rel='stylesheet' type='text/css'/>
+  <link href='stylesheets/screen.css' media='print' rel='stylesheet' type='text/css'/>
+  <script type="text/javascript" src="javascripts/lib/shred.bundle.js"></script>
+  <script src='javascripts/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+  <script src='javascripts/lib/jquery.slideto.min.js' type='text/javascript'></script>
+  <script src='javascripts/lib/jquery.wiggle.min.js' type='text/javascript'></script>
+  <script src='javascripts/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+  <script src='javascripts/lib/handlebars-2.0.0.js' type='text/javascript'></script>
+  <script src='javascripts/lib/underscore-min.js' type='text/javascript'></script>
+  <script src='javascripts/lib/backbone-min.js' type='text/javascript'></script>
+  <script src='javascripts/lib/swagger-client.js' type='text/javascript'></script>
+  <script src='javascripts/swagger-ui.js' type='text/javascript'></script>
+  <script src='javascripts/lib/highlight.7.3.pack.js' type='text/javascript'></script>
+  <script src='javascripts/lib/marked.js' type='text/javascript'></script>
+
+  <!-- enabling this will enable oauth2 implicit scope support -->
+  <script src='javascripts/lib/swagger-oauth.js' type='text/javascript'></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://petstore.swagger.io/v2/swagger.json";
+      }
+      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",
+              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"
+      });
+
+      function addApiKeyAuthorization() {
+        var key = $('#input_apiKey')[0].value;
+        log("key: " + key);
+        if(key && key.trim() != "") {
+            log("added key " + key);
+            window.authorizations.add("api_key", new ApiKeyAuthorization("api_key", key, "query"));
+        }
+      }
+
+      $('#input_apiKey').change(function() {
+        addApiKeyAuthorization();
+      });
+
+      // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...
+      /*
+        var apiKey = "myApiKeyXXXX123456789";
+        $('#input_apiKey').val(apiKey);
+        addApiKeyAuthorization();
+      */
+
+      window.swaggerUi.load();
+  });
+  </script>
+</head>
+
+<body class="swagger-section">
+<div id='header'>
+  <div class="swagger-ui-wrap">
+    <a id="logo" href="http://swagger.io">swagger</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="#">Explore</a></div>
+    </form>
+  </div>
+</div>
+
+<div id="message-bar" class="swagger-ui-wrap">&nbsp;</div>
+<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
+</body>
+</html>