riak-client 2.3.0 → 2.3.1

data/lib/riak/client/feature_detection.rb

@@ -1,120 +1,120 @@
-module Riak
-  class Client
-    # Methods that can be used to determine whether certain features
-    # are supported by the Riak node to which the client backend is
-    # connected.
-    #
-    # Backends must implement the "get_server_version" method,
-    # returning a string representing the Riak node's version. This is
-    # implemented on HTTP using the stats resource, and on Protocol
-    # Buffers using the RpbGetServerInfoReq message.
-    module FeatureDetection
-      # Constants representing Riak versions
-      VERSION = {
-        1 => Gem::Version.new("1.0.0"),
-        1.1 => Gem::Version.new("1.1.0"),
-        1.2 => Gem::Version.new("1.2.0"),
-        1.3 => Gem::Version.new("1.3.0"),
-        1.4 => Gem::Version.new("1.4.0")
-      }.freeze
-
-      # @return [String] the version of the Riak node
-      # @abstract
-      def get_server_version
-        raise NotImplementedError
-      end
-
-      # @return [Gem::Version] the version of the Riak node to which
-      #   this backend is connected
-      def server_version
-        @server_version ||= Gem::Version.new(get_server_version.split("-").first)
-      end
-
-      # @return [true,false] whether MapReduce requests can be submitted without
-      #   phases.
-      def mapred_phaseless?
-        at_least? VERSION[1.1]
-      end
-
-      # @return [true,false] whether secondary index queries are
-      #  supported over Protocol Buffers
-      def pb_indexes?
-        at_least? VERSION[1.2]
-      end
-
-      # @return [true,false] whether search queries are supported over
-      #   Protocol Buffers
-      def pb_search?
-        at_least? VERSION[1.2]
-      end
-
-      # @return [true,false] whether conditional fetch/store semantics
-      #   are supported over Protocol Buffers
-      def pb_conditionals?
-        at_least? VERSION[1]
-      end
-
-      # @return [true,false] whether additional quorums and FSM
-      #   controls are available, e.g. primary quorums, basic_quorum,
-      #   notfound_ok
-      def quorum_controls?
-        at_least? VERSION[1]
-      end
-
-      # @return [true,false] whether "not found" responses might
-      #   include vclocks
-      def tombstone_vclocks?
-        at_least? VERSION[1]
-      end
-
-      # @return [true,false] whether partial-fetches (vclock and
-      #   metadata only) are supported over Protocol Buffers
-      def pb_head?
-        at_least? VERSION[1]
-      end
-
-      # @return [true,false] whether bucket properties can be cleared
-      #   (reset to defaults) over HTTP
-      def http_props_clearable?
-        at_least? VERSION[1.3]
-      end
-
-      # @return [true,false] whether secondary indexes support
-      #   pagination
-      def index_pagination?
-        at_least? VERSION[1.4]
-      end
-
-      # @return [true,false] whether secondary indexes support
-      #   return_terms
-      def index_return_terms?
-        at_least? VERSION[1.4]
-      end
-
-      # @return [true,false] whether secondary indexes support
-      #   streaming
-      def index_streaming?
-        at_least? VERSION[1.4]
-      end
-
-      # @return [true,false] whether timeouts are accepted for
-      #   object CRUD, key listing, and bucket listing
-      def key_object_bucket_timeouts?
-        at_least? VERSION[1.4]
-      end
-
-      protected
-      # @return [true,false] whether the server version is the same or
-      #  newer than the requested version
-      def at_least?(version)
-        server_version >= version
-      end
-
-      # Backends should call this when their connection is interrupted
-      # or reset so as to facilitate rolling upgrades
-      def reset_server_version
-        @server_version = nil
-      end
-    end
-  end
-end
+module Riak
+  class Client
+    # Methods that can be used to determine whether certain features
+    # are supported by the Riak node to which the client backend is
+    # connected.
+    #
+    # Backends must implement the "get_server_version" method,
+    # returning a string representing the Riak node's version. This is
+    # implemented on HTTP using the stats resource, and on Protocol
+    # Buffers using the RpbGetServerInfoReq message.
+    module FeatureDetection
+      # Constants representing Riak versions
+      VERSION = {
+        1 => Gem::Version.new("1.0.0"),
+        1.1 => Gem::Version.new("1.1.0"),
+        1.2 => Gem::Version.new("1.2.0"),
+        1.3 => Gem::Version.new("1.3.0"),
+        1.4 => Gem::Version.new("1.4.0")
+      }.freeze
+
+      # @return [String] the version of the Riak node
+      # @abstract
+      def get_server_version
+        raise NotImplementedError
+      end
+
+      # @return [Gem::Version] the version of the Riak node to which
+      #   this backend is connected
+      def server_version
+        @server_version ||= Gem::Version.new(get_server_version.split("-").first)
+      end
+
+      # @return [true,false] whether MapReduce requests can be submitted without
+      #   phases.
+      def mapred_phaseless?
+        at_least? VERSION[1.1]
+      end
+
+      # @return [true,false] whether secondary index queries are
+      #  supported over Protocol Buffers
+      def pb_indexes?
+        at_least? VERSION[1.2]
+      end
+
+      # @return [true,false] whether search queries are supported over
+      #   Protocol Buffers
+      def pb_search?
+        at_least? VERSION[1.2]
+      end
+
+      # @return [true,false] whether conditional fetch/store semantics
+      #   are supported over Protocol Buffers
+      def pb_conditionals?
+        at_least? VERSION[1]
+      end
+
+      # @return [true,false] whether additional quorums and FSM
+      #   controls are available, e.g. primary quorums, basic_quorum,
+      #   notfound_ok
+      def quorum_controls?
+        at_least? VERSION[1]
+      end
+
+      # @return [true,false] whether "not found" responses might
+      #   include vclocks
+      def tombstone_vclocks?
+        at_least? VERSION[1]
+      end
+
+      # @return [true,false] whether partial-fetches (vclock and
+      #   metadata only) are supported over Protocol Buffers
+      def pb_head?
+        at_least? VERSION[1]
+      end
+
+      # @return [true,false] whether bucket properties can be cleared
+      #   (reset to defaults) over HTTP
+      def http_props_clearable?
+        at_least? VERSION[1.3]
+      end
+
+      # @return [true,false] whether secondary indexes support
+      #   pagination
+      def index_pagination?
+        at_least? VERSION[1.4]
+      end
+
+      # @return [true,false] whether secondary indexes support
+      #   return_terms
+      def index_return_terms?
+        at_least? VERSION[1.4]
+      end
+
+      # @return [true,false] whether secondary indexes support
+      #   streaming
+      def index_streaming?
+        at_least? VERSION[1.4]
+      end
+
+      # @return [true,false] whether timeouts are accepted for
+      #   object CRUD, key listing, and bucket listing
+      def key_object_bucket_timeouts?
+        at_least? VERSION[1.4]
+      end
+
+      protected
+      # @return [true,false] whether the server version is the same or
+      #  newer than the requested version
+      def at_least?(version)
+        server_version >= version
+      end
+
+      # Backends should call this when their connection is interrupted
+      # or reset so as to facilitate rolling upgrades
+      def reset_server_version
+        @server_version = nil
+      end
+    end
+  end
+end

data/lib/riak/client/instrumentation.rb

@@ -1,19 +1,19 @@
-class Riak::Client
-  include Instrumentable
-
-  client_payload = {client_id: :client_id}
-
-  instrument_method :buckets, 'riak.list_buckets', client_payload
-  instrument_method :list_buckets, 'riak.list_buckets', client_payload
-  instrument_method :list_keys, 'riak.list_keys', client_payload
-  instrument_method :set_bucket_props, 'riak.set_bucket_props', client_payload
-  instrument_method :get_bucket_props, 'riak.get_bucket_props', client_payload
-  instrument_method :clear_bucket_props, 'riak.clear_bucket_props', client_payload
-  instrument_method :get_index, 'riak.get_index', client_payload
-  instrument_method :store_object, 'riak.store_object', client_payload
-  instrument_method :get_object, 'riak.get_object', client_payload
-  instrument_method :reload_object, 'riak.reload_object', client_payload
-  instrument_method :delete_object, 'riak.delete_object', client_payload
-  instrument_method :mapred, 'riak.map_reduce', client_payload
-  instrument_method :ping, 'riak.ping', client_payload
-end
+class Riak::Client
+  include Instrumentable
+
+  client_payload = {client_id: :client_id}
+
+  instrument_method :buckets, 'riak.list_buckets', client_payload
+  instrument_method :list_buckets, 'riak.list_buckets', client_payload
+  instrument_method :list_keys, 'riak.list_keys', client_payload
+  instrument_method :set_bucket_props, 'riak.set_bucket_props', client_payload
+  instrument_method :get_bucket_props, 'riak.get_bucket_props', client_payload
+  instrument_method :clear_bucket_props, 'riak.clear_bucket_props', client_payload
+  instrument_method :get_index, 'riak.get_index', client_payload
+  instrument_method :store_object, 'riak.store_object', client_payload
+  instrument_method :get_object, 'riak.get_object', client_payload
+  instrument_method :reload_object, 'riak.reload_object', client_payload
+  instrument_method :delete_object, 'riak.delete_object', client_payload
+  instrument_method :mapred, 'riak.map_reduce', client_payload
+  instrument_method :ping, 'riak.ping', client_payload
+end

data/lib/riak/client/node.rb

@@ -1,49 +1,49 @@
-module Riak
-  class Client
-    class Node
-      # Represents a single riak node in a cluster.
-
-      include Util::Translation
-      include Util::Escape
-
-      VALID_OPTIONS = [:host, :pb_port]
-
-      # For a score which halves in 10 seconds, choose
-      # ln(1/2)/10
-      ERRORS_DECAY_RATE = Math.log(0.5)/10
-
-      # What IP address or hostname does this node listen on?
-      attr_accessor :host
-
-      # Which port does the protocol buffers interface listen on?
-      attr_accessor :pb_port
-
-      # A Decaying rate of errors.
-      attr_reader :error_rate
-
-      def initialize(client, opts = {})
-        @client = client
-        @host = opts[:host] || "127.0.0.1"
-        @pb_port = opts[:pb_port] || 8087
-
-        @error_rate = Decaying.new
-      end
-
-      def ==(o)
-        o.kind_of? Node and
-          @host == o.host and
-          @pb_port == o.pb_port
-      end
-
-      # Can this node be used for protocol buffers requests?
-      def protobuffs?
-        # TODO: Need to sort out capabilities
-        true
-      end
-
-      def inspect
-        "#<Node #{@host}:#{@pb_port}>"
-      end
-    end
-  end
-end
+module Riak
+  class Client
+    class Node
+      # Represents a single riak node in a cluster.
+
+      include Util::Translation
+      include Util::Escape
+
+      VALID_OPTIONS = [:host, :pb_port]
+
+      # For a score which halves in 10 seconds, choose
+      # ln(1/2)/10
+      ERRORS_DECAY_RATE = Math.log(0.5)/10
+
+      # What IP address or hostname does this node listen on?
+      attr_accessor :host
+
+      # Which port does the protocol buffers interface listen on?
+      attr_accessor :pb_port
+
+      # A Decaying rate of errors.
+      attr_reader :error_rate
+
+      def initialize(client, opts = {})
+        @client = client
+        @host = opts[:host] || "127.0.0.1"
+        @pb_port = opts[:pb_port] || 8087
+
+        @error_rate = Decaying.new
+      end
+
+      def ==(o)
+        o.kind_of? Node and
+          @host == o.host and
+          @pb_port == o.pb_port
+      end
+
+      # Can this node be used for protocol buffers requests?
+      def protobuffs?
+        # TODO: Need to sort out capabilities
+        true
+      end
+
+      def inspect
+        "#<Node #{@host}:#{@pb_port}>"
+      end
+    end
+  end
+end

data/lib/riak/client/search.rb

@@ -1,27 +1,27 @@
-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
-      backend do |b|
-        b.search(index, query, options)
-      end
-    end
-    alias :select :search
-  end
-end
+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
+      backend do |b|
+        b.search(index, query, options)
+      end
+    end
+    alias :select :search
+  end
+end

data/lib/riak/conflict.rb

@@ -1,13 +1,13 @@
-require 'riak/util/translation'
-
-module Riak
-  # Raised when an object that is in conflict (i.e. has siblings) is
-  # stored or manipulated as if it had a single value.
-  class Conflict < StandardError
-    include Util::Translation
-
-    def initialize(robject)
-      super t('object_in_conflict', :robject => robject.inspect)
-    end
-  end
-end
+require 'riak/util/translation'
+
+module Riak
+  # Raised when an object that is in conflict (i.e. has siblings) is
+  # stored or manipulated as if it had a single value.
+  class Conflict < StandardError
+    include Util::Translation
+
+    def initialize(robject)
+      super t('object_in_conflict', :robject => robject.inspect)
+    end
+  end
+end