praxis 0.14.0 → 0.15.0

data/spec/praxis/media_type_identifier_spec.rb

@@ -0,0 +1,209 @@
+require "spec_helper"
+
+describe Praxis::MediaTypeIdentifier do
+  let(:example) { 'application/ice-cream+sundae; nuts="true"; fudge="true"' }
+
+  subject { described_class.new(example) }
+
+  context '.load' do
+    it 'parses type/subtype' do
+      expect(subject.type).to eq('application')
+      expect(subject.subtype).to eq('ice-cream')
+    end
+
+    it 'parses suffix' do
+      expect(subject.suffix).to eq('sundae')
+    end
+
+    context 'given parameters' do
+      let(:example) { 'application/vnd.widget; encoding="martian"' }
+      let(:unquoted_example) { 'application/vnd.widget; encoding=martian' }
+      let(:tricky_example) { 'application/vnd.widget; sauce="yes; absolutely"' }
+
+      it 'handles quoted values' do
+        expect(described_class.new(example).parameters['encoding']).to eq('martian')
+      end
+
+      it 'handles unquoted values' do
+        expect(described_class.new(unquoted_example).parameters['encoding']).to eq('martian')
+      end
+
+      it 'handles quoted semicolons in values' do
+        pending("need to stop using a regexp to do a context-free parser's job")
+        expect(described_class.new(tricky_example).parameters['sauce']).to eq('yes; absolutely')
+      end
+
+
+    end
+
+    context 'given a malformed type' do
+      it 'tolerates extra slash or plus' do
+        ['man/bear/pig', 'c/c++', 'application/ice-cream+cone+dipped'].each do |eg|
+          expect(described_class.new(eg).to_s).to eq(eg)
+        end
+      end
+
+      it 'assumes application/XYZ' do
+        ['nachos', 'tacos with extra cheese!'].each do |eg|
+          prefix = eg.split(/\s+/).first
+          expect(described_class.new(eg).to_s).to eq("application/#{prefix}")
+        end
+      end
+    end
+  end
+
+  context '#match' do
+    subject { described_class }
+
+    # @example match anything
+    #      MediaTypeIdentifier.load('*/*').match('application/icecream+cone; flavor=vanilla') # => true
+    #
+    # @example match a subtype wildcard
+    #      MediaTypeIdentifier.load('image/*').match('image/jpeg') # => true
+    #
+    # @example match a specific type irrespective of structured syntax
+    #      MediaTypeIdentifier.load('application/vnd.widget').match('application/vnd.widget+json') # => true
+    #
+    # @example match a specific type, respective of important parameters but irrespective of extra parameters or structured syntax
+    #      MediaTypeIdentifier.load('application/vnd.widget; type=collection').match('application/vnd.widget+json; material=steel; type=collection') # => true
+
+    it 'accepts String' do
+      expect(subject.new('image/jpeg').match('image/jpeg')).to be_truthy
+      expect(subject.new('image/jpeg').match('image/png')).to be_falsey
+    end
+
+    it 'accepts MediaTypeIdentifier' do
+      expect(subject.new('image/jpeg').match(subject.new('image/jpeg'))).to be_truthy
+      expect(subject.new('image/jpeg').match(subject.new('image/png'))).to be_falsey
+    end
+
+    it 'understands type wildcards' do
+      expect(subject.new('*/*').match('application/pizza')).to be_truthy
+    end
+
+    it 'understands subtype wildcards' do
+      expect(subject.new('application/*').match('application/pizza')).to be_truthy
+      expect(subject.new('application/*').match('image/jpeg')).to be_falsey
+    end
+
+    it 'understands structured-syntax suffixes' do
+      expect(subject.new('application/vnd.widget').match('application/vnd.widget+json')).to be_truthy
+      expect(subject.new('application/vnd.widget+json').match('application/vnd.widget+xml')).to be_falsey
+    end
+
+    it 'understands parameters' do
+      expect(subject.new('application/vnd.widget; type=collection').match('application/vnd.widget; type=collection; material=steel')).to be_truthy
+      expect(subject.new('application/vnd.widget+json; material=steel').match('application/vnd.widget+xml; material=copper')).to be_falsey
+    end
+  end
+
+  context '#=~' do
+    subject { described_class.new('image/jpeg') }
+    it 'delegates to #match' do
+      expect(subject).to receive(:match).once
+      (described_class.new('image/jpeg') =~ subject)
+    end
+  end
+
+  context '#==' do
+    let(:example) { 'application/vnd.widget+xml; charset=UTF8' }
+    subject { described_class }
+
+    it 'compares all attributes' do
+      expect(subject.new('application/json')).not_to eq(subject.new('application/xml'))
+      expect(subject.new('application/vnd.widget+json')).not_to eq(subject.new('application/vnd.widget+xml'))
+      expect(subject.new('text/plain; charset=UTF8')).not_to eq(subject.new('text/plain; charset=martian'))
+
+      expect(subject.new(example)).to eq(subject.new(example))
+    end
+
+    it 'ignores parameter ordering' do
+      expect(subject.new('text/plain; a=1; b=2')).to eq(subject.new('text/plain; b=2; a=1'))
+    end
+  end
+
+  context '#to_s' do
+    subject { described_class.new(example) }
+
+    it 'includes type/subtype' do
+      expect(subject.to_s).to start_with('application/ice-cream')
+    end
+
+    it 'includes suffix' do
+      expect(subject.to_s).to start_with('application/ice-cream+sundae')
+    end
+
+    it 'canonicalizes parameter ordering' do
+      expect(subject.to_s).to end_with('; fudge=true; nuts=true')
+    end
+  end
+
+  context '#without_parameters' do
+    it 'excludes parameters' do
+      expect(subject.without_parameters.to_s).to eq('application/ice-cream+sundae')
+    end
+  end
+
+  context '#handler_name' do
+    subject { described_class }
+
+    let(:with_suffix) { 'application/vnd.widget+xml' }
+    let(:with_subtype) { 'text/xml' }
+    let(:with_both) { 'text/json+xml' } #nonsensical but valid!
+
+    it 'uses the suffix' do
+      expect(subject.new(with_suffix).handler_name).to eq('xml')
+    end
+
+    it 'uses the subtype' do
+      expect(subject.new(with_subtype).handler_name).to eq('xml')
+    end
+
+    it 'prefers the suffix' do
+      expect(subject.new(with_both).handler_name).to eq('xml')
+    end
+  end
+
+  context '#+' do
+    let(:simple_subject) { described_class.new('application/vnd.icecream') }
+    let(:complex_subject) { described_class.new('application/vnd.icecream+json; nuts="true"') }
+
+    it 'adds a suffix' do
+      expect(simple_subject + 'xml').to \
+        eq(described_class.new('application/vnd.icecream+xml'))
+      expect(simple_subject + '+xml').to \
+        eq(described_class.new('application/vnd.icecream+xml'))
+    end
+
+    it 'adds parameters' do
+      expect(simple_subject + 'nuts=true').to \
+      eq(described_class.new('application/vnd.icecream; nuts=true'))
+
+      expect(simple_subject + '; nuts=true').to \
+      eq(described_class.new('application/vnd.icecream; nuts=true'))
+    end
+
+    it 'adds suffix and parameters' do
+      expect(simple_subject + 'xml; nuts=true').to \
+      eq(described_class.new('application/vnd.icecream+xml; nuts=true'))
+    end
+
+    it 'replaces the suffix' do
+      expect(complex_subject + 'xml').to \
+        eq(described_class.new('application/vnd.icecream+xml; nuts=true'))
+    end
+
+    it 'replaces existing parameters and adds new ones' do
+      expect(complex_subject + 'nuts=false; cherry=true').to \
+      eq(described_class.new('application/vnd.icecream+json; cherry=true; nuts=false'))
+
+      expect(complex_subject + '; nuts=false; cherry=true').to \
+        eq(described_class.new('application/vnd.icecream+json; cherry=true; nuts=false'))
+    end
+
+    it 'replaces suffix and parameters and adds new ones' do
+      expect(complex_subject + 'json; nuts=false; cherry=true').to \
+      eq(described_class.new('application/vnd.icecream+json; cherry=true; nuts=false'))
+    end
+  end
+end

data/spec/praxis/media_type_spec.rb

@@ -3,9 +3,20 @@ require 'spec_helper'
 describe Praxis::MediaType do
   let(:owner_resource) { instance_double(Person, id: 100, name: /[:name:]/.gen, href: '/', links: ['one','two']) }
   let(:manager_resource) { instance_double(Person, id: 101, name: /[:name:]/.gen, href: '/', links: []) }
+  let(:custodian_resource) { instance_double(Person, id: 102, name: /[:name:]/.gen, href: '/', links: []) }
+  let(:residents_summary_resource) do
+    instance_double(Person::CollectionSummary, href: "/people", size: 2)
+  end
 
   let(:resource) do
-    double('address', id: 1, name: 'Home',owner: owner_resource, manager: manager_resource)
+    double('address', 
+      id: 1, 
+      name: 'Home',
+      owner: owner_resource,
+      manager: manager_resource,
+      custodian: custodian_resource,
+      residents_summary: residents_summary_resource
+    )
   end
 
   subject(:address) { Address.new(resource) }
@@ -20,7 +31,9 @@ describe Praxis::MediaType do
       it 'respects using' do
         expect(address.links.super).to be_kind_of(Person)
         expect(address.links.super.object).to be(resource.manager)
+        expect(address.links.caretaker.object).to be(resource.custodian)
       end
+
     end
   end
 
@@ -29,7 +42,25 @@ describe Praxis::MediaType do
   context 'accessor methods' do
     subject(:address_klass) { address.class }
 
-    its(:identifier)  { should be_kind_of(String) }
+    context '#identifier' do
+      context 'in praxis v0' do
+        it 'should be a kind of String' do
+          if Praxis::VERSION =~ /^0/
+            expect(subject.identifier).to be_kind_of(String)
+          else
+            raise 'Please remove this spec which is no longer pertinent'
+          end
+        end
+      end
+
+      context 'in praxis v1.0 and beyond' do
+        it 'should be a kind of Praxis::MediaTypeIdentifier' do
+          pending('interface-breaking change') if Praxis::VERSION =~ /^0/
+          expect(subject.identifier).to be_kind_of(Praxis::MediaTypeIdentifier)
+        end
+      end
+    end
+
     its(:description) { should be_kind_of(String) }
     
     context 'links' do
@@ -43,8 +74,24 @@ describe Praxis::MediaType do
       context 'using the links DSL' do
         subject(:address) { Address.new(resource) }
         its(:links)  { should be_kind_of(Address::Links) }
+
+        it 'inherits types appropriately' do
+          links_attribute = Address::Links.attributes
+          expect(links_attribute[:owner].type).to be(Person)
+          expect(links_attribute[:super].type).to be(Person)
+          expect(links_attribute[:caretaker].type).to be(Person)
+        end
+
+        context 'loading returned values' do
+          subject(:residents) { address.links.residents }
+          let(:residents_summary_resource) do
+            {href: "/people", size: 2}
+          end
+
+          its(:href) { should eq('/people') }
+          its(:size) { should eq(2) }
+        end
       end
-      
     end
   end
 

data/spec/praxis/plugins/praxis_mapper_plugin_spec.rb

@@ -55,8 +55,8 @@ describe Praxis::Plugins::PraxisMapperPlugin do
       expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:log).
         with(kind_of(Praxis::Request),kind_of(Praxis::Mapper::IdentityMap), 'detailed').
         and_call_original
-
-      get '/clouds/1/instances/2?junk=foo&api_version=1.0', nil, 'global_session' => session
+      the_body = StringIO.new("{}") # This is a funny, GET request expecting a body
+      get '/clouds/1/instances/2?junk=foo&api_version=1.0', nil, 'rack.input' => the_body,'CONTENT_TYPE' => "application/json", 'global_session' => session
 
       expect(last_response.status).to eq(200)
     end

data/spec/praxis/request_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe Praxis::Request do
   let(:rack_input) { StringIO.new('something=given') }
+  let(:env_content_type){ 'application/x-www-form-urlencoded' }
   let(:env) do
     env = Rack::MockRequest.env_for('/instances/1?junk=foo&api_version=1.0')
     env['rack.input'] = rack_input
-    env['CONTENT_TYPE'] = 'application/x-www-form-urlencoded'
+    env['CONTENT_TYPE'] = env_content_type
     env['HTTP_VERSION'] = 'HTTP/1.1'
     env['HTTP_AUTHORIZATION'] = 'Secret'
     env
@@ -174,5 +175,42 @@ describe Praxis::Request do
         expect(request.validate_payload(context[:payload])).to eq(['some_error'])
       end
     end
+  
+    context '#load_payload' 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' }
+        let(:parsed_result) { Praxis::Handlers::JSON.new.parse(request.raw_payload) }
+
+        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/response_definition_spec.rb

@@ -8,7 +8,7 @@ describe Praxis::ResponseDefinition do
     Proc.new do
       status 200
       description 'test description'
-      headers({ "X-Header" => "value", "Content-Type" => "some_type" })
+      headers({ "X-Header" => "value", "Content-Type" => "application/some-type" })
     end
   end
 
@@ -16,9 +16,10 @@ describe Praxis::ResponseDefinition do
   its(:description) { should == 'test description' }
   its(:parts) { should be(nil) }
   let(:response_status) { 200 }
-  let(:response_headers) { { "X-Header" => "value", "Content-Type" => "some_type"} }
+  let(:response_content_type) { "application/some-type" }
+  let(:response_headers) { { "X-Header" => "value", "Content-Type" => response_content_type} }
 
-  let(:response) { instance_double("Praxis::Response", status: response_status , headers: response_headers ) }
+  let(:response) { instance_double("Praxis::Response", status: response_status , headers: response_headers, content_type: response_content_type ) }
 
 
   context '#media_type' do
@@ -66,14 +67,14 @@ describe Praxis::ResponseDefinition do
 
   context '#headers' do
     it 'accepts a Hash' do
-      response_definition.headers Hash["X-Header" => "value", "Content-Type" => "some_type"]
+      response_definition.headers Hash["X-Header" => "value", "Content-Type" => "application/some-type"]
       expect(response_definition.headers).to be_a(Hash)
     end
 
     it 'accepts an Array' do
-      response_definition.headers ["X-Header: value", "Content-Type: some_type"]
+      response_definition.headers ["X-Header: value", "Content-Type: application/some-type"]
       expect(response_definition.headers).to be_a(Hash)
-      expect(response_definition.headers.keys).to include("X-Header: value", "Content-Type: some_type")
+      expect(response_definition.headers.keys).to include("X-Header: value", "Content-Type: application/some-type")
     end
 
     it 'accepts a String' do
@@ -364,7 +365,8 @@ describe Praxis::ResponseDefinition do
           before { response_definition.media_type(media_type) }
 
           context 'when content type matches the mediatype of the spec' do
-            let(:response_headers) { {'Content-Type' => content_type } }
+            let(:response_content_type) { content_type }
+
             it 'validates successfully' do
               expect {
                 response_definition.validate_content_type!(response)
@@ -373,7 +375,7 @@ describe Praxis::ResponseDefinition do
           end
 
           context 'when content type includes a parameter' do
-            let(:response_headers) { {'Content-Type' => "#{content_type};collection=true" } }
+            let(:response_content_type) { "#{content_type}; collection=true" }
             it 'validates successfully' do
               expect {
                 response_definition.validate_content_type!(response)
@@ -382,7 +384,8 @@ describe Praxis::ResponseDefinition do
           end
 
           context 'when content type does not match' do
-            let(:response_headers) { {'Content-Type' => "will_never_match" } }
+            let(:response_content_type) { "application/will_never_match" }
+
             it 'should raise error telling you so' do
               expect {
                 response_definition.validate_content_type!(response)

data/spec/praxis/response_spec.rb

@@ -50,12 +50,6 @@ describe Praxis::Response do
 
   subject(:response) { Praxis::Responses::Ok.new(status: response_status, headers: response_headers) }
 
-  # before :each do
-  #   allow(response.class).to receive(:response_name).and_return(:spec)
-  #   #allow(response).to       receive(:headers).and_return(response_headers)
-  #   #allow(response).to       receive(:status).and_return(response_status)
-  # end
-
   describe '#validate' do
     before do
       allow(action).to receive(:responses).and_return({response_spec.name => response_spec })
@@ -84,6 +78,43 @@ describe Praxis::Response do
 
   end
 
+  describe '#encode!' do
+    let(:response_body_structured_data) { [{"moo" => "bah"}] }
+    let(:response_body_entity) { '[{"moo": "bah"}]' }
+
+    context 'given a String body' do
+      before { response.body = response_body_entity }
+
+      it 'leaves well enough alone' do
+        response.encode!
+        expect(response.body).to eq(response_body_entity)
+      end
+    end
+
+    context 'given a structured body' do
+      before { response.body = response_body_structured_data }
+
+      it 'encodes using a suitable handler' do
+        response.encode!
+        expect(JSON.load(response.body)).to eq(response_body_structured_data)
+      end
+    end
+
+    context 'when no Content-Type is defined' do
+      before { response.body = response_body_structured_data }
+
+      let(:response_headers) {
+        { 'X-Header'     => 'Foobar',
+          'Location'     => '/api/resources/123' }
+      }
+      it 'still defaults to the default handler' do
+        response.encode!
+        expect(JSON.load(response.body)).to eq(response_body_structured_data)
+      end
+    end
+
+
+  end
 
   context 'multipart responses' do
     let(:part) { Praxis::MultipartPart.new('not so ok', {'Status' => 400, "Location" => "somewhere"}) }

data/spec/praxis/types/collection_spec.rb

@@ -14,7 +14,7 @@ describe Praxis::Collection do
   context '.of' do
     let(:media_type) do
       Class.new(Praxis::MediaType) do
-        identifier 'an-awesome-type'
+        identifier 'application/an-awesome-type'
       end
     end
 
@@ -22,7 +22,7 @@ describe Praxis::Collection do
       Praxis::Collection.of(media_type)
     end
 
-    its(:identifier) { should eq 'an-awesome-type;type=collection' }
+    its(:identifier) { should eq 'application/an-awesome-type; type=collection' }
 
     it 'sets the collection on the media type' do
       expect(media_type::Collection).to be(collection)

data/spec/praxis/types/multipart_spec.rb

@@ -78,4 +78,21 @@ describe Praxis::Multipart do
 
   end
 
+  context '.load' do
+    it 'returns nil when loading nil' do
+      expect(type.load(nil)).to be nil
+    end
+    it 'returns the same value when loading an instance of a Multipart class' do
+      instance = Praxis::Multipart.example
+      expect(type.load(instance)).to be instance
+    end
+
+    it 'complains when the value is not a String (besides a Multipart instance or nil)' do
+       expect{
+        type.load( {a: "hash"} )
+        }.to raise_error(Attributor::CoercionError)
+    end
+
+    pending 'complete the load tests'
+  end
 end

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

@@ -46,7 +46,7 @@ class Instances < BaseClass
 
   def show(cloud_id:, id:, junk:, **other_params)
     payload = request.payload
-    response.body = {cloud_id: cloud_id, id: id, junk: junk, other_params: other_params, payload: payload.dump}
+    response.body = {cloud_id: cloud_id, id: id, junk: junk, other_params: other_params, payload: payload && payload.dump}
     response.headers['Content-Type'] = 'application/vnd.acme.instance'
     response
   end

data/spec/support/spec_media_types.rb

@@ -17,6 +17,19 @@ class Person < Praxis::MediaType
     attribute :name
     attribute :href
   end
+
+  class CollectionSummary < Praxis::MediaType
+    attributes do
+      attribute :href, String
+      attribute :size, Integer
+    end
+
+    view :link do
+      attribute :href
+      attribute :size
+    end
+
+  end
 end
 
 
@@ -30,10 +43,16 @@ class Address < Praxis::MediaType
     attribute :name, String
 
     attribute :owner, Person
+    attribute :custodian, Person
+  
+    attribute :residents, Praxis::Collection.of(Person)    
+    attribute :residents_summary, Person::CollectionSummary
 
     links do
       link :owner
       link :super, Person, using: :manager
+      link :caretaker, using: :custodian
+      link :residents, using: :residents_summary
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -834,7 +834,6 @@ files:
 - lib/praxis/callbacks.rb
 - lib/praxis/collection.rb
 - lib/praxis/config.rb
-- lib/praxis/content_type_parser.rb
 - lib/praxis/controller.rb
 - lib/praxis/dispatcher.rb
 - lib/praxis/error_handler.rb
@@ -848,9 +847,13 @@ files:
 - lib/praxis/exceptions/stage_not_found.rb
 - lib/praxis/exceptions/validation.rb
 - lib/praxis/file_group.rb
+- lib/praxis/handlers/json.rb
+- lib/praxis/handlers/www_form.rb
+- lib/praxis/handlers/xml.rb
 - lib/praxis/links.rb
 - lib/praxis/media_type.rb
 - lib/praxis/media_type_collection.rb
+- lib/praxis/media_type_identifier.rb
 - lib/praxis/multipart/parser.rb
 - lib/praxis/multipart/part.rb
 - lib/praxis/notifications.rb
@@ -899,12 +902,14 @@ files:
 - spec/praxis/bootloader_spec.rb
 - spec/praxis/callbacks_spec.rb
 - spec/praxis/config_spec.rb
-- spec/praxis/content_type_parser_spec.rb
 - spec/praxis/controller_spec.rb
 - spec/praxis/dispatcher_spec.rb
 - spec/praxis/file_group_spec.rb
+- spec/praxis/handlers/json_spec.rb
+- spec/praxis/handlers/xml_spec.rb
 - spec/praxis/links_spec.rb
 - spec/praxis/media_type_collection_spec.rb
+- spec/praxis/media_type_identifier_spec.rb
 - spec/praxis/media_type_spec.rb
 - spec/praxis/multipart/parser_spec.rb
 - spec/praxis/notifications_spec.rb