riak-client 0.8.2 → 0.8.3

data/Gemfile

@@ -1,13 +1,22 @@
-# A sample Gemfile
 source :gemcutter
 
-gem 'activesupport', '~>2.3.5' #'~>3.0.0'
 gem 'i18n'
-
+gem 'builder'
 gem 'rspec', "~>2.0.0"
 gem 'fakeweb', ">=1.2"
 gem 'rack', '>=1.0'
-gem 'curb', '>=0.6'
-gem 'yajl-ruby'
 gem 'rake'
 gem 'bundler'
+gem 'excon', "~>0.3.4"
+
+if defined? JRUBY_VERSION
+  gem 'json'
+  gem 'jruby-openssl'
+else
+  gem 'curb', '>=0.6'
+  gem 'yajl-ruby'
+end
+
+group :integration do
+  gem 'activesupport', '~>3.0'
+end

data/Rakefile

@@ -6,32 +6,85 @@ gemspec = Gem::Specification.new do |gem|
   gem.summary = %Q{riak-client is a rich client for Riak, the distributed database by Basho.}
   gem.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.}
   gem.version = File.read('../VERSION').strip
-  gem.email = "seancribbs@gmail.com"
+  gem.email = "sean@basho.com"
   gem.homepage = "http://seancribbs.github.com/ripple"
   gem.authors = ["Sean Cribbs"]
   gem.add_development_dependency "rspec", "~>2.0.0"
   gem.add_development_dependency "fakeweb", ">=1.2"
   gem.add_development_dependency "rack", ">=1.0"
   gem.add_development_dependency "curb", ">=0.6"
-  gem.add_dependency "activesupport", ">= 2.3.5"
-  gem.add_dependency "i18n", "~>0.4.0"
-  gem.requirements << "`gem install curb` for better HTTP performance"
+  gem.add_development_dependency "excon", "~>0.3.4"
+  gem.add_dependency "i18n", ">=0.4.0"
+  gem.add_dependency "builder", "~>2.1.2"
 
-  files = FileList["**/*"]
-  files.exclude /\.DS_Store/
-  files.exclude /\#/
-  files.exclude /~/
-  files.exclude /\.swp/
-  files.exclude '**/._*'
-  files.exclude '**/*.orig'
-  files.exclude '**/*.rej'
-  files.exclude /^pkg/
-  files.exclude 'riak-client.gemspec'
-  files.exclude 'spec/support/test_server.yml'
+  gem.files = %W{
+                  erl_src/riak_kv_test_backend.beam
+                  erl_src/riak_kv_test_backend.erl
+                  Gemfile
+                  lib/active_support/cache/riak_store.rb
+                  lib/riak/bucket.rb
+                  lib/riak/cache_store.rb
+                  lib/riak/client/curb_backend.rb
+                  lib/riak/client/excon_backend.rb
+                  lib/riak/client/http_backend.rb
+                  lib/riak/client/net_http_backend.rb
+                  lib/riak/client.rb
+                  lib/riak/core_ext/blank.rb
+                  lib/riak/core_ext/extract_options.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/failed_request.rb
+                  lib/riak/i18n.rb
+                  lib/riak/invalid_response.rb
+                  lib/riak/link.rb
+                  lib/riak/locale
+                  lib/riak/locale/en.yml
+                  lib/riak/map_reduce.rb
+                  lib/riak/map_reduce_error.rb
+                  lib/riak/robject.rb
+                  lib/riak/search.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.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-with-body.txt
+                  spec/integration/riak/cache_store_spec.rb
+                  spec/integration/riak/test_server_spec.rb
+                  spec/riak/bucket_spec.rb
+                  spec/riak/client_spec.rb
+                  spec/riak/curb_backend_spec.rb
+                  spec/riak/escape_spec.rb
+                  spec/riak/excon_backend_spec.rb
+                  spec/riak/headers_spec.rb
+                  spec/riak/http_backend_spec.rb
+                  spec/riak/link_spec.rb
+                  spec/riak/map_reduce_spec.rb
+                  spec/riak/multipart_spec.rb
+                  spec/riak/net_http_backend_spec.rb
+                  spec/riak/object_spec.rb
+                  spec/riak/search_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/mock_server.rb
+                  spec/support/mocks.rb
+                  spec/support/test_server.yml.example
+              }
 
-  gem.files = files.to_a
-
-  gem.test_files = FileList["spec/**/*.rb"].to_a
+  gem.test_files = gem.files.grep(/_spec\.rb$/)
 end
 
 # Gem packaging tasks

data/lib/riak.rb

@@ -13,16 +13,25 @@
 #    limitations under the License.
 $KCODE = "UTF8" if RUBY_VERSION < "1.9"
 
-require 'active_support/all'
-require 'active_support/json'
-require 'active_support/version'
 require 'base64'
 require 'uri'
 require 'cgi'
+require 'set'
 require 'net/http'
 require 'yaml'
 require 'riak/i18n'
 
+# Load JSON
+unless defined? JSON
+  begin
+    require 'yajl/json_gem'
+  rescue LoadError
+    require 'json'
+  end
+end
+
+require 'riak/core_ext'
+
 # The Riak module contains all aspects of the HTTP client interface
 # to Riak.
 module Riak
@@ -35,9 +44,7 @@ module Riak
   autoload :MapReduce,       "riak/map_reduce"
 
   # Cache store - only supports Rails 3 style
-  if ActiveSupport::VERSION::STRING >= "3.0.0"
-    autoload :CacheStore,      "riak/cache_store"
-  end
+  autoload :CacheStore,      "riak/cache_store"
 
   # Exceptions
   autoload :FailedRequest,   "riak/failed_request"

data/lib/riak/bucket.rb

@@ -41,10 +41,11 @@ module Riak
     # @return [Bucket] self
     # @see Client#bucket
     def load(response={})
-      unless response.try(:[], :headers).try(:[],'content-type').try(:first) =~ /json$/
+      content_type = response[:headers]['content-type'].first rescue ""
+      unless content_type =~ /json$/
         raise Riak::InvalidResponse.new({"content-type" => ["application/json"]}, response[:headers], t("loading_bucket", :name => name))
       end
-      payload = ActiveSupport::JSON.decode(response[:body])
+      payload = JSON.parse(response[:body])
       @keys = payload['keys'].map {|k| CGI.unescape(k) }  if payload['keys']
       @props = payload['props'] if payload['props']
       self
@@ -61,7 +62,8 @@ module Riak
     def keys(options={})
       if block_given?
         @client.http.get(200, @client.prefix, escape(name), {:props => false, :keys => 'stream'}, {}) do |chunk|
-          obj = ActiveSupport::JSON.decode(chunk) rescue {}
+          obj = JSON.parse(chunk) rescue nil
+          next unless obj and obj['keys']
           yield obj['keys'].map {|k| CGI.unescape(k) } if obj['keys']
         end
       elsif @keys.nil? || options[:reload]
@@ -97,13 +99,14 @@ module Riak
       @client.http.put(204, @client.prefix, escape(name), body, {"Content-Type" => "application/json"})
       @props.merge!(properties)
     end
+    alias properties= props=
 
     # @return [Hash] Internal Riak bucket properties.
     # @see #props=
     def props
       @props
     end
-    alias_attribute :properties, :props
+    alias properties props
 
     # Retrieve an object from within the bucket.
     # @param [String] key the key of the object to retrieve

data/lib/riak/cache_store.rb

@@ -12,6 +12,12 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 require 'riak'
+require 'active_support/version'
+if ActiveSupport::VERSION::STRING < "3.0.0"
+  raise LoadError, "ActiveSupport 3.0.0 or greater is required to use Riak::CacheStore."
+else
+  require 'active_support/cache'
+end
 
 module Riak
   # An ActiveSupport::Cache::Store implementation that uses Riak.
@@ -71,7 +77,7 @@ module Riak
       begin
         bucket.get(key).data
       rescue Riak::FailedRequest => fr
-        raise fr unless fr.code == 404
+        raise fr unless fr.code.to_i == 404
         nil
       end
     end

data/lib/riak/client.rb

@@ -24,6 +24,7 @@ module Riak
     autoload :HTTPBackend,    "riak/client/http_backend"
     autoload :NetHTTPBackend, "riak/client/net_http_backend"
     autoload :CurbBackend,    "riak/client/curb_backend"
+    autoload :ExconBackend,   "riak/client/excon_backend"
 
     # When using integer client IDs, the exclusive upper-bound of valid values.
     MAX_CLIENT_ID = 4294967296
@@ -49,6 +50,9 @@ module Riak
     # @return [String] The URL path to the luwak HTTP endpoint
     attr_accessor :luwak
 
+    # @return [Symbol] The HTTP backend/client to use
+    attr_accessor :http_backend
+
     # Creates a client connection to 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
@@ -56,15 +60,19 @@ module Riak
     # @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
+    # @option options [String, Symbol] :http_backend (:NetHTTP) which  HTTP backend to use
     # @raise [ArgumentError] raised if any options are invalid
     def initialize(options={})
-      options.assert_valid_keys(:host, :port, :prefix, :client_id, :mapred, :luwak)
-      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]    || "/riak/"
-      self.mapred    = options[:mapred]    || "/mapred"
-      self.luwak     = options[:luwak]     || "/luwak"
+      unless (options.keys - [:host, :port, :prefix, :client_id, :mapred, :luwak, :http_backend]).empty?
+        raise ArgumentError, "invalid options"
+      end
+      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]       || "/riak/"
+      self.mapred       = options[:mapred]       || "/mapred"
+      self.luwak        = options[:luwak]        || "/luwak"
+      self.http_backend = options[:http_backend] || :NetHTTP
       raise ArgumentError, t("missing_host_and_port") unless @host && @port
     end
 
@@ -101,17 +109,24 @@ module Riak
       @port = value
     end
 
+    # Sets the desired HTTP backend
+    def http_backend=(value)
+      @http = nil
+      @http_backend = value
+    end
+
     # Automatically detects and returns an appropriate HTTP backend.
     # The HTTP backend is used internally by the Riak client, but can also
     # be used to access the server directly.
     # @return [HTTPBackend] the HTTP backend for this client
     def http
       @http ||= begin
-                  require 'curb'
-                  CurbBackend.new(self)
-                rescue LoadError, NameError
-                  warn t("install_curb")
-                  NetHTTPBackend.new(self)
+                  klass = self.class.const_get("#{@http_backend}Backend")
+                  if klass.configured?
+                    klass.new(self)
+                  else
+                    raise t('http_configuration', :backend => @http_backend)
+                  end
                 end
     end
 
@@ -122,7 +137,9 @@ module Riak
     # @option options [Boolean] :props (true) whether to retreive the bucket properties
     # @return [Bucket] the requested bucket
     def bucket(name, options={})
-      options.assert_valid_keys(:keys, :props)
+      unless (options.keys - [:keys, :props]).empty?
+        raise ArgumentError, "invalid options"
+      end
       response = http.get(200, prefix, escape(name), {:keys => false}.merge(options), {})
       Bucket.new(self, name).load(response)
     end
@@ -185,7 +202,7 @@ module Riak
       http.delete([204,404], luwak, escape(filename))
       true
     end
-    
+
     # Checks whether a file exists in "Luwak".
     # @param [String] key the key to check
     # @return [true, false] whether the key exists in "Luwak"

data/lib/riak/client/curb_backend.rb

@@ -22,14 +22,21 @@ end
 module Riak
   class Client
     # An HTTP backend for Riak::Client that uses the 'curb' library/gem.
-    # If the 'curb' library is present, this backend will be preferred to
-    # the backend based on Net::HTTP.
     # Conforms to the Riak::Client::HTTPBackend interface.
     class CurbBackend < HTTPBackend
+      def self.configured?
+        begin
+          require 'curb'
+          true
+        rescue LoadError
+          false
+        end
+      end
+
       private
       def perform(method, uri, headers, expect, data=nil)
         # Setup
-        curl.headers = create_request_headers(headers)
+        curl.headers = RequestHeaders.new(headers).to_a
         curl.url = uri.to_s
         response_headers.initialize_http_header(nil)
         if block_given?
@@ -53,7 +60,7 @@ module Riak
           # 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.headers = RequestHeaders.new(curl.headers).to_a + _headers
           curl.http("PUT")
         else
           curl.send("http_#{method}")
@@ -80,20 +87,6 @@ module Riak
           end
         end
       end
-
-      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/excon_backend.rb

@@ -0,0 +1,60 @@
+# 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
+  class Client
+    # An HTTP backend for Riak::Client that uses Wesley Beary's Excon
+    # HTTP library. Comforms to the Riak::Client::HTTPBackend
+    # interface.
+    class ExconBackend < HTTPBackend
+      def self.configured?
+        begin
+          require 'excon'
+          Excon::VERSION >= "0.3.4"
+        rescue LoadError
+          false
+        end
+      end
+
+      private
+      def perform(method, uri, headers, expect, data=nil, &block)
+        params = {
+          :method => method.to_s.upcase,
+          :headers => RequestHeaders.new(headers).to_hash,
+          :path => uri.path
+        }
+        params[:query] = uri.query if uri.query
+        params[:body] = data if [:put,:post].include?(method)
+        params[:idempotent] = (method != :post)
+
+        response = connection.request(params, &block)
+        if valid_response?(expect, response.status)
+          response_headers.initialize_http_header(response.headers)
+          result = {:headers => response_headers.to_hash, :code => response.status}
+          if return_body?(method, response.status, block_given?)
+            result[:body] = response.body
+          end
+          result
+        else
+          raise FailedRequest.new(method, expect, response.status, response.headers, response.body)
+        end
+      end
+
+      def connection
+        @connection ||= Excon::Connection.new(root_uri.to_s)
+      end
+    end
+  end
+end

data/lib/riak/client/http_backend.rb

@@ -171,7 +171,7 @@ module Riak
         resource = Array(resource).flatten
         raise ArgumentError, t("resource_path_short") unless resource.length > 1 || resource.include?(@client.mapred)
       end
-      
+
       # Checks the expected response codes against the actual response code. Use internally when
       # implementing {#perform}.
       # @param [String, Fixnum, Array<String,Fixnum>] expected the expected response code(s)
@@ -190,7 +190,7 @@ module Riak
       def return_body?(method, code, has_block)
         method != :head && !valid_response?([204,205,304], code) && !has_block
       end
-      
+
       # Executes requests according to the underlying HTTP client library semantics.
       # @abstract Subclasses must implement this internal method to perform HTTP requests
       #           according to the API of their HTTP libraries.
@@ -205,6 +205,37 @@ module Riak
       def perform(method, uri, headers, expect, body=nil)
         raise NotImplementedError
       end
+
+      private
+      def response_headers
+        Thread.current[:response_headers] ||= Riak::Util::Headers.new
+      end
+
+      # @private
+      class RequestHeaders < Riak::Util::Headers
+        alias each each_capitalized
+
+        def initialize(hash)
+          initialize_http_header(hash)
+        end
+
+        def to_a
+          [].tap do |arr|
+            each_capitalized do |k,v|
+              arr << "#{k}: #{v}"
+            end
+          end
+        end
+
+        def to_hash
+          {}.tap do |hash|
+            each_capitalized do |k,v|
+              hash[k] ||= []
+              hash[k] << v
+            end
+          end
+        end
+      end
     end
   end
 end