praxis 2.0.pre.3 → 2.0.pre.8

data/spec/praxis/request_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe Praxis::Request do
   let(:path) { '/instances/1?junk=foo&api_version=1.0' } 
-  let(:rack_input) { StringIO.new('something=given') }
-  let(:env_content_type){ 'application/x-www-form-urlencoded' }
+  let(:rack_input) { StringIO.new('{"something": "given"}') }
+  let(:env_content_type){ 'application/json' }
   let(:env) do
     env = Rack::MockRequest.env_for(path)
     env['rack.input'] = rack_input
@@ -192,7 +192,7 @@ describe Praxis::Request do
     end
 
     context '#validate_payload' do
-      before { request.load_payload('') }
+      before { request.load_payload('{}') }
       it 'should validate payload' do
         expect(request.payload).to receive(:validate).and_return([])
         request.validate_payload(context[:payload])
@@ -208,22 +208,11 @@ describe Praxis::Request do
       let(:load_context){ context[:payload] }
       let(:parsed_result){ double("parsed") }
 
-      before do
-        Praxis::Application.instance.handler 'xml', Praxis::Handlers::XML
-      end
-
       after do
         expect(request.action.payload).to receive(:load).with(parsed_result, load_context, content_type: request.content_type.to_s )
         request.load_payload( load_context )
       end
 
-      context 'that is url-encoded' do
-        let(:env_content_type){ 'application/x-www-form-urlencoded' }
-        let(:parsed_result) { {"something" => "given"} }
-
-        it 'decodes it the www-form handler' do end
-      end
-
       context 'that is json encoded' do
         let(:rack_input) { StringIO.new('{"one":1,"sub_hash":{"first":"hello"}}') }
         let(:env_content_type){ 'application/json' }
@@ -231,14 +220,6 @@ describe Praxis::Request do
 
         it 'decodes using the JSON handler' do end
       end
-      context 'that is xml encoded' do
-        let(:rack_input) { StringIO.new('<hash><one type="integer">1</one><sub_hash><first>hello</first></sub_hash></hash>') }
-        let(:env_content_type) { 'application/xml' }
-        let(:parsed_result) { Praxis::Handlers::XML.new.parse(request.raw_payload) }
-
-        it 'decodes using the XML handler' do end
-      end
-
     end
   end
 end

data/spec/praxis/resource_definition_spec.rb

@@ -137,7 +137,7 @@ describe Praxis::ResourceDefinition do
     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/:base_param/people/:id'
+      expect(action.route.path.to_s).to eq '/api/:base_param/people/:id'
     end
 
     context 'includes base_params from the APIDefinition' do

data/spec/praxis/response_definition_spec.rb

@@ -514,22 +514,18 @@ describe Praxis::ResponseDefinition do
 
     context 'for a definition with a media type' do
       let(:media_type) { Instance }
-      subject(:payload) { output[:payload] }
+      subject(:payload) { output[:payload][:type] }
 
       before do
         response.media_type Instance
       end
-
       its([:name]) { should eq 'Instance' }
       context 'examples' do
         subject(:examples) { payload[:examples] }
         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])
-          xml = Praxis::Application.instance.handlers['xml'].parse(examples['xml'][:body])
-          expect(json).to eq xml
+          expect(JSON.parse(examples['json'][:body])).to be_kind_of(Hash)
         end
 
       end
@@ -542,7 +538,6 @@ describe Praxis::ResponseDefinition do
 
         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
 
@@ -571,7 +566,9 @@ describe Praxis::ResponseDefinition do
         end
 
         it{ should be_kind_of(::Hash) }
-        its([:payload]){ should ==  {id: 'Praxis-SimpleMediaType', name: 'Praxis::SimpleMediaType', family: 'string', identifier: 'foobar' } }
+        it 'has the right type info' do
+          expect(subject[:payload][:type]).to match(id: 'Praxis-SimpleMediaType', name: 'Praxis::SimpleMediaType', family: 'string', identifier: 'foobar')
+        end
         its([:status]){ should == 200 }
       end
       context 'using a full response definition block' do
@@ -587,7 +584,9 @@ describe Praxis::ResponseDefinition do
         end
 
         it{ should be_kind_of(::Hash) }
-        its([:payload]) { should == {id: 'Praxis-SimpleMediaType', name: 'Praxis::SimpleMediaType', family: 'string', identifier: 'custom_media'} }
+        it 'has the right type info' do
+          expect(subject[:payload][:type]).to match(id: 'Praxis-SimpleMediaType', name: 'Praxis::SimpleMediaType', family: 'string', identifier: 'custom_media')
+        end
         its([:status]) { should == 234 }
       end
     end

data/spec/praxis/route_spec.rb

@@ -5,21 +5,19 @@ describe Praxis::Route do
   let(:verb) { 'GET' }
   let(:path) { '/base/stuff' }
   let(:prefixed_path) { '/stuff' }
-  let(:name) { nil }
   let(:version) { '1.0' }
   let(:options) { {} }
 
-  subject(:route) { Praxis::Route.new(verb, path, version, name: name, prefixed_path: prefixed_path, **options) }
+  subject(:route) { Praxis::Route.new(verb, path, version, prefixed_path: prefixed_path, **options) }
 
   its(:verb) { should be(verb) }
   its(:path) { should be(path) }
-  its(:name) { should be(name) }
   its(:version) { should be(version) }
   its(:prefixed_path) { should eq(prefixed_path) }
   its(:options) { should eq(options) }
 
   it 'defaults version to "n/a"' do
-    route = Praxis::Route.new(verb, path, name: name, **options)
+    route = Praxis::Route.new(verb, path, **options)
     expect(route.version).to eq('n/a')
   end
 
@@ -27,11 +25,6 @@ describe Praxis::Route do
     subject(:description) { route.describe }
     it { should eq({verb:verb, path:path , version:version}) }
 
-    context 'with a named route' do
-      let(:name) { :stuff }
-      its([:name]) { should eq(name) }
-    end
-
     context 'with options' do
       let(:options) { {option: 'value'} }
       its([:options]) { should eq(options) }

data/spec/praxis/routing_config_spec.rb

@@ -43,26 +43,17 @@ describe Praxis::RoutingConfig do
     let(:options) { {} }
     let(:base_path){ '/api' }
     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)
+    it 'sets the Route to its route' do
+      expect(route).to eq(routing_config.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(base_path + path, hash_excluding({name: 'alternative'}))
-        expect(route.name).to eq('alternative')
-      end
+      let(:options){ { except: '/special' } }
 
       it 'passes them through the underlying mustermann object (telling it to ignore unknown ones)' do
         expect(Mustermann).to receive(:new).with(base_path + path, hash_including(ignore_unknown_options: true, except: '/special'))

data/spec/praxis/types/multipart_array_spec.rb

@@ -41,14 +41,6 @@ describe Praxis::Types::MultipartArray do
     entity = MIME::Application.new('file2')
     form_data.add entity,'files', 'file2'
 
-    entity = MIME::Application.new('
-      <?xml version="1.0" encoding="UTF-8"?>
-      <hash>
-        <first_name>James</first_name>
-      </hash>
-      ', 'xml')
-    form_data.add entity,'stuff1'
-
     entity = MIME::Application.new('{"first_name": "Frank"}', 'json')
     form_data.add entity,'stuff2'
 
@@ -81,9 +73,6 @@ describe Praxis::Types::MultipartArray do
     files = payload.part('files')
     expect(files).to have(2).items
 
-    stuff1 = payload.part('stuff1')
-    expect(stuff1.payload['first_name']).to eq 'James'
-
     stuff2 = payload.part('stuff2')
     expect(stuff2.payload['first_name']).to eq 'Frank'
 
@@ -274,7 +263,7 @@ describe Praxis::Types::MultipartArray do
 
       let(:example) { type.example }
 
-      let(:default_format) { 'xml' }
+      let(:default_format) { 'json' }
 
       let(:output) { example.dump(default_format: default_format) }
 
@@ -282,29 +271,23 @@ describe Praxis::Types::MultipartArray do
 
       it 'dumps the parts with the proper handler' do
         json_handler = Praxis::Application.instance.handlers['json']
-        xml_handler = Praxis::Application.instance.handlers['xml']
 
         # title is simple string, so should keep text/plain
         title = parts.find { |part| part.name == 'title' }
         expect(title.content_type.to_s).to eq 'text/plain'
         expect(title.payload).to eq example.part('title').payload
 
-        # things are structs with no content-type header defined
-        thing = parts.find { |part| part.name == 'thing' }
-        expect(thing.content_type.to_s).to eq 'application/xml'
-        expect(thing.payload).to eq xml_handler.generate(example.part('thing').payload.dump)
-
         # stuff has hardcoded 'application/json' content-type, and should remain such
         stuff = parts.find { |part| part.name == 'stuff' }
         expect(stuff.content_type.to_s).to eq 'application/json'
         expect(stuff.payload).to eq json_handler.generate(example.part('stuff').payload.dump)
 
         # instances just specify 'application/vnd.acme.instance', and should
-        # have xml suffix appended
+        # have json suffix appended
         instances = parts.select { |part| part.name == 'instances' }
         instances.each_with_index do |instance, i|
-          expect(instance.content_type.to_s).to eq 'application/vnd.acme.instance+xml'
-          expect(instance.payload).to eq xml_handler.generate(example.part('instances')[i].payload.dump)
+          expect(instance.content_type.to_s).to eq 'application/vnd.acme.instance+json'
+          expect(instance.payload).to eq json_handler.generate(example.part('instances')[i].payload.dump)
         end
       end
 

data/spec/spec_app/config/environment.rb

@@ -14,8 +14,6 @@ end
 
 Praxis::Application.configure do |application|
 
-  application.handler 'xml', Praxis::Handlers::XML
-
   application.middleware SetHeader, 'Spec-Middleware', 'used'
 
   application.bootloader.use SimpleAuthenticationPlugin, config_file: 'config/authentication.yml'

data/spec/spec_app/design/api.rb

@@ -24,9 +24,15 @@ Praxis::ApiDefinition.define do
     description "This example API should really be replaced by a set of more full-fledged example apps in the future"
 
     base_path "/api"
-    produces 'json','xml'
+    produces 'json'
     #version_with :path
     #base_path "/v:api_version"
+
+    # Custom attributes (for OpenApi, for example)
+    termsOfService "http://example.com/tos"
+    contact name: 'Joe', email: 'joe@email.com'
+    license name: "Apache 2.0",
+            url: "https://www.apache.org/licenses/LICENSE-2.0.html"
   end
 
   info '1.0' do # Applies to 1.0 version (and inherits everything else form the global one)

data/spec/spec_app/design/media_types/instance.rb

@@ -14,16 +14,11 @@ class Instance < Praxis::MediaType
 
     attribute :volumes, Volume::Collection
     
-    links do
-      link :root_volume
-      link :other_volume, Volume, using: :data_volume
-    end
   end
 
   view :default do
     attribute :id
     attribute :root_volume
-    attribute :links
   end
 
   view :link do
@@ -40,9 +35,6 @@ class Instance < Praxis::MediaType
     attribute :id
     attribute :name
     attribute :root_volume
-    attribute :links do
-      attribute :root_volume
-    end
   end
 
 

data/spec/spec_app/design/media_types/volume.rb

@@ -9,12 +9,6 @@ class Volume < Praxis::MediaType
 
     attribute :snapshots, Praxis::Collection.of(VolumeSnapshot)
     attribute :snapshots_summary, VolumeSnapshot::CollectionSummary
-
-    links do
-      link :source
-      link :snapshots, VolumeSnapshot::CollectionSummary, using: :snapshots_summary
-    end
-
   end
 
   view :default do
@@ -22,12 +16,6 @@ class Volume < Praxis::MediaType
     attribute :name
     attribute :source
     attribute :snapshots
-
-    attribute :links
-  end
-
-  view :link do
-    attribute :id
   end
 
   class Collection < Praxis::Collection

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

@@ -44,7 +44,6 @@ module ApiResources
     action :show do
       routing do
         get '/:id'
-        get '/something/:id', name: :alternate
       end
 
       response :ok, media_type: 'application/json'
@@ -144,7 +143,7 @@ module ApiResources
         attribute :id
       end
 
-      payload do
+      payload required: false do
         attribute :when, DateTime
       end
 

data/spec/spec_helper.rb

@@ -7,6 +7,12 @@ $:.unshift File.expand_path('support',__dir__)
 
 require 'bundler'
 Bundler.setup :default, :test
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end
+
 require 'simplecov'
 SimpleCov.start 'praxis'
 

data/spec/support/spec_media_types.rb

@@ -6,22 +6,13 @@ class Person < Praxis::MediaType
     attribute :id, Integer
     attribute :name, String, example: /[:name:]/
     attribute :href, String, example: proc { |person| "/people/#{person.id}" }
-    attribute :links, Attributor::Collection.of(String),
-      description: 'Here to ensure an explicit links attribute works'
-
   end
 
   view :default do
     attribute :id
     attribute :name
-    attribute :links
   end
 
-  view :link do
-    attribute :id
-    attribute :name
-    attribute :href
-  end
 
   class CollectionSummary < Praxis::MediaType
     attributes do
@@ -29,11 +20,6 @@ class Person < Praxis::MediaType
       attribute :size, Integer
     end
 
-    view :link do
-      attribute :href
-      attribute :size
-    end
-
     view :default do
       attribute :href
     end
@@ -59,14 +45,6 @@ class Address < Praxis::MediaType
     attribute :residents_summary, Person::CollectionSummary
 
     attribute :fields, Praxis::Types::FieldSelector.for(Person)
-
-    links do
-      link :owner
-      link :super, Person, using: :manager
-      link :caretaker, using: :custodian
-      link :residents, using: :residents_summary
-    end
-
   end
 
   view :default do
@@ -74,15 +52,7 @@ class Address < Praxis::MediaType
     attribute :name
     attribute :owner
     attribute :fields
-
-    attribute :links
-  end
-
-  view :link do
-    attribute :id
-    attribute :name
   end
-
 end
 
 
@@ -123,10 +93,6 @@ class Blog < Praxis::MediaType
       example: proc { |blog,ctx| Post::CollectionSummary.example(ctx, href: "#{blog.href}/posts") },
       description: "Summary of information from related Post resources"
 
-    links do
-      link :posts, using: :posts_summary
-      link :owner
-    end
   end
 
   view :default do
@@ -138,7 +104,6 @@ class Blog < Praxis::MediaType
     attribute :timestamps
 
     attribute :owner
-    attribute :links
   end
 
   view :overview do
@@ -146,11 +111,6 @@ class Blog < Praxis::MediaType
     attribute :name
     attribute :description
   end
-
-  view :link do
-    attribute :href
-  end
-
 end
 
 
@@ -185,11 +145,6 @@ class Post < Praxis::MediaType
       attribute :created_at, DateTime
       attribute :updated_at, DateTime
     end
-
-    links do
-      link :author
-      link :blog
-    end
   end
 
   view :default do
@@ -202,23 +157,13 @@ class Post < Praxis::MediaType
     attribute :author
 
     attribute :timestamps
-    attribute :links
-  end
-
-  view :link do
-    attribute :href
   end
 
-
   class CollectionSummary < Praxis::MediaType
     attributes do
       attribute :href, String
       attribute :count, Integer
     end
-
-    view :link do
-      attribute :href
-    end
   end
 end
 
@@ -251,12 +196,6 @@ class User < Praxis::MediaType
 
     attribute :posts_summary, Post::CollectionSummary,
       example: proc { |user,ctx| Post::CollectionSummary.example(ctx, href: "#{user.href}/posts") }
-
-    links do
-      link :posts, using: :posts_summary
-      link :primary_blog
-    end
-
   end
 
   view :default do
@@ -265,8 +204,6 @@ class User < Praxis::MediaType
 
     attribute :first
     attribute :last
-
-    attribute :links
   end
 
   view :extended do
@@ -276,20 +213,10 @@ class User < Praxis::MediaType
     attribute :first
     attribute :last
     attribute :primary_blog, view: :overview
-
-    attribute :links
   end
 
   view :with_post_links do
     attribute :id
     attribute :posts, view: :link
   end
-
-  view :link do
-    attribute :href
-  end
-
-  view :summary do
-    attribute :links
-  end
 end