zero-rails_openapi 1.5.6 → 1.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec6a3ea12a29b24fa6b0ebcedb7ce02ba8e61d9
-  data.tar.gz: 05c67721c53cbdd173068f1ae9df0d629d97e3aa
+  metadata.gz: ed64dbbb343efdc64e8ea606b49e5363f6fcc04a
+  data.tar.gz: f6914e5543de926f5672710f9247ccb3b1c1bdbc
 SHA512:
-  metadata.gz: 660c9cbc7567fa48f70fe3be7638f221a8c0be88ca3c7ea487d7d12535bc155e8a28834ea7577dfb77d1b9161eacc79a05dc702d2d23913b261512a6e6576a3e
-  data.tar.gz: 30f0533d1fcdbb05392152f9f742e31501fc196076e946485d679ecd831e280bfaacfc4a33907702c28286e32582f40bb27edadf212bca218b2b613969e793e2
+  metadata.gz: 6308ca2b74eee6cd14d2a828eaed6c4591ffd2496e115c1e2c1d0807f7c70b457965f7146738efdb430740eb7a3f95d7fe0991060b4ca2531e18037c14547d5f
+  data.tar.gz: 290fcb45ceb1f876ea4b3f20ccdfd4f056be1a5e18a6e534bef63e8d7a7d217e513872ec3bbed827748d2bd258bae69af455102f6dda5a870797a87981c4286c

data/CHANGELOG.md

@@ -2,11 +2,22 @@
 
 ## [Unreleased]
 
+## [1.5.7] - 2018/4/6 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.6...v1.5.7)
+
+## Changed
+
+1. issue [#16](#https://github.com/zhandao/zero-rails_openapi/issues/16) DSL in `base_doc_class` can not be generated.
+
+## Fixed
+
+1. issue [#15](#https://github.com/zhandao/zero-rails_openapi/issues/15) colorize was not required.
+2. securitySchemes defined by config DSL was not be generated.
+
 ## [1.5.6] - 2018/3/23 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.5...v1.5.6)
 
 ## Changed
 
-1. Update `loofah` and `rails-html-sanitizer` cause XSS vulnerability.
+1. Upgrade `loofah` and `rails-html-sanitizer` cause XSS vulnerability.
 2. Refactor and document DSL for Rspec (spec_dsl.rb).
 
 ## [1.5.5] - 2018/2/21 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.4...v1.5.5)

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    zero-rails_openapi (1.5.6)
+    zero-rails_openapi (1.5.7)
       activesupport (>= 3)
-      colorize (= 0.8.1)
+      colorize
       rails (>= 3)
 
 GEM
@@ -53,7 +53,7 @@ GEM
     crass (1.0.3)
     diff-lcs (1.3)
     docile (1.3.0)
-    erubi (1.7.0)
+    erubi (1.7.1)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
     i18n (0.9.5)
@@ -68,11 +68,11 @@ GEM
     mini_mime (1.0.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nio4r (2.2.0)
+    nio4r (2.3.0)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     rack (2.0.4)
-    rack-test (0.8.2)
+    rack-test (0.8.3)
       rack (>= 1.0, < 3)
     rails (5.1.5)
       actioncable (= 5.1.5)

data/README.md

@@ -6,12 +6,24 @@
   [![Test Coverage](https://api.codeclimate.com/v1/badges/471fd60f6eb7b019ceed/test_coverage)](https://codeclimate.com/github/zhandao/zero-rails_openapi/test_coverage)
 
   Concise DSL for generating OpenAPI Specification 3 (**OAS3**, formerly Swagger3) JSON documentation for Rails application.
+  
+  ```ruby
+  class Api::ExamplesController < ApiController
+    api :update, 'POST update some thing' do
+      path  :id, Integer
+      query :token, String, desc: 'api token', length: 16
+      form data: { phone: String }
+    end
+  end
+  ```
 
 ## Contributing
 
   **Hi, here is ZhanDao = ▽ =  
   It may be a very useful tool if you want to write API document clearly.  
   I'm looking forward to your issue and PR!**
+  
+  [Need Help](https://github.com/zhandao/zero-rails_openapi/issues/14)
 
   If you have any questions, please read the test code first.  
   such as [api DSL](spec/api_spec.rb) and [schema Obj](spec/oas_objs/schema_obj_spec.rb).

data/lib/open_api/dsl.rb

@@ -1,5 +1,6 @@
 require 'open_api/dsl/api'
 require 'open_api/dsl/components'
+require 'colorize'
 
 module OpenApi
   module DSL

data/lib/open_api/generator.rb

@@ -1,5 +1,6 @@
 require 'active_support/hash_with_indifferent_access'
 require 'open_api/config'
+require 'colorize'
 
 module OpenApi
   module Generator
@@ -27,11 +28,12 @@ module OpenApi
         doc = { openapi: '3.0.0', **settings.slice(:info, :servers) }.merge!(
                 security: settings[:global_security], tags: [ ], paths: { },
                 components: {
-                    securitySchemes: { }, schemas: { }, parameters: { }, requestBodies: { }
-                }.merge!(settings[:components] || { })
+                    securitySchemes: settings[:securitySchemes] || { },
+                    schemas: { }, parameters: { }, requestBodies: { }
+                }
               )
 
-        settings[:base_doc_class].descendants.each do |ctrl|
+        [(bdc = settings[:base_doc_class]), *bdc.descendants].each do |ctrl|
           doc_info = ctrl.instance_variable_get('@doc_info')
           next if doc_info.nil?
 

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.5.6'
+  VERSION = '1.5.7'
 end

data/zero-rails_openapi.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
 
-  spec.add_runtime_dependency 'colorize', '0.8.1'
+  spec.add_runtime_dependency 'colorize'
   spec.add_runtime_dependency 'activesupport', '>= 3'
   spec.add_runtime_dependency 'rails', '>= 3'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.5.7
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement