zero-rails_openapi 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fab58d6a912611eb51d9d86bc69401c5feb70f06
-  data.tar.gz: 2aa24ae7d92823d075cbb21acf09949e365d13ab
+  metadata.gz: 5f96bf52633bfd7fe91394003f64571c24bfc4ad
+  data.tar.gz: f44d8713d0691eacd66ae9a5ff62f90f21b97595
 SHA512:
-  metadata.gz: c321e853c95bad0cc5324c9719b3e610c54b2bd4bb18190b2876d091a115b3d90f3b6450645684606ae295c230ab700bca3fa7461fc40a057753376ab6651a02
-  data.tar.gz: 4e273a9871cd4e8078bad7cc56a7c6b5e6e40a26825f00e57cc28783d61cf49d7557829b76b7a55e6c3fd3297efc0b1bd124a6237685c4002599812ce55814bb
+  metadata.gz: 9ad13a356350c385963ac5a62233afc6f4a182360b6684e2536782ffaadb86d4458112844ec44eff8055adf5c1957c2dd2ac92b32c906445c221de17693aa34a
+  data.tar.gz: 1dc8b8bb3002a33ac62ab4016fb2359e72a4ce1e43b378c520cf3dbd40dd43227162e43a31801ef824a02323b1fbe5c9f9cdeb51cfe42cb6ee7ba6d3cc174cab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zero-rails_openapi (1.4.1)
+    zero-rails_openapi (1.4.2)
       activesupport (>= 3)
       rails (>= 3)
 
@@ -58,10 +58,12 @@ GEM
     loofah (2.1.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.0)
-      mini_mime (>= 0.1.1)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
     method_source (0.9.0)
-    mini_mime (1.0.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
     mini_portile2 (2.3.0)
     minitest (5.10.3)
     nio4r (2.1.0)
@@ -120,7 +122,7 @@ GEM
       thread_safe (~> 0.1)
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -3,6 +3,7 @@
   [![Gem Version](https://badge.fury.io/rb/zero-rails_openapi.svg)](https://badge.fury.io/rb/zero-rails_openapi)
   [![Build Status](https://travis-ci.org/zhandao/zero-rails_openapi.svg?branch=master)](https://travis-ci.org/zhandao/zero-rails_openapi)
   [![Maintainability](https://api.codeclimate.com/v1/badges/471fd60f6eb7b019ceed/maintainability)](https://codeclimate.com/github/zhandao/zero-rails_openapi/maintainability)
+  [![Gitter Chat](https://badges.gitter.im/zero-rails_openapi/Lobby.svg)](https://gitter.im/zero-rails_openapi/Lobby)
   
   Concise DSL for generating OpenAPI Specification 3 (**OAS3**, formerly Swagger3) JSON documentation for Rails application, 
   then you can use Swagger UI 3.2.0+ to show the documentation.

data/README_zh.md

@@ -3,6 +3,7 @@
   [![Gem Version](https://badge.fury.io/rb/zero-rails_openapi.svg)](https://badge.fury.io/rb/zero-rails_openapi)
   [![Build Status](https://travis-ci.org/zhandao/zero-rails_openapi.svg?branch=master)](https://travis-ci.org/zhandao/zero-rails_openapi)
   [![Maintainability](https://api.codeclimate.com/v1/badges/471fd60f6eb7b019ceed/maintainability)](https://codeclimate.com/github/zhandao/zero-rails_openapi/maintainability)
+  [![Gitter Chat](https://badges.gitter.im/zero-rails_openapi/Lobby.svg)](https://gitter.im/zero-rails_openapi/Lobby)
   
   一套简洁的 DSL，用于为 Rails 应用生成 OpenAPI Specification 3 (**OAS3**, 旧称「Swagger3」) 标准的 JSON 文档。  
   （你还可以使用 Swagger-UI 3.2.0 以上版本来可视化所生成的文档。）

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "open_api"
+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.
@@ -10,5 +10,5 @@ require "open_api"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/documentation/examples/auto_gen_doc.rb

@@ -51,20 +51,17 @@ module AutoGenDoc
           model = Object.const_get(action_path.split('#').first.split('/').last[0..-2].camelize) rescue nil
           type = action.in?(%w[ index show ]) ? Array[load_schema(model)] : String
           response '200', 'success', :json, type: {
-              code:      { type: Integer, dft: 200 },
-              msg:       { type: String,  dft: 'success' },
-              total:     { type: Integer },
-              timestamp: { type: Integer },
-              language:  { type: String, dft: 'Ruby' },
-              data:      { type: type }
+              code: { type: Integer, dft: 200 },
+               msg: { type: String,  dft: 'success' },
+              data: { type: type }
           }
 
 
           ### Automatically generate responses based on the agreed error class.
           #   The business error-class's implementation see:
-          #     https://github.com/zhandao/zero-rails/blob/master/lib/business_error/z_error.rb
+          #     https://github.com/zhandao/zero-rails/blob/master/lib/business_error/dsl.rb
           #   It's usage see:
-          #     https://github.com/zhandao/zero-rails/blob/master/app/controllers/api/v1/base_controller.rb
+          #     https://github.com/zhandao/zero-rails/blob/master/app/_docs/api_error.rb
           #   Then, the following code will auto generate error responses by
           #     extracting the specified error classes info, for example,
           #     in ExamplesError: `mattr_reader :name_not_found, 'can not find the name', 404`

data/lib/oas_objs/schema_obj.rb

@@ -11,9 +11,10 @@ module OpenApi
       include SchemaObjHelpers
       include Helpers
 
-      attr_accessor :processed, :type
+      attr_accessor :processed, :type, :preprocessed
 
       def initialize(type, schema_hash)
+        self.preprocessed = false
         self.processed = { }
         # [Note] Here is no limit to type, even if the input isn't up to OAS,
         #          like: double, float, hash.
@@ -51,7 +52,7 @@ module OpenApi
       def preprocess_with_desc desc, param_name = nil
         self.__desc = desc
         process_for param_name
-        @preprocessed = true
+        self.preprocessed = true
         __desc
       end
 

data/lib/open_api/config.rb

@@ -23,7 +23,7 @@ module OpenApi
     end
 
     cattr_accessor :active_record_base do
-      ApplicationRecord
+      nil
     end
 
     # Everything about OAS3 is on https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md
@@ -55,18 +55,6 @@ module OpenApi
       'binary'
     end
 
-    cattr_accessor :generate_jbuilder_file do
-      false
-    end
-
-    cattr_accessor :overwrite_jbuilder_file do
-      false
-    end
-
-    cattr_accessor :jbuilder_templates do
-      { }
-    end
-
     def self.docs
       open_api_docs
     end

data/lib/open_api/dsl/components.rb

@@ -8,18 +8,19 @@ module OpenApi
 
       def schema component_key, type = nil, one_of: nil, all_of: nil, any_of: nil, not: nil, **schema_hash
         (schema_hash = type) and (type = type.delete(:type)) if type.is_a?(Hash) && type.key?(:type)
-        type = schema_hash[:type] if type.nil?
-        type = load_schema component_key if component_key.try(:superclass) == Config.active_record_base && type.nil?
+        type ||= schema_hash[:type]
+        type ||= load_schema component_key if component_key.try(:superclass) == Config.active_record_base || ApplicationRecord
 
-        combined_schema = one_of || all_of || any_of || (_not = binding.local_variable_get(:not))
+        combined_schema = (_not = binding.local_variable_get(:not)) || one_of || all_of || any_of
         combined_schema = CombinedSchema.new(one_of: one_of, all_of: all_of, any_of: any_of, _not: _not) if combined_schema
         (self[:schemas] ||= { })[component_key.to_s.to_sym] = combined_schema&.process || SchemaObj.new(type, schema_hash).process
       end
       arrow_enable :schema
 
-      def example summary, example_hash
-        # TODO
+      def example component_key, examples_hash
+        (self[:examples] ||= { })[component_key] = ExampleObj.new(examples_hash).process
       end
+      arrow_enable :example
 
       def param component_key, param_type, name, type, required, schema_hash = { }
         (self[:parameters] ||= { })[component_key] = ParamObj.new(name, param_type, type, required, schema_hash).process
@@ -60,15 +61,18 @@ module OpenApi
       def base_auth scheme_name, other_info = { }
         security_scheme scheme_name, { type: 'http', scheme: 'basic' }.merge(other_info)
       end
+      arrow_enable :base_auth
 
       def bearer_auth scheme_name, format = 'JWT', other_info = { }
         security_scheme scheme_name, { type: 'http', scheme: 'bearer', bearerFormat: format }.merge(other_info)
       end
+      arrow_enable :bearer_auth
 
       def api_key scheme_name, field:, in:, **other_info
         _in = binding.local_variable_get(:in)
         security_scheme scheme_name, { type: 'apiKey', name: field, in: _in }.merge(other_info)
       end
+      arrow_enable :api_key
 
       def _process_objs
         self[:responses]&.each do |code, obj|

data/lib/open_api/generator.rb

@@ -27,7 +27,7 @@ module OpenApi
                 security: settings[:global_security], tags: [ ], paths: { },
                 components: {
                     securitySchemes: { }, schemas: { }, parameters: { }, requestBodies: { }
-                }.merge(settings[:components])
+                }.merge(settings[:components] || { })
               )
 
         settings[:root_controller].descendants.each do |ctrl|

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.4.1'
+  VERSION = '1.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Concise DSL for generating OpenAPI3 documentation.