Merge remote-tracking branch 'aadi/aadi/oas3' into oas3

Author: krasnoukhov

lib/rspec_api_documentation.rb

@@ -54,25 +54,27 @@ module Writers
   module OpenApi
     extend ActiveSupport::Autoload
 
+    autoload :Components
+    autoload :Contact
+    autoload :ExternalDocs
+    autoload :Flow
+    autoload :Header
     autoload :Helper
-    autoload :Node
-    autoload :Root
     autoload :Info
-    autoload :Contact
     autoload :License
-    autoload :Paths
-    autoload :Path
-    autoload :Tag
+    autoload :Media
+    autoload :Node
     autoload :Operation
     autoload :Parameter
-    autoload :Responses
+    autoload :Path
+    autoload :RequestBody
     autoload :Response
-    autoload :Example
-    autoload :Headers
-    autoload :Header
+    autoload :Root
     autoload :Schema
-    autoload :SecurityDefinitions
-    autoload :SecuritySchema
+    autoload :SecurityScheme
+    autoload :Server
+    autoload :Tag
+    autoload :Variable
   end
 
   module Views

lib/rspec_api_documentation/open_api/components.rb

@@ -0,0 +1,13 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Components < Node
+      add_setting :schemas, :schema => { '' => Schema }
+      add_setting :responses, :schema => { '' => Response }
+      add_setting :parameters, :schema => { '' => Parameter }
+      add_setting :headers, :schema => { '' => Header }
+      add_setting :securitySchemes, :schema => { '' => SecurityScheme }
+      add_setting :links
+      add_setting :callbacks
+    end
+  end
+end

lib/rspec_api_documentation/open_api/example.rb

@@ -0,0 +1,8 @@
+module RspecApiDocumentation
+  module OpenApi
+    class ExternalDocs < Node
+      add_setting :description
+      add_setting :url, :required => true
+    end
+  end
+end

lib/rspec_api_documentation/open_api/external_docs.rb

@@ -0,0 +1,10 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Flow < Node
+      add_setting :authorizationUrl, :required => true
+      add_setting :tokenUrl, :required => true
+      add_setting :refreshUrl
+      add_setting :scopes, :required => true
+    end
+  end
+end

lib/rspec_api_documentation/open_api/flow.rb

@@ -2,11 +2,16 @@ module RspecApiDocumentation
   module OpenApi
     class Header < Node
       add_setting :description
-      add_setting :type, :required => true, :default => lambda { |header|
-        Helper.extract_type(header.public_send('x-example-value'))
-      }
-      add_setting :format
-      add_setting 'x-example-value'
+      add_setting :required
+      add_setting :deprecated
+      # add_setting :allowEmptyValue
+      # add_setting :style
+      # add_setting :explode
+      # add_setting :allowReserved
+      add_setting :schema, :schema => Schema
+      add_setting :example
+      # add_setting :examples, :schema => { '' => Example }
+      # add_setting :content, :schema => { '' => Media }
     end
   end
 end

lib/rspec_api_documentation/open_api/header.rb

@@ -16,7 +16,7 @@ def extract_type(value)
       end
 
       def extract_items(value, opts = {})
-        result = {type: extract_type(value)}
+        result = { type: extract_type(value) }
         if result[:type] == :array
           result[:items] = extract_items(value[0], opts)
         else

lib/rspec_api_documentation/open_api/headers.rb

@@ -0,0 +1,10 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Media < Node
+      add_setting :schema, :schema => Schema
+      add_setting :example
+      # add_setting :examples, :schema => { '' => Example }
+      # add_setting :encoding, :schema => { '' => Encoding }
+    end
+  end
+end

lib/rspec_api_documentation/open_api/helper.rb

@@ -1,12 +1,6 @@
 module RspecApiDocumentation
   module OpenApi
     class Node
-      # this is used to define class of incoming option attribute
-      # If +false+ then do not create new setting
-      # If +true+ then create new setting with raw passed value
-      # If RspecApiDocumentation::OpenApi::Node then create new setting and wrap it in this class
-      CHILD_CLASS = false
-
       # This attribute allow us to hide some of children through configuration file
       attr_accessor :hide
 
@@ -36,14 +30,15 @@ def initialize(opts = {})
         opts.each do |name, value|
           if name.to_s == 'hide'
             self.hide = value
-          elsif self.class::CHILD_CLASS
-            add_setting name, :value => self.class::CHILD_CLASS === true ? value : self.class::CHILD_CLASS.new(value)
           elsif setting_exist?(name.to_sym)
             schema = setting_schema(name)
             converted =
-              case
-              when schema.is_a?(Array) && schema[0] <= Node then value.map { |v| v.is_a?(schema[0]) ? v : schema[0].new(v) }
-              when schema <= Node then value.is_a?(schema) ? value : schema.new(value)
+              if schema.is_a?(Hash) && schema.values[0] <= Node
+                Hash[value.map { |k, v| [k, v.is_a?(schema.values[0]) ? v : schema.values[0].new(v)] }]
+              elsif schema.is_a?(Array) && schema[0] <= Node
+                value.map { |v| v.is_a?(schema[0]) ? v : schema[0].new(v) }
+              elsif schema <= Node
+                value.is_a?(schema) ? value : schema.new(value)
               else
                 value
               end
@@ -69,7 +64,13 @@ def add_setting(name, opts = {})
         settings[name] = opts[:value] if opts[:value]
 
         define_singleton_method("#{name}_schema") { opts[:schema] || NilClass }
-        define_singleton_method("#{name}=") { |value| settings[name] = value }
+        define_singleton_method("#{name}=") do |value|
+          if setting[name].is_a?(Hash) && value.is_a?(Hash)
+            value.each { |k, v| setting[name][k] = setting[name][k] ? setting[name][k].merge(v) : v }
+          else
+            settings[name] = value
+          end
+        end
         define_singleton_method("#{name}") do
           if settings.has_key?(name)
             settings[name]
@@ -94,6 +95,8 @@ def as_json
           when value.is_a?(Array) && value[0].is_a?(Node)
             tmp = value.select { |v| !v.hide }.map { |v| v.as_json }
             hash[name] = tmp unless tmp.empty?
+          when value.is_a?(Hash) && value.values[0].is_a?(Node)
+            hash[name] = Hash[value.select { |k, v| !v.hide }.map { |k, v| [k, v.as_json] }]
           else
             hash[name] = value
           end unless value.nil?

lib/rspec_api_documentation/open_api/media.rb

@@ -4,15 +4,14 @@ class Operation < Node
       add_setting :tags, :default => []
       add_setting :summary
       add_setting :description
-      add_setting :externalDocs
-      add_setting :operationId
-      add_setting :consumes
-      add_setting :produces
+      add_setting :externalDocs, :schema => ExternalDocs
+      # add_setting :operationId
       add_setting :parameters, :default => [], :schema => [Parameter]
-      add_setting :responses, :required => true, :schema => Responses
-      add_setting :schemes
+      add_setting :requestBody, :schema => RequestBody
+      add_setting :responses, :required => true, :schema => { '' => Response }
       add_setting :deprecated, :default => false
       add_setting :security
+      # add_setting :servers, :schema => [Server]
     end
   end
 end

lib/rspec_api_documentation/open_api/node.rb

@@ -1,24 +1,19 @@
 module RspecApiDocumentation
   module OpenApi
     class Parameter < Node
-      # Required to write example values to description of parameter when option `with_example: true` is provided
-      attr_accessor :value
-      attr_accessor :with_example
-
       add_setting :name, :required => true
       add_setting :in, :required => true
       add_setting :description
-      add_setting :required, :default => lambda { |parameter| parameter.in.to_s == 'path' ? true : false }
-      add_setting :schema
-      add_setting :type
-      add_setting :items
-      add_setting :default
-      add_setting :minimum
-      add_setting :maximum
-      add_setting :enum
-      add_setting :example, :default => lambda { |parameter| parameter.with_example ? parameter.value : nil }
-
-      alias_method :description_without_example, :description
+      add_setting :required, :default => lambda { |parameter| parameter.in.to_s == 'path' }
+      add_setting :deprecated
+      # add_setting :allowEmptyValue
+      # add_setting :style
+      # add_setting :explode
+      # add_setting :allowReserved
+      add_setting :schema, :schema => Schema
+      add_setting :example
+      # add_setting :examples, :schema => { '' => Example }
+      # add_setting :content, :schema => { '' => Media }
     end
   end
 end

lib/rspec_api_documentation/open_api/operation.rb

@@ -8,6 +8,7 @@ class Path < Node
       add_setting :options, :schema => Operation
       add_setting :head, :schema => Operation
       add_setting :patch, :schema => Operation
+      add_setting :trace, :schema => Operation
     end
   end
 end

lib/rspec_api_documentation/open_api/parameter.rb

@@ -0,0 +1,9 @@
+module RspecApiDocumentation
+  module OpenApi
+    class RequestBody < Node
+      add_setting :description, :default => 'body'
+      add_setting :content, :required => true, :schema => { '' => Media }
+      add_setting :required, :default => false
+    end
+  end
+end

lib/rspec_api_documentation/open_api/path.rb

@@ -2,9 +2,9 @@ module RspecApiDocumentation
   module OpenApi
     class Response < Node
       add_setting :description, :required => true, :default => 'Successful operation'
-      add_setting :schema, :schema => Schema
-      add_setting :headers, :schema => Headers
-      add_setting :examples, :schema => Example
+      add_setting :headers, :schema => { '' => Header }
+      add_setting :content, :schema => { '' => Media }
+      # add_setting :links
     end
   end
 end

lib/rspec_api_documentation/open_api/paths.rb

@@ -1,21 +1,14 @@
 module RspecApiDocumentation
   module OpenApi
     class Root < Node
-      add_setting :swagger, :default => '2.0', :required => true
+      add_setting :openapi, :default => '3.0.0', :required => true
       add_setting :info, :default => Info.new, :required => true, :schema => Info
-      add_setting :host, :default => 'localhost:3000'
-      add_setting :basePath
-      add_setting :schemes, :default => %w(http https)
-      add_setting :consumes, :default => %w(application/json application/xml)
-      add_setting :produces, :default => %w(application/json application/xml)
-      add_setting :paths, :default => Paths.new, :required => true, :schema => Paths
-      add_setting :definitions
-      add_setting :parameters
-      add_setting :responses
-      add_setting :securityDefinitions, :schema => SecurityDefinitions
+      add_setting :servers, :schema => [Server]
+      add_setting :paths, :default => { '/' => Path.new }, :required => true, :schema => { '' => Path }
+      add_setting :components, :schema => Components
       add_setting :security
-      add_setting :tags, :default => [], :schema => [Tag]
-      add_setting :externalDocs
+      add_setting :tags, :schema => [Tag]
+      add_setting :externalDocs, :schema => ExternalDocs
     end
   end
 end

lib/rspec_api_documentation/open_api/request_body.rb

@@ -1,15 +1,36 @@
 module RspecApiDocumentation
   module OpenApi
     class Schema < Node
-      add_setting :format
       add_setting :title
-      add_setting :description
+      add_setting :multipleOf
+      add_setting :maximum
+      add_setting :exclusiveMaximum
+      add_setting :minimum
+      add_setting :exclusiveMinimum
+      add_setting :maxLength
+      add_setting :minLength
+      add_setting :pattern
+      add_setting :maxItems
+      add_setting :minItems
+      add_setting :uniqueItems
+      add_setting :maxProperties
+      add_setting :minProperties
       add_setting :required
       add_setting :enum
       add_setting :type
+      add_setting :allOf, :schema => [Schema]
+      add_setting :oneOf, :schema => [Schema]
+      add_setting :anyOf, :schema => [Schema]
+      add_setting :not, :schema => [Schema]
       add_setting :items
-      add_setting :properties
+      add_setting :properties, :schema => { '' => Schema }
+      add_setting :description
+      add_setting :format
       add_setting :example
+      add_setting :externalDocs, :schema => ExternalDocs
+      add_setting :nullable
+      add_setting :deprecated
+      add_setting :discriminator
     end
   end
 end

lib/rspec_api_documentation/open_api/response.rb

@@ -1,14 +1,14 @@
 module RspecApiDocumentation
   module OpenApi
-    class SecuritySchema < Node
+    class SecurityScheme < Node
       add_setting :type, :required => true
       add_setting :description
       add_setting :name
       add_setting :in
-      add_setting :flow
-      add_setting :authorizationUrl
-      add_setting :tokenUrl
-      add_setting :scopes
+      add_setting :scheme
+      add_setting :bearerFormat
+      add_setting :flows, :schema => { '' => Flow }
+      add_setting :openIdConnectUrl
     end
   end
 end