couchbase 3.0.0.alpha.1 → 3.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85cb801dc8f7b63d941b79865a732d57ed42bb120cb9e7aedeb5896fcdb9335a
-  data.tar.gz: 83e988d0285aaf16389238afbbf0369aca85394712b8eb492f7f66646b5f4441
+  metadata.gz: cd8c352b8e6f1752e4a465be62889b7d00f89fa6dbb217ceb6a2fbcff601d4c2
+  data.tar.gz: 232734648d18dddac6acbc8f5ea1b3d40cec2efa1ef2e021e568b4491152cfcd
 SHA512:
-  metadata.gz: 5bf2fe5ef893721de3a7e00ac26d731ed8d00ee47ab8fd2ba72097ae9218a4652618d4677d9899568de2c61d39082b5fdcd747b3f41e1a605abcf7756abc6540
-  data.tar.gz: 654499d9954281e56a5fdcbb8e9c5162e2e97b51331603df37a3910d0595d335a8ea18c2057042c54f22faad9dad5e732860a4c591f05e8f119712bc6b6dd0e7
+  metadata.gz: ec3182ef85d573758801b9ed34ad034c441b247fe9aa52c23b8fead63671572ec338fa8c735c0194464d957d0eb0eddcc64aa4e300b83f40bb02a8a0dcf8d074
+  data.tar.gz: 35973818ce61c6b8a1d984125bcf5398940566d5f8f0d16b280fcdf7e2e5eea3c1dddf4cd2d9ee16b0ddff0d85933f683759996ed4feb6660f8279cf0213e19f

data/.github/workflows/tests-6.0.3.yml

@@ -0,0 +1,49 @@
+name: tests-6.0.3
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    services:
+      couchbase:
+        image: couchbase:enterprise-6.0.3
+        ports:
+          - 8091-8094:8091-8094
+          - 11210:11210
+
+    steps:
+      - name: Install build environment
+        run: sudo apt-get install -y libssl-dev cmake gcc g++ curl
+
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Initialize couchbase
+        run: ./bin/init-cluster
+
+      - name: Compile extension
+        run: bundle exec rake compile
+
+      - name: Display library version
+        run: bundle exec ruby -I lib -r couchbase -e 'pp Couchbase::VERSION'
+
+      - name: Run tests
+        run: bundle exec rake test
+        env:
+          TEST_SERVER_VERSION: 6.0.3

data/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    services:
+      couchbase:
+        image: couchbase
+        ports:
+          - 8091-8094:8091-8094
+          - 11210:11210
+
+    steps:
+      - name: Install build environment
+        run: sudo apt-get install -y libssl-dev cmake gcc g++ curl
+
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Initialize couchbase
+        run: ./bin/init-cluster
+
+      - name: Compile extension
+        run: bundle exec rake compile
+
+      - name: Display library version
+        run: bundle exec ruby -I lib -r couchbase -e 'pp Couchbase::VERSION'
+
+      - name: Run tests
+        run: bundle exec rake test

data/.gitmodules

@@ -13,3 +13,6 @@
 [submodule "ext/third_party/asio"]
 	path = ext/third_party/asio
 	url = git://github.com/chriskohlhoff/asio.git
+[submodule "ext/third_party/snappy"]
+	path = ext/third_party/snappy
+	url = git://github.com/google/snappy.git

data/.idea/dictionaries/gem_terms.xml

@@ -2,11 +2,16 @@
   <dictionary name="gem_terms">
     <words>
       <w>adhoc</w>
+      <w>datasets</w>
+      <w>datastores</w>
       <w>dataverse</w>
+      <w>keyspace</w>
       <w>libcouchbase</w>
       <w>opcode</w>
+      <w>subdoc</w>
       <w>subdocument</w>
       <w>upsert</w>
+      <w>upserting</w>
       <w>xattr</w>
     </words>
   </dictionary>

data/.idea/inspectionProfiles/Project_Default.xml

@@ -2,6 +2,7 @@
   <profile version="1.0">
     <option name="myName" value="Project Default" />
     <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="RubyInstanceMethodNamingConvention" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="RubyStringKeysInHashInspection" enabled="false" level="WARNING" enabled_by_default="false" />
   </profile>
 </component>

data/.idea/vcs.xml

@@ -6,6 +6,7 @@
     <mapping directory="$PROJECT_DIR$/ext/third_party/gsl" vcs="Git" />
     <mapping directory="$PROJECT_DIR$/ext/third_party/http_parser" vcs="Git" />
     <mapping directory="$PROJECT_DIR$/ext/third_party/json" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/ext/third_party/snappy" vcs="Git" />
     <mapping directory="$PROJECT_DIR$/ext/third_party/spdlog" vcs="Git" />
   </component>
 </project>

data/Gemfile

@@ -19,5 +19,6 @@ gemspec
 
 group :development do
   gem "byebug"
+  gem "rake"
 #  gem "sorbet"
 end

data/README.md

@@ -1,6 +1,59 @@
-# Couchbase Ruby Client
+# Couchbase Ruby Client [![tests](https://github.com/couchbase/couchbase-ruby-client/workflows/tests/badge.svg)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Atests)
 
-This repository contains the third generation of the Couchbase SDK for Ruby (aka. SDKv3)
+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](http://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:
+
+    $ ruby -r couchbase -e 'p Couchbase::VERSION'
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "couchbase", "3.0.0.alpha.2"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install --pre couchbase
+
+For some platforms we precompile binary packages. When, for some reason, binary package cannot be used, pass
+`--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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+Part of the library is written in C++, and requires both C and C++ compilers installed on the system. To configure build
+environment, it uses `cmake`. When these tools installed, the build process is easy:
+
+    $ rake compile
+
+## Generate Documentation
+
+To generate documentation `yard` library is highly recommended.
+
+    $ gem install yard
+
+The following steps will generate API reference for selected git tag:
+
+    $ rake doc
+
+Now the API reference is accessible using web browser (where `VERSION` is current version of the SDK)
+
+    $ firefox doc/couchbase-ruby-client-VERSION/index.html
 
 ## License
 

data/Rakefile

@@ -27,3 +27,21 @@ task :compile do
     sh "ruby #{File.join(__dir__, "ext", "extconf.rb")}"
   end
 end
+
+task :doc do
+  require "couchbase/version"
+  input_dir = File.join(__dir__, "lib")
+  output_dir = File.join(__dir__, "doc", "couchbase-ruby-client-#{Couchbase::VERSION[:sdk]}")
+  rm_rf output_dir
+  sh "yard doc --output-dir #{output_dir} #{input_dir}"
+  puts "#{File.realpath(output_dir)}/index.html"
+end
+
+task :docs => :doc
+
+task :render_git_revision do
+  build_version_path = File.join(__dir__, 'ext', 'build_version.hxx.in')
+  File.write(build_version_path, File.read(build_version_path).gsub('@BACKEND_GIT_REVISION@', `git rev-parse HEAD`.strip))
+end
+
+task :build => :render_git_revision

data/bin/init-cluster

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+#    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.
+
+HOST="localhost"
+USERNAME="Administrator"
+PASSWORD="password"
+CREDS="${USERNAME}:${PASSWORD}"
+
+sleep 1
+
+set -ex
+
+# Ping cluster
+curl -sS http://${HOST}:8091/pools
+
+# Initialize Node
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/nodes/self/controller/settings \
+     -d 'path=%2Fopt%2Fcouchbase%2Fvar%2Flib%2Fcouchbase%2Fdata' \
+     -d 'index_path=%2Fopt%2Fcouchbase%2Fvar%2Flib%2Fcouchbase%2Fdata'
+
+# Setup Services
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/node/controller/setupServices \
+     -d 'services=kv%2Cn1ql%2Cindex'
+
+# Setup Memory Quotas
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/pools/default \
+  -d 'memoryQuota=256' \
+  -d 'indexMemoryQuota=256'
+
+# Setup Administrator username and password
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/settings/web \
+     -d "password=${PASSWORD}" \
+     -d "username=${USERNAME}" \
+     -d "port=SAME"
+
+# Setup index settings
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/settings/indexes \
+     -d "storageMode=plasma"
+
+# Setup Bucket
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/pools/default/buckets \
+     -d 'flushEnabled=1' \
+     -d 'threadsNumber=3' \
+     -d 'replicaIndex=0' \
+     -d 'replicaNumber=0' \
+     -d 'evictionPolicy=valueOnly' \
+     -d 'ramQuotaMB=100' \
+     -d 'bucketType=membase' \
+     -d 'name=default'

data/bin/setup

@@ -19,5 +19,6 @@ PROJECT_ROOT="$( cd "$(dirname "$0"/..)" >/dev/null 2>&1 ; pwd -P )"
 set -euo pipefail
 IFS=$'\n\t'
 set -vx
+git submodule update --init
 bundle config set --local path ${PROJECT_ROOT}/vendor/bundle
 bundle install

data/couchbase.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.email = ["sergey.avseyev@gmail.com"]
   spec.summary = "SDK for Couchbase Server"
   spec.description = "Modern SDK for Couchbase Server"
-  spec.homepage = "https://github.com/couchbase/couchbase.rb"
-  spec.license = "MIT"
+  spec.homepage = "https://www.couchbase.com"
+  spec.license = "Apache-2.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/couchbase/couchbase-ruby-client"
@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/extconf.rb"]
+  spec.rdoc_options.append('--exclude', 'ext/')
 
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 13.0"

data/examples/crud.rb

@@ -1,4 +1,3 @@
-require 'irb'
 require 'couchbase'
 include Couchbase
 
@@ -12,7 +11,7 @@ res = collection.upsert("foo", {"bar" => 42})
 p res.cas
 
 res = collection.get("foo")
-p res.content_as :json
+p res.content
 p res.cas
 
 res = collection.remove("foo")

data/examples/managing_buckets.rb

@@ -0,0 +1,47 @@
+require 'couchbase'
+include Couchbase
+
+def measure(msg)
+  start = Time.now
+  yield
+  printf "%s in %.2f seconds\n", msg, Time.now - start
+end
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+bucket_name = "new_bucket"
+
+all_buckets = cluster.buckets.get_all_buckets
+puts "There are #{all_buckets.size} buckets on the cluster"
+all_buckets.each do |bucket|
+  puts " * #{bucket.name} (type: #{bucket.bucket_type}, quota: #{bucket.ram_quota_mb} MB)"
+end
+
+if all_buckets.any? { |bucket| bucket.name == bucket_name }
+  measure("Bucket #{bucket_name.inspect} removed") { cluster.buckets.drop_bucket(bucket_name) }
+end
+
+settings = Management::BucketSettings.new
+settings.name = bucket_name
+settings.ram_quota_mb = 100
+settings.flush_enabled = true
+measure("New bucket #{bucket_name.inspect} created") { cluster.buckets.create_bucket(settings) }
+
+sleep(1)
+
+settings = cluster.buckets.get_bucket(bucket_name)
+puts "Bucket #{bucket_name.inspect} settings:"
+puts " * healthy?           : #{settings.healthy?}"
+puts " * RAM quota          : #{settings.ram_quota_mb}"
+puts " * number of replicas : #{settings.num_replicas}"
+puts " * flush enabled:     : #{settings.flush_enabled}"
+puts " * max TTL            : #{settings.max_expiry}"
+puts " * compression mode   : #{settings.compression_mode}"
+puts " * replica indexes    : #{settings.replica_indexes}"
+puts " * ejection policy    : #{settings.ejection_policy}"
+
+measure("Bucket #{bucket_name.inspect} flushed") { cluster.buckets.flush_bucket(bucket_name) }
+
+cluster.disconnect

data/examples/managing_collections.rb

@@ -0,0 +1,58 @@
+require 'couchbase'
+include Couchbase
+
+def measure(msg)
+  start = Time.now
+  yield
+  printf "%s in %.2f seconds\n", msg, Time.now - start
+end
+
+bucket_name = "travel-sample"
+scope_name = "myapp"
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+bucket = cluster.bucket(bucket_name)
+
+
+scopes = bucket.collections.get_all_scopes
+puts "There are #{scopes.size} on the bucket \"#{bucket_name}\""
+
+scopes.each do |scope|
+  puts "  * \"#{scope.name}\" (#{scope.collections.size})"
+  scope.collections.each do |collection|
+    puts "    * \"#{collection.name}\""
+  end
+end
+
+if scopes.any? {|scope| scope.name == scope_name }
+  measure("Scope \"#{scope_name}\" has been removed") { bucket.collections.drop_scope(scope_name) }
+end
+measure("Scope \"#{scope_name}\" has been created") { bucket.collections.create_scope(scope_name) }
+
+scope = bucket.collections.get_scope(scope_name)
+puts "Scope \"#{scope_name}\" has #{scope.collections.size} collections"
+
+collection = Management::CollectionSpec.new
+collection.scope_name = scope_name
+collection.name = "users"
+measure("Collection \"#{collection.name}\" on scope \"#{collection.scope_name}\" has been created") do
+  bucket.collections.create_collection(collection)
+end
+
+scope = bucket.collections.get_scope(scope_name)
+puts "Scope \"#{scope_name}\" has #{scope.collections.size} collections"
+scope.collections.each do |collection|
+  puts "  * \"#{collection.name}\""
+end
+
+measure("Collection \"#{collection.name}\" on scope \"#{collection.scope_name}\" has been dropped") do
+  bucket.collections.drop_collection(collection)
+end
+
+scope = bucket.collections.get_scope(scope_name)
+puts "Scope \"#{scope_name}\" has #{scope.collections.size} collections"
+scope.collections.each do |collection|
+  puts "  * \"#{collection.name}\""
+end