RubyGems - swaggard - Versions diffs - 0.0.4 - Mend

swaggard 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +178 -0
data/Rakefile +24 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-700.eot +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-700.svg +411 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-700.ttf +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-700.woff +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-700.woff2 +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-regular.eot +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-regular.svg +403 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-regular.ttf +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-regular.woff +0 -0
data/app/assets/fonts/swaggard/droid-sans-v6-latin-regular.woff2 +0 -0
data/app/assets/images/swaggard/logo_small.png +0 -0
data/app/assets/images/swaggard/pet_store_api.png +0 -0
data/app/assets/images/swaggard/throbber.gif +0 -0
data/app/assets/images/swaggard/wordnik_api.png +0 -0
data/app/assets/javascripts/swaggard/application.js +24 -0
data/app/assets/javascripts/swaggard/lib/MD5.js +319 -0
data/app/assets/javascripts/swaggard/lib/backbone-min.js +15 -0
data/app/assets/javascripts/swaggard/lib/handlebars-1.0.rc.1.js +1920 -0
data/app/assets/javascripts/swaggard/lib/handlebars-2.0.0.js +28 -0
data/app/assets/javascripts/swaggard/lib/highlight.7.3.pack.js +1 -0
data/app/assets/javascripts/swaggard/lib/jquery-1.8.0.min.js +2 -0
data/app/assets/javascripts/swaggard/lib/jquery.ba-bbq.min.js +18 -0
data/app/assets/javascripts/swaggard/lib/jquery.slideto.min.js +1 -0
data/app/assets/javascripts/swaggard/lib/jquery.wiggle.min.js +8 -0
data/app/assets/javascripts/swaggard/lib/marked.js +1272 -0
data/app/assets/javascripts/swaggard/lib/shred.bundle.js +2765 -0
data/app/assets/javascripts/swaggard/lib/swagger-client.js +3294 -0
data/app/assets/javascripts/swaggard/lib/swagger.js +794 -0
data/app/assets/javascripts/swaggard/lib/underscore-min.js +32 -0
data/app/assets/javascripts/swaggard/swagger-ui.js +2240 -0
data/app/assets/javascripts/swaggard/swagger-ui_org.js +2005 -0
data/app/assets/stylesheets/swaggard/application.css +16 -0
data/app/assets/stylesheets/swaggard/reset.css +125 -0
data/app/assets/stylesheets/swaggard/screen.css.scss +1256 -0
data/app/assets/stylesheets/swaggard/typography.css.scss +26 -0
data/app/controllers/swaggard/application_controller.rb +4 -0
data/app/controllers/swaggard/swagger_controller.rb +21 -0
data/app/views/swaggard/swagger/index.html.erb +74 -0
data/config/routes.rb +3 -0
data/lib/swaggard.rb +92 -0
data/lib/swaggard/api_definition.rb +52 -0
data/lib/swaggard/configuration.rb +82 -0
data/lib/swaggard/engine.rb +18 -0
data/lib/swaggard/parsers/controllers.rb +30 -0
data/lib/swaggard/parsers/models.rb +29 -0
data/lib/swaggard/parsers/routes.rb +54 -0
data/lib/swaggard/swagger/definition.rb +24 -0
data/lib/swaggard/swagger/operation.rb +98 -0
data/lib/swaggard/swagger/parameters/base.rb +21 -0
data/lib/swaggard/swagger/parameters/body.rb +67 -0
data/lib/swaggard/swagger/parameters/form.rb +32 -0
data/lib/swaggard/swagger/parameters/list.rb +46 -0
data/lib/swaggard/swagger/parameters/path.rb +21 -0
data/lib/swaggard/swagger/parameters/query.rb +32 -0
data/lib/swaggard/swagger/path.rb +24 -0
data/lib/swaggard/swagger/property.rb +23 -0
data/lib/swaggard/swagger/response.rb +45 -0
data/lib/swaggard/swagger/tag.rb +28 -0
data/lib/swaggard/swagger/type.rb +72 -0
data/lib/swaggard/version.rb +5 -0
data/spec/fixtures/api.json +1 -0
data/spec/fixtures/dummy/app/controllers/application_controller.rb +2 -0
data/spec/fixtures/dummy/app/controllers/pets_controller.rb +15 -0
data/spec/fixtures/dummy/config/application.rb +15 -0
data/spec/fixtures/dummy/config/environments/development.rb +5 -0
data/spec/fixtures/dummy/config/routes.rb +5 -0
data/spec/fixtures/dummy/log/development.log +0 -0
data/spec/integration/swaggard_spec.rb +19 -0
data/spec/spec_helper.rb +27 -0
metadata +210 -0

data/app/assets/stylesheets/swaggard/typography.css.scss ADDED Viewed

@@ -0,0 +1,26 @@
+/* droid-sans-regular - latin */
+@font-face {
+  font-family: 'Droid Sans';
+  font-style: normal;
+  font-weight: 400;
+  src: url('../fonts/droid-sans-v6-latin-regular.eot'); /* IE9 Compat Modes */
+  src: local('Droid Sans'), local('DroidSans'),
+       font-url('swaggard/droid-sans-v6-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
+       font-url('swaggard/droid-sans-v6-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */
+       font-url('swaggard/droid-sans-v6-latin-regular.woff') format('woff'), /* Modern Browsers */
+       font-url('swaggard/droid-sans-v6-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */
+       font-url('swaggard/droid-sans-v6-latin-regular.svg#DroidSans') format('svg'); /* Legacy iOS */
+}
+/* droid-sans-700 - latin */
+@font-face {
+  font-family: 'Droid Sans';
+  font-style: normal;
+  font-weight: 700;
+  src: font-url('swaggard/droid-sans-v6-latin-700.eot'); /* IE9 Compat Modes */
+  src: local('Droid Sans Bold'), local('DroidSans-Bold'),
+       font-url('swaggard/droid-sans-v6-latin-700.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
+       font-url('swaggard/droid-sans-v6-latin-700.woff2') format('woff2'), /* Super Modern Browsers */
+       font-url('swaggard/droid-sans-v6-latin-700.woff') format('woff'), /* Modern Browsers */
+       font-url('swaggard/droid-sans-v6-latin-700.ttf') format('truetype'), /* Safari, Android, iOS */
+       font-url('swaggard/droid-sans-v6-latin-700.svg#DroidSans') format('svg'); /* Legacy iOS */
+}

data/app/controllers/swaggard/application_controller.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Swaggard
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/swaggard/swagger_controller.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module Swaggard
+  class SwaggerController < ApplicationController
+    def index
+      respond_to do |format|
+        format.html do
+          @authentication_type = Swaggard.configuration.authentication_type
+          @authentication_key = Swaggard.configuration.authentication_key
+          @authentication_value = Swaggard.configuration.authentication_value
+          render :index
+        end
+        format.json do
+          render :json => Swaggard.get_doc
+        end
+      end
+    end
+  end
+end

data/app/views/swaggard/swagger/index.html.erb ADDED Viewed

@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Swagger UI</title>
+  <%= stylesheet_link_tag    'swaggard/application', media: 'all' %>
+  <%= javascript_include_tag 'swaggard/application' %>
+  <script type="text/javascript">
+    $(function () {
+      var url = window.location.search.match(/url=([^&]+)/);
+      if (url && url.length > 1) {
+        url = decodeURIComponent(url[1]);
+      } else {
+        url = location.protocol + "//" + location.host + "/swagger.json";
+      }
+      window.swaggerUi = new SwaggerUi({
+        url: url,
+        dom_id: "swagger-ui-container",
+        supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
+        onComplete: function(swaggerApi, swaggerUi){
+          $('pre code').each(function(i, e) {
+            hljs.highlightBlock(e)
+          });
+        },
+        onFailure: function(data) {
+          log("Unable to Load SwaggerUI");
+        },
+        docExpansion: "none",
+        apisSorter : "alpha"
+      });
+      function addApiKeyAuthorization() {
+        var key = $('#input_apiKey')[0].value;
+        log("key: " + key);
+        if(key && key.trim() != "") {
+          log("added key " + key);
+          window.authorizations.add('key', new ApiKeyAuthorization("<%= @authentication_key %>",
+                                           key,
+                                           "<%= @authentication_type %>"));
+        }
+      }
+      var $apiKeyInput = $('#input_apiKey');
+      $apiKeyInput.change(function() {
+        addApiKeyAuthorization();
+      });
+      var apiKey = "<%= @authentication_value %>";
+      $apiKeyInput.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="<%= @authentication_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>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Swaggard::Engine.routes.draw do
+   get '/(.:format)', to: 'swagger#index'
+end

data/lib/swaggard.rb ADDED Viewed

@@ -0,0 +1,92 @@
+require 'json'
+require 'yard'
+require 'swaggard/api_definition'
+require 'swaggard/configuration'
+require 'swaggard/engine'
+require 'swaggard/parsers/controllers'
+require 'swaggard/parsers/models'
+require 'swaggard/parsers/routes'
+module Swaggard
+  class << self
+    def configure
+      yield configuration
+    end
+    def configuration
+      @configuration ||= Swaggard::Configuration.new
+    end
+    # Register some custom yard tags
+    def register_custom_yard_tags!
+      ::YARD::Tags::Library.define_tag('Controller\'s tag',  :tag)
+      ::YARD::Tags::Library.define_tag('Query parameter', :query_parameter)
+      ::YARD::Tags::Library.define_tag('Form parameter',  :form_parameter)
+      ::YARD::Tags::Library.define_tag('Body parameter',  :body_parameter)
+      ::YARD::Tags::Library.define_tag('Parameter list',  :parameter_list)
+      ::YARD::Tags::Library.define_tag('Response class',  :response_class)
+    end
+    def get_doc
+      load!
+      @api.to_doc
+    end
+    private
+    def load!
+      @api = Swaggard::ApiDefinition.new
+      parse_models
+      parse_controllers
+    end
+    def parse_controllers
+      parser = Parsers::Controllers.new
+      Dir[configuration.controllers_path].each do |file|
+        yard_objects = get_yard_objects(file)
+        tag, operations = parser.run(yard_objects, routes)
+        next unless tag
+        @api.add_tag(tag)
+        operations.each { |operation| @api.add_operation(operation) }
+      end
+    end
+    def routes
+      return @routes if @routes
+      parser = Parsers::Routes.new
+      @routes = parser.run(configuration.routes)
+    end
+    def parse_models
+      parser = Parsers::Models.new
+      definitions =[]
+      Dir[configuration.models_path].each do |file|
+        yard_objects = get_yard_objects(file)
+        definitions.concat(parser.run(yard_objects))
+      end
+      @api.definitions = definitions
+    end
+    def get_yard_objects(file)
+      ::YARD.parse(file)
+      yard_objects = ::YARD::Registry.all
+      ::YARD::Registry.clear
+      yard_objects
+    end
+  end
+end

data/lib/swaggard/api_definition.rb ADDED Viewed

@@ -0,0 +1,52 @@
+require_relative 'swagger/path'
+module Swaggard
+  class ApiDefinition
+    attr_accessor :definitions
+    def initialize
+      @paths        = {}
+      @tags         = {}
+      @definitions  = []
+    end
+    def add_tag(tag)
+      @tags[tag.name] ||= tag
+      @tags[tag.name].description = tag.description unless tag.description.blank?
+    end
+    def add_operation(operation)
+      @paths[operation.path] ||= Swagger::Path.new(operation.path)
+      @paths[operation.path].add_operation(operation)
+      @definitions.concat(operation.definitions)
+    end
+    def to_doc
+      {
+        'swagger' => Swaggard.configuration.swagger_version,
+        'info' => {
+          'description'     => Swaggard.configuration.description,
+          'version'         => Swaggard.configuration.api_version,
+          'title'           => Swaggard.configuration.title,
+          'termsOfService'  => Swaggard.configuration.tos,
+          'contact' => {
+            'email' => Swaggard.configuration.contact
+          },
+          'license' => {
+            'name'  => Swaggard.configuration.license_name,
+            'url'   => Swaggard.configuration.license_url
+          }
+        },
+        'host'        => Swaggard.configuration.host,
+        'basePath'    => Swaggard.configuration.api_base_path,
+        'tags'        => @tags.map { |_, tag| tag.to_doc },
+        'schemes'     => Swaggard.configuration.schemes,
+        'paths'       => Hash[@paths.values.map { |path| [path.path, path.to_doc] }],
+        'definitions' => Hash[@definitions.map { |definition| [definition.id, definition.to_doc] }]
+      }
+    end
+  end
+end

data/lib/swaggard/configuration.rb ADDED Viewed

@@ -0,0 +1,82 @@
+module Swaggard
+  # Configuration for Swagger Yard, use like:
+  #
+  #   Swaggard.configure do |config|
+  #     config.api_version          = '0.1'
+  #     config.doc_base_path        = 'http://swagger.example.com/doc'
+  #     config.api_base_path        = 'http://swagger.example.com/api'
+  #     config.authentication_type  = 'header'
+  #     config.authentication_key   = 'X-AUTHORIZATION'
+  #     config.authentication_value = 'you-secret-key'
+  #   end
+  class Configuration
+    attr_accessor :doc_base_path, :api_base_path, :controllers_path, :models_path, :routes
+    attr_writer :swagger_version, :api_version, :api_path, :api_formats, :title, :description,
+                :tos, :contact, :host, :authentication_type, :authentication_key,
+                :authentication_value
+    def swagger_version
+      @swagger_version ||= '2.0'
+    end
+    def api_version
+      @api_version ||= '0.1'
+    end
+    def api_path
+      @api_path ||= ''
+    end
+    def api_formats
+      @api_formats ||= [:xml, :json]
+    end
+    def host
+      @host ||= ''
+    end
+    def schemes
+      @schemes ||= [:http]
+    end
+    def title
+      @title ||= ''
+    end
+    def description
+      @description ||= ''
+    end
+    def tos
+      @tos ||= ''
+    end
+    def contact
+      @contact ||= ''
+    end
+    def license_name
+      @license_name ||= ''
+    end
+    def license_url
+      @license_url ||= ''
+    end
+    def authentication_type
+      @authentication_type ||= 'query'
+    end
+    def authentication_key
+      @authentication_key ||= 'api_key'
+    end
+    def authentication_value
+      @authentication_value ||= ''
+    end
+  end
+end

data/lib/swaggard/engine.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module Swaggard
+  class Engine < ::Rails::Engine
+    isolate_namespace Swaggard
+    initializer 'swaggard.finisher_hook', :after => :finisher_hook do |app|
+      app.reload_routes!
+      Swaggard.configure do |config|
+        config.controllers_path = "#{app.root}/app/controllers/**/*.rb"
+        config.models_path = "#{app.root}/app/serializers/**/*.rb"
+        config.routes = app.routes.routes
+      end
+      Swaggard.register_custom_yard_tags!
+    end
+  end
+end

data/lib/swaggard/parsers/controllers.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require_relative '../swagger/operation'
+require_relative '../swagger/tag'
+module Swaggard
+  module Parsers
+    class Controllers
+      def run(yard_objects, routes)
+        tag = nil
+        operations = []
+        yard_objects.each do |yard_object|
+          if yard_object.type == :class
+            tag = Swagger::Tag.new(yard_object)
+          elsif tag && yard_object.type == :method
+            operation = Swagger::Operation.new(yard_object, tag, routes)
+            operations << operation if operation.valid?
+          else
+            break
+          end
+        end
+        return unless operations.any?
+        return tag, operations
+      end
+    end
+  end
+end

data/lib/swaggard/parsers/models.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require_relative '../swagger/definition'
+require_relative '../swagger/property'
+module Swaggard
+  module Parsers
+    class Models
+      def run(yard_objects)
+        definitions = []
+        yard_objects.each do |yard_object|
+          next unless yard_object.type == :class
+          definition = Swagger::Definition.new(yard_object.name)
+          yard_object.tags.each do |tag|
+            property = Swagger::Property.new(tag)
+            definition.add_property(property)
+          end
+          definitions << definition
+        end
+        definitions
+      end
+    end
+  end
+end