praxis 2.0.pre.28 → 2.0.pre.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 516db7752a3c4d1e8aa48abe0967781c9f6b31a65155a18285febb30c058e823
-  data.tar.gz: f404aaf78564a04b4835c70928584a82f3313b013c71f1d5e28e78f3e814296c
+  metadata.gz: e8f0514dd2a155733de0efe5586dd4b0409c70a9b385822b15e39934a7b83ea2
+  data.tar.gz: ff66561cdaadb84a9c97b83c044c423561b6506e10a31cf72d032dce73dcb50c
 SHA512:
-  metadata.gz: 5b1eae94ededb45b3cd48fdfe2440c5ac41af66b5c251e3a682906709d67a15d02d7463c7dc2e384fb4c217a745b7cec438b0d919e614f5f4c4c499a94cb17a4
-  data.tar.gz: fe8c7d881560b09702a4fe63680046f472efebb18aa1c09b01138b6dd9569727d29759bfc0e765095d52ec92df1c136e1de1419bf3fe282cc0b56e92cb3b1c9e
+  metadata.gz: 9bcb89e0426fb2e9e8ea51e7794a42f0a1ec6969fce436196da8c9d32697b232a02bddb0008400d51c6dc8b2d475e1122283da8644ed78bb448d759fbf4f2363
+  data.tar.gz: 5c0a71be2bb1043ccc4269ccfa258d01e93b66d4dfa2f69938f5a495d8a296a305d2b8051c84a6683343672a69cd01e20f717dc87f4bf5ca4049b587438a3194

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Praxis Changelog
 
 ## next
+
+## 2.0.pre.29
+  * Assorted set of fixes to generate cleaner and more compliant OpenApi documents.
+    * Mostly in the area of multipart generation, and requirements and nullability for OpenApi 3.0
 ## 2.0.pre.28
   * Enhance the mapper's Resource property to allow for a couple more powerful options using the `as:` keyword:
     * `as: :self` will provide a way to map any further incoming fields on top of the already existing object. This is useful when we want to expose some properties for a resource, grouped within a sub structure, but that in reality they exist directly in the resource's underlying model (i.e., to organize the information of the model in a more structured/groupable way).

data/lib/praxis/docs/open_api/media_type_object.rb

@@ -45,15 +45,22 @@ module Praxis
 
           if example_payload
             examples_by_content_type = {}
-            rendered_payload = example_payload.dump
+            # We don't need to provide top-level examples for a multipart payload...each part
+            # will provide its own example (and assembling a proper structured example for the whole
+            # body isn't necessarily trivial based on the spec)
+            # If we need to, someday, we can create the rendered_paylod by calling MultipartArray.self.dump_for_openapi
+            # and properly complete that code to generate the appropriate thing, including the encoding etc...
+            unless type < Praxis::Types::MultipartArray
+              rendered_payload = example_payload.dump
 
-            example_handlers.each do |spec|
-              content_type, handler_name = spec.first
-              handler = Praxis::Application.instance.handlers[handler_name]
-              # ReDoc is not happy to display json generated outputs when served as JSON...wtf?
-              generated = handler.generate(rendered_payload)
-              final = handler_name == 'json' ? JSON.parse(generated) : generated
-              examples_by_content_type[content_type] = final
+              example_handlers.each do |spec|
+                content_type, handler_name = spec.first
+                handler = Praxis::Application.instance.handlers[handler_name]
+                # ReDoc is not happy to display json generated outputs when served as JSON...wtf?
+                generated = handler.generate(rendered_payload)
+                final = handler_name == 'json' ? JSON.parse(generated) : generated
+                examples_by_content_type[content_type] = final
+              end
             end
           end
 

data/lib/praxis/docs/open_api/request_body_object.rb

@@ -23,13 +23,14 @@ module Praxis
           # so we'll show all the supported MTs...but repeating the schema
           # dumped_schema = SchemaObject.new(info: attribute).dump_schema
 
-          example_handlers = if attribute.type < Praxis::Types::MultipartArray
-                               ident = MediaTypeIdentifier.load('multipart/form-data')
-                               [{ ident.to_s => 'plain' }] # Multipart content type, but with the plain renderer (so there's no modification)
-                             else
-                               # TODO: We could run it through other handlers I guess...if they're registered
-                               [{ 'application/json' => 'json' }]
-                             end
+          example_handlers = \
+            if attribute.type < Praxis::Types::MultipartArray
+              ident = MediaTypeIdentifier.load('multipart/form-data')
+              [{ ident.to_s => 'json' }] # Multipart content type
+            else
+              # TODO: We could run it through other handlers I guess...if they're registered
+              [{ 'application/json' => 'json' }]
+            end
 
           h[:content] = MediaTypeObject.create_content_attribute_helper(type: attribute.type,
                                                                         example_payload: attribute.example(nil),

data/lib/praxis/docs/open_api/schema_object.rb

@@ -31,7 +31,7 @@ module Praxis
 
         def dump_schema(shallow: false, allow_ref: false)
           # We will dump schemas for mediatypes by simply creating a reference to the components' section
-          if type < Attributor::Container
+          if type < Attributor::Container && ! (type < Praxis::Types::MultipartArray)
             if (type < Praxis::Blueprint || type < Attributor::Model) && allow_ref && !type.anonymous?
               # TODO: Do we even need a description?
               h = @attribute_options[:description] ? { 'description' => @attribute_options[:description] } : {}
@@ -47,10 +47,11 @@ module Praxis
               props = type.attributes.transform_values.with_index do |definition, index|
                 # if type has an attribute in its requirements all, then it should be marked as required here
                 field_name = type.attributes.keys[index]
-                definition.options.merge!(required: true) if required_attributes.include?(field_name)
                 OpenApi::SchemaObject.new(info: definition).dump_schema(allow_ref: true, shallow: shallow)
               end
-              h = { type: :object, properties: props } # TODO: Example?
+              h = { type: :object}
+              h[:properties] = props if props.presence
+              h[:required] = required_attributes unless required_attributes.empty?
             end
           else
             # OpenApi::SchemaObject.new(info:target).dump_schema(allow_ref: allow_ref, shallow: shallow)
@@ -61,12 +62,8 @@ module Praxis
 
           # Tag on OpenAPI specific requirements that aren't already added in the underlying JSON schema model
           # Nullable: (it seems we need to ensure there is a null option to the enum, if there is one)
-          if @attribute_options[:null]
-            h[:nullable] = @attribute_options[:null]
-            h[:enum] = h[:enum] + [nil] if h[:enum] && !h[:enum].include?(nil)
-          end
-          # Required: Mostly for request bodies
-          h[:required] = true if @attribute_options[:required]
+          is_nullable = @attribute_options[:null]
+          h[:nullable] = true if is_nullable
           h
 
           # # TODO: FIXME: return a generic object type if the passed info was weird.

data/lib/praxis/docs/open_api_generator.rb

@@ -117,10 +117,10 @@ module Praxis
           openapi: '3.0.2',
           info: info_object.dump,
           servers: [server_object.dump],
-          paths: paths_object.dump
+          paths: paths_object.dump,
+          security: [] # NOTE: No security definitions in Praxis. Leave it empty, to not anger linters
           # responses: {}, #TODO!! what do we get here? the templates?...need to transform to "Responses Definitions Object"
           # securityDefinitions: {}, # NOTE: No security definitions in Praxis
-          # security: [], # NOTE: No security definitions in Praxis
         }
 
         # Create the top level tags by:

data/lib/praxis/multipart/part.rb

@@ -254,5 +254,10 @@ module Praxis
     ensure
       self.content_type = original_content_type
     end
+
+    def self.dump_for_openapi(example_part)
+      # TODO: This needs to be structured as OpenAPI requires it
+      raise "dumping a part for open api not implemented yet"
+    end
   end
 end

data/lib/praxis/types/multipart_array.rb

@@ -197,7 +197,7 @@ module Praxis
             encoding[key_to_use]['headers'] = headers_attribute.as_json_schema(example: part_example.headers)
           end
 
-          hash[:properties] = props
+          hash[:properties] = props if props.presence
           hash[:encoding] = encoding unless encoding.empty?
         end
         hash
@@ -370,6 +370,10 @@ module Praxis
         all_entities = parts.join("\r\n--#{boundary}\r\n")
         "--#{boundary}\r\n#{all_entities}\r\n--#{boundary}--\r\n"
       end
+
+      def self.dump_for_openapi(example)
+        example.map {|part| MultipartPart.dump_for_openapi(part)}
+      end
     end
   end
 end

data/lib/praxis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Praxis
-  VERSION = '2.0.pre.28'
+  VERSION = '2.0.pre.29'
 end

data/praxis.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables << 'praxis'
 
   spec.add_dependency 'activesupport', '>= 3'
-  spec.add_dependency 'attributor', '>= 6.4'
+  spec.add_dependency 'attributor', '>= 6.5'
   spec.add_dependency 'mime', '~> 0'
   spec.add_dependency 'mustermann', '>=1.1'
   spec.add_dependency 'rack', '>= 1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.28
+  version: 2.0.pre.29
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.5'
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement