mt-libcouchbase 1.4.0

data/lib/mt-libcouchbase/design_docs.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+module MTLibcouchbase
+    class DesignDocs
+        def initialize(bucket, connection, result_meth, **opts)
+            @connection = connection
+            @result = result_meth
+            @bucket = bucket # This reference is required to keep to the connection alive
+
+            opts[:type] = :management
+            result(@connection.http("/pools/default/buckets/#{connection.bucket}/ddocs", **opts).then(proc { |resp|
+                @ddocs = if resp.body.length > 0
+                    JSON.parse(resp.body, Connection::DECODE_OPTIONS)[:rows] || []
+                else
+                    []
+                end
+            }))
+        end
+
+        def designs
+            # Remove '_design/' from the id string
+            @ddocs.map { |row| row[:doc][:meta][:id][8..-1] }
+        end
+
+        def design(name)
+            name = name.to_s
+            
+            des = nil
+            short = nil
+
+            @ddocs.each do |row|
+                full = row[:doc][:meta][:id]
+                short = full[8..-1]
+
+                if [short, full].include? name
+                    des = row[:doc]
+                    break
+                end
+            end
+
+            des ? DesignDoc.new(short, des, @bucket, @connection, @result) : nil
+        end
+        alias_method :[], :design
+
+
+        protected
+
+
+        # This is a proxy to the Bucket#result method
+        def result(promise)
+            @result.call(promise)
+        end
+    end
+
+    class DesignDoc
+        def initialize(id, row, bucket, connection, result_meth)
+            @connection = connection
+            @result = result_meth
+            @bucket = bucket
+            @row = row
+            @id = id
+        end
+
+        def views
+            @row[:json][:views].keys
+        end
+
+        def view(name, extended: false, **opts, &blk)
+            name = name.to_sym
+            entry = @row[:json][:views][name]
+            if entry
+                @bucket.view(@id, name, **opts, &blk)
+            else
+                nil
+            end
+        end
+        alias_method :[], :view
+
+        def view_config
+            @row[:json][:views]
+        end
+
+
+        protected
+
+
+        # This is a proxy to the Bucket#result method
+        def result(promise)
+            @result.call(promise)
+        end
+    end
+end

data/lib/mt-libcouchbase/error.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+module MTLibcouchbase
+    class Error < ::StandardError; end
+
+    class Error < ::StandardError
+        class UnknownError < ::MTLibcouchbase::Error; end
+        class HttpResponseError < ::MTLibcouchbase::Error
+            attr_accessor :code, :headers, :body
+        end
+        Lookup = {}
+
+        # Borrowed from:
+        # https://github.com/rails/rails/blob/f2489f493b794ee83a86e746b6240031acb8994e/activesupport/lib/active_support/inflector/methods.rb#L66
+        def self.camelize(term, uppercase_first_letter = true)
+            string = term.to_s
+            if uppercase_first_letter
+                string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+            else
+                string = string.sub(/^(?:#{inflections.acronym_regex}(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+            end
+            string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+            string.gsub!('/', '::')
+            string
+        end
+
+        # Dynamically define the error classes
+        Ignore = ['empty', 'error', 'environment']
+        Map = {
+            'noent'  => 'not_found',
+            'nomem'  => 'no_memory',
+            'noconf' => 'no_config',
+            '2big'   => 'too_big',
+            '2deep'  => 'too_deep',
+            'inval'  => 'invalid'
+        }
+        Ext::ErrorT.symbols.map { |val|
+            # Remove the 'e' character from the start of errors and
+            # Improve descriptions
+            new_val = val.to_s.split('_')
+                .map { |val| (val[0] == 'e' && !Ignore.include?(val)) ? val[1..-1] : val }
+                .map { |val| Map[val] || val }
+                .join('_')
+
+            [val, camelize(new_val).to_sym]
+        }.each do |enum, name|
+            Lookup[enum] = begin
+                # Ensure the constant doesn't exist
+                ::MTLibcouchbase::Error.const_get(name)
+            rescue NameError => e 
+                # Build the constants
+                klass = Class.new(::MTLibcouchbase::Error)
+                ::MTLibcouchbase::Error.const_set(name, klass)
+                klass
+            end
+        end
+
+        # Re-assign the errors that are equivalent
+        Lookup[:not_stored] = KeyNotFound
+        Lookup[:error]      = UnknownError
+
+        # Provide a helper
+        def self.lookup(key)
+            look = key.is_a?(Numeric) ? Ext::ErrorT[key] : key.to_sym
+            Lookup[look] || UnknownError
+        end
+    end
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdbase.rb

@@ -0,0 +1,23 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  class CMDBASE < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdcounter.rb

@@ -0,0 +1,36 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :delta ::
+  #   (Integer) Delta value. If this number is negative the item on the server is
+  #   decremented. If this number is positive then the item on the server
+  #   is incremented
+  # :initial ::
+  #   (Integer) If the item does not exist on the server (and `create` is true) then
+  #   this will be the initial value for the item.
+  # :create ::
+  #   (Integer) Boolean value. Create the item and set it to `initial` if it does not
+  #   already exist
+  class CMDCOUNTER < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :delta, :long_long,
+           :initial, :ulong_long,
+           :create, :int
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdendure.rb

@@ -0,0 +1,26 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :mutation_token ::
+  #   (MUTATIONTOKEN)
+  class CMDENDURE < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :mutation_token, MUTATIONTOKEN.by_ref
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdfts.rb

@@ -0,0 +1,24 @@
+module MTLibcouchbase::Ext
+  # @brief Search Command
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer) Modifiers for command. Currently none are defined
+  # :query ::
+  #   (String) Encoded JSON query
+  # :nquery ::
+  #   (Integer) Length of JSON query
+  # :callback ::
+  #   (Proc(callback_ftscallback)) Callback to be invoked. This must be supplied
+  # :handle ::
+  #   (FFI::Pointer(*FTSHANDLE)) Optional pointer to store the handle. The handle may then be
+  #   used for query cancellation via lcb_fts_cancel()
+  class CMDFTS < FFI::Struct
+    layout :cmdflags, :uint,
+           :query, :pointer,
+           :nquery, :ulong,
+           :callback, :ftscallback,
+           :handle, :pointer
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdget.rb

@@ -0,0 +1,30 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :lock ::
+  #   (Integer) If set to true, the `exptime` field inside `options` will take to mean
+  #   the time the lock should be held. While the lock is held, other operations
+  #   trying to access the key will fail with an `LCB_ETMPFAIL` error. The
+  #   item may be unlocked either via `lcb_unlock3()` or via a mutation
+  #   operation with a supplied CAS
+  class CMDGET < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :lock, :int
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdgetreplica.rb

@@ -0,0 +1,49 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :strategy ::
+  #   (ReplicaT) Strategy for selecting a replica. The default is ::LCB_REPLICA_FIRST
+  #   which results in the client trying each replica in sequence until a
+  #   successful reply is found, and returned in the callback.
+  #
+  #   ::LCB_REPLICA_FIRST evaluates to 0.
+  #
+  #   Other options include:
+  #   <ul>
+  #   <li>::LCB_REPLICA_ALL - queries all replicas concurrently and dispatches
+  #   a callback for each reply</li>
+  #   <li>::LCB_REPLICA_SELECT - queries a specific replica indicated in the
+  #   #index field</li>
+  #   </ul>
+  #
+  #   @note When ::LCB_REPLICA_ALL is selected, the callback will be invoked
+  #   multiple times, one for each replica. The final callback will have the
+  #   ::LCB_RESP_F_FINAL bit set in the lcb_RESPBASE::rflags field. The final
+  #   response will also contain the response from the last replica to
+  #   respond.
+  # :index ::
+  #   (Integer) Valid only when #strategy is ::LCB_REPLICA_SELECT, specifies the replica
+  #   index number to query. This should be no more than `nreplicas-1`
+  #   where `nreplicas` is the number of replicas the bucket is configured with.
+  class CMDGETREPLICA < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :strategy, ReplicaT,
+           :index, :int
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdhttp.rb

@@ -0,0 +1,58 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :type ::
+  #   (HttpTypeT) Type of request to issue. LCB_HTTP_TYPE_VIEW will issue a request
+  #   against a random node's view API. LCB_HTTP_TYPE_MANAGEMENT will issue
+  #   a request against a random node's administrative API, and
+  #   LCB_HTTP_TYPE_RAW will issue a request against an arbitrary host.
+  # :method ::
+  #   (HttpMethodT) < HTTP Method to use
+  # :body ::
+  #   (String) If the request requires a body (e.g. `PUT` or `POST`) then it will
+  #   go here. Be sure to indicate the length of the body too.
+  # :nbody ::
+  #   (Integer) Length of the body for the request
+  # :reqhandle ::
+  #   (FFI::Pointer(*HttpRequestT)) If non-NULL, will be assigned a handle which may be used to
+  #   subsequently cancel the request
+  # :content_type ::
+  #   (String) For views, set this to `application/json`
+  # :username ::
+  #   (String) Username to authenticate with, if left empty, will use the credentials
+  #   passed to lcb_create()
+  # :password ::
+  #   (String) Password to authenticate with, if left empty, will use the credentials
+  #   passed to lcb_create()
+  # :host ::
+  #   (String) If set, this must be a string in the form of `http://host:port`. Should
+  #   only be used for raw requests.
+  class CMDHTTP < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :type, HttpTypeT,
+           :method, HttpMethodT,
+           :body, :pointer,
+           :nbody, :ulong,
+           :reqhandle, :pointer,
+           :content_type, :pointer,
+           :username, :pointer,
+           :password, :pointer,
+           :host, :pointer
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdn1ql.rb

@@ -0,0 +1,40 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :query ::
+  #   (String) Query to be placed in the POST request. The library will not perform
+  #   any conversions or validation on this string, so it is up to the user
+  #   (or wrapping library) to ensure that the string is well formed.
+  #
+  #   If using the @ref lcb_N1QLPARAMS structure, the lcb_n1p_mkcmd() function
+  #   will properly populate this field.
+  #
+  #   In general the string should either be JSON (in which case, the
+  #   #content_type field should be `application/json`) or url-encoded
+  #   (in which case the #content_type field should be
+  #   `application/x-www-form-urlencoded`)
+  # :nquery ::
+  #   (Integer) Length of the query data
+  # :host ::
+  #   (String) Ignored since version 2.5.3
+  # :content_type ::
+  #   (String) Ignored since version 2.5.3
+  # :callback ::
+  #   (Proc(callback_n1qlcallback)) Callback to be invoked for each row
+  # :handle ::
+  #   (FFI::Pointer(*N1QLHANDLE)) Request handle. Will be set to the handle which may be passed to
+  #   lcb_n1ql_cancel()
+  class CMDN1QL < FFI::Struct
+    layout :cmdflags, :uint,
+           :query, :string,
+           :nquery, :ulong,
+           :host, :string,
+           :content_type, :string,
+           :callback, :n1qlcallback,
+           :handle, :pointer
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdobseqno.rb

@@ -0,0 +1,33 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :server_index ::
+  #   (Integer) Server index to target. The server index must be valid and must also
+  #   be either a master or a replica for the vBucket indicated in #vbid
+  # :vbid ::
+  #   (Integer) < vBucket ID to query
+  # :uuid ::
+  #   (Integer) < UUID known to client which should be queried
+  class CMDOBSEQNO < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :server_index, :ushort,
+           :vbid, :ushort,
+           :uuid, :ulong_long
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdobserve.rb

@@ -0,0 +1,30 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :servers ::
+  #   (FFI::Pointer(*U16)) For internal use: This determines the servers the command should be
+  #   routed to. Each entry is an index within the server.
+  # :nservers ::
+  #   (Integer)
+  class CMDOBSERVE < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :servers, :pointer,
+           :nservers, :ulong
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdstore.rb

@@ -0,0 +1,40 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :value ::
+  #   (VALBUF) Value to store on the server. The value may be set using the
+  #   LCB_CMD_SET_VALUE() or LCB_CMD_SET_VALUEIOV() API
+  # :flags ::
+  #   (Integer) Format flags used by clients to determine the underlying encoding of
+  #   the value. This value is also returned during retrieval operations in the
+  #   lcb_RESPGET::itmflags field
+  # :datatype ::
+  #   (Integer) Do not set this value for now
+  # :operation ::
+  #   (StorageT) Controls *how* the operation is perfomed. See the documentation for
+  #   @ref lcb_storage_t for the options. There is no default value for this
+  #   field.
+  class CMDSTORE < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :value, VALBUF.by_value,
+           :flags, :uint,
+           :datatype, :uchar,
+           :operation, StorageT
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdstoredur.rb

@@ -0,0 +1,45 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :value ::
+  #   (VALBUF) < @see lcb_CMDSTORE::value
+  # :flags ::
+  #   (Integer) < @see lcb_CMDSTORE::flags
+  # :datatype ::
+  #   (Integer) < @private
+  # :operation ::
+  #   (StorageT) < @see lcb_CMDSTORE::operation
+  # :persist_to ::
+  #   (Integer) Number of nodes to persist to. If negative, will be capped at the maximum
+  #   allowable for the current cluster.
+  #   @see lcb_DURABILITYOPTSv0::persist_to
+  # :replicate_to ::
+  #   (Integer) Number of nodes to replicate to. If negative, will be capped at the maximum
+  #   allowable for the current cluster.
+  #   @see lcb_DURABILITYOPTSv0::replicate_to
+  class CMDSTOREDUR < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :value, VALBUF.by_value,
+           :flags, :uint,
+           :datatype, :uchar,
+           :operation, StorageT,
+           :persist_to, :char,
+           :replicate_to, :char
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdsubdoc.rb

@@ -0,0 +1,61 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :specs ::
+  #   (SDSPEC) An array of one or more command specifications. The storage
+  #   for the array need only persist for the duration of the
+  #   lcb_subdoc3() call.
+  #
+  #   The specs array must be valid only through the invocation
+  #   of lcb_subdoc3(). As such, they can reside on the stack and
+  #   be re-used for scheduling multiple commands. See subdoc-simple.cc
+  # :nspecs ::
+  #   (Integer) Number of entries in #specs
+  # :error_index ::
+  #   (FFI::Pointer(*Int)) If the scheduling of the command failed, the index of the entry which
+  #   caused the failure will be written to this pointer.
+  #
+  #   If the value is -1 then the failure took place at the command level
+  #   and not at the spec level.
+  # :multimode ::
+  #   (Integer) Operation mode to use. This can either be @ref LCB_SDMULTI_MODE_LOOKUP
+  #   or @ref LCB_SDMULTI_MODE_MUTATE.
+  #
+  #   This field may be left empty, in which case the mode is implicitly
+  #   derived from the _first_ command issued.
+  class CMDSUBDOC < FFI::Struct
+    # CMD flags
+    UPSERT_DOC = (1<<16) # document is to be created if it does not exist.
+    INSERT_DOC = (1<<17) # document must be created anew. Fail if it exists
+    ACCESS_DELETED = (1<<18) # Access a potentially deleted document.
+
+    SDMULTI_MODE_INVALID = 0
+    SDMULTI_MODE_LOOKUP = 1
+    SDMULTI_MODE_MUTATE = 2
+
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :specs, :pointer, # ==> SDSPEC.by_ref,
+           :nspecs, :ulong,
+           :error_index, :pointer,
+
+           # This can either be SDMULTI_MODE_LOOKUP or SDMULTI_MODE_MUTATE
+           # This field may be left empty, in which case the mode is implicitly derived from the _first_ command issued.
+           :multimode, :uint
+  end
+
+end

data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdverbosity.rb

@@ -0,0 +1,29 @@
+module MTLibcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :cmdflags ::
+  #   (Integer)
+  # :exptime ::
+  #   (Integer)
+  # :cas ::
+  #   (Integer)
+  # :key ::
+  #   (KEYBUF)
+  # :hashkey ::
+  #   (KEYBUF)
+  # :server ::
+  #   (String)
+  # :level ::
+  #   (VerbosityLevelT)
+  class CMDVERBOSITY < FFI::Struct
+    layout :cmdflags, :uint,
+           :exptime, :uint,
+           :cas, :ulong_long,
+           :key, KEYBUF.by_value,
+           :hashkey, KEYBUF.by_value,
+           :server, :string,
+           :level, VerbosityLevelT
+  end
+
+end