praxis 0.16.1 → 0.17.0

data/spec/praxis/types/multipart_spec.rb

@@ -21,7 +21,11 @@ describe Praxis::Multipart do
   end
 
   context 'with value type' do
-    let(:type) { Praxis::Multipart.of(value: Integer) }
+    let(:type) do
+      silence_warnings do
+        Praxis::Multipart.of(value: Integer)
+      end
+    end
     its(['some_name']) { should eq(1) }
   end
 
@@ -42,7 +46,7 @@ describe Praxis::Multipart do
       form.add entity,'some_date'
     end
 
-    let(:type) { Praxis::Multipart.construct(block) }
+    let(:type) { silence_warnings { Praxis::Multipart.construct(block) } }
 
     its(['some_name']) { should eq(1) }
     its(['some_date']) { should eq(date) }
@@ -61,7 +65,12 @@ describe Praxis::Multipart do
   end
 
   context '.example' do
-    let(:type) { Praxis::Multipart.of(value: Instance) }
+    let(:type) do
+      silence_warnings do
+        Praxis::Multipart.of(value: Instance)
+      end
+    end
+
     subject(:example) { type.example('example') }
 
     it 'generates an interesting example' do
@@ -88,9 +97,9 @@ describe Praxis::Multipart do
     end
 
     it 'complains when the value is not a String (besides a Multipart instance or nil)' do
-       expect{
+      expect{
         type.load( {a: "hash"} )
-        }.to raise_error(Attributor::CoercionError)
+      }.to raise_error(Attributor::CoercionError)
     end
 
     pending 'complete the load tests'

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

@@ -39,32 +39,42 @@ class Instances < BaseClass
     #puts "Decorator three end"
   end
 
-  def index(response_content_type:, **params)
+  def index(cloud_id:, response_content_type: 'application/vnd.acme.instance;type=collection', **params)
+    instances = Instance::Collection.example
+    response.body = JSON.pretty_generate(instances.collect { |i| i.render })
     response.headers['Content-Type'] = response_content_type #'application/vnd.acme.instance;type=collection'
-    JSON.generate(params)
+    response
   end
 
   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 && payload.dump}
-    response.headers['Content-Type'] = 'application/vnd.acme.instance'
+    response.headers['Content-Type'] = 'application/json'
     response
   end
 
   def bulk_create(cloud_id:)
-    self.response = BulkResponse.new
+    self.response = Praxis::Responses::MultipartOk.new
+    response.body = request.action.responses[:multipart_ok].media_type.new
+
+    request.payload.each do |part|
+      instance_id = part.name
+      instance = part.payload
 
+      part_body = {
+        key: instance_id,
+        value: instance.render(view: :create)
+      }
 
-    request.payload.each do |instance_id,instance|
-      part_body = JSON.pretty_generate(key: instance_id, value: instance.render(:create))
       headers = {
         'Status' => '201',
-        'Content-Type' => Instance.identifier,
+        'Content-Type' => Instance.identifier + '+json',
         'Location' => definition.to_href(cloud_id: cloud_id, id: instance.id)
       }
-      part = Praxis::MultipartPart.new(part_body, headers)
 
-      response.add_part(instance_id, part)
+      part = Praxis::MultipartPart.new(part_body, headers, name: instance_id)
+
+      response.body.push(part)
     end
 
     response
@@ -105,7 +115,7 @@ class Instances < BaseClass
   end
 
   def exceptional(cloud_id:, splat:)
-    response.headers['Content-Type'] = 'application/vnd.acme.instance'
+    response.headers['Content-Type'] = 'application/json'
     response
   end
 end

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

@@ -8,15 +8,19 @@ class Volumes < BaseClass
     #puts "before action for volumes"
   end
 
-  def show(id:, **other_params)
-    response.body = { id: id, other_params: other_params }
-    response.headers['Content-Type'] = 'application/vnd.acme.volume'
+  def index
+    volumes = Volume::Collection.example
+    
+    response.body = volumes.collect { |v| v.render }
+    response.headers['Content-Type'] = 'application/vnd.acme.volumes'
     response
   end
 
-  def index
+  def show(id:, **other_params)
+    response.body = JSON.pretty_generate(Volume.example.render)
     response.headers['Content-Type'] = 'application/vnd.acme.volume'
     response
   end
 
+
 end

data/spec/spec_app/app/responses/bulk_response.rb

@@ -1,6 +0,0 @@
-
-class BulkResponse < Praxis::Response
-  self.response_name = :bulk_response
-  self.status = 200
-end
-

data/spec/spec_app/config/environment.rb

@@ -14,6 +14,8 @@ 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'
@@ -27,8 +29,19 @@ Praxis::Application.configure do |application|
 
   # enable "development-mode" options
   application.config.praxis.validate_responses = true
+  application.config.praxis.validate_response_bodies = true
   application.config.praxis.show_exceptions = true
 
+  # FIXME: until we have a better way to unit test such a feature...
+  # Silly callback code pieces to test that the deferred callbacks work even for sub-stages
+  application.bootloader.after :app, :models do
+    PersonModel.identity(:other_id)
+  end
+  application.bootloader.after :app do
+    raise "After sub-stage hooks not working!" unless PersonModel.identities.include? :other_id
+  end
+
+
   application.layout do
     layout do
       map :initializers, 'config/initializers/**/*'

data/spec/spec_app/design/api.rb

@@ -10,13 +10,7 @@ Praxis::ApiDefinition.define do
     media_type 'multipart/form-data'
   end
 
-  response_template :bulk_response do |media_type: nil, parts: |
-    status 200
-    media_type 'multipart/form-data'
 
-    parts[:media_type] ||= media_type if ( media_type && parts.kind_of?(Hash) )
-    parts(parts)
-  end
 
   trait :authenticated do
     headers do
@@ -28,11 +22,14 @@ Praxis::ApiDefinition.define do
     name "Spec App"
     title "A simple App to do some simple integration testing"
     description "This example API should really be replaced by a set of more full-fledged example apps in the future"
+
+    base_path "/api"
+    #version_with :path
+    #base_path "/v:api_version"
   end
-  
-  info("1.0") do # Applies to 1.0 version (and inherits everything else form the global one)
+
+  info '1.0' do # Applies to 1.0 version (and inherits everything else form the global one)
     description "A simple 1.0 App"
-    base_path "/"
   end
-  
+
 end

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

@@ -4,7 +4,9 @@ class Instance < Praxis::MediaType
 
   attributes do
     attribute :id, Integer
-    attribute :name, String, example: /[:first_name:]/
+    attribute :name, String, 
+      example: /[:first_name:]/,
+      regexp: /^\w+$/
 
     attribute :href, String
 

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

@@ -17,7 +17,7 @@ module ApiResources
       requires_ability :read
 
       params do
-        attribute :cloud_id, Integer, required: true
+        attribute :cloud_id, Integer, required: true, min: 0
       end
     end
 
@@ -26,17 +26,19 @@ module ApiResources
         get ''
       end
 
-      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
         header "FOO", /bar/
+        key 'Account-Id', Integer, required: false, min: 0
+      end
+
+      params do
+        attribute :response_content_type, String, default: 'application/vnd.acme.instance;type=collection'
       end
 
-      response :ok, media_type: Praxis::Collection.of(Instance)
+
+      response :ok, Praxis::Collection.of(Instance)
     end
 
     action :show do
@@ -45,7 +47,7 @@ module ApiResources
         get '/something/:id', name: :alternate
       end
 
-      response :ok
+      response :ok, media_type: 'application/json'
       response :unauthorized
 
       params do
@@ -54,25 +56,50 @@ module ApiResources
         attribute :some_date, DateTime, default: DateTime.parse('2012-12-21')
         attribute :fail_filter, Attributor::Boolean, default: false
       end
+
       payload do
         attribute :something, String
         attribute :optional, String, default: "not given"
       end
     end
 
+
     action :bulk_create do
       routing do
         post ''
       end
 
-      payload Praxis::Multipart.of(key: Integer, value: Instance)
+      payload Praxis::Types::MultipartArray do
+        name_type Integer
+        payload_type Instance
+      end
+
+      response :multipart_ok, Praxis::Types::MultipartArray do
+        name_type Integer
+
+        part /\d+/ do
+          header 'Status', '201'
+          header 'Content-Type', /^#{Instance.identifier}/
+          header 'Location', Attributor::URI,
+            example: proc { |part| ApiResources::Instances.to_href(cloud_id: part[:value].cloud_id, id: part[:value].id) }
+
+          payload Hash do
+            attribute :key, Integer, required: true
+            attribute :value, Hash, required: true, reference: Instance do
+              attribute :id
+              attribute :name
+            end
+          end
+
+        end
+      end
+
 
       # Using a hash param for parts
-      response :bulk_response ,
-      parts: {
-        like: :created,
-        location: /\/instances\//
-      }
+      #response :multipart_ok, parts: {
+      #  like: :created,
+      #  location: /\/instances\//
+      #}
 
       # Using a block for parts to defin a sub-request
       #     sub_request = proc do
@@ -81,30 +108,8 @@ module ApiResources
       #                     headers ['X-Foo','X-Bar']
       #                   end
       #     response :bulk_response, parts: sub_request
-
-
-      # multi 200, H1
-      # parts_as :resp1
-
-      # part_type do
-      #   201
-      #   h Location ~= /asdfa/
-      # end
-
-      # part 'dest_dir' do
-
-      # end
-      # part 'file' do
-      #   mt binary
-      # end
     end
 
-    #action :get_user_data do
-    #  response :get_user_data do
-    #    media_type: UserData
-    #  end
-    #end
-
     action :attach_file do
       routing do
         post '/:id/files'
@@ -114,10 +119,13 @@ module ApiResources
         attribute :id
       end
 
-      payload Praxis::Multipart, allow_extra: true do
-        key 'destination_path', String, required: true
-        key 'file', Attributor::FileUpload, required: false
-        extra 'options'
+      # TODO: move to something else when Multipart is fully deprecated
+      silence_warnings do
+        payload Praxis::Multipart, allow_extra: true do
+          key 'destination_path', String, required: true
+          key 'file', Attributor::FileUpload, required: false
+          extra 'options'
+        end
       end
 
       response :ok, media_type: 'application/json'
@@ -166,7 +174,7 @@ module ApiResources
       end
 
       payload do
-        attribute :name
+        attribute :name, regexp: /.*/
         attribute :root_volume
       end
 
@@ -182,8 +190,9 @@ module ApiResources
       params do
         attribute :splat, Attributor::Collection.of(String), required: true
       end
-      response :ok
+      response :ok, media_type: 'application/json'
     end
+
     # OTHER USAGES:
     #   note: these are all hypothetical, pending, brainstorming usages.
 

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

@@ -0,0 +1,39 @@
+require_relative 'volumes'
+
+module ApiResources
+  class VolumeSnapshots
+    include Praxis::ResourceDefinition
+
+    media_type VolumeSnapshot
+
+    version '1.0'
+    
+    parent Volumes, :id => :volume_id
+    prefix '/snapshots'
+
+    action :index do
+      routing do
+        get ''
+      end
+      response :ok
+      response :unauthorized
+
+      params do
+        attribute :volume_id, Integer, description: 'id of parent volume'
+      end
+
+    end
+
+    action :show do
+      routing do
+        get '/:id'
+      end
+
+      params do
+        attribute :id
+      end
+      
+    end
+
+  end
+end

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

@@ -3,17 +3,22 @@ module ApiResources
     include Praxis::ResourceDefinition
 
     media_type Volume
-    version '1.0', using: :path
-
-    prefix '/volumes'
+    version '1.0'
+    prefix '/clouds/:cloud_id/volumes'
 
     trait :authenticated
-    
+  
+    action_defaults do
+      params do
+        attribute :cloud_id, Integer, description: "id of the cloud"
+      end
+    end
+
     action :index do
       routing do
         get ''
       end
-      response :ok
+      response :ok, media_type: Praxis::Collection.of(Volume)
       response :unauthorized
     end
 
@@ -26,7 +31,7 @@ module ApiResources
       response :unauthorized
 
       params do
-        attribute :id
+        attribute :id, description: 'ID to find'
         attribute :junk, String, default: ''
         attribute :some_date, DateTime, default: DateTime.parse('2012-12-21')
       end