RubyGems - rack-backend-api - Versions diffs - 0.0.3 → 0.0.4 - Mend

rack-backend-api 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

data/README.md +47 -0
data/lib/backend_api.rb +4 -4
data/lib/sequel_rack_backend_api_adapter.rb +1 -0
data/rack-backend-api.gemspec +1 -1
data/test/spec_backend_api.rb +39 -2
metadata +4 -4

data/README.md CHANGED Viewed

@@ -164,6 +164,52 @@ nice interface using Ajax and getting the best of what the API has to offer.
 The forms are really meant to be requested via an XHR,
 so that you have access to style and javascript widgets like a date-picker for example.
+Nevertheless you might want to have a better unobtrusiveness for your javascript, meaning
+you want to be able to wrap the forms yourself with your nice layout.
+That is also valuable if you want to have no javascript at all.
+This is exactly what the option `_no_wrap` is for. Basically if you want that,
+it is better to have your Backend middleware before the API in the Rack stack:
+    map '/' do
+      run Frontend
+    end
+    map '/admin' do
+      use Rack::Auth::Basic, "your-realm" do |username, password|
+        [username, password] == ['username', 'password']
+      end
+      use Backend
+      run BackendAPI
+    end
+Then what you do is that you make your Backend middleware aware that if the GET param
+`_no_wrap` is used, it has to forward the request and then wrap the body:
+    class Backend
+      def initialize(app); @app = app; end
+      def call(env)
+        if Rack::Request.new(env)['_no_wrap']
+          status, header, body = @app.call(env)
+          res = Rack::Response.new('<!-- ', status, header)
+          if body.respond_to? :to_str
+            res.write body.to_str
+          elsif body.respond_to?(:each)
+            body.each { |part|
+              res.write part.to_s
+            }
+          end
+          res.write(' -->')
+          res.finish
+        else
+          [200, {'Content-Type'=>'text/plain'}, ['not wrapped']]
+        end
+      end
+    end
+Here, if the param `_no_wrap` is used, this middleware will ask the response to the API middleware
+and then will create a new Response with the body wrapped between `<!-- ` and ` -->`.
 HOW TO PLUG AN ORM
 ==================
@@ -204,6 +250,7 @@ CHANGE LOG
 0.0.1 First version
 0.0.2 Accept CamelCased class names
 0.0.3 Fix Form mockup
+0.0.4 Partial available not only via XHR but also via `_no_wrap` param
 COPYRIGHT
 =========

data/lib/backend_api.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 class BackendAPI
-  VERSION = [0,0,3]
+  VERSION = [0,0,4]
   WRAP = <<-EOT
   <!doctype html>
   <html>
@@ -51,7 +51,7 @@ class BackendAPI
   def get
     @model_instance ||= @model_class.backend_post
     @model_instance.backend_put @req['model']
-    form = @model_instance.backend_form(@req.path, @req['fields'], :destination => @req['_destination'], :submit_text => @req['_submit_text'] )
+    form = @model_instance.backend_form(@req.path, @req['fields'], :destination => @req['_destination'], :submit_text => @req['_submit_text'], :no_wrap => @req['_no_wrap'])
     @res.write(wrap_form(form))
   end
@@ -102,14 +102,14 @@ 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'])
+      form = @model_instance.backend_form(@req.path, @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
   end
   def wrap_form(form)
-    if @req.xhr?
+    if @req['_no_wrap'] || @req.xhr?
       form
     else
       WRAP % [@model_class_name, form]

data/lib/sequel_rack_backend_api_adapter.rb CHANGED Viewed

@@ -27,6 +27,7 @@ module ::Sequel::Plugins::RackBackendApiAdapter
       o << "<input type='hidden' name='_method' value='#{opts[:method] || method}' />\n"
       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?
       o << "<input type='submit' name='save' value='#{opts[:submit_text] || 'SAVE'}' />\n"
       o << "</form>\n"
       o

data/rack-backend-api.gemspec CHANGED Viewed

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rack-backend-api'
-  s.version = "0.0.3"
+  s.version = "0.0.4"
   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/spec_backend_api.rb CHANGED Viewed

@@ -22,6 +22,27 @@ def wrap(title, form) #mock wrapped versions of forms when not XHR
   BackendAPI::WRAP % [title,form]
 end
+class WrappingMiddleware
+  def initialize(app); @app = app; end
+  def call(env)
+    if Rack::Request.new(env)['_no_wrap']
+      status, header, body = @app.call(env)
+      res = Rack::Response.new('<!-- ', status, header)
+      if body.respond_to? :to_str
+        res.write body.to_str
+      elsif body.respond_to?(:each)
+        body.each { |part|
+          res.write part.to_s
+        }
+      end
+      res.write(' -->')
+      res.finish
+    else
+      [200, {'Content-Type'=>'text/plain'}, ['not wrapped']]
+    end
+  end
+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')
@@ -85,9 +106,16 @@ describe 'API Post' do
     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
+  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?
+    res = req_lint(WrappingMiddleware.new(BackendAPI.new)).post('/haiku', :params => {'_no_wrap' => 'true', 'model' => {'title' => '13'}})
+    res.body.should==('<!-- '+compared.backend_form('/haiku',['title'], {:no_wrap=>'true'})+' -->')
+    res.body.should.match(/name='_no_wrap'.*value='true'/)
+  end
 end
 describe 'API Get' do
@@ -106,8 +134,10 @@ describe 'API Get' do
     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" do
+  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'})
+    req_lint(WrappingMiddleware.new(BackendAPI.new)).get('/haiku?_no_wrap=true').body.should==('<!-- '+Haiku.new.backend_form('/haiku', nil, {:no_wrap=>'true'})+' -->')
   end
 end
@@ -149,6 +179,13 @@ describe 'API Put' do
   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?
+    res = req_lint(WrappingMiddleware.new(BackendAPI.new)).post('/haiku/3', :params => {'_no_wrap' => 'true', 'model' => {'title' => '13'}})
+    res.body.should==('<!-- '+compared.backend_form('/haiku/3',['title'], {:no_wrap=>'true'})+' -->')
+    res.body.should.match(/name='_no_wrap'.*value='true'/)
+  end
 end
 describe 'API Delete' do

metadata CHANGED Viewed

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