riak-client 0.7.0

data/lib/riak/util/escape.rb

@@ -0,0 +1,12 @@
+module Riak
+  module Util
+    module Escape
+      # URI-escapes bucket or key names that may contain slashes for use in URLs.
+      # @param [String] bucket_or_key the bucket or key name
+      # @return [String] the escaped path segment
+      def escape(bucket_or_key)
+        URI.escape(bucket_or_key.to_s).gsub("/", "%2F")
+      end
+    end
+  end
+end

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/util/headers.rb

@@ -0,0 +1,44 @@
+# 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
+    # Represents headers from an HTTP response
+    class Headers
+      include Net::HTTPHeader
+
+      def initialize
+        initialize_http_header({})
+      end
+      
+      # Parse a single header line into its key and value
+      # @param [String] chunk a single header line
+      def self.parse(chunk)
+        line = chunk.strip
+        # thanks Net::HTTPResponse
+        return [nil,nil] if chunk =~ /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)\s*(.*)\z/in
+        m = /\A([^:]+):\s*/.match(line)
+        [m[1], m.post_match] rescue [nil, nil]
+      end
+      
+      # Parses a header line and adds it to the header collection
+      # @param [String] chunk a single header line
+      def parse(chunk)
+        key, value = self.class.parse(chunk)
+        add_field(key, value) if key && value
+      end
+    end
+  end
+end

data/lib/riak/util/multipart.rb

@@ -0,0 +1,52 @@
+# 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
+    # Utility methods for handling multipart/mixed responses
+    module Multipart
+      extend self
+      # Parses a multipart/mixed body into its constituent parts, including nested multipart/mixed sections
+      # @param [String] data the multipart body data
+      # @param [String] boundary the boundary string given in the Content-Type header
+      def parse(data, boundary)
+        contents = data.match(/\r?\n--#{Regexp.escape(boundary)}--\r?\n/).pre_match rescue ""
+        contents.split(/\r?\n--#{Regexp.escape(boundary)}\r?\n/).reject(&:blank?).map do |part|
+          headers = Headers.new
+          if md = part.match(/\r?\n\r?\n/)
+            body = md.post_match
+            md.pre_match.split(/\r?\n/).each do |line|
+              headers.parse(line)
+            end
+
+            if headers["content-type"] =~ /multipart\/mixed/
+              boundary = extract_boundary(headers.to_hash["content-type"].first)
+              parse(body, boundary)
+            else
+              {:headers => headers.to_hash, :body => body}
+            end
+          end
+        end.compact
+      end
+
+      # Extracts the boundary string from a Content-Type header that is a multipart type
+      # @param [String] header_string the Content-Type header
+      # @return [String] the boundary string separating each part
+      def extract_boundary(header_string)
+        $1 if header_string =~ /boundary=([A-Za-z0-9\'()+_,-.\/:=?]+)/
+      end
+    end
+  end
+end

data/lib/riak/util/translation.rb

@@ -0,0 +1,29 @@
+# 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
+    module Translation
+      def i18n_scope
+        :riak
+      end
+
+      def t(message, options={})
+        I18n.t("#{i18n_scope}.#{message}", options)
+      end
+    end
+  end
+end
+

data/lib/riak/walk_spec.rb

@@ -0,0 +1,117 @@
+# 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
+
+  # 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 /riak/artists/REM/albums,_,_/tracks,_,1
+  # This operation would have two WalkSpecs:
+  #   Riak::WalkSpec.new({:bucket => 'albums'})
+  #   Riak::WalkSpec.new({:bucket => 'tracks', :result => true})
+  class WalkSpec
+    include Util::Translation
+    include Util::Escape
+
+    # @return [String] The bucket followed links should be restricted to. "_" represents all buckets.
+    attr_accessor :bucket
+
+    # @return [String] The "riaktag" or "rel" that followed links should be restricted to. "_" represents all tags.
+    attr_accessor :tag
+
+    # @return [Boolean] Whether objects should be returned from this phase of link walking. Default is false.
+    attr_accessor :keep
+
+    # Normalize a list of walk specs into WalkSpec objects.
+    def self.normalize(*params)
+      params.flatten!
+      specs = []
+      while params.length > 0
+        param = params.shift
+        case param
+        when Hash
+          specs << new(param)
+        when WalkSpec
+          specs << param
+        else
+          if params.length >= 2
+            specs << new(param, params.shift, params.shift)
+          else
+            raise ArgumentError, t("too_few_arguments", :params => params.inspect)
+          end
+        end
+      end
+      specs
+    end
+
+    # Creates a walk-spec for use in finding other objects in Riak.
+    # @overload initialize(hash)
+    #   Creates a walk-spec from a hash.
+    #   @param [Hash] hash options for the walk-spec
+    #   @option hash [String] :bucket ("_") the bucket the links should point to (default '_' is all)
+    #   @option hash [String] :tag ("_") the tag to filter links by (default '_' is all)
+    #   @option hash [Boolean] :keep (false) whether to return results from following this link specification
+    # @overload initialize(bucket, tag, keep)
+    #   Creates a walk-spec from a bucket-tag-result triple.
+    #   @param [String] bucket the bucket the links should point to (default '_' is all)
+    #   @param [String] tag the tag to filter links by (default '_' is all)
+    #   @param [Boolean] keep whether to return results from following this link specification
+    # @see {Riak::RObject#walk}
+    def initialize(*args)
+      args.flatten!
+      case args.size
+      when 1
+        hash = args.first
+        raise ArgumentError, t("hash_type", :hash => hash.inspect) unless Hash === hash
+        assign(hash[:bucket], hash[:tag], hash[:keep])
+      when 3
+        assign(*args)
+      else
+        raise ArgumentError, t("wrong_argument_count_walk_spec")
+      end
+    end
+
+    # Converts the walk-spec into the form required by the link-walker resource URL
+    def to_s
+      b = @bucket && escape(@bucket) || '_'
+      t = @tag && escape(@tag) || '_'
+      "#{b},#{t},#{@keep ? '1' : '_'}"
+    end
+
+    def ==(other)
+      other.is_a?(WalkSpec) && other.bucket == bucket && other.tag == tag && other.keep == keep
+    end
+
+    def ===(other)
+      self == other || case other
+                       when WalkSpec
+                         other.keep == keep &&
+                           (bucket == "_" || bucket == other.bucket) &&
+                           (tag == "_" || tag == other.tag)
+                       when Link
+                         (bucket == "_" || bucket == other.url.split("/")[2]) &&
+                           (tag == "_" || tag == other.rel)
+                       end
+    end
+
+    private
+    def assign(bucket, tag, result)
+      @bucket = bucket || "_"
+      @tag = tag || "_"
+      @keep = result || false
+    end
+  end
+end

data/spec/fixtures/multipart-blank.txt

@@ -0,0 +1,7 @@
+
+--73NmmA8dJxSB5nL2dVerpFIi8ze
+Content-Type: multipart/mixed; boundary=8fPXq9XfV15txMoV1IbA3hovEij
+
+--8fPXq9XfV15txMoV1IbA3hovEij--
+
+--73NmmA8dJxSB5nL2dVerpFIi8ze--

data/spec/fixtures/multipart-with-body.txt

@@ -0,0 +1,16 @@
+
+--5EiMOjuGavQ2IbXAqsJPLLfJNlA
+Content-Type: multipart/mixed; boundary=7extjTzvYIKVMVHowUiTn0LfvSs
+
+--7extjTzvYIKVMVHowUiTn0LfvSs
+X-Riak-Vclock: a85hYGBgyWDKBVHMr9s3ZzAlMuaxMtyZcPAIH1RYyObHDqiwxIZjcOG1M98chAq3bUQIz7SSFQEKM4FUbwMKZwEA
+Location: /riak/foo/baz
+Content-Type: text/plain
+Link: </riak/foo>; rel="up"
+Etag: 6JdI51eFrvv5lDwY6un7a2
+Last-Modified: Sat, 16 Jan 2010 22:13:44 GMT
+
+SCP sloooow....
+--7extjTzvYIKVMVHowUiTn0LfvSs--
+
+--5EiMOjuGavQ2IbXAqsJPLLfJNlA--

data/spec/integration/riak/cache_store_spec.rb

@@ -0,0 +1,129 @@
+# 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.dirname(__FILE__))
+
+describe Riak::CacheStore do
+  before do
+    @cache = ActiveSupport::Cache.lookup_store(:riak_store)
+    @cleanup = true
+  end
+
+  after do
+    @cache.bucket.keys(:force => true).each do |k|
+      @cache.bucket.delete(k, :rw => 1) unless k.blank?
+    end if @cleanup
+  end
+
+  describe "Riak integration" do
+    before do
+      @cleanup = false
+    end
+
+    it "should have a client" do
+      @cache.should respond_to(:client)
+      @cache.client.should be_kind_of(Riak::Client)
+    end
+
+    it "should have a bucket to store entries in" do
+      @cache.bucket.should be_kind_of(Riak::Bucket)
+    end
+
+    it "should configure the client according to the initialized options" do
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :port => 10000)
+      @cache.client.port.should == 10000
+    end
+
+    it "should choose the bucket according to the initializer option" do
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :bucket => "foobar")
+      @cache.bucket.name.should == "foobar"
+    end
+
+    it "should set the N value to 2 by default" do
+      @cache.bucket.n_value.should == 2
+    end
+
+    it "should set the N value to the specified value" do
+      @cache = ActiveSupport::Cache.lookup_store(:riak_store, :n_value => 1)
+      @cache.bucket.n_value.should == 1
+    end
+  end
+
+
+  it "should read and write strings" do
+    @cache.write('foo', 'bar')
+    @cache.read('foo').should == 'bar'
+  end
+
+  it "should read and write hashes" do
+    @cache.write('foo', {:a => "b"})
+    @cache.read('foo').should == {:a => "b"}
+  end
+
+  it "should read and write integers" do
+    @cache.write('foo', 1)
+    @cache.read('foo').should == 1
+  end
+
+  it "should read and write nil" do
+    @cache.write('foo', nil)
+    @cache.read('foo').should be_nil
+  end
+
+  it "should return the stored value when fetching on hit" do
+    @cache.write('foo', 'bar')
+    @cache.fetch('foo'){'baz'}.should == 'bar'
+  end
+
+  it "should return the default value when fetching on miss" do
+    @cache.fetch('foo'){'baz'}.should == 'baz'
+  end
+
+  it "should return the default value when forcing a miss" do
+    @cache.fetch('foo', :force => true){'bar'}.should == 'bar'
+  end
+
+  it "should increment an integer value in the cache" do
+    @cache.write('foo', 1, :raw => true)
+    @cache.read('foo', :raw => true).to_i.should == 1
+    @cache.increment('foo')
+    @cache.read('foo', :raw => true).to_i.should == 2
+  end
+
+  it "should decrement an integer value in the cache" do
+    @cache.write('foo', 1, :raw => true)
+    @cache.read('foo', :raw => true).to_i.should == 1
+    @cache.decrement('foo')
+    @cache.read('foo', :raw => true).to_i.should == 0
+  end
+
+  it "should detect if a value exists in the cache" do
+    @cache.write('foo', 'bar')
+    @cache.exist?('foo').should be_true
+  end
+
+  it "should delete matching keys from the cache" do
+    @cache.write('foo', 'bar')
+    @cache.write('green', 'thumb')
+    @cache.delete_matched(/foo/)
+    @cache.read('foo').should be_nil
+    @cache.read('green').should == 'thumb'
+  end
+
+  it "should delete a single key from the cache" do
+    @cache.write('foo', 'bar')
+    @cache.read('foo').should == 'bar'
+    @cache.delete('foo')
+    @cache.read('foo').should be_nil
+  end
+end