praxis 0.21 → 0.22.pre.1

data/lib/praxis/request.rb

@@ -1,7 +1,7 @@
 module Praxis
 
-  class Request
-    attr_reader :env, :query
+  class Request < Praxis.request_superclass
+    attr_reader :env, :query, :praxis_instance
     attr_accessor :route_params, :action
 
     PATH_VERSION_PREFIX = "/v".freeze
@@ -14,10 +14,11 @@ module Praxis
     API_NO_VERSION_NAME = 'n/a'.freeze
     VERSION_USING_DEFAULTS = [:header, :params].freeze
 
-    def initialize(env)
+    def initialize(env, args={})
       @env = env
       @query = Rack::Utils.parse_nested_query(env[QUERY_STRING_NAME])
       @route_params = {}
+      @praxis_instance = args[:application]
     end
 
     # Determine the content type of this request as indicated by the Content-Type header.
@@ -86,8 +87,8 @@ module Praxis
     PATH_VERSION_MATCHER = %r{^#{self.path_version_prefix}(?<version>[^\/]+)\/}.freeze
 
     def path_version_matcher
-      if Application.instance.versioning_scheme == :path
-        matcher = Mustermann.new(ApiDefinition.instance.info.base_path + '*')
+      if praxis_instance.versioning_scheme == :path
+        matcher = Mustermann.new(praxis_instance.api_definition.info.base_path + '*')
         matcher.params(self.path)[API_VERSION_PARAM_NAME]
       else
         PATH_VERSION_MATCHER.match(self.path)[:version]
@@ -96,8 +97,7 @@ module Praxis
 
     def version
       result = nil
-
-      Array(Application.instance.versioning_scheme).find do |mode|
+      Array(praxis_instance.versioning_scheme).find do |mode|
         case mode
         when :header;
           result = env[API_VERSION_HEADER_NAME]
@@ -128,8 +128,7 @@ module Praxis
     def load_payload(context)
       return unless action.payload
       return if content_type.nil?
-
-      raw = if (handler = Praxis::Application.instance.handlers[content_type.handler_name])
+      raw = if (handler = praxis_instance.handlers[content_type.handler_name])
         handler.parse(self.raw_payload)
       else
         # TODO is this a good default?

data/lib/praxis/request_stages/response.rb

@@ -8,8 +8,9 @@ module Praxis
 
         response.handle
 
-        if Application.instance.config.praxis.validate_responses == true
-          validate_body = Application.instance.config.praxis.validate_response_bodies
+        config = Application.current_instance.config
+        if config.praxis.validate_responses == true
+          validate_body = config.praxis.validate_response_bodies
 
           response.validate(action, validate_body: validate_body)
         end

data/lib/praxis/request_superclassing.rb

@@ -0,0 +1,11 @@
+module Praxis
+  class << self
+
+    attr_writer :request_superclass
+
+    def request_superclass
+      @request_superclass || Object
+    end
+
+  end
+end

data/lib/praxis/resource_definition.rb

@@ -8,11 +8,15 @@ module Praxis
     DEFAULT_RESOURCE_HREF_ACTION = :show
 
     included do
+      # Store the attached (i.e., current) Praxis App instance into the resource definition for easy retrieval later
+      @application = Application.instance
+      @application.resource_definitions << self
+
       @version = 'n/a'.freeze
       @actions = Hash.new
       @responses = Hash.new
 
-      @action_defaults = Trait.new &ResourceDefinition.generate_defaults_block
+      @action_defaults = Trait.new &ResourceDefinition.generate_defaults_block(application: @application)
 
       @version_options = {}
       @metadata = {}
@@ -33,13 +37,12 @@ module Praxis
 
       @on_finalize = Array.new
 
-      Application.instance.resource_definitions << self
+ 
     end
 
-    def self.generate_defaults_block( version: nil )
-
+    def self.generate_defaults_block( version: nil, application:)
       # Ensure we inherit any base params defined in the API definition for the passed in version
-      base_attributes = if (base_params = ApiDefinition.instance.info(version).base_params)
+      base_attributes = if (base_params = application.api_definition.info(version).base_params)
         base_params.attributes
       else
         {}
@@ -56,8 +59,8 @@ module Praxis
       end
     end
 
-    def self.finalize!
-      Application.instance.resource_definitions.each do |resource_definition|
+    def self.finalize!(application: )
+      application.resource_definitions.each do |resource_definition|
         while (block = resource_definition.on_finalize.shift)
           block.call
         end
@@ -73,6 +76,7 @@ module Praxis
       attr_reader :traits
       attr_reader :version_prefix
       attr_reader :parent_prefix
+      attr_reader :application
 
       # opaque hash of user-defined medata, used to decorate the definition,
       # and also available in the generated JSON documents
@@ -199,7 +203,7 @@ module Praxis
           end
         end
 
-        @action_defaults.instance_eval &ResourceDefinition.generate_defaults_block( version: version )
+        @action_defaults.instance_eval &ResourceDefinition.generate_defaults_block( version: version, application: self.application)
       end
 
 
@@ -238,10 +242,10 @@ module Praxis
       end
 
       def trait(trait_name)
-        unless ApiDefinition.instance.traits.has_key? trait_name
+        unless self.application.api_definition.traits.has_key? trait_name
           raise Exceptions::InvalidTrait.new("Trait #{trait_name} not found in the system")
         end
-        trait = ApiDefinition.instance.traits.fetch(trait_name)
+        trait = self.application.api_definition.traits.fetch(trait_name)
         @traits << trait_name
       end
       alias_method :use, :trait

data/lib/praxis/response.rb

@@ -18,7 +18,7 @@ module Praxis
       klass.status = self.status if self.status
     end
 
-    def initialize(status:self.class.status, headers:{}, body:'', location: nil)
+    def initialize(status:self.class.status, headers:{}, body: nil, location: nil)
       @name    = response_name
       @status  = status
       @headers = headers
@@ -63,24 +63,23 @@ module Praxis
       self.class.response_name
     end
 
-    def format!
+    def format!(config:)
     end
 
-    def encode!
+    def encode!(handlers:)
       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
-      format!
-      encode!
+    def finish(application:)
+      format!(config: application.config)
+      encode!(handlers: application.handlers)
 
       @body = Array(@body)
 

data/lib/praxis/response_definition.rb

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

data/lib/praxis/response_template.rb

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

data/lib/praxis/responses/http.rb

@@ -131,41 +131,5 @@ 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,16 +13,15 @@ module Praxis
         @error = error
       end
 
-      def format!(exception = @error)
+      def format!(exception = @error, config:)
         if @error
-
-          if Application.instance.config.praxis.show_exceptions == true
+          if config.praxis.show_exceptions == true
             msg = {
               name: exception.class.name,
               message: exception.message,
               backtrace: exception.backtrace
             }
-            msg[:cause] = format!(exception.cause) if exception.cause
+            msg[:cause] = format!(exception.cause, config: config) if exception.cause
           else
             msg = {name: 'InternalServerError', message: "Something bad happened."}
           end
@@ -34,12 +33,4 @@ 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!
+      def encode!(handlers:)
         case @body
         when Praxis::Types::MultipartArray
           @body = @body.dump
@@ -28,9 +28,9 @@ module Praxis
         end
       end
 
-      def finish
-        format!
-        encode!
+      def finish(application:)
+        format!(config: application.config)
+        encode!(handlers: application.handlers)
 
         @body = Array(@body)
 
@@ -41,11 +41,4 @@ 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!
+      def format!(**_args)
         @body = {name: 'ValidationError', summary: @summary }
         @body[:errors] = @errors if @errors
 
@@ -31,13 +31,4 @@ 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/router.rb

@@ -50,7 +50,7 @@ module Praxis
     end
 
     def add_route(target, route)
-      path_versioning = (Application.instance.versioning_scheme == :path)
+      path_versioning = (application.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)
+        request_class.new(env_or_request, application: application)
       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 Praxis::Application.instance.config.praxis.x_cascade
+        if application.config.praxis.x_cascade
           headers['X-Cascade'] = 'pass'
         end
         result = [404, headers, [body]]

data/lib/praxis/tasks/api_docs.rb

@@ -58,8 +58,16 @@ namespace :praxis do
       require 'fileutils'
 
       Praxis::Blueprint.caching_enabled = false
-      generator = Praxis::Docs::Generator.new(Dir.pwd)
-      generator.save!
+      
+      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
+      end
     end
 
   end

data/lib/praxis/tasks/routes.rb

@@ -11,6 +11,7 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.21'
+  VERSION = '0.22.pre.1'
 end