riakrest 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-10-20
+
+* Initial release:
+  * Still pre-alpha

data/Manifest.txt

@@ -0,0 +1,41 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+examples/auto_update_data.rb
+examples/auto_update_links.rb
+examples/basic_client.rb
+examples/basic_resource.rb
+examples/json_data_resource.rb
+examples/linked_resource.rb
+examples/multiple_resources.rb
+lib/riakrest.rb
+lib/riakrest/core/exceptions.rb
+lib/riakrest/core/jiak_bucket.rb
+lib/riakrest/core/jiak_client.rb
+lib/riakrest/core/jiak_data.rb
+lib/riakrest/core/jiak_link.rb
+lib/riakrest/core/jiak_object.rb
+lib/riakrest/core/jiak_schema.rb
+lib/riakrest/core/query_link.rb
+lib/riakrest/data/jiak_data_hash.rb
+lib/riakrest/resource/jiak_resource.rb
+lib/riakrest/version.rb
+riakrest.gemspec
+script/console
+script/destroy
+script/generate
+spec/core/exceptions_spec.rb
+spec/core/jiak_bucket_spec.rb
+spec/core/jiak_client_spec.rb
+spec/core/jiak_link_spec.rb
+spec/core/jiak_object_spec.rb
+spec/core/jiak_schema_spec.rb
+spec/core/query_link_spec.rb
+spec/data/jiak_data_hash_spec.rb
+spec/resource/jiak_resource_spec.rb
+spec/riakrest_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on riakrest, see http://gemcutter.org/dingosky/riakrest

data/README.rdoc

@@ -0,0 +1,51 @@
+= 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.
+
+== FEATURES/PROBLEMS:
+
+
+== SYNOPSIS:
+
+
+== REQUIREMENTS:
+
+RestClient is used for REST server interaction.
+JSON is used for data exchange.
+
+== INSTALL:
+
+sudo gem install riakrest
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Paul Rogers, DingoSky LLC
+
+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/Rakefile

@@ -0,0 +1,24 @@
+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]

data/examples/auto_update_data.rb

@@ -0,0 +1,50 @@
+require 'lib/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
+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
+
+Person.auto_update false
+remy.auto_update = true
+puts Person.get('remy').age                 # => 12
+remy.age = 10
+puts Person.get('remy').age                 # => 10
+
+Person.auto_update true
+remy.auto_update = false
+remy.age = 12
+puts Person.get('remy').age                 # => 10
+remy.update
+puts Person.get('remy').age                 # => 12
+
+remy.auto_update = nil
+remy.age = 10
+puts Person.get('remy').age                 # => 10
+
+remy.delete
+callie.delete
+
+

data/examples/auto_update_links.rb

@@ -0,0 +1,48 @@
+require 'lib/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
+end
+
+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
+remy.update
+puts remy.walk(Person,'sister').size        # => 1
+remy.remove_link(callie,'sister')
+
+Person.auto_update true
+remy.link(callie,'sibling')
+puts remy.walk(Person,'sibling').size       # => 1
+remy.remove_link(callie,'sibling')
+
+callie.auto_update = false
+callie.link(remy,'sibling')
+puts callie.walk(Person,'sibling').size     # => 0
+callie.update
+puts callie.walk(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
+callie.update
+puts callie.walk(Person,'sisters').size     # => 1
+
+remy.delete
+callie.delete
+

data/examples/basic_client.rb

@@ -0,0 +1,33 @@
+require 'lib/riakrest'
+include RiakRest
+
+Person = JiakDataHash.create(:name,:age)
+
+client = JiakClient.new("http://localhost:8002/jiak")
+bucket = JiakBucket.new('people',Person)
+client.set_schema(bucket)
+
+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')
+client.store(remy)
+
+sisters = client.walk(bucket,remy.key,QueryLink.new(bucket,'sister'),Person)
+sisters[0].eql?(callie)                            # => true
+
+client.delete(bucket,remy.key)
+client.delete(bucket,callie.key)

data/examples/basic_resource.rb

@@ -0,0 +1,34 @@
+require 'lib/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
+end
+
+remy = Person.new(:name => 'remy', :age => 10)
+puts Person.get('remy').name                # => "remy"
+
+remy.name = "Remy"
+remy.update
+puts remy.name                              # => "Remy"
+puts Person.get('remy').name                # => "Remy"
+
+callie = Person.new(:name => 'Callie', :age => 12)
+remy.bi_link(callie,'sister').update
+callie.update
+
+sisters = remy.walk(Person,'sister')
+puts sisters[0].eql?(callie)                # => true
+
+remy.delete
+callie.delete
+
+

data/examples/json_data_resource.rb

@@ -0,0 +1,32 @@
+require 'date'
+class DogData  # :nodoc:
+  include JiakData
+
+  allowed   :name, :birthdate, :weight, :breed
+  readwrite :name, :birthdate, :weight
+
+  def initialize(hsh)
+    hsh.each {|key,val| send("#{key}=",val)}
+  end
+
+  def self.create(hsh)
+    new(hsh)
+  end
+
+  def self.jiak_create(jiak)
+    jiak['birthdate'] = Date.parse(jiak['birthdate']) if jiak['birthdate']    
+    new(jiak)
+  end
+
+  def for_jiak
+    self.class.write_mask.inject({}) do |build,field|
+      val = send("#{field}")
+      build[field] = val   unless val.nil?
+      build
+    end
+  end
+
+  def keygen
+    @name
+  end
+end

data/examples/linked_resource.rb

@@ -0,0 +1,113 @@
+require 'lib/riakrest'
+include RiakRest
+
+PersonData = JiakDataHash.create(:name)
+PersonData.keygen :name
+
+class Parent
+  include JiakResource
+
+  server      'http://localhost:8002/jiak'
+  group       'parents'
+  data_class  PersonData
+end
+
+Child = Parent.copy(:group => 'children')
+
+# relationships
+parent_children = {
+  'p0' => ['c0'],
+  'p1' => ['c0','c1','c2'],
+  'p2' => ['c2','c3'],
+  'p3' => ['c3']
+}
+
+# invert relationships
+child_parents = parent_children.inject({}) do |build, (p,cs)|
+  cs.each do |c|
+    build[c] ? build[c] << p : build[c] = [p]
+  end
+  build
+end
+
+# store data and relationships
+parent_children.each do |pname,cnames|
+  p = Parent.new(:name => pname)
+  cnames.each do |cname|
+    begin
+      c = Child.get(cname)
+    rescue
+      c = Child.new(:name => cname)
+    end
+    c.link(p,'parent')
+    c.put
+    p.link(c,'child')
+  end
+  p.post
+end
+
+# retrieve parents
+parents = parent_children.keys.map {|p| Parent.get(p)}
+p0,p1,p2,p3 = parents
+p1.name                                # => 'p1'
+
+# retrieve children
+children = child_parents.keys.map {|c| Child.get(c)}
+c0,c1,c2,c3 = children
+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')
+
+# retrieve children parents
+c0p,c1p,c2p,c3p = children.map {|c| c.walk(Parent,'parent')}
+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)}
+end
+c3s[0].name                            # => 'c2'
+
+# who is c3's step-sibling's other parent?
+c3sp = c3.walk(Parent,'parent',Child,'child',Parent,'parent')
+c3p.each {|p| c3sp.delete_if{|sp| p.eql?(sp)}}
+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.each {|s| c.link(s,'sibling')}
+  c.update
+end
+c1.walk(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.each do |child| 
+    child.link(parent, p[1].to_i.odd? ? 'odd' : 'normal')
+    child.update
+    parent.link(child, child.name[1].to_i.odd? ? 'odd' : 'normal')
+  end
+  parent.update
+end
+# refresh parents and children variables
+parents.each {|p| p.get}
+children.each {|c| c.get}
+
+# do any odd parents have normal children?
+op = parents.inject([]) do |build,parent|
+  build << parent.walk(Child,'normal',Parent,'odd')
+  build.flatten.uniq
+end
+op[0].name                            # => 'p1'

data/examples/multiple_resources.rb

@@ -0,0 +1,43 @@
+require 'lib/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
+end
+
+DogBreedData = JiakDataHash.create(DogData.schema)
+DogBreedData.readwrite :name, :breed
+DogBreed = Dog.copy(:data_class => DogBreedData)
+
+DogWeightData = JiakDataHash.create(DogData.schema)
+DogWeightData.readwrite :name, :weight
+DogWeight = Dog.copy(:data_class => DogWeightData)
+
+Dog.pov
+addie = Dog.new(:name => 'adelaide', :weight => 45, :breed => 'heeler')
+addie.post
+puts addie.name                 # => "adelaide"
+puts addie.breed                # => "heeler"
+puts addie.weight               # => 45
+
+DogBreed.pov
+addie = DogBreed.get('adelaide')
+addie.breed = "Heeler"
+addie.put
+
+DogWeight.pov
+addie = DogWeight.get('adelaide')
+addie.weight = 47
+addie.put
+
+Dog.pov
+addie = Dog.get('adelaide')
+puts addie.name                 # => "adelaide"
+puts addie.breed                # => "Heeler"
+puts addie.weight               # => 47
+

data/lib/riakrest/core/exceptions.rb

@@ -0,0 +1,73 @@
+module RiakRest
+
+  # Top-level RiakRest exception. All RiakRest exceptions are subclass of this
+  # class.
+  class Exception < StandardError
+  end
+
+  # Client exception in accessing a resource on the Jiak server.
+  class JiakResourceException < RiakRest::Exception
+    attr_accessor :params
+    
+    # call-seq:
+    #    raise JiakClientException, message="", params={}
+    #
+    # The message is handled using normal Ruby exception handling. The params
+    # field is a hash containing:
+    # <code>action</code>:: The client resource access action.
+    # <code>args</code>:: The arguments to the action.
+    # <code>uri</code>:: The URI used to access the resource.
+    def initialize(msg="", params={})
+      super(msg)
+      @params = params
+    end
+
+    # call-seq:
+    #    err.description -> string
+    #
+    # A string description of a client error when accessing a Jiak resource.
+    def description
+      unless(@params.empty?)
+        action = @params[:action] || ""
+        args = @params[:args] || "()"
+        uri = @params[:uri] || ""
+        "#{self.class}: #{action}#{args} #{message} using uri='#{uri}'"
+      else
+        "#{self.class}: #{message}"
+      end
+    end
+  end
+
+  # Exceptions pertaining to JiakClient usage.
+  class JiakClientException < RiakRest::Exception
+  end
+
+  # Resource not found on the Jiak server.
+  class JiakResourceNotFound < RiakRest::JiakResourceException
+  end
+
+  # Exceptions pertaining to JiakBucket usage.
+  class JiakBucketException < RiakRest::Exception
+  end
+
+  # Exceptions pertaining to JiakObject usage.
+  class JiakObjectException < RiakRest::Exception
+  end
+
+  # Exceptions pertaining to JiakData usage.
+  class JiakDataException < RiakRest::Exception
+  end
+
+  # Exceptions pertaining to JiakLink usage.
+  class JiakLinkException < RiakRest::Exception
+  end
+
+  # Exceptions pertaining to JiakSchema usage.
+  class JiakSchemaException < RiakRest::Exception
+  end
+
+  # Exceptions pertaining to QueryLink usage.
+  class QueryLinkException < RiakRest::Exception
+  end
+
+end