r2-oas 0.2.0 → 0.3.4

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'r2-oas'
-
-# 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

data/bin/setup

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

data/docs/README.md

@@ -1,173 +0,0 @@
-# R2-OAS
-
-[![Gem Version](https://badge.fury.io/rb/r2-oas.svg)](https://badge.fury.io/rb/r2-oas)
-[![Build Status](https://travis-ci.org/yukihirop/r2-oas.svg?branch=master)](https://travis-ci.org/yukihirop/r2-oas)
-[![Coverage Status](https://coveralls.io/repos/github/yukihirop/r2-oas/badge.svg)](https://coveralls.io/github/yukihirop/r2-oas)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f8c3846f350bb412fd63/maintainability)](https://codeclimate.com/github/yukihirop/r2-oas/maintainability)
-
-Generate api docment(OpenAPI) side only from `Rails` routing.
-
-Provides a rake command to help `generate` , `view` , and `edit` OpenAPI documents.
-
-```bash
-bundle exec rake routes:oas:docs    # generate
-bundle exec rake routes:oas:ui      # view
-bundle exec rake routes:oas:editor  # edit
-bundle exec rake routes:oas:monitor # monitor
-bundle exec rake routes:oas:dist    # distribute
-bundle exec rake routes:oas:clean   # clean
-bundle exec rake routes:oas:analyze # analyze
-bundle exec rake routes:oas:deploy  # deploy
-```
-
-## 💎 Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-group :development do
-  gem 'r2-oas'
-end
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install r2-oas
-
-## 🔦 Requirements
-
-If you want to view with `Swagger UI` or edit with `Swagger Editor`, This gem needs the following:
-
-- [`swaggerapi/swagger-ui:latest` docker image](https://hub.docker.com/r/swaggerapi/swagger-ui/)
-- [`swaggerapi/swagger-editor:latest` docker image](https://hub.docker.com/r/swaggerapi/swagger-editor/)
-- [`chromedriver`](http://chromedriver.chromium.org/downloads)
-
-If you do not have it download as below.
-
-```
-$ docker pull swaggerapi/swagger-editor:latest
-$ docker pull swaggerapi/swagger-ui:latest
-$ brew cask install chromedriver
-```
-
-## 🚀 Tutorial
-
-After requiring a gem,
-
-```bash
-bundle exec routes:oas:docs
-bundle exec routes:oas:editor
-```
-
-#### Generate docs
-
-![oas_docs](https://user-images.githubusercontent.com/11146767/80856236-0b839a80-8c83-11ea-888f-d0e659e0c251.gif)
-
-
-#### Edit docs
-
-![oas_editor](https://user-images.githubusercontent.com/11146767/80856240-15a59900-8c83-11ea-9dbd-4382528944f2.gif)
-
-## 📖 Usage
-
-
-You can execute the following command in the root directory of rails.
-
-```bash
-$ # Generate docs
-$ bundle exec rake routes:oas:docs                                                       # Generate docs
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:docs    # Generate docs by specify unit paths
-
-$ # Start swagger editor
-$ bundle exec rake routes:oas:editor                                                     # Start swagger editor
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor  # Start swagger editor by specify unit paths
-$ # Start swagger ui
-$ bundle exec rake routes:oas:ui                                                         # Start swagger ui
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:ui      # Start swagger ui by specify unit paths
-$ # Monitor swagger document
-$ bundle exec rake routes:oas:monitor                                                    # Monitor swagger document
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:monitor # Monitor swagger by specify unit paths
-
-$ # Analyze docs
-$ OAS_FILE="~/Desktop/swagger.yml" bundle exec rake routes:oas:analyze
-$ # Clean docs
-$ bundle exec rake routes:oas:clean
-$ # Deploy docs
-$ bundle exec rake routes:oas:deploy
-$ # Distribute swagger document
-$ bundle exec rake routes:oas:dist
-$ # Distribute swagger document
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:dist # Distribute swagger document by specify unit paths
-
-# Display paths list
-$ bundle exec rake routes:oas:paths_ls
-# Display paths stats
-$ bundle exec rake routes:oas:paths_stats
-```
-
-## ❤️ Support Rails Version
-
-- Rails (>= 4.2.5.1)
-
-## ❤️ Support Ruby Version
-
-- Ruby (>= 2.3.3p222 (2016-11-21 revision 56859) [x86_64-darwin18])
-
-## ❤️ Support Rouging
-
-- Rails Engine Routing
-- Rails Normal Routing
-
-## ❗️ Convention over Configuration (CoC)
-
-- `tag name` represents `controller name` and determine `paths file name`.
-  - For example, If `controller name` is `Api::V1::UsersController`, `tag_name` is `api/v1/user`. and `paths file name` is `api/v1/user.yml`
-
-- `_` of `components/{schemas,requestBodies, ...} name` convert `/` when save file.
-  - For example, If `components/schemas name` is `Api_V1_User`, `components/schemas file name` is `api/v1/user.yml`.
-  - `_` is supposed to be used to express `namespace`.
-  - format is `Namespace1_Namespace2_Model`.
-
-- `.` of `components/{schemas,requestBodies, ...} name` convert `/` when save file.
-  - For example, If `components/schemas name` is `api.v1.User`, `components/schemas file name` is `api/v1/user.yml`.
-  - `.` is supposed to be used to express `namespace`.
-  - format is `namespace1.namespace2.Model`.
-
-## 🔩 CORS
-
-Use [rack-cors](https://github.com/cyu/rack-cors) to enable CORS.
-
-```ruby
-require 'rack/cors'
-use Rack::Cors do
-  allow do
-    origins '*'
-    resource '*', headers: :any, methods: [ :get, :post, :put, :delete, :options ]
-  end
-end
-```
-
-Alternatively you can set CORS headers in a `before` block.
-
-```ruby
-before do
-  header['Access-Control-Allow-Origin'] = '*'
-  header['Access-Control-Request-Method'] = '*'
-end
-```
-
-## 📝 License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## 🤝 Contributing
-
-1. Fork it ( http://github.com/yukihirop/r2-oas/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/docs/_sidebar.md

@@ -1,23 +0,0 @@
-<!-- docs/_sidebar.md -->
-* **Attention**
- * [If Clash](/attention/if_clash)
-* **Usage**
- * [Generate Docs](/usage/generate_docs)
- * [Edit docs](/usage/edit_docs)
- * [View docs](/usage/view_docs)
- * [Monitor Docs](/usage/monitor_docs)
- * [Analyze Docs](/usage/analyze_docs)
- * [Use Hook to Generate Docs](/usage/use_hook_to_generate_docs)
- * [Use schema namespace](/usage/use_schema_namespace)
- * [Use tag namespace](/usage/use_tag_namespace)
- * [Use hook methods](/usage/use_hook_methods)
- * [Deploy docs](/usage/deploy_docs)
- * [Clean Docs](/usage/clean_docs)
- * [Display Paths Lists](/usage/display_paths_list)
- * [Display Paths Stats](/usage/display_paths_stats)
-* **Configure**
- * [COC](/setting/COC)
- * [Configure](/setting/configure)
- * [CORS](/setting/CORS)
-* **Support Schema**
- * [3.0.0](/schema/3.0.0)

data/docs/attention/if_clash.md

@@ -1,19 +0,0 @@
-# If clash
-
-Unfortunately, if you do the paste operation with Swagger Editor running, it may occasionally crash.
-
-f you crash while Swagger Editor is running, you can execute the following command to reflect the editing status up to a few seconds before in the local file.
-
-```bash
-bundle exec rake routes:oas:analyze
-```
-
-It is a file generated by parsing the generated file oas_doc.yml and dividing it into each file.
-
-## Attention
-
-Please be aware that if you execute the following command immediately after the crash, the change history will be `lost`.
-
-```bash
-bundle exec rake routes:oas:editor
-```

data/docs/index.html

@@ -1,29 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Document</title>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Description">
-  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-  <script>
-    window.$docsify = {
-      auto2top: true,
-      name: '<span>r2-oas</span>',
-      repo: 'https://github.com/yukihirop/r2-oas',
-      loadSidebar: true,
-      subMaxLevel: 2
-    }
-  </script>
-  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
-  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
-  <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-ruby.min.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
-  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-diff.min.js"></script>
-</body>
-</html>

data/docs/schema/3.0.0.md

@@ -1,155 +0,0 @@
-# 3.0.0
-
-## Support Schema
-
-Generate schema yaml like this:
-
-- Schema
-  - openapi
-  - info
-  - tags
-  - paths
-  - externalDocs
-  - servers
-  - security
-  - components
-    - schemas
-    - requestBodies
-    - securitySchemes
-    - parameters
-    - responses (experimental)
-    - examples (experimental)
-    - headers (experimental)
-    - links (experimental)
-    - callbacks (experimental)
-
-## openapi
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`openapi`|`string`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object)
-
-## info
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`title`|`string`|
-|`description`|`string`|
-|`termsOfService`|`string`|
-|`contact`|`Contact Object`|
-|`license`|`License Object`|
-|`version`|`string`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#info-object)
-
-## tags
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`name`|`string`|
-|`description`|`string`|
-|`externalDocs`|`External Document Object`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#tagObject)
-
-## paths
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`/{path}`|`Path Item Object`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#paths-object)
-
-for example:
-```
-paths:
-  "/users":
-    post:
-      tags:
-      - user
-      summary: post summary
-      description: post description
-      responses:
-        default:
-          description: ''
-      deprecated: false
-  "/{model_name}/{id}":
-    get:
-      tags:
-      - rails_admin/main
-      summary: get summary
-      description: get description
-      responses:
-        default:
-          description: ''
-        '200':
-          description: rails_admin/main description
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/Main"
-      deprecated: false
-      parameters:
-      - name: model_name
-        in: path
-        description: model_name
-        required: true
-        schema:
-          type: string
-      - name: id
-        in: path
-        description: id
-        required: true
-        schema:
-          type: integer
-```
-
-## externalDocs
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`description`|`string`|
-|`url`|`string`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#external-documentation-object)
-
-## servers
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`url`|`string`|
-|`description`|`string`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#server-object)
-
-## components
-
-Support field like this:
-
-|field name|field type|
-|----------|----------|
-|`schemas`| `Schema Object` |
-|`requestBodies`| `Request Body Object`|
-|`securitySchemes`| `Security Schemes Object` |
-|`parameters`| `Parameter Object` |
-|`responses`| `Response Object` |
-|`examples`| `Example Object` |
-|`headers`| `Header Object` |
-|`links`|`Link Object` |
-|`callbacks`| `Callback Object`|
-
-[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#components-object)

data/docs/setting/COC.md

@@ -1,14 +0,0 @@
-# ❗️Convention over Configuration (CoC)
-
-- `tag name` represents `controller name` and determine `paths file name`.
-  - For example, If `controller name` is `Api::V1::UsersController`, `tag_name` is `api/v1/user`. and `paths file name` is `api/v1/user.yml`
-
-- `_` of `components/{schemas,requestBodies, ...} name` convert `/` when save file.
-  - For example, If `components/schemas name` is `Api_V1_User`, `components/schemas file name` is `api/v1/user.yml`.
-  - `_` is supposed to be used to express `namespace`.
-  - format is `Namespace1_Namespace2_Model`.
-
-- `.` of `components/{schemas,requestBodies, ...} name` convert `/` when save file.
-  - For example, If `components/schemas name` is `api.v1.User`, `components/schemas file name` is `api/v1/user.yml`.
-  - `.` is supposed to be used to express `namespace`.
-  - format is `namespace1.namespace2.Model`.