praxis 0.15.0 → 0.16.0

data/lib/praxis/resource_definition.rb

@@ -5,23 +5,34 @@ module Praxis
   module ResourceDefinition
     extend ActiveSupport::Concern
     DEFAULT_RESOURCE_HREF_ACTION = :show
-    
+
     included do
       @version = 'n/a'.freeze
       @actions = Hash.new
       @responses = Hash.new
-      @action_defaults = []
+      @action_defaults = Trait.new
       @version_options = {}
       @metadata = {}
+      @traits = []
+
+      if self.name
+        @routing_prefix = '/' + self.name.split("::").last.underscore
+      else
+        @routing_prefix = '/'
+      end
+
+      @version_prefix = ''
+
       Application.instance.resource_definitions << self
     end
 
     module ClassMethods
       attr_reader :actions
-      attr_reader :routing_config
       attr_reader :responses
       attr_reader :version_options
-
+      attr_reader :traits
+      attr_reader :routing_prefix
+      attr_reader :version_prefix
       # opaque hash of user-defined medata, used to decorate the definition,
       # and also available in the generated JSON documents
       attr_reader :metadata
@@ -30,7 +41,17 @@ module Praxis
 
       # FIXME: this is inconsistent with the rest of the magic DSL convention.
       def routing(&block)
-        @routing_config = block
+        warn "DEPRECATED: ResourceDefinition.routing is deprecated use prefix directly instead."
+
+        # eval this assuming it will only call #prefix
+        self.instance_eval(&block)
+      end
+
+      def prefix(prefix=nil)
+        unless prefix.nil?
+          @routing_prefix = prefix
+        end
+        @routing_prefix
       end
 
       def media_type(media_type=nil)
@@ -46,6 +67,13 @@ module Praxis
         return @version unless version
         @version = version
         @version_options = options || {using: [:header,:params]}
+
+        if @version_options
+          version_using = Array(@version_options[:using])
+          if version_using.include?(:path)
+            @version_prefix = "#{Praxis::Request::path_version_prefix}#{self.version}"
+          end
+        end
       end
 
       def canonical_path( action_name=nil )
@@ -64,7 +92,7 @@ module Praxis
           return @canonical_action
         end
       end
-      
+
       def to_href( params )
         canonical_path.primary_route.path.expand(params)
       end
@@ -78,11 +106,22 @@ module Praxis
       rescue => e
         raise Praxis::Exception.new("Error parsing or coercing parameters from href: #{path}\n"+e.message)
       end
-      
+
+      def trait(trait_name)
+        unless ApiDefinition.instance.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)
+        @traits << trait_name
+      end
+      alias_method :use, :trait
+
       def action_defaults(&block)
-        return @action_defaults unless block_given?
+        if block_given?
+          @action_defaults.instance_eval(&block)
+        end
 
-        @action_defaults << block
+        @action_defaults
       end
 
       def params(type=Attributor::Struct, **opts, &block)
@@ -133,18 +172,12 @@ module Praxis
           hash[:description] = description
           hash[:media_type] = media_type.id if media_type
           hash[:actions] = actions.values.map(&:describe)
-          hash[:name] = self.name 
+          hash[:name] = self.name
           hash[:metadata] = metadata
+          hash[:traits] = self.traits
         end
       end
 
-      def use(trait_name)
-        unless ApiDefinition.instance.traits.has_key? trait_name
-          raise Exceptions::InvalidTrait.new("Trait #{trait_name} not found")
-        end
-        self.instance_eval(&ApiDefinition.instance.traits[trait_name])
-      end
-
       def nodoc!
         metadata[:doc_visibility] = :none
       end

data/lib/praxis/router.rb

@@ -11,7 +11,7 @@ module Praxis
         @version = version
       end
       def call(request)
-        if request.version(@target.action.resource_definition.version_options) == @version          
+        if request.version(@target.action.resource_definition.version_options) == @version
           @target.call(request)
         else
           # Version doesn't match, pass and continue
@@ -20,8 +20,8 @@ module Praxis
         end
       end
     end
-    
-    class RequestRouter < Mustermann::Router::Simple      
+
+    class RequestRouter < Mustermann::Router::Simple
       def initialize(default: nil, **options, &block)
         options[:default] = :not_found
 
@@ -48,8 +48,7 @@ module Praxis
     end
 
     def add_route(target, route)
-      warn 'other conditions not supported yet' if route.options.any?
-      version_wrapper = VersionMatcher.new(target, version: route.version)    
+      version_wrapper = VersionMatcher.new(target, version: route.version)
       @routes[route.verb].on(route.path, call: version_wrapper)
     end
 
@@ -75,17 +74,17 @@ module Praxis
            :not_found
          end
       end
-      
+
       if result == :not_found
         # no need to try :path as we cannot really know if you've attempted to pass a version through it here
         # plus we wouldn't have tracked it as unmatched
-        version = request.version(using: [:header,:params]) 
+        version = request.version(using: [:header,:params])
         attempted_versions = request.unmatched_versions
         body = "NotFound"
         unless attempted_versions.empty? || (attempted_versions.size == 1 && attempted_versions.first == 'n/a')
-          body += if version == 'n/a' 
-                    ". Your request did not specify an API version.".freeze 
-                  else 
+          body += if version == 'n/a'
+                    ". Your request did not specify an API version.".freeze
+                  else
                     ". Your request speficied API version = \"#{version}\"."
                   end
           pretty_versions = attempted_versions.collect(&:inspect).join(', ')
@@ -95,7 +94,7 @@ module Praxis
         if Praxis::Application.instance.config.praxis.x_cascade
           headers['X-Cascade'] = 'pass'
         end
-        result = [404, headers, [body]] 
+        result = [404, headers, [body]]
       end
       result
     end

data/lib/praxis/routing_config.rb

@@ -0,0 +1,65 @@
+module Praxis
+  class RoutingConfig
+
+    attr_reader :routes
+    attr_reader :version
+    attr_reader :base
+
+    def initialize(version:'n/a'.freeze, base: '', prefix:[], &block)
+      @version = version
+      @base = base
+      @prefix_segments = Array(prefix)
+
+      @routes = []
+
+      if block_given?
+        instance_eval(&block)
+      end
+    end
+
+    def clear!
+      @prefix_segments = []
+    end
+
+    def prefix(prefix=nil)
+      return @prefix_segments.join.gsub('//','/') if prefix.nil?
+
+      case prefix
+      when ''
+        @prefix_segments = []
+      when ABSOLUTE_PATH_REGEX
+        @prefix_segments = Array(prefix[1..-1])
+      else
+        @prefix_segments << prefix
+      end
+    end
+
+    def options(path, opts={}) add_route 'OPTIONS', path, opts end
+    def get(path, opts={})     add_route 'GET',     path, opts end
+    def head(path, opts={})    add_route 'HEAD',    path, opts end
+    def post(path, opts={})    add_route 'POST',    path, opts end
+    def put(path, opts={})     add_route 'PUT',     path, opts end
+    def delete(path, opts={})  add_route 'DELETE',  path, opts end
+    def trace(path, opts={})   add_route 'TRACE',   path, opts end
+    def connect(path, opts={}) add_route 'CONNECT', path, opts end
+    def patch(path, opts={})   add_route 'PATCH',   path, opts end
+    def any(path, opts={})     add_route 'ANY',     path, opts end
+
+    ABSOLUTE_PATH_REGEX = %r|^//|
+
+    def add_route(verb, path, options={})
+      unless path =~ ABSOLUTE_PATH_REGEX
+        path = prefix + path
+      end
+
+      path = (base + path).gsub('//','/')
+      # Reject our own options
+      route_name = options.delete(:name);
+      pattern = Mustermann.new(path, {ignore_unknown_options: true}.merge( options ))
+      route = Route.new(verb, pattern, version, name: route_name, **options)
+      @routes << route
+      route
+    end
+
+  end
+end

data/lib/praxis/tasks/routes.rb

@@ -7,7 +7,7 @@ namespace :praxis do
     table = Terminal::Table.new title: "Routes",
     headings:  [
       "Version", "Path", "Verb",
-      "Resource", "Action", "Implementation", "Name", "Primary"
+      "Resource", "Action", "Implementation", "Name", "Primary", "Options"
     ]
 
     rows = []
@@ -37,7 +37,8 @@ namespace :praxis do
               verb: route.verb,
               path: route.path,
               name: route.name,
-              primary: (action.primary_route == route ? 'yes' : '')
+              primary: (action.primary_route == route ? 'yes' : ''),
+              options: route.options
             })
         end
       end
@@ -49,8 +50,11 @@ namespace :praxis do
       puts JSON.pretty_generate(rows)
     when "table"
       rows.each do |row|
-        table.add_row(row.values_at(:version, :path, :verb, :resource,
-                                    :action, :implementation, :name, :primary))
+        formatted_options = row[:options].map{|(k,v)| "#{k}:#{v.to_s}"}.join("\n")
+        row_data = row.values_at(:version, :path, :verb, :resource,
+                                    :action, :implementation, :name, :primary)
+        row_data << formatted_options
+        table.add_row(row_data)
       end
       puts table
     else

data/lib/praxis/trait.rb

@@ -0,0 +1,107 @@
+module Praxis
+
+  class Trait
+    attr_reader :name
+    attr_reader :attribute_groups
+
+    def initialize(&block)
+      @name = nil
+      @description = nil
+      @responses = {}
+      @routing = nil
+      @other = []
+
+      @attribute_groups = Hash.new do |h,k|
+        h[k] = Trait.new
+      end
+
+      if block_given?
+        self.instance_eval(&block)
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      @other << [name, args, block]
+    end
+
+    def description(desc=nil)
+      return @description if desc.nil?
+      @description = desc
+    end
+
+    def response(resp, **args)
+      @responses[resp] = args
+    end
+
+    def create_group(name, &block)
+      @attribute_groups[name] = block
+    end
+
+    def headers(*args, &block)
+      create_group(:headers,&block)
+    end
+
+    def params(*args, &block)
+      create_group(:params,&block)
+    end
+
+    def payload(*args, &block)
+      type, opts = args
+
+      if type && !(type < Attributor::Hash)
+        raise 'payload in a trait with non-hash (or model or struct) is not supported'
+      end
+
+      create_group(:payload,&block)
+    end
+
+    def routing(&block)
+      @routing = block
+    end
+
+    def describe
+      desc = {description: @description}
+      desc[:name] = @name if @name
+      desc[:responses] = @responses if @responses.any?
+
+      if @routing
+        desc[:routing] = ConfigHash.new(&@routing).to_hash
+      end
+
+      @attribute_groups.each_with_object(desc) do |(name, block), hash|
+        hash[name] = Attributor::Hash.construct(block).describe[:keys]
+      end
+
+      desc
+    end
+
+
+    def apply!(target)
+      @attribute_groups.each do |name, block|
+        target.send(name, &block)
+      end
+      
+      if @routing
+        target.routing(&@routing)
+      end
+      
+      @responses.each do |name, args|
+        target.response(name, **args)
+      end
+
+      if @other.any?
+        @other.each do |name, args, block|
+          if block
+            target.send(name, *args, &block)
+          else
+            target.send(name,*args)
+          end
+        end
+      end
+    end
+
+
+
+  end
+
+end

data/lib/praxis/types/media_type_common.rb

@@ -9,7 +9,7 @@ module Praxis
         def describe(shallow = false)
           hash = super
           unless shallow
-            hash.merge!(identifier: @identifier, description: @description)
+            hash.merge!(identifier: @identifier.to_s, description: @description)
           end
           hash
         end

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/praxis.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mustermann', '~> 0'
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'praxis-mapper', '~> 3.3'
+  spec.add_dependency 'praxis-mapper', '~> 3.4'
   spec.add_dependency 'praxis-blueprints', '~> 1.3'
   spec.add_dependency 'attributor', '~> 2.6'
   spec.add_dependency 'thor', '~> 0.18'

data/spec/functional_spec.rb

@@ -276,7 +276,7 @@ describe 'Functional specs' do
     end
   end
 
-  context 'wildcard routing' do
+  context 'wildcard verb routing' do
     it 'can terminate instances with POST' do
       post '/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
       expect(last_response.status).to eq(200)
@@ -288,6 +288,19 @@ describe 'Functional specs' do
 
   end
 
+  context 'route options' do
+    it 'reach the endpoint that does not match the except clause' do
+      get '/clouds/23/otherinstances/_action/test?api_version=1.0', nil, 'global_session' => session
+      expect(last_response.status).to eq(200)
+    end
+    it 'does NOT reach the endpoint that matches the except clause' do
+      get '/clouds/23/otherinstances/_action/exceptional?api_version=1.0', nil, 'global_session' => session
+      expect(last_response.status).to eq(404)
+    end
+
+
+  end
+
   context 'auth_plugin' do
     it 'can terminate' do
       post '/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
@@ -316,7 +329,7 @@ describe 'Functional specs' do
   end
 
   context 'update' do
-    
+
 
     let(:body) { JSON.pretty_generate(request_payload) }
     let(:content_type) { 'application/json' }
@@ -324,7 +337,7 @@ describe 'Functional specs' do
     before do
       patch '/clouds/1/instances/3?api_version=1.0', body, 'CONTENT_TYPE' => content_type, 'global_session' => session
     end
-  
+
     subject(:response_body) { JSON.parse(last_response.body) }
 
     context 'with an empty payload' do