marley 0.5.0 → 0.6.0

data/rdoc/messages_joint.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'sequel'
+require 'marley'
+require 'marley/test_helpers'
+
+DB=Sequel.sqlite('')
+DB.create_table :users do
+  primary_key :id
+  text :name, :unique => true
+  text :user_type, :index => true
+  text :pw_hash
+  datetime :date_created, :index => true
+  text :description
+end
+DB.create_table :messages do
+  primary_key :id
+  integer :user_id, :index => true
+  text :message_type, :index => true
+  text :title,  :index => true,:null => false
+  text :content
+end
+DB.create_table :messages_users do
+  primary_key :id
+  integer :user_id
+  integer :message_id
+  boolean :read, :index => true
+  index [:user_id, :message_id], :unique => true
+end
+
+Sequel::Model.plugin :validation_helpers
+Marley.plugin('orm_rest_convenience').apply(Sequel::Model)
+Marley.joint 'user'
+Marley.plugin('current_user_methods').apply(Sequel::Model)
+Marley.joint 'messages'

data/rdoc/messages_joint.rdoc

@@ -0,0 +1,18 @@
+
+==The Messages Joint
+
+  setup
+    DB[:users].delete
+    DB[:messages].delete
+    DB[:messages_users].delete
+    DB[:SQLITE_SEQUENCE].update(:seq => 0)
+    user_client=Marley::TestClient.new(:resource_name => 'user')
+    user=user_client.read({},:method => 'new').set_values(:password => 'asdfasdf', :confirm_password => 'asdfasdf')
+    (1 .. 5).each { |i|
+      user_client.create(user.set_values(:name => "user#{i}"))
+      instance_variable_set(:"@client#{i}", Marley::TestClient.new(:auth => ["user#{i}",'asdfasdf'] ))
+    }
+  end
+
+examples:
+

data/rdoc/messages_joint/private_messages.rdoc

@@ -0,0 +1,59 @@
+
+==Private Messages
+
+  setup
+    (1 .. 5).each { |i|
+      instance_variable_get(:"@client#{i}").resource_name='private_message'
+    }
+  end
+
+example: user1 sends message to user2
+
+>> @msg=@client1.read({},:method => 'new')
+=> [:instance, {:url=>"/private_message/", :schema=>[["text", :recipients, 0, ""], ["integer", :user_id, 3, 1], ["text", :title, 4, nil], ["text", :content, 0, nil]], :name=>"private_message", :new_rec=>true, :actions=>nil}, []]
+
+>> @client1.create(@msg.set_values(:title => 'asdf',:recipients => 'xxx'),:code => 400)
+=> [:error, {:error_type=>"validation", :error_details=>{:recipients=>["xxx is not a valid message recipient"]}, :description=>nil}]
+>> @client1.create(@msg.set_values(:title => 'asdf',:recipients => 'user2'))
+=> [:instance, {:url=>"/private_message/1", :schema=>[["text", :recipients, 2, "user2"], ["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 6, "asdf"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []]
+
+>> @client1.read
+=> []
+>> @client3.read
+=> []
+>> @client2.read
+=> [[:instance, {:url=>"/private_message/1", :schema=>[["text", :recipients, 2, "user2"], ["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 6, "asdf"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []]]
+
+example: user2 sends message to user3 and user4, each of which replies
+
+>> @msg=@client2.read({},:method => 'new')
+=> [:instance, {:url=>"/private_message/", :schema=>[["text", :recipients, 0, ""], ["integer", :user_id, 3, 2], ["text", :title, 4, nil], ["text", :content, 0, nil]], :name=>"private_message", :new_rec=>true, :actions=>nil}, []]
+>> @client2.create(@msg.set_values(:title => 'message1',:recipients => 'user3,user4'))
+=> [:instance, {:url=>"/private_message/1", :schema=>[["text", :recipients, 2, "user3,user4"], ["text", :author, 2, "user2"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 2], ["text", :title, 6, "message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []]
+>> @client1.read
+=> []
+>> @client2.read
+=> []
+>> @client3.read
+=> [[:instance, {:url=>"/private_message/1", :schema=>[["text", :recipients, 2, "user3,user4"], ["text", :author, 2, "user2"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 2], ["text", :title, 6, "message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []]]
+>> @orig=@client4.read
+=> [[:instance, {:url=>"/private_message/1", :schema=>[["text", :recipients, 2, "user3,user4"], ["text", :author, 2, "user2"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 2], ["text", :title, 6, "message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []]]
+
+>> @u3r=@client3.read({},:url => @orig[0].url+'/reply')
+=> [:instance, {:url=>"/private_message/", :schema=>[["text", :recipients, 0, "user2"], ["integer", :user_id, 3, 3], ["text", :title, 4, "re: message1"], ["text", :content, 0, nil]], :name=>"private_message", :new_rec=>true, :actions=>nil}, []]
+>> @u3ra=@client3.read({},:url => @orig[0].url+'/reply_all')
+=> [:instance, {:url=>"/private_message/", :schema=>[["text", :recipients, 0, "user2,user4"], ["integer", :user_id, 3, 3], ["text", :title, 4, "re: message1"], ["text", :content, 0, nil]], :name=>"private_message", :new_rec=>true, :actions=>nil}, []]
+
+>> @client3.create(@u3r)
+=> [:instance, {:url=>"/private_message/2", :schema=>[["text", :recipients, 2, "user2"], ["text", :author, 2, "user3"], ["integer", :id, 2, 2], ["integer", :user_id, 3, 3], ["text", :title, 6, "re: message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []]
+>> @client2.read
+=> [[:instance, {:url=>"/private_message/2", :schema=>[["text", :recipients, 2, "user2"], ["text", :author, 2, "user3"], ["integer", :id, 2, 2], ["integer", :user_id, 3, 3], ["text", :title, 6, "re: message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []]]
+
+>> @client3.create(@u3ra)
+=> [:instance, {:url=>"/private_message/3", :schema=>[["text", :recipients, 2, "user2,user4"], ["text", :author, 2, "user3"], ["integer", :id, 2, 3], ["integer", :user_id, 3, 3], ["text", :title, 6, "re: message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []]
+>> @client2.read
+=> [[:instance, {:url=>"/private_message/2", :schema=>[["text", :recipients, 2, "user2"], ["text", :author, 2, "user3"], ["integer", :id, 2, 2], ["integer", :user_id, 3, 3], ["text", :title, 6, "re: message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []], [:instance, {:url=>"/private_message/3", :schema=>[["text", :recipients, 2, "user2,user4"], ["text", :author, 2, "user3"], ["integer", :id, 2, 3], ["integer", :user_id, 3, 3], ["text", :title, 6, "re: message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []]]
+
+>> @client4.read
+=> [[:instance, {:url=>"/private_message/1", :schema=>[["text", :recipients, 2, "user3,user4"], ["text", :author, 2, "user2"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 2], ["text", :title, 6, "message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []], [:instance, {:url=>"/private_message/3", :schema=>[["text", :recipients, 2, "user2,user4"], ["text", :author, 2, "user3"], ["integer", :id, 2, 3], ["integer", :user_id, 3, 3], ["text", :title, 6, "re: message1"], ["text", :content, 2, nil]], :name=>"private_message", :new_rec=>false, :actions=>[:reply, :reply_all]}, []]]
+

data/rdoc/messages_joint/public_messages.rdoc

@@ -0,0 +1,65 @@
+
+==Public Messages
+
+  setup
+    (1 .. 5).each { |i|
+      instance_variable_get(:"@client#{i}").resource_name='public_message'
+    }
+  end
+
+
+
+example: user1 writes, edits, deletes post
+
+
+>>@msg=@client1.read({},:method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/public_message/", :name=>"public_message", :schema=>[["integer", :user_id, 3, 1], ["text", :title, 4, nil], ["text", :content, 0, nil]]}, []]
+
+>> @client1.create(@msg,:code => 400)
+=> [:error, {:error_type=>"validation", :description=>nil, :error_details=>{:title=>["is required"]}}]
+
+>> @msg=@client1.create(@msg.set_values(:title => 'test'))
+=> [:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 4, "test"], ["text", :content, 0, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/1"}}, []]
+
+>> @client1.update(@msg.set_values(:content => 'asdf'),:url => @msg.url)
+=> [:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 4, "test"], ["text", :content, 0, "asdf"]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/1"}}, []]
+
+>> @client1.del({},:url => @msg.url)
+=> [:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 4, "test"], ["text", :content, 0, "asdf"]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/1"}}, []]
+
+
+example:  two users, several messages
+>> @u1msg=@client1.read({},:method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/public_message/", :name=>"public_message", :schema=>[["integer", :user_id, 3, 1], ["text", :title, 4, nil], ["text", :content, 0, nil]]}, []]
+>> @u2msg=@client2.read({},:method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/public_message/", :name=>"public_message", :schema=>[["integer", :user_id, 3, 2], ["text", :title, 4, nil], ["text", :content, 0, nil]]}, []]
+
+>> @u1m1=@client1.create(@u1msg.set_values(:title => 'usr1 msg1'))
+=> [:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 4, "usr1 msg1"], ["text", :content, 0, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/1"}}, []]
+
+>> @client3.read
+=> [[:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 6, "usr1 msg1"], ["text", :content, 2, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []]]
+
+>> @u1m2=@client1.create(@u1msg.set_values(:title => 'usr1 msg2'))
+=> [:instance, {:url=>"/public_message/2", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :title, 4, "usr1 msg2"], ["text", :content, 0, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/2"}}, []]
+>> @client3.read
+=> [[:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 6, "usr1 msg1"], ["text", :content, 2, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []], [:instance, {:url=>"/public_message/2", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :title, 6, "usr1 msg2"], ["text", :content, 2, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply"}}, []]]
+
+>> @client3.update(@u1m1.set_values(:title => 'asdf'),:url => @u1m1.url,:code => 403)
+=> [:error, {:error_type=>"authorization", :error_details=>nil, :description=>"You are not authorized for this operation"}]
+>> @client2.update(@u1m1.set_values(:title => 'asdf'),:url => @u1m1.url,:code => 403)
+=> [:error, {:error_type=>"authorization", :error_details=>nil, :description=>"You are not authorized for this operation"}]
+>> @client1.update(@u1m1.set_values(:title => 'asdf'),:url => @u1m1.url)
+=> [:instance, {:url=>"/public_message/1", :schema=>[["text", :author, 2, "user1"], ["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :title, 4, "asdf"], ["text", :content, 0, nil]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/1"}}, []]
+
+>> @u2r1=@client2.read({},:url => @u1m1.url+'/reply')
+=> [:instance, {:url=>"/public_message/", :schema=>[["integer", :user_id, 3, 2], ["text", :title, 4, "re: asdf"], ["text", :content, 0, nil]], :name=>"public_message", :new_rec=>true, :actions=>nil}, []]
+
+>> @client2.create(@u2r1.set_values(:content => 'xxxxxx'))
+=> [:instance, {:url=>"/public_message/3", :schema=>[["text", :author, 2, "user2"], ["integer", :id, 2, 3], ["integer", :user_id, 3, 2], ["text", :title, 4, "re: asdf"], ["text", :content, 0, "xxxxxx"]], :name=>"public_message", :new_rec=>false, :actions=>{:get=>"reply", :delete=>"/public_message/3"}}, []]
+
+
+
+
+
+

data/rdoc/orm_rest_convenience_plugin.rb

@@ -0,0 +1,28 @@
+
+require 'rubygems'
+require 'sequel'
+require 'marley'
+require 'marley/test_helpers'
+
+DB=Sequel.sqlite('')
+DB.create_table :users do
+  primary_key :id
+  text :name,:unique => true, :null => false
+  text :password, :null => false
+  text :description
+end
+
+Marley.config(:http_auth => false)
+Marley.plugin('orm_rest_convenience').apply(Sequel::Model)
+module Marley
+  module Resources
+    class User < Sequel::Model
+      def validate
+        validates_presence :name
+        validates_unique :name
+        validates_presence :description
+        validates_presence :password
+      end
+    end
+  end
+end

data/rdoc/orm_rest_convenience_plugin.rdoc

@@ -0,0 +1,99 @@
+
+=== Orm Rest Convenience
+
+This plugin tries to be ORM agnostic but I've only tested it with Sequel.  You are encouraged to fork this plugin and make it work with other ORM's.
+
+setup
+  @client=Marley::TestClient.new(:resource_name => 'user')
+end
+
+examples:
+  => Marley::Resources::User
+  >> MR::User.resource_name
+  => "user"
+  >> MR::User.foreign_key_name
+  => :user_id
+  >> MR::User.reggae_link
+  => [:link, {:url=>"/user/", :title=>"User"},[]]
+  >> MR::User.reggae_link('new')
+  => [:link, {:url=>"/user/new", :title=>"New User"},[]]
+  >> MR::User.model_actions
+  => {:get => [:new,:list]}
+  >> @client.read
+  => []
+  >> @client.read({},{:method => 'new'})
+  => [:instance, {:url=>"/user/", :new_rec=>true, :actions=>nil, :schema=>[["text", :name, 4, nil], [:password, :password, 4, nil], ["text", :description, 0, nil]], :name=>"user"}, []]
+
+  >> @client.create({},:code => 400)
+  => [:error, {:description=>nil, :error_type=>"validation", :error_details=>{:description=>["is required"], :name=>["is required"], :password=>["is required"]}}]
+  >> @client.create({:'user[name]' => 'asdf',:'user[password]' => 'asdf', :'user[description]' => 'xxxx'})
+  => [:instance, {:url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]
+
+  >> MR::User[1].to_s
+  => "asdf"
+  >> MR::User[1].url
+  => "/user/1"
+  >> MR::User[1].reggae_link
+  => [:link, {:url=>"/user/1", :title=>""},[]]
+  >> MR::User[1].reggae_link('foobar')
+  => [:link, {:url=>"/user/1", :title=>"Foobar"},[]]
+  >> MR::User[1].rest_cols
+  => [:id, :name, :password, :description]
+  >> MR::User[1].write_cols
+  => [:name, :password, :description]
+  >> MR::User[1].hidden_cols
+  => []
+  >> MR::User[1].required_cols
+  => []
+  >> MR::User[1].reggae_schema
+  => [["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]]
+  >> MR::User[1].reggae_instance
+  => [:instance, {:url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]
+
+  >> @client.create({:'user[name]' => 'asdf',:'user[password]' => 'asdf', :'user[description]' => 'xxxx'},:code => 400)
+  => [:error, {:description=>nil, :error_type=>"validation", :error_details=>{:name=>["is already taken"]}}]
+  >> @client.create({:'user[name]' => 'asd',:'user[password]' => 'asdf', :'user[description]' => 'xxxx'})
+  => [:instance, {:url=>"/user/2", :schema=>[["integer", :id, 2, 2], ["text", :name, 4, "asd"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]
+  >> @client.read
+  => [[:instance, {:url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []], [:instance, {:url=>"/user/2", :schema=>[["integer", :id, 2, 2], ["text", :name, 4, "asd"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]]
+  >> @client.del({},:instance_id => 2)
+  => [:instance, {:url=>"/user/2", :schema=>[["integer", :id, 2, 2], ["text", :name, 4, "asd"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]
+  >> @client.read
+  => [[:instance, {:url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "xxxx"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]]
+  >> @client.read({},:instance_id => 2, :code => 404)
+  => [:error, {:description=>"Not Found", :error_type=>"routing", :error_details=>nil}]
+  >> @client.update({:'user[description]' => 'ddd'},:instance_id => 1)
+  => [:instance, {:url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "ddd"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]
+  >> @client.update({},:instance_id => 1)
+  => [:instance, {:url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "ddd"]], :new_rec=>false, :actions=>nil, :name=>"user"}, []]
+
+>> MR::User.reject_cols![:new?][true] << 'name'
+=> [/^id$/, /_type$/, /date_(created|updated)/, "name"]
+>> MR::User.new.rest_cols
+=> [:password, :description]
+>> @client.read({}, :method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/user/", :schema=>[[:password, :password, 4, nil], ["text", :description, 0, nil]], :name=>"user"}, []]
+>> @client.read
+=> [[:instance, {:new_rec=>false, :actions=>nil, :url=>"/user/1", :schema=>[["integer", :id, 2, 1], ["text", :name, 4, "asdf"], [:password, :password, 4, "asdf"], ["text", :description, 0, "ddd"]], :name=>"user"}, []]]
+>> MR::User.reject_cols![:new?][false] << 'name'
+=> [/_type$/, "name"]
+>> @client.read
+=> [[:instance, {:new_rec=>false, :actions=>nil, :url=>"/user/1", :schema=>[["integer", :id, 2, 1], [:password, :password, 4, "asdf"], ["text", :description, 0, "ddd"]], :name=>"user"}, []]]
+
+>> MR::User.ro_cols![:new?][false] << 'description'
+=> [/^id$/, /_id$/, /date_(created|updated)/, "description"]
+>> @client.read({},:method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/user/", :schema=>[[:password, :password, 4, nil], ["text", :description, 0, nil]], :name=>"user"}, []]
+>> @client.read
+=> [[:instance, {:new_rec=>false, :actions=>nil, :url=>"/user/1", :schema=>[["integer", :id, 2, 1], [:password, :password, 4, "asdf"], ["text", :description, 2, "ddd"]], :name=>"user"}, []]]
+
+>> MR::User.hidden_cols![:new?][true]=['password']
+=> ["password"]
+>> @client.read({},:method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/user/", :schema=>[[:password, :password, 5, nil], ["text", :description, 0, nil]], :name=>"user"}, []]
+
+>> MR::User.required_cols![:new?][true]=['description']
+=> ["description"]
+>> @client.read({},:method => 'new')
+=> [:instance, {:new_rec=>true, :actions=>nil, :url=>"/user/", :schema=>[[:password, :password, 5, nil], ["text", :description, 4, nil]], :name=>"user"}, []]
+

data/rdoc/plugins.rdoc

@@ -0,0 +1,35 @@
+
+== The Plugins System
+
+Marley activates both of them for Sequel::Model.  This will soon change to an option.
+
+:include: rdoc/hello.rb
+
+:include: rdoc/example_plugin.rb
+
+    setup
+        @client=Marley::TestClient.new(:resource_name => 'hello')
+        @plugin=Marley.plugin('example_plugin')
+    end
+example: without the plugin, then with the plugin
+
+    >> MR.constants
+    => ["Hello"]
+    >> @client.read
+    => "\"Hello World!\""
+    >> @client.create({}, :code => 404)
+    => [:error, {:description=>"Not Found", :error_type=>"routing", :error_details=>nil}]
+
+    >> @plugin.apply('Hello')
+    => nil
+    >> @client.create({})
+    => " world"
+    >> @client.create({},:method => 'howdy')
+    => "howdy world"
+
+== Included Plugins
+
+Marley comes with 1 external plugin (there are others in the included Joints, described later):
+
+:include: rdoc/orm_rest_convenience_plugin.rdoc
+

data/rdoc/reggae.rb

@@ -0,0 +1,3 @@
+require 'marley/utils.rb'
+require 'marley/reggae.rb'
+

data/rdoc/reggae.rdoc

@@ -0,0 +1,11 @@
+==Reggae
+
+The server and client use a JSON based data representation format "Reggae."  Reggae.ebnf describes the format in canonical form, and reggae.rb contains a Reggae parser and generator.  
+
+The Reggae class generates and parses Reggae JSON arrays.  See reggae.ebnf for the syntax
+
+setup
+ @reggae=Marley::Reggae
+end
+
+

data/rdoc/reggae/generate.rdoc

@@ -0,0 +1,13 @@
+
+===Reggae Generator
+
+examples:  generate an instance
+
+  >> @instance=Marley::ReggaeInstance.new({:name => 'foo',:schema => []})
+  => [:instance, {:schema=>[], :name=>"foo"}, []]
+
+  >> @link=Marley::ReggaeLink.new({:url => '/', :title => 'asdf'})
+  => [:link, {:url=>"/", :title=>"asdf"}, []]
+  >> @link.update(:url => '/asdf/')
+  => [:link, {:url=>"/asdf/", :title=>"asdf"}, []]
+

data/rdoc/reggae/parse.rdoc

@@ -0,0 +1,44 @@
+
+===Reggae Parser
+
+examples: leave non-Reggae arrays as is
+
+    >> Marley::Reggae.new([])
+    => []
+    >> Marley::Reggae.new(['asdf','ssss'])
+    => ["asdf", "ssss"]
+    >> Marley::Reggae.new(['asdf','ssss']).class
+    => Marley::Reggae
+    >> Marley::Reggae.new(['asdf',{}]).to_resource
+    => ["asdf", {}]
+    >> Marley::Reggae.new(['asdf',{}]).to_resource.class
+    => Marley::Reggae
+
+examples: a simple Reggae Resource
+
+    >> Marley::Reggae.new(['resource',{}]).to_resource.class
+    => Marley::ReggaeResource
+
+    This also works:
+
+    >> Marley::Reggae.get_resource(['resource',{}]).class
+    => Marley::ReggaeResource
+
+examples: parse a ReggaeSection
+
+    >> @section=Marley::Reggae.new([:section, {}]).to_resource
+    => [:section, {}]
+    >> @section.properties
+    => {}
+
+examples: parse a ReggaeSection with a title
+
+    >> @section=Marley::Reggae.new([:section, {:title => 'asdf'}]).to_resource
+    => [:section, {:title=>"asdf"}]
+    >> @section.title
+    => "asdf"
+    >> @section.properties
+    => {:title=>"asdf"}
+
+
+

data/rdoc/section_joint.rb

@@ -0,0 +1,13 @@
+
+require 'messages_joint.rb'
+
+Marley.joint('section')
+Marley.plugin('section').apply(MR.constants)
+
+module Marley
+  module Resources
+    def User.section_link
+      super.update(:title => 'Account',:url => current_user.url)
+    end
+  end
+end

data/rdoc/section_joint.rdoc

@@ -0,0 +1,19 @@
+== The Section Joint
+
+  setup
+    @client=Marley::TestClient.new
+    DB[:users].delete
+    DB[:messages].delete
+    DB[:messages_users].delete
+    DB[:SQLITE_SEQUENCE].update(:seq => 0)
+    user_client=Marley::TestClient.new(:resource_name => 'user')
+    user=user_client.read({},:method => 'new').set_values(:password => 'asdfasdf', :confirm_password => 'asdfasdf')
+    (1 .. 5).each { |i|
+      user_client.create(user.set_values(:name => "user#{i}"))
+      instance_variable_set(:"@client#{i}", Marley::TestClient.new(:auth => ["user#{i}",'asdfasdf'] ))
+    }
+  end
+
+
+examples: 
+