seomoz-riak-client 1.0.0.pre

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,53 @@
+require 'net/http'
+
+# Splits headers into < 8KB chunks
+# @private
+module Net::HTTPHeader
+  def each_capitalized
+    # 1.9 check
+    respond_to?(:enum_for) and (block_given? or return enum_for(__method__))
+    @header.each do |k,v|
+      base_length = "#{k}: \r\n".length
+      values = v.map {|i| i.to_s.split(", ") }.flatten
+      while !values.empty?
+        current_line = ""
+        while values.first && current_line.length + base_length + values.first.length + 2 < 8192
+          val = values.shift.strip
+          current_line += current_line.empty? ? val : ", #{val}"
+        end
+        yield capitalize(k), current_line
+      end
+    end
+  end
+end
+
+module Riak
+  module Util
+    # Represents headers from an HTTP request or response.
+    # Used internally by HTTP backends for processing headers.
+    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 @@
+require 'riak/util/headers'
+
+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(end_boundary_regex(boundary)).pre_match rescue ""
+        contents.split(inner_boundary_regex(boundary)).reject(&:blank?).map do |part|
+          parse_multipart_section(part)
+        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
+
+      private
+      def end_boundary_regex(boundary)
+        /\r?\n--#{Regexp.escape(boundary)}--\r?\n/
+      end
+
+      def inner_boundary_regex(boundary)
+        /\r?\n--#{Regexp.escape(boundary)}\r?\n/
+      end
+
+      def parse_multipart_section(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
+    end
+  end
+end

data/lib/riak/util/multipart/stream_parser.rb

@@ -0,0 +1,62 @@
+require 'riak/util/translation'
+require 'riak/util/multipart'
+
+module Riak
+  module Util
+    module Multipart
+      # This class is parses chunked/streamed multipart HTTP
+      # streams. It is used by streaming MapReduce queries, and in the
+      # future streaming key-lists (once implemented on the Riak side).
+      class StreamParser
+        include Multipart
+        include Translation
+        # Creates a new StreamParser.
+        #
+        # Example usage:
+        #     http.get(200, "/riak", "foo", {}, &StreamParser.new {|part| ... })
+        #
+        # @yield [Hash] parts of the multipart/mixed stream,
+        #               containing :headers and :body keys
+        def initialize(&block)
+          raise ArgumentError, t('missing_block') unless block_given?
+          @buffer = ""
+          @block = block
+          @state = :get_boundary
+        end
+
+        # Accepts a chunk of the HTTP response stream, and yields to
+        # the block when appropriate.
+        def accept(chunk)
+          @buffer << chunk
+          @state = send(@state)
+        end
+
+        # Returns a Proc that can be passed to an HTTP request method.
+        def to_proc
+          method(:accept).to_proc
+        end
+
+        private
+        CAPTURE_BOUNDARY = /^--([A-Za-z0-9\'()+_,-.\/:=?]+)\r?\n/
+
+        def get_boundary
+          if @buffer =~ CAPTURE_BOUNDARY
+            @re = /\r?\n--#{Regexp.escape($1)}(?:--)?\r?\n/
+            @buffer = $~.post_match
+            buffering
+          else
+            :get_boundary
+          end
+        end
+
+        def buffering
+          while @buffer =~ @re
+            @block.call parse_multipart_section($~.pre_match)
+            @buffer = $~.post_match
+          end
+          :buffering
+        end
+      end
+    end
+  end
+end

data/lib/riak/util/tcp_socket_extensions.rb

@@ -0,0 +1,58 @@
+require 'time'
+require 'timeout'
+require 'socket'
+
+# Borrowed from Webrat and Selenium client, watches for TCP port
+# liveness of the spawned server.
+# @private
+class TCPSocket  
+  def self.wait_for_service(options)
+    verbose_wait until listening_service?(options)
+  end
+
+  def self.wait_for_service_termination(options)
+    verbose_wait while listening_service?(options)
+  end
+
+  def self.listening_service?(options)
+    Timeout::timeout(options[:timeout] || 20) do
+      begin
+        socket = TCPSocket.new(options[:host], options[:port])
+        socket.close unless socket.nil?
+        true
+      rescue Errno::ECONNREFUSED,
+        Errno::EBADF           # Windows
+        false
+      end
+    end
+  end
+
+  def self.verbose_wait
+    # Removed the puts call so as not to clutter up test output.
+    sleep 2
+  end
+
+  def self.wait_for_service_with_timeout(options)
+    start_time = Time.now
+
+    until listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not open within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+  def self.wait_for_service_termination_with_timeout(options)
+    start_time = Time.now
+
+    while listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not terminate within #{options[:timeout]} seconds")
+      end
+    end
+  end
+end

data/lib/riak/util/translation.rb

@@ -0,0 +1,19 @@
+require 'riak/i18n'
+
+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
+    end
+  end
+end
+

data/lib/riak/walk_spec.rb

@@ -0,0 +1,105 @@
+require 'riak/util/translation'
+require 'riak/util/escape'
+require 'riak/link'
+
+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/riak-client.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{riak-client}
+  s.version = "1.0.0.pre"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sean Cribbs"]
+  s.date = %q{2011-11-18}
+  s.description = %q{riak-client is a rich client for Riak, the distributed database by Basho. It supports the full HTTP interface including storage operations, bucket configuration, link-walking and map-reduce.}
+  s.email = %q{sean@basho.com}
+  s.files = ["erl_src/riak_kv_test_backend.beam", "erl_src/riak_kv_test_backend.erl", "erl_src/riak_search_test_backend.beam", "erl_src/riak_search_test_backend.erl", "Gemfile", "Guardfile", "lib/active_support/cache/riak_store.rb", "lib/riak/bucket.rb", "lib/riak/cache_store.rb", "lib/riak/client/beefcake/messages.rb", "lib/riak/client/beefcake/object_methods.rb", "lib/riak/client/beefcake_protobuffs_backend.rb", "lib/riak/client/excon_backend.rb", "lib/riak/client/http_backend/configuration.rb", "lib/riak/client/http_backend/key_streamer.rb", "lib/riak/client/http_backend/object_methods.rb", "lib/riak/client/http_backend/request_headers.rb", "lib/riak/client/http_backend/transport_methods.rb", "lib/riak/client/http_backend.rb", "lib/riak/client/net_http_backend.rb", "lib/riak/client/protobuffs_backend.rb", "lib/riak/client/pump.rb", "lib/riak/client/search.rb", "lib/riak/client.rb", "lib/riak/core_ext/blank.rb", "lib/riak/core_ext/extract_options.rb", "lib/riak/core_ext/json.rb", "lib/riak/core_ext/slice.rb", "lib/riak/core_ext/stringify_keys.rb", "lib/riak/core_ext/symbolize_keys.rb", "lib/riak/core_ext/to_param.rb", "lib/riak/core_ext.rb", "lib/riak/encoding.rb", "lib/riak/failed_request.rb", "lib/riak/i18n.rb", "lib/riak/json.rb", "lib/riak/link.rb", "lib/riak/locale/en.yml", "lib/riak/map_reduce/filter_builder.rb", "lib/riak/map_reduce/phase.rb", "lib/riak/map_reduce.rb", "lib/riak/map_reduce_error.rb", "lib/riak/robject.rb", "lib/riak/search.rb", "lib/riak/serializers.rb", "lib/riak/stamp.rb", "lib/riak/test_server.rb", "lib/riak/util/escape.rb", "lib/riak/util/fiber1.8.rb", "lib/riak/util/headers.rb", "lib/riak/util/multipart/stream_parser.rb", "lib/riak/util/multipart.rb", "lib/riak/util/tcp_socket_extensions.rb", "lib/riak/util/translation.rb", "lib/riak/walk_spec.rb", "lib/riak.rb", "Rakefile", "riak-client.gemspec", "spec/fixtures/cat.jpg", "spec/fixtures/multipart-blank.txt", "spec/fixtures/multipart-mapreduce.txt", "spec/fixtures/multipart-with-body.txt", "spec/fixtures/server.cert.crt", "spec/fixtures/server.cert.key", "spec/fixtures/test.pem", "spec/integration/riak/cache_store_spec.rb", "spec/integration/riak/http_backends_spec.rb", "spec/integration/riak/protobuffs_backends_spec.rb", "spec/integration/riak/test_server_spec.rb", "spec/riak/beefcake_protobuffs_backend_spec.rb", "spec/riak/bucket_spec.rb", "spec/riak/client_spec.rb", "spec/riak/core_ext/to_param_spec.rb", "spec/riak/escape_spec.rb", "spec/riak/excon_backend_spec.rb", "spec/riak/headers_spec.rb", "spec/riak/http_backend/configuration_spec.rb", "spec/riak/http_backend/object_methods_spec.rb", "spec/riak/http_backend/transport_methods_spec.rb", "spec/riak/http_backend_spec.rb", "spec/riak/link_spec.rb", "spec/riak/map_reduce/filter_builder_spec.rb", "spec/riak/map_reduce/phase_spec.rb", "spec/riak/map_reduce_spec.rb", "spec/riak/multipart_spec.rb", "spec/riak/net_http_backend_spec.rb", "spec/riak/robject_spec.rb", "spec/riak/search_spec.rb", "spec/riak/serializers_spec.rb", "spec/riak/stamp_spec.rb", "spec/riak/stream_parser_spec.rb", "spec/riak/walk_spec_spec.rb", "spec/spec_helper.rb", "spec/support/drb_mock_server.rb", "spec/support/http_backend_implementation_examples.rb", "spec/support/integration_setup.rb", "spec/support/mock_server.rb", "spec/support/mocks.rb", "spec/support/test_server.yml.example", "spec/support/unified_backend_examples.rb"]
+  s.homepage = %q{http://seancribbs.github.com/ripple}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{riak-client is a rich client for Riak, the distributed database by Basho.}
+  s.test_files = ["lib/riak/walk_spec.rb", "spec/integration/riak/cache_store_spec.rb", "spec/integration/riak/http_backends_spec.rb", "spec/integration/riak/protobuffs_backends_spec.rb", "spec/integration/riak/test_server_spec.rb", "spec/riak/beefcake_protobuffs_backend_spec.rb", "spec/riak/bucket_spec.rb", "spec/riak/client_spec.rb", "spec/riak/core_ext/to_param_spec.rb", "spec/riak/escape_spec.rb", "spec/riak/excon_backend_spec.rb", "spec/riak/headers_spec.rb", "spec/riak/http_backend/configuration_spec.rb", "spec/riak/http_backend/object_methods_spec.rb", "spec/riak/http_backend/transport_methods_spec.rb", "spec/riak/http_backend_spec.rb", "spec/riak/link_spec.rb", "spec/riak/map_reduce/filter_builder_spec.rb", "spec/riak/map_reduce/phase_spec.rb", "spec/riak/map_reduce_spec.rb", "spec/riak/multipart_spec.rb", "spec/riak/net_http_backend_spec.rb", "spec/riak/robject_spec.rb", "spec/riak/search_spec.rb", "spec/riak/serializers_spec.rb", "spec/riak/stamp_spec.rb", "spec/riak/stream_parser_spec.rb", "spec/riak/walk_spec_spec.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2"])
+      s.add_development_dependency(%q<rack>, [">= 1.0"])
+      s.add_development_dependency(%q<excon>, ["~> 0.6.1"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0.4.0"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_runtime_dependency(%q<beefcake>, ["= 0.3.2"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.0.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2"])
+      s.add_dependency(%q<rack>, [">= 1.0"])
+      s.add_dependency(%q<excon>, ["~> 0.6.1"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<i18n>, [">= 0.4.0"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<beefcake>, ["= 0.3.2"])
+      s.add_dependency(%q<multi_json>, ["~> 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2"])
+    s.add_dependency(%q<rack>, [">= 1.0"])
+    s.add_dependency(%q<excon>, ["~> 0.6.1"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<i18n>, [">= 0.4.0"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<beefcake>, ["= 0.3.2"])
+    s.add_dependency(%q<multi_json>, ["~> 1.0.0"])
+  end
+end