riakrest 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+## OS X
+.DS_Store
+
+## emacs
+TAGS
+*~
+.#*
+
+## gem
+pkg/*
+rdoc/*
+*.gemspec
+
+##
+doc/*
+log/*
+tmp/*
+

data/History.txt

@@ -1,4 +1,7 @@
+=== 0.0.2 2009-10-30
+
+* Clean-up:
+
 === 0.0.1 2009-10-20
 
 * Initial release:
-  * Still pre-alpha

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Paul Rogers, DingoSky
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,51 +1,77 @@
-= riakrest
+= RiakRest
 
 http://github.com/wcpr/riakrest
 
 == DESCRIPTION:
 
 RiakRest provides structured, RESTful interaction with a Riak document
-store. In Riak parlance, this JSON data exchange is called Jiak. RiakRest
-provides two levels of interaction: Core Client and Resource. Core Client
-interaction works down at the Jiak level and exposes Jiak internals. Resource
-interaction is an abstraction built on top of the Core Client.
+store.
 
-== FEATURES/PROBLEMS:
+== 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.
 
 == SYNOPSIS:
 
+RiakRest provides structured, RESTful interaction with the HTTP/JSON interface
+of a Riak[http://riak.basho.com] document data store. RiakRest provides two
+levels of interaction: Core Client and Resource. Core Client works at the Jiak
+level and exposes Jiak internals. JiakResource is an abstraction built on top
+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.
 
+Riak[http://riak.basho.com] provides the HTTP/JSON Jiak interface and data
+store.
+
 == INSTALL:
 
 sudo gem install riakrest
 
-== LICENSE:
+== EXAMPLE
+  require 'riakrest'
+  include RiakRest
+
+  PersonData = JiakDataHash.create(:name,:age)
+  PersonData.keygen :name
+
+  class Person
+    include JiakResource
+    server      'http://localhost:8002/jiak'
+    group       'people'
+    data_class  PersonData
+    auto_post   true
+    auto_update true
+  end
 
-(The MIT License)
+  remy = Person.new(:name => 'remy',:age => 10) #            (auto-post)
+  puts remy.name                                # => "remy"  (auto-update)
 
-Copyright (c) 2009 Paul Rogers, DingoSky LLC
+  puts Person.get('remy').name                  # => "remy"  (from Jiak server)
+  puts Person.get('remy').age                   # => 10      (from Jiak server)
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+  remy.age = 11                                 #            (auto-update)
+  puts Person.get('remy').age                   # => 11      (from Jiak server)
+
+  callie = Person.new(:name => 'Callie', :age => 13)
+  remy.link(callie,'sister')
+
+  sisters = remy.query(Person,'sister')
+  puts sisters[0].eql?(callie)                  # => true
+
+  remy.delete
+  callie.delete
+
+== LICENSE:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Copyright (c) 2009 Paul Rogers, DingoSky. See LICENCE for details.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+===Go forth and Riak!

data/Rakefile

@@ -1,24 +1,55 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/riakrest'
-
-Hoe.plugin :newgem
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'riakrest' do
-  self.developer 'Paul Rogers', 'paul@dingosky.com'
-  self.post_install_message = 'PostInstall.txt'
-  self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
-end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "riakrest"
+  gem.summary = %Q{RiakRest provides structured, RESTful interaction with a Riak document store.}
+  gem.description = <<-EOH
+    RiakRest provides structured, RESTful interaction with
+    the HTTP/JSON interface of a Riak[http://riak.basho.com] document data
+    store. RiakRest provides two levels of interaction: Core Client and
+    Resource. Core Client works at the Jiak level and exposes Jiak
+    internals. JiakResource is an abstraction built on top of the Core Client
+    that gives a true RESTful feel.
+  EOH
+  gem.authors = ["Paul Rogers"]
+  gem.email = "paul@dingosky.com"
+  gem.homepage = "http://github.com/wcpr/riakrest"
+  gem.add_dependency('rest-client', '>= 1.0.0')
+  gem.add_development_dependency "rest-client", ">= 1.0.0"
+  gem.add_development_dependency "rspec", ">= 1.2.9"
+end
+
+Jeweler::GemcutterTasks.new
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :test => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "riakrest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/examples/auto_update_data.rb

@@ -11,19 +11,14 @@ class Person
   group        'people'
   data_class   PersonData
   auto_post    true
+  auto_update  true
 end
 
 remy = Person.new(:name => 'remy', :age => 10)
 puts Person.get('remy').name                # => "remy"
 
 remy.name = "Remy"
-puts Person.get('remy').name                # => "remy"
-remy.update
 puts Person.get('remy').name                # => "Remy"
-
-Person.auto_update true
-
-puts Person.get('remy').age                 # => 10
 remy.age = 12
 puts Person.get('remy').age                 # => 12
 
@@ -45,6 +40,5 @@ remy.age = 10
 puts Person.get('remy').age                 # => 10
 
 remy.delete
-callie.delete
 
 

data/examples/auto_update_links.rb

@@ -17,31 +17,31 @@ remy = Person.new(:name => 'remy', :age => 10)
 callie = Person.new(:name => 'Callie', :age => 12)
 
 remy.link(callie,'sister')
-puts remy.walk(Person,'sister').size        # => 0
+puts remy.query(Person,'sister').size        # => 0
 remy.update
-puts remy.walk(Person,'sister').size        # => 1
+puts remy.query(Person,'sister').size        # => 1
 remy.remove_link(callie,'sister')
 
 Person.auto_update true
 remy.link(callie,'sibling')
-puts remy.walk(Person,'sibling').size       # => 1
+puts remy.query(Person,'sibling').size       # => 1
 remy.remove_link(callie,'sibling')
 
 callie.auto_update = false
 callie.link(remy,'sibling')
-puts callie.walk(Person,'sibling').size     # => 0
+puts callie.query(Person,'sibling').size     # => 0
 callie.update
-puts callie.walk(Person,'sibling').size     # => 1
+puts callie.query(Person,'sibling').size     # => 1
 callie.remove_link(remy,'sibling')
 
 Person.auto_update false
 remy.auto_update = true
 callie.auto_update = nil
 remy.bi_link(callie,'sisters')
-puts remy.walk(Person,'sisters').size       # => 1
-puts callie.walk(Person,'sisters').size     # => 0
+puts remy.query(Person,'sisters').size       # => 1
+puts callie.query(Person,'sisters').size     # => 0
 callie.update
-puts callie.walk(Person,'sisters').size     # => 1
+puts callie.query(Person,'sisters').size     # => 1
 
 remy.delete
 callie.delete

data/examples/basic_client.rb

@@ -11,23 +11,21 @@ remy = client.store(JiakObject.new(:bucket => bucket,
                                     :data => Person.new(:name => "remy",
                                                         :age => 10)),
                      :object => true)
-puts client.get(bucket,remy.key).data.name         # => "remy"
-
-remy.data.name                                     # => "remy"
-remy.data.name = "Remy"
-client.store(remy)
-puts client.get(bucket,remy.key).data.name         # => "Remy"
-
-
 callie = client.store(JiakObject.new(:bucket => bucket,
                                      :data => Person.new(:name => "Callie",
                                                          :age => 12)),
                       :object => true)
-remy   << JiakLink.new(bucket,callie.key,'sister')
+
+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"
+
 sisters = client.walk(bucket,remy.key,QueryLink.new(bucket,'sister'),Person)
-sisters[0].eql?(callie)                            # => true
+puts sisters[0].eql?(callie)                       # => true
 
 client.delete(bucket,remy.key)
 client.delete(bucket,callie.key)

data/examples/basic_resource.rb

@@ -6,29 +6,27 @@ PersonData.keygen :name
 
 class Person
   include JiakResource
-
-  server       'http://localhost:8002/jiak'
-  group        'people'
-  data_class   PersonData
-  auto_post    true
+  server      'http://localhost:8002/jiak'
+  group       'people'
+  data_class  PersonData
+  auto_post   true
+  auto_update true
 end
 
-remy = Person.new(:name => 'remy', :age => 10)
-puts Person.get('remy').name                # => "remy"
+remy = Person.new(:name => 'remy',:age => 10) #            (auto-post)
+puts remy.name                                # => "remy"  (auto-update)
+
+puts Person.get('remy').name                  # => "remy"  (from Jiak server)
+puts Person.get('remy').age                   # => 10      (from Jiak server)
 
-remy.name = "Remy"
-remy.update
-puts remy.name                              # => "Remy"
-puts Person.get('remy').name                # => "Remy"
+remy.age = 11                                 #            (auto-update)
+puts Person.get('remy').age                   # => 11      (from Jiak server)
 
-callie = Person.new(:name => 'Callie', :age => 12)
-remy.bi_link(callie,'sister').update
-callie.update
+callie = Person.new(:name => 'Callie', :age => 13)
+remy.link(callie,'sister')
 
-sisters = remy.walk(Person,'sister')
-puts sisters[0].eql?(callie)                # => true
+sisters = remy.query(Person,'sister')
+puts sisters[0].eql?(callie)                  # => true
 
 remy.delete
 callie.delete
-
-

data/examples/json_data_resource.rb

@@ -1,3 +1,8 @@
+require 'lib/riakrest'
+include RiakRest
+
+# CxINC Example doesn't do anything useful yet
+
 require 'date'
 class DogData  # :nodoc:
   include JiakData

data/examples/linked_resource.rb

@@ -10,8 +10,9 @@ class Parent
   server      'http://localhost:8002/jiak'
   group       'parents'
   data_class  PersonData
+  auto_post   true
+  auto_update true
 end
-
 Child = Parent.copy(:group => 'children')
 
 # relationships
@@ -31,8 +32,12 @@ child_parents = parent_children.inject({}) do |build, (p,cs)|
 end
 
 # store data and relationships
+Parent.auto_post   false
+Parent.auto_update false
+Child.auto_post    false
+Child.auto_update  false
 parent_children.each do |pname,cnames|
-  p = Parent.new(:name => pname)
+  p = Parent.new(:name => pname).post
   cnames.each do |cname|
     begin
       c = Child.get(cname)
@@ -43,57 +48,54 @@ parent_children.each do |pname,cnames|
     c.put
     p.link(c,'child')
   end
-  p.post
+  p.update
 end
+Parent.auto_post   true
+Parent.auto_update true
+Child.auto_post    true
+Child.auto_update  true
 
 # retrieve parents
 parents = parent_children.keys.map {|p| Parent.get(p)}
 p0,p1,p2,p3 = parents
-p1.name                                # => 'p1'
+puts p1.name                                # => 'p1'
 
 # retrieve children
 children = child_parents.keys.map {|c| Child.get(c)}
 c0,c1,c2,c3 = children
-c1.name                                # => 'c1'
+puts c1.name                                # => 'c1'
 
 # retrieve parent children
-p0c,p1c,p2c,p3c = parents.map {|p| p.walk(Child,'child')}
-p2c[0].name                            # => 'c2' (not sorted, so could be 'c3')
+p0c,p1c,p2c,p3c = parents.map {|p| p.query(Child,'child')}
+puts p2c[0].name                            # => 'c2' (not sorted, could be 'c3')
 
 # retrieve children parents
-c0p,c1p,c2p,c3p = children.map {|c| c.walk(Parent,'parent')}
-c3p[0].name                            # => 'p3'
+c0p,c1p,c2p,c3p = children.map {|c| c.query(Parent,'parent')}
+puts c3p[0].name                            # => 'p3'
 
 # retrieve children siblings
 c0s,c1s,c2s,c3s = children.map do |c|
-  c.walk(Parent,'parent',Child,'child').delete_if{|s| s.eql?(c)}
+  c.query(Parent,'parent',Child,'child').delete_if{|s| s.eql?(c)}
 end
-c3s[0].name                            # => 'c2'
+puts c3s[0].name                            # => 'c2'
 
 # who is c3's step-sibling's other parent?
-c3sp = c3.walk(Parent,'parent',Child,'child',Parent,'parent')
+c3sp = c3.query(Parent,'parent',Child,'child',Parent,'parent')
 c3p.each {|p| c3sp.delete_if{|sp| p.eql?(sp)}}
-c3sp[0].name                           # => "p1"
+puts c3sp[0].name                           # => "p1"
 
 # add sibling links
 children.each do |c|
-  siblings = c.walk(Parent,'parent',Child,'child').delete_if{|s| s.eql?(c)}
+  siblings = c.query(Parent,'parent',Child,'child').delete_if{|s| s.eql?(c)}
   siblings.each {|s| c.link(s,'sibling')}
   c.update
 end
-c1.walk(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)
-  p_children = parent.walk(Child,'child')
+  p_children = parent.query(Child,'child')
   p_children.each do |child| 
     child.link(parent, p[1].to_i.odd? ? 'odd' : 'normal')
     child.update
@@ -102,12 +104,15 @@ parent_children.keys.each do |p|
   parent.update
 end
 # refresh parents and children variables
-parents.each {|p| p.get}
-children.each {|c| c.get}
+parents.each {|p| p.refresh}
+children.each {|c| c.refresh}
 
 # do any odd parents have normal children?
 op = parents.inject([]) do |build,parent|
-  build << parent.walk(Child,'normal',Parent,'odd')
+  build << parent.query(Child,'normal',Parent,'odd')
   build.flatten.uniq
 end
-op[0].name                            # => 'p1'
+puts op[0].name                            # => 'p1'
+
+parents.each  {|p| p.delete}
+children.each {|c| c.delete}

data/examples/links_only.rb

@@ -0,0 +1,38 @@
+require 'riakrest'
+include RiakRest
+
+# class with 10 fields
+class Full
+  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
+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)
+
+# 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)}
+
+Links.pov
+links1 = Links.get(full1.jiak.key)
+links1.link(full2,'link')
+
+Full.pov
+full2.f1 = "new f1"
+
+linked = full1.query(Full,'link')[0]
+puts linked.f1 == full2.f1                        # => true
+
+full1.delete
+full2.delete

data/lib/riakrest/core/jiak_client.rb

@@ -178,6 +178,11 @@ module RiakRest
       begin
         uri = jiak_uri(bucket,key,req_params)
         resp = RestClient.get(uri, :accept => APP_JSON)
+
+        # puts
+        # puts "---CxDEBUG---"
+        # puts "  #{resp}"
+
         JiakObject.from_jiak(JSON.parse(resp),bucket.data_class)
       rescue RestClient::ResourceNotFound => err
         raise JiakResourceNotFound, "failed get: #{err.message}"

data/lib/riakrest/core/jiak_data.rb

@@ -89,19 +89,27 @@ module RiakRest
 
       # :call-seq:
       #   allowed :f1, ..., :fn   -> array
+      #   allowed [:f1, ..., :fn]   -> array
       #
       # Fields allowed in Jiak interactions. Returns an array of the allowed
       # fields.
       #
+      # The field <code>jiak</code> is reserved for RiakRest.
+      #
+      # Raise JiakDataException if the fields include <code>jiak</code>.
       def allowed(*fields)
-        arr_fields = create_array(fields)
-        fields.each {|field| attr_accessor field}
+        if(fields.include?(:jiak) || fields.include?('jiak'))
+          raise JiakDataException, "jiak field name reserved for RiakRest"
+        end
+        arr_fields = transform_fields(*fields)
+        arr_fields.each {|field| attr_accessor field}
         @schema = JiakSchema.new(arr_fields)
         arr_fields
       end
 
       # :call-seq:
       #   required :f1, ..., :fn  -> array
+      #   required [:f1, ..., :fn]   -> array
       #
       # Fields required during in Jiak interactions. Returns an array of the
       # required fields.
@@ -112,6 +120,7 @@ module RiakRest
 
       # :call-seq:
       #   readable :f1, ..., :fn  -> array
+      #   readable [:f1, ..., :fn]  -> array
       #
       # Fields returned by Jiak on retrieval. Returns an array of the fields in
       # the read mask.
@@ -122,6 +131,7 @@ module RiakRest
 
       # :call-seq:
       #   writable :f1, ..., :fn  -> arry
+      #   writable [:f1, ..., :fn]  -> arry
       #
       # Fields that can be written during Jiak interaction. Returns an array of
       # the fields in the write mask.
@@ -132,6 +142,7 @@ module RiakRest
 
       # :call-seq:
       #   readwrite :f1, ..., :fn  -> array
+      #   readwrite [:f1, ..., :fn]  -> array
       #
       # Set the read and write masks to the same fields. Returns an array of
       # the fields in the masks.
@@ -141,7 +152,7 @@ module RiakRest
       end
 
       def set_fields(which,*fields)
-        arr_fields = create_array(fields)
+        arr_fields = transform_fields(*fields)
         check_allowed(arr_fields)
         @schema.send("#{which}=",arr_fields)
         arr_fields
@@ -181,21 +192,16 @@ module RiakRest
       #    end
       # </code>
       #
-      # Raise JiakDataException if not explicitly defined by user-defined data class.
+      # Raise JiakDataException if not explicitly defined by user-data class.
       def jiak_create(json)
         raise JiakDataException, "#{self} must define jiak_create"
       end
 
-      def create_array(*fields)
-        if(fields.size == 1 && fields[0].is_a?(Array))
-          array = fields[0]
-        else
-          array = fields
-        end
-        array.map {|field| field}
-        array
+      def transform_fields(*fields)
+        fields = fields[0] if(fields[0].is_a?(Array))
+        fields.map {|f| f.to_sym}
       end
-      private :create_array
+      private :transform_fields
 
       def check_allowed(fields)
         allowed_fields = @schema.allowed_fields

data/lib/riakrest/core/query_link.rb

@@ -132,7 +132,7 @@ module RiakRest
 
     # String representation of this QueryLink.
     def to_s
-      '["'+@bucket+'","'+@tag+'","'+@acc+'"]'
+      "[#{bucket},#{tag},#{acc}]"
     end
 
     def transform_args(b,t,a)