couchbase 3.0.0.alpha.3 → 3.0.1

data/lib/couchbase/collection.rb

@@ -22,7 +22,7 @@ module Couchbase
     attr_reader :scope_name
     attr_reader :name
 
-    alias_method :inspect, :to_s
+    alias inspect to_s
 
     # @param [Couchbase::Backend] backend
     # @param [String] bucket_name name of the bucket
@@ -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]
@@ -140,7 +140,7 @@ module Couchbase
     # @return [MutationResult]
     def remove(id, options = RemoveOptions.new)
       resp = @backend.document_remove(bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, {
-          durability_level: options.durability_level
+        durability_level: options.durability_level,
       })
       MutationResult.new do |res|
         res.cas = resp[:cas]
@@ -158,8 +158,8 @@ module Couchbase
     def insert(id, content, options = InsertOptions.new)
       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,
+        durability_level: options.durability_level,
+        expiry: options.expiry,
       })
       MutationResult.new do |res|
         res.cas = resp[:cas]
@@ -177,8 +177,8 @@ module Couchbase
     def upsert(id, content, options = UpsertOptions.new)
       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,
+        durability_level: options.durability_level,
+        expiry: options.expiry,
       })
       MutationResult.new do |res|
         res.cas = resp[:cas]
@@ -196,9 +196,9 @@ module Couchbase
     def replace(id, content, options = ReplaceOptions.new)
       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,
-          cas: options.cas,
+        durability_level: options.durability_level,
+        expiry: options.expiry,
+        cas: options.cas,
       })
       MutationResult.new do |res|
         res.cas = resp[:cas]
@@ -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
@@ -240,14 +240,14 @@ module Couchbase
     # @return [LookupInResult]
     def lookup_in(id, specs, options = LookupInOptions.new)
       resp = @backend.document_lookup_in(
-          bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, options.access_deleted,
-          specs.map { |s|
-            {
-                opcode: s.type,
-                xattr: s.xattr?,
-                path: s.path
-            }
+        bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, options.access_deleted,
+        specs.map do |s|
+          {
+            opcode: s.type,
+            xattr: s.xattr?,
+            path: s.path,
           }
+        end
       )
       LookupInResult.new do |res|
         res.transcoder = options.transcoder
@@ -255,10 +255,12 @@ module Couchbase
         res.encoded = resp[:fields].map do |field|
           SubDocumentField.new do |f|
             f.exists = field[:exists]
+            f.index = field[:index]
             f.path = field[:path]
             f.status = field[:status]
+            f.error = field[:error]
             f.value = field[:value]
-            f.type = field[:opcode]
+            f.type = field[:type]
           end
         end
       end
@@ -273,22 +275,26 @@ module Couchbase
     # @return [MutateInResult]
     def mutate_in(id, specs, options = MutateInOptions.new)
       resp = @backend.document_mutate_in(
-          bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, options.access_deleted,
-          specs.map { |s|
-            {
-                opcode: s.type,
-                path: s.path,
-                param: s.param,
-                xattr: s.xattr?,
-                expand_macros: s.expand_macros?,
-                create_parents: s.create_parents?
-            }
-          },
+        bucket_name, "#{@scope_name}.#{@name}", id, options.timeout,
+        specs.map do |s|
           {
-              durability_level: options.durability_level
+            opcode: s.type,
+            path: s.path,
+            param: s.param,
+            xattr: s.xattr?,
+            expand_macros: s.expand_macros?,
+            create_path: s.create_path?,
           }
+        end,
+        {
+          durability_level: options.durability_level,
+          store_semantics: options.store_semantics,
+          access_deleted: options.access_deleted,
+          cas: options.cas,
+          expiry: options.expiry,
+        }
       )
-      MutateInResult.new do |res|
+      result = MutateInResult.new do |res|
         res.transcoder = options.transcoder
         res.cas = resp[:cas]
         res.mutation_token = extract_mutation_token(resp)
@@ -298,11 +304,15 @@ module Couchbase
             f.exists = field[:exists]
             f.path = field[:path]
             f.status = field[:status]
+            f.error = field[:error]
             f.value = field[:value]
-            f.type = field[:opcode]
+            f.type = field[:type]
           end
         end
       end
+      raise result.first_error unless result.success?
+
+      result
     end
 
     private

data/lib/couchbase/collection_options.rb

@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "rubygems/deprecate"
+
 require "couchbase/json_transcoder"
 require "couchbase/common_options"
 require "couchbase/subdoc"
@@ -21,16 +23,17 @@ 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
 
       # @yieldparam [GetOptions] self
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         @preserve_array_indexes = false
-        @with_expiration = nil
+        @with_expiry = nil
         @projections = nil
         yield self if block_given?
       end
@@ -57,7 +60,7 @@ module Couchbase
       # @api private
       # @return [Boolean]
       def need_projected_get?
-        @with_expiration || !@projections.nil?
+        @with_expiry || !@projections.nil?
       end
     end
 
@@ -67,6 +70,7 @@ module Couchbase
 
       # @yieldparam [GetAndLockOptions] self
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         yield self if block_given?
       end
@@ -78,19 +82,23 @@ module Couchbase
 
       # @yieldparam [GetAndTouchOptions] self
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         yield self if block_given?
       end
     end
 
     class GetResult
+      extend Gem::Deprecate
+
       # @return [Integer] holds the CAS value of the fetched document
       attr_accessor :cas
 
       # @return [Integer] the expiration if fetched and present
-      attr_accessor :expiration
+      attr_writer :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)
@@ -102,16 +110,30 @@ module Couchbase
         transcoder.decode(@encoded, @flags)
       end
 
+      # @return [Time] time when the document will expire
+      def expiry_time
+        Time.at(@expiry) if @expiry
+      end
+
       # @yieldparam [GetResult] self
       def initialize
+        @expiry = nil
         yield self if block_given?
       end
 
       # @return [Integer] The flags from the operation
+      # @api private
       attr_accessor :flags
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
+
+      # @deprecated Use {#expiry_time}
+      # @return [Integer] the expiration if fetched and present
+      def expiry
+        @expiry
+      end
+      deprecate :expiry, :expiry_time, 2021, 1
     end
 
     class GetAllReplicasOptions < CommonOptions
@@ -120,6 +142,7 @@ module Couchbase
 
       # @yieldparam [GetAllReplicasOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -130,6 +153,7 @@ module Couchbase
 
       # @yieldparam [GetAnyReplicaOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -137,12 +161,13 @@ module Couchbase
     class GetReplicaResult < GetResult
       # @return [Boolean] true if this result came from a replica
       attr_accessor :is_replica
-      alias_method :replica?, :is_replica
+      alias replica? is_replica
     end
 
     class ExistsOptions < CommonOptions
       # @yieldparam [ExistsOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -179,6 +204,7 @@ module Couchbase
 
       # @yieldparam [RemoveOptions]
       def initialize
+        super
         @durability_level = :none
         yield self if block_given?
       end
@@ -186,7 +212,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
@@ -196,6 +222,7 @@ module Couchbase
 
       # @yieldparam [InsertOptions]
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         @durability_level = :none
         yield self if block_given?
@@ -204,7 +231,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
@@ -214,6 +241,7 @@ module Couchbase
 
       # @yieldparam [UpsertOptions]
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         @durability_level = :none
         yield self if block_given?
@@ -222,7 +250,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
@@ -235,6 +263,7 @@ module Couchbase
 
       # @yieldparam [ReplaceOptions]
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         @durability_level = :none
         yield self if block_given?
@@ -257,6 +286,7 @@ module Couchbase
     class TouchOptions < CommonOptions
       # @yieldparam [TouchOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -264,6 +294,7 @@ module Couchbase
     class UnlockOptions < CommonOptions
       # @yieldparam [UnlockOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -277,6 +308,7 @@ module Couchbase
 
       # @yieldparam [LookupInOptions] self
       def initialize
+        super
         @transcoder = JsonTranscoder.new
         yield self if block_given?
       end
@@ -292,7 +324,7 @@ module Couchbase
       #
       # @return [Object] the decoded
       def content(index, transcoder = self.transcoder)
-        transcoder.decode(encoded[index].value, :json)
+        transcoder.decode(get_field_at_index(index).value, :json)
       end
 
       # Allows to check if a value at the given index exists
@@ -301,7 +333,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
@@ -314,11 +346,22 @@ module Couchbase
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
+
+      private
+
+      def get_field_at_index(index)
+        raise Error::PathInvalid, "Index is out of bounds: #{index}" unless index >= 0 && index < encoded.size
+
+        field = encoded[index]
+        raise field.error unless field.success?
+
+        field
+      end
     end
 
     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
       #
@@ -343,6 +386,7 @@ module Couchbase
 
       # @yieldparam [MutateInOptions]
       def initialize
+        super
         @durability_level = :none
         @store_semantics = :replace
         @transcoder = JsonTranscoder.new
@@ -359,38 +403,64 @@ module Couchbase
       #
       # @return [Object] the decoded
       def content(index, transcoder = self.transcoder)
-        transcoder.decode(encoded[index].value, :json)
+        field = get_field_at_index(index)
+        if field.type == :counter
+          field.value
+        else
+          transcoder.decode(field.value, :json)
+        end
       end
 
       # @yieldparam [MutateInResult] self
       def initialize
+        super
         yield self if block_given?
       end
 
+      # @api private
       def success?
-        !!first_error_index
+        first_error_index.nil?
+      end
+
+      # @api private
+      def first_error
+        encoded[first_error_index].error unless success?
       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
       attr_accessor :transcoder
+
+      private
+
+      def get_field_at_index(index)
+        raise Error::PathInvalid, "Index is out of bounds: #{index}" unless index >= 0 && index < encoded.size
+
+        field = encoded[index]
+        raise field.error unless field.success?
+
+        field
+      end
     end
 
-# @api private
+    # @api private
     class SubDocumentField
-      attr_accessor :error
-
       # @return [Boolean] true if the path exists in the document
       attr_accessor :exists
 
       # @return [String] value
       attr_accessor :value
 
+      # @return [Integer] index
+      attr_accessor :index
+
       # @return [String] path
       attr_accessor :path
 
@@ -418,7 +488,8 @@ module Couchbase
       #
       # [+:success+] Indicates a successful response in general.
       # [+:path_not_found+] The provided path does not exist in the document
-      # [+:path_mismatch+] One of path components treats a non-dictionary as a dictionary, or a non-array as an array, or value the path points to is not a number
+      # [+:path_mismatch+] One of path components treats a non-dictionary as a dictionary, or a non-array as an array, or value the path
+      #   points to is not a number
       # [+:path_invalid+] The path's syntax was incorrect
       # [+:path_too_big+] The path provided is too large: either the string is too long, or it contains too many components
       # [+:value_cannot_insert+] The value provided will invalidate the JSON if inserted
@@ -438,10 +509,19 @@ module Couchbase
       # @return [Symbol]
       attr_accessor :status
 
+      # @return [nil, Exception]
+      attr_accessor :error
+
       # @yieldparam [SubDocumentField] self
       def initialize
+        @status = :unknown
         yield self if block_given?
       end
+
+      # @return [Boolean] true if the path does not have associated error
+      def success?
+        status == :success
+      end
     end
   end
 end