ripple 0.5.1 → 0.6.0

data/CONTRIBUTORS.textile

@@ -2,3 +2,4 @@ These developers have contributed code to Ripple:
 
 * Sean Cribbs - sean@basho.com
 * John Lynch - john@rigelgroupllc.com
+* Adam Hunter - adamhunter@me.com

data/README.textile

@@ -76,15 +76,15 @@ class Email
   property :body,    String
 end
 
-email = Email.find("37458abc752f8413e")  # GET /raw/emails/37458abc752f8413e
+email = Email.find("37458abc752f8413e")  # GET /riak/emails/37458abc752f8413e
 email.from = "someone@nowhere.net"
-email.save                               # PUT /raw/emails/37458abc752f8413e
+email.save                               # PUT /riak/emails/37458abc752f8413e
 
 reply = Email.new
 reply.from = "justin@bashoooo.com"
 reply.to   = "sean@geeemail.com"
 reply.body = "Riak is a good fit for scalable Ruby apps."
-reply.save                               # POST /raw/emails (Riak-assigned key)
+reply.save                               # POST /riak/emails (Riak-assigned key)
 </pre></notextile>
 
 h2. How to Contribute
@@ -120,7 +120,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-h2. Auxillary License
+h2. Auxillary Licenses
 
 The included photo (spec/fixtures/cat.jpg) is Copyright &copy;2009 "Sean Cribbs":http://seancribbs.com/, and is 
 licensed under the "Creative Commons Attribution Non-Commercial 3.0":http://creativecommons.org/licenses/by-nc/3.0 license. !http://i.creativecommons.org/l/by-nc/3.0/88x31.png!
+
+The "Poor Man's Fibers" implementation (lib/riak/util/fiber1.8.rb) is Copyright &copy;2008 Aman Gupta.

data/RELEASE_NOTES.textile

@@ -1,5 +1,25 @@
 h1. Ripple Release Notes
 
+h2. 0.6.0 Feature Release - 2010-03-05
+
+This release contains enhancements and bugfixes in preparation for the
+Riak 0.9 release.
+
+* The CurbBackend now uses fibers to prevent curl-handle corruption when
+  a block is given to streaming operations.
+* The default prefix is now "/riak/" to match the latest version of Riak.
+* The client configuration for Ripple is now used.
+* Added Bucket#new and Bucket#get_or_new for easily creating new objects.
+* Added Bucket#allow_mult and Bucket#n_value accessors for more easily setting
+  bucket properties.
+* Added timestamps! method for easily adding created_at/updated_at to documents.
+  [Adam Hunter]
+* The 'links' collection on RObject is now a Set instead of an Array.
+* All literal messages are now stored in YAML localization files.
+* Object siblings (caused by concurrent updates when allow_mult is true) can now
+  be accessed directly.
+* Map-reduce jobs now have timeouts (in parity with Riak).
+
 h2. 0.5.1 Patch Release - 2010-02-22
 
 This is a minor release with fixes for Ruby 1.9, bundler/edge Rails,

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/riak/bucket.rb

@@ -34,7 +34,7 @@ module Riak
     def initialize(client, name)
       raise ArgumentError, t("client_type", :client => client.inspect) unless Client === client
       raise ArgumentError, t("string_type", :string => name.inspect) unless String === name
-      @client, @name = client, name
+      @client, @name, @props = client, name, {}
     end
 
     # Load information for the bucket from a response given by the {Riak::Client::HTTPBackend}.
@@ -92,11 +92,61 @@ module Riak
     # @return [Riak::RObject] the object
     # @raise [FailedRequest] if the object is not found or some other error occurs
     def get(key, options={})
-      response = @client.http.get(200, @client.prefix, name, key, options, {})
+      code = allow_mult ? [200,300] : 200
+      response = @client.http.get(code, @client.prefix, name, key, options, {})
       RObject.new(self, key).load(response)
     end
     alias :[] :get
 
+    # Create a new blank object
+    # @param [String] key the key of the new object
+    # @return [RObject] the new, unsaved object
+    def new(key=nil)
+      RObject.new(self, key).tap do |obj|
+        obj.content_type = "application/json"
+      end
+    end
+
+    # Fetches an object if it exists, otherwise creates a new one with the given key
+    # @param [String] key the key to fetch or create
+    # @return [RObject] the new or existing object
+    def get_or_new(key, options={})
+      begin
+        get(key, options)
+      rescue Riak::FailedRequest => fr
+        if fr.code.to_i == 404
+          new(key)
+        else
+          raise fr
+        end
+      end
+    end
+
+    # @return [true, false] whether the bucket allows divergent siblings
+    def allow_mult
+      props['allow_mult']
+    end
+    
+    # Set the allow_mult property.  *NOTE* This will result in a PUT request to Riak.
+    # @param [true, false] value whether the bucket should allow siblings
+    def allow_mult=(value)
+      self.props = props.merge('allow_mult' => value)
+      value
+    end
+
+    # @return [Fixnum] the N value, or number of replicas for this bucket
+    def n_value
+      props['n_val']
+    end
+
+    # Set the N value (number of replicas). *NOTE* This will result in a PUT request to Riak.
+    # Setting this value after the bucket has objects stored in it may have unpredictable results.
+    # @param [Fixnum] value the number of replicas the bucket should keep of each object
+    def n_value=(value)
+      self.props = props.merge('n_val' => value)
+      value
+    end
+    
     # @return [String] a representation suitable for IRB and debugging output
     def inspect
       "#<Riak::Bucket #{client.http.path(client.prefix, name).to_s}#{" keys=[#{keys.join(',')}]" if defined?(@keys)}>"

data/lib/riak/client.rb

@@ -47,7 +47,7 @@ module Riak
     # @param [Hash] options configuration options for the client
     # @option options [String] :host ('127.0.0.1') The host or IP address for the Riak endpoint
     # @option options [Fixnum] :port (8098) The port of the Riak HTTP endpoint
-    # @option options [String] :prefix ('/raw/') The URL path prefix to the "raw" HTTP endpoint
+    # @option options [String] :prefix ('/riak/') The URL path prefix to the main HTTP endpoint
     # @option options [String] :mapred ('/mapred') The path to the map-reduce HTTP endpoint
     # @option options [Fixnum, String] :client_id (rand(MAX_CLIENT_ID)) The internal client ID used by Riak to route responses
     # @raise [ArgumentError] raised if any options are invalid
@@ -56,7 +56,7 @@ module Riak
       self.host      = options[:host]      || "127.0.0.1"
       self.port      = options[:port]      || 8098
       self.client_id = options[:client_id] || make_client_id
-      self.prefix    = options[:prefix]    || "/raw/"
+      self.prefix    = options[:prefix]    || "/riak/"
       self.mapred    = options[:mapred]    || "/mapred"
       raise ArgumentError, t("missing_host_and_port") unless @host && @port
     end

data/lib/riak/client/curb_backend.rb

@@ -13,6 +13,12 @@
 #    limitations under the License.
 require 'riak'
 
+begin
+  require 'fiber'
+rescue LoadError
+  require 'riak/util/fiber1.8'
+end
+
 module Riak
   class Client
     # An HTTP backend for Riak::Client that uses the 'curb' library/gem.
@@ -20,44 +26,57 @@ module Riak
     # the backend based on Net::HTTP.
     # Conforms to the Riak::Client::HTTPBackend interface.
     class CurbBackend < HTTPBackend
-      # @private
-      def initialize(client)
-        super
-        @curl = Curl::Easy.new
-        @curl.follow_location = false
-        @curl.on_header do |header_line|
-          @response_headers.parse(header_line)
-          header_line.size
-        end
-      end
-
       private
       def perform(method, uri, headers, expect, data=nil)
         # Setup
-        @curl.headers = headers
-        @curl.url = uri.to_s
-        @response_headers = Riak::Util::Headers.new
-        @curl.on_body {|chunk| yield chunk; chunk.size } if block_given?
-
+        curl.headers = headers
+        curl.url = uri.to_s
+        response_headers.initialize_http_header(nil)
+        if block_given?
+          _curl = curl
+          Fiber.new {
+            f = Fiber.current
+            _curl.on_body {|chunk| f.resume(chunk); chunk.size }
+            loop do
+              yield Fiber.yield
+            end
+          }.resume
+        else
+          curl.on_body
+        end
         # Perform
         case method
         when :put, :post
-          @curl.send("http_#{method}", data)
+          curl.send("http_#{method}", data)
         else
-          @curl.send("http_#{method}")
+          curl.send("http_#{method}")
         end
 
         # Verify
-        if valid_response?(expect, @curl.response_code)
-          result = { :headers => @response_headers.to_hash, :code => @curl.response_code.to_i }
-          if return_body?(method, @curl.response_code, block_given?)
-            result[:body] = @curl.body_str
+        if valid_response?(expect, curl.response_code)
+          result = { :headers => response_headers.to_hash, :code => curl.response_code.to_i }
+          if return_body?(method, curl.response_code, block_given?)
+            result[:body] = curl.body_str
           end
           result
         else
-          raise FailedRequest.new(method, expect, @curl.response_code, @response_headers.to_hash, @curl.body_str)
+          raise FailedRequest.new(method, expect, curl.response_code, response_headers.to_hash, curl.body_str)
         end
       end
+
+      def curl
+        Thread.current[:curl_easy_handle] ||= Curl::Easy.new.tap do |c|
+          c.follow_location = false
+          c.on_header do |header_line|
+            response_headers.parse(header_line)
+            header_line.size
+          end
+        end
+      end
+
+      def response_headers
+        Thread.current[:response_headers] ||= Riak::Util::Headers.new
+      end
     end
   end
 end

data/lib/riak/link.rb

@@ -35,14 +35,14 @@ module Riak
       @url, @rel = url, rel
     end
 
-    # @return [String] bucket_name, if the Link url is a known Riak link ("/raw/<bucket>/<key>")
+    # @return [String] bucket_name, if the Link url is a known Riak link ("/riak/<bucket>/<key>")
     def bucket
-      $1 if url =~ %r{/raw/([^/]+)/?}
+      $1 if url =~ %r{/riak/([^/]+)/?}
     end
     
-    # @return [String] key, if the Link url is a known Riak link ("/raw/<bucket>/<key>")
+    # @return [String] key, if the Link url is a known Riak link ("/riak/<bucket>/<key>")
     def key
-      $1 if url =~ %r{/raw/[^/]+/([^/]+)/?}
+      $1 if url =~ %r{/riak/[^/]+/([^/]+)/?}
     end
 
     def inspect; to_s; end

data/lib/riak/map_reduce.rb

@@ -124,10 +124,18 @@ module Riak
       self
     end
 
+    # Sets the timeout for the map-reduce job.
+    # @param [Fixnum] value the job timeout, in milliseconds
+    def timeout(value)
+      @timeout = value
+    end
+
     # Convert the job to JSON for submission over the HTTP interface.
     # @return [String] the JSON representation
     def to_json(options={})
-      ActiveSupport::JSON.encode({"inputs" => inputs, "query" => query.map(&:as_json)}, options)
+      hash = {"inputs" => inputs, "query" => query.map(&:as_json)}
+      hash['timeout'] = @timeout.to_i if @timeout
+      ActiveSupport::JSON.encode(hash, options)
     end
 
     # Executes this map-reduce job.

data/lib/riak/robject.rb

@@ -12,6 +12,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 require 'riak'
+require 'set'
 
 module Riak
   # Parent class of all object types supported by ripple. {Riak::RObject} represents
@@ -36,7 +37,7 @@ module Riak
     # @return [Object] the data stored in Riak at this object's key. Varies in format by content-type, defaulting to String from the response body.
     attr_accessor :data
 
-    # @return [Array<Link>] an array of {Riak::Link} objects for relationships between this object and other resources
+    # @return [Set<Link>] an Set of {Riak::Link} objects for relationships between this object and other resources
     attr_accessor :links
 
     # @return [String] the ETag header from the most recent HTTP response, useful for caching and reloading
@@ -54,7 +55,8 @@ module Riak
     # @see Bucket#get
     def initialize(bucket, key=nil)
       @bucket, @key = bucket, key
-      @links, @meta = [], {}
+      @links, @meta = Set.new, {}
+      yield self if block_given?
     end
 
     # Load object data from an HTTP response
@@ -63,7 +65,7 @@ module Riak
       extract_header(response, "location", :key) {|v| URI.unescape(v.split("/").last) }
       extract_header(response, "content-type", :content_type)
       extract_header(response, "x-riak-vclock", :vclock)
-      extract_header(response, "link", :links) {|v| Link.parse(v) }
+      extract_header(response, "link", :links) {|v| Set.new(Link.parse(v)) }
       extract_header(response, "etag", :etag)
       extract_header(response, "last-modified", :last_modified) {|v| Time.httpdate(v) }
       @meta = response[:headers].inject({}) do |h,(k,v)|
@@ -72,6 +74,8 @@ module Riak
         end
         h
       end
+      @conflict = response[:code].try(:to_i) == 300 && content_type =~ /multipart\/mixed/
+      @siblings = nil
       @data = deserialize(response[:body]) if response[:body].present?
       self
     end
@@ -126,8 +130,9 @@ module Riak
     def reload(options={})
       force = options.delete(:force)
       return self unless @key && (@vclock || force)
-      response = @bucket.client.http.get([200, 304], @bucket.client.prefix, @bucket.name, @key, options, reload_headers)
-      load(response) if response[:code] == 200
+      codes = @bucket.allow_mult ? [200,300,304] : [200,304]
+      response = @bucket.client.http.get(codes, @bucket.client.prefix, @bucket.name, @key, options, reload_headers)
+      load(response) unless response[:code] == 304
       self
     end
 
@@ -141,6 +146,24 @@ module Riak
       freeze
     end
 
+    # Returns sibling objects when in conflict.
+    # @return [Array<RObject>] an array of conflicting sibling objects for this key
+    # @return [self] this object when not in conflict
+    def siblings
+      return self unless conflict?
+      @siblings ||= Multipart.parse(data, Multipart.extract_boundary(content_type)).map do |part|
+        RObject.new(self.bucket, self.key) do |sibling|
+          sibling.load(part)
+          sibling.vclock = vclock
+        end
+      end
+    end
+
+    # @return [true,false] Whether this object has conflicting sibling objects (divergent vclocks)
+    def conflict?
+      @conflict.present?
+    end
+
     # Serializes the internal object data for sending to Riak. Differs based on the content-type.
     # This method is called internally when storing the object.
     # Automatically serialized formats:
@@ -207,12 +230,12 @@ module Riak
         []
       end
     end
-    
+
     # Converts the object to a link suitable for linking other objects to it
     def to_link(tag=nil)
       Link.new(@bucket.client.http.path(@bucket.client.prefix, @bucket.name, @key).path, tag)
     end
-    
+
     private
     def extract_header(response, name, attribute=nil)
       if response[:headers][name].present?

data/lib/riak/util/fiber1.8.rb

@@ -0,0 +1,48 @@
+# Poor Man's Fiber (API compatible Thread based Fiber implementation for Ruby 1.8)
+# (c) 2008 Aman Gupta (tmm1)
+
+unless defined? Fiber
+  require 'thread'
+
+  class FiberError < StandardError; end
+
+  class Fiber
+    def initialize
+      raise ArgumentError, 'new Fiber requires a block' unless block_given?
+
+      @yield = Queue.new
+      @resume = Queue.new
+
+      @thread = Thread.new{ @yield.push [ *yield(*@resume.pop) ] }
+      @thread.abort_on_exception = true
+      @thread[:fiber] = self
+    end
+    attr_reader :thread
+
+    def resume *args
+      raise FiberError, 'dead fiber called' unless @thread.alive?
+      @resume.push(args)
+      result = @yield.pop
+      result.size > 1 ? result : result.first
+    end
+
+    def yield *args
+      @yield.push(args)
+      result = @resume.pop
+      result.size > 1 ? result : result.first
+    end
+
+    def self.yield *args
+      raise FiberError, "can't yield from root fiber" unless fiber = Thread.current[:fiber]
+      fiber.yield(*args)
+    end
+
+    def self.current
+      Thread.current[:fiber] or raise FiberError, 'not inside a fiber'
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}>"
+    end
+  end
+end

data/lib/riak/walk_spec.rb

@@ -18,7 +18,7 @@ module Riak
   # The specification of how to follow links from one object to another in Riak,
   # when using the link-walker resource.
   # Example link-walking operation:
-  #   GET /raw/artists/REM/albums,_,_/tracks,_,1
+  #   GET /riak/artists/REM/albums,_,_/tracks,_,1
   # This operation would have two WalkSpecs:
   #   Riak::WalkSpec.new({:bucket => 'albums'})
   #   Riak::WalkSpec.new({:bucket => 'tracks', :result => true})

data/lib/ripple.rb

@@ -28,10 +28,12 @@ module Ripple
   autoload :PropertyTypeMismatch
   autoload :Translation
 
+  DEFAULT_CONFIG = {}
+
   class << self
     # @return [Riak::Client] The client for the current thread.
     def client
-      Thread.current[:ripple_client] ||= Riak::Client.new
+      Thread.current[:ripple_client] ||= Riak::Client.new(config)
     end
 
     # Sets the client for the current thread.