rack-autocrud 0.1.15 → 0.1.16

data/README.md

@@ -74,7 +74,7 @@ option to this middleware.
 For example:
 
 ```ruby
-use Rack::AutoCRUD, :model_namespace => 'Models', :endpoint_namespace => 'Endpoints', :sinatra_opts => { :sessions => false }
+use Rack::AutoCRUD, :model_namespace => 'Models', :endpoint_namespace => 'Endpoints', :sinatra_opts => { :sessions => true }
 ```
 
 Which can be extremely useful if you're handling sessions at a higher level than the
@@ -89,7 +89,7 @@ _config.ru_. This middleware will dynamically create a _Sinatra::Base_ subclass
 
 | Route       |           Action               | HTTP Response Code |
 | ----------- | -------------------------------| ------------------ |
-| get /       | List all _Person_ entries      |      403           |
+| get /       | List all _Person_ entries      |      200 / 403     |
 | post /      | Create a new _Person_          |      201 / 402     |
 | get /:id    | Retrieve a _Person_            |      200           |
 | put /:id    | Update a _Person_              |      201 / 402     |
@@ -125,26 +125,62 @@ CRUD Processing Hooks
 
 There are some basic processing hooks you can define in your endpoint:
 
-|             Hook                 |                        Description                               |
-| -------------------------------- | ---------------------------------------------------------------- |
-| pre_create(env,request,params)   | Called before the record is created                              |
-| post_create(env,request,obj)     | Called after the record is saved, if it was saved successfully   |
-| pre_retrieve(env,request,params) | Called before the record is fetched                              |
-| post_retrieve(env,request,obj)   | Called after the record is fetched                               |
-| pre_update(env,request,params)   | Called before the record is updated                              |
-| post_update(env,request,params)  | Called after the record is updated, if it was saved successfully |
-| pre_destroy(env,request,params)  | Called before the record is destroyed                            |
-| post_destroy(env,request,obj)    | Called after the record is destroyed                             |
+|               Hook                      |                        Description                               |
+| --------------------------------------- | ---------------------------------------------------------------- |
+| pre_create(env,request,params)          | Called before the record is created                              |
+| post_create(env,request,obj)            | Called after the record is saved, if it was saved successfully   |
+| pre_retrieve(env,request,params)        | Called before the record is fetched                              |
+| post_retrieve(env,request,obj)          | Called after the record is fetched                               |
+| pre_update(env,request,params)          | Called before the record is updated                              |
+| post_update(env,request,params)         | Called after the record is updated, if it was saved successfully |
+| pre_destroy(env,request,params)         | Called before the record is destroyed                            |
+| post_destroy(env,request,obj)           | Called after the record is destroyed                             |
+| pre_collect(env,request,params)         | Called before the record is collected                            |
+| post_collect(env,request,collection)    | Called after the record is collected                             |
+
 
 Parameters:
 
 * *env* is the current Rack environment
 * *request* is the current request object
 * *obj* is the ORM object corresponding to the record in question
+* *collection* is the collection returned by the ORM
 
 If any of these hooks returns anything other than _nil_, it is assumed to be a response object, which
 is returned immediately, and no further processing is performed.
 
+Collections
+===========
+
+All models in the namespace are *not* collectable by default. To enable collections,
+you need to set the _COLLECTABLE_ constant in the model:
+
+```ruby
+module Models
+  class Person
+    include DataMapper::Resource
+
+    property :id,   Serial
+    property :name, String
+
+    # Enable collection
+    COLLECTABLE = 1
+  end
+end
+```
+
+You can set this constant to 0 to disable it. If you want to enable collections
+on all models in your namespace, simply specify the constant there:
+
+If you want to *not* expose all models by default, simply define the constant as part of the _Models_ module:
+
+```ruby
+module Models
+  # Enable collections on all models by default
+  COLLECTABLE = 1
+end
+```
+
 Selective Exposure
 ==================
 

data/lib/rack/autocrud.rb

@@ -64,6 +64,11 @@ module Rack
         model_klass.const_set(:EXPOSE,@model_mod.const_get(:EXPOSE))
       end
 
+      # Make sure we copy the :COLLECTABLE constant if it's defined upstream
+      if !model_klass.nil? && !model_klass.const_defined?(:COLLECTABLE) && @model_mod.const_defined?(:COLLECTABLE)
+        model_klass.const_set(:COLLECTABLE,@model_mod.const_get(:COLLECTABLE))
+      end
+
       # Now, if we've got something, do our magic.
       if !model_klass.nil? && (!model_klass.const_defined?(:EXPOSE) || model_klass.const_get(:EXPOSE))
         # If we don't have an endpoint class, make one
@@ -88,7 +93,24 @@ module Rack
           end
 
           get '/' do
-            halt [ 403, '{ "error": "Access Denied" }' ]
+            halt [ 403, '{ "error": "Access Denied" }' ] unless model_klass.const_defined?(:COLLECTABLE) && model.const_get(:COLLECTABLE)
+
+            # Call the pre-create hook
+            if self.respond_to?(:pre_collect)
+              ret = pre_collect(env,request,params)
+              return ret unless ret.nil?
+            end
+
+            # Get the collection
+            collection = model.all
+
+            # Call the post-collect hook
+            if self.respond_to?(:post_collect)
+              ret = post_collect(env,request,collection)
+              return ret unless ret.nil?
+            end
+
+            collection.to_json
           end
 
           post '/' do
@@ -185,7 +207,8 @@ module Rack
         }
 
         # Now, call the endpoint class (assuming it will return a response)
-        env['PATH_INFO'] = '/' + uri.join('/')
+        env['PATH_INFO']    = '/' + uri.join('/')
+        env['CONTENT_TYPE'] = 'text/json'
         return endpoint_klass.call(env)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-autocrud
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json