praxis 0.20.1 → 0.21

data/lib/praxis/trait.rb

@@ -12,7 +12,7 @@ module Praxis
       @other = []
 
       @attribute_groups = Hash.new do |h,k|
-        h[k] = Trait.new
+        h[k] = []
       end
 
       if block_given?
@@ -34,7 +34,7 @@ module Praxis
     end
 
     def create_group(name, &block)
-      @attribute_groups[name] = block
+      @attribute_groups[name] << block
     end
 
     def headers(*args, &block)
@@ -68,7 +68,7 @@ module Praxis
         desc[:routing] = ConfigHash.new(&@routing).to_hash
       end
 
-      @attribute_groups.each_with_object(desc) do |(name, block), hash|
+      @attribute_groups.each_with_object(desc) do |(name, blocks), hash|
         type_class = if name == :headers
           # Headers are special:
           # Keys are strings, they have a special DSL, and are case insensitive
@@ -76,9 +76,12 @@ module Praxis
             dsl_compiler: ActionDefinition::HeadersDSLCompiler,
             case_insensitive_load: true
           }
-          Attributor::Hash.of(key: String).construct(block, hash_opts)
+          Attributor::Hash.of(key: String).construct(Proc.new {}, hash_opts)
         else
-          Attributor::Hash.construct(block)
+          Attributor::Hash.construct(Proc.new {})
+        end
+        blocks.each do |block|
+          type_class.construct(block)
         end
         hash[name] = type_class.describe[:attributes]
       end
@@ -88,8 +91,10 @@ module Praxis
 
 
     def apply!(target)
-      @attribute_groups.each do |name, block|
-        target.send(name, &block)
+      @attribute_groups.each do |name, blocks|
+        blocks.each do |block|
+          target.send(name, &block)
+        end
       end
 
       if @routing

data/lib/praxis/validation_handler.rb

@@ -3,7 +3,8 @@ module Praxis
 
     # Should return the Response to send back
     def handle!(summary:, request:, stage:, errors: nil, exception: nil, **opts)
-      Responses::ValidationError.new(summary: summary, errors: errors, exception: exception, **opts)
+      documentation = Docs::LinkBuilder.instance.for_request request
+      Responses::ValidationError.new(summary: summary, errors: errors, exception: exception, documentation: documentation, **opts)
     end
 
   end

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.20.1'
+  VERSION = '0.21'
 end

data/praxis.gemspec

@@ -24,9 +24,9 @@ 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', '~> 4.2'
-  spec.add_dependency 'praxis-blueprints', '~> 3.2'
-  spec.add_dependency 'attributor', '~> 5.0.2'
+  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 'terminal-table', '~> 1.4'
   spec.add_dependency 'harness', '~> 2'
@@ -34,9 +34,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 0.9'
   spec.add_development_dependency 'rake-notes', '~> 0'
-  spec.add_development_dependency 'pry', '~> 0'
-  spec.add_development_dependency 'pry-byebug', '~> 1'
-  spec.add_development_dependency 'pry-stack_explorer', '~> 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 'sqlite3', '~> 1'
+  else
+    spec.add_development_dependency 'jdbc-sqlite3'
+  end
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its', '~> 1'
   spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
@@ -47,6 +52,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0'
   spec.add_development_dependency 'fuubar', '~> 2'
   spec.add_development_dependency 'yard', '~> 0'
-  spec.add_development_dependency 'sqlite3', '~> 1'
   spec.add_development_dependency 'coveralls'
 end

data/spec/api_browser/filters/attribute_name_spec.js

@@ -8,10 +8,10 @@ describe('attributeName filter', function() {
     };
   }));
 
-  it('only modifies input with one dot', function() {
+  it('only modifies input with one or more dots', function() {
     expect(function(str) {
       var dotsCount = str.split('.').length - 1;
-      if (dotsCount !== 1) {
+      if (dotsCount === 0) {
         return str === filter(str);
       }
     }).forAll(qc.string);

data/spec/praxis/action_definition_spec.rb

@@ -2,10 +2,15 @@ require 'spec_helper'
 
 describe Praxis::ActionDefinition do
   class SpecMediaType < Praxis::MediaType
+    identifier 'application/json'
+
     attributes do
       attribute :one, String
       attribute :two, Integer
     end
+    view :default do
+      attribute :one
+    end
   end
 
   let(:resource_definition) do
@@ -28,11 +33,22 @@ describe Praxis::ActionDefinition do
   end
 
   subject(:action) do
+
+    Praxis::ApiDefinition.define do |api|
+      api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
+        status 200
+
+        media_type media_type
+        location location
+        headers headers if headers
+      end
+    end
     Praxis::ActionDefinition.new(:foo, resource_definition) do
       routing { get '/:one' }
       payload { attribute :two, String }
       headers { header "X_REQUESTED_WITH", 'XMLHttpRequest' }
       params  { attribute :one, String }
+      response :ok, headers: { "Foo" => "Bar"}, location: %r{/some/thing}
     end
   end
 
@@ -53,11 +69,13 @@ describe Praxis::ActionDefinition do
     before do
       action.response :ok
       action.response :internal_server_error
+      action.response :created, location: 'foobar'
     end
 
     it { should be_kind_of Hash }
     it { should include :ok }
     it { should include :internal_server_error }
+    it { should include :created }
   end
 
   describe '#allowed_responses' do
@@ -252,6 +270,10 @@ describe Praxis::ActionDefinition do
       end
     end
 
+    context 'responses' do
+      subject(:response_description) { describe[:responses] }
+      its(:keys) { should include(:ok) }
+    end
   end
 
   context 'href generation' do
@@ -318,7 +340,7 @@ describe Praxis::ActionDefinition do
     end
 
     its('routes.first.path.to_s') { should eq '/apps/:app_name/foobars/hello_world/:one' }
-    its('params.attributes.keys') { should eq [:inherited, :app_name, :one]}
+    its('params.attributes.keys') { should match_array [:inherited, :app_name, :one]}
 
     context 'where the action overrides a base_param' do
 

data/spec/praxis/bootloader_spec.rb

@@ -70,5 +70,33 @@ describe Praxis::Bootloader do
       bootloader.use(plugin)
       expect(bootloader.application.plugins[:foo].class).to be(plugin)
     end
+
+    it "complains if a plugin with same name already registered" do
+      bootloader.use(plugin)
+      expect do
+        bootloader.use(plugin)
+      end.to raise_error /another plugin (.*) is already registered with key: foo/
+    end
+    context "defaults config_key" do
+      let(:plugin_two) do
+        Class.new(Praxis::Plugin) do
+          def self.name
+            "Two" # Need this to avoid creating a true named class.
+          end
+        end
+      end
+
+      it "to the class name" do
+        bootloader.use(plugin_two)
+        expect(bootloader.application.plugins[:two].class).to be(plugin_two)
+      end
+
+      it 'but raises if class is anonymous' do
+        plugin_anon = Class.new(Praxis::Plugin) {}
+        expect do
+          bootloader.use(plugin_anon)
+        end.to raise_error(/It does not have a config_key defined, and its class does not have a name/)
+      end
+    end
   end
 end

data/spec/praxis/extensions/field_expansion_spec.rb

@@ -91,6 +91,16 @@ describe Praxis::Extensions::FieldExpansion do
         end
       end
     end
+
+
+    context 'with an action with no params' do
+      let(:test_params) { nil }
+      let(:fields){ nil }
+      let(:view){ nil }
+      it 'ignores incoming parameters and expands for the default view' do
+        expect(expansion).to eq({id: true, name: true, links: [true]})
+      end
+    end
   end
 
 end

data/spec/praxis/middleware_app_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Praxis::MiddlewareApp do
+
+  context '.for' do
+    let(:init_args){ { root: 'here'} }
+    subject(:middleware) { Praxis::MiddlewareApp.for( init_args ) }
+
+    it 'initializes the application singletone with the passed parameters' do
+      expect( Praxis::Application.instance ).to receive(:setup).with( init_args ).once
+      subject
+    end
+    it 'returns its class' do
+      expect( subject ).to be( Praxis::MiddlewareApp )
+    end
+  end
+
+  context 'instantiated' do
+    let(:target_response){ [201,{}] }
+    let(:target){ double("target app", call: target_response) }
+    subject(:instance){ Praxis::MiddlewareApp.new(target)}
+    it 'saves the target app' do
+      expect(subject.target).to be(target)
+    end
+    context '.call' do
+      let(:env){ {} }
+      let(:praxis_response){ [200,{}] }
+      subject(:response){ Praxis::MiddlewareApp.new(target).call(env) }
+      before do
+        # always invokes the praxis app
+        expect( Praxis::Application.instance ).to receive(:call).with( env ).once.and_return(praxis_response)
+      end
+
+      context 'properly handled (non-404 and 405) responses from praxis' do
+        it 'are returned straight through' do
+          expect( response ).to be(praxis_response)
+        end
+      end
+
+      context '404/405 responses with X-Cascade = pass' do
+        let(:praxis_response){ [404, {'X-Cascade' => 'pass'}]}
+        it 'are forwarded to the target app' do
+          expect( response ).to be(target_response)
+        end
+      end
+
+      context '404/405 responses without X-Cascade = pass' do
+        let(:praxis_response){ [404, {}]}
+        it 'returned straight through' do
+          expect( response ).to be(praxis_response)
+        end
+      end
+    end
+  end
+end

data/spec/praxis/plugins/praxis_mapper_plugin_spec.rb

@@ -4,7 +4,6 @@ describe Praxis::Plugins::PraxisMapperPlugin do
 
   subject(:plugin) { Praxis::Plugins::PraxisMapperPlugin::Plugin.instance }
   let(:config) { plugin.config }
-
   context 'Plugin' do
     context 'configuration' do
       subject { config }
@@ -15,8 +14,14 @@ describe Praxis::Plugins::PraxisMapperPlugin do
       context 'default repository' do
         subject(:default) { config.repositories['default'] }
         its(['type']) { should eq 'sequel' }
-        its(['connection_settings']) do
-          should eq('adapter' => 'sqlite','database' => ':memory:')
+        it 'has the right connection settings' do
+          if RUBY_PLATFORM !~ /java/
+            expect(subject['connection_settings'].dump).to eq( 'adapter' => 'sqlite','database' => ':memory:' )
+          else
+            expect(subject['connection_settings'].dump).to eq( 'adapter' => 'jdbc', 'uri' => 'jdbc:sqlite::memory:' )
+          end
+
+
         end
       end
 

data/spec/praxis/resource_definition_spec.rb

@@ -26,7 +26,7 @@ describe Praxis::ResourceDefinition do
 
     context 'for a resource with a parent' do
       let(:resource_definition) { ApiResources::VolumeSnapshots}
-      
+
       its([:parent]) { should eq ApiResources::Volumes.id }
     end
 
@@ -78,6 +78,7 @@ describe Praxis::ResourceDefinition do
         include Praxis::ResourceDefinition
         media_type Person
 
+        version '1.0'
         def self.name
           'FooBar'
         end
@@ -101,12 +102,60 @@ describe Praxis::ResourceDefinition do
       end
     end
 
+    let(:non_singleton_api) do
+      api_def=Praxis::ApiDefinition.__send__(:new)
+      api_def.instance_eval do |api|
+
+        api.info do
+          base_path '/api/:base_param'
+          base_params do
+            attribute :base_param, String
+            attribute :grouped_params do
+              attribute :nested_param, String
+            end
+          end
+        end
+
+        api.info '1.0' do
+          base_params do
+            attribute :app_name, String
+          end
+        end
+        api.info '2.0' do
+          base_params do
+            attribute :v2_param, String
+          end
+        end
+      end
+      api_def
+    end
+
+    before do
+      allow(Praxis::ApiDefinition).to receive(:instance).and_return(non_singleton_api)
+    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 '/api/people/:id'
+      expect(action.routes.first.path.to_s).to eq '/api/:base_param/people/:id'
     end
 
+    context 'includes base_params from the APIDefinition' do
+      let(:show_action_params){ resource_definition.actions[:show].params }
+
+      it 'including globally defined' do
+        expect(show_action_params.attributes).to have_key(:base_param)
+        expect(show_action_params.attributes).to have_key(:grouped_params)
+        grouped = show_action_params.attributes[:grouped_params]
+        expect(grouped.type.ancestors).to include(::Attributor::Struct)
+        expect(grouped.type.attributes.keys).to eq([:nested_param])
+      end
+      it 'including the ones defined for its own version' do
+        expect(show_action_params.attributes).to have_key(:app_name)
+        expect(show_action_params.attributes).to_not have_key(:v2_param)
+      end
+
+    end
   end
 
   context 'setting other values' do

data/spec/praxis/response_definition_spec.rb

@@ -448,7 +448,7 @@ describe Praxis::ResponseDefinition do
         context 'with legacy multipart response' do
           subject(:response) { Praxis::Responses::Ok.new(status: response_status, headers: response_headers) }
 
-          let(:part) { Praxis::MultipartPart.new('done', {'Status' => 200, 'Content-Type' => 'application/special'}) }
+          let(:part) { Praxis::MultipartPart.new('done', {'Status' => 200, 'Content-Type' => 'application/special'},{}) }
 
           before do
             response_definition.parts like: :ok, media_type: 'application/special'
@@ -463,7 +463,7 @@ describe Praxis::ResponseDefinition do
           end
 
           context 'with invalid part' do
-            let(:part) { Praxis::MultipartPart.new('done', {'Status' => 200, "Location" => "somewhere"}) }
+            let(:part) { Praxis::MultipartPart.new('done', {'Status' => 200, "Location" => "somewhere"},{}) }
 
             it 'validates' do
               expect {
@@ -520,8 +520,8 @@ describe Praxis::ResponseDefinition do
       its([:name]) { should eq 'Instance' }
       context 'examples' do
         subject(:examples) { payload[:examples] }
-        its(['json', :content_type]) { 'application/vnd.acme.instance+json '}
-        its(['xml', :content_type]) { 'application/vnd.acme.instance+xml' }
+        its(['json', :content_type]) { should eq('application/vnd.acme.instance+json') }
+        its(['xml', :content_type]) { should eq('application/vnd.acme.instance+xml') }
 
         it 'properly encodes the example bodies' do
           json = Praxis::Application.instance.handlers['json'].parse(examples['json'][:body])
@@ -531,6 +531,18 @@ describe Praxis::ResponseDefinition do
 
       end
 
+      context 'which does not have a identifier' do
+        subject(:examples) { payload[:examples] }
+        before do
+          allow(response.media_type).to receive(:identifier).and_return(nil)
+        end
+
+        it 'still renders examples but as pure handler types for contents' do
+          expect(subject['json'][:content_type]).to eq('application/json')
+          expect(subject['xml'][:content_type]).to eq('application/xml')
+        end
+      end
+
 
     end