couchbase 3.0.1-universal-darwin-19 → 3.0.2-universal-darwin-19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbef5636789e4dfcb950d1666439af1f5ee0d852c695426ec7a05b2a73c873af
-  data.tar.gz: c090f90cd78e634b0d941a87935e46f2317087603d5bfee5ea6bae30ddc9075d
+  metadata.gz: f871d373fce0cb2ad05ee3874801f61cb09b7748e7bdb39033e13ca06ac49166
+  data.tar.gz: 65c3af3fca6168d6cbe4daae0406c63e1589930671ad09e28b199840fe0ccd1b
 SHA512:
-  metadata.gz: 9ea1cb648975f073ccd45c4b24ddecb193ad8bbe1fe02c5e57afd7b7ef417d59a5e86be5b1fea24cfaed17ce71c0db32c208893ded57d060438497b0e8fccce0
-  data.tar.gz: d3ca53bada746495f19b25a7354c608c2f6d5b70a0eb41908a3dacb5866211fad20d9b310887062699efcc11378525f7b1380b6447c034d1233de105192b255b
+  metadata.gz: b4fb457e62b6ac0614467df28c5a55737c8658247c8a0d09b44e41f0f20fc551ead94ec3f4eec6c5afc4b01a00fdd36d01a833533c479be184522e5a6b13a2b9
+  data.tar.gz: 15a8fbf5003480b2d69440d8b9e8f17f8bf28d6874e8ed68cfa1726f29f31dc8edc40ab3909c49d051bebb786b7a9ac666b17abf186a6502b7b252beb847d378

data/README.md

@@ -1,11 +1,18 @@
-# Couchbase Ruby Client [![gem](https://badge.fury.io/rb/couchbase.svg)](https://rubygems.org/gems/couchbase) [![tests](https://github.com/couchbase/couchbase-ruby-client/workflows/tests/badge.svg)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Atests)
+# Couchbase Ruby Client
+
+[![license](https://img.shields.io/github/license/couchbase/couchbase-ruby-client?color=brightgreen)](https://opensource.org/licenses/Apache-2.0)
+[![gem](https://img.shields.io/gem/v/couchbase?color=brightgreen)](https://rubygems.org/gems/couchbase)
+[![commits](https://img.shields.io/github/commits-since/couchbase/couchbase-ruby-client/latest?color=brightgreen)](https://github.com/couchbase/couchbase-ruby-client/commits/master)
+[![tests](https://img.shields.io/github/workflow/status/couchbase/couchbase-ruby-client/tests?label=tests)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Atests)
+[![linters](https://img.shields.io/github/workflow/status/couchbase/couchbase-ruby-client/linters?label=linters)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Alinters)
+[![jenkins](https://img.shields.io/jenkins/build?jobUrl=http%3A%2F%2Fsdk.jenkins.couchbase.com%2Fjob%2Fruby%2Fjob%2Fruby-nightly%2F&label=jenkins)](http://sdk.jenkins.couchbase.com/job/ruby/job/ruby-nightly/)
 
 This repository contains the third generation of the official Couchbase SDK for Ruby (aka. SDKv3)
 
 ## Support and Feedback
 
-If you find an issue, please file it in [our JIRA issue tracker](https://couchbase.com/issues/browse/RCBC).
-Also you are always welcome on [our forum](https://forums.couchbase.com/c/ruby-sdk).
+If you find an issue, please file it in [our JIRA issue tracker](https://couchbase.com/issues/browse/RCBC). Also you are
+always welcome on [our forum](https://forums.couchbase.com/c/ruby-sdk).
 
 Please attach version information to ticket/post. To obtain this information use the following command:
 
@@ -18,7 +25,7 @@ The library tested with the MRI 2.5, 2.6 and 2.7. Supported platforms are Linux
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.0.1"
+gem "couchbase", "3.0.2"
 ```
 
 And then execute:
@@ -33,6 +40,54 @@ For some platforms we precompile binary packages. When, for some reason, binary
 `--platform=ruby` to `gem install` command (or check `specific_platform` and `force_ruby_platform` options of Bundler).
 In latter case, see [Development](#development) section for build dependencies.
 
+## Usage
+
+Here is a basic steps demonstrating basic operations with data:
+
+```ruby
+require "couchbase"
+include Couchbase # include Couchbase module for brevity
+
+# initialize library
+cluster = Cluster.connect("couchbase://127.0.0.1", "Administrator", "password")
+
+# open bucket and collection for data operations
+bucket = cluster.bucket("my_bucket")
+collection = bucket.default_collection
+
+# update or insert the document
+res = collection.upsert("foo", {"bar" => 42})
+res.cas
+#=> 22120998714646
+
+# retrieve document from the collection
+res = collection.get("foo")
+res.cas
+#=> 22120998714646
+res.content
+#=> {"bar"=>42}
+
+# remove document
+res = collection.remove("foo")
+res.cas
+#=> 47891154812182
+
+# fetch top-3 cities by number of hotels in the collection
+res = cluster.query("
+          SELECT city, COUNT(*) AS cnt FROM `travel-sample`
+          WHERE type = $type
+          GROUP BY city
+          ORDER BY cnt DESC
+          LIMIT 3",
+        Options::Query(named_parameters: {type: "hotel"}, metrics: true))
+res.rows.each do |row|
+  p row
+end
+#=> {"city"=>"San Francisco", "cnt"=>132}
+#   {"city"=>"London", "cnt"=>67}
+#   {"city"=>"Paris", "cnt"=>64}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
@@ -60,3 +115,17 @@ Now the API reference is accessible using web browser (where `VERSION` is curren
 ## License
 
 The gem is available as open source under the terms of the [Apache2 License](https://opensource.org/licenses/Apache-2.0).
+
+    Copyright 2011-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.

data/ext/extconf.rb

@@ -1,95 +0,0 @@
-#    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 "mkmf"
-require "tempfile"
-
-require_relative "../lib/couchbase/version"
-SDK_VERSION = Couchbase::VERSION[:sdk]
-
-cmake = find_executable("cmake")
-if `#{cmake} --version`[/cmake version (\d+\.\d+)/, 1].to_f < 3.15
-  cmake = find_executable("cmake3")
-end
-abort "ERROR: CMake is required to build couchbase extension." unless cmake
-puts "-- #{`#{cmake} --version`.split("\n").first}"
-
-def sys(*cmd)
-  puts "-- #{Dir.pwd}"
-  puts "-- #{cmd.join(' ')}"
-  system(*cmd)
-end
-
-build_type = ENV["DEBUG"] ? "Debug" : "RelWithDebInfo"
-cmake_flags = %W[
-  -DCMAKE_BUILD_TYPE=#{build_type}
-  -DRUBY_HDR_DIR=#{RbConfig::CONFIG['rubyhdrdir']}
-  -DRUBY_ARCH_HDR_DIR=#{RbConfig::CONFIG['rubyarchhdrdir']}
-]
-
-cmake_flags << "-DCMAKE_C_COMPILER=#{ENV['CB_CC']}" if ENV["CB_CC"]
-cmake_flags << "-DCMAKE_CXX_COMPILER=#{ENV['CB_CXX']}" if ENV["CB_CXX"]
-cmake_flags << "-DSTATIC_STDLIB=ON" << "-DSTATIC_OPENSSL=ON" if ENV["CB_STATIC"]
-cmake_flags << "-DENABLE_SANITIZER_ADDRESS=ON" if ENV["CB_ASAN"]
-cmake_flags << "-DENABLE_SANITIZER_LEAK=ON" if ENV["CB_LSAN"]
-cmake_flags << "-DENABLE_SANITIZER_MEMORY=ON" if ENV["CB_MSAN"]
-cmake_flags << "-DENABLE_SANITIZER_THREAD=ON" if ENV["CB_TSAN"]
-cmake_flags << "-DENABLE_SANITIZER_UNDEFINED_BEHAVIOUR=ON" if ENV["CB_UBSAN"]
-
-case RbConfig::CONFIG["target_os"]
-when /darwin/
-  openssl_root = `brew --prefix openssl 2> /dev/null`.strip
-  cmake_flags << "-DOPENSSL_ROOT_DIR=#{openssl_root}" unless openssl_root.empty?
-when /linux/
-  openssl_root = ["/usr/lib64/openssl11", "/usr/include/openssl11"]
-  cmake_flags << "-DOPENSSL_ROOT_DIR=#{openssl_root.join(';')}" if openssl_root.all? { |path| File.directory?(path) }
-end
-
-project_path = File.expand_path(File.join(__dir__))
-build_dir = ENV['CB_EXT_BUILD_DIR'] ||
-            File.join(Dir.tmpdir, "cb-#{build_type}-#{RUBY_VERSION}-#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}-#{SDK_VERSION}")
-FileUtils.rm_rf(build_dir, verbose: true) unless ENV['CB_PRESERVE_BUILD_DIR']
-FileUtils.mkdir_p(build_dir, verbose: true)
-Dir.chdir(build_dir) do
-  puts "-- build #{build_type} extension #{SDK_VERSION} for ruby #{RUBY_VERSION}-#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}"
-  sys(cmake, *cmake_flags, project_path)
-  sys("make -j4 VERBOSE=1")
-end
-extension_name = "libcouchbase.#{RbConfig::CONFIG['SOEXT'] || RbConfig::CONFIG['DLEXT']}"
-extension_path = File.expand_path(File.join(build_dir, extension_name))
-abort "ERROR: failed to build extension in #{extension_path}" unless File.file?(extension_path)
-extension_name.gsub!(/\.dylib/, '.bundle')
-install_path = File.expand_path(File.join(__dir__, "..", "lib", "couchbase", extension_name))
-puts "-- copy extension to #{install_path}"
-FileUtils.cp(extension_path, install_path, verbose: true)
-ext_directory = File.expand_path(__dir__)
-create_makefile("libcouchbase")
-if ENV["CB_REMOVE_EXT_DIRECTORY"]
-  puts "-- CB_REMOVE_EXT_DIRECTORY is set, remove #{ext_directory}"
-  Dir
-    .glob("#{ext_directory}/*", File::FNM_DOTMATCH)
-    .reject { |path| %w[. .. extconf.rb].include?(File.basename(path)) || File.basename(path).start_with?(".gem") }
-    .each do |entry|
-    puts "-- remove #{entry}"
-    FileUtils.rm_rf(entry, verbose: true)
-  end
-  File.truncate("#{ext_directory}/extconf.rb", 0)
-  puts "-- truncate #{ext_directory}/extconf.rb"
-  File.write("#{ext_directory}/Makefile", <<~MAKEFILE)
-    .PHONY: all clean install
-    all:
-    clean:
-    install:
-  MAKEFILE
-end

data/lib/couchbase.rb

@@ -14,4 +14,5 @@
 
 require "couchbase/version"
 require "couchbase/libcouchbase"
+require "couchbase/logger"
 require "couchbase/cluster"

data/lib/couchbase/analytics_options.rb

@@ -12,80 +12,10 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require 'couchbase/json_transcoder'
+require "couchbase/json_transcoder"
 
 module Couchbase
   class Cluster
-    class AnalyticsOptions
-      # @return [Integer] Timeout in milliseconds
-      attr_accessor :timeout
-
-      # @return [String] Provides a custom client context ID for this query
-      attr_accessor :client_context_id
-
-      # @return [:not_bounded, :request_plus] specifies level of consistency for the query
-      attr_accessor :scan_consistency
-
-      # @return [Boolean] Allows explicitly marking a query as being readonly and not mutating any documents on the server side.
-      attr_accessor :readonly
-
-      # @return [Boolean] Allows to give certain requests higher priority than others
-      attr_accessor :priority
-
-      # @return [JsonTranscoder] transcoder to use on rows
-      attr_accessor :transcoder
-
-      # @api private
-      # @return [Hash<String => #to_json>]
-      attr_reader :raw_parameters
-
-      # @yieldparam [AnalyticsOptions] self
-      def initialize
-        @transcoder = JsonTranscoder.new
-        @raw_parameters = {}
-        @positional_parameters = nil
-        @named_parameters = nil
-        @scan_consistency = nil
-        yield self if block_given?
-      end
-
-      # Sets positional parameters for the query
-      #
-      # @param [Array] positional the list of parameters that have to be substituted in the statement
-      def positional_parameters(positional)
-        @positional_parameters = positional
-        @named_parameters = nil
-      end
-
-      # @api private
-      # @return [Array<String>, nil]
-      def export_positional_parameters
-        @positional_parameters&.map { |p| JSON.dump(p) }
-      end
-
-      # Sets named parameters for the query
-      #
-      # @param [Hash] named the key/value map of the parameters to substitute in the statement
-      def named_parameters(named)
-        @named_parameters = named
-        @positional_parameters = nil
-      end
-
-      # Allows providing custom JSON key/value pairs for advanced usage
-      #
-      # @param [String] key the parameter name (key of the JSON property)
-      # @param [Object] value the parameter value (value of the JSON property)
-      def raw(key, value)
-        @raw_parameters[key] = JSON.generate(value)
-      end
-
-      # @api private
-      # @return [Hash<String => String>, nil]
-      def export_named_parameters
-        @named_parameters&.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) }
-      end
-    end
-
     class AnalyticsWarning
       # @return [Integer]
       attr_accessor :code

data/lib/couchbase/binary_collection.rb

@@ -12,6 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/options"
 require "couchbase/binary_collection_options"
 
 module Couchbase
@@ -28,35 +29,59 @@ module Couchbase
     #
     # @param [String] id the document id which is used to uniquely identify it
     # @param [String] content the binary content to append to the document
-    # @param [AppendOptions] options custom options to customize the request
+    # @param [Options::Append] options custom options to customize the request
+    #
+    # @example Append "bar" to the content of the existing document
+    #   collection.upsert("mydoc", "foo")
+    #   collection.binary.append("mydoc", "bar", Options::Append(timeout: 3_000))
+    #   collection.get("mydoc", Options::Get(transcoder: nil)).content #=> "foobar"
     #
     # @return [Collection::MutationResult]
-    def append(id, content, options = AppendOptions.new) end
+    def append(id, content, options = Options::Append.new)
+      resp = @backend.document_append(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}",
+                                      id, content, options.to_backend)
+      Collection::MutationResult.new do |res|
+        res.cas = resp[:cas]
+        res.mutation_token = @collection.send(:extract_mutation_token, resp)
+      end
+    end
 
     # Prepends binary content to the document
     #
     # @param [String] id the document id which is used to uniquely identify it
     # @param [String] content the binary content to prepend to the document
-    # @param [PrependOptions] options custom options to customize the request
+    # @param [Options::Prepend] options custom options to customize the request
+    #
+    # @example Prepend "bar" to the content of the existing document
+    #   collection.upsert("mydoc", "foo")
+    #   collection.binary.prepend("mydoc", "bar", Options::Prepend(timeout: 3_000))
+    #   collection.get("mydoc", Options::Get(transcoder: nil)).content #=> "barfoo"
     #
     # @return [Collection::MutationResult]
-    def prepend(id, content, options = PrependOptions.new) end
+    def prepend(id, content, options = Options::Prepend.new)
+      resp = @backend.document_prepend(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}",
+                                       id, content, options.to_backend)
+      Collection::MutationResult.new do |res|
+        res.cas = resp[:cas]
+        res.mutation_token = @collection.send(:extract_mutation_token, resp)
+      end
+    end
 
     # Increments the counter document by one of the number defined in the options
     #
     # @param [String] id the document id which is used to uniquely identify it
-    # @param [IncrementOptions] options custom options to customize the request
+    # @param [Options::Increment] options custom options to customize the request
+    #
+    # @example Increment value by 10, and initialize to 0 if it does not exist
+    #   res = collection.binary.increment("raw_counter", Options::Increment(delta: 10, initial: 0))
+    #   res.content #=> 0
+    #   res = collection.binary.increment("raw_counter", Options::Increment(delta: 10, initial: 0))
+    #   res.content #=> 10
     #
     # @return [CounterResult]
-    def increment(id, options = IncrementOptions.new)
+    def increment(id, options = Options::Increment.new)
       resp = @backend.document_increment(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id,
-                                         options.timeout,
-                                         {
-                                           delta: options.delta,
-                                           initial_value: options.initial,
-                                           expiry: options.expiry,
-                                           durability_level: options.durability_level,
-                                         })
+                                         options.to_backend)
       CounterResult.new do |res|
         res.cas = resp[:cas]
         res.content = resp[:content]
@@ -67,23 +92,36 @@ module Couchbase
     # Decrements the counter document by one of the number defined in the options
     #
     # @param [String] id the document id which is used to uniquely identify it
-    # @param [DecrementOptions] options custom options to customize the request
+    # @param [Options::Decrement] options custom options to customize the request
+    #
+    # @example Decrement value by 2, and initialize to 100 if it does not exist
+    #   res = collection.binary.decrement("raw_counter", Options::Decrement(delta: 2, initial: 100))
+    #   res.value #=> 100
+    #   res = collection.binary.decrement("raw_counter", Options::Decrement(delta: 2, initial: 100))
+    #   res.value #=> 98
     #
     # @return [CounterResult]
-    def decrement(id, options = DecrementOptions.new)
+    def decrement(id, options = Options::Decrement.new)
       resp = @backend.document_decrement(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id,
-                                         options.timeout,
-                                         {
-                                           delta: options.delta,
-                                           initial_value: options.initial,
-                                           expiry: options.expiry,
-                                           durability_level: options.durability_level,
-                                         })
+                                         options.to_backend)
       CounterResult.new do |res|
         res.cas = resp[:cas]
         res.content = resp[:content]
         res.mutation_token = @collection.send(:extract_mutation_token, resp)
       end
     end
+
+    # @api private
+    # TODO: deprecate in 3.1
+    AppendOptions = ::Couchbase::Options::Append
+    # @api private
+    # TODO: deprecate in 3.1
+    PrependOptions = ::Couchbase::Options::Prepend
+    # @api private
+    # TODO: deprecate in 3.1
+    IncrementOptions = ::Couchbase::Options::Increment
+    # @api private
+    # TODO: deprecate in 3.1
+    DecrementOptions = ::Couchbase::Options::Decrement
   end
 end

data/lib/couchbase/binary_collection_options.rb

@@ -16,82 +16,6 @@ require "couchbase/collection_options"
 
 module Couchbase
   class BinaryCollection
-    class AppendOptions < CommonOptions
-      # @return [Integer] The default CAS used (0 means no CAS in this context)
-      attr_accessor :cas
-
-      # @yieldparam [AppendOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
-    class PrependOptions < CommonOptions
-      # @return [Integer] The default CAS used (0 means no CAS in this context)
-      attr_accessor :cas
-
-      # @yieldparam [PrependOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
-    class IncrementOptions < CommonOptions
-      # @return [Integer] the delta for the operation
-      attr_reader :delta
-
-      # @return [Integer] if present, holds the initial value
-      attr_accessor :initial
-
-      # @return [Integer] if set, holds the expiration for the operation
-      attr_accessor :expiry
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [IncrementOptions] self
-      def initialize
-        super
-        @delta = 1
-        yield self if block_given?
-      end
-
-      def delta=(value)
-        raise ArgumentError, "the delta cannot be less than 0" if delta.negative?
-
-        @delta = value
-      end
-    end
-
-    class DecrementOptions < CommonOptions
-      # @return [Integer] the delta for the operation
-      attr_reader :delta
-
-      # @return [Integer] if present, holds the initial value
-      attr_accessor :initial
-
-      # @return [Integer] if set, holds the expiration for the operation
-      attr_accessor :expiry
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [DecrementOptions] self
-      def initialize
-        super
-        @delta = 1
-        yield self if block_given?
-      end
-
-      def delta=(value)
-        raise ArgumentError, "the delta cannot be less than 0" if delta.negative?
-
-        @delta = value
-      end
-    end
-
     class CounterResult < ::Couchbase::Collection::MutationResult
       # @return [Integer] current value of the counter
       attr_accessor :content