marley 0.5.0 → 0.6.0

data/rdoc/tags_joint.rb

@@ -0,0 +1,16 @@
+require 'user_joint.rb'
+
+DB.create_table :tags do
+  primary_key :id
+  integer :user_id
+  text :tag
+end
+DB.create_table :messages_tags do
+  primary_key :id
+  integer :tag_id
+  integer :message_id
+end
+Marley.joint('tags')
+Marley.plugin(:tagging,{:tag_type => 'private'}).apply('Secret')
+Marley.plugin(:tagging,{:tag_type => 'private'}).apply('Announcement')
+Marley.plugin(:tagging,{:tag_type => 'public'}).apply('Announcement')

data/rdoc/tags_joint.rdoc

@@ -0,0 +1,22 @@
+
+== The Tags Joint
+
+  setup
+      DB[:users].delete
+      DB[:messages].delete
+      DB[:messages_tags].delete
+      DB[:tags].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,2,3].each { |i|
+        user_client.create(user.set_values(:name => "user#{i}"))
+      }
+      @user1_auth=['user1', 'asdfasdf']
+      @user2_auth=['user2', 'asdfasdf']
+      @user3_auth=['user3', 'asdfasdf']
+  end
+
+example:
+
+

data/rdoc/tags_joint/announcements.rdoc

@@ -0,0 +1,64 @@
+
+
+=== Announcements
+
+setup
+  @client1=Marley::TestClient.new(:resource_name => 'announcement', :auth => @user1_auth)
+  @client2=Marley::TestClient.new(:resource_name => 'announcement', :auth => @user2_auth)
+end
+
+
+examples: announcements with private and public tags
+
+>> @announcement1=@client1.read({},{:method => 'new'})
+=> [:instance, {:schema=>[["integer", :user_id, 3, 1], ["text", :name, 4, nil], ["text", :message, 0, nil], ["text", :_private_tags, 0, nil], ["text", :_public_tags, 0, nil]], :url=>"/announcement/", :new_rec=>true, :actions=>nil, :name=>"announcement"}, []]
+
+>> @client1.create(@announcement1.set_values({:name => 'user1 ann1', :message => 'user1ann1 msg', :_private_tags => 'aaa,bbb',:_public_tags => 'ppp'}), :url => @announcement1.url)
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "aaa, bbb"], ["text", :_public_tags, 0, "ppp"]], :url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :name=>"announcement"}, []]
+>> @client1.read
+=> [[:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "aaa, bbb"], ["text", :_public_tags, 0, "ppp"]], :url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :name=>"announcement"}, []]]
+
+>> @client2.read
+=> [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 ann1"], ["text", :message, 2, "user1ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "ppp"]], :name=>"announcement"}, []]]
+
+>> @announcement2=@client2.read({},{:method => 'new'})
+=> [:instance, {:url=>"/announcement/", :new_rec=>true, :actions=>nil, :schema=>[["integer", :user_id, 3, 2], ["text", :name, 4, nil], ["text", :message, 0, nil], ["text", :_private_tags, 0, nil], ["text", :_public_tags, 0, nil]], :name=>"announcement"}, []]
+>> @client1.create(@announcement.set_values({:name => 'user1 ann1', :message => 'user1ann1 msg', :_private_tags => 'aaa,bbb',:_public_tags => 'ppp'}), :url => @announcement.url)
+>> @client2.create(@announcement2.set_values({:name => 'user2 ann1', :message => 'user2ann1 msg', :_private_tags => 'xxx',:_public_tags => 'yyy,zzz'}), :url => @announcement2.url)
+=> [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>{:delete=>"/announcement/2"}, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 ann1"], ["text", :message, 0, "user2ann1 msg"], ["text", :_private_tags, 0, "xxx"], ["text", :_public_tags, 0, "yyy, zzz"]], :name=>"announcement"}, []]
+
+>> @client1.read
+=> [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "aaa, bbb"], ["text", :_public_tags, 0, "ppp"]], :name=>"announcement"}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 6, "user2 ann1"], ["text", :message, 2, "user2ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "yyy, zzz"]], :name=>"announcement"}, []]]
+>> @client2.read
+=> [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 ann1"], ["text", :message, 2, "user1ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "ppp"]], :name=>"announcement"}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>{:delete=>"/announcement/2"}, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 ann1"], ["text", :message, 0, "user2ann1 msg"], ["text", :_private_tags, 0, "xxx"], ["text", :_public_tags, 0, "yyy, zzz"]], :name=>"announcement"}, []]]
+
+>> @ann1client1=@client1.read({},:instance_id => 1)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "aaa, bbb"], ["text", :_public_tags, 0, "ppp"]], :name=>"announcement"}, []]
+ :_public_tags, 0, "ppp"]], :name=>"announcement"}, []]
+
+>> @ann1client2=@client2.read({},:instance_id => 1)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 ann1"], ["text", :message, 2, "user1ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "ppp"]], :name=>"announcement"}, []]
+
+>> @ann2client1=@client1.read({},:instance_id => 2)
+=> [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 6, "user2 ann1"], ["text", :message, 2, "user2ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "yyy, zzz"]], :name=>"announcement"}, []]
+
+>> @ann2client2=@client2.read({},:instance_id => 2)
+=> [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>{:delete=>"/announcement/2"}, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 ann1"], ["text", :message, 0, "user2ann1 msg"], ["text", :_private_tags, 0, "xxx"], ["text", :_public_tags, 0, "yyy, zzz"]], :name=>"announcement"}, []]
+
+
+>> @client1.update(@ann1client1.set_values(:_public_tags => 'uuu'), :url => @ann1client1.url)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "aaa, bbb"], ["text", :_public_tags, 0, "uuu"]], :name=>"announcement"}, []]
+
+>> @client2.read({},:instance_id => 1)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 ann1"], ["text", :message, 2, "user1ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "uuu"]], :name=>"announcement"}, []]
+>> @client1.update(@ann1client1.set_values(:_private_tags => 'u,v,w'), :url => @ann1client1.url)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "u, v, w"], ["text", :_public_tags, 0, "uuu"]], :name=>"announcement"}, []]
+>> @client2.read({},:instance_id => 1)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 ann1"], ["text", :message, 2, "user1ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "uuu"]], :name=>"announcement"}, []]
+>> @client2.update(@ann1client2.set_values(:_public_tags => 'ddd',:_private_tags => 'ee,www,rr'),:url => @ann1client2.url)
+=> [:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 ann1"], ["text", :message, 2, "user1ann1 msg"], ["text", :_private_tags, 0, "ee, www, rr"], ["text", :_public_tags, 0, "ddd"]], :name=>"announcement"}, []]
+
+>> @client1.read
+=> [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 ann1"], ["text", :message, 0, "user1ann1 msg"], ["text", :_private_tags, 0, "u, v, w"], ["text", :_public_tags, 0, "ddd"]], :name=>"announcement"}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 6, "user2 ann1"], ["text", :message, 2, "user2ann1 msg"], ["text", :_private_tags, 0, ""], ["text", :_public_tags, 0, "yyy, zzz"]], :name=>"announcement"}, []]]
+
+

data/rdoc/tags_joint/secrets.rdoc

@@ -0,0 +1,65 @@
+
+=== Secrets
+
+setup
+  @client=Marley::TestClient.new(:resource_name => 'secret')
+end
+
+
+examples:
+
+>> @client.auth=@user1_auth
+=> ["user1", "asdfasdf"]
+>> @secret=@client.read({}, :method => 'new')
+=> [:instance, {:schema=>[["integer", :user_id, 3, 1], ["text", :name, 4, nil], ["text", :message, 0, nil], ["text", :_private_tags, 0, nil]], :url=>"/secret/", :new_rec=>true, :actions=>nil, :name=>"secret"}, []]
+
+>> @client.create(@secret.set_values(:name => 'user1 secret1', :_private_tags => 'xxxxxx,sss'))
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 secret1"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "xxxxxx, sss"]], :url=>"/secret/1", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> @secret=@client.read[0]
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 secret1"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "xxxxxx, sss"]], :url=>"/secret/1", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> @client.update(@secret.set_values(:_private_tags => "#{@secret.col_value(:_private_tags)},zzz,aaa"), :url => @secret.url)
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 secret1"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "xxxxxx, sss, zzz, aaa"]], :url=>"/secret/1", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+>> @secret=@client.read[0]
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 secret1"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "xxxxxx, sss, zzz, aaa"]], :url=>"/secret/1", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> @client.update(@secret.set_values(:_private_tags => "foo"), :url => @secret.url)
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 secret1"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "foo"]], :url=>"/secret/1", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+>> @secret=@client.read[0]
+=> [:instance, {:schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 secret1"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "foo"]], :url=>"/secret/1", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> DB[:tags].all
+=> [{:tag=>"xxxxxx", :id=>1, :user_id=>1}, {:tag=>"sss", :id=>2, :user_id=>1}, {:tag=>"sss", :id=>3, :user_id=>1}, {:tag=>"zzz", :id=>4, :user_id=>1}, {:tag=>"aaa", :id=>5, :user_id=>1}, {:tag=>"foo", :id=>6, :user_id=>1}]
+>> DB[:messages_tags].all
+=> [{:tag_id=>6, :message_id=>1, :id=>7}]
+
+
+
+>> @client.auth=@user2_auth
+=> ["user2", "asdfasdf"]
+>> @client.read
+=> []
+
+>> @secret=@client.read({}, :method => 'new')
+=> [:instance, {:schema=>[["integer", :user_id, 3, 2], ["text", :name, 4, nil], ["text", :message, 0, nil], ["text", :_private_tags, 0, nil]], :url=>"/secret/", :new_rec=>true, :actions=>nil, :name=>"secret"}, []]
+
+>> @client.create(@secret.set_values(:name => 'user2 secret', :_private_tags => 'foo,bar'))
+=> [:instance, {:schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 secret"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "foo, bar"]], :url=>"/secret/2", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> @secret=@client.read[0]
+=> [:instance, {:schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 secret"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "foo, bar"]], :url=>"/secret/2", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+>> @client.update(@secret.set_values(:_private_tags => "#{@secret.col_value(:_private_tags)},baz,bat"), :url => @secret.url)
+=> [:instance, {:schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 secret"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "foo, bar, baz, bat"]], :url=>"/secret/2", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> @secret=@client.read[0]
+=> [:instance, {:schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 secret"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "foo, bar, baz, bat"]], :url=>"/secret/2", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+>> @client.update(@secret.set_values(:_private_tags => "boo"), :url => @secret.url)
+=> [:instance, {:schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 secret"], ["text", :message, 0, nil], ["text", :_private_tags, 0, "boo"]], :url=>"/secret/2", :new_rec=>false, :actions=>nil, :name=>"secret"}, []]
+
+>> DB[:tags].all
+=> [{:tag=>"xxxxxx", :id=>1, :user_id=>1}, {:tag=>"sss", :id=>2, :user_id=>1}, {:tag=>"sss", :id=>3, :user_id=>1}, {:tag=>"zzz", :id=>4, :user_id=>1}, {:tag=>"aaa", :id=>5, :user_id=>1}, {:tag=>"foo", :id=>6, :user_id=>1}, {:tag=>"foo", :id=>7, :user_id=>2}, {:tag=>"bar", :id=>8, :user_id=>2}, {:tag=>"bar", :id=>9, :user_id=>2}, {:tag=>"baz", :id=>10, :user_id=>2}, {:tag=>"bat", :id=>11, :user_id=>2}, {:tag=>"boo", :id=>12, :user_id=>2}]
+>> DB[:messages_tags].all
+=> [{:tag_id=>6, :message_id=>1, :id=>7}, {:tag_id=>12, :message_id=>2, :id=>14}]
+
+

data/rdoc/user_joint.rb

@@ -0,0 +1,62 @@
+
+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
+  text :email
+  date :birthday
+  datetime :date_created
+  text :description
+end
+DB.create_table :messages do
+  primary_key :id
+  integer :user_id, :index => true
+  text :message_type, :index => true
+  text :name,  :index => true,:null => false
+  text :message
+end
+
+Marley.plugin('orm_rest_convenience').apply(Sequel::Model)
+Marley.joint 'user'
+Marley.plugin('current_user_methods').apply(Sequel::Model)
+
+module Marley
+  module Resources
+    class Admin < User
+      def self.requires_user?; true;end
+    end
+    class Message < Sequel::Model
+      def validate
+        super
+        validates_presence [:name]
+      end
+    end
+    class Secret < Message
+      User.join_to(self)
+      def self.list_dataset
+        current_user_ds
+      end
+    end
+    class Announcement < Message
+      ro_cols![:current_user_role]={'reader' => [/.*/]}
+      def current_user_role
+        super || 'reader' unless User.current_user.new?
+      end
+      def actions(parent_instance=nil)
+        if current_user_role=='owner' && ! self.new?
+          {:delete => self.url}.update(super ? super : {})
+        else
+          super
+        end
+      end
+    end
+  end
+end
+

data/rdoc/user_joint.rdoc

@@ -0,0 +1,13 @@
+
+== The User Joint
+
+  setup
+    MR::User.delete
+    MR::Message.delete
+    DB[:SQLITE_SEQUENCE].delete  #kinda hate this but it seems necessary for the moment
+    @client=Marley::TestClient.new(:resource_name => 'user')
+    @user=@client.read({},:method => 'new')
+  end
+
+examples:
+

data/rdoc/user_joint/exiting_users.rdoc

@@ -0,0 +1,120 @@
+
+  setup
+    @client.create(@user.set_values(:name => 'user1', :password => 'asdfasdf',:confirm_password => 'asdfasdf'))
+    @client.create(@user.set_values(:name => 'user2', :password => 'asdfasdf',:confirm_password => 'asdfasdf'))
+    @user1_auth=['user1', 'asdfasdf']
+    @user2_auth=['user2', 'asdfasdf']
+  end
+
+examples: 2 users exist
+  >> MR::User.count
+  => 2
+
+example: user1 logged in
+  >> @client.auth=@user1_auth
+  => ["user1", "asdfasdf"]
+
+# Note:  Date hack, defined in test_helper.rb is causing the strings to appear in the date_created/updated fields
+
+  >> @client.read
+  => [[:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, nil], [:password, :password, 0, nil], [:password, :confirm_password, 0, nil]], :name=>"user", :url=>"/user/1"}, []], [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 2], ["text", :name, 2, "user2"], ["text", :email, 2, nil], ["date", :birthday, 2, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 2, nil]], :name=>"user", :url=>"/user/2"}, []]]
+
+  >> @client.instance_id=1
+  => 1
+  >> @user1=@client.read
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, nil], [:password, :password, 0, nil], [:password, :confirm_password, 0, nil]], :name=>"user", :url=>"/user/1"}, []]
+  >> @client.update(@user1)
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, nil], [:password, :password, 0, nil], [:password, :confirm_password, 0, nil]], :name=>"user", :url=>"/user/1"}, []]
+
+  >> @user1=@client.read
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, nil], [:password, :password, 0, nil], [:password, :confirm_password, 0, nil]], :name=>"user", :url=>"/user/1"}, []]
+  >> @client.update(@user1)
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, nil], [:password, :password, 0, nil], [:password, :confirm_password, 0, nil]], :name=>"user", :url=>"/user/1"}, []]
+  >> @user1.col_value(:password, 'zxcvzxcv')
+  => "zxcvzxcv"
+  >> @client.update(@user1,{:code => 400})
+  => [:error, {:error_type=>"validation", :error_details=>{:old_password=>["Old Password Incorrect"], :confirm_password=>["Passwords do not match"]}, :description=>nil}]
+  >> @user1.set_values(:confirm_password => 'zxcvzxcv',:old_password => 'asdfasdf')
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, "asdfasdf"], [:password, :password, 0, "zxcvzxcv"], [:password, :confirm_password, 0, "zxcvzxcv"]], :name=>"user", :url=>"/user/1"}, []]
+  >> @client.update(@user1)
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 2, "user1"], ["text", :email, 2, nil], ["date", :birthday, 2, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 2, nil]], :name=>"user", :url=>"/user/1"}, []]
+  >> @client.read({},:code => 401)
+  => [:error, {:error_type=>"authentication", :error_details=>nil, :description=>nil}]
+  >> @client.read({},:auth => ['user1', 'zxcvzxcv'])
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["text", :name, 0, "user1"], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["datetime", :date_created, 2, "date_created"], ["text", :description, 0, nil], [:password, :old_password, 0, nil], [:password, :password, 0, nil], [:password, :confirm_password, 0, nil]], :name=>"user", :url=>"/user/1"}, []]
+
+example:  user1 reading/writing secrets
+
+  >> @client.auth=@user1_auth
+  => ["user1", "asdfasdf"]
+  >> @client.resource_name='secret'
+  => "secret"
+
+  >> @client.read
+  => []
+  >>  @secret=@client.read({}, {:method => 'new'})
+  => [:instance, {:new_rec=>true, :actions=>nil, :schema=>[["integer", :user_id, 3, 1], ["text", :name, 4, nil], ["text", :message, 0, nil]], :name=>"secret", :url=>"/secret/"}, []]
+
+  >> @client.create(@secret, {:code => 400})
+  => [:error, {:error_type=>"validation", :error_details=>{:name=>["is required"]}, :description=>nil}]
+  >> @client.create(@secret.set_values(:name => 'this is my secret'))
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "this is my secret"], ["text", :message, 0, nil]], :name=>"secret", :url=>"/secret/1"}, []]
+  >> @client.read
+  => [[:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "this is my secret"], ["text", :message, 0, nil]], :name=>"secret", :url=>"/secret/1"}, []]]
+  >> @client.read({},:auth => @user2_auth)
+  => []
+  >> @client.read({},:auth => @user2_auth,:instance_id => 1, :code => 403)
+  => [:error, {:error_type=>"authorization", :error_details=>nil, :description=>"You are not authorized for this operation"}]
+
+example: user2 reading/writing secrets
+  >> @client.auth=@user2_auth
+  => ["user2", "asdfasdf"]
+  >> @client.resource_name='secret'
+  => "secret"
+  >> @client.read
+  => []
+  >> @secret=@client.read({}, {:method => 'new'})
+  => [:instance, {:new_rec=>true, :actions=>nil, :schema=>[["integer", :user_id, 3, 2], ["text", :name, 4, nil], ["text", :message, 0, nil]], :name=>"secret", :url=>"/secret/"}, []]
+  >> @client.create(@secret.set_values(:name => 'user2 my secret'))
+  => [:instance, {:new_rec=>false, :actions=>nil, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 my secret"], ["text", :message, 0, nil]], :name=>"secret", :url=>"/secret/1"}, []]
+
+  >> @client.read({}, :auth => @user1_auth)
+  => []
+  >> @client.read({}, :auth => @user1_auth, :instance_id => 1,:code => 403)
+  => [:error, {:error_type=>"authorization", :error_details=>nil, :description=>"You are not authorized for this operation"}]
+
+examples:  announcements
+  >> @client.auth=@user1_auth
+  => ["user1", "asdfasdf"]
+  >> @client.resource_name='announcement'
+  => "announcement"
+  >> @client.read
+  => []
+
+  >> @announcement=@client.read({},{:method => 'new'})
+  => [:instance, {:new_rec=>true, :actions=>nil, :schema=>[["integer", :user_id, 3, 1], ["text", :name, 4, nil], ["text", :message, 0, nil]], :name=>"announcement", :url=>"/announcement/"}, []]
+  >> @client.create(@announcement.set_values({:name => 'user1 announcement'}))
+  => [:instance, {:new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement"], ["text", :message, 0, nil]], :name=>"announcement", :url=>"/announcement/1"}, []]
+  >> @client.read
+  => [[:instance, {:new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement"], ["text", :message, 0, nil]], :name=>"announcement", :url=>"/announcement/1"}, []]]
+  >> @client.create(@announcement.set_values({:name => 'user1 announcement2'}))
+  => [:instance, {:new_rec=>false, :actions=>{:delete=>"/announcement/2"}, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement2"], ["text", :message, 0, nil]], :name=>"announcement", :url=>"/announcement/2"}, []]
+  >> @client.read
+  => [[:instance, {:new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement"], ["text", :message, 0, nil]], :name=>"announcement", :url=>"/announcement/1"}, []], [:instance, {:new_rec=>false, :actions=>{:delete=>"/announcement/2"}, :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement2"], ["text", :message, 0, nil]], :name=>"announcement", :url=>"/announcement/2"}, []]]
+
+  >>  @client.auth=@user2_auth
+  => ["user2", "asdfasdf"]
+  >> @client.read
+  => [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 announcement"], ["text", :message, 2, nil]]}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 announcement2"], ["text", :message, 2, nil]]}, []]]
+
+  >> @client.read
+  => [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 announcement"], ["text", :message, 2, nil]]}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 announcement2"], ["text", :message, 2, nil]]}, []]]
+  >> @announcement=@client.read({},{:method => 'new'})
+  => [:instance, {:url=>"/announcement/", :new_rec=>true, :actions=>nil, :name=>"announcement", :schema=>[["integer", :user_id, 3, 2], ["text", :name, 4, nil], ["text", :message, 0, nil]]}, []]
+  >> @client.create(@announcement.set_values({:name => 'user2 announcement'}))
+  => [:instance, {:url=>"/announcement/3", :new_rec=>false, :actions=>{:delete=>"/announcement/3"}, :name=>"announcement", :schema=>[["integer", :id, 2, 3], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 announcement"], ["text", :message, 0, nil]]}, []]
+  >> @client.read
+  => [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 announcement"], ["text", :message, 2, nil]]}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :name, 6, "user1 announcement2"], ["text", :message, 2, nil]]}, []], [:instance, {:url=>"/announcement/3", :new_rec=>false, :actions=>{:delete=>"/announcement/3"}, :name=>"announcement", :schema=>[["integer", :id, 2, 3], ["integer", :user_id, 3, 2], ["text", :name, 4, "user2 announcement"], ["text", :message, 0, nil]]}, []]]
+  >> @client.read({}, :auth => @user1_auth)
+  => [[:instance, {:url=>"/announcement/1", :new_rec=>false, :actions=>{:delete=>"/announcement/1"}, :name=>"announcement", :schema=>[["integer", :id, 2, 1], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement"], ["text", :message, 0, nil]]}, []], [:instance, {:url=>"/announcement/2", :new_rec=>false, :actions=>{:delete=>"/announcement/2"}, :name=>"announcement", :schema=>[["integer", :id, 2, 2], ["integer", :user_id, 3, 1], ["text", :name, 4, "user1 announcement2"], ["text", :message, 0, nil]]}, []], [:instance, {:url=>"/announcement/3", :new_rec=>false, :actions=>nil, :name=>"announcement", :schema=>[["integer", :id, 2, 3], ["integer", :user_id, 3, 2], ["text", :name, 6, "user2 announcement"], ["text", :message, 2, nil]]}, []]]
+

data/rdoc/user_joint/no_auth_provided.rdoc

@@ -0,0 +1,34 @@
+
+example: read new user form but not user list
+  >> @client.read({},:code => 401)
+  => [:error, {:error_type=>"authentication", :error_details=>nil, :description=>nil}]
+  >> @client.read({},:method => 'new')
+  => [:instance, {:new_rec=>true, :actions=>nil, :schema=>[["text", :name, 0, nil], ["text", :email, 0, nil], ["date", :birthday, 0, nil], ["text", :description, 0, nil], [:password, :password, 4, nil], [:password, :confirm_password, 4, nil]], :name=>"user", :url=>"/user/"}, []]
+
+
+example:  user validation
+  >> @client.create({}, :code => 400)
+  => [:error, {:error_type=>"validation", :error_details=>{:name=>["is required"], :password=>["Password must contain at least 8 characters"]}, :description=>nil}]
+  >> @client.create(@user.set_values(:name => 'asdf', :password => 'asdfasdf',:confirm_password => 'asdfasdf'))
+  => [:msg, {:title=>"Success!"}, "Your login, 'asdf', has been sucessfully created. You can now log in."]
+
+
+example:  cannot list any other resources
+  >> @client.read({},{:resource_name => 'secrets',:code => 401})
+  => [:error, {:error_type=>"authentication", :error_details=>nil, :description=>nil}]
+  >> @client.read({},{:resource_name => 'announcements',:code => 401})
+  => [:error, {:error_type=>"authentication", :error_details=>nil, :description=>nil}]
+
+example:  non-existent resource yields 401, not 404
+  >> @client.read({},{:resource_name => 'xxx',:code => 401})
+  => [:error, {:error_type=>"authentication", :error_details=>nil, :description=>nil}]
+
+example: unable to create admin user
+  >> @client.create(@user.set_values(:name => 'admin',:password => 'asdfasdf',:confirm_password => 'asdfasdf'),:resource_name => 'admin', :code=> 401)
+  => [:error, {:error_type=>"authentication", :error_details=>nil, :description=>nil}]
+
+  >> @client.create(@user.set_values(:name => 'admin',:password => 'asdfasdf',:confirm_password => 'asdfasdf').to_params.update("user[user_type]" => 'Admin'),:code => 403)
+  => [:error, {:error_type=>"authorization", :error_details=>nil, :description=>"You are not authorized for this operation"}]
+
+
+

data/reggae.ebnf

@@ -11,7 +11,7 @@ property ::= section_property | link_property |  instance_property |instance_lis
 
 value ::= title_value | description_value | navigation_value | name_value | new_rec_value | search_value | schema_value | get_actions_value | delete_action_value | items_value | col_value | error_type_value | error_details_value | 
 
-section_property ::= 'title' | 'description' | 'navigation'
+section_property ::= 'name' | 'title' | 'description' | 'navigation'
 
 link_property ::= 'title' | 'description' | 'url'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marley
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Herb Daily
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-01 00:00:00 -03:00
+date: 2012-02-22 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,9 +50,9 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.12.1
+        version: 0.13.4
     version: 
-description: "Marley implements a web services framework on top of Rack and Sequel on the server side and Jquery on the client side.  "
+description: "Marley is a framework for quickly building RESTful web services and applications.  Development is fast because Marley implements lots of sensible defaults, all of which can be overridden and most of which can be overridden easily. "
 email: herb.daily@safe-mail.net
 executables: []
 
@@ -61,46 +61,54 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- marley.gemspec
-- Rakefile
-- Favicon.ico
 - README.rdoc
-- TODO
 - reggae.ebnf
-- marley-0.4.0.gem
 - lib/marley.rb
+- lib/marley/core_ext.rb
 - lib/marley/test_helpers.rb
+- lib/marley/plugin.rb
+- lib/marley/resources.rb
+- lib/marley/router.rb
+- lib/marley/joints/forum.rb
+- lib/marley/joints/messages.rb
+- lib/marley/joints/section.rb
+- lib/marley/joints/user.rb
+- lib/marley/joints/tags.rb
 - lib/marley/utils.rb
 - lib/marley/joint.rb
+- lib/marley/plugins/orm_rest_convenience.rb
+- lib/marley/plugins/rest_convenience.rb
 - lib/marley/controllers.rb
+- lib/marley/errors.rb
 - lib/marley/reggae.rb
-- lib/sequel/plugins/rest_convenience.rb
-- lib/sequel/plugins/rest_auth.rb
-- lib/client/jamaica.css
-- lib/client/jquery-1.6.2.js
-- lib/client/jamaica.rb
-- lib/client/jamaica.js
-- lib/client/jquery.form.js
-- lib/joints/basic_messaging.rb
-- lib/joints/basic_user.rb
-- lib/joints/tagging.rb
-- lib/joints/basic_menu_system.rb
-- lib/joints/tagged_messaging.rb
-- examples/forum.js
-- examples/forum.sql
-- examples/blog.rb
-- examples/forum.rb
-- examples/forum.sqlite3
-- examples/forum_test.sqlite3
-- examples/empty.sqlite3
-- examples/forum.css
-- examples/run.sh
-- test/menu_tests.rb
-- test/test_include.rb
-- test/empty.sqlite3
-- test/user_tests.rb
-- test/test.sqlite3
-- test/tagged_messaging_tests.rb
+- rdoc/orm_rest_convenience_plugin.rb
+- rdoc/section_joint.rb
+- rdoc/forum_joint.rb
+- rdoc/tags_joint.rdoc
+- rdoc/user_joint/no_auth_provided.rdoc
+- rdoc/user_joint/exiting_users.rdoc
+- rdoc/messages_joint.rb
+- rdoc/messages_joint.rdoc
+- rdoc/hello.rb
+- rdoc/section_joint.rdoc
+- rdoc/user_joint.rdoc
+- rdoc/example_plugin.rb
+- rdoc/plugins.rdoc
+- rdoc/example_joint.rb
+- rdoc/messages_joint/private_messages.rdoc
+- rdoc/messages_joint/public_messages.rdoc
+- rdoc/forum_joint.rdoc
+- rdoc/orm_rest_convenience_plugin.rdoc
+- rdoc/reggae/generate.rdoc
+- rdoc/reggae/parse.rdoc
+- rdoc/user_joint.rb
+- rdoc/joints.rdoc
+- rdoc/hello.rdoc
+- rdoc/tags_joint.rb
+- rdoc/tags_joint/announcements.rdoc
+- rdoc/tags_joint/secrets.rdoc
+- rdoc/reggae.rb
+- rdoc/reggae.rdoc
 has_rdoc: true
 homepage: http://github.com/herbdaily/marley
 licenses: []
@@ -128,6 +136,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Irie default restful routes for your models and other objects
+summary: Irie default restful routes for models and other objects
 test_files: []