rack-backend-api 0.0.4 → 0.0.5

data/README.md

@@ -7,13 +7,13 @@ while only concentrating on the interface.
 All the database interactions are handled by the API.
 
 The project is made with a Rack middleware and a small adapter for the Sequel ORM.
-One of the chapter explains how to create an adpater for another ORM (if you do one, please share).
+One of the chapter explains how to create an adapter for another ORM (if you do one, please share).
 
 Also this tool is part of a toolkit that is made for creating a CMS (in a modular way).
 Here are the others:
 
 - [Crushyform](https://github.com/mig-hub/sequel-crushyform): A Sequel plugin for building forms in a painless way and as flexible as possible.
-- [Stash Magic](https://github.com/mig-hub/stash_magic): A simple attachment system that also handles thumbnails or other styles via ImageMagick. Originaly tested on Sequel ORM but purposedly easy to plug to something else.
+- [Stash Magic](https://github.com/mig-hub/stash_magic): A simple attachment system that also handles thumbnails or other styles via ImageMagick. Originally tested on Sequel ORM but purposedly easy to plug to something else.
 - [Cerberus](https://github.com/mig-hub/cerberus): A Rack middleware for form-based authentication.
 
 This project is still at an early stage so don't hesitate to ask any question if the documentation lacks something.
@@ -42,8 +42,8 @@ HOW TO USE IT
 =============
 
 BackendAPI is a Rack middleware that you have to put before your actual backend/CMS, 
-and generaly after an authentication middleware.
-And it takes care of everything involving interraction with your database.
+and generally after an authentication middleware.
+And it takes care of everything involving interaction with your database.
 
 In reality, it does not HAVE to be with the Backend but it makes sense and that way,
 both share the authentication middleware.
@@ -59,11 +59,11 @@ A rackup stack for your application might look like this:
         [username, password] == ['username', 'password']
       end
       use BackendAPI
-      run Backend
+      run Backend.new
     end
 
-Your backend receives every request that the Restful API doesn't recognize.
-The BackendAPI recognizes requests following this scheme:
+Your backend receives every request that the Restful API doesn't recognise.
+The BackendAPI recognises requests following this scheme:
 
     METHOD /Backend-path/model_class/ID
 
@@ -80,7 +80,7 @@ Then if you need to delete the entry with ID 4:
 
     DELETE /admin/blog_post/4
 
-The API also understands a camelcased class name:
+The API also understands a CamelCased class name:
 
     DELETE /admin/BlogPost/4
 
@@ -93,7 +93,7 @@ and therefore use the right action and method for POST and PUT requests.
 The problem sometimes with a Restful API is that in real life,
 in spite of the fact that not every requests are GET or POST it is sometimes forced.
 The href of a link is always a GET, and the method for a form is
-overriden if it is not GET or POST.
+overridden if it is not GET or POST.
 
 This is why Rack has a very handy middleware called MethodOverride.
 You don't have to `use` it because BackendAPI puts it on the stack for you.
@@ -180,7 +180,7 @@ it is better to have your Backend middleware before the API in the Rack stack:
         [username, password] == ['username', 'password']
       end
       use Backend
-      run BackendAPI
+      run BackendAPI.new
     end
 
 Then what you do is that you make your Backend middleware aware that if the GET param
@@ -224,22 +224,22 @@ It is done automatically if the constant `Sequel` is defined (so you have to req
 Here are the methods to implement, most of them are just aliases for having a single name:
 
 - `Model::backend_get( id )` Should return a single database entry with the id provided
-- `Model::backend_post( hash-of-values )` Generaly equivalent to Model::new, it creates a new entry with provided values and without validating or saving
+- `Model::backend_post( hash-of-values )` Generally equivalent to Model::new, it creates a new entry with provided values and without validating or saving
 - `Model#backend_delete` Instance method that destroys the entry
-- `Model#backend_put( hash-of-values )` Generaly equivalent to Model::update, it updates an existing entry with provided values and without validating or saving
+- `Model#backend_put( hash-of-values )` Generally equivalent to Model::update, it updates an existing entry with provided values and without validating or saving
 
 Others are slightly more sophisticated:
 
 - `Model#backend_save?` Returns true if the entry is validated and saved. It generally triggers the error messages for the form as well.
 - `Model#default_backend_columns` This the list of columns in the forms when the list of fields is not provided via `fields` option
 - `Model#backend_form( action_url, columns=nil, options={} )` It is only the wrapping of the form without the actual fields. Try to implement it like the Sequel one.
-- `Model#backend_fields( columns )` These are the actual fields. There is a default behavior that basically puts a textarea for everything. That works in most cases but this is meant to be overriden for a better solution. We recommand [Crushyform](https://rubygems.org/gems/sequel-crushyform) for Sequel because we did it so we know it plays well with BackendAPI, and also because you don't have anything more to do. BackendAPI knows you have [Crushyform](https://rubygems.org/gems/sequel-crushyform) and use it to create the fields.
+- `Model#backend_fields( columns )` These are the actual fields. There is a default behaviour that basically puts a `textarea` for everything. That works in most cases but this is meant to be overridden for a better solution. We recommend [Crushyform](https://rubygems.org/gems/sequel-crushyform) for Sequel because we did it so we know it plays well with BackendAPI, and also because you don't have anything more to do. BackendAPI knows you have [Crushyform](https://rubygems.org/gems/sequel-crushyform) and use it to create the fields.
 - `Model#backend_delete_form( action_url, options={})` Basically sugar for Model#backend_form but with an empty array for columns, and these options `{:submit_text=>'X', :method=>'DELETE'}` predefined which you can override. We've seen before that it is for creating DELETE forms.
 
 THANX
 =====
 
-I'd like to thank [Manveru](https://github.com/manveru), [Pistos](https://github.com/pistos) and many others on the #ramaze IRC channel for being friendly, helpful and obviously savy.
+I'd like to thank [Manveru](https://github.com/manveru), [Pistos](https://github.com/pistos) and many others on the #ramaze IRC channel for being friendly, helpful and obviously savvy.
 
 Also I'd like to thank [Konstantin Haase](https://github.com/rkh) for the same reasons as he helped me many times on #rack issues,
 and because [almost-sinatra](https://github.com/rkh/almost-sinatra) is just made with the 8 nicest lines of code to read.

data/lib/backend_api.rb

@@ -1,5 +1,5 @@
 class BackendAPI
-  VERSION = [0,0,4]
+  VERSION = [0,0,5]
   WRAP = <<-EOT
   <!doctype html>
   <html>
@@ -102,7 +102,7 @@ class BackendAPI
         @res.redirect(::Rack::Utils::unescape(@req['_destination']))
       end
     else
-      form = @model_instance.backend_form(@req.path, @req['model'].keys, :destination => @req['_destination'], :submit_text => @req['_submit_text'], :no_wrap => @req['_no_wrap'])
+      form = @model_instance.backend_form(@req.path, @req['fields']||@req['model'].keys, :destination => @req['_destination'], :submit_text => @req['_submit_text'], :no_wrap => @req['_no_wrap'])
       @res.write(wrap_form(form))
       @res.status=400 # Bad Request
     end

data/lib/sequel_rack_backend_api_adapter.rb

@@ -28,6 +28,9 @@ module ::Sequel::Plugins::RackBackendApiAdapter
       o << "<input type='hidden' name='_destination' value='#{opts[:destination]}' />\n" unless opts[:destination].nil?
       o << "<input type='hidden' name='_submit_text' value='#{opts[:submit_text]}' />\n" unless opts[:submit_text].nil?
       o << "<input type='hidden' name='_no_wrap' value='#{opts[:no_wrap]}' />\n" unless opts[:no_wrap].nil?
+      cols.each do |c|
+        o << "<input type='hidden' name='fields[]' value='#{c}' />\n"
+      end
       o << "<input type='submit' name='save' value='#{opts[:submit_text] || 'SAVE'}' />\n"
       o << "</form>\n"
       o

data/rack-backend-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s| 
   s.name = 'rack-backend-api'
-  s.version = "0.0.4"
+  s.version = "0.0.5"
   s.platform = Gem::Platform::RUBY
   s.summary = "A Rack middleware that provides a simple API for your Admin section"
   s.description = "The purpose of this Rack Middleware is to provide an API that interfaces with database actions in order to build a CMS."

data/test/db.rb

@@ -35,6 +35,7 @@ end
 class Pic < ::Sequel::Model
   set_schema do
     primary_key :id
+    String :name
     String :image, :crushyform=>{:type=>:attachment}
   end
   create_table unless table_exists?

data/test/spec_backend_api.rb

@@ -22,7 +22,7 @@ def wrap(title, form) #mock wrapped versions of forms when not XHR
   BackendAPI::WRAP % [title,form]
 end
 
-class WrappingMiddleware
+class WrappingMiddleware # Wrap but with the previous middleware
   def initialize(app); @app = app; end
   def call(env)
     if Rack::Request.new(env)['_no_wrap']
@@ -44,21 +44,25 @@ class WrappingMiddleware
 end
 
 describe 'API Misc' do
+  
   should "Send 404 X-cascade if no response at the bottom of the Rack stack - Builder::run" do
     res = req_lint(BackendAPI.new).get('/zzz')
     res.status.should==404
     res.headers['X-Cascade'].should=='pass'
   end
+  
   should 'Follow the Rack stack if response is not found - Builder::use' do
     res = req_lint(BackendAPI.new(dummy_app)).get('/')
     res.status.should==200
     res.body.should=='dummy'
   end
+  
   should "Have a special path for sending version" do
     res = req_lint(BackendAPI.new(dummy_app)).get('/_version')
     res.status.should==200
     res.body.should==BackendAPI::VERSION.join('.')
   end
+  
   should "Accept CamelCased or under_scrored class names" do
     # I prefer CamelCased as it only needs to be eval(ed)  
     # But people are used to under_scrored  
@@ -72,6 +76,7 @@ describe 'API Misc' do
 end
 
 describe 'API Post' do
+  
   should "Create a new entry in the database and send a 201 response" do
     res = req_lint(BackendAPI.new).post('/haiku', :params => {'model' => {'title' => 'Summer', 'body' => "Summer was missing\nI cannot accept that\nI need to bake in the sun"}})
     res.status.should==201 # Created
@@ -79,14 +84,17 @@ describe 'API Post' do
     haiku.title.should=='Summer'
     haiku.body.should=="Summer was missing\nI cannot accept that\nI need to bake in the sun"
   end
+  
   should "Fallback to an update if there is an id provided" do
     req_lint(BackendAPI.new).post('/haiku/4', :params => {'model' => {'title' => 'Summer is not new !!!'}})
     Haiku.filter(:title => 'Summer is not new !!!').first.id.should==4
   end
+  
   should "Accept a new entry with no attributes as long as it is valid" do
     res = req_lint(BackendAPI.new).post('/haiku')
     res.status.should==201
   end
+  
   should "Send back the appropriate form when the creation is not valid" do
     
     res = req_lint(BackendAPI.new).post('/haiku', :params => {'model' => {'title' => '13'}})
@@ -100,15 +108,27 @@ describe 'API Post' do
     res.status.should==400
     res.body.should==compared.backend_form('/haiku', ['title'])
   end
+  
+  should "Use fields instead of model keys when validation fails (if possible)" do
+    # That helps keeping the same order when validation doesn't pass
+    # Also it keeps fields not sent when untouched, like checkboxes or images
+    res = req_lint(BackendAPI.new).post('/haiku', :params => {'model' => {'title' => '13'}})
+    res.body.should.not.match(/value='body'/)
+    res = req_lint(BackendAPI.new).post('/haiku', :params => {'model' => {'title' => '13'}, 'fields' => ['title', 'body']})
+    res.body.should.match(/value='body'/)
+  end
+  
   should "Accept a destination for when Entry is validated and request is not XHR" do
     res = req_lint(BackendAPI.new(dummy_app)).post('/haiku', :params => {'_destination' => 'http://www.domain.com/list.xml', 'model' => {'title' => 'Destination Summer'}})
     res.status.should==302
     res.headers['Location']=='http://www.domain.com/list.xml'
     Haiku.order(:id).last.title.should=='Destination Summer'
   end
+  
   should "Keep _destination until form is validated" do
     req_lint(BackendAPI.new).post('/haiku', :params => {'_destination' => '/', 'model' => {'title' => '13'}}).body.should.match(/name='_destination'.*value='\/'/)
   end
+  
   should "Keep _no_wrap until form is validated" do
     compared = Haiku.new.set('title' => '13')
     compared.valid?
@@ -119,21 +139,26 @@ describe 'API Post' do
 end
 
 describe 'API Get' do
+  
   should "Return the form for a fresh entry when no id is provided" do
     req_lint(BackendAPI.new).get('/haiku').body.should==wrap('Haiku', Haiku.new.backend_form('/haiku'))
   end
+  
   should "Return the form for an update when id is provided" do
     req_lint(BackendAPI.new).get('/haiku/3').body.should==wrap('Haiku', Haiku[3].backend_form('/haiku/3'))
   end
+  
   should "Be able to send a form with selected set of fields" do
     req_lint(BackendAPI.new).get('/haiku', :params => {'fields' => ['title']}).body.should==wrap('Haiku', Haiku.new.backend_form('/haiku', ['title']))
     req_lint(BackendAPI.new).get('/haiku/3', :params => {'fields' => ['title']}).body.should==wrap('Haiku', Haiku[3].backend_form('/haiku/3', ['title']))
   end
+  
   should "Update the entry before building the form if model parameter is used" do
     update = {'title' => 'Changed'}
     req_lint(BackendAPI.new).get('/haiku', :params => {'model' => update}).body.should==wrap('Haiku', Haiku.new.set(update).backend_form('/haiku'))
     req_lint(BackendAPI.new).get('/haiku/3', :params => {'model' => update}).body.should==wrap('Haiku', Haiku[3].set(update).backend_form('/haiku/3'))
   end
+  
   should "Return a partial if the request is XHR or param _no_wrap is used" do
     req_lint(BackendAPI.new).get('/haiku', "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest").body.should==Haiku.new.backend_form('/haiku')
     req_lint(BackendAPI.new).get('/haiku?_no_wrap=true').body.should==Haiku.new.backend_form('/haiku', nil, {:no_wrap=>'true'})
@@ -142,6 +167,7 @@ describe 'API Get' do
 end
 
 describe 'API Put' do
+  
   should "Update a database entry that exists and send a 201 response" do
     res = req_lint(BackendAPI.new).put('/haiku/3', :params => {'model' => {'body' => "Maybe I have no inspiration\nBut at least\nIt should be on three lines"}})
     res.status.should==201 # Created
@@ -149,14 +175,17 @@ describe 'API Put' do
     haiku.body.should=="Maybe I have no inspiration\nBut at least\nIt should be on three lines"
     haiku.title.should=='Spring'
   end
+  
   should "Work with MethodOverride" do
     req_lint(BackendAPI.new).post('/haiku/3', :params => {'_method' => 'PUT', 'model' => {'title' => 'Spring Wow !!!'}})
     Haiku[3].title.should=='Spring Wow !!!'
   end
+  
   should "Not break if one updates with no changes" do
     res = req_lint(BackendAPI.new).put('/haiku/3')
     res.status.should==201
   end
+  
   should "Send back the appropriate form when the creation is not valid" do
     
     res = req_lint(BackendAPI.new).put('/haiku/3', :params => {'model' => {'title' => '13'}})
@@ -170,15 +199,27 @@ describe 'API Put' do
     res.status.should==400
     res.body.should==compared.backend_form('/haiku/3', ['title'])
   end
+  
+  should "Use fields instead of model keys when validation fails (if possible)" do
+    # That helps keeping the same order when validation doesn't pass
+    # Also it keeps fields not sent when untouched, like checkboxes or images
+    res = req_lint(BackendAPI.new).put('/haiku/3', :params => {'model' => {'title' => '13'}})
+    res.body.should.not.match(/value='body'/)
+    res = req_lint(BackendAPI.new).put('/haiku/3', :params => {'model' => {'title' => '13'}, 'fields' => ['title', 'body']})
+    res.body.should.match(/value='body'/)
+  end
+  
   should "Accept a destination for when Update is validated and request is not XHR" do
     res = req_lint(BackendAPI.new(dummy_app)).post('/haiku/3', :params => {'_method' => 'PUT', '_destination' => '/', 'model' => {'title' => 'Spring destination !!!'}})
     res.status.should==302
     res.headers['Location']=='/'
     Haiku[3].title.should=='Spring destination !!!'
   end
+  
   should "keep destination until form is validated" do
     req_lint(BackendAPI.new).put('/haiku/3', :params => {'_destination' => '/', 'model' => {'title' => '13'}}).body.should.match(/name='_destination'.*value='\/'/)
   end
+  
   should "Keep _no_wrap until form is validated" do
     compared = Haiku[3].set('title' => '13')
     compared.valid?
@@ -189,15 +230,18 @@ describe 'API Put' do
 end
 
 describe 'API Delete' do
+  
   should "Delete a database entry that exists and send a 204 response" do
     res = req_lint(BackendAPI.new).delete('/haiku/1')
     res.status.should==204 # No Content
     Haiku[1].should==nil
   end
+  
   should "Work with MethodOverride" do
     req_lint(BackendAPI.new(dummy_app)).post('/haiku/2', :params => {'_method' => 'DELETE'})
     Haiku[2].should==nil
   end
+  
   should "Accept a destination" do
     res = req_lint(BackendAPI.new).delete('/haiku/3', :params => {'_destination' => '/'})
     res.status.should==302

data/test/spec_sequel_adapter.rb

@@ -65,6 +65,12 @@ describe 'Sequel Adapter' do
     f.should.match(/name='_submit_text' value='CREATE'/)
   end
   
+  should 'Send the list of fields in the correct order' do
+    # That helps keeping the same order when validation doesn't pass
+    # Also it keeps fields not sent when untouched, like checkboxes or images
+    Pic.new.backend_form('/url').scan(/name='fields\[\]'/).size.should==2
+  end
+  
   should 'Have a backend_delete_form method - pure HTTP way of deleting records with HTTP DELETE method' do
     form = Haiku.first.backend_delete_form('/url')
     form.should.match(/name='_method' value='DELETE'/)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-backend-api
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mickael Riga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-21 00:00:00 +01:00
+date: 2011-07-22 00:00:00 +01:00
 default_executable: 
 dependencies: []