couchbase 3.0.0.alpha.5 → 3.0.0.beta.1

data/lib/couchbase/bucket.rb

@@ -26,7 +26,7 @@ module Couchbase
 
     # @param [Couchbase::Backend] backend
     def initialize(backend, name)
-      backend.open_bucket(name)
+      backend.open_bucket(name, true)
       @backend = backend
       @name = name
     end
@@ -60,7 +60,7 @@ module Couchbase
     #
     # @return [Collection]
     def default_collection
-      default_scope.default_collection
+      Collection.new(@backend, @name, :_default, :_default)
     end
 
     # Performs query to view index.
@@ -69,7 +69,7 @@ module Couchbase
     # @param [String] view_name name of the view to query
     # @param [ViewOptions] options
     #
-    # @return [ViewQueryResult]
+    # @return [ViewResult]
     def view_query(design_document_name, view_name, options = ViewOptions.new)
       resp = @backend.document_view(@name, design_document_name, view_name, options.namespace, {
           timeout: options.timeout,
@@ -84,7 +84,7 @@ module Couchbase
           group: options.group,
           group_level: options.group_level,
           key: (JSON.generate(options.key) unless options.key.nil?),
-          keys: options.keys&.map { |key| JSON.generate(key) },
+          keys: (options.keys.map { |key| JSON.generate(key) } if options.keys),
           order: options.order,
           reduce: options.reduce,
           on_error: options.on_error,

data/lib/couchbase/cluster.rb

@@ -67,18 +67,18 @@ module Couchbase
           pipeline_cap: options.pipeline_cap,
           metrics: options.metrics,
           profile: options.profile,
-          positional_parameters: options.instance_variable_get("@positional_parameters")&.map { |p| JSON.dump(p) },
-          named_parameters: options.instance_variable_get("@named_parameters")&.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) },
-          raw_parameters: options.instance_variable_get("@raw_parameters"),
-          scan_consistency: options.instance_variable_get("@scan_consistency"),
-          mutation_state: options.instance_variable_get("@mutation_state")&.tokens&.map { |t|
+          positional_parameters: options.export_positional_parameters,
+          named_parameters: options.export_named_parameters,
+          raw_parameters: options.raw_parameters,
+          scan_consistency: options.scan_consistency,
+          mutation_state: (options.mutation_state.tokens.map { |t|
             {
                 bucket_name: t.bucket_name,
                 partition_id: t.partition_id,
                 partition_uuid: t.partition_uuid,
                 sequence_number: t.sequence_number,
             }
-          },
+          } if options.mutation_state),
       })
 
       QueryResult.new do |res|
@@ -119,9 +119,9 @@ module Couchbase
           scan_consistency: options.scan_consistency,
           readonly: options.readonly,
           priority: options.priority,
-          positional_parameters: options.instance_variable_get("@positional_parameters")&.map { |p| JSON.dump(p) },
-          named_parameters: options.instance_variable_get("@named_parameters")&.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) },
-          raw_parameters: options.instance_variable_get("@raw_parameters"),
+          positional_parameters: options.export_positional_parameters,
+          named_parameters: options.export_named_parameters,
+          raw_parameters: options.raw_parameters,
       })
 
       AnalyticsResult.new do |res|
@@ -165,17 +165,17 @@ module Couchbase
           highlight_style: options.highlight_style,
           highlight_fields: options.highlight_fields,
           fields: options.fields,
-          sort: options.sort&.map { |v| JSON.generate(v) },
-          facets: options.facets&.map { |(k, v)| [k, JSON.generate(v)] },
-          scan_consistency: options.instance_variable_get("@scan_consistency"),
-          mutation_state: options.instance_variable_get("@mutation_state")&.tokens&.map { |t|
+          sort: (options.sort.map { |v| JSON.generate(v) } if options.sort),
+          facets: (options.facets.map { |(k, v)| [k, JSON.generate(v)] } if options.facets),
+          scan_consistency: options.scan_consistency,
+          mutation_state: (options.mutation_state.tokens.map { |t|
             {
                 bucket_name: t.bucket_name,
                 partition_id: t.partition_id,
                 partition_uuid: t.partition_uuid,
                 sequence_number: t.sequence_number,
             }
-          },
+          } if options.mutation_state),
       })
 
       SearchResult.new do |res|
@@ -209,35 +209,52 @@ module Couchbase
             row.explanation = JSON.parse(r[:explanation]) if r[:explanation]
           end
         end
-        res.facets = resp[:facets]&.each_with_object({}) do |(k, v), o|
-          facet = case options.facets[k]
-                  when SearchFacet::SearchFacetTerm
-                    SearchFacetResult::TermFacetResult.new do |f|
-                      f.terms = v[:terms]&.map do |t|
-                        SearchFacetResult::TermFacetResult::TermFacet.new(t[:term], t[:count])
-                      end || []
-                    end
-                  when SearchFacet::SearchFacetDateRange
-                    SearchFacetResult::DateRangeFacetResult.new do |f|
-                      f.date_ranges = v[:date_ranges]&.map do |r|
-                        SearchFacetResult::DateRangeFacetResult::DateRangeFacet.new(r[:name], r[:count], r[:start_time], r[:end_time])
-                      end || []
+        if resp[:facets]
+          res.facets = resp[:facets].each_with_object({}) do |(k, v), o|
+            facet = case options.facets[k]
+                    when SearchFacet::SearchFacetTerm
+                      SearchFacetResult::TermFacetResult.new do |f|
+                        f.terms =
+                            if v[:terms]
+                              v[:terms].map do |t|
+                                SearchFacetResult::TermFacetResult::TermFacet.new(t[:term], t[:count])
+                              end
+                            else
+                              []
+                            end
+                      end
+                    when SearchFacet::SearchFacetDateRange
+                      SearchFacetResult::DateRangeFacetResult.new do |f|
+                        f.date_ranges =
+                            if v[:date_ranges]
+                              v[:date_ranges].map do |r|
+                                SearchFacetResult::DateRangeFacetResult::DateRangeFacet.new(r[:name], r[:count], r[:start_time], r[:end_time])
+                              end
+                            else
+                              []
+                            end
+                      end
+                    when SearchFacet::SearchFacetNumericRange
+                      SearchFacetResult::NumericRangeFacetResult.new do |f|
+                        f.numeric_ranges =
+                            if v[:numeric_ranges]
+                              v[:numeric_ranges].map do |r|
+                                SearchFacetResult::NumericRangeFacetResult::NumericRangeFacet.new(r[:name], r[:count], r[:min], r[:max])
+                              end
+                            else
+                              []
+                            end
+                      end
+                    else
+                      next # ignore unknown facet result
                     end
-                  when SearchFacet::SearchFacetNumericRange
-                    SearchFacetResult::NumericRangeFacetResult.new do |f|
-                      f.numeric_ranges = v[:numeric_ranges]&.map do |r|
-                        SearchFacetResult::NumericRangeFacetResult::NumericRangeFacet.new(r[:name], r[:count], r[:min], r[:max])
-                      end || []
-                    end
-                  else
-                    next # ignore unknown facet result
-                  end
-          facet.name = v[:name]
-          facet.field = v[:field]
-          facet.total = v[:total]
-          facet.missing = v[:missing]
-          facet.other = v[:other]
-          o[k] = facet
+            facet.name = v[:name]
+            facet.field = v[:field]
+            facet.total = v[:total]
+            facet.missing = v[:missing]
+            facet.other = v[:other]
+            o[k] = facet
+          end
         end
       end
     end
@@ -302,9 +319,6 @@ module Couchbase
     # @param [String] connection_string connection string used to locate the Couchbase Cluster
     # @param [ClusterOptions] options custom options when creating the cluster connection
     def initialize(connection_string, options)
-      conn_info = Backend.parse_connection_string(connection_string)
-      raise ArgumentError, "missing hostname" if conn_info[:nodes].empty?
-      hostname = conn_info[:nodes].first[:address]
       raise ArgumentError, "options must have authenticator configured" unless options.authenticator
       username = options.authenticator.username
       raise ArgumentError, "missing username" unless username
@@ -312,7 +326,7 @@ module Couchbase
       raise ArgumentError, "missing password" unless password
 
       @backend = Backend.new
-      @backend.open(hostname, username, password)
+      @backend.open(connection_string, username, password, {})
     end
   end
 end

data/lib/couchbase/collection.rb

@@ -52,7 +52,7 @@ module Couchbase
       resp = if options.need_projected_get?
                @backend.document_get_projected(bucket_name, "#{@scope_name}.#{@name}", id,
                                                options.timeout,
-                                               options.with_expiration,
+                                               options.with_expiry,
                                                options.projections,
                                                options.preserve_array_indexes)
              else
@@ -63,7 +63,7 @@ module Couchbase
         res.cas = resp[:cas]
         res.flags = resp[:flags]
         res.encoded = resp[:content]
-        res.expiration = resp[:expiration] if resp.key?(:expiration)
+        res.expiry = resp[:expiry] if resp.key?(:expiry)
       end
     end
 
@@ -84,15 +84,15 @@ module Couchbase
       end
     end
 
-    # Fetches a full document and resets its expiration time to the expiration duration provided
+    # Fetches a full document and resets its expiration time to the duration provided
     #
     # @param [String] id the document id which is used to uniquely identify it.
-    # @param [Integer] expiration the new expiration time for the document
+    # @param [Integer] expiry the new expiration time for the document
     # @param [GetAndTouchOptions] options request customization
     #
     # @return [GetResult]
-    def get_and_touch(id, expiration, options = GetAndTouchOptions.new)
-      resp = @backend.document_get_and_touch(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, expiration)
+    def get_and_touch(id, expiry, options = GetAndTouchOptions.new)
+      resp = @backend.document_get_and_touch(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, expiry)
       GetResult.new do |res|
         res.transcoder = options.transcoder
         res.cas = resp[:cas]
@@ -159,7 +159,7 @@ module Couchbase
       blob, flags = options.transcoder.encode(content)
       resp = @backend.document_insert(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, blob, flags, {
           durability_level: options.durability_level,
-          expiration: options.expiration,
+          expiry: options.expiry,
       })
       MutationResult.new do |res|
         res.cas = resp[:cas]
@@ -178,7 +178,7 @@ module Couchbase
       blob, flags = options.transcoder.encode(content)
       resp = @backend.document_upsert(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, blob, flags, {
           durability_level: options.durability_level,
-          expiration: options.expiration,
+          expiry: options.expiry,
       })
       MutationResult.new do |res|
         res.cas = resp[:cas]
@@ -197,7 +197,7 @@ module Couchbase
       blob, flags = options.transcoder.encode(content)
       resp = @backend.document_replace(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, blob, flags, {
           durability_level: options.durability_level,
-          expiration: options.expiration,
+          expiry: options.expiry,
           cas: options.cas,
       })
       MutationResult.new do |res|
@@ -209,12 +209,12 @@ module Couchbase
     # Update the expiration of the document with the given id
     #
     # @param [String] id the document id which is used to uniquely identify it.
-    # @param [Integer] expiration new expiration time for the document
+    # @param [Integer] expiry new expiration time for the document
     # @param [TouchOptions] options request customization
     #
     # @return [MutationResult]
-    def touch(id, expiration, options = TouchOptions.new)
-      resp = @backend.document_touch(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, expiration)
+    def touch(id, expiry, options = TouchOptions.new)
+      resp = @backend.document_touch(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, expiry)
       MutationResult.new do |res|
         res.cas = resp[:cas]
       end
@@ -291,7 +291,7 @@ module Couchbase
               store_semantics: options.store_semantics,
               access_deleted: options.access_deleted,
               cas: options.cas,
-              expiration: options.expiration,
+              expiry: options.expiry,
           }
       )
       res = MutateInResult.new do |res|

data/lib/couchbase/collection_options.rb

@@ -21,7 +21,7 @@ module Couchbase
   class Collection
     class GetOptions < CommonOptions
       # @return [Boolean] if the expiration should also fetched with get
-      attr_accessor :with_expiration
+      attr_accessor :with_expiry
 
       # @return [JsonTranscoder] transcoder used for decoding
       attr_accessor :transcoder
@@ -30,7 +30,7 @@ module Couchbase
       def initialize
         @transcoder = JsonTranscoder.new
         @preserve_array_indexes = false
-        @with_expiration = nil
+        @with_expiry = nil
         @projections = nil
         yield self if block_given?
       end
@@ -57,7 +57,7 @@ module Couchbase
       # @api private
       # @return [Boolean]
       def need_projected_get?
-        @with_expiration || !@projections.nil?
+        @with_expiry || !@projections.nil?
       end
     end
 
@@ -88,9 +88,10 @@ module Couchbase
       attr_accessor :cas
 
       # @return [Integer] the expiration if fetched and present
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # @return [String] The encoded content when loading the document
+      # @api private
       attr_accessor :encoded
 
       # Decodes the content of the document using given (or default transcoder)
@@ -108,6 +109,7 @@ module Couchbase
       end
 
       # @return [Integer] The flags from the operation
+      # @api private
       attr_accessor :flags
 
       # @return [JsonTranscoder] The default transcoder which should be used
@@ -186,7 +188,7 @@ module Couchbase
 
     class InsertOptions < CommonOptions
       # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # @return [Proc] transcoder used for encoding
       attr_accessor :transcoder
@@ -204,7 +206,7 @@ module Couchbase
 
     class UpsertOptions < CommonOptions
       # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # @return [JsonTranscoder] transcoder used for encoding
       attr_accessor :transcoder
@@ -222,7 +224,7 @@ module Couchbase
 
     class ReplaceOptions < CommonOptions
       # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # @return [JsonTranscoder] transcoder used for encoding
       attr_accessor :transcoder
@@ -301,7 +303,7 @@ module Couchbase
       #
       # @return [Boolean] true if a value is present at the index, false otherwise
       def exists?(index)
-        encoded[index]&.exists
+        !encoded[index].nil? && encoded[index].exists
       end
 
       # @return [Array<SubDocumentField>] holds the encoded subdocument responses
@@ -330,7 +332,7 @@ module Couchbase
 
     class MutateInOptions < CommonOptions
       # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # Describes how the outer document store semantics on subdoc should act
       #
@@ -384,18 +386,22 @@ module Couchbase
         yield self if block_given?
       end
 
+      # @api private
       def success?
         first_error_index.nil?
       end
 
+      # @api private
       def first_error
         encoded[first_error_index].error
       end
 
       # @return [Array<SubDocumentField>] holds the encoded subdocument responses
+      # @api private
       attr_accessor :encoded
 
       # @return [Integer, nil] index of first operation entry that generated an error
+      # @api private
       attr_accessor :first_error_index
 
       # @return [JsonTranscoder] The default transcoder which should be used

data/{bin/console → lib/couchbase/datastructures.rb}

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 #    Copyright 2020 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,8 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require "bundler/setup"
-require "irb"
-require "couchbase"
-
-IRB.start(__FILE__)
+require "couchbase/datastructures/couchbase_list"
+require "couchbase/datastructures/couchbase_set"
+require "couchbase/datastructures/couchbase_queue"
+require "couchbase/datastructures/couchbase_map"

data/lib/couchbase/datastructures/couchbase_list.rb

@@ -0,0 +1,171 @@
+#    Copyright 2020 Couchbase, 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 "couchbase/collection"
+require "couchbase/errors"
+
+module Couchbase
+  module Datastructures
+    # A {CouchbaseList} is implements +Enumerable+ interface and backed by {Collection} document (more specifically
+    # a JSON array).
+    #
+    # Note that as such, a {CouchbaseList} is restricted to the types that JSON array can contain.
+    class CouchbaseList
+      include Enumerable
+
+      # Create a new List, backed by the document identified by +id+ in +collection+.
+      #
+      # @param [String] id the id of the document to back the list.
+      # @param [Collection] collection the Couchbase collection through which to interact with the document.
+      # @param [CouchbaseListOptions] options customization of the datastructure
+      def initialize(id, collection, options = CouchbaseListOptions.new)
+        @id = id
+        @collection = collection
+        @options = options
+        @cas = 0
+      end
+
+      # Calls the given block once for each element in the list, passing that element as a parameter.
+      #
+      # @yieldparam [Object] item
+      #
+      # @return [CouchbaseList, Enumerable]
+      def each
+        if block_given?
+          begin
+            result = @collection.get(@id, @options.get_options)
+            current = result.content
+            @cas = result.cas
+          rescue Error::DocumentNotFound
+            current = []
+            @cas = 0
+          end
+          current.each do |entry|
+            yield entry
+          end
+          self
+        else
+          enum_for(:each)
+        end
+      end
+
+      # @return [Integer] returns the number of elements in the list.
+      def length
+        result = @collection.lookup_in(@id, [
+            LookupInSpec.count("")
+        ], @options.lookup_in_options)
+        result.content(0)
+      rescue Error::DocumentNotFound
+        0
+      end
+
+      alias_method :size, :length
+
+      # @return [Boolean] returns true if list is empty
+      def empty?
+        size.zero?
+      end
+
+      # Appends the given object(s) on to the end of this error. This expression returns the array itself, so several
+      # appends may be chained together.
+      #
+      # @param [Object...] obj object(s) to append
+      # @return [CouchbaseList]
+      def push(*obj)
+        @collection.mutate_in(@id, [
+            MutateInSpec.array_append("", obj)
+        ], @options.mutate_in_options)
+        self
+      end
+
+      alias_method :append, :push
+
+      # Prepends objects to the front of the list, moving other elements upwards
+      #
+      # @param [Object...] obj object(s) to prepend
+      # @return [CouchbaseList]
+      def unshift(*obj)
+        @collection.mutate_in(@id, [
+            MutateInSpec.array_prepend("", obj)
+        ], @options.mutate_in_options)
+        self
+      end
+
+      alias_method :prepend, :unshift
+
+      # Inserts the given values before the element with the given +index+.
+      #
+      # @param [Integer] index
+      # @param [Object...] obj object(s) to insert
+      # @return [CouchbaseList]
+      def insert(index, *obj)
+        @collection.mutate_in(@id, [
+            MutateInSpec.array_insert("[#{index.to_i}]", obj)
+        ])
+        self
+      end
+
+      # Returns the element at +index+. A negative index counts from the end. Returns +nil+ if the index is out of range.
+      #
+      # @param [Integer] index
+      # @return [Object, nil]
+      def at(index)
+        result = @collection.lookup_in(@id, [
+            LookupInSpec.get("[#{index.to_i}]")
+        ], @options.lookup_in_options)
+        result.exists?(0) ? result.content(0) : nil
+      rescue Error::DocumentNotFound
+        nil
+      end
+
+      alias_method :[], :at
+
+      # Deletes the element at the specified +index+, returning that element, or nil
+      #
+      # @param [Integer] index
+      # @return [CouchbaseList]
+      def delete_at(index)
+        @collection.mutate_in(@id, [
+            MutateInSpec.remove("[#{index.to_i}]")
+        ])
+        self
+      rescue Error::DocumentNotFound
+        self
+      end
+
+      # Removes all elements from the list
+      def clear
+        @collection.remove(@id, @options.remove_options)
+        nil
+      rescue Error::DocumentNotFound
+        nil
+      end
+    end
+
+    class CouchbaseListOptions
+      attr_accessor :get_options
+      attr_accessor :lookup_in_options
+      attr_accessor :mutate_in_options
+      attr_accessor :remove_options
+
+      def initialize
+        @get_options = Collection::GetOptions.new
+        @remove_options = Collection::RemoveOptions.new
+        @lookup_in_options = Collection::LookupInOptions.new
+        @mutate_in_options = Collection::MutateInOptions.new
+        @mutate_in_options.store_semantics = :upsert
+      end
+    end
+  end
+end