praxis 0.15.0 → 0.16.0

data/spec/praxis/resource_definition_spec.rb

@@ -9,7 +9,7 @@ describe Praxis::ResourceDefinition do
   its(:version) { should eq('1.0') }
   its(:version_options) { should eq({using: [:header,:params]}) }
 
-  its(:routing_config) { should be_kind_of(Proc) }
+  its(:prefix) { should eq('/people') }
 
   its(:actions) { should have(2).items }
   its(:metadata) { should_not have_key(:doc_visibility) }
@@ -22,6 +22,7 @@ describe Praxis::ResourceDefinition do
 
     its([:actions]) { should have(2).items }
     its([:metadata]) { should be_kind_of(Hash) }
+    its([:traits]) { should eq [:test] }
   end
 
   context '.action' do
@@ -34,7 +35,7 @@ describe Praxis::ResourceDefinition do
       expect(index).to be_kind_of(Praxis::ActionDefinition)
       expect(index.description).to eq("index description")
     end
-    
+
     it 'complains if action names are not symbols' do
       expect do
         Class.new do
@@ -46,7 +47,43 @@ describe Praxis::ResourceDefinition do
     end
   end
 
+  context 'action_defaults' do
+    let(:resource_definition) do
+      Class.new do
+        include Praxis::ResourceDefinition
+        media_type Person
+
+        def self.name
+          'FooBar'
+        end
 
+        action_defaults do
+          routing do
+            prefix '/people/:id'
+          end
+
+          params do
+            attribute :id
+          end
+        end
+
+        action :show do
+          routing do
+            get ''
+          end
+        end
+
+      end
+    end
+
+    it 'are applied to actions' do
+      action = resource_definition.actions[:show]
+      expect(action.params.attributes).to have_key(:id)
+      expect(action.routes.first.path.to_s).to eq '/people/:id'
+    end
+
+  end
+  
   context 'setting other values' do
     subject(:resource_definition) { Class.new {include Praxis::ResourceDefinition } }
 
@@ -64,7 +101,7 @@ describe Praxis::ResourceDefinition do
   end
 
 
-  context '.use' do
+  context '.trait' do
     subject(:resource_definition) { Class.new {include Praxis::ResourceDefinition } }
     it 'raises an error for missing traits' do
       expect { resource_definition.use(:stuff) }.to raise_error(Praxis::Exceptions::InvalidTrait)
@@ -81,9 +118,10 @@ describe Praxis::ResourceDefinition do
         def self.name
           'FooBar'
         end
+        
         silence_warnings do
           payload { attribute :inherited_payload, String }
-          headers { header "Inherited-Header", String }
+          headers { key "Inherited-Header", String }
           params  { attribute :inherited_params, String }
           response :not_found
         end
@@ -95,11 +133,7 @@ describe Praxis::ResourceDefinition do
 
     let(:action) { resource_definition.actions[:index] }
 
-    it 'defers the values to procs in action_defaults' do
-      expect(resource_definition.action_defaults).to have(4).items
-    end
-
-    it 'delegates defaults to the action' do
+    it 'are applied to the action' do
       expect(action.payload.attributes).to have_key(:inherited_payload)
       expect(action.headers.attributes).to have_key("Inherited-Header")
       expect(action.params.attributes).to have_key(:inherited_params)
@@ -110,7 +144,7 @@ describe Praxis::ResourceDefinition do
 
   context 'with nodoc! called' do
     before do
-      resource_definition.nodoc!      
+      resource_definition.nodoc!
     end
 
     it 'has the :doc_visibility option set' do
@@ -133,7 +167,7 @@ describe Praxis::ResourceDefinition do
           resource_definition.canonical_path :reset
         }.to raise_error(/'canonical_path' can only be defined once./)
       end
-    end  
+    end
     context 'if none specified' do
       subject(:resource_definition) do
         Class.new do
@@ -143,7 +177,7 @@ describe Praxis::ResourceDefinition do
         end
       end
       it 'defaults to the :show action' do
-        expect(subject.canonical_path).to eq(subject.actions[:show])        
+        expect(subject.canonical_path).to eq(subject.actions[:show])
       end
     end
     context 'with an undefined action' do

data/spec/praxis/router_spec.rb

@@ -75,9 +75,6 @@ describe Praxis::Router do
   end
 
   context ".add_route" do
-    before do
-      expect(router).to receive(:warn).with("other conditions not supported yet")
-    end
 
     let(:route){ double('route', options: [1], version: 1, verb: 'verb', path: 'path')}
     let(:target){ double('target') }
@@ -93,9 +90,6 @@ describe Praxis::Router do
       router.add_route(target ,route)
     end
 
-    it "raises warning when options are specified in route" do
-      expect(router.add_route(proc {'target'},route)).to eq(['path'])
-    end
   end
 
   context ".call" do
@@ -116,34 +110,34 @@ describe Praxis::Router do
       router.add_route(double("P"),double("route1", verb: 'POST', path: '/', options: {} , version: request_version))
       # Hijack the callable block in the routes (since there's no way to point back to the registered route object)
       router.instance_variable_get( :@routes )['POST'] = post_target_router
-        
+
     end
 
     context 'for routes without wildcards (a single POST route)' do
-      
+
       context 'and an incoming POST request' do
         it "finds a match and invokes it the route" do
           expect(router.call(request)).to eq(router_response_for_post)
         end
       end
       context 'and an incoming PUT request' do
-        let(:request_verb) { 'PUT' }      
+        let(:request_verb) { 'PUT' }
         it "does not find a route" do
           response_code, _ , _ = router.call(request)
           expect(response_code).to be(404)
         end
       end
     end
-    
+
     context 'for routes with wildcards (a POST and a * route)' do
       before do
         router.add_route(double("*"),double("route2", verb: 'ANY', path: '/*', options: {} , version: request_version))
         # Hijack the callable block in the routes (since there's no way to point back to the registered route object)
-        router.instance_variable_get( :@routes )['ANY'] = any_target_router        
+        router.instance_variable_get( :@routes )['ANY'] = any_target_router
       end
-      
+
       context 'and an incoming PUT request' do
-        let(:request_verb) { 'PUT' }      
+        let(:request_verb) { 'PUT' }
         it "it can successfully find a match using the wildcard target" do
           expect(router.call(request)).to eq(router_response_for_wildcard)
         end
@@ -164,7 +158,7 @@ describe Praxis::Router do
     end
 
     context "when not_found is returned" do
-      let(:request_verb) { 'DELETE' }      
+      let(:request_verb) { 'DELETE' }
       let(:router_response){ :not_found }
 
 
@@ -175,7 +169,7 @@ describe Praxis::Router do
       end
 
       context 'with X-Cascade disabled' do
-        let(:config) { Praxis::Application.instance.config.praxis } 
+        let(:config) { Praxis::Application.instance.config.praxis }
         before do
           expect(config).to receive(:x_cascade).and_return(false)
         end

data/spec/praxis/routing_config_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Praxis::RoutingConfig do
+
+  let(:resource_definition) do
+    Class.new do
+      include Praxis::ResourceDefinition
+      def self.name; 'MyResource'; end
+    end
+  end
+
+  let(:routing_block) { Proc.new{} }
+  let(:default_route_prefix) { "/" + resource_definition.name.split("::").last.underscore }
+
+  subject(:routing_config){ Praxis::RoutingConfig.new(&routing_block) }
+
+  its(:version) { should eq('n/a') }
+  its(:prefix ) { should eq('') }
+
+  context '#prefix' do
+    it 'sets the prefix' do
+      routing_config.prefix '/'
+      expect(routing_config.prefix).to eq('/')
+    end
+
+    it 'is additive' do
+      routing_config.prefix '/people/:id'
+      routing_config.prefix '/address'
+      expect(routing_config.prefix).to eq('/people/:id/address')
+    end
+
+    it 'strips duplicated /s' do
+      routing_config.prefix '/'
+      routing_config.prefix '/people'
+      expect(routing_config.prefix).to eq('/people')
+    end
+
+  end
+
+  context '#add_route' do
+    let(:path) { '/people' }
+    let(:options) { {} }
+    let(:route) { routing_config.add_route 'GET', path, **options}
+
+    it 'returns a corresponding Praxis::Route' do
+      expect(route).to be_kind_of(Praxis::Route)
+    end
+
+    it 'appends the Route to the set of routes' do
+      expect(routing_config.routes).to include(route)
+    end
+
+    context 'passing  options' do
+      let(:options){ {name: 'alternative', except: '/special' } }
+
+      it 'uses :name to name the route' do
+        expect(route.name).to eq('alternative')
+      end
+
+      it 'does NOT pass the name option down to mustermann' do
+        expect(Mustermann).to receive(:new).with(path, hash_excluding({name: 'alternative'}))
+        expect(route.name).to eq('alternative')
+      end
+
+      it 'passes them through the underlying mustermann object (telling it to ignore unknown ones)' do
+        expect(Mustermann).to receive(:new).with(path, hash_including(ignore_unknown_options: true, except: '/special'))
+        expect(route.options).to eq( { except: '/special' })
+      end
+    end
+
+    context 'with prefix defined' do
+      before do
+        routing_config.prefix '/parents/:parent_id'
+      end
+
+      it 'includes the prefix in the route path' do
+        expect(route.path.to_s).to eq '/parents/:parent_id/people'
+      end
+
+      context 'for paths beginning with //' do
+        let(:path) { '//people' }
+        it 'does not include the prefix in the route path' do
+          expect(route.path.to_s).to eq '/people'
+        end
+      end
+    end
+  end
+
+end

data/spec/praxis/trait_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Praxis::Trait do
+
+  subject(:trait) do
+    Praxis::Trait.new do
+      description 'my awesome trait'
+
+      routing do
+        prefix '/:app_name'
+      end
+
+      response :something
+      response :nothing
+
+      params do
+        attribute :app_name, String
+        attribute :order, String,
+          description: "Field to sort by."
+      end
+
+    end
+  end
+
+  context 'describe' do
+    subject(:describe) { trait.describe }
+
+    its([:description]) { should eq('my awesome trait') }
+    
+    its([:responses, :something]) { should eq Hash.new }
+    its([:responses, :nothing]) { should eq Hash.new }
+    
+    its([:params, :app_name, :type, :name]) { should eq 'String' }
+    its([:params, :order, :type, :name]) { should eq 'String' }
+    its([:routing, :prefix]) { should eq '/:app_name'}
+  end
+
+end

data/spec/spec_app/app/controllers/instances.rb

@@ -3,7 +3,7 @@ class Instances < BaseClass
 
   implements ApiResources::Instances
   include Concerns::BasicApi
-  
+
   before :validate, actions: [:index]  do |controller|
     #p [:before, :validate, :params_and_headers, controller.request.action.name]
   end
@@ -32,7 +32,7 @@ class Instances < BaseClass
     blk.call
     #puts "Decorator two end"
   end
-  
+
   around :action, actions: [:index] do |controller, blk|
     #puts "Decorator three (index action) start"
     blk.call
@@ -104,4 +104,8 @@ class Instances < BaseClass
     response
   end
 
+  def exceptional(cloud_id:, splat:)
+    response.headers['Content-Type'] = 'application/vnd.acme.instance'
+    response
+  end
 end

data/spec/spec_app/design/resources/instances.rb

@@ -4,18 +4,16 @@ module ApiResources
 
     media_type Instance
     version '1.0'
-    
+
     # :show action is the canonical path for this resource.
     # Note that the following is redundant, since :show is the default canonical path if none is defined.
     canonical_path :show
-    
-    routing do
-      prefix '/clouds/:cloud_id/instances'
-    end
 
-    action_defaults do
-      use :authenticated
+    prefix '/clouds/:cloud_id/instances'
+
+    trait :authenticated
 
+    action_defaults do
       requires_ability :read
 
       params do
@@ -31,7 +29,7 @@ module ApiResources
       params do
         attribute :response_content_type, String, default: 'application/vnd.acme.instance;type=collection'
       end
-      
+
       headers do
         # BOTH ARE EQUIVALENT
         #key "FOO", String, required: true
@@ -130,14 +128,14 @@ module ApiResources
       routing do
         any '/:id/terminate'
       end
-      
+
       requires_ability :terminate
 
       params do
         attribute :id
       end
 
-      payload do 
+      payload do
         attribute :when, DateTime
       end
 
@@ -175,6 +173,17 @@ module ApiResources
       response :ok
     end
 
+
+    action :exceptional do
+      routing do
+        prefix '//clouds/:cloud_id/otherinstances'
+        get '/_action/*', except: '*/_action/exceptional'
+      end
+      params do
+        attribute :splat, Attributor::Collection.of(String), required: true
+      end
+      response :ok
+    end
     # OTHER USAGES:
     #   note: these are all hypothetical, pending, brainstorming usages.
 

data/spec/spec_app/design/resources/volumes.rb

@@ -5,10 +5,10 @@ module ApiResources
     media_type Volume
     version '1.0', using: :path
 
-    action_defaults do
-      use :authenticated
-    end
+    prefix '/volumes'
 
+    trait :authenticated
+    
     action :index do
       routing do
         get ''

data/spec/support/spec_resource_definitions.rb

@@ -1,5 +1,11 @@
 require_relative 'spec_media_types'
 
+Praxis::ApiDefinition.define do
+  trait :test do
+    description 'testing trait'
+  end
+end
+
 class PeopleResource
   include Praxis::ResourceDefinition
 
@@ -11,9 +17,9 @@ class PeopleResource
 
   canonical_path :show
 
-  routing do
-    prefix "/people"
-  end
+  trait :test
+
+  prefix '/people'
 
   action :index do
     description 'index description'
@@ -34,6 +40,7 @@ class PeopleResource
 
 end
 
+
 class AddressResource
   include Praxis::ResourceDefinition
 
@@ -43,9 +50,7 @@ class AddressResource
 
   version '1.0'
 
-  routing do
-    prefix "/addresses"
-  end
+  prefix '/addresses'
 
   action :index do
     description 'index description'