riak-client 0.8.0.beta2 → 0.8.0

data/lib/riak.rb

@@ -44,6 +44,7 @@ module Riak
   autoload :InvalidResponse, "riak/invalid_response"
   autoload :MapReduceError,  "riak/map_reduce_error"
 
+  # Utility classes and mixins
   module Util
     autoload :Escape,        "riak/util/escape"
     autoload :Headers,       "riak/util/headers"

data/lib/riak/bucket.rb

@@ -177,7 +177,8 @@ module Riak
     def n_value
       props['n_val']
     end
-
+    alias :n_val :n_value
+    
     # 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
@@ -185,7 +186,8 @@ module Riak
       self.props = {'n_val' => value}
       value
     end
-
+    alias :n_val= :n_value=
+    
     [:r,:w,:dw,:rw].each do |q|
       class_eval <<-CODE
         def #{q}

data/lib/riak/cache_store.rb

@@ -12,10 +12,14 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 require 'riak'
+
 module Riak
+  # An ActiveSupport::Cache::Store implementation that uses Riak.
+  # Compatible only with ActiveSupport version 3 or greater.
   class CacheStore < ActiveSupport::Cache::Store
     attr_accessor :client
 
+    # Creates a Riak-backed cache store.
     def initialize(options = {})
       super
       @bucket_name = options.delete(:bucket) || '_cache'

data/lib/riak/client/curb_backend.rb

@@ -29,7 +29,7 @@ module Riak
       private
       def perform(method, uri, headers, expect, data=nil)
         # Setup
-        curl.headers = headers
+        curl.headers = create_request_headers(headers)
         curl.url = uri.to_s
         response_headers.initialize_http_header(nil)
         if block_given?
@@ -46,8 +46,15 @@ module Riak
         end
         # Perform
         case method
-        when :put, :post
-          curl.send("http_#{method}", data)
+        when :post
+          data = data.read if data.respond_to?(:read)
+          curl.http_post(data)
+        when :put
+          # Hacks around limitations in curb's PUT semantics
+          _headers, curl.headers = curl.headers, {}
+          curl.put_data = data
+          curl.headers = create_request_headers(curl.headers) + _headers
+          curl.http("PUT")
         else
           curl.send("http_#{method}")
         end
@@ -77,6 +84,16 @@ module Riak
       def response_headers
         Thread.current[:response_headers] ||= Riak::Util::Headers.new
       end
+
+      def create_request_headers(hash)
+        h = Riak::Util::Headers.new
+        hash.each {|k,v| h.add_field(k,v) }
+        [].tap do |arr|
+          h.each_capitalized do |k,v|
+            arr << "#{k}: #{v}"
+          end
+        end
+      end
     end
   end
 end

data/lib/riak/client/http_backend.rb

@@ -15,6 +15,7 @@ require 'riak'
 
 module Riak
   class Client
+    # The parent class for all backends that connect to Riak via HTTP.
     class HTTPBackend
       include Util::Translation
       # The Riak::Client that uses this backend

data/lib/riak/map_reduce.rb

@@ -161,7 +161,7 @@ module Riak
     end
 
     # Represents an individual phase in a map-reduce pipeline. Generally you'll want to call
-    # methods of {MapReduce} instead of using this directly.
+    # methods of MapReduce instead of using this directly.
     class Phase
       include Util::Translation
       # @return [Symbol] the type of phase - :map, :reduce, or :link

data/lib/riak/robject.rb

@@ -15,8 +15,8 @@ require 'riak'
 require 'set'
 
 module Riak
-  # Parent class of all object types supported by ripple. {Riak::RObject} represents
-  # the data and metadata stored in a bucket/key pair in the Riak database.
+  # Represents the data and metadata stored in a bucket/key pair in
+  # the Riak database, the base unit of data manipulation.  
   class RObject
     include Util
     include Util::Translation
@@ -52,10 +52,8 @@ module Riak
 
     # Loads a list of RObjects that were emitted from a MapReduce
     # query.
-    # @param [Client] client A Riak::Client with which the results will be
-    # associated
-    # @param [Array<Hash>] response A list of results a MapReduce job. Each
-    # entry should contain these keys: bucket, key, vclock, values
+    # @param [Client] client A Riak::Client with which the results will be associated
+    # @param [Array<Hash>] response A list of results a MapReduce job. Each entry should contain these keys: bucket, key, vclock, values
     # @return [Array<RObject>] An array of RObject instances
     def self.load_from_mapreduce(client, response)
       response.map do |item|
@@ -66,6 +64,7 @@ module Riak
     # Create a new object manually
     # @param [Bucket] bucket the bucket in which the object exists
     # @param [String] key the key at which the object resides. If nil, a key will be assigned when the object is saved.
+    # @yield self the new RObject
     # @see Bucket#get
     def initialize(bucket, key=nil)
       @bucket, @key = bucket, key
@@ -205,7 +204,9 @@ module Riak
     # Automatically serialized formats:
     # * JSON (application/json)
     # * YAML (text/yaml)
-    # * Marshal (application/octet-stream if meta['ruby-serialization'] == "Marshal")
+    # * Marshal (application/x-ruby-marshal)
+    # When given an IO-like object (e.g. File), no serialization will
+    # be done.
     # @param [Object] payload the data to serialize
     def serialize(payload)
       return payload if IO === payload
@@ -226,7 +227,7 @@ module Riak
     # Automatically deserialized formats:
     # * JSON (application/json)
     # * YAML (text/yaml)
-    # * Marshal (application/octet-stream if meta['ruby-serialization'] == "Marshal")
+    # * Marshal (application/x-ruby-marshal)
     # @param [String] body the serialized response body
     def deserialize(body)
       case @content_type
@@ -247,6 +248,7 @@ module Riak
     end
 
     # Walks links from this object to other objects in Riak.
+    # @param [Array<Hash,WalkSpec>] link specifications for the query
     def walk(*params)
       specs = WalkSpec.normalize(*params)
       response = @bucket.client.http.get(200, @bucket.client.prefix, escape(@bucket.name), escape(@key), specs.join("/"))
@@ -259,7 +261,9 @@ module Riak
       end
     end
 
-    # Converts the object to a link suitable for linking other objects to it
+    # Converts the object to a link suitable for linking other objects
+    # to it
+    # @param [String] tag the tag to apply to the link
     def to_link(tag)
       Link.new(@bucket.client.http.path(@bucket.client.prefix, escape(@bucket.name), escape(@key)).path, tag)
     end

data/lib/riak/util/escape.rb

@@ -1,5 +1,21 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    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.
+require 'riak'
+
 module Riak
   module Util
+    # Methods for escaping URL segments.
     module Escape
       # CGI-escapes bucket or key names that may contain slashes for use in URLs.
       # @param [String] bucket_or_key the bucket or key name

data/lib/riak/util/headers.rb

@@ -14,6 +14,7 @@
 require 'riak'
 
 # Splits headers into < 8KB chunks
+# @private
 module Net::HTTPHeader
   def each_capitalized
     # 1.9 check
@@ -35,7 +36,8 @@ end
 
 module Riak
   module Util
-    # Represents headers from an HTTP response
+    # Represents headers from an HTTP request or response.
+    # Used internally by HTTP backends for processing headers.
     class Headers
       include Net::HTTPHeader
 

data/lib/riak/util/translation.rb

@@ -15,11 +15,14 @@ require 'riak'
 
 module Riak
   module Util
+    # Methods for doing i18n string lookup
     module Translation
+      # The scope of i18n messages
       def i18n_scope
         :riak
       end
 
+      # Provides the translation for a given internationalized message
       def t(message, options={})
         I18n.t("#{i18n_scope}.#{message}", options)
       end

data/lib/riak/walk_spec.rb

@@ -14,7 +14,6 @@
 require 'riak'
 
 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:

data/spec/riak/curb_backend_spec.rb

@@ -20,7 +20,7 @@ rescue LoadError
 else
   $server = MockServer.new
   at_exit { $server.stop }
-  
+
   describe Riak::Client::CurbBackend do
     def setup_http_mock(method, uri, options={})
       method = method.to_s.upcase
@@ -46,8 +46,32 @@ else
 
     it_should_behave_like "HTTP backend"
 
+    it "should split long headers into 8KB chunks" do
+      setup_http_mock(:put, @backend.path("/riak/","foo").to_s, :body => "ok")
+      lambda do
+        @backend.put(200, "/riak/", "foo", "body",{"Long-Header" => (["12345678"*10]*100).join(", ") })
+        headers = @backend.send(:curl).headers
+        headers.should be_kind_of(Array)
+        headers.select {|h| h =~ /^Long-Header:/ }.should have(2).items
+        headers.select {|h| h =~ /^Long-Header:/ }.should be_all {|h| h.size < 8192 }
+      end.should_not raise_error
+    end
+
+    it "should support IO objects as the request body" do
+      file = File.open(File.expand_path("../../fixtures/cat.jpg", __FILE__))
+      lambda do
+        setup_http_mock(:put, @backend.path("/riak/","foo").to_s, :body => "ok")
+        @backend.put(200, "/riak/", "foo", file,{})
+      end.should_not raise_error
+      lambda do
+        setup_http_mock(:post, @backend.path("/riak/","foo").to_s, :body => "ok")
+        @backend.post(200, "/riak/", "foo", file, {})
+      end.should_not raise_error
+    end
+
     after :each do
       $server.detach
+      Thread.current[:curl_easy_handle] = nil
     end
   end
 end

data/spec/riak/escape_spec.rb

@@ -1,3 +1,17 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    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.
+
 require File.expand_path("../../spec_helper", __FILE__)
 
 describe Riak::Util::Escape do

data/spec/support/mocks.rb

@@ -1,3 +1,17 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    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.
+
 def mock_response(overrides={})
   {:headers => {"content-type" => ["application/json"]}, :body => '{}'}.merge(overrides)
-end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: riak-client
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 8
   - 0
-  - beta2
-  version: 0.8.0.beta2
+  version: 0.8.0
 platform: ruby
 authors: 
 - Sean Cribbs
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-29 00:00:00 -04:00
+date: 2010-08-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -181,13 +180,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: 
 - `gem install curb` for better HTTP performance
 rubyforge_project: