riakrest 0.0.3 → 0.0.4

data/History.txt

@@ -1,27 +1,34 @@
+=== 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.
+
 === 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
+   * 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.
+   * 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.
+   * 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
+   * DRY'd some code
+   * Examples
 
 
 === 0.0.1 2009-10-20
 
 * Initial release:
-    - To github, anyway. git log shows the prior activity.
+   * To github, anyway. git log shows the prior activity.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/examples/basic_client.rb

@@ -10,11 +10,11 @@ client.set_schema(bucket)
 remy = client.store(JiakObject.new(:bucket => bucket,
                                     :data => Person.new(:name => "remy",
                                                         :age => 10)),
-                     :object => true)
+                     :return => :object)
 callie = client.store(JiakObject.new(:bucket => bucket,
                                      :data => Person.new(:name => "Callie",
                                                          :age => 12)),
-                      :object => true)
+                      :return => :object)
 
 puts client.get(bucket,remy.key).data.name         # => "remy"
 

data/examples/basic_resource.rb

@@ -13,14 +13,14 @@ class Person
   auto_update true
 end
 
-remy = Person.new(:name => 'remy',:age => 10) #            (auto-post)
-puts remy.name                                # => "remy"  (auto-update)
+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)
+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)
+puts Person.get('Remy').age                   # => 11      (from Jiak server)
 
 callie = Person.new(:name => 'Callie', :age => 13)
 remy.link(callie,'sister')

data/examples/bucket_schemas.rb

@@ -0,0 +1,36 @@
+require 'riakrest'
+include RiakRest
+
+DogData = JiakDataHash.create(:name,:age,:breeds)
+
+# client = JiakClient.new("http://localhost:8002/jiak",:proxy=>"http://localhost:8888")
+client = JiakClient.new("http://localhost:8002/jiak")
+bucket = JiakBucket.new("dogs", DogData)
+chili = JiakObject.new(:bucket => bucket,
+                       :key => 'chili',
+                       :data => DogData.new(:name => "Chili",
+                                            :age => 6,
+                                            :breeds => ["heeler","akita"]))
+client.set_schema(bucket)
+client.store(chili)
+chili = client.get(bucket,'chili')
+
+DogData.readable(:name,:breeds)
+DogData.writable(:name,:age)
+client.set_schema(bucket)
+chili = client.get(bucket,'chili')
+diego = JiakObject.new(:bucket => bucket,
+                       :key => "diego",
+                       :data => DogData.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/rest_interaction.rb

@@ -0,0 +1,51 @@
+require 'riakrest'
+include RiakRest
+
+DogData = JiakDataHash.create(:name,:age,:breeds)
+# client = JiakClient.new("http://localhost:8002/jiak",:proxy=>"http://localhost:8888")
+client = JiakClient.new("http://localhost:8002/jiak")
+bucket = JiakBucket.new("dogs", DogData)
+
+chili = JiakObject.new(:bucket => bucket,
+                       :key => 'chili',
+                       :data => DogData.new(:name => "Chili",
+                                            :age => 6,
+                                            :breeds => ["heeler","akita"]))
+client.store(chili)
+
+diego = JiakObject.new(:bucket => bucket,
+                       :data => DogData.new(:name => "Diego",
+                                            :age => 7,
+                                            :breeds => ["pure mutt"]))
+key = client.store(diego)
+
+chili = client.get(bucket,'chili')
+diego = client.get(bucket,key)
+
+addie = JiakObject.new(:bucket => bucket,
+                       :key => 'addie',
+                       :data => DogData.new(:name => "Adelaide",
+                                            :age => 14,
+                                            :breeds => ["heeler"]))
+client.store(addie)                     # Store addie
+addie.data.age = 15                     # Whoops, fix her age
+client.store(addie)                     # Store that update
+db_addie = client.get(bucket,'addie')   # Get what we stored
+puts db_addie.data.age                  # =>  14 !??  Not 15??
+
+strass = JiakObject.new(:bucket => bucket,
+                        :key => 'strass',
+                        :data => DogData.new(:name => "Cauchy Euler Weierstrass",
+                                             :age => 5,
+                                             :breeds => ["schnauzer","mutt"]))
+strass = client.store(strass,:return => :object)
+strass.data.age = 6
+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)}
+

data/lib/riakrest/core/jiak_client.rb

@@ -30,6 +30,7 @@ module RiakRest
     # Raise JiakClientException if server or proxy (if exists) URI are not strings.
     #
     def initialize(uri='http://127.0.0.1:8002/jiak/', opts={})
+      check_opts(opts,[:proxy],JiakClientException)
       server(uri)
       proxy(opts[:proxy])   if(opts[:proxy])
     end
@@ -78,7 +79,6 @@ module RiakRest
       resp = RestClient.put(jiak_uri(bucket),
                             bucket.schema.to_jiak,
                             :content_type => APP_JSON,
-                            :data_type => JSON_DATA,
                             :accept => APP_JSON)
     end
 
@@ -113,7 +113,7 @@ module RiakRest
     # stored JiakObject depending on the option <code>key</code>. The object
     # for storage must be JiakObject. Valid options are:
     #
-    # <code>:object</code> :: If <code>true</code>, on success return the stored JiakObject (which includes Jiak metadata); otherwise return just the key. Default is <code>false</code>, which returns the key.
+    # <code>:return</code> :: If <code>:key</code>, return the key under which the data was stored. If <code>:object</code> return the stored JiakObject (which includes Riak context). Defaults to <code>:key</code>.
     # <code>:writes</code> :: The number of Riak nodes that must successfully store the data.
     # <code>:durable_writes</code> :: The number of Riak nodes (<code>< writes</code>) that must successfully store the data in a durable manner.
     # <code>:reads</code> :: The number of Riak nodes that must successfully read data if a JiakObject is being returned.
@@ -128,20 +128,21 @@ module RiakRest
     # Raise JiakResourceException on RESTful HTTP errors.
     #
     def store(jobj,opts={})
+      check_opts(opts,[:return,:reads,:writes,:durable_writes],
+                 JiakClientException)
       params = jobj.bucket.params
       req_params = {
         WRITES => opts[:writes] || params[:writes], 
         DURABLE_WRITES => opts[:durable_writes] || params[:durable_writes],
         READS => opts[:reads] || params[:reads]
       }
-      req_params[RETURN_BODY] = opts[:object]  if opts[:object]
+      req_params[RETURN_BODY] = (opts[:return] == :object)
 
       begin
         uri = jiak_uri(jobj.bucket,jobj.key,req_params)
         payload = jobj.to_jiak
         headers = { 
           :content_type => APP_JSON,
-          :data_type => JSON_DATA,
           :accept => APP_JSON }
         # Decision tree:
         #   If key empty POST
@@ -201,6 +202,7 @@ module RiakRest
       unless bucket.is_a?(JiakBucket)
         raise JiakClientException, "Bucket must be a JiakBucket."
       end
+      check_opts(opts,[:reads],JiakClientException)
       req_params = {READS => opts[:reads] || bucket.params[:reads]}
 
       begin
@@ -229,6 +231,7 @@ module RiakRest
     # Raise JiakResourceException on RESTful HTTP errors.
     #
     def delete(bucket,key,opts={})
+      check_opts(opts,[:waits],JiakClientException)
       begin
         req_params = {RESPONSE_WAITS => opts[:waits] || bucket.params[:waits]}
         uri = jiak_uri(bucket,key,req_params)

data/lib/riakrest/core/jiak_object.rb

@@ -27,7 +27,7 @@ module RiakRest
     # altered and are purposely not described here.
     def initialize(opts)
       opts[:links] ||= []
-      check_opts(opts)
+      check_opts(opts,VALID_OPTS,JiakObjectException)
 
       @bucket = check_bucket(opts[:bucket])
       @data = check_data(opts[:data])
@@ -36,7 +36,7 @@ module RiakRest
 
       # The Riak context for the object if provided.
       if opts[:vclock]
-        @riak = opts.select {|k,v| [:vclock,:vtag,:lastmod].include?(k)}
+        @riak = {}.merge(opts)
       end
     end
 
@@ -127,9 +127,20 @@ module RiakRest
     # :call-seq:
     #   jiak_object.riak = riak
     #
-    # Set the Riak context for a JiakObject.
+    # Set the Riak context for a JiakObject. This is a public method due to
+    # implementation needs, but in general should not be called by library
+    # clients.
     def riak=(riak)
-      @riak = check_riak(riak)
+      @riak = riak.nil? ? nil : check_opts(riak,VALID_RIAK,JiakObjectException)
+    end
+
+    # :call-seq:
+    #   local? -> true or false
+    #
+    # <code>true</code> if a JiakObject is local only, i.e., has not been
+    # stored via the Jiak server.
+    def local?
+      @riak.nil?
     end
 
     # :call-seq:
@@ -141,7 +152,8 @@ module RiakRest
       (@bucket == other.bucket &&
        @key == other.key &&
        @data == other.data &&
-       @links == other.links
+       @links == other.links &&
+       @riak.nil? == other.riak.nil?
        ) rescue false
     end
 
@@ -155,22 +167,14 @@ module RiakRest
         @bucket.eql?(other.bucket) &&
         @key.eql?(other.key) &&
         @data.eql?(other.data) &&
-        @links.eql?(other.links)
+        @links.eql?(other.links) &&
+        @riak.nil?.eql?(other.riak.nil?)
     end
 
     def hash    # :nodoc:
       @bucket.name.hash + @key.hash + @data.hash + @links.hash + @riak.hash
     end
 
-    def check_opts(opts)
-      err = opts.select {|k,v| !VALID_OPTS.include?(k)}
-      unless err.empty?
-        raise JiakObjectException, "unrecognized options: #{err.keys}"
-      end
-      opts
-    end
-    private :check_opts
-
     def check_bucket(bucket)
       unless bucket.is_a?(JiakBucket)
         raise JiakObjectException, "Bucket must be a JiakBucket."
@@ -217,14 +221,6 @@ module RiakRest
     end
     private :check_link
 
-    def check_riak(riak)
-      err = riak.select {|k,v| !VALID_RIAK.include?(k)}
-      unless err.empty?
-        raise JiakObjectException, "unrecognized options: #{err.keys}"
-      end
-      riak
-    end
-
     private
     VALID_RIAK = [:vclock,:vtag,:lastmod]
     VALID_OPTS = [:bucket,:key,:data,:links] + VALID_RIAK

data/lib/riakrest/resource/jiak_resource.rb

@@ -274,7 +274,7 @@ module RiakRest
       # JiakResource class, then to the value set on the Riak cluster. In
       # general the values set on the Riak cluster should suffice.
       def put(resource,opts={})
-        opts[:object] = true
+        opts[:return] = :object
         resource.jiak.object = jiak.server.store(resource.jiak.object,opts)
         resource.convenient_jiak
         resource
@@ -633,7 +633,7 @@ module RiakRest
     # post/put to the Jiak server. This test is used in the guards for class
     # and instance level post/update methods.
     def local?
-      jiak.object.riak.nil?
+      jiak.object.local?
     end
 
     # :call-seq:

data/lib/riakrest.rb

@@ -136,6 +136,17 @@ $:.unshift(dirname) unless
 module RiakRest
   version_file = File.join(File.dirname(__FILE__),"..","VERSION")
   VERSION = IO.read(version_file).chomp
+
+  # Convenience method for checking validity of method options. If any of the
+  # options in opt are not in valid, raise the exception with the invalid
+  # options in the message.
+  def check_opts(opts,valid,exception)
+    err = opts.select {|k,v| !valid.include?(k)}
+    unless err.empty?
+      raise exception, "unrecognized options: #{err.keys}"
+    end
+    opts
+  end
 end
 
 require 'riakrest/core/exceptions'

data/spec/core/jiak_client_spec.rb

@@ -152,17 +152,21 @@ describe "JiakClient processing" do
       it "should return a JiakObject at time of storage" do
         key = 'store_key_2'
         jobj = JiakObject.new(:bucket => @bucket, :key => key, :data => @data)
-        resp = @client.store(jobj,{:object => true})
+        resp = @client.store(jobj,{:return => :object})
         resp.should be_a JiakObject
         resp.bucket.should eql @bucket
         resp.key.should eql key
         resp.data.should be_a FooBarBaz
 
         jobj = JiakObject.new(:bucket => @bucket, :data => @data)
-        resp = @client.store(jobj,{:object => true})
+        jobj.local?.should be true
+        resp = @client.store(jobj,{:return => :object})
         resp.should be_a JiakObject
         resp.key.should_not be_nil
         resp.data.should be_a FooBarBaz
+
+        jobj.local?.should be true
+        resp.local?.should be false
       end
       
       it "should handle odd key values" do
@@ -201,7 +205,7 @@ describe "JiakClient processing" do
       it "should update a previously stored JiakObject" do
         jobj =
           @client.store(JiakObject.new(:bucket => @bucket, :data => @data),
-                        {:object => true})
+                        {:return => :object})
         
         jobj.data.should eql @data
         [:vclock,:vtag,:lastmod].each do |field|
@@ -213,7 +217,7 @@ describe "JiakClient processing" do
         updated_data = FooBarBaz.new(:foo => 'new val')
         jobj.data = updated_data
         updated_object = 
-          @client.store(jobj,{:object => true})
+          @client.store(jobj,{:return => :object})
         updated_data = updated_object.data
         updated_data.should_not eql @data
         updated_data.foo.should eql 'new val'
@@ -276,7 +280,7 @@ describe "JiakClient links" do
       p_obj = JiakObject.new(:bucket => @p_bucket,
                              :key => p_name,
                              :data => p_data)
-      parent = @client.store(p_obj,:object => true)
+      parent = @client.store(p_obj,:return => :object)
       p_link = JiakLink.new(@p_bucket,parent.key,'parent')
       c_names.each do |c_name|
         begin
@@ -286,7 +290,7 @@ describe "JiakClient links" do
           c_obj = JiakObject.new(:bucket => @c_bucket,
                                  :key => c_name,
                                  :data => c_data)
-          child = @client.store(c_obj, :object => true)
+          child = @client.store(c_obj, :return => :object)
         end
         c_link = JiakLink.new(@c_bucket,child.key,'child')
         child << p_link

data/spec/core/jiak_object_spec.rb

@@ -37,6 +37,7 @@ describe "JiakObject" do
     @object.should respond_to(:data,:data=)
     @object.should respond_to(:links,:links=)
     @object.should respond_to(:riak,:riak=)
+    @object.should respond_to(:local?)
     @object.should respond_to(:<<)
     @object.should respond_to(:==,:eql?)
     @object.should respond_to(:to_jiak)
@@ -53,6 +54,7 @@ describe "JiakObject" do
     jobj = JiakObject.new(:bucket => @bucket, :key => @key, :data => @data)
     jobj.bucket.should eql @bucket
     jobj.links.should be_empty
+    jobj.local?.should be true
   end
 
   it "should allow nil, missing, blank or empty key" do
@@ -159,6 +161,9 @@ describe "JiakObject" do
     @object.riak = riak
     @object.riak.should eql riak
 
+    @object.riak = nil
+    @object.riak.should be nil
+
     bad_bucket = lambda {@object.bucket = 'bucket'}
     bad_bucket.should raise_error(JiakObjectException,/Bucket/)
 

data/spec/resource/jiak_resource_spec.rb

@@ -4,11 +4,11 @@ describe "JiakResource default" do
   F1F2 = JiakDataHash.create(:f1,:f2)
   class Rsrc           # :nodoc:
     include JiakResource
-    server       'http://localhost:8002/jiak/'
-    group        'group'
-    data_class   F1F2
+    server        'http://localhost:8002/jiak/'
+    group         'group'
+    data_class    F1F2
+    point_of_view
   end
-  Rsrc.pov
 
   before do
     @server = 'http://localhost:8002/jiak/'
@@ -111,11 +111,11 @@ describe "JiakResource default class-level auto-post/auto-update" do
   PersonData.keygen :name
   class Person           # :nodoc:
     include JiakResource
-    server       'http://localhost:8002/jiak'
-    group        'people'
-    data_class   PersonData
+    server         'http://localhost:8002/jiak'
+    group          'people'
+    data_class     PersonData
+    point_of_view
   end
-  Person.pov
 
   before do
     @name = 'p default'
@@ -162,11 +162,11 @@ describe "JiakResource class auto-post" do
   PersonData.keygen :name
   class Person           # :nodoc:
     include JiakResource
-    server       'http://localhost:8002/jiak'
-    group        'people'
-    data_class   PersonData
+    server         'http://localhost:8002/jiak'
+    group          'people'
+    data_class     PersonData
+    point_of_view
   end
-  Person.pov
 
   before do
     @name = 'p auto-post'
@@ -242,13 +242,13 @@ describe "JiakResource class auto-update" do
   DogData.keygen :name
   class Dog           # :nodoc:
     include JiakResource
-    server       'http://localhost:8002/jiak'
-    group        'dogs'
-    data_class   DogData
-    auto_post    true
-    auto_update  true
+    server         'http://localhost:8002/jiak'
+    group          'dogs'
+    data_class     DogData
+    point_of_view
+    auto_post      true
+    auto_update    true
   end
-  Dog.pov
 
   before do
     @pname = 'p auto-update'
@@ -339,13 +339,13 @@ describe "JiakResource simple" do
   DogData.keygen :name
   class Dog           # :nodoc:
     include JiakResource
-    server       'http://localhost:8002/jiak'
-    group        'dogs'
-    data_class   DogData
-    auto_post    true
-    auto_update  true
+    server         'http://localhost:8002/jiak'
+    group          'dogs'
+    data_class     DogData
+    point_of_view
+    auto_post      true
+    auto_update    true
   end
-  Dog.pov
 
   before do
     @pname = 'p'
@@ -404,11 +404,11 @@ describe "JiakResource complex" do
   class Parent           # :nodoc:
     include JiakResource
     
-    server      'http://localhost:8002/jiak'
-    group       'parents'
-    data_class  PersonData
+    server        'http://localhost:8002/jiak'
+    group         'parents'
+    data_class    PersonData
+    point_of_view
   end
-  Parent.pov
 
   Child = Parent.copy(:group => 'children')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riakrest
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Paul Rogers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-03 00:00:00 -08:00
+date: 2009-11-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -133,7 +133,9 @@ test_files:
 - examples/auto_update_links.rb
 - examples/basic_client.rb
 - examples/basic_resource.rb
+- examples/bucket_schemas.rb
 - examples/linked_resources.rb
 - examples/links_only_pov.rb
 - examples/multiple_pov.rb
+- examples/rest_interaction.rb
 - examples/ruby_json_data.rb