riakrest 0.0.4 → 0.1.0

data/History.txt

@@ -1,34 +1,33 @@
+=== 0.1.0 2009-11-16
+  - Renamed data/JiakDataHash to core/JiakDataFields and reworked.
+  - Move JiakDataHash functionality into JiakData as default implementation
+    - Like Resource, JiakData has jattr_* to manage data inside out.
+  - Resource encapsulates its data.
+    - jattr_* methods add data fields and implicitly maintain schema.
+    - Removed class methods for schema manipulation.
+  - Incrementally add fields data.
+  - Incrementally add fields to schemas.
+
 === 0.0.4 2009-11-10
- * Mods
-   * Fixed bug when running ruby 1.8
-   * Changed client_store option for returning object to :return => :object
-   * Added check to eql? and == that both objects are either local or not.
-   * Refactored local? method to jiak_object.
+  - Fixed bug when running ruby 1.8
+  - Changed client_store option for returning object to :return => :object
+  - Added check to eql? and == that both objects are either local or not.
+  - Refactored local? method to jiak_object.
 
 === 0.0.3 2009-11-03
-
-* Mods:
-   * Switched to jeweler for managing gem
-   * Allow passing an array for specifying schema fields/masks
-   * Added convenience accessors to rsrc.jiak
-   * Allow setting proxy on core client
-
-  Clean-up:
-   * More examples futzing.
+  - Switched to jeweler for managing gem
+  - Allow passing an array for specifying schema fields/masks
+  - Added convenience accessors to rsrc.jiak
+  - Allow setting proxy on core client
+  - More examples futzing.
 
 === 0.0.2 2009-10-30
-
-* Mods:
-   * Fixed corner case for auto_post false / auto_update true.
-   * Explicitly reserve jiak field in user data classes.
-   * Changed walk to query. Kept walk as an alias.
-
-* Clean-up:
-   * DRY'd some code
-   * Examples
+  - Fixed corner case for auto_post false / auto_update true.
+  - Explicitly reserve jiak field in user data classes.
+  - Changed walk to query. Kept walk as an alias.
+  - DRY'd some code
+  - Examples
 
 
 === 0.0.1 2009-10-20
-
-* Initial release:
-   * To github, anyway. git log shows the prior activity.
+  - Initial release to github, anyway. git log shows the prior activity.

data/README.rdoc

@@ -10,10 +10,11 @@ store.
 == RIAK:
 
 Riak[http://riak.basho.com] is an open-source project developed and maintained
-by the fine folks at Basho[http://www.basho.com]. It combines a decentralized
-key-value store, a flexible map/reduce engine, and a friendly HTTP/JSON query
-interface to provide a database ideally suited for Web applications. RiakRest
-interacts with the HTTP/JSON query interface, which is called Jiak.
+by the fine folks at Basho[http://www.basho.com] Technologies. Riak combines a
+decentralized key-value store, a flexible map/reduce engine, and a friendly
+HTTP/JSON query interface to provide a database ideally suited for Web
+applications. RiakRest interacts with the HTTP/JSON query interface, which is
+called Jiak.
 
 == SYNOPSIS:
 
@@ -25,7 +26,7 @@ of the Core Client that gives a true RESTful feel.
 
 == REQUIREMENTS:
 
-RestClient is used for REST server interaction
+RestClient is used for REST server interaction.
 
 JSON is used for data exchange.
 
@@ -40,32 +41,21 @@ sudo gem install riakrest
   require 'riakrest'
   include RiakRest
 
-  PersonData = JiakDataHash.create(:name,:age)
-  PersonData.keygen :name
-
-  class Person
+  class People
     include JiakResource
-    server      'http://localhost:8002/jiak'
-    group       'people'
-    data_class  PersonData
-    auto_post   true
-    auto_update true
+    server 'http://localhost:8002/jiak'
+    jattr_accessor :name, :age
+    auto_manage
   end
 
-  remy = Person.new(:name => 'remy',:age => 10) #            (auto-post)
-  puts remy.name                                # => "remy"
-
-  puts Person.get('remy').name                  # => "remy"  (from Jiak server)
-  puts Person.get('remy').age                   # => 10      (from Jiak server)
-
-  remy.age = 11                                 #            (auto-update)
-  puts Person.get('remy').age                   # => 11      (from Jiak server)
+  remy = People.new(:name => 'Remy',:age => 10)    # (auto-post)
+  remy.age = 11                                    # (auto-update)
 
-  callie = Person.new(:name => 'Callie', :age => 13)
-  remy.link(callie,'sister')                    # link from remy to callie
+  callie = People.new(:name => 'Callie', :age => 13)
+  remy.link(callie,'sister')
 
-  sisters = remy.query(Person,'sister')         # use link to get 'sister'
-  puts sisters[0].eql?(callie)                  # => true
+  sisters = remy.query(People,'sister')
+  puts sisters[0].eql?(callie)                     # => true
 
   remy.delete
   callie.delete

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/examples/auto_update_data.rb

@@ -1,43 +1,38 @@
 require 'riakrest'
 include RiakRest
 
-PersonData = JiakDataHash.create(:name,:age)
-PersonData.keygen :name
-
-class Person
+class People
   include JiakResource
-
-  server       'http://localhost:8002/jiak'
-  group        'people'
-  data_class   PersonData
-  auto_post    true
-  auto_update  true
+  server         'http://localhost:8002/jiak'
+  jattr_accessor :name, :age
+  keygen { name }
+  auto_manage
 end
 
-remy = Person.new(:name => 'remy', :age => 10)
-puts Person.get('remy').name                # => "remy"
+remy = People.new(:name => 'remy', :age => 10)
+puts People.get('remy').name                      # => "remy"
 
 remy.name = "Remy"
-puts Person.get('remy').name                # => "Remy"
+puts People.get('remy').name                      # => "Remy"
 remy.age = 12
-puts Person.get('remy').age                 # => 12
+puts People.get('remy').age                       # => 12
 
-Person.auto_update false
+People.auto_update false
 remy.auto_update = true
-puts Person.get('remy').age                 # => 12
+puts People.get('remy').age                       # => 12
 remy.age = 10
-puts Person.get('remy').age                 # => 10
+puts People.get('remy').age                       # => 10
 
-Person.auto_update true
+People.auto_update true
 remy.auto_update = false
 remy.age = 12
-puts Person.get('remy').age                 # => 10
+puts People.get('remy').age                       # => 10
 remy.update
-puts Person.get('remy').age                 # => 12
+puts People.get('remy').age                       # => 12
 
 remy.auto_update = nil
 remy.age = 10
-puts Person.get('remy').age                 # => 10
+puts People.get('remy').age                       # => 10
 
 remy.delete
 

data/examples/auto_update_links.rb

@@ -1,47 +1,43 @@
 require 'riakrest'
 include RiakRest
 
-PersonData = JiakDataHash.create(:name,:age)
-PersonData.keygen :name
-
-class Person
+class People
   include JiakResource
-
-  server       'http://localhost:8002/jiak'
-  group        'people'
-  data_class   PersonData
-  auto_post    true
+  server         'http://localhost:8002/jiak'
+  jattr_accessor :name, :age
+  keygen { name.downcase }
+  auto_post
 end
 
-remy = Person.new(:name => 'remy', :age => 10)
-callie = Person.new(:name => 'Callie', :age => 12)
+remy = People.new(:name => 'remy', :age => 10)
+callie = People.new(:name => 'Callie', :age => 12)
 
 remy.link(callie,'sister')
-puts remy.query(Person,'sister').size        # => 0
+puts remy.query(People,'sister').size              # => 0
 remy.update
-puts remy.query(Person,'sister').size        # => 1
+puts remy.query(People,'sister').size              # => 1
 remy.remove_link(callie,'sister')
 
-Person.auto_update true
+People.auto_update true
 remy.link(callie,'sibling')
-puts remy.query(Person,'sibling').size       # => 1
+puts remy.query(People,'sibling').size             # => 1
 remy.remove_link(callie,'sibling')
 
 callie.auto_update = false
 callie.link(remy,'sibling')
-puts callie.query(Person,'sibling').size     # => 0
+puts callie.query(People,'sibling').size           # => 0
 callie.update
-puts callie.query(Person,'sibling').size     # => 1
+puts callie.query(People,'sibling').size           # => 1
 callie.remove_link(remy,'sibling')
 
-Person.auto_update false
+People.auto_update false
 remy.auto_update = true
 callie.auto_update = nil
 remy.bi_link(callie,'sisters')
-puts remy.query(Person,'sisters').size       # => 1
-puts callie.query(Person,'sisters').size     # => 0
+puts remy.query(People,'sisters').size             # => 1
+puts callie.query(People,'sisters').size           # => 0
 callie.update
-puts callie.query(Person,'sisters').size     # => 1
+puts callie.query(People,'sisters').size           # => 1
 
 remy.delete
 callie.delete

data/examples/basic_client.rb

@@ -1,31 +1,35 @@
 require 'riakrest'
 include RiakRest
 
-Person = JiakDataHash.create(:name,:age)
+class PeopleData
+  include JiakData
+  jattr_accessor :name, :age
+end
 
 client = JiakClient.new("http://localhost:8002/jiak")
-bucket = JiakBucket.new('people',Person)
+bucket = JiakBucket.new('people',PeopleData)
 client.set_schema(bucket)
 
 remy = client.store(JiakObject.new(:bucket => bucket,
-                                    :data => Person.new(:name => "remy",
-                                                        :age => 10)),
-                     :return => :object)
+                                    :data => PeopleData.new(:name => "remy",
+                                                            :age => 10)),
+                    :return => :object)
 callie = client.store(JiakObject.new(:bucket => bucket,
-                                     :data => Person.new(:name => "Callie",
-                                                         :age => 12)),
+                                     :data => PeopleData.new(:name => "Callie",
+                                                             :age => 12)),
                       :return => :object)
 
-puts client.get(bucket,remy.key).data.name         # => "remy"
+puts client.get(bucket,remy.key).data.name                         # => "remy"
 
 remy.data.name = "Remy"
 remy << JiakLink.new(bucket,callie.key,'sister')
 client.store(remy)
 
-puts client.get(bucket,remy.key).data.name         # => "Remy"
+puts client.get(bucket,remy.key).data.name                         # => "Remy"
 
-sisters = client.walk(bucket,remy.key,QueryLink.new(bucket,'sister'),Person)
-puts sisters[0].eql?(callie)                       # => true
+sisters = client.walk(bucket,remy.key,
+                      QueryLink.new(bucket,'sister'),PeopleData)
+puts sisters[0].eql?(callie)                                       # => true
 
 client.delete(bucket,remy.key)
 client.delete(bucket,callie.key)

data/examples/basic_resource.rb

@@ -1,32 +1,28 @@
 require 'riakrest'
 include RiakRest
 
-PersonData = JiakDataHash.create(:name,:age)
-PersonData.keygen :name
-
-class Person
+class People
   include JiakResource
-  server      'http://localhost:8002/jiak'
-  group       'people'
-  data_class  PersonData
-  auto_post   true
-  auto_update true
+  server 'http://localhost:8002/jiak'
+  jattr_accessor :name, :age
+  keygen {name.downcase}
+  auto_manage
 end
 
-remy = Person.new(:name => 'Remy',:age => 10) #            (auto-post)
-puts remy.name                                # => "Remy"
+remy = People.new(:name => 'Remy',:age => 10)    #            (auto-post)
+puts remy.name                                   # => "Remy"
 
-puts Person.get('Remy').name                  # => "Remy"  (from Jiak server)
-puts Person.get('Remy').age                   # => 10      (from Jiak server)
+puts People.get('remy').name                     # => "Remy"  (from Jiak server)
+puts People.get('remy').age                      # => 10      (from Jiak server)
 
-remy.age = 11                                 #            (auto-update)
-puts Person.get('Remy').age                   # => 11      (from Jiak server)
+remy.age = 11                                    #            (auto-update)
+puts People.get('remy').age                      # => 11      (from Jiak server)
 
-callie = Person.new(:name => 'Callie', :age => 13)
+callie = People.new(:name => 'Callie', :age => 13)
 remy.link(callie,'sister')
 
-sisters = remy.query(Person,'sister')
-puts sisters[0].eql?(callie)                  # => true
+sisters = remy.query(People,'sister')
+puts sisters[0].eql?(callie)                     # => true
 
 remy.delete
 callie.delete

data/examples/bucket_schemas.rb

@@ -1,13 +1,14 @@
 require 'riakrest'
 include RiakRest
 
-DogData = JiakDataHash.create(:name,:age,:breeds)
+DogData = JiakDataFields.create(:name,:age,:breeds)
+DogData.keygen { name.downcase }
 
-# client = JiakClient.new("http://localhost:8002/jiak",:proxy=>"http://localhost:8888")
-client = JiakClient.new("http://localhost:8002/jiak")
+# client = JiakClient.new("http://localhost:8002/jiak")
+client = JiakClient.new("http://localhost:8002/jiak",
+                        :proxy=>"http://localhost:8888")
 bucket = JiakBucket.new("dogs", DogData)
 chili = JiakObject.new(:bucket => bucket,
-                       :key => 'chili',
                        :data => DogData.new(:name => "Chili",
                                             :age => 6,
                                             :breeds => ["heeler","akita"]))
@@ -15,22 +16,23 @@ client.set_schema(bucket)
 client.store(chili)
 chili = client.get(bucket,'chili')
 
-DogData.readable(:name,:breeds)
-DogData.writable(:name,:age)
+DogBreedsData = JiakDataFields.create(:name,:breeds)
+bucket.data_class = DogBreedsData
 client.set_schema(bucket)
 chili = client.get(bucket,'chili')
+chili.data.breeds = ["heeler","mutt"]
+
+
+DogAgeData = JiakDataFields.create(:name,:age)
 diego = JiakObject.new(:bucket => bucket,
-                       :key => "diego",
-                       :data => DogData.new(:name => "Diego",
+                       :data => DogAgeData.new(:name => "Diego",
                                             :age => 7))
 client.store(diego)
 
 addie = JiakObject.new(:bucket => bucket,
-                       :key => "addie",
                        :data => DogData.new(:name => "Adelaide",
                                             :age => 14,
                                             :breeds => ["heeler"]))
 client.store(addie)
 
-
 addie = client.get(bucket,'addie')

data/examples/linked_resources.rb

@@ -1,17 +1,13 @@
 require 'riakrest'
 include RiakRest
 
-PersonData = JiakDataHash.create(:name)
-PersonData.keygen :name
-
-class Parent
+class Parents
   include JiakResource
-
-  server      'http://localhost:8002/jiak'
-  group       'parents'
-  data_class  PersonData
+  server         'http://localhost:8002/jiak'
+  jattr_accessor :name
+  keygen { name }
 end
-Child = Parent.copy(:group => 'children')
+(Child = Parents.dup).group 'children'
 
 # relationships
 parent_children = {
@@ -31,7 +27,7 @@ end
 
 # store data and relationships
 parent_children.each do |pname,cnames|
-  p = Parent.new(:name => pname).post
+  p = Parents.new(:name => pname).post
   cnames.each do |cname|
     begin
       c = Child.get(cname)
@@ -46,49 +42,50 @@ parent_children.each do |pname,cnames|
 end
 
 # retrieve parents
-parents = parent_children.keys.map {|p| Parent.get(p)}
+parents = parent_children.keys.map {|p| Parents.get(p)}
 p0,p1,p2,p3 = parents
-puts p1.name                                # => 'p1'
+puts p1.name                                      # => 'p1'
 
 # retrieve children
 children = child_parents.keys.map {|c| Child.get(c)}
 c0,c1,c2,c3 = children
-puts c1.name                                # => 'c1'
+puts c1.name                                      # => 'c1'
 
 # retrieve parent children
 p0c,p1c,p2c,p3c = parents.map {|p| p.query(Child,'child')}
-puts p2c[0].name                            # => 'c2' (not sorted, could be 'c3')
+puts p2c[0].name                                  # => 'c2' (could be 'c3')
 
 # retrieve children parents
-c0p,c1p,c2p,c3p = children.map {|c| c.query(Parent,'parent')}
-puts c3p[0].name                            # => 'p3'
+c0p,c1p,c2p,c3p = children.map {|c| c.query(Parents,'parent')}
+puts c3p[0].name                                  # => 'p2'
+puts c3p[1].name                                  # => 'p3'
 
 # retrieve children siblings
 c0s,c1s,c2s,c3s = children.map do |c|
-  c.query(Parent,'parent',Child,'child').delete_if{|s| s.eql?(c)}
+  c.query(Parents,'parent',Child,'child').delete_if{|s| s.eql?(c)}
 end
-puts c3s[0].name                            # => 'c2'
+puts c3s[0].name                                  # => 'c2'
 
 # who is c3's step-sibling's other parent?
-c3sp = c3.query(Parent,'parent',Child,'child',Parent,'parent')
+c3sp = c3.query(Parents,'parent',Child,'child',Parents,'parent')
 c3p.each {|p| c3sp.delete_if{|sp| p.eql?(sp)}}
-puts c3sp[0].name                           # => "p1"
+puts c3sp[0].name                                 # => "p1"
 
 # turn on auto-update at class level
-Parent.auto_update true
+Parents.auto_update true
 Child.auto_update  true
 
 # add sibling links
 children.each do |c|
-  siblings = c.query(Parent,'parent',Child,'child').delete_if{|s| s.eql?(c)}
+  siblings = c.query(Parents,'parent',Child,'child').delete_if{|s| s.eql?(c)}
   siblings.each {|s| c.link(s,'sibling')}
   c.update
 end
-puts c1.query(Child,'sibling').size          # => 2  
+puts c1.query(Child,'sibling').size               # => 2  
   
 # some folks are odd, and others are normal
 parent_children.keys.each do |p|
-  parent = Parent.get(p)
+  parent = Parents.get(p)
   p_children = parent.query(Child,'child')
   p_children.each do |child| 
     child.link(parent, p[1].to_i.odd? ? 'odd' : 'normal')
@@ -103,10 +100,10 @@ children.each {|c| c.refresh}
 
 # do any odd parents have normal children?
 op = parents.inject([]) do |build,parent|
-  build << parent.query(Child,'normal',Parent,'odd')
+  build << parent.query(Child,'normal',Parents,'odd')
   build.flatten.uniq
 end
-puts op[0].name                            # => 'p1'
+puts op[0].name                                   # => 'p1'
 
 # clean-up by deleting everybody
 parents.each  {|p| p.delete}

data/examples/links_only_pov.rb

@@ -2,37 +2,37 @@ require 'riakrest'
 include RiakRest
 
 # class with 10 fields
-class Full
+class Fields
   include JiakResource
-  server       'http://localhost:8002/jiak'
-  group        'fields'
-  data_class   JiakDataHash.create (0...10).map {|n| "f#{n}".to_sym}
-  auto_post    true
-  auto_update  true
+  server         'http://localhost:8002/jiak'
+  jattr_accessor (0...10).map {|n| "f#{n}".to_sym}
+  auto_manage
 end
 
-# copy of above, but no read/write fields, i.e., only links
-LinksOnly = JiakDataHash.create Full.schema
-LinksOnly.readwrite []
-Links = Full.copy(:data_class => LinksOnly)
+class Links
+  include JiakResource
+  server       'http://localhost:8002/jiak'
+  auto_manage
+end
 
-# populate two Full objects with (meaningless) stuff
-Full.pov
-full1,full2 =
-  ["full1","full2"].map {|o| Full.new(Full.schema.write_mask.inject({}) do |h,f|
-                                        h[f]="#{o.upcase}-#{f.hash}"
-                                        h
-                                      end)}
+# populate two Fields objects with (meaningless) stuff
+Fields.pov
+fields = ["fields1","fields2"]
+fields1,fields2 =
+  fields.map {|o| Fields.new(Fields.schema.write_mask.inject({}) do |h,f|
+                               h[f]="#{o.upcase}-#{f.hash}"
+                               h
+                             end)}
 
 Links.pov
-links1 = Links.get(full1.jiak.key)
-links1.link(full2,'link')
+links1 = Links.get(fields1.jiak.key)
+links1.link(fields2,'link')
 
-Full.pov
-full2.f1 = "new f1"
+Fields.pov
+fields2.f1 = "new f1"
 
-linked = full1.query(Full,'link')[0]
-puts linked.f1 == full2.f1                        # => true
+linked = fields1.query(Fields,'link')[0]
+puts linked.f1 == fields2.f1                        # => true
 
-full1.delete
-full2.delete
+fields1.delete
+fields2.delete

data/examples/multiple_pov.rb

@@ -1,27 +1,29 @@
 require 'riakrest'
 include RiakRest
 
-DogData = JiakDataHash.create(:name,:weight,:breed)
-DogData.keygen :name
 class Dog
   include JiakResource
-  server      'http://localhost:8002/jiak'
-  group       'dogs'
-  data_class  DogData
+  server        'http://localhost:8002/jiak'
+  jiak_accessor :name, :weight, :breed
+  keygen { name.downcase }
 end
 
-DogBreedData = JiakDataHash.create(DogData.schema)
-DogBreedData.readwrite :name, :breed
-DogBreed = Dog.copy(:data_class => DogBreedData)
+class DogBreed
+  include JiakResource
+  server        'http://localhost:8002/jiak'
+  jiak_accessor :name, :breed
+end
 
-DogWeightData = JiakDataHash.create(DogData.schema)
-DogWeightData.readwrite :name, :weight
-DogWeight = Dog.copy(:data_class => DogWeightData)
+class DogWeight
+  include JiakResource
+  server        'http://localhost:8002/jiak'
+  jiak_accessor :name, :weight
+end
 
 Dog.pov
-addie = Dog.new(:name => 'adelaide', :weight => 45, :breed => 'heeler')
+addie = Dog.new(:name => 'Adelaide', :weight => 45, :breed => 'heeler')
 addie.post
-puts addie.name                 # => "adelaide"
+puts addie.name                 # => "Adelaide"
 puts addie.breed                # => "heeler"
 puts addie.weight               # => 45
 
@@ -37,7 +39,7 @@ addie.put
 
 Dog.pov
 addie = Dog.get('adelaide')
-puts addie.name                 # => "adelaide"
+puts addie.name                 # => "Adelaide"
 puts addie.breed                # => "Heeler"
 puts addie.weight               # => 47
 

data/examples/rest_interaction.rb

@@ -1,8 +1,11 @@
 require 'riakrest'
 include RiakRest
 
-DogData = JiakDataHash.create(:name,:age,:breeds)
-# client = JiakClient.new("http://localhost:8002/jiak",:proxy=>"http://localhost:8888")
+class DogData
+  include JiakData
+  jattr_accessor :name, :age, :breeds
+end
+
 client = JiakClient.new("http://localhost:8002/jiak")
 bucket = JiakBucket.new("dogs", DogData)
 
@@ -44,8 +47,5 @@ client.store(strass)
 db_strass = client.get(bucket,'strass')
 puts db_strass.data.age                     # =>  6   Yeah!
 
-
-
 # Clean-up
 client.keys(bucket).each {|key| client.delete(bucket,key)}
-