praxis 0.17.1 → 0.18.0

data/spec/praxis/media_type_collection_spec.rb

@@ -6,6 +6,8 @@ describe Praxis::MediaTypeCollection do
     silence_warnings do
       klass = Class.new(Praxis::MediaTypeCollection) do
         member_type VolumeSnapshot
+        description 'A container for a collection of Volumes'
+        display_name 'Volumes Collection'
 
         attributes do
           attribute :name, String, regexp: /snapshots-(\w+)/
@@ -26,13 +28,13 @@ describe Praxis::MediaTypeCollection do
       klass
     end
   end
-   
+
   context '.member_type' do
     its(:member_type){ should be(VolumeSnapshot) }
     its(:member_attribute){ should be_kind_of(Attributor::Attribute) }
     its('member_attribute.type'){ should be(VolumeSnapshot) }
   end
-  
+
   context '.load' do
     context 'with a hash' do
       let(:snapshots_data) { {name: 'snapshots',   href: '/bob/snapshots' } }
@@ -52,7 +54,7 @@ describe Praxis::MediaTypeCollection do
         [{id: 1, name: 'snapshot-1'},
          {id: 2, name: 'snapshot-2'}]
       end
-      
+
       let(:snapshots) { media_type_collection.load(snapshots_data) }
       subject(:members) { snapshots.to_a }
 
@@ -102,7 +104,7 @@ describe Praxis::MediaTypeCollection do
   end
 
   context '#validate' do
- 
+
 
     context 'with a hash' do
       let(:snapshots_data) { {name: 'snapshots-1',   href: '/bob/snapshots' } }
@@ -148,4 +150,9 @@ describe Praxis::MediaTypeCollection do
     end
   end
 
+  context '#describe' do
+    subject(:described) { media_type_collection.describe }
+    its([:description]){ should be(media_type_collection.description)}
+    its([:display_name]){ should be(media_type_collection.display_name)}
+  end
 end

data/spec/praxis/media_type_spec.rb

@@ -144,9 +144,10 @@ describe Praxis::MediaType do
 
     subject(:described){ Address.describe }
 
-    its(:keys) { should match_array( [:attributes, :description, :family, :id, :identifier, :key, :name, :views] ) }
+    its(:keys) { should match_array( [:attributes, :description, :display_name, :family, :id, :identifier, :key, :name, :views] ) }
     its([:attributes]) { should be_kind_of(::Hash) }
     its([:description]) { should be_kind_of(::String) }
+    its([:display_name]) { should be_kind_of(::String) }
     its([:family]) { should be_kind_of(::String) }
     its([:id]) { should be_kind_of(::String) }
     its([:name]) { should be_kind_of(::String) }
@@ -155,6 +156,7 @@ describe Praxis::MediaType do
     its([:views]) { should be_kind_of(::Hash) }
 
     its([:description]) { should eq(Address.description) }
+    its([:display_name]) { should eq(Address.display_name) }
     its([:family]) { should eq(Address.family) }
     its([:id]) { should eq(Address.id) }
     its([:name]) { should eq(Address.name) }

data/spec/praxis/request_stages/action_spec.rb

@@ -7,11 +7,11 @@ describe Praxis::RequestStages::Action do
       include Praxis::Controller
     end.new(request)
   end
-  
-  let(:action) { double("action", name: "foo") }  
+
+  let(:action) { double("action", name: "foo") }
   let(:response){ Praxis::Responses::Ok.new }
   let(:app){ double("App", controller: controller, action:action, request: request)}
-  let(:action_stage){ Praxis::RequestStages::Action.new(action.name,app) }  
+  let(:action_stage){ Praxis::RequestStages::Action.new(action.name,app) }
 
   let(:request) do
     env = Rack::MockRequest.env_for('/instances/1?cloud_id=1&api_version=1.0')
@@ -29,17 +29,24 @@ describe Praxis::RequestStages::Action do
       expect(controller).to receive(action_stage.name).with(request.params_hash).and_return(controller_response)
     end
     let(:controller_response){ controller.response }
-    it 'should always call the right controller method' do
+
+    it 'always call the right controller method' do
       action_stage.execute
     end
-    it 'should save the request reference inside the response' do
+
+    it 'saves the request reference inside the response' do
       action_stage.execute
       expect(controller.response.request).to eq(request)
     end
 
+    it 'sends the right ActiveSupport::Notification' do
+      expect(ActiveSupport::Notifications).to receive(:instrument).with('praxis.request_stage.execute', {controller: an_instance_of(controller.class)}).and_call_original
+      action_stage.execute
+    end
+
     context 'if the controller method returns a string' do
       let(:controller_response){ "this is the body"}
-      it 'set the response body with it (and save the request too)' do
+      it 'sets the response body with it (and save the request too)' do
         action_stage.execute
         expect(controller.response.body).to eq("this is the body")
       end

data/spec/praxis/resource_definition_spec.rb

@@ -17,7 +17,7 @@ describe Praxis::ResourceDefinition do
     subject(:describe) { resource_definition.describe }
 
     its([:description]) { should eq(resource_definition.description) }
-    its([:media_type]) { should eq(resource_definition.media_type.name) }
+    its([:media_type]) { should eq(resource_definition.media_type.describe(true)) }
 
     its([:actions]) { should have(2).items }
     its([:metadata]) { should be_kind_of(Hash) }

data/spec/praxis/response_definition_spec.rb

@@ -509,6 +509,32 @@ describe Praxis::ResponseDefinition do
       response.headers(headers) if headers
     end
 
+    context 'for a definition with a media type' do
+      let(:media_type) { Instance }
+      subject(:payload) { output[:payload] }
+
+      before do
+        response.media_type Instance
+      end
+
+      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' }
+        
+        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
+        end
+
+      end
+
+
+    end
+
+
     context 'for a definition without parts' do
       it{ should be_kind_of(::Hash) }
       its([:description]){ should be(description) }
@@ -530,7 +556,7 @@ describe Praxis::ResponseDefinition do
         end
 
         it{ should be_kind_of(::Hash) }
-        its([:media_type]){ should == { identifier: 'foobar'} }
+        its([:payload]){ should == { identifier: 'foobar'} }
         its([:status]){ should == 200 }
       end
       context 'using a full response definition block' do
@@ -546,8 +572,8 @@ describe Praxis::ResponseDefinition do
         end
 
         it{ should be_kind_of(::Hash) }
-        its([:media_type]){ should == { identifier: 'custom_media'} }
-        its([:status]){ should == 234 }
+        its([:payload]) { should == { identifier: 'custom_media'} }
+        its([:status]) { should == 234 }
       end
     end
   end

data/spec/praxis/router_spec.rb

@@ -230,7 +230,7 @@ describe Praxis::Router do
               code, headers, body = router.call(request)
               expect(code).to eq(404)
               expect(headers['Content-Type']).to eq('text/plain')
-              expect(body.first).to eq("NotFound. Your request speficied API version = \"#{request_version}\". Available versions = \"1.0\", \"2.0\".")
+              expect(body.first).to eq("NotFound. Your request specified API version = \"#{request_version}\". Available versions = \"1.0\", \"2.0\".")
             end
           end
         end

data/spec/praxis/types/multipart_array_spec.rb

@@ -102,6 +102,34 @@ describe Praxis::Types::MultipartArray do
 
     it do
       expect(payload.part('blah').payload['sub_hash']).to eq('key' => 'value')
+
+      # The "reader" functions should work
+      expect(payload.payload_type).to eq Attributor::Hash
+      expect(payload.class.payload_type).to eq Attributor::Hash
+    end
+  end
+
+  context 'with simple payload_type block defined' do
+    let(:type) do
+      Class.new(Praxis::Types::MultipartArray) do
+        name_type String
+        payload_type do
+          attribute :attr, String
+        end
+      end
+    end
+
+    let(:json_payload) { {attr: 'value'}.to_json }
+    let(:body) { StringIO.new("--boundary\r\nContent-Disposition: form-data; name=blah\r\n\r\n#{json_payload}\r\n--boundary--") }
+    let(:content_type) { "multipart/form-data; boundary=boundary" }
+
+    it do
+      expect(payload.part('blah').payload.class.ancestors).to include(Attributor::Struct)
+      expect(payload.part('blah').payload.attr).to eq('value')
+
+      # The "reader" functions should work
+      expect(payload.payload_type).to eq Attributor::Struct
+      expect(payload.class.payload_type).to eq Attributor::Struct
     end
   end
 
@@ -208,6 +236,70 @@ describe Praxis::Types::MultipartArray do
         loaded = type.load(dumped, content_type: payload.content_type)
       end
     end
+
+
+    context 'with default_format' do
+      let(:type) do
+        Class.new(Praxis::Types::MultipartArray) do
+          part 'title', String, required: true
+          part 'thing' do
+            payload do
+              attribute :name, String
+              attribute :value, String
+            end
+          end
+          part 'stuff' do
+            header 'Content-Type', 'application/json'
+            payload Hash do
+              key :foo, String
+              key :bar, DateTime
+            end
+          end
+          part 'instances', multiple: true do
+            header 'Content-Type', 'application/vnd.acme.instance'
+            payload Instance
+          end
+        end
+      end
+
+      let(:example) { type.example }
+
+      let(:default_format) { 'xml' }
+
+      let(:output) { example.dump(default_format: default_format) } 
+
+      let(:parts) { Praxis::MultipartParser.parse({'Content-Type'=>example.content_type}, output).last }
+
+      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
+        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)
+        end
+      end
+
+    end
+
   end
 
   context 'with errors' do

data/spec/praxis/types/multipart_spec.rb

@@ -104,4 +104,9 @@ describe Praxis::Multipart do
 
     pending 'complete the load tests'
   end
+
+  context '#describe' do
+    subject(:described) { type.describe }
+    its([:family]){ should eq('multipart')}
+  end
 end

data/spec/spec_app/design/api.rb

@@ -24,6 +24,7 @@ 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'
     #version_with :path
     #base_path "/v:api_version"
   end

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

@@ -22,7 +22,7 @@ class Volume < Praxis::MediaType
     attribute :name
     attribute :source
     attribute :snapshots
-    
+
     attribute :links
   end
 
@@ -37,5 +37,3 @@ class Volume < Praxis::MediaType
   end
 
 end
-
-

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

@@ -57,7 +57,7 @@ module ApiResources
         attribute :fail_filter, Attributor::Boolean, default: false
       end
 
-      payload do
+      payload required: false do
         attribute :something, String
         attribute :optional, String, default: "not given"
       end

data/spec/support/spec_media_types.rb

@@ -1,9 +1,9 @@
 class Person < Praxis::MediaType
-  attributes do 
+  attributes do
     attribute :id, Integer
     attribute :name, String, example: /[:name:]/
     attribute :href, String, example: proc { |person| "/people/#{person.id}" }
-    attribute :links, silence_warnings { Praxis::Collection.of(String) } 
+    attribute :links, silence_warnings { Praxis::Collection.of(String) }
   end
 
   view :default do
@@ -37,6 +37,7 @@ class Address < Praxis::MediaType
   identifier 'application/json'
 
   description 'Address MediaType'
+  display_name 'The Address'
 
   attributes do
     attribute :id, Integer
@@ -44,8 +45,8 @@ class Address < Praxis::MediaType
 
     attribute :owner, Person
     attribute :custodian, Person
-  
-    attribute :residents, Praxis::Collection.of(Person)    
+
+    attribute :residents, Praxis::Collection.of(Person)
     attribute :residents_summary, Person::CollectionSummary
 
     links do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -73,42 +73,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: praxis-blueprints
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: attributor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -728,6 +728,7 @@ files:
 - lib/praxis/config.rb
 - lib/praxis/controller.rb
 - lib/praxis/dispatcher.rb
+- lib/praxis/docs/generator.rb
 - lib/praxis/error_handler.rb
 - lib/praxis/exception.rb
 - lib/praxis/exceptions/config.rb
@@ -920,7 +921,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Building APIs the way you want it.