RubyGems - swagger_rails - Versions diffs - 1.0.0.pre.beta - Mend

swagger_rails 1.0.0.pre.beta

Files changed (69) hide show

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,4 @@
+SwaggerRails::Engine.routes.draw do
+  root to: 'application#redirect_to_swagger_ui'
+  get '/index.html', to: 'swagger_ui#index', as: :swagger_ui
+end

data/lib/generators/swagger_rails/custom_ui/USAGE ADDED Viewed

@@ -0,0 +1,8 @@
+Description:
+    Adds a local version of index.html.erb for customizing the swagger-ui
+Example:
+    rails generate swagger_rails:custom_ui
+    This will create:
+        app/views/swagger_rails/swagger_ui/index.html.erb

data/lib/generators/swagger_rails/custom_ui/custom_ui_generator.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module SwaggerRails
+  class CustomUiGenerator < Rails::Generators::Base
+    source_root File.expand_path('../files', __FILE__)
+    def add_custom_index
+      copy_file('index.html.erb', 'app/views/swagger_rails/swagger_ui/index.html.erb')
+    end
+  end
+end

data/lib/generators/swagger_rails/custom_ui/files/index.html.erb ADDED Viewed

@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />
+  <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>
+  <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>
+  <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+  <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>
+  <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>
+  <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+  <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>
+  <script src='lib/underscore-min.js' type='text/javascript'></script>
+  <script src='lib/backbone-min.js' type='text/javascript'></script>
+  <script src='swagger-ui.js' type='text/javascript'></script>
+  <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>
+  <script src='lib/marked.js' type='text/javascript'></script>
+  <script src='lib/swagger-oauth.js' type='text/javascript'></script>
+  <!-- Some basic translations -->
+  <!-- <script src='lang/translator.js' type='text/javascript'></script> -->
+  <!-- <script src='lang/ru.js' type='text/javascript'></script> -->
+  <!-- <script src='lang/en.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 = "<%= @discovery_paths.values.first %>";
+      }
+      // 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",
+              realm: "your-realms",
+              appName: "your-app-name",
+              scopeSeparator: ","
+            });
+          }
+          if(window.SwaggerTranslator) {
+            window.SwaggerTranslator.translate();
+          }
+          $('pre code').each(function(i, e) {
+            hljs.highlightBlock(e)
+          });
+          addApiKeyAuthorization();
+        },
+        onFailure: function(data) {
+          log("Unable to Load SwaggerUI");
+        },
+        docExpansion: "list",
+        apisSorter: "alpha",
+        showRequestHeaders: false
+      });
+      function addApiKeyAuthorization(){
+        var key = encodeURIComponent($('#input_apiKey')[0].value);
+        if(key && key.trim() != "") {
+            var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
+            window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
+            log("added key " + key);
+        }
+      }
+      $('#input_apiKey').change(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);
+      */
+      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">swagger</a>
+    <form id='api_selector'>
+      <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text" disabled="disabled"/></div>
+      <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
+      <div class='input'>
+        <select id="select_version">
+          <% @discovery_paths.each do |name, path| %>
+            <option value="<%= path %>"><%= name %></option>
+          <% end %>
+        </select>
+        <script type="text/javascript">
+          $('#select_version').change(function () {
+            $('#input_baseUrl').val($(this).val());
+              window.swaggerUi.headerView.showCustom();
+          });
+        </script>
+        <style>
+          #select_version {
+            border: none;
+            -moz-border-radius: 4px;
+            -webkit-border-radius: 4px;
+            -o-border-radius: 4px;
+            -ms-border-radius: 4px;
+            -khtml-border-radius: 4px;
+            border-radius: 4px;
+            color: white;
+            background-color: #547f00;
+            font-size: 0.9em;
+          }
+        </style>
+      </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/lib/generators/swagger_rails/install/USAGE ADDED Viewed

@@ -0,0 +1,9 @@
+Description:
+  Adds default files required to use swagger_rails
+Example:
+    rails generate swagger_rails:install
+    This will create:
+        config/swagger/v1/swagger.json
+        config/initializers/swagger_rails.rb

data/lib/generators/swagger_rails/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'rails/generators'
+module SwaggerRails
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    def add_swagger_dir
+      empty_directory('config/swagger/v1')
+    end
+    def add_initializer
+      template('swagger_rails.rb', 'config/initializers/swagger_rails.rb')
+    end
+    def add_routes
+      route("mount SwaggerRails::Engine => '/api-docs'")
+    end
+  end
+end

data/lib/generators/swagger_rails/install/templates/swagger.json ADDED Viewed

@@ -0,0 +1,45 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "version": "0.0.0",
+        "title": "[Enter a description for your API here]",
+        "description": "The docs below are powered by the default swagger.json that gets installed with swagger_rails. You'll need to update it to describe your API. See here for the complete swagger spec - https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md"
+    },
+    "paths": {
+        "/a/sample/resource": {
+            "post": {
+                "tags": [
+                  "a/sample/resource"
+                ],
+                "description": "Create a new sample resource",
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/CreateSampleResource"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Ok"
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "CreateSampleResource": {
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "date_time": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        }
+    }
+}

data/lib/generators/swagger_rails/install/templates/swagger_rails.rb ADDED Viewed

@@ -0,0 +1,13 @@
+SwaggerRails.configure do |c|
+  # Define your swagger documents and provide global metadata
+  # Describe actual operations in your spec/test files
+  c.swagger_doc 'v1/swagger.json' do
+    {
+      info: {
+        title: 'API V1',
+        version: 'v1'
+      }
+    }
+  end
+end

data/lib/swagger_rails/engine.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'swagger_rails/middleware/swagger_docs'
+require 'swagger_rails/middleware/swagger_ui'
+module SwaggerRails
+  class Engine < ::Rails::Engine
+    isolate_namespace SwaggerRails
+    initializer 'swagger_rails.initialize' do |app|
+      middleware.use SwaggerDocs, File.join(app.root, 'config', 'swagger')
+      middleware.use SwaggerUi, "#{root}/bower_components/swagger-ui/dist"
+    end
+  end
+end

data/lib/swagger_rails/middleware/swagger_docs.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module SwaggerRails
+  class SwaggerDocs < ActionDispatch::Static
+  end
+end

data/lib/swagger_rails/middleware/swagger_ui.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module SwaggerRails
+  class SwaggerUi < ActionDispatch::Static
+    IGNORE_PATHS = [ '', '/', '/index.html' ]
+    def call(env)
+      # Serve index.html via swagger_ui_controller
+      if IGNORE_PATHS.include?(env['PATH_INFO'])
+        @app.call(env)
+      else
+        super(env)
+      end
+    end
+  end
+end

data/lib/swagger_rails/rspec/dsl.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require 'swagger_rails/test_visitor'
+module SwaggerRails
+  module RSpec
+    module DSL
+      def path(path_template, &block)
+        metadata = {
+          path_template: path_template
+        }
+        describe(path_template, metadata, &block)
+      end
+      def operation(http_verb, summary=nil, &block)
+        metadata = {
+          http_verb: http_verb,
+          summary: summary,
+          parameters: []
+        }
+        describe(http_verb, metadata, &block)
+      end
+      [ :get, :post, :patch, :put, :delete, :head ].each do |http_verb|
+        define_method(http_verb) do |summary=nil, &block|
+          operation(http_verb, summary, &block)
+        end
+      end
+      def consumes(*mime_types)
+        metadata[:consumes] = mime_types
+      end
+      def produces(*mime_types)
+        metadata[:produces] = mime_types
+      end
+      def parameter(name, attributes={})
+        metadata[:parameters] << { name: name.to_s }.merge(attributes)
+      end
+      def response(code, description, &block)
+        metadata = {
+          response_code: code,
+          response: {
+            description: description
+          }
+        }
+        context(description, metadata, &block)
+      end
+      def run_test!
+        before do |example|
+          SwaggerRails::TestVisitor.instance.submit_request!(self, example.metadata)
+        end
+        it "returns a #{metadata[:response_code]} status" do |example|
+          SwaggerRails::TestVisitor.instance.assert_response!(self, example.metadata)
+        end
+      end
+    end
+  end
+end

data/lib/swagger_rails/rspec/formatter.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require 'rspec/core/formatters/base_text_formatter'
+require 'rails_helper'
+module SwaggerRails
+  module RSpec
+    class Formatter
+      ::RSpec::Core::Formatters.register self,
+        :example_group_finished,
+        :stop
+      def initialize(output)
+        @output = output
+        @swagger_docs = SwaggerRails.swagger_docs
+        @output.puts 'Generating Swagger Docs ...'
+      end
+      def example_group_finished(notification)
+        metadata = notification.group.metadata
+        return unless metadata.has_key?(:response_code)
+        swagger_data = swagger_data_from(metadata)
+        swagger_doc = @swagger_docs[metadata[:docs_path]] || @swagger_docs.values.first
+        swagger_doc.deep_merge!(swagger_data)
+      end
+      def stop(notification)
+        @swagger_docs.each do |path, doc|
+          file_path = File.join(Rails.root, 'config/swagger', path)
+          File.open(file_path, 'w') do |file|
+            file.write(JSON.pretty_generate(doc))
+          end
+        end
+        @output.puts 'Swagger Doc generated'
+      end
+      private
+      def swagger_data_from(metadata)
+        {
+          paths: {
+            metadata[:path_template] => {
+              metadata[:http_verb] => operation_from(metadata)
+            }
+          }
+        }
+      end
+      def operation_from(metadata)
+        metadata.slice(:summary, :consumes, :produces, :parameters).tap do |operation|
+          operation[:responses] = {
+            metadata[:response_code] => metadata[:response]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/swagger_rails/test_visitor.rb ADDED Viewed

@@ -0,0 +1,59 @@
+require 'singleton'
+module SwaggerRails
+  class TestVisitor
+    include Singleton
+    def submit_request!(test, metadata)
+      params_data = params_data_for(test, metadata[:parameters])
+      path = build_path(metadata[:path_template], params_data)
+      body_or_params = build_body_or_params(params_data)
+      headers = build_headers(params_data, metadata[:consumes], metadata[:produces])
+      test.send(metadata[:http_verb], path, body_or_params, headers)
+    end
+    def assert_response!(test, metadata)
+      test.assert_response(metadata[:response_code].to_i)
+    end
+    private
+    def params_data_for(test, parameters)
+      parameters.map do |parameter|
+        parameter
+          .slice(:name, :in)
+          .merge(value: test.send(parameter[:name].to_s.underscore))
+      end
+    end
+    def build_path(path_template, params_data)
+      path_params_data = params_data.select { |p| p[:in] == :path }
+      path_template.dup.tap do |path|
+        path_params_data.each do |param_data|
+          path.sub!("\{#{param_data[:name]}\}", param_data[:value].to_s)
+        end
+      end
+    end
+    def build_body_or_params(params_data)
+      body_params_data = params_data.select { |p| p[:in] == :body }
+      return body_params_data.first[:value].to_json if body_params_data.any?
+      query_params_data = params_data.select { |p| p[:in] == :query }
+      Hash[query_params_data.map { |p| [ p[:name], p[:value] ] }]
+    end
+    def build_headers(params_data, consumes, produces)
+      header_params_data = params_data.select { |p| p[:in] == :header }
+      headers = Hash[header_params_data.map { |p| [ p[:name], p[:value] ] }]
+      headers['ACCEPT'] = produces.join(';') if produces.present?
+      headers['CONTENT_TYPE'] = consumes.join(';') if consumes.present?
+      return headers
+    end
+  end
+end

data/lib/swagger_rails/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module SwaggerRails
+  VERSION = "1.0.0-beta"
+end

data/lib/swagger_rails.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require "swagger_rails/engine"
+module SwaggerRails
+  def self.configure
+    yield self
+  end
+  class << self
+    @@swagger_docs = {}
+    def swagger_doc(path, &block)
+      @@swagger_docs[path] = block
+    end
+    def swagger_docs
+      Hash[
+        @@swagger_docs.map do |path, factory|
+          [ path, factory.call.merge(swagger: '2.0') ]
+        end
+      ]
+    end
+  end
+end

data/lib/tasks/swagger_rails_tasks.rake ADDED Viewed

@@ -0,0 +1,12 @@
+# desc "Explaining what the task does"
+# task :swagger_rails do
+#   # Task goes here
+# end
+require 'rspec/core/rake_task'
+desc 'Generate Swagger JSON files from integration specs'
+RSpec::Core::RakeTask.new('swaggerize') do |t|
+  t.pattern = 'spec/integration/**/*_spec.rb'
+  t.rspec_opts = [ '--format SwaggerRails::RSpec::Formatter', '--dry-run' ]
+end

metadata ADDED Viewed

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: swagger_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta
+platform: ruby
+authors:
+- domaindrivendev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use the provided DSL to accurately test and describe API operations in
+  your spec files. Then, you can easily generate corresponding swagger.json files
+  and serve them up with an embedded version of swagger-ui. This means you can complement
+  your API with a slick discovery UI to assist consumers with their integration efforts.
+  Best of all, it requires minimal coding and maintenance, allowing you to focus on
+  building an awesome API!
+email:
+- domaindrivendev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/controllers/swagger_rails/application_controller.rb
+- app/controllers/swagger_rails/swagger_ui_controller.rb
+- app/helpers/swagger_rails/application_helper.rb
+- app/views/swagger_rails/swagger_ui/index.html.erb
+- bower_components/swagger-ui/dist/css/print.css
+- bower_components/swagger-ui/dist/css/reset.css
+- bower_components/swagger-ui/dist/css/screen.css
+- bower_components/swagger-ui/dist/css/style.css
+- bower_components/swagger-ui/dist/css/typography.css
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.eot
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.svg
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.ttf
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.woff
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.woff2
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.eot
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.svg
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.ttf
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.woff
+- bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.woff2
+- bower_components/swagger-ui/dist/images/explorer_icons.png
+- bower_components/swagger-ui/dist/images/favicon-16x16.png
+- bower_components/swagger-ui/dist/images/favicon-32x32.png
+- bower_components/swagger-ui/dist/images/favicon.ico
+- bower_components/swagger-ui/dist/images/logo_small.png
+- bower_components/swagger-ui/dist/images/pet_store_api.png
+- bower_components/swagger-ui/dist/images/throbber.gif
+- bower_components/swagger-ui/dist/images/wordnik_api.png
+- bower_components/swagger-ui/dist/index.html
+- bower_components/swagger-ui/dist/lang/en.js
+- bower_components/swagger-ui/dist/lang/es.js
+- bower_components/swagger-ui/dist/lang/pt.js
+- bower_components/swagger-ui/dist/lang/ru.js
+- bower_components/swagger-ui/dist/lang/translator.js
+- bower_components/swagger-ui/dist/lib/backbone-min.js
+- bower_components/swagger-ui/dist/lib/handlebars-2.0.0.js
+- bower_components/swagger-ui/dist/lib/highlight.7.3.pack.js
+- bower_components/swagger-ui/dist/lib/jquery-1.8.0.min.js
+- bower_components/swagger-ui/dist/lib/jquery.ba-bbq.min.js
+- bower_components/swagger-ui/dist/lib/jquery.slideto.min.js
+- bower_components/swagger-ui/dist/lib/jquery.wiggle.min.js
+- bower_components/swagger-ui/dist/lib/marked.js
+- bower_components/swagger-ui/dist/lib/swagger-oauth.js
+- bower_components/swagger-ui/dist/lib/underscore-min.js
+- bower_components/swagger-ui/dist/lib/underscore-min.map
+- bower_components/swagger-ui/dist/o2c.html
+- bower_components/swagger-ui/dist/swagger-ui.js
+- bower_components/swagger-ui/dist/swagger-ui.min.js
+- config/routes.rb
+- lib/generators/swagger_rails/custom_ui/USAGE
+- lib/generators/swagger_rails/custom_ui/custom_ui_generator.rb
+- lib/generators/swagger_rails/custom_ui/files/index.html.erb
+- lib/generators/swagger_rails/install/USAGE
+- lib/generators/swagger_rails/install/install_generator.rb
+- lib/generators/swagger_rails/install/templates/swagger.json
+- lib/generators/swagger_rails/install/templates/swagger_rails.rb
+- lib/swagger_rails.rb
+- lib/swagger_rails/engine.rb
+- lib/swagger_rails/middleware/swagger_docs.rb
+- lib/swagger_rails/middleware/swagger_ui.rb
+- lib/swagger_rails/rspec/dsl.rb
+- lib/swagger_rails/rspec/formatter.rb
+- lib/swagger_rails/test_visitor.rb
+- lib/swagger_rails/version.rb
+- lib/tasks/swagger_rails_tasks.rake
+homepage: https://github.com/domaindrivendev/swagger_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Leverage your api/integration test specs to generate swagger descriptions
+  for Rails-based API's
+test_files: []
+has_rdoc: