rack-autocrud 0.1.6 → 0.1.7

data/README.md

@@ -63,7 +63,7 @@ _config.ru_. This middleware will dynamically create a _Sinatra::Base_ subclass
 | Route       |           Action               | HTTP Response Code |
 | ----------- | -------------------------------| ------------------ |
 | get /       | List all _Person_ entries      |      403           |
-| post /      | Create a new _Person_          |      201 / 402     |
+| post /      | Create a new _Person_          |      201 / 403     |
 | get /:id    | Retrieve a _Person_            |      200           |
 | put /:id    | Update a _Person_              |      201 / 403     |
 | delete /:id | Destroy a _Person_             |      204           |
@@ -98,16 +98,16 @@ CRUD Processing Hooks
 
 There are some basic processing hooks you can define in your endpoint:
 
-|             Hook               |                        Description                               |
-| ------------------------------ | ---------------------------------------------------------------- |
-| pre_create(env,request)        | 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)      | Called before the record is fetched                              |
-| post_retrieve(env,request,obj) | Called after the record is fetched                               |
-| pre_update(env,request)        | Called before the record is updated                              |
-| post_update(env,request)       | Called after the record is updated, if it was saved successfully |
-| pre_destroy(env,request)       | 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                             |
 
 Parameters:
 
@@ -132,3 +132,15 @@ def set_request_body(new_body,content_type='text/json')
 
 where *new_body* is expected to be a string.
 
+Auto-Inclusion of Other Modules
+===============================
+
+This middleware also takes an option _:includes_ which can be used to automatically
+include other modules (e.g. helpers) when creating and/or patching endpoints.
+
+For example:
+
+```ruby
+use Rack::AutoCRUD, :model_namespace => 'Models', :endpoint_namespace => 'Endpoints', :includes => [ Your::HelperModule ]
+```
+

data/lib/rack/autocrud.rb

@@ -20,6 +20,7 @@ module Rack
       @app                = app
       @model_namespace    = options[:model_namespace]
       @endpoint_namespace = options[:endpoint_namespace]
+      @includes           = options[:includes]
       @endpoint_mod       = nil
     end
 
@@ -57,6 +58,9 @@ module Rack
           @endpoint_mod.const_set(endpoint.capitalize,endpoint_klass)
         end
 
+        # Add in any specified helpers
+        @includes.each { |inc| endpoint_klass.send(:include,inc) } unless @includes.nil?
+
         # Patch in the routes
         endpoint_klass.class_exec(model_klass,endpoint,env) { |model,endpoint,env|
           def set_request_body(new_body,content_type='text/json')
@@ -67,13 +71,13 @@ module Rack
           end
 
           get '/' do
-            halt [403, '{ "error": "Access Denied" }']
+            halt [ 403, '{ "error": "Access Denied" }' ]
           end
 
           post '/' do
             # Call the pre-create hook
             if self.respond_to?(:pre_create)
-              ret = pre_create(env,request)
+              ret = pre_create(env,request,params)
               return ret unless ret.nil?
             end
 
@@ -84,7 +88,7 @@ module Rack
             obj = nil
             begin
               obj = model.create(JSON.parse(request.body.read))
-              halt [402, '{ "error": "Failed to save ' + endpoint + '" }'] unless obj && obj.saved?
+              halt [ 403, '{ "error": "Failed to save ' + endpoint + '" }' ] unless obj && obj.saved?
             rescue JSON::ParserError
               halt [ 400, { 'error' => 'Invalid JSON in request body.', 'details' => $! }.to_json ]
             end
@@ -101,7 +105,7 @@ module Rack
           get '/:id' do
             # Call the pre-retrieve hook
             if self.respond_to?(:pre_retrieve)
-              ret = pre_retrieve(env,request)
+              ret = pre_retrieve(env,request,params)
               return ret unless ret.nil?
             end
 
@@ -119,7 +123,7 @@ module Rack
           put '/:id' do
             # Call the pre-update hook
             if self.respond_to?(:pre_update)
-              ret = pre_update(env,request)
+              ret = pre_update(env,request,params)
               return ret unless ret.nil?
             end
 
@@ -128,15 +132,15 @@ module Rack
 
             # Attempt to update the model
             begin
-              saved = model.update(JSON.parse(request.body.read))
-              halt [403, 'Access Denied'] unless saved
+              saved = model.update(JSON.parse(request.body.read).merge(:id => params[:id]))
+              halt [ 403, '{ "error": "Access Denied" }' ] unless saved
             rescue JSON::ParserError
               halt [ 400, { 'error' => 'Invalid JSON in request body.', 'details' => $! }.to_json ]
             end
 
             # Call the post-update hook
             if self.respond_to?(:post_update)
-              ret = post_update(env,request)
+              ret = post_update(env,request,params)
               return ret unless ret.nil?
             end
 
@@ -146,12 +150,12 @@ module Rack
           delete '/:id' do
             # Call the pre-destroy hook
             if self.respond_to?(:pre_destroy)
-              ret = pre_destroy(env,request)
+              ret = pre_destroy(env,request,params)
               return ret unless ret.nil?
             end
 
             obj = model.get(params[:id])
-            obj.destroy if obj
+            obj.destroy! if obj
 
             # Call the post-destroy hook
             if self.respond_to?(:post_destroy)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-autocrud
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors: