rack-autocrud 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012, Tim Hentenaar
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,119 @@
+rack-autocrud
+=============
+
+Rack middleware that works with Sinatra and DataMapper to dynamically
+create CRUD endpoints and routes based on models. It ain't perfect, but
+it works.
+
+These generated CRUD routes are assumed to return a Rack response.
+
+It's important to note, that you models and endpoints must be in separate
+modules (read: namespaces).
+
+Input and Response data are formatted as JSON.
+
+Licensing
+=========
+
+This software is licensed under the [Simplified BSD License](http://en.wikipedia.org/wiki/BSD_licenses#2-clause_license_.28.22Simplified_BSD_License.22_or_.22FreeBSD_License.22.29) as described in the LICENSE file.
+
+Requirements
+============
+
+* sinatra
+* datamapper
+
+Installation
+============
+
+    gem install rack-autocrud
+
+Usage
+=====
+
+Just add something like this to your _config.ru_:
+
+```ruby
+require 'rack/autocrud'
+
+# Load your models
+require 'models'
+
+# Load your endpoints
+require 'endpoints'
+
+# Auto-magical CRUD
+run Rack::AutoCRUD.new nil, :model_namespace => 'Models', :endpoint_namespace => 'Endpoints'
+```
+
+This would assume you only want CRUD-based routing. You can also _use_ this middleware:
+
+```ruby
+use Rack::AutoCRUD, :model_namespace => 'Models', :endpoint_namespace => 'Endpoints'
+```
+
+How Routing Works
+=================
+
+The routing is simple. You have a model *Models::Person*. You've added something like the above to your
+_config.ru_. This middleware will dynamically create a _Sinatra::Base_ subclass called *Endpoints::Person*
+(if it already exists, these routes are added to it) which will contain the following routes:
+
+| Route       |           Action               | HTTP Response Code |
+| ----------- | -------------------------------| ------------------ |
+| get /       | List all _Person_ entries      |      403           |
+| post /      | Create a new _Person_          |      201 / 402     |
+| get /:id    | Retrieve a _Person_            |      200           |
+| put /:id    | Update a _Person_              |      201 / 403     |
+| delete /:id | Destroy a _Person_             |      204           |
+
+The middleware will route based on the URI. Thus, _/person_ would correspond to *Endpoints::Person*'s _get /_ route.
+
+Overriding Generated Routes
+===========================
+
+You can define your own CRUD routes, which will be called and return a response
+before the autogenerated routes, as long as they're added after your endpoint is defined.
+
+For example:
+
+```ruby
+require 'sinatra/base'
+
+module Endpoints
+  class Person < Sinatra::Base
+    get '/'
+       Models::Person.all.to_json
+    end
+end
+```
+
+In this case, if you're using _dm-serializer_,you'd get back every _Models::Person_ record in the database in
+a JSON array. By default, the _get /_ route returns "Access Denied."
+
+CRUD Processing Hooks
+=====================
+
+There are some basic processing hooks you can define in your endpoint:
+
+|             Hook               |                        Description                               |
+| ------------------------------ | ---------------------------------------------------------------- |
+| pre_create(env,request,obj)    | Called after the record is created, but before it's saved        |
+| 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                             |
+
+Parameters:
+
+* *env* is the current Rack environment
+* *request* is the current request object
+* *obj* is the ORM object corresponding to the record in question
+
+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.
+
+

data/lib/rack/autocrud.rb

@@ -0,0 +1,152 @@
+#
+# Rack::AutoCRUD - AutoCRUD Middleware for Rack
+#
+# Copyright (C) 2012 Tim Hentenaar. All Rights Reserved.
+#
+# Licensed under the Simplified BSD License. 
+# See the LICENSE file for details.
+#
+# This Rack middleware automatically generates Sinatra
+# endpoints (descended from Sinatra::Base) to handle
+# basic CRUD operations on defined models.
+#
+
+require 'sinatra/base'
+require 'json'
+
+module Rack
+	class AutoCRUD
+		def initialize(app,options={})
+			@app                = app
+			@model_namespace    = options[:model_namespace]
+			@endpoint_namespace = options[:endpoint_namespace]
+			@endpoint_mod       = nil
+		end
+
+		def call(env)
+			dup._call(env) # For thread safety...
+		end
+
+		def _call(env)
+			model_klass        = nil
+			endpoint_klass     = nil
+			verb,endpoint,*uri = env['REQUEST_URI'].split('/')
+			verb               = env['REQUEST_METHOD'].downcase
+
+			# Enumerate through all defined classes, checking for the model / endpoint
+			ObjectSpace.each_object(Class) { |klass|
+				model_klass    = klass if String(klass.name).downcase == String(@model_namespace    + '::' + endpoint).downcase
+				endpoint_klass = klass if String(klass.name).downcase == String(@endpoint_namespace + '::' + endpoint).downcase
+			}
+
+			# Lazily locate the endpoint namespace module (if we haven't already)
+			if endpoint_klass.nil? && @endpoint_mod.nil?
+				ObjectSpace.each_object(Module) { |klass|
+					@endpoint_mod = klass if String(klass.name).downcase == @endpoint_namespace.downcase 
+				}
+			end
+
+			# Now, if we've got something, do our magic.
+			if !model_klass.nil?
+				# If we don't have an endpoint class, make one
+				if endpoint_klass.nil?
+					endpoint_klass = Class.new(Sinatra::Base)
+					@endpoint_mod.const_set(endpoint.capitalize,endpoint_klass)
+				end
+
+				# Patch in the routes
+				endpoint_klass.class_exec(model_klass,endpoint,env) { |model,endpoint,env|
+					get '/' do
+						halt [403, '{ "error": "Access Denied" }']
+					end
+
+					post '/' do
+						obj = model.new(JSON.parse(request.body.read))
+						
+						# Call the pre-create hook
+						if self.respond_to?(:pre_create)
+							ret = pre_create(env,request,obj)
+							return ret unless ret.nil?
+						end
+
+						obj.save
+						halt [402, '{ "error": "Failed to save ' + endpoint + '" }'] unless obj.saved?
+
+						# Call the post-create hook
+						if self.respond_to?(:post_create)
+							ret = post_create(env,request,obj)
+							return ret unless ret.nil?
+						end
+
+						[ 201, { 'id' => obj.id.to_i }.to_json ]
+					end
+
+					get '/:id' do
+						# Call the pre-retrieve hook
+						if self.respond_to?(:pre_retrieve)
+							ret = pre_retrieve(env,request)
+							return ret unless ret.nil?
+						end
+
+						obj = model.get(params[:id])
+
+						# Call the post-retrieve hook
+						if self.respond_to?(:post_retrieve)
+							ret = post_retrieve(env,request,obj)
+							return ret unless ret.nil?
+						end
+
+						obj.to_json
+					end
+
+					put '/:id' do
+						# Call the pre-update hook
+						if self.respond_to?(:pre_update)
+							ret = pre_update(env,request)
+							return ret unless ret.nil?
+						end
+
+						saved = model.update(JSON.parse(request.body.read))
+						halt [403, 'Access Denied'] unless saved
+
+						# Call the post-update hook
+						if self.respond_to?(:post_update)
+							ret = post_update(env,request)
+							return ret unless ret.nil?
+						end
+
+						[ 201, '{ "status": "ok" }' ]
+					end
+
+					delete '/:id' do
+						# Call the pre-destroy hook
+						if self.respond_to?(:pre_destroy)
+							ret = pre_destroy(env,request)
+							return ret unless ret.nil?
+						end
+
+						obj = model.get(params[:id])
+						obj.destroy if obj
+
+						# Call the post-destroy hook
+						if self.respond_to?(:post_destroy)
+							ret = post_destroy(env,request,obj)
+							return ret unless ret.nil?
+						end
+
+						[ 204 ]
+					end
+				}
+
+				# Now, call the endpoint class (assuming it will return a response)
+				env['PATH_INFO'] = '/' + uri.join('/')
+				return endpoint_klass.call(env)
+			end
+
+			# Otherwise, pass the request down the chain...
+			@app.call(env)
+		end
+	end
+end
+
+# vi:set ts=2:

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rack-autocrud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Hentenaar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\tRack middleware that works with Sinatra and DataMapper to dynamically\n\tcreate
+  CRUD endpoints and routes based on models. It ain't perfect, but\n\tit works.\n\n\tThese
+  generated CRUD routes are assumed to return a Rack response.\n\n\tIt's important
+  to note, that you models and endpoints must be in separate\n\tmodules (read: namespaces).\n\n\tInput
+  and Response data are formatted as JSON.\n\n\tSee the README for more info.\n"
+email: tim.hentenaar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/autocrud.rb
+- README.md
+- LICENSE
+homepage: https://github.com/thentenaar/rack-autocrud
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware that automagically handles basic CRUD operations
+test_files: []