zero-rails_openapi 2.1.0 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1945a762cf400f52a4fbc222c7cd10e6fed4937e3d4afcb9357e4e030edf349
-  data.tar.gz: f6b25115dd788832d34e5f83e4b216c49381367b80e0ae1c33a65fa964726b0d
+  metadata.gz: a8d4c7ad77acde6b60064c24b5e9526d8182ee3d9580dd720b4781b67d64b8a9
+  data.tar.gz: f0697e6dfe1ce02e4427676f7f604d937685ab1a26876a3d3b2093069d13dc6e
 SHA512:
-  metadata.gz: 56e62cdd21432ee8394ca955ca63498a9e198da18c553f30fa35840fad8219afc599bccb25e71a1c6565e513be26c3a2422c4e08c51b1e51ab48edd31423d813
-  data.tar.gz: ce16f8ad8b4f83cdf5c7cbc4106b0f81354790a8febdeea0bf19b598f594e77505921260e832b6bf40f807ce580c9bef8c494b95c54de6d6d788e52c5032ef93
+  metadata.gz: 0cc748c545feebc6d0888594b99068279e18a17e32cd67297300d1147799319741c7fc8c1bdbefaca73b466f9ecb51b4eec15c0c91b43262e27776393cda0245
+  data.tar.gz: f09fa8f370ca5d7a16baa8c9fc7525ba1e2ecb224f7fe97fbf4233813610242e3f74abc083d2c5a80dba08fa86ad5646ffc9ae08cc9035227ca2d8840deab976

data/.travis.yml

@@ -1,8 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.16.0.pre.2
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4
 env:
   global:
     - CC_TEST_REPORTER_ID=fd0a238819079b92c19e99f5f4d6dcc8a5b5b2baf087fceb3723837604b5b0e9

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## [Unreleased]
 
+## [2.1.5] - 2020/9/20 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v2.1.4...v2.1.5)
+
+### Fixed
+
+1. Keyword arguments in Ruby 2.7 [issued by @dandunckelman](https://github.com/zhandao/zero-rails_openapi/issues/66)
+
+## [2.1.3 - 2.1.4] - 2020/2/10 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v2.1.2...v2.1.4)
+
+### Fixed
+
+1. Fix response HTTP Status Code's type, restrict to String [issued by @am17torres](https://github.com/zhandao/zero-rails_openapi/issues/60)
+
+### Added
+
+1. Configurable additionalProperties's default value of Object type [issued by @remuspoienar](https://github.com/zhandao/zero-rails_openapi/issues/61)
+
+## [2.1.1 - 2.1.2] - 2019/2/12 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v2.1.0...v2.1.2)
+
+### Fixed
+
+1. Fix response header schema output [PR #49 by @drjonnicholson](https://github.com/zhandao/zero-rails_openapi/pull/49)
+2. Fix router formatter in Rails 6 [PR #53 by @rjayroach](https://github.com/zhandao/zero-rails_openapi/pull/53)
+3. Support for generating `additional_properties: true` [issued by @bopm](https://github.com/zhandao/zero-rails_openapi/issues/55)
+
 ## [2.1.0] - 2019/2/16 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v2.0.3...v2.1.0)
 
 See: [PR #43](https://github.com/zhandao/zero-rails_openapi/pull/43)

data/README.md

@@ -121,6 +121,20 @@
 
 ### Part 2: config (DSL) for generating OpenApi info
 
+  ```ruby
+  # 1. open_api
+  #   base_doc_classes should be an array of base classes of the classes you write the OpenApi spec in, 
+  #   like [ActionController::Base] (if you write spec in controllers).
+  open_api doc_name, base_doc_classes: []
+  
+  # 2. info
+  info version:, title:, desc: '', **addition
+  
+  # 3. server
+  # 4. security_scheme / base_auth / bearer_auth / api_key
+  # 5. global_security_require
+  ```
+
   See all the DSLs: [config_dsl.rb](lib/open_api/config_dsl.rb)
 
 ## DSL Usage
@@ -132,12 +146,12 @@
 ### First of all, `include OpenApi::DSL` in your base class (which is for writing spec):
 
   For example:
-    ```ruby
-    # in app/controllers/api/api_controller.rb
-    class ApiController < ActionController::API
-      include OpenApi::DSL
-    end
-    ```
+  ```ruby
+  # in app/controllers/api/api_controller.rb
+  class ApiController < ActionController::API
+    include OpenApi::DSL
+  end
+  ```
 
 ### DSL Usage Example
 
@@ -238,7 +252,7 @@
   end
   ```
   
-  And then you should call `dry` method ([detailed info]()) for executing the declared dry blocks:
+  And then you should call `dry` method ([detailed info](#9-dry)) for executing the declared dry blocks:
   ```ruby
   api :index do
     dry
@@ -452,10 +466,11 @@
 
   ```ruby
   # ** Method Signature
-  response code, desc, media_type = nil, data: { }, **options
+  response code, desc, media_type = nil, headers: { }, data: { }, **options
   # ** Usage
   resp 200, 'success', :json, data: { name: 'test' }
   response 200, 'query result', :pdf, data: File
+  response :success, 'succ', :json, headers: { 'X-Request-Start': String }, data: { }
 
   # ** Method Signature
   response_ref code_and_compkey_hash

data/lib/oas_objs/header_obj.rb

@@ -16,8 +16,7 @@ module OpenApi
       end
 
       def process
-        schema.process
-        processed.merge!(schema: schema)
+        processed.merge!(schema: schema.process)
       end
     end
   end

data/lib/oas_objs/media_type_obj.rb

@@ -7,21 +7,22 @@ module OpenApi
   module DSL
     # https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#media-type-object
     class MediaTypeObj < Hash
-      attr_accessor :media_type, :schema, :examples
+      attr_accessor :media_type, :schema, :examples, :example
 
-      def initialize(media_type, hash)
-        examples_hash   = hash.delete(:examples)
-        exp_params      = schema_type.keys if (exp_params = hash.delete(:exp_params)) == :all
-        self.examples   = ExampleObj.new(examples_hash, exp_params, multiple: true) if examples_hash.present?
+      def initialize(media_type, example: nil, examples: nil, exp_params: nil, **media_hash)
+        schema_type     = media_hash.values_at(:type, :data).compact.first
+        exp_params      = schema_type.keys if exp_params == :all
+        self.examples   = ExampleObj.new(examples, exp_params, multiple: true) if examples.present?
+        self.example    = ExampleObj.new(example) if example.present?
         self.media_type = media_type_mapping(media_type)
-        self.schema     = SchemaObj.new(hash.values_at(:type, :data).compact.first,
-                                        hash.except(:type, :data))
+        self.schema     = SchemaObj.new(schema_type, media_hash.except(:type, :data))
       end
 
       def process
         return { } if media_type.nil?
         schema_processed = schema.process
         result = schema_processed.values.join.blank? ? { } : { schema: schema_processed }
+        result[:example] = example.process unless example.nil?
         result[:examples] = examples.process unless examples.nil?
         { media_type => result }
       end

data/lib/oas_objs/request_body_obj.rb

@@ -18,7 +18,7 @@ module OpenApi
       end
 
       def absorb(media_type, hash)
-        media_types << MediaTypeObj.new(media_type, hash)
+        media_types << MediaTypeObj.new(media_type, **hash)
         self
       end
 

data/lib/oas_objs/response_obj.rb

@@ -20,7 +20,7 @@ module OpenApi
       def absorb(desc, media_type, headers: { }, **media_hash)
         self.processed[:description] = desc if desc.present?
         self.headers.merge!(headers)
-        media_types << MediaTypeObj.new(media_type, media_hash)
+        media_types << MediaTypeObj.new(media_type, **media_hash)
         self
       end
 

data/lib/oas_objs/schema_obj.rb

@@ -46,7 +46,7 @@ module OpenApi
           { type: 'string', format: Config.file_format }
         elsif t == 'datetime'
           { type: 'string', format: 'date-time' }
-        elsif t[/\{=>.*\}/]
+        elsif t[/{=>.*}/]
           self[:values_type] = t[3..-2]
           { type: 'object' }
         else # other string
@@ -55,10 +55,12 @@ module OpenApi
       end
 
       def additional_properties
-        return if processed[:type] != 'object' || _addProp.nil?
-        {
-            additionalProperties: SchemaObj.new(_addProp, { }).process
-        }
+        return if processed[:type] != 'object'
+        default = Config.additional_properties_default_value_of_type_object
+        return { additionalProperties: default } if _addProp.nil? && !default.nil?
+
+        value = _addProp.in?([true, false]) ? _addProp : SchemaObj.new(_addProp, { }).process
+        { additionalProperties: value }
       end
 
       def enum

data/lib/open_api.rb

@@ -50,7 +50,7 @@ module OpenApi
   def init_hash(doc_name)
     settings = Config.docs[doc_name]
     doc = { openapi: '3.0.0', **settings.slice(:info, :servers) }.merge!(
-        security: settings[:global_security], tags: [ ], paths: { },
+        security: settings[:global_security] || [], tags: [ ], paths: { },
         components: {
             securitySchemes: settings[:securitySchemes] || { },
             schemas: { }, parameters: { }, requestBodies: { }

data/lib/open_api/config.rb

@@ -24,6 +24,8 @@ module OpenApi
 
     cattr_accessor(:file_format) { 'binary' }
 
+    cattr_accessor(:additional_properties_default_value_of_type_object) { nil }
+
     def self.docs
       open_api_docs
     end

data/lib/open_api/dsl/api.rb

@@ -96,14 +96,14 @@ module OpenApi
       end
 
       def response code, desc, media_type = nil, headers: { }, data: { }, **options
-        (self[:responses][code] ||= ResponseObj.new(desc)).absorb(desc, media_type, headers: headers, data: data, **options)
+        (self[:responses][code.to_s] ||= ResponseObj.new(desc)).absorb(desc, media_type, headers: headers, data: data, **options)
       end
 
       alias_method :resp,  :response
       alias_method :error, :response
 
       def response_ref code_and_compkey # = { }
-        code_and_compkey.each { |code, component_key| self[:responses][code] = RefObj.new(:response, component_key) }
+        code_and_compkey.each { |code, component_key| self[:responses][code.to_s] = RefObj.new(:response, component_key) }
       end
 
       def security_require scheme_name, scopes: [ ]

data/lib/open_api/dsl/helpers.rb

@@ -31,7 +31,7 @@ module OpenApi
 
       def process_schema_input(schema_type, schema, name, model: nil)
         schema = { type: schema } unless schema.is_a?(Hash)
-        combined_schema = _combined_schema(schema)
+        combined_schema = _combined_schema(**schema)
         type = schema[:type] ||= schema_type
         return Tip.param_no_type(name) if type.nil? && combined_schema.nil?
         combined_schema || SchemaObj.new(type, load_schema(model) || schema)
@@ -46,7 +46,12 @@ module OpenApi
       def arrow_writing_support
         proc do |args, executor|
           args = (args.size == 1 && args.first.is_a?(Hash)) ? args[0].to_a.flatten : args
-          send(executor, *args)
+
+          if !executor.in?(%w[ _example _security_scheme _base_auth _bearer_auth ]) && args.last.is_a?(Hash)
+            send(executor, *args[0..-2], **args[-1])
+          else
+            send(executor, *args)
+          end
         end
       end
 

data/lib/open_api/router.rb

@@ -15,7 +15,11 @@ module OpenApi
             all_routes = Rails.application.routes.routes
             require 'action_dispatch/routing/inspector'
             inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
-            inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, nil)
+            if Rails::VERSION::MAJOR < 6
+              inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, nil)
+            else
+              inspector.format(ActionDispatch::Routing::ConsoleFormatter::Sheet.new)
+            end
             # :nocov:
           end
     end

data/lib/open_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenApi
-  VERSION = '2.1.0'
+  VERSION = '2.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.5
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -188,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Concise DSL for generating OpenAPI3 documentation.