praxis 0.22.pre.1 → 2.0.pre.4

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
 
@@ -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,8 @@ 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
-      end
+      generator = Praxis::Docs::Generator.new(Dir.pwd)
+      generator.save!
     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

@@ -32,8 +32,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)
@@ -218,7 +218,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
 

data/lib/praxis/types/multipart_array/part_definition.rb

@@ -14,7 +14,7 @@ module Praxis
 
         def update_attribute(attribute, options, block)
           attribute.options.merge!(options)
-          attribute.type.attributes(options, &block)
+          attribute.type.attributes(**options, &block)
         end
 
         def create_attribute(type=Attributor::Struct, **opts, &block)

data/lib/praxis/version.rb

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

data/praxis.gemspec

@@ -21,22 +21,21 @@ Gem::Specification.new do |spec|
   spec.executables << 'praxis'
 
   spec.add_dependency 'rack', '>= 1'
-  spec.add_dependency 'mustermann', '>=0', '<=1'
+  spec.add_dependency 'mustermann', '>=1.1', '<=2'
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'praxis-mapper', '~> 4.3'
-  spec.add_dependency 'praxis-blueprints', '~> 3.3'
-  spec.add_dependency 'attributor', '~> 5.1'
-  spec.add_dependency 'thor', '~> 0.18'
+  spec.add_dependency 'praxis-blueprints', '>= 3.4'
+  spec.add_dependency 'attributor', '>= 5.4'
+  spec.add_dependency 'thor'
   spec.add_dependency 'terminal-table', '~> 1.4'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 0.9'
   spec.add_development_dependency 'rake-notes', '~> 0'
   if RUBY_PLATFORM !~ /java/
-    spec.add_development_dependency 'pry', '~> 0'
-    spec.add_development_dependency 'pry-byebug', '~> 1'
-    spec.add_development_dependency 'pry-stack_explorer', '~> 0'
+    spec.add_development_dependency 'pry'
+    spec.add_development_dependency 'pry-byebug'
+    spec.add_development_dependency 'pry-stack_explorer'
     spec.add_development_dependency 'sqlite3', '~> 1'
   else
     spec.add_development_dependency 'jdbc-sqlite3'
@@ -50,6 +49,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack-test', '~> 0'
   spec.add_development_dependency 'simplecov', '~> 0'
   spec.add_development_dependency 'fuubar', '~> 2'
-  spec.add_development_dependency 'yard', '~> 0'
+  spec.add_development_dependency 'yard', ">= 0.9.20"
   spec.add_development_dependency 'coveralls'
+  # Just for the query selector extensions etc...
+  spec.add_development_dependency 'sequel', '~> 5'
+  spec.add_development_dependency 'activerecord', '> 4'
 end

data/spec/functional_spec.rb

@@ -136,7 +136,6 @@ describe 'Functional specs' do
     headers = last_response.headers
     expect(headers['Content-Type']).to eq('application/json')
     expect(headers['Spec-Middleware']).to eq('used')
-    expect(headers['Content-Length']).to eq(last_response.body.size.to_s)
   end
 
   it 'returns early when making the before filter break' do

data/spec/praxis/action_definition_spec.rb

@@ -1,15 +1,6 @@
 require 'spec_helper'
 
 describe Praxis::ActionDefinition do
-  
-  before(:context) do
-    Thread.current[:praxis_instance] = Praxis::Application.new(name: 'action_definition_spec', skip_registration: true)
-  end
-  
-  let(:praxis_instance) do
-    Thread.current[:praxis_instance]
-  end
-  
   class SpecMediaType < Praxis::MediaType
     identifier 'application/json'
 
@@ -40,8 +31,10 @@ describe Praxis::ActionDefinition do
       end
     end
   end
+
   subject(:action) do
-    praxis_instance.api_definition.define do |api|
+
+    Praxis::ApiDefinition.define do |api|
       api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
         status 200
 
@@ -49,10 +42,6 @@ describe Praxis::ActionDefinition do
         location location
         headers headers if headers
       end
-      
-      api.info do # applies to all API infos
-        base_path "/pref"
-      end
     end
     Praxis::ActionDefinition.new(:foo, resource_definition) do
       routing { get '/:one' }
@@ -122,11 +111,11 @@ describe Praxis::ActionDefinition do
     let(:traits) { {test: trait} }
 
     before do
-      allow(praxis_instance.api_definition).to receive(:traits).and_return(traits)
+      allow(Praxis::ApiDefinition.instance).to receive(:traits).and_return(traits)
     end
 
     its('params.attributes.keys') { should eq [:inherited, :app_name, :name, :one]}
-    its('routes.first.path.to_s') { should eq '/pref/foobars/hello_world/test_trait/:app_name/:one' }
+    its('routes.first.path.to_s') { should eq '/api/foobars/hello_world/test_trait/:app_name/:one' }
     its(:traits) { should eq [:test] }
 
     it 'is reflected in the describe output' do
@@ -292,7 +281,7 @@ describe Praxis::ActionDefinition do
     subject(:action) { resource_definition.actions[:show] }
 
     it 'works' do
-      expansion = action.primary_route.path.expand(cloud_id:232, id: 2)
+      expansion = action.primary_route.path.expand(cloud_id:'232', id: '2')
       expect(expansion).to eq "/api/clouds/232/instances/2"
     end
 
@@ -326,9 +315,11 @@ describe Praxis::ActionDefinition do
   end
 
   context 'with a base_path and base_params on ApiDefinition' do
-    subject(:action) do
-      api_def=Praxis::ApiDefinition.new(praxis_instance)
-      api_def.define do |api|
+    # Without getting a fresh new ApiDefinition it is very difficult to test stuff using the Singleton
+    # So for some tests we're gonna create a new instance and work with it to avoid the singleton issues
+    let(:non_singleton_api) do
+      api_def=Praxis::ApiDefinition.__send__(:new)
+      api_def.instance_eval do |api|
 
         api.info do
           base_path '/apps/:app_name'
@@ -341,13 +332,11 @@ describe Praxis::ActionDefinition do
         end
 
       end
-      # No setter...and its fine to do it here as it would not be used in a runtime situation
-      praxis_instance.instance_variable_set(:@api_definition, api_def)
-      # Define the action after the api_definition is set (as it uses is config to setup the routes)
-      Praxis::ActionDefinition.new(:bar, resource_definition) do
-        routing { get '/:one' }
-        params  { attribute :one, String }
-      end
+      api_def
+    end
+
+    before do
+      allow(Praxis::ApiDefinition).to receive(:instance).and_return(non_singleton_api)
     end
 
     its('routes.first.path.to_s') { should eq '/apps/:app_name/foobars/hello_world/:one' }