riakrest 0.1.5 → 0.1.6

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.6 2009-12-17
+  - Add method for specifying data conversion in JiakData and JiakResouce.
+  - Add testing and examples for data conversion.
+
 === 0.1.5 2009-12-11
   - Added POV processing.
   - Refactored jattr_* to attr_*.

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/examples/jiak_client.data.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/example_helper.rb'
+require 'date'
+
+# JiakData class with a couple of attributes, one of which requires conversion
+class DateData
+  include JiakData
+  attr_accessor :name, :date
+  convert :date => lambda{|value| Date.parse(value)}
+end
+
+client = JiakClient.new(SERVER_URI)
+bucket = JiakBucket.new('date data',DateData)
+
+# Leap data date is a Data object
+leap_2008 = DateData.new(:name => "Leap 2008", 
+                         :date => Date.new(2008,02,29))
+leap_obj = client.store(JiakObject.new(:bucket => bucket,
+                                       :data => leap_2008),
+                        :return => :object)
+puts leap_obj.data.date.inspect                 # => #<Date: 2008-02-29 (etc.)>
+
+# Clean-up stored object
+client.delete(bucket,leap_obj.key)
+
+
+# It is also possible to use Ruby JSON processing to achieve a similar result;
+# however, this is not optimal as the stored Riak data value contains
+# Ruby-secific information which may be undesirable to non-Ruby consumers of
+# that data.
+
+# Instrument the Ruby Date class for round-trip JSON processing.
+class Date
+  def to_json(*args)
+    { 'json_class' => self.class.name,
+      'date' => to_s
+    }.to_json(*args)
+  end
+  def self.json_create(hash)
+    parse(hash['date'])
+  end
+end
+
+class DateData2
+  include JiakData
+  attr_accessor :name, :date
+end
+
+bucket = JiakBucket.new('date data',DateData2)
+
+leap_2012 = DateData2.new(:name => "Leap 2012", 
+                          :date => Date.new(2012,02,29))
+leap_obj = client.store(JiakObject.new(:bucket => bucket,
+                                       :data => leap_2012),
+                        :return => :object)
+puts leap_obj.data.date.inspect                 # => #<Date: 2012-02-29 (etc.)>
+
+# JSON payload: 
+#  leap_2008 : {"name":"leap","date":"2008-02-29"}
+#  leap_2012 : {"name":"leap","date":{"json_class":"Date","date":"2012-02-29"}}
+
+# Clean-up stored object
+client.delete(bucket,leap_obj.key)

data/examples/jiak_resource_data.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/example_helper.rb'
+require 'date'
+
+# JiakResource with a couple of attributes, one of which requires conversion
+class Person
+  include JiakResource
+  server SERVER_URI
+  attr_accessor :name, :birthdate
+  convert :birthdate => lambda{|value| Date.parse(value)}
+  keygen {name.downcase}
+
+  def age
+    now = DateTime.now
+    age = now.year - birthdate.year
+    age -= 1 if(now.yday < birthdate.yday)
+    age
+  end
+end
+
+# Create and post resource, showing birthdate is a Date before and after post.
+remy = Person.new(:name => 'Remy',:birthdate => Date.new(1999,06,26))
+puts remy.birthdate.inspect                     # => #<Date: 1999-06-26 (etc.)>
+puts remy.age                                   # => current age
+remy.post
+puts remy.birthdate.inspect                     # => #<Date: 1999-06-26 (etc.)>
+puts remy.age                                   # => current age
+
+remy.delete
+

data/lib/riakrest/core/jiak_client.rb

@@ -105,7 +105,7 @@ module RiakRest
     # <code>delete</code> requests take precendence over the setting maintained
     # by a JiakClient. Any request parameter not set in JiakClient or on an
     # individual request will default to the values set in the Riak cluster.
-    # 
+    #
     def initialize(uri, opts={})
       check_opts(opts,CLIENT_PARAMS,JiakClientException)
       self.server = uri
@@ -263,7 +263,7 @@ module RiakRest
     def store(jobj,opts={})
       check_opts(opts,STORE_PARAMS,JiakClientException)
       req_params = {
-        WRITES => opts[:writes] || @params[:writes], 
+        WRITES => opts[:writes] || @params[:writes],
         DURABLE_WRITES => opts[:durable_writes] || @params[:durable_writes],
         COPY => opts[:copy]
       }
@@ -292,7 +292,7 @@ module RiakRest
         else
           resp = RestClient.put(uri,payload,headers)
         end
-        
+
         if(req_params[RETURN_BODY])
           JiakObject.jiak_create(JSON.parse(resp),jobj.bucket.data_class)
         elsif(key_empty)
@@ -301,12 +301,14 @@ module RiakRest
           jobj.key
         end
       rescue RestClient::ExceptionWithResponse => err
-        fail_with_response("put", err)
+        JiakClient.fail_with_response("store", err)
       rescue RestClient::Exception => err
-        fail_with_message("put", err)
+        JiakClient.fail_with_message("store", err)
+      rescue Errno::ECONNREFUSED => err
+        JiakClient.fail_connection("store", err)
       end
     end
-    
+
     # :call-seq:
     #   get(bucket,key,opts={})  -> JiakObject
     #
@@ -348,9 +350,11 @@ module RiakRest
       rescue RestClient::ResourceNotFound => err
         raise JiakResourceNotFound, "failed get: #{err.message}"
       rescue RestClient::ExceptionWithResponse => err
-        fail_with_response("get", err)
+        JiakClient.fail_with_response("get", err)
       rescue RestClient::Exception => err
-        fail_with_message("get",err)
+        JiakClient.fail_with_message("get",err)
+      rescue Errno::ECONNREFUSED => err
+        JiakClient.fail_connection("get", err)
       end
     end
 
@@ -372,9 +376,11 @@ module RiakRest
         RestClient.delete(uri,:accept => APP_JSON)
         true
       rescue RestClient::ExceptionWithResponse => err
-        fail_with_response("delete", err)
+        JiakClient.fail_with_response("delete", err)
       rescue RestClient::Exception => err
-        fail_with_message("delete", err)
+        JiakClient.fail_with_message("delete", err)
+      rescue Errno::ECONNREFUSED => err
+        JiakClient.fail_connection("delete", err)
       end
     end
 
@@ -389,8 +395,8 @@ module RiakRest
         true
       rescue RestClient::ResourceNotFound
         false
-      rescue RestClient::Exception => err
-        fail_with_message("delete", err)
+      rescue Errno::ECONNREFUSED => err
+        JiakClient.fail_connection("exist?", err)
       end
     end
 
@@ -425,9 +431,11 @@ module RiakRest
           JiakObject.jiak_create(jiak,data_class)
         end
       rescue RestClient::ExceptionWithResponse => err
-        fail_with_response("put", err)
+        JiakClient.fail_with_response("walk", err)
       rescue RestClient::Exception => err
-        fail_with_message("put", err)
+        JiakClient.fail_with_message("walk", err)
+      rescue Errno::ECONNREFUSED => err
+        JiakClient.fail_connection("walk", err)
       end
     end
 
@@ -438,7 +446,7 @@ module RiakRest
     def ==(other)
       (@server == other.server) rescue false
     end
-    
+
     # :call-seq:
     #    eql?(other) -> true or false
     #
@@ -453,6 +461,8 @@ module RiakRest
       @server.hash
     end
 
+    # :stopdoc:
+
     # Build the URI for accessing the Jiak server.
     def jiak_uri(bucket,key="")
       bucket_name = bucket.is_a?(JiakBucket) ? bucket.name : bucket
@@ -472,7 +482,7 @@ module RiakRest
       qstring
     end
     private :jiak_qstring
-    
+
     # Get either the schema or keys for the bucket.
     def bucket_info(bucket,info)
       ignore = (info == SCHEMA) ? KEYS : SCHEMA
@@ -480,23 +490,30 @@ module RiakRest
         uri = jiak_uri(bucket,"") << jiak_qstring({ignore => false})
         JSON.parse(RestClient.get(uri, :accept => APP_JSON))[info]
       rescue RestClient::ExceptionWithResponse => err
-        fail_with_response("get", err)
+        JiakClient.fail_with_response("info", err)
       rescue RestClient::Exception => err
-        fail_with_message("get", err)
+        JiakClient.fail_with_message("info", err)
+      rescue Errno::ECONNREFUSED => err
+        JiakClient.fail_connection("info", err)
       end
     end
     private :bucket_info
 
-    def fail_with_response(action,err)
-      raise( JiakResourceException,
-             "failed #{action}: HTTP code #{err.http_code}: #{err.http_body}")
+    def self.fail_with_response(action,err)
+      raise(JiakResourceException,
+            "failed #{action}: HTTP code #{err.http_code}: #{err.http_body}")
     end
-    private :fail_with_response
 
-    def fail_with_message(action,err)
+    def self.fail_with_message(action,err)
       raise JiakResourceException, "failed #{action}: #{err.message}"
     end
-    private :fail_with_message
+
+    def self.fail_connection(action,err)
+      raise(JiakClientException,
+            "failed #{action}: Connection refused for server #{@server}")
+    end
+
+    # :startdoc:
 
   end
 

data/lib/riakrest/core/jiak_data.rb

@@ -47,9 +47,9 @@ module RiakRest
     # ----------------------------------------------------------------------
     #   Class methods
     # ----------------------------------------------------------------------
-    
+
     # Class methods for use in creating a user-defined JiakData. The methods
-    # <code>allow, require, readable, writable</code> delegate to JiakSchema. 
+    # <code>allow, require, readable, writable</code> delegate to JiakSchema.
     # See JiakSchema for discussion on the use of schemas in Riak.
     module ClassMethods
 
@@ -148,7 +148,7 @@ module RiakRest
         added_fields = @schema.send(method,*fields)
         added_allowed = @schema.allowed_fields - prev_allowed
         # added_allowed.each {|field| attr_accessor field}
-        added_allowed.each do |field| 
+        added_allowed.each do |field|
           class_eval <<-EOH
             def #{field}
               @#{field}
@@ -161,7 +161,7 @@ module RiakRest
         added_fields
       end
       private :expand_schema
-      
+
       # :call-seq:
       #   JiakData.schema  -> JiakSchema
       #
@@ -173,7 +173,7 @@ module RiakRest
       # :call-seq:
       #   JiakData.keygen(&block)  -> nil
       #
-      # Define the key generation for an instance of the created JiakData
+      # Specify the key generation for an instance of the created JiakData
       # class. Key generation will call the specified block in the scope of the
       # current instance.
       def keygen(&block)
@@ -181,26 +181,33 @@ module RiakRest
       end
 
       # :call-seq:
-      #  JiakData.jiak_create(jiak)  -> JiakData
-      #
-      # Create an instance of user-defined data object from the fields read
-      # by Jiak. These fields are determined by the read mask of the
-      # structured Jiak interaction. See JiakSchema for read mask discussion.
+      #   JiakData.convert(hash)  -> nil
       #
-      # User-defined data classes must either override this method explicitly
-      # or use the <code>attr_*</code> methods which implicitly override this
-      # method. The method is automatically called to marshall data from
-      # Jiak. You do not call this method explicitly.
+      # Specify a hash of optional Procs for converting the data values stored
+      # in Riak during the process of inflating returned Riak data into Ruby
+      # objects. The hash values should be Procs used to convert the data
+      # attribute specified by the hash key. The Procs must accept one
+      # argument, the data value actually stored in Riak. The converted result
+      # will be the actual value of the data field inside the inflated Ruby
+      # object.
       #
       # ====Example
-      #  def initialize(f1,f2)
-      #    @f1 = f1
-      #    @f2 = f2
-      #  end
-      #  def jiak_create(jiak)
-      #    new(jiak['f1'], jiak['f2'])
-      #  end
-      def jiak_create(jiak)
+      # def PersonData
+      #   include JiakData
+      #   attr_accessor :name, :birthdate
+      #   convert :birthdate => lambda {|val| Date.parse(val)}
+      # end
+      def convert(hash)
+        @converter ||= {}
+        hash.each {|k,blk| @converter[k.to_s] = blk}
+      end
+
+      # Use optional converters to convert returned data values before passing
+      # to the JiakData constructor.
+      def jiak_create(jiak)     # :nodoc:
+        unless(@converter.nil?)
+          @converter.each {|k,blk| jiak[k] = blk.call(jiak[k])}
+        end
         new(jiak)
       end
 
@@ -235,7 +242,7 @@ module RiakRest
         end
       end
     end
-    
+
     # ----------------------------------------------------------------------
     #   Instance methods
     # ----------------------------------------------------------------------
@@ -244,34 +251,6 @@ module RiakRest
       hash.each {|k,v| instance_variable_set("@#{k}", v)}
     end
 
-    # :call-seq:
-    #   to_jiak  -> hash
-    #
-    # Provide a hash structure of the data to write to Jiak. The fields for
-    # this structure should come from the JiakData write mask. See JiakSchema
-    # for shema discussion.
-    #
-    # User-defined data classes must either override this method explicitly or
-    # use the <code>attr_*</code> methods which implicitly provide an implicit
-    # override. The method is automatically called to marshall data to
-    # Jiak. You do not call this method explicitly.
-
-    # Data classes that do not used the attr_* methods to specify attributes
-    # must override this method. 
-    #
-    # ====Example
-    #  def to_jiak
-    #    { :writable_f1 => @writable_f1,
-    #      :writable_f2 => @writable_f2
-    #    }
-    #  end
-    def to_jiak
-      self.class.schema.write_mask.inject({}) do |build,field|
-        build[field] = send("#{field}")
-        build
-      end
-    end
-
     # :call-seq:
     #   keygen   -> string
     #

data/lib/riakrest/resource/jiak_resource.rb

@@ -125,7 +125,7 @@ module RiakRest
       private :check_fields
 
       # :call-seq:
-      #   keygen(&block)
+      #   JiakResource.keygen(&block)
       #
       # Specify the block for generating keys for a JiakResource instance.
       def keygen(&block)
@@ -134,6 +134,20 @@ module RiakRest
         EOS
       end
 
+      # :call-seq:
+      #   JiakResource.convert(hash)
+      #
+      # Specify a hash of optional Procs for converting the data values stored
+      # in Riak during the process of inflating returned Riak data into
+      # JiakResource objects. The hash values should be Procs used to convert
+      # the data attribute specified by the hash key. The Procs must accept one
+      # argument, the data value actually stored in Riak. The converted result
+      # will be the actual value of the data field inside the inflated
+      # JiakResource.
+      def convert(hash)
+        jiak.data.convert(hash)
+      end
+
       # :call-seq:
       #   JiakResource.params(opts={})  -> hash
       #

data/spec/core/jiak_client_spec.rb

@@ -2,12 +2,23 @@ require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 class FooBarBaz  # :nodoc:
   include JiakData
-
   attr_accessor :foo, :bar
   require :foo
   allow   :baz
 end
 
+require 'date'
+class DateData
+  include JiakData
+  attr_accessor :name, :date
+  convert :date => lambda { |v| Date.parse(v) }
+end
+
+class PersonData
+  include JiakData
+  attr_accessor :name
+end
+
 describe "JiakClient" do
   before do
     @base_uri = SERVER_URI
@@ -67,7 +78,7 @@ describe "JiakClient" do
 
     no_no = lambda {JiakClient::KEYS << 'a'}
     no_no.should raise_error(StandardError,/frozen/)
-    
+
     no_no = lambda {JiakClient::SCHEMA << 'a'}
     no_no.should raise_error(StandardError,/frozen/)
   end
@@ -97,7 +108,7 @@ describe "JiakClient" do
     client.proxy.should eql 'proxy_uri'
     client.params.should have_exactly(4).items
     @params.each {|k,v| client.params[k].should == @params[k]}
-    
+
     @opts.delete(:proxy)
     @opts.delete(:writes)
     client = JiakClient.new(@base_uri,@opts)
@@ -126,13 +137,41 @@ describe "JiakClient" do
 
     bad_opts = lambda {@client.set_params(:junk => 'junk')}
     bad_opts.should raise_error(JiakClientException,/option/)
-    
+
     @params[:junk] = 'junk'
     bad_opts = lambda {@client.params = @params}
     bad_opts.should raise_error(JiakClientException,/option/)
   end
 end
 
+describe "JiakClient connection" do
+  before do
+    @client = JiakClient.new("http://localhost:9999/jiak/")
+    @data = FooBarBaz.new(:foo => 'Foo',:bar => 'Bar')
+    @bucket = JiakBucket.new('actions_bucket',FooBarBaz)
+  end
+
+  it "should report refused errors" do
+    client = JiakClient.new("http://localhost:9999/jiak/")
+    data = FooBarBaz.new(:foo => 'Foo',:bar => 'Bar')
+    bucket = JiakBucket.new('actions_bucket',FooBarBaz)
+    key = 'key'
+    jobj = JiakObject.new(:bucket => bucket, :key => key, :data => data)
+    qlink = QueryLink.new(bucket,'tag',nil)
+
+    [lambda {client.keys(bucket)},
+     lambda {client.schema(bucket)},
+     lambda {client.store(jobj)},
+     lambda {client.get(bucket,key)},
+     lambda {client.exist?(bucket,key)},
+     lambda {client.delete(bucket,key)},
+     lambda {client.walk(bucket,'tag',qlink,FooBarBaz)}
+    ].each do |bad_req|
+      bad_req.should raise_error(JiakClientException,/Connection refused/)
+    end
+  end
+end
+
 describe "JiakClient URI handling" do
   before do
     @base_uri = SERVER_URI
@@ -174,7 +213,7 @@ describe "JiakClient processing" do
 
     it "should set and fetch a bucket schema" do
       schema = @client.schema(@bucket)
-      
+
       ['allowed_fields',
        'required_fields',
        'read_mask',
@@ -188,7 +227,7 @@ describe "JiakClient processing" do
     it "should update an existing bucket schema" do
       FooBarBazBuz = JiakDataFields.create(:foo,:bar,:baz,:buz)
       @client.set_schema(JiakBucket.new(@bucket_name,FooBarBazBuz))
-      
+
       resp_schema = @client.schema(@bucket)
       resp_schema.allowed_fields.should include :buz
       resp_schema.required_fields.should be_empty
@@ -263,7 +302,7 @@ describe "JiakClient processing" do
         jobj.local?.should be true
         resp.local?.should be false
       end
-      
+
       it "should handle odd key values" do
         key = '$ p @ c #'
         jobj = JiakObject.new(:bucket => @bucket, :key => key, :data => @data)
@@ -276,7 +315,7 @@ describe "JiakClient processing" do
       it "should check for resource existence" do
         jobj = JiakObject.new(:bucket => @bucket, :data => @data)
         key = @client.store(jobj)
-        
+
         @client.exist?(@bucket,key).should be true
         @client.exist?(@bucket,'nope').should be false
       end
@@ -297,10 +336,25 @@ describe "JiakClient processing" do
         fetched.should be_a JiakObject
       end
 
+      it "should optionally convert data values" do
+        bucket = JiakBucket.new('date data',DateData)
+        name = 'leap'
+        date = Date.new(2004,02,29)
+        jobj = JiakObject.new(:bucket => bucket,
+                              :data => DateData.new(:name => name,
+                                                    :date => date))
+        jobj.data.name.should eql name
+        jobj.data.date.should eql date
+
+        jobj = @client.store(jobj, :return => :object)
+        jobj.data.name.should eql name
+        jobj.data.date.should eql date
+      end
+
       it "should accept write and read parameters" do
         key = 'fetch_key_wr'
         jobj = JiakObject.new(:bucket => @bucket, :key => key, :data => @data)
-        jobj = @client.store(jobj, 
+        jobj = @client.store(jobj,
                              :writes => 3, :reads => 3,
                              :return => :object)
 
@@ -318,7 +372,7 @@ describe "JiakClient processing" do
         jobj =
           @client.store(JiakObject.new(:bucket => @bucket, :data => @data),
                         {:return => :object})
-        
+
         jobj.data.should eql @data
         [:vclock,:vtag,:lastmod].each do |field|
           jobj.riak.should include field
@@ -328,7 +382,7 @@ describe "JiakClient processing" do
 
         updated_data = FooBarBaz.new(:foo => 'new val')
         jobj.data = updated_data
-        updated_object = 
+        updated_object =
           @client.store(jobj,{:return => :object})
         updated_data = updated_object.data
         updated_data.should_not eql @data
@@ -353,11 +407,6 @@ describe "JiakClient processing" do
 
 end
 
-class PersonData
-  include JiakData
-  attr_accessor :name
-end
-
 describe "JiakClient links" do
   before do
     @base_uri = SERVER_URI
@@ -440,7 +489,7 @@ describe "JiakClient links" do
         child.links.should include p_link
       end
     end
-    
+
     # p's should include links to their c's
     c_link = QueryLink.new(@c_bucket,'child',nil)
     parent_children.each do |p_name,children|

data/spec/resource/jiak_resource_spec.rb

@@ -318,6 +318,31 @@ describe "JiakResource class auto-update" do
 
 end
 
+describe "JiakResource data conversion" do
+  require 'date'
+  class DogDate           # :nodoc:
+    include JiakResource
+    server         SERVER_URI
+    group          'dogs'
+    attr_accessor  :name, :birthdate
+    convert :birthdate => lambda{|value| Date.parse(value)}
+    keygen { name }
+    auto_manage
+  end
+
+  it "should convert date data into a Date" do
+    name = 'Adelaide'
+    date = Date.new(1993,10,8)
+
+    addie = DogDate.new(:name => name, :birthdate => date)
+    addie.name.should eql name
+    addie.birthdate.should eql date
+
+    addie.delete
+  end
+
+end
+
 describe "JiakResource simple" do
   class Dog           # :nodoc:
     include JiakResource

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riakrest
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Paul Rogers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-11 00:00:00 -08:00
+date: 2009-12-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,8 @@ files:
 - examples/buoy.rb
 - examples/buoy_pov.rb
 - examples/example_helper.rb
+- examples/jiak_client.data.rb
+- examples/jiak_resource_data.rb
 - examples/linked_resources.rb
 - lib/riakrest.rb
 - lib/riakrest/core/exceptions.rb
@@ -167,4 +169,6 @@ test_files:
 - examples/buoy.rb
 - examples/buoy_pov.rb
 - examples/example_helper.rb
+- examples/jiak_client.data.rb
+- examples/jiak_resource_data.rb
 - examples/linked_resources.rb