praxis 0.21 → 0.22.pre.1

data/lib/praxis/action_definition.rb

@@ -12,6 +12,7 @@ module Praxis
 
     attr_reader :name
     attr_reader :resource_definition
+    attr_reader :api_definition
     attr_reader :routes
     attr_reader :primary_route
     attr_reader :named_routes
@@ -39,6 +40,7 @@ module Praxis
       @metadata = Hash.new
       @routes = []
       @traits = []
+      @api_definition = resource_definition.application.api_definition
 
       if (media_type = resource_definition.media_type)
         if media_type.kind_of?(Class) && media_type < Praxis::Types::MediaTypeCommon
@@ -47,7 +49,7 @@ module Praxis
       end
 
       version = resource_definition.version
-      api_info = ApiDefinition.instance.info(resource_definition.version)
+      api_info = api_definition.info(resource_definition.version)
 
       route_base = "#{api_info.base_path}#{resource_definition.version_prefix}"
       prefix = Array(resource_definition.routing_prefix)
@@ -64,11 +66,11 @@ module Praxis
     end
 
     def trait(trait_name)
-      unless ApiDefinition.instance.traits.has_key? trait_name
+      unless 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 = api_definition.traits.fetch(trait_name)
       trait.apply!(self)
       traits << trait_name
     end
@@ -90,7 +92,7 @@ module Praxis
         args[:media_type] = type
       end
 
-      template = ApiDefinition.instance.response(name)
+      template = api_definition.response(name)
       @responses[name] = template.compile(self, **args)
     end
 
@@ -303,7 +305,7 @@ module Praxis
 
         # and return that one if it already corresponds to a registered handler
         # otherwise, add the encoding
-        if Praxis::Application.instance.handlers.include?(pick.handler_name)
+        if resource_definition.application.handlers.include?(pick.handler_name)
           return pick
         else
           return pick + handler_name
@@ -320,13 +322,13 @@ module Praxis
 
       hash[:examples] = {}
 
-      default_handlers = ApiDefinition.instance.info.consumes
+      default_handlers = api_definition.info.consumes
 
       default_handlers.each do |default_handler|
         dumped_payload = payload.dump(example, default_format: default_handler)
 
         content_type = derive_content_type(example, default_handler)
-        handler = Praxis::Application.instance.handlers[content_type.handler_name]
+        handler = resource_definition.application.handlers[content_type.handler_name]
 
         # in case handler is nil, use dumped_payload as-is.
         generated_payload = if handler.nil?

data/lib/praxis/api_definition.rb

@@ -1,41 +1,57 @@
-require 'singleton'
 require 'forwardable'
 
 module Praxis
 
   class ApiDefinition
-    include Singleton
     extend Forwardable
 
     attr_reader :traits
     attr_reader :responses
     attr_reader :infos
     attr_reader :global_info
+    attr_reader :application    
 
     attr_accessor :versioning_scheme
 
+    def self.instance
+      i = Thread.current[:praxis_instance] || $praxis_initializing_instance
+      raise "Trying to use Praxis::ApiDefinition outside the context of a Praxis::Application" unless i
+      i.api_definition
+    end
+    
     def self.define(&block)
+      
+      definition = Praxis::Application.current_instance.api_definition
+      if block.arity == 0
+        definition.instance_eval(&block)
+      else
+        yield(definition)
+      end
+    end
+    
+    def define(&block)
       if block.arity == 0
-        self.instance.instance_eval(&block)
+        self.instance_eval(&block)
       else
-        yield(self.instance)
+        yield(self)
       end
     end
 
-    def initialize
+    def initialize(application)
+      @application = application
       @responses = Hash.new
       @traits = Hash.new
       @base_path = ''
 
-      @global_info = ApiGeneralInfo.new
+      @global_info = ApiGeneralInfo.new(application: application)
 
       @infos = Hash.new do |hash, version|
-        hash[version] = ApiGeneralInfo.new(@global_info, version: version)
+        hash[version] = ApiGeneralInfo.new(@global_info, application: application, version: version)
       end
     end
 
     def response_template(name, &block)
-      @responses[name] = Praxis::ResponseTemplate.new(name, &block)
+      @responses[name] = Praxis::ResponseTemplate.new(name, application, &block)
     end
 
     def response(name)
@@ -91,25 +107,26 @@ module Praxis
       data
     end
 
-    define do |api|
-      api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
-        status 200
-        description( description || 'Standard response for successful HTTP requests.' )
-
-        media_type media_type
-        location location
-        headers headers if headers
-      end
-
-      api.response_template :created do |media_type: nil, location: nil, headers: nil, description: nil|
-        status 201
-        description( description || 'The request has been fulfilled and resulted in a new resource being created.' )
-
-        media_type media_type if media_type
-        location location
-        headers headers if headers
-      end
-    end
+    # CANNOT DEFINE IT AT FILE LOADING TIME: THE INSTANCE FOR THE API_DEFINITION IS NOT READY YET.
+    # define do |api|
+    #   api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
+    #     status 200
+    #     description( description || 'Standard response for successful HTTP requests.' )
+    #
+    #     media_type media_type
+    #     location location
+    #     headers headers if headers
+    #   end
+    #
+    #   api.response_template :created do |media_type: nil, location: nil, headers: nil, description: nil|
+    #     status 201
+    #     description( description || 'The request has been fulfilled and resulted in a new resource being created.' )
+    #
+    #     media_type media_type if media_type
+    #     location location
+    #     headers headers if headers
+    #   end
+    # end
 
   end
 

data/lib/praxis/api_general_info.rb

@@ -3,10 +3,11 @@ module Praxis
 
     attr_reader :version
 
-    def initialize(global_info=nil, version: nil)
+    def initialize(global_info=nil, application:, version: nil)
       @data = Hash.new
       @global_info = global_info
       @version = version
+      @application = application
 
       if @global_info.nil? # this *is* the global info
         version_with [:header, :params]
@@ -54,7 +55,7 @@ module Praxis
         get(:version_with)
       else
         if @global_info.nil? # this *is* the global info
-          Application.instance.versioning_scheme = val
+          @application.versioning_scheme = val
           set(:version_with, val)
         else
           raise "Use of version_with is only allowed in the global part of " \

data/lib/praxis/application.rb

@@ -1,16 +1,15 @@
-require 'singleton'
 require 'mustermann'
 require 'logger'
 
 module Praxis
   class Application
-    include Singleton
 
     attr_reader :router
     attr_reader :controllers
     attr_reader :resource_definitions
     attr_reader :app
     attr_reader :builder
+    attr_reader :api_definition
 
     attr_accessor :bootloader
     attr_accessor :file_layout
@@ -25,12 +24,30 @@ module Praxis
 
     attr_accessor :versioning_scheme
 
+    @@registered_apps = {}
 
+    def self.registered_apps
+      @@registered_apps
+    end
+        
+    def self.instance
+      i = current_instance
+      return i if i
+      $praxis_initializing_instance = self.new
+    end
+    
+    def self.current_instance
+      Thread.current[:praxis_instance] || $praxis_initializing_instance
+    end
+    
     def self.configure
-      yield(self.instance)
+       # Should fail (i.e., be nil) if it's not in initialization/setup or a runtime call
+      yield(current_instance)
     end
 
-    def initialize
+    def initialize(name: 'default', skip_registration: false)
+      old = $praxis_initializing_instance
+      $praxis_initializing_instance = self # ApiDefinition.new needs to get the instance...
       @controllers = Set.new
       @resource_definitions = Set.new
 
@@ -51,37 +68,135 @@ module Praxis
       @config = Config.new
       @root = nil
       @logger = Logger.new(STDOUT)
-    end
-
-
-    def setup(root: '.')
-      return self unless @app.nil?
-
-      @root = Pathname.new(root).expand_path
+      @api_definition = ApiDefinition.new(self)
+      
+      @api_definition.define do |api|
+        api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
+          status 200
+          description( description || 'Standard response for successful HTTP requests.' )
+
+          media_type media_type
+          location location
+          headers headers if headers
+        end
+
+        api.response_template :created do |media_type: nil, location: nil, headers: nil, description: nil|
+          status 201
+          description( description || 'The request has been fulfilled and resulted in a new resource being created.' )
+
+          media_type media_type if media_type
+          location location
+          headers headers if headers
+        end
+      end
+      
+      require 'praxis/responses/http'
+      self.api_definition.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
+      
+      require 'praxis/responses/internal_server_error'
+      self.api_definition.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
+      
+      require 'praxis/responses/validation_error'
+      self.api_definition.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
+      
+      
+      require 'praxis/responses/multipart_ok'
+      self.api_definition.define do |api|
+        api.response_template :multipart_ok do |media_type: Praxis::Types::MultipartArray|
+          status 200
+          media_type media_type
+        end
+      end
+      
       builtin_handlers = {
         'plain' => Praxis::Handlers::Plain,
         'json' => Praxis::Handlers::JSON,
         'x-www-form-urlencoded' => Praxis::Handlers::WWWForm
       }
+      
       # Register built-in handlers unless the app already provided its own
       builtin_handlers.each_pair do |name, handler|
         self.handler(name, handler) unless handlers.key?(name)
       end
+      
+      setup_initial_config!
+      
+      unless skip_registration
+        if self.class.registered_apps[name]
+          raise "A Praxis instance named #{name} has already been registered, please use the :name parameter to initialize them"
+        end
+        self.class.registered_apps[name] = self
+      end
+      $praxis_initializing_instance = old
+    end
+
+    def setup_initial_config!
+      self.config do
+        attribute :praxis do
+          attribute :validate_responses, Attributor::Boolean, default: false
+          attribute :validate_response_bodies, Attributor::Boolean, default: false
 
-      @bootloader.setup!
+          attribute :show_exceptions, Attributor::Boolean, default: false
+          attribute :x_cascade, Attributor::Boolean, default: true
+        end
+      end
+    end
 
-      @builder.run(@router)
-      @app = @builder.to_app
 
-      Notifications.subscribe 'rack.request.all'.freeze do |name, start, finish, _id, payload|
-        duration = (finish - start) * 1000
-        Stats.timing(name, duration)
+    def setup(root: '.')
+      return self unless @app.nil?
+      saved_value = $praxis_initializing_instance
+      $praxis_initializing_instance = self
+      @root = Pathname.new(root).expand_path
 
-        status, _, _ = payload[:response]
-        Stats.increment "rack.request.#{status}"
-      end
+      bootloader.setup!
+      builder.run(@router)
+      @app = builder.to_app
 
+      $praxis_initializing_instance = saved_value
       self
     end
 
@@ -111,9 +226,13 @@ module Praxis
 
     def call(env)
       response = []
+      old = Thread.current[:praxis_instance]
+      Thread.current[:praxis_instance] = self
       Notifications.instrument 'rack.request.all'.freeze, response: response do
         response.push(*@app.call(env))
       end
+    ensure
+      Thread.current[:praxis_instance] = old      
     end
 
     def layout(&block)

data/lib/praxis/bootloader.rb

@@ -49,7 +49,7 @@ module Praxis
       after(:app) do
         Praxis::Mapper.finalize!
         Praxis::Blueprint.finalize!
-        Praxis::ResourceDefinition.finalize!
+        Praxis::ResourceDefinition.finalize!(application: self.application)
       end
 
     end
@@ -112,10 +112,8 @@ module Praxis
     end
 
     def setup!
-      # use the Stats and Notifications plugins by default
-      use Praxis::Stats
+      # use the Notifications plugin by default
       use Praxis::Notifications
-
       run
     end
 

data/lib/praxis/bootloader_stages/environment.rb

@@ -8,7 +8,6 @@ module Praxis
       # 1) the environment.rb file    - generic stuff for all environments
       # 2) "Deployer.environment".rb  - environment specific stuff
       def execute
-        setup_initial_config!
 
         env_file = application.root + "config/environment.rb"
         require env_file if File.exists? env_file
@@ -37,18 +36,6 @@ module Praxis
         end
       end
 
-      # TODO: not really sure I like this here... but where else is better?
-      def setup_initial_config!
-        application.config do
-          attribute :praxis do
-            attribute :validate_responses, Attributor::Boolean, default: false
-            attribute :validate_response_bodies, Attributor::Boolean, default: false
-
-            attribute :show_exceptions, Attributor::Boolean, default: false
-            attribute :x_cascade, Attributor::Boolean, default: true
-          end
-        end
-      end
 
     end