riakrest 0.0.2 → 0.0.3

data/History.txt

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

data/README.rdoc

@@ -53,7 +53,7 @@ sudo gem install riakrest
   end
 
   remy = Person.new(:name => 'remy',:age => 10) #            (auto-post)
-  puts remy.name                                # => "remy"  (auto-update)
+  puts remy.name                                # => "remy"
 
   puts Person.get('remy').name                  # => "remy"  (from Jiak server)
   puts Person.get('remy').age                   # => 10      (from Jiak server)
@@ -62,9 +62,9 @@ sudo gem install riakrest
   puts Person.get('remy').age                   # => 11      (from Jiak server)
 
   callie = Person.new(:name => 'Callie', :age => 13)
-  remy.link(callie,'sister')
+  remy.link(callie,'sister')                    # link from remy to callie
 
-  sisters = remy.query(Person,'sister')
+  sisters = remy.query(Person,'sister')         # use link to get 'sister'
   puts sisters[0].eql?(callie)                  # => true
 
   remy.delete

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/examples/auto_update_data.rb

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 PersonData = JiakDataHash.create(:name,:age)

data/examples/auto_update_links.rb

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 PersonData = JiakDataHash.create(:name,:age)

data/examples/basic_client.rb

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 Person = JiakDataHash.create(:name,:age)

data/examples/basic_resource.rb

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 PersonData = JiakDataHash.create(:name,:age)

data/examples/{linked_resource.rb → linked_resources.rb}

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 PersonData = JiakDataHash.create(:name)
@@ -10,8 +10,6 @@ class Parent
   server      'http://localhost:8002/jiak'
   group       'parents'
   data_class  PersonData
-  auto_post   true
-  auto_update true
 end
 Child = Parent.copy(:group => 'children')
 
@@ -32,10 +30,6 @@ 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).post
   cnames.each do |cname|
@@ -50,10 +44,6 @@ parent_children.each do |pname,cnames|
   end
   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)}
@@ -84,6 +74,10 @@ c3sp = c3.query(Parent,'parent',Child,'child',Parent,'parent')
 c3p.each {|p| c3sp.delete_if{|sp| p.eql?(sp)}}
 puts c3sp[0].name                           # => "p1"
 
+# turn on auto-update at class level
+Parent.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)}
@@ -114,5 +108,6 @@ op = parents.inject([]) do |build,parent|
 end
 puts op[0].name                            # => 'p1'
 
+# clean-up by deleting everybody
 parents.each  {|p| p.delete}
 children.each {|c| c.delete}

data/examples/{multiple_resources.rb → multiple_pov.rb}

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 DogData = JiakDataHash.create(:name,:weight,:breed)
@@ -41,3 +41,4 @@ puts addie.name                 # => "adelaide"
 puts addie.breed                # => "Heeler"
 puts addie.weight               # => 47
 
+addie.delete

data/examples/{json_data_resource.rb → ruby_json_data.rb}

@@ -1,4 +1,4 @@
-require 'lib/riakrest'
+require 'riakrest'
 include RiakRest
 
 # CxINC Example doesn't do anything useful yet

data/lib/riakrest/core/jiak_client.rb

@@ -19,22 +19,50 @@ module RiakRest
     # :startdoc:
 
     # :call-seq:
-    #   JiakClient.new(uri)  -> uri
+    #   JiakClient.new(uri,opts={})  -> uri
     #
     # Create a new client for Riak RESTful (Jiak) interaction with the server at
-    # the specified URI.
+    # the specified URI. Go through a proxy if proxy option specified.
     #
-    # Raise JiakClientException if the server URI is not a string.
+    # Valid options:
+    #  <code>:proxy</code> Proxy server URI
     #
-    def initialize(uri='http://127.0.0.1:8002/jiak/')
+    # Raise JiakClientException if server or proxy (if exists) URI are not strings.
+    #
+    def initialize(uri='http://127.0.0.1:8002/jiak/', opts={})
+      server(uri)
+      proxy(opts[:proxy])   if(opts[:proxy])
+    end
+
+    # :call-seq:
+    #   server(uri)  -> string
+    #
+    # Set the Jiak server URI for the client.
+    #
+    # Raise JiakClientException if server URI is not string.
+    def server(uri)
       unless uri.is_a?(String)
-        raise JiakClientException, "Jiak server URI shoud be a String."
+        raise JiakClientException, "Jiak server URI should be a string."
       end
       @uri = uri
       @uri += '/' unless @uri.end_with?('/')
       @uri
     end
 
+    # :call-seq:
+    #   proxy(uri)  -> string
+    #
+    # Set Jiak interaction to go through a proxy.
+    #
+    # Raise JiakClientException if proxy URI is not string.
+    def proxy(uri)
+      unless uri.is_a?(String)
+        raise JiakClientException, "Proxy URI should be a string."
+      end
+      @proxy = uri
+      RestClient.proxy = uri
+    end
+
     # :call-seq:
     #   set_schema(bucket)  -> nil
     #
@@ -178,11 +206,6 @@ 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/resource/jiak_resource.rb

@@ -25,12 +25,16 @@ module RiakRest
     module ClassMethods
 
       # :call-seq:
-      #   JiakServer.server(uri)
+      #   JiakServer.server(uri,opts={})
       #
-      # Set the URI for Jiak server interaction.
-      def server(uri)
+      # Set the URI for Jiak server interaction. Go through a proxy if proxy
+      # option specified.
+      #
+      # Valid options:
+      #  <code>:proxy</code> Proxy server URI.
+      def server(uri,opts={})
         jiak.uri = uri
-        jiak.server = JiakClient.new(uri)
+        jiak.server = JiakClient.new(uri,opts)
         uri
       end
 

data/lib/riakrest.rb

@@ -1,25 +1,25 @@
 # See README.rdoc for the RiakRest license.
-
 begin
   require 'json'
 rescue LoadError
   raise "RiakRest requires json for REST JSON messaging."
 end
+
 begin
   require 'restclient'
 rescue LoadError
   raise <<EOM
 RiakRest requires the restclient gem for making REST calls.
   gem install rest-client
-
 EOM
 end
 
 require 'uri'
 
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || 
-  $:.include?(File.expand_path(File.dirname(__FILE__)))
+dirname = File.dirname(__FILE__)
+$:.unshift(dirname) unless
+  $:.include?(dirname) || 
+  $:.include?(File.expand_path(dirname))
 
 # RiakRest provides structured, RESTful interaction with a Riak document
 # store. In Riak parlance, this JSON data exchange is called Jiak. RiakRest
@@ -134,10 +134,10 @@ $:.unshift(File.dirname(__FILE__)) unless
 # </code>
 # Ah, that feels better. Go forth and Riak!
 module RiakRest
+  version_file = File.join(File.dirname(__FILE__),"..","VERSION")
+  VERSION = IO.read(version_file).chomp
 end
 
-require 'riakrest/version'
-
 require 'riakrest/core/exceptions'
 require 'riakrest/core/jiak_bucket'
 require 'riakrest/core/jiak_client'
@@ -148,7 +148,6 @@ require 'riakrest/core/jiak_schema'
 require 'riakrest/core/query_link'
 
 require 'riakrest/data/jiak_data_hash'
-
 require 'riakrest/resource/jiak_resource'
 
 # Extend Array with convenience methods for comparing array contents.

data/spec/resource/jiak_resource_spec.rb

@@ -8,6 +8,7 @@ describe "JiakResource default" do
     group        'group'
     data_class   F1F2
   end
+  Rsrc.pov
 
   before do
     @server = 'http://localhost:8002/jiak/'
@@ -114,6 +115,7 @@ describe "JiakResource default class-level auto-post/auto-update" do
     group        'people'
     data_class   PersonData
   end
+  Person.pov
 
   before do
     @name = 'p default'
@@ -164,6 +166,7 @@ describe "JiakResource class auto-post" do
     group        'people'
     data_class   PersonData
   end
+  Person.pov
 
   before do
     @name = 'p auto-post'
@@ -245,6 +248,7 @@ describe "JiakResource class auto-update" do
     auto_post    true
     auto_update  true
   end
+  Dog.pov
 
   before do
     @pname = 'p auto-update'
@@ -341,6 +345,7 @@ describe "JiakResource simple" do
     auto_post    true
     auto_update  true
   end
+  Dog.pov
 
   before do
     @pname = 'p'
@@ -403,6 +408,8 @@ describe "JiakResource complex" do
     group       'parents'
     data_class  PersonData
   end
+  Parent.pov
+
   Child = Parent.copy(:group => 'children')
 
   it "should do multi-step relationships" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riakrest
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Paul Rogers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-31 00:00:00 -07:00
+date: 2009-11-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,10 +62,10 @@ files:
 - examples/auto_update_links.rb
 - examples/basic_client.rb
 - examples/basic_resource.rb
-- examples/json_data_resource.rb
-- examples/linked_resource.rb
-- examples/links_only.rb
-- examples/multiple_resources.rb
+- examples/linked_resources.rb
+- examples/links_only_pov.rb
+- examples/multiple_pov.rb
+- examples/ruby_json_data.rb
 - lib/riakrest.rb
 - lib/riakrest/core/exceptions.rb
 - lib/riakrest/core/jiak_bucket.rb
@@ -77,7 +77,6 @@ files:
 - lib/riakrest/core/query_link.rb
 - lib/riakrest/data/jiak_data_hash.rb
 - lib/riakrest/resource/jiak_resource.rb
-- lib/riakrest/version.rb
 - spec/core/exceptions_spec.rb
 - spec/core/jiak_bucket_spec.rb
 - spec/core/jiak_client_spec.rb
@@ -134,7 +133,7 @@ test_files:
 - examples/auto_update_links.rb
 - examples/basic_client.rb
 - examples/basic_resource.rb
-- examples/json_data_resource.rb
-- examples/linked_resource.rb
-- examples/links_only.rb
-- examples/multiple_resources.rb
+- examples/linked_resources.rb
+- examples/links_only_pov.rb
+- examples/multiple_pov.rb
+- examples/ruby_json_data.rb

data/lib/riakrest/version.rb

@@ -1,7 +0,0 @@
-module RiakRest
-  VERSION         = '0.0.2'
-  VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
-  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
-  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
-  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
-end