zero-rails_openapi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 388bb78c95e92399dacc43b0a83ae3b5165e3ea2
+  data.tar.gz: 352a5d7fdf9f6aa670a7e0ea56a99934dec0375c
+SHA512:
+  metadata.gz: 26b8d36f4601facd4ed6936e5be617a8cc03ee279c99c603727ad7fb7432841f2e9ad20691e1d1a0f6e448a837b758f55cf5e4408027b87cc25ce3bd7391a0c4
+  data.tar.gz: bbfc3c14e4c72b8f56eed5dae4fb4df9c5120e81bd1c7d8a4fd535c0853a7e23d018812aabfa3283d51b421b8a8aee6d3ab84ef055087dbf6c418c5a1bb4a82d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0.pre.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at will.huang@dji.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zero-rails_openapi.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    zero-rails_openapi (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  zero-rails_openapi!
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 will.huang
+
+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,245 @@
+# ZRO: OpenApi 3 DocGenerator for Rails
+
+Provide concise DSL for you to generate the OpenAPI Specification 3 (**OAS3**, formerly Swagger3) JSON file for Rails application, 
+then you can use Swagger-UI 3.2.0+ to show the documentation.
+
+## About OAS
+
+Everything about OAS3 is on [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md)
+
+You can getting started from [swagger.io](https://swagger.io/docs/specification/basic-structure/)
+
+**I suggest you should understand OAS3's basic structure at least.** 
+such as component (can help you reuse DSL code, when your apis are used with the 
+same data structure).
+
+## Installation
+
+Add this line to your Rails's Gemfile:
+
+```ruby
+gem 'zero-rails_openapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zero-rails_openapi
+    
+## Configure
+
+Create an initializer, configure ZRO and define your APIs.
+
+This is the simplest configuration example:
+
+```ruby
+# config/initializers/open_api.rb
+require 'open_api'
+
+OpenApi.configure do |c|
+  # [REQUIRED] The output location where .json doc file will be written to.
+  c.file_output_path = 'public/open_api'
+
+  c.register_apis = {
+      homepage_api: {
+          # [REQUIRED] ZRO will scan all the descendants of the root_controller, then generate their docs.
+          root_controller: Api::V1::BaseController,
+
+          # [REQUIRED] OAS Info Object: The section contains API information.
+          info: {
+              # [REQUIRED] The title of the application.
+              title: 'Rails APIs',
+              # Description of the application.
+              description: 'API documentation of Rails Application. <br/>' \
+                           'Optional multiline or single-line Markdown-formatted description ' \
+                           'in [CommonMark](http://spec.commonmark.org/) or `HTML`.',
+              # [REQUIRED] The version of the OpenAPI document
+              # (which is distinct from the OAS version or the API implementation version).
+              version: '1.0.0'
+          }
+      }
+  }
+end
+```
+You can also set the *global configuration(/component)* of OAS: 
+Server Object / Security Scheme Object / Security Requirement Object ...
+
+For more detailed configuration: [open_api.rb](https://github.com/zhandao/zero-rails_openapi/blob/master/lib/examples/open_api.rb)
+
+## Usage
+
+### DSL for documenting your controller
+
+#### \> First of all, extend DSL for your base controller, for example:
+
+```ruby
+# application_controller.rb
+require 'open_api/dsl'
+
+class ApplicationController < ActionController::API
+  include OpenApi::DSL
+ end
+```
+
+#### \> [DSL Usage Example](https://github.com/zhandao/zero-rails_openapi/blob/master/lib/examples/examples_controller.rb)
+
+```ruby
+class Api::V1::ExamplesController < Api::V1::BaseController
+  apis_set 'ExamplesController\'s APIs' do
+    schema :Dog           => [ { id!: Integer, name: String }, dft: { id: 1, name: 'pet' } ]
+    path!  :PathCompId    => [ :id, Integer, desc: 'user id' ]
+    query! :QueryCompUuid => [ :product_uuid, { uuid: String, time: 'int32' }, desc: 'product uuid' ]
+    body!  :RqBodyComp    => [ :form ]
+    resp   :RespComp      => [ 'bad request', :json ]
+  end
+
+  open_api_set %i[index show], 'common response' do
+    response '567', 'query result export', :pdf, type: File
+  end
+
+  open_api :index, '(SUMMARY) this api blah blah ...' do
+    this_api_is_invalid! 'this api is expired!'
+    desc 'Optional multiline or single-line Markdown-formatted description',
+         id:         'user id',
+         email_addr: 'email_addr\'s desc'
+    email = 'git@github.com'
+
+    query! :id,         Integer, enum: 0..5,     length: [1, 2], pattern: /^[0-9]$/, range: {gt:0, le:5}
+    query! :done,       Boolean, must_be: false, default: true,  desc: 'must be false'
+    query  :email_addr, String,  lth: :ge_3,     default: email  # is_a: :email
+    # form! 'form', type: { id!: Integer, name: String }
+    file :pdf, 'desc: the media type is application/pdf'
+    
+    response :success, 'success response', :json, type: :Dog
+    
+    security :ApiKeyAuth
+  end
+
+  open_api :show do
+    param_ref    :PathCompId, :QueryCompUuid
+    response_ref '123' => :RespComp, '223' => :RespComp
+  end
+end
+
+```
+
+#### \> Explanation
+
+##### \>\> controller class methods ([code source](https://github.com/zhandao/zero-rails_openapi/blob/master/lib/open_api/dsl.rb))
+
+- `apis_set` [Optional]
+
+
+
+- `open_api_set` [Optional]
+
+
+- `open_api`
+
+##### \>\> DSL methods inside *open_api* and *open_api_set*'s block ([code source](https://github.com/zhandao/zero-rails_openapi/blob/master/lib/open_api/dsl_inside_block.rb)# ApiInfoObj )
+
+These methods in the block describe the specified API(s): description, valid?,
+parameters, request body, responses, securities, servers.
+
+- `this_api_is_invalid!`, its aliases are:
+  - `this_api_is_expired!`
+  - `this_api_is_unused!`
+  - `this_api_is_under_repair!`
+
+```ruby
+    # method signature
+    this_api_is_invalid! explain = ''
+    # usage
+    this_api_is_invalid! 'this api is expired!'
+```
+
+- `desc`: description for current API and its inputs (parameters and request body)
+
+```ruby
+    # method signature
+    desc desc, inputs_descs = { }
+    # usage
+    desc 'current API\'s description',
+         id:         'user id',
+         email_addr: 'email_addr\'s desc'
+```
+
+You can of course describe the input in it's DSL method (like `query! :done` this line), 
+but that will make it long and ugly. We recommend that unite descriptions in this place.
+
+- param family methods
+  - `param`
+  - `param_ref`
+  - `header`, `path`, `query`, `cookie`
+  - bang methods: `header!`, `path!`, `query!`, `cookie!`
+  
+  
+- request_body family methods
+  - `request_body`
+  - `body_ref`
+  - `body` and bang `body!`
+  
+  
+- response family methods
+  - `response` (`resp`)
+  - `response_ref`
+  - `default_response` (`dft_resp`)
+  - `error_response` (`other_response`, `oth_resp`, `error`, `err_resp`)
+  
+##### \>\> DSL methods inside apis_set'block ([code source](https://github.com/zhandao/zero-rails_openapi/blob/master/lib/open_api/dsl_inside_block.rb)# CtrlInfoObj )
+
+These methods in the block describe the current controller, 
+or we say, these methods eventually produce reusable components.
+
+So, the following methods are used as above, except that you need to 
+name the key of the component, and pass it as the first of argument list, like:
+
+```ruby
+query! :QueryCompUuid, :product_uuid, Integer, ...
+```
+This writing is feasible but not recommended, 
+because component's key and parameter's name looks like the same level.
+The recommended writing is:
+
+```ruby
+query! :QueryCompUuid => [:product_uuid, Integer, ...]
+```
+The DSL methods used to generate the components in this block are: 
+(explained above)
+
+- param family methods (except `param_ref`)
+- request_body family methods (except `body_ref`)
+
+
+
+### Generate JSON Documentation File
+
+
+### Use Swagger-UI(Very Beautiful Web UI) to show your Documentation
+
+
+## Troubleshooting
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zhandao/zero-rails_openapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Zero-OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zhandao/zero-rails_openapi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "open_api"
+
+# 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(__FILE__)