zero-rails_openapi 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f02e4f2dff6974c8ea59e4e410e695f27d7395a417612003525ed6fa250c008a
-  data.tar.gz: 23e2eb595a89c71e3f417b295d107de43d9cf5e3af917329715d69fe42846a0f
+  metadata.gz: 66b3b5f0baadb63bbc86eee3a1fcfbaf7aae4e6c99accace8d67822416cedef9
+  data.tar.gz: 8352e7bd3a917060a60b080ad02f9104ae808c5e78d793cd6daa928fca9eb3b8
 SHA512:
-  metadata.gz: de28674280308d143a856a82cdc7fee995b1a506ac4b0342ff9721d3656637f87444c4ff69f4967e8a839e36598797e1559f41a02145c24bce8c823916bc1318
-  data.tar.gz: ccea172bdb47b90b97f423ac0d6a744e996de455c6fc1a82cf3ba22a12126978e0ff13278d8737ddc4f699065980fb755c2776bf6f98e695598ac74cba357619
+  metadata.gz: 54d9f088e61a36f5f7c838a0d4dedffb77d97dabf11fba8077b80af25cf7250ecaf0dd5ff494ab82ba2fdfd59dd3a7b2f4a8356ecbf33e773a6e24c5729d837e
+  data.tar.gz: 4674013106338919992c8d03ee59db6ff7158eaaec7f0aa8c4ee0ec97cbd47c41432aeda33bc7205edd27cb47e7a4554ef5eb4fcf5fb1e7f405dd4a79574c614

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased]
 
+## [1.6.1] - 2018/8/21 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.6.0...v1.6.1)
+
+## Fixed
+
+1. camelize action tag
+2. update gems cause sprockets vulnerability
+
 ## [1.6.0] - 2018/6/26 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.9...v1.6.0)
 
 ## Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zero-rails_openapi (1.6.0)
+    zero-rails_openapi (1.6.1)
       activesupport (>= 3)
       colorize
       rails (>= 3)
@@ -9,44 +9,48 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.6)
-      actionpack (= 5.1.6)
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
       nio4r (~> 2.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.1.6)
-      actionpack (= 5.1.6)
-      actionview (= 5.1.6)
-      activejob (= 5.1.6)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.1.6)
-      actionview (= 5.1.6)
-      activesupport (= 5.1.6)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.6)
-      activesupport (= 5.1.6)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.6)
-      activesupport (= 5.1.6)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
       globalid (>= 0.3.6)
-    activemodel (5.1.6)
-      activesupport (= 5.1.6)
-    activerecord (5.1.6)
-      activemodel (= 5.1.6)
-      activesupport (= 5.1.6)
-      arel (~> 8.0)
-    activesupport (5.1.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
+    arel (9.0.0)
     builder (3.2.3)
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
@@ -56,7 +60,7 @@ GEM
     erubi (1.7.1)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    i18n (1.0.0)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     loofah (2.2.2)
@@ -64,39 +68,43 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.0)
       mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
     method_source (0.9.0)
-    mini_mime (1.0.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nio4r (2.3.0)
-    nokogiri (1.8.2)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
-    rack (2.0.4)
-    rack-test (1.0.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.1.6)
-      actioncable (= 5.1.6)
-      actionmailer (= 5.1.6)
-      actionpack (= 5.1.6)
-      actionview (= 5.1.6)
-      activejob (= 5.1.6)
-      activemodel (= 5.1.6)
-      activerecord (= 5.1.6)
-      activesupport (= 5.1.6)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
       bundler (>= 1.3.0)
-      railties (= 5.1.6)
+      railties (= 5.2.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.1.6)
-      actionpack (= 5.1.6)
-      activesupport (= 5.1.6)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
+      thor (>= 0.19.0, < 2.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -116,7 +124,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    sprockets (3.7.1)
+    sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
@@ -127,7 +135,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
+    websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.3)
 
@@ -142,4 +150,4 @@ DEPENDENCIES
   zero-rails_openapi!
 
 BUNDLED WITH
-   1.16.1
+   1.16.3

data/README.md

@@ -697,7 +697,7 @@
 ### Trick1 - Write the DSL Somewhere Else
 
   Does your documentation take too many lines?  
-  Do you want to separate documentation from business controller to simplify both?  
+  Do you want to separate documentation from controller to simplify both?  
   Very easy! Just follow
 
   ```ruby
@@ -722,8 +722,14 @@
   end
   ```
 
-  Notes: file name ends in `_doc.rb` by default, but you can change via `Config.doc_location`
-  (it should be file paths, defaults to `./app/**/*_doc.rb`).
+  Explain: These four steps are necessary:
+  1. create a class, like ApiDoc, and make it include OpenApi::DSL (then it could be the base class for writing Api spec).
+  2. set the specified Api spec's base_doc_class to ApiDoc.
+  3. let your doc class (like V1::ExamplesDoc) inherit the base_doc_class (ApiDoc).
+  4. set the route_base (to route path api/v1/examples of that controller Api::V1::ExamplesController) inside V1::ExamplesDoc.
+  
+  Notes: file name ends in `_doc.rb` by default, but you can change it by setting `Config.doc_location`
+    (it should be file paths, defaults to `./app/**/*_doc.rb`).
 
 ### Trick2 - Global DRYing
 

data/lib/oas_objs/response_obj.rb

@@ -13,7 +13,8 @@ module OpenApi
         self.processed   = { description: desc }
       end
 
-      def add_or_fusion(media_type, hash)
+      def add_or_fusion(desc, media_type, hash)
+        self.processed[:description] = desc if desc.present?
         media_types << MediaTypeObj.new(media_type, hash)
         self
       end

data/lib/open_api/dsl/common_dsl.rb

@@ -29,7 +29,7 @@ module OpenApi
       # `code`: when defining components, `code` means `component_key`
       def response code, desc, media_type = nil, data: { }, type: nil
         self[:responses][code] = ResponseObj.new(desc) unless (self[:responses] ||= { })[code].is_a?(ResponseObj)
-        self[:responses][code].add_or_fusion(media_type, { data: type || data })
+        self[:responses][code].add_or_fusion(desc, media_type, { data: type || data })
       end
 
       alias_method :resp,  :response

data/lib/open_api/dsl.rb

@@ -42,7 +42,7 @@ module OpenApi
         return puts '    ZRO'.red + " Route mapping failed: #{action_path}" if routes.blank?
 
         api = Api.new(action_path, skip: Array(skip), use: Array(use))
-                 .merge! description: '', summary: summary, operationId: id || "#{@doc_info[:tag][:name]}_#{action}",
+                 .merge! description: '', summary: summary, operationId: id || "#{@doc_info[:tag][:name]}#{action.capitalize}",
                          tags: [@doc_tag], parameters: [ ], requestBody: '',  responses: { },  callbacks: { },
                          links: { }, security: [ ], servers: [ ]
         [action, :all].each { |blk_key| @zro_dry_blocks&.[](blk_key)&.each { |blk| api.instance_eval(&blk) } }

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.6.0'
+  VERSION = '1.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Concise DSL for generating OpenAPI3 documentation.