riak-client 0.9.8 → 1.0.0.beta

data/lib/riak/client/protobuffs_backend.rb

@@ -1,16 +1,3 @@
-# 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'
 require 'socket'
 require 'base64'
@@ -68,6 +55,18 @@ module Riak
       simple :server_info,   :GetServerInfoReq
       simple :list_buckets,  :ListBucketsReq
 
+      # Performs a secondary-index query via emulation through MapReduce.
+      # @param [String, Bucket] bucket the bucket to query
+      # @param [String] index the index to query
+      # @param [String, Integer, Range] query the equality query or
+      #   range query to perform
+      # @return [Array<String>] a list of keys matching the query
+      def get_index(bucket, index, query)
+        mapred(Riak::MapReduce.new(client).
+               index(bucket, index, query).
+               reduce(%w[riak_kv_mapreduce reduce_identity], :arg => {:reduce_phase_only_1 => true}, :keep => true)).map {|p| p.last }
+      end
+
       private
       # Implemented by subclasses
       def decode_response
@@ -85,7 +84,7 @@ module Riak
       end
 
       def reset_socket
-        socket.close
+        socket.close if !socket.closed?
         Thread.current[:riakpbc_socket] = nil
       end
 
@@ -97,13 +96,16 @@ module Riak
         "default" => UINTMAX - 4
       }.freeze
 
-      def normalize_quorum_value(q)
-        QUORUMS[q.to_s] || q.to_i
+      def normalize_quorums(options={})
+        options.dup.tap do |o|
+          [:r, :pr, :w, :pw, :dw, :rw].each do |k|
+            o[k] = normalize_quorum_value(o[k]) if o[k]
+          end
+        end
       end
 
-      # This doesn't give us exactly the keygen that Riak uses, but close.
-      def generate_key
-        Base64.encode64(Digest::SHA1.digest(Socket.gethostname + Time.now.iso8601(3))).tr("+/","-_").sub(/=+\n$/,'')
+      def normalize_quorum_value(q)
+        QUORUMS[q.to_s] || q.to_i
       end
     end
   end

data/lib/riak/client/pump.rb

@@ -1,16 +1,3 @@
-# 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.
 
 begin
   require 'fiber'
@@ -21,7 +8,7 @@ end
 module Riak
   class Client
     # @private
-    class Pump      
+    class Pump
       def initialize(block)
         @fiber = Fiber.new do
           loop do
@@ -33,7 +20,6 @@ module Riak
 
       def pump(input)
         @fiber.resume input
-        input.size if input.respond_to?(:size) # for curb
       end
 
       def to_proc

data/lib/riak/client/search.rb

@@ -0,0 +1,85 @@
+require 'builder'
+
+module Riak
+  class Client
+    # (Riak Search) Performs a search via the Solr interface.
+    # @overload search(index, query, options={})
+    #   @param [String] index the index to query on
+    #   @param [String] query a Lucene query string
+    # @overload search(query, options={})
+    #   Queries the default index
+    #   @param [String] query a Lucene query string
+    # @param [Hash] options extra options for the Solr query
+    # @option options [String] :df the default field to search in
+    # @option options [String] :'q.op' the default operator between terms ("or", "and")
+    # @option options [String] :wt ("json") the response type - "json" and "xml" are valid
+    # @option options [String] :sort ('none') the field and direction to sort, e.g. "name asc"
+    # @option options [Fixnum] :start (0) the offset into the query to start from, e.g. for pagination
+    # @option options [Fixnum] :rows (10) the number of results to return
+    # @return [Hash] the query result, containing the 'responseHeaders' and 'response' keys
+    def search(*args)
+      options = args.extract_options!
+      index, query = args[-2], args[-1]  # Allows nil index, while keeping it as firstargument
+      http.search(index, query, options)
+    end
+    alias :select :search
+
+    # (Riak Search) Adds documents to a search index via the Solr interface.
+    # @overload index(index, *docs)
+    #   Adds documents to the specified search index
+    #   @param [String] index the index in which to add/update the given documents
+    #   @param [Array<Hash>] docs unnested document hashes, with one key per field
+    # @overload index(*docs)
+    #   Adds documents to the default search index
+    #   @param [Array<Hash>] docs unnested document hashes, with one key per field
+    # @raise [ArgumentError] if any documents don't include 'id' key
+    def index(*args)
+      index = args.shift if String === args.first # Documents must be hashes of fields
+      raise ArgumentError.new(t("search_docs_require_id")) unless args.all? {|d| d.key?("id") || d.key?(:id) }
+      xml = Builder::XmlMarkup.new
+      xml.add do
+        args.each do |doc|
+          xml.doc do
+            doc.each do |k,v|
+              xml.field('name' => k.to_s) { xml.text!(v.to_s) }
+            end
+          end
+        end
+      end
+      http.update_search_index(index, xml.target!)
+      true
+    end
+    alias :add_doc :index
+
+    # (Riak Search) Removes documents from a search index via the Solr interface.
+    # @overload remove(index, specs)
+    #   Removes documents from the specified index
+    #   @param [String] index the index from which to remove documents
+    #   @param [Array<Hash>] specs the specificaiton of documents to remove (must contain 'id' or 'query' keys)
+    # @overload remove(specs)
+    #   Removes documents from the default index
+    #   @param [Array<Hash>] specs the specification of documents to remove (must contain 'id' or 'query' keys)
+    # @raise [ArgumentError] if any document specs don't include 'id' or 'query' keys
+    def remove(*args)
+      index = args.shift if String === args.first
+      raise ArgumentError.new(t("search_remove_requires_id_or_query")) unless args.all? { |s|
+        s.include? :id or
+        s.include? 'id' or
+        s.include? :query or
+        s.include? 'query'
+      }
+      xml = Builder::XmlMarkup.new
+      xml.delete do
+        args.each do |spec|
+          spec.each do |k,v|
+            xml.tag!(k.to_sym, v)
+          end
+        end
+      end
+      http.update_search_index(index, xml.target!)
+      true
+    end
+    alias :delete_doc :remove
+    alias :deindex :remove
+  end
+end

data/lib/riak/cluster.rb

@@ -0,0 +1,151 @@
+require 'pathname'
+require 'riak/node'
+require 'riak/util/translation'
+
+module Riak
+  # Generates and controls a cluster of {Riak::Node} instances for use
+  # in development or testing on a single machine.
+  class Cluster
+    include Util::Translation
+    # @return [Array<Node>] the member Nodes of this cluster
+    attr_reader :nodes
+
+    # @return [Hash] the cluster configuration
+    attr_reader :configuration
+
+    # @return [Pathname] the root directory of the cluster
+    attr_reader :root
+
+    # Creates a {Cluster} of {Node}s.
+    # @param [Hash] config the configuration for the cluster
+    # @option config [Fixnum] :count the number of nodes to create
+    # @option config [String] :source path to the Riak bin/ directory.
+    #   See {Node#source}.
+    # @option config [String] :root path to where the nodes will be
+    #   generated.
+    # @option config [Fixnum] :min_port the base port number from
+    #   which nodes will claim IP ports for HTTP, PB, handoff.
+    def initialize(config={})
+      raise ArgumentError, t('source_and_root_required') unless config[:source] && config[:root]
+      @configuration = config
+      @count = config.delete(:count) || 4
+      @min_port = config.delete(:min_port) || 9000
+      @root = Pathname.new(config.delete(:root))
+      @nodes = []
+      cookie = "#{rand(100000).to_s}_#{rand(1000000).to_s}"
+      @count.times do |i|
+        nodes << Riak::Node.new(config.merge(:min_port => @min_port + (i * 3),
+                                             :root => @root + (i+1).to_s,
+                                             :cookie => cookie))
+      end
+    end
+
+    # @return [true,false] whether the cluster has been created
+    def exist?
+      root.directory? && nodes.all? {|n| n.exist? }
+    end
+
+    # Generates all nodes in the cluster.
+    def create
+      unless exist?
+        root.mkpath unless root.exist?
+        nodes.each {|n| n.create }
+      end
+    end
+
+    # Removes all nodes in the cluster and the root, and freezes the
+    # object.
+    def destroy
+      nodes.each {|n| n.destroy }
+      root.rmtree if root.exist?
+      freeze
+    end
+
+    # Removes and recreates the cluster.
+    def recreate
+      stop unless stopped?
+      root.rmtree if root.exist?
+      create
+    end
+
+    # Drops all data from the cluster without destroying the nodes.
+    def drop
+      nodes.each {|n| n.drop }
+    end
+
+    # Starts all nodes in the cluster.
+    def start
+      nodes.each {|n| n.start }
+    end
+
+    # Stops all nodes in the cluster.
+    def stop
+      nodes.each {|n| n.stop }
+    end
+
+    # Restarts all nodes in the cluster (without exiting the Erlang
+    # runtime)
+    def restart
+      nodes.each {|n| n.restart }
+    end
+
+    # Reboots all nodes in the cluster
+    def reboot
+      nodes.each {|n| n.reboot }
+    end
+
+    # Forces the cluster nodes to restart/reload their JavaScript VMs,
+    # effectively reloading any user-provided code.
+    def js_reload
+      nodes.each {|n| n.js_reload }
+    end
+
+    # Attaches to the console on all nodes, returning a list of
+    # {Riak::Node::Console} objects.
+    # @return [Array<Riak::Node::Console>] consoles for all running
+    #   nodes, with nil for nodes that aren't running or otherwise
+    #   fail to connect
+    def attach
+      nodes.map do |n|
+        begin
+          n.attach
+        rescue ArgumentError, SystemCallError
+          nil
+        end
+      end
+    end
+
+    # Executes the given block on each node against the node's
+    # console. You could use this to send Erlang commands to all nodes
+    # in the cluster.
+    # @yield [console] A block of commands to be run against the
+    #   console
+    # @yieldparam [Riak::Node::Console] console A console manager for
+    #   sending commands to the current node in the iteration
+    def with_console(&block)
+      nodes.each do |n|
+        n.with_console(&block)
+      end
+    end
+
+    # Is the cluster started?
+    def started?
+      nodes.all? {|n| n.started? }
+    end
+
+    # Is the cluster stopped?
+    def stopped?
+      nodes.all? {|n| n.stopped? }
+    end
+
+    # Joins the nodes together into a cluster.
+    # @note This method relies on cluster membership changes present
+    #   in the 1.0 series of Riak, and is NOT safe on 0.14 and
+    #   earlier.
+    def join
+      claimant = nodes.first.name # Not really the claimant, just a
+                                  # node to join to
+      nodes[1..-1].each {|n| n.join(claimant) unless n.peers.include?(claimant) }
+    end
+  end
+end

data/lib/riak/core_ext.rb

@@ -4,3 +4,4 @@ require 'riak/core_ext/slice'
 require 'riak/core_ext/stringify_keys'
 require 'riak/core_ext/symbolize_keys'
 require 'riak/core_ext/to_param'
+require 'riak/core_ext/deep_dup'

data/lib/riak/core_ext/deep_dup.rb

@@ -0,0 +1,13 @@
+unless {}.respond_to?(:deep_dup)
+  class Hash
+    # Returns a deep copy of hash.
+    def deep_dup
+      duplicate = self.dup
+      duplicate.each_pair do |k,v|
+        tv = duplicate[k]
+        duplicate[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_dup : v
+      end
+      duplicate
+    end
+  end
+end

data/lib/riak/core_ext/json.rb

@@ -0,0 +1,15 @@
+unless Object.new.respond_to?(:to_json)
+  # @private
+  class Object
+    def to_json(*args)
+      Riak::JSON.encode(self)
+    end
+  end
+
+  # @private
+  class Symbol
+    def to_json(*args)
+      to_s.to_json(*args)
+    end
+  end
+end

data/lib/riak/core_ext/stringify_keys.rb

@@ -1,7 +1,7 @@
 unless {}.respond_to? :stringify_keys
   class Hash
     def stringify_keys
-      inject({}) do |hash, pair| 
+      inject({}) do |hash, pair|
         hash[pair[0].to_s] = pair[1]
         hash
       end

data/lib/riak/core_ext/symbolize_keys.rb

@@ -1,7 +1,7 @@
 unless {}.respond_to? :symbolize_keys
   class Hash
     def symbolize_keys
-      inject({}) do |hash, pair| 
+      inject({}) do |hash, pair|
         hash[pair[0].to_sym] = pair[1]
         hash
       end

data/lib/riak/encoding.rb

@@ -0,0 +1,6 @@
+if defined? Encoding
+  Encoding.default_internal = "UTF-8" if Encoding.default_internal.nil? ||
+                                        !Encoding.default_internal.ascii_compatible?
+else
+  $KCODE = "U"
+end

data/lib/riak/failed_request.rb

@@ -1,16 +1,3 @@
-# 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/util/translation'
 require 'riak/json'
@@ -48,7 +35,7 @@ module Riak
     def is_json?
       headers['content-type'].include?('application/json')
     end
-    
+
     # @return [true,false] whether the error represents a "not found" response
     def not_found?
       @code.to_i == 404
@@ -79,7 +66,7 @@ module Riak
         false
       end
     end
-    
+
     # @return [true,false] whether the error represents a "not found" response
     def not_found?
       @not_found

data/lib/riak/i18n.rb

@@ -1,16 +1,3 @@
-# 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 'i18n'
 
 I18n.load_path << File.expand_path("../locale/en.yml", __FILE__)