praxis 0.22.pre.2 → 2.0.pre.5

data/lib/praxis/response.rb

@@ -63,23 +63,24 @@ module Praxis
       self.class.response_name
     end
 
-    def format!(config:)
+    def format!
     end
 
-    def encode!(handlers:)
+    def encode!
       case @body
       when Hash, Array
         # response payload is structured data; transform it into an entity using the handler
         # implied by the response's media type. If no handler is registered for this
         # name, assume JSON as a default handler.
+        handlers = Praxis::Application.instance.handlers
         handler = (content_type && handlers[content_type.handler_name]) || handlers['json']
         @body = handler.generate(@body)
       end
     end
 
-    def finish(application:)
-      format!(config: application.config)
-      encode!(handlers: application.handlers)
+    def finish
+      format!
+      encode!
 
       @body = Array(@body)
 

data/lib/praxis/response_definition.rb

@@ -4,9 +4,8 @@ module Praxis
 
   class ResponseDefinition
     attr_reader :name
-    attr_reader :application
-    
-    def initialize(response_name, application, **spec, &block)
+
+    def initialize(response_name, **spec, &block)
       unless response_name
         raise Exceptions::InvalidConfiguration.new(
           "Response name is required for a response specification"
@@ -14,7 +13,6 @@ module Praxis
       end
       @spec = { headers:{} }
       @name = response_name
-      @application = application
       self.instance_exec(**spec, &block) if block_given?
 
       if self.status.nil?
@@ -143,9 +141,9 @@ module Praxis
           # FIXME: remove load when when MediaTypeCommon.identifier returns a MediaTypeIdentifier
           identifier = MediaTypeIdentifier.load(self.media_type.identifier)
 
-          default_handlers = application.api_definition.info.produces
+          default_handlers = ApiDefinition.instance.info.produces
 
-          handlers = application.handlers.select do |k,v|
+          handlers = Praxis::Application.instance.handlers.select do |k,v|
             default_handlers.include?(k)
           end
 
@@ -165,7 +163,7 @@ module Praxis
           end
         end
 
-        content[:payload] = payload
+        content[:payload] = {type: payload}
       end
 
       unless parts == nil
@@ -202,7 +200,7 @@ module Praxis
         raise ArgumentError, "Parts definition for response #{name} does not allow :like and a block simultaneously"
       end
       if like
-        template = application.api_definition.response(like)
+        template = ApiDefinition.instance.response(like)
         @parts = template.compile(nil, **args)
       else # block
         @parts = Praxis::ResponseDefinition.new('anonymous', **args, &a_proc)

data/lib/praxis/response_template.rb

@@ -1,12 +1,11 @@
 module Praxis
 
   class ResponseTemplate
-    attr_reader :name, :block, :application
+    attr_reader :name, :block
 
-    def initialize(response_name, application, &block)
+    def initialize(response_name, &block)
       @name = response_name
       @block = block
-      @application = application
     end
 
     def compile(action=nil, **args)
@@ -24,7 +23,7 @@ module Praxis
           args[:media_type] = media_type
         end
       end
-      Praxis::ResponseDefinition.new(name, application, **args, &block)   
+      Praxis::ResponseDefinition.new(name, **args, &block)   
     end
 
     def describe

data/lib/praxis/responses/http.rb

@@ -131,5 +131,41 @@ module Praxis
       self.status = 422
     end
 
+    ApiDefinition.define do |api|
+
+
+      [
+        [ :accepted, 202, "The request has been accepted for processing, but the processing has not been completed." ],
+        [ :no_content, 204,"The server successfully processed the request, but is not returning any content."],
+        [ :multiple_choices, 300,"Indicates multiple options for the resource that the client may follow."],
+        [ :moved_permanently, 301,"This and all future requests should be directed to the given URI."],
+        [ :found, 302,"The requested resource resides temporarily under a different URI."],
+        [ :see_other, 303,"The response to the request can be found under another URI using a GET method"],
+        [ :not_modified, 304,"Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-Match."],
+        [ :temporary_redirect, 307,"In this case, the request should be repeated with another URI; however, future requests should still use the original URI."],
+        [ :bad_request, 400,"The request cannot be fulfilled due to bad syntax."],
+        [ :unauthorized, 401,"Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided."],
+        [ :forbidden, 403,"The request was a valid request, but the server is refusing to respond to it."],
+        [ :not_found, 404,"The requested resource could not be found but may be available again in the future."],
+        [ :method_not_allowed, 405,"A request was made of a resource using a request method not supported by that resource."],
+        [ :not_acceptable, 406,"The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request."],
+        [ :request_timeout, 408,"The server timed out waiting for the request."],
+        [ :conflict, 409, "Indicates that the request could not be processed because of conflict in the request, such as an edit conflict in the case of multiple updates."],
+        [ :precondition_failed, 412,"The server does not meet one of the preconditions that the requester put on the request."],
+        [ :unprocessable_entity, 422,"The request was well-formed but was unable to be followed due to semantic errors."],
+      ].each do |name, code, base_description|
+        api.response_template name do |media_type: nil, location: nil, headers: nil, description: nil|
+          status code
+          description( description || base_description ) # description can "potentially" be overriden in an individual action.
+
+          media_type media_type if media_type
+          location location if location
+          headers headers if headers
+        end
+      end
+
+    end
+
+
   end
 end

data/lib/praxis/responses/internal_server_error.rb

@@ -13,15 +13,16 @@ module Praxis
         @error = error
       end
 
-      def format!(exception = @error, config:)
+      def format!(exception = @error)
         if @error
-          if config.praxis.show_exceptions == true
+
+          if Application.instance.config.praxis.show_exceptions == true
             msg = {
               name: exception.class.name,
               message: exception.message,
               backtrace: exception.backtrace
             }
-            msg[:cause] = format!(exception.cause, config: config) if exception.cause
+            msg[:cause] = format!(exception.cause) if exception.cause
           else
             msg = {name: 'InternalServerError', message: "Something bad happened."}
           end
@@ -33,4 +34,12 @@ module Praxis
 
   end
 
+  ApiDefinition.define do |api|
+    api.response_template :internal_server_error do
+      description "A generic error message, given when an unexpected condition was encountered and no more specific message is suitable."
+      status 500
+      media_type "application/json"
+    end
+  end
+
 end

data/lib/praxis/responses/multipart_ok.rb

@@ -19,7 +19,7 @@ module Praxis
       end
 
 
-      def encode!(handlers:)
+      def encode!
         case @body
         when Praxis::Types::MultipartArray
           @body = @body.dump
@@ -28,9 +28,9 @@ module Praxis
         end
       end
 
-      def finish(application:)
-        format!(config: application.config)
-        encode!(handlers: application.handlers)
+      def finish
+        format!
+        encode!
 
         @body = Array(@body)
 
@@ -41,4 +41,11 @@ module Praxis
 
   end
 
+  ApiDefinition.define do |api|
+    api.response_template :multipart_ok do |media_type: Praxis::Types::MultipartArray|
+      status 200
+      media_type media_type
+    end
+  end
+
 end

data/lib/praxis/responses/validation_error.rb

@@ -15,7 +15,7 @@ module Praxis
         @documentation = documentation
       end
 
-      def format!(**_args)
+      def format!
         @body = {name: 'ValidationError', summary: @summary }
         @body[:errors] = @errors if @errors
 
@@ -31,4 +31,13 @@ module Praxis
 
   end
 
+
+  ApiDefinition.define do |api|
+    api.response_template :validation_error do
+      description "An error message indicating that one or more elements of the request did not match the API specification for the action"
+      status 400
+      media_type "application/json"
+    end
+  end
+
 end

data/lib/praxis/route.rb

@@ -24,7 +24,7 @@ module Praxis
       path_params = example_hash.select{|k,v| path_param_keys.include? k }
       # Let's generate the example only using required params, to avoid mixing incompatible parameters
       query_params = example_hash.select{|k,v| required_query_param_keys.include? k }
-      example = { verb: self.verb, url: self.path.expand(path_params), query_params: query_params }
+      example = { verb: self.verb, url: self.path.expand(path_params.transform_values(&:to_s)), query_params: query_params }
 
     end
 

data/lib/praxis/router.rb

@@ -50,7 +50,7 @@ module Praxis
     end
 
     def add_route(target, route)
-      path_versioning = (application.versioning_scheme == :path)
+      path_versioning = (Application.instance.versioning_scheme == :path)
 
       # DEPRECATED: remove with ResourceDefinition.version using: :path
       path_versioning ||= (target.action.resource_definition.version_options[:using] == :path)
@@ -65,7 +65,7 @@ module Praxis
     def call(env_or_request)
       request = case env_or_request
       when Hash
-        request_class.new(env_or_request, application: application)
+        request_class.new(env_or_request)
       when request_class
         env_or_request
       else
@@ -101,7 +101,7 @@ module Praxis
           body += " Available versions = #{pretty_versions}."
         end
         headers = {"Content-Type" => "text/plain"}
-        if application.config.praxis.x_cascade
+        if Praxis::Application.instance.config.praxis.x_cascade
           headers['X-Cascade'] = 'pass'
         end
         result = [404, headers, [body]]

data/lib/praxis/routing_config.rb

@@ -55,7 +55,7 @@ module Praxis
       path = (base + path).gsub('//','/')
       # Reject our own options
       route_name = options.delete(:name);
-      pattern = Mustermann.new(path, {ignore_unknown_options: true}.merge( options ))
+      pattern = Mustermann.new(path, **{ignore_unknown_options: true}.merge( options ))
       route = Route.new(verb, pattern, version, name: route_name, prefixed_path: prefixed_path, **options)
       @routes << route
       route

data/lib/praxis/tasks/api_docs.rb

@@ -58,16 +58,31 @@ namespace :praxis do
       require 'fileutils'
 
       Praxis::Blueprint.caching_enabled = false
-      
-      apps = Praxis::Application.registered_apps
-      if apps.size == 1
-        # Backwards compatible directory generation when there's only 1 app
-        Praxis::Docs::Generator.generate(Dir.pwd, name: apps.first[0], skip_sub_directory: true)
-      else
-        apps.each do|name,instance|
-          Praxis::Docs::Generator.generate(Dir.pwd, name: name)
-        end
+      generator = Praxis::Docs::Generator.new(Dir.pwd)
+      generator.save!
+    end
+
+    desc "Generate OpenAPI 3 docs for a Praxis App"
+    task :openapi => [:environment] do |t, args|
+      require 'fileutils'
+
+      Praxis::Blueprint.caching_enabled = false
+      generator = Praxis::Docs::OpenApiGenerator.new(Dir.pwd)
+      generator.save!
+    end
+
+    desc "Preview (and Generate) OpenAPI 3 docs for a Praxis App"
+    task :openapipreview => [:openapi] do |t, args|
+      require 'webrick' 
+      docs_port = 9090
+      root = Dir.pwd + '/docs/openapi/'
+      wb = Thread.new do
+        s = WEBrick::HTTPServer.new(:Port => docs_port, :DocumentRoot => root)
+        trap('INT') { s.shutdown }
+        s.start
       end
+      `open http://localhost:#{docs_port}/`
+      wb.join
     end
 
   end

data/lib/praxis/tasks/routes.rb

@@ -11,7 +11,6 @@ namespace :praxis do
     ]
 
     rows = []
-    # TODO SINGLETON: ... what do do here?...
     Praxis::Application.instance.resource_definitions.each do |resource_definition|
       resource_definition.actions.each do |name, action|
         method = begin

data/lib/praxis/trait.rb

@@ -76,7 +76,7 @@ module Praxis
             dsl_compiler: ActionDefinition::HeadersDSLCompiler,
             case_insensitive_load: true
           }
-          Attributor::Hash.of(key: String).construct(Proc.new {}, hash_opts)
+          Attributor::Hash.of(key: String).construct(Proc.new {}, **hash_opts)
         else
           Attributor::Hash.construct(Proc.new {})
         end

data/lib/praxis/types/media_type_common.rb

@@ -14,6 +14,16 @@ module Praxis
           hash
         end
 
+        def as_json_schema(**args)
+          the_type = @attribute && @attribute.type || member_type
+          the_type.as_json_schema(args)
+        end
+
+        def json_schema_type
+          the_type = @attribute && @attribute.type || member_type
+          the_type.json_schema_type
+        end
+    
         def description(text=nil)
           @description = text if text
           @description
@@ -32,8 +42,8 @@ module Praxis
         #
         # @return [String] the string-representation of this type's identifier
         def identifier(identifier=nil)
-          return @identifier.to_s unless identifier
-          (@identifier = MediaTypeIdentifier.load(identifier)).to_s
+          return @identifier unless identifier
+          @identifier = MediaTypeIdentifier.load(identifier)
         end
       end
 

data/lib/praxis/types/multipart.rb

@@ -12,7 +12,7 @@ module Praxis
       return value if value.kind_of?(self) || value.nil?
 
       unless (value.kind_of?(::String) && ! content_type.nil?)
-        raise Attributor::CoercionError, context: context, from: value.class, to: self.name, value: value
+        raise Attributor::CoercionError.new(context: context, from: value.class, to: self.name, value: value)
       end
 
       headers = {'Content-Type' => content_type}

data/lib/praxis/types/multipart_array.rb

@@ -83,7 +83,7 @@ module Praxis
 
         self.multiple << name if multiple
 
-        compiler = Attributor::DSLCompiler.new(self, opts)
+        compiler = Attributor::DSLCompiler.new(self, **opts)
 
         if filename
           filename_attribute = compiler.define('filename', String, required: true)
@@ -153,6 +153,68 @@ module Praxis
         example
       end
 
+      def self.json_schema_type
+        :object
+      end
+
+      # Multipart request bodies are special in OPEN API
+      # schema:            # Request payload
+      # type: object
+      # properties:      # Request parts
+      #   id:            # Part 1 (string value)
+      #     type: string
+      #     format: uuid
+      #   address:       # Part2 (object)
+      #     type: object
+      #     properties:
+      #       street:
+      #         type: string
+      #       city:
+      #         type: string
+      #   profileImage:  # Part 3 (an image)
+      #     type: string
+      #     format: binary
+      # 
+      # NOTE: not sure if this 
+      def self.as_openapi_request_body( attribute_options: {} )
+        hash = { type: json_schema_type }
+        opts = self.options.merge( attribute_options )
+        hash[:description] = opts[:description] if opts[:description]
+        hash[:default] = opts[:default] if opts[:default]
+
+        unless self.attributes.empty?
+          props = {}
+          encoding = {}
+          self.attributes.each do |part_name, part_attribute|
+            part_example = part_attribute.example
+            key_to_use = part_name.is_a?(Regexp) ? part_name.source : part_name
+            
+            part_info = {}
+            if (payload_attribute = part_attribute.options[:payload_attribute])
+              props[key_to_use] = payload_attribute.as_json_schema(example: part_example.payload)
+            end
+            #{
+            # contentType: 'fff',
+            # headers: {
+            #   custom1: 'safd'
+            # }
+            if (headers_attribute = part_attribute.options[:headers_attribute])
+              # Does this 'Content-Type' string check work?...can it be a symbol? what does it mean anyway?
+              encoding[key_to_use][:contentType] = headers_attribute['Content-Type'] if headers_attribute['Content-Type']
+              # TODO?rethink? ...is this correct?: att a 'headers' key with some header schemas if this part have some
+              encoding[key_to_use]['headers'] = headers_attribute.as_json_schema(example: part_example.headers)
+            end
+          end
+
+          hash[:properties] = props
+          hash[:encoding] = encoding unless encoding.empty?
+        end
+        hash
+      end
+
+      def self.as_json_schema( shallow: false, example: nil, attribute_options: {} )
+        as_openapi_request_body(attribute_options: attribute_options)
+      end
 
       def self.describe(shallow=true, example: nil)
         type_name = Attributor.type_name(self)
@@ -218,7 +280,7 @@ module Praxis
       attr_accessor :preamble
       attr_reader :content_type
 
-      def initialize(content_type: self.class.identifier)
+      def initialize(content_type: self.class.identifier.to_s)
         self.content_type = content_type
       end