couchbase 3.0.0.beta.1-universal-darwin-19 → 3.0.0-universal-darwin-19

data/examples/analytics.rb

@@ -1,12 +1,25 @@
-require 'couchbase'
-
-include Couchbase
+#    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"
+
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
-
 bucket_name = "tiny_social"
 dataverse_name = "TinySocial"
 
@@ -31,116 +44,116 @@ collection = cluster.bucket(bucket_name).default_collection
 
 # Documents for GleambookUsers dataset
 [
-    {
-        "id" => 1,
-        "alias" => "Margarita",
-        "name" => "MargaritaStoddard",
-        "nickname" => "Mags",
-        "userSince" => "2012-08-20T10:10:00",
-        "friendIds" => [2, 3, 6, 10],
-        "employment" => [
-            {
-                "organizationName" => "Codetechno",
-                "start-date" => "2006-08-06"
-            },
-            {
-                "organizationName" => "geomedia",
-                "start-date" => "2010-06-17",
-                "end-date" => "2010-01-26"
-            }
-        ],
-        "gender" => "F"
-    },
-    {
-        "id" => 2,
-        "alias" => "Isbel",
-        "name" => "IsbelDull",
-        "nickname" => "Izzy",
-        "userSince" => "2011-01-22T10:10:00",
-        "friendIds" => [1, 4],
-        "employment" => [
-            {
-                "organizationName" => "Hexviafind",
-                "startDate" => "2010-04-27"
-            }
-        ]
-    },
-    {
-        "id" => 3,
-        "alias" => "Emory",
-        "name" => "EmoryUnk",
-        "userSince" => "2012-07-10T10:10:00",
-        "friendIds" => [1, 5, 8, 9],
-        "employment" => [
-            {
-                "organizationName" => "geomedia",
-                "startDate" => "2010-06-17",
-                "endDate" => "2010-01-26"
-            }
-        ]
-    }
+  {
+    "id" => 1,
+    "alias" => "Margarita",
+    "name" => "MargaritaStoddard",
+    "nickname" => "Mags",
+    "userSince" => "2012-08-20T10:10:00",
+    "friendIds" => [2, 3, 6, 10],
+    "employment" => [
+      {
+        "organizationName" => "Codetechno",
+        "start-date" => "2006-08-06",
+      },
+      {
+        "organizationName" => "geomedia",
+        "start-date" => "2010-06-17",
+        "end-date" => "2010-01-26",
+      },
+    ],
+    "gender" => "F",
+  },
+  {
+    "id" => 2,
+    "alias" => "Isbel",
+    "name" => "IsbelDull",
+    "nickname" => "Izzy",
+    "userSince" => "2011-01-22T10:10:00",
+    "friendIds" => [1, 4],
+    "employment" => [
+      {
+        "organizationName" => "Hexviafind",
+        "startDate" => "2010-04-27",
+      },
+    ],
+  },
+  {
+    "id" => 3,
+    "alias" => "Emory",
+    "name" => "EmoryUnk",
+    "userSince" => "2012-07-10T10:10:00",
+    "friendIds" => [1, 5, 8, 9],
+    "employment" => [
+      {
+        "organizationName" => "geomedia",
+        "startDate" => "2010-06-17",
+        "endDate" => "2010-01-26",
+      },
+    ],
+  },
 ].each do |document|
-  collection.upsert("user:#{document["id"]}",
+  collection.upsert("user:#{document['id']}",
                     document.merge({"type" => "user"}))
 end
 
 # Documents for GleambookMessages dataset
 [
-    {
-        "messageId" => 2,
-        "authorId" => 1,
-        "inResponseTo" => 4,
-        "senderLocation" => [41.66, 80.87],
-        "message" => " dislike x-phone its touch-screen is horrible"
-    },
-    {
-        "messageId" => 3,
-        "authorId" => 2,
-        "inResponseTo" => 4,
-        "senderLocation" => [48.09, 81.01],
-        "message" => " like product-y the plan is amazing"
-    },
-    {
-        "messageId" => 4,
-        "authorId" => 1,
-        "inResponseTo" => 2,
-        "senderLocation" => [37.73, 97.04],
-        "message" => " can't stand acast the network is horrible:("
-    },
-    {
-        "messageId" => 6,
-        "authorId" => 2,
-        "inResponseTo" => 1,
-        "senderLocation" => [31.5, 75.56],
-        "message" => " like product-z its platform is mind-blowing"
-    },
-    {
-        "messageId" => 8,
-        "authorId" => 1,
-        "inResponseTo" => 11,
-        "senderLocation" => [40.33, 80.87],
-        "message" => " like ccast the 3G is awesome:)"
-    },
-    {
-        "messageId" => 10,
-        "authorId" => 1,
-        "inResponseTo" => 12,
-        "senderLocation" => [42.5, 70.01],
-        "message" => " can't stand product-w the touch-screen is terrible"
-    },
-    {
-        "messageId" => 11,
-        "authorId" => 1,
-        "inResponseTo" => 1,
-        "senderLocation" => [38.97, 77.49],
-        "message" => " can't stand acast its plan is terrible"
-    }
+  {
+    "messageId" => 2,
+    "authorId" => 1,
+    "inResponseTo" => 4,
+    "senderLocation" => [41.66, 80.87],
+    "message" => " dislike x-phone its touch-screen is horrible",
+  },
+  {
+    "messageId" => 3,
+    "authorId" => 2,
+    "inResponseTo" => 4,
+    "senderLocation" => [48.09, 81.01],
+    "message" => " like product-y the plan is amazing",
+  },
+  {
+    "messageId" => 4,
+    "authorId" => 1,
+    "inResponseTo" => 2,
+    "senderLocation" => [37.73, 97.04],
+    "message" => " can't stand acast the network is horrible:(",
+  },
+  {
+    "messageId" => 6,
+    "authorId" => 2,
+    "inResponseTo" => 1,
+    "senderLocation" => [31.5, 75.56],
+    "message" => " like product-z its platform is mind-blowing",
+  },
+  {
+    "messageId" => 8,
+    "authorId" => 1,
+    "inResponseTo" => 11,
+    "senderLocation" => [40.33, 80.87],
+    "message" => " like ccast the 3G is awesome:)",
+  },
+  {
+    "messageId" => 10,
+    "authorId" => 1,
+    "inResponseTo" => 12,
+    "senderLocation" => [42.5, 70.01],
+    "message" => " can't stand product-w the touch-screen is terrible",
+  },
+  {
+    "messageId" => 11,
+    "authorId" => 1,
+    "inResponseTo" => 1,
+    "senderLocation" => [38.97, 77.49],
+    "message" => " can't stand acast its plan is terrible",
+  },
 ].each do |document|
-  collection.upsert("message:#{document["messageId"]}",
+  collection.upsert("message:#{document['messageId']}",
                     document.merge({"type" => "message"}))
 end
 
-if cluster.analytics_indexes.get_all_datasets.any? {|ds| ds.dataverse_name == dataverse_name}
+if cluster.analytics_indexes.get_all_datasets.any? { |ds| ds.dataverse_name == dataverse_name }
   # there are datasets on our dataverse, drop everything and re-create
   options = Management::AnalyticsIndexManager::DisconnectLinkOptions.new
   options.dataverse_name = dataverse_name
@@ -166,9 +179,11 @@ cluster.analytics_indexes.connect_link(options)
 sleep(1)
 
 puts "---- inner join"
-res = cluster.analytics_query("SELECT * FROM #{dataverse_name}.GleambookUsers u, #{dataverse_name}.GleambookMessages m WHERE m.authorId = u.id")
+res = cluster.analytics_query(
+  "SELECT * FROM #{dataverse_name}.GleambookUsers u, #{dataverse_name}.GleambookMessages m WHERE m.authorId = u.id"
+)
 res.rows.each do |row|
-  puts "#{row["u"]["name"]}: #{row["m"]["message"].inspect}"
+  puts "#{row['u']['name']}: #{row['m']['message'].inspect}"
 end
 
 # The query language supports SQL's notion of left outer join.
@@ -180,7 +195,7 @@ res = cluster.analytics_query("
   LEFT OUTER JOIN GleambookMessages m ON m.authorId = u.id
 ")
 res.rows.each do |row|
-  puts "#{row["uname"]}: #{row["message"].inspect}"
+  puts "#{row['uname']}: #{row['message'].inspect}"
 end
 
 # Named parameters
@@ -215,7 +230,7 @@ FROM GleambookUsers AS user
 WHERE len(user.friendIds) > $1
 ", options)
 res.rows.each do |row|
-  puts "#{row["name"]}: #{row["friendIds"].size}"
+  puts "#{row['name']}: #{row['friendIds'].size}"
 end
 
 # More query examples at https://docs.couchbase.com/server/current/analytics/3_query.html

data/examples/auth.rb

@@ -0,0 +1,33 @@
+#    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"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
+
+options = Cluster::ClusterOptions.new
+# initializes {PasswordAuthenticator} internally
+options.authenticate("Administrator", "password")
+Cluster.connect("couchbase://localhost", options)
+
+# the same as above, but more explicit
+options.authenticator = PasswordAuthenticator.new("Administrator", "password")
+Cluster.connect("couchbase://localhost", options)
+
+# shorter version, more useful for interactive sessions
+Cluster.connect("couchbase://localhost", "Administrator", "password")
+
+# authentication with TLS client certificate
+# @see https://docs.couchbase.com/server/current/manage/manage-security/configure-client-certificates.html
+options.authenticator = CertificateAuthenticator.new("/tmp/certificate.pem", "/tmp/private.key")
+Cluster.connect("couchbases://localhost?trust_certificate=/tmp/ca.pem", options)

data/examples/crud.rb

@@ -1,5 +1,19 @@
-require 'couchbase'
-include Couchbase
+#    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"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")

data/examples/managing_analytics_indexes.rb

@@ -1,10 +1,24 @@
-require 'couchbase'
-include Couchbase
+#    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"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 def measure(msg)
   start = Time.now
   yield
-  printf "%s in %.2f seconds\n", msg, Time.now - start
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
 options = Cluster::ClusterOptions.new
@@ -47,7 +61,7 @@ manager.create_index("breweries_loc_idx", "beers", {"geo.lon" => "double", "geo.
 
 puts "---- Indexes currently defined on the cluster:"
 manager.get_all_indexes.each_with_index do |index, i|
-  puts "#{i}. #{index.dataverse_name}.#{index.dataset_name}.#{index.name} #{"(primary)" if index.primary?}"
+  puts "#{i}. #{index.dataverse_name}.#{index.dataset_name}.#{index.name} #{'(primary)' if index.primary?}"
 end
 
 # Drops one of the indexes

data/examples/managing_buckets.rb

@@ -1,10 +1,24 @@
-require 'couchbase'
-include Couchbase
+#    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"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 def measure(msg)
   start = Time.now
   yield
-  printf "%s in %.2f seconds\n", msg, Time.now - start
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
 options = Cluster::ClusterOptions.new

data/examples/managing_collections.rb

@@ -1,10 +1,24 @@
-require 'couchbase'
-include Couchbase
+#    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"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 def measure(msg)
   start = Time.now
   yield
-  printf "%s in %.2f seconds\n", msg, Time.now - start
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
 bucket_name = "travel-sample"
@@ -15,7 +29,6 @@ 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}\""
 
@@ -26,7 +39,7 @@ scopes.each do |scope|
   end
 end
 
-if scopes.any? {|scope| scope.name == scope_name }
+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) }
@@ -43,8 +56,8 @@ 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}\""
+scope.collections.each do |c|
+  puts "  * \"#{c.name}\""
 end
 
 measure("Collection \"#{collection.name}\" on scope \"#{collection.scope_name}\" has been dropped") do
@@ -53,6 +66,6 @@ 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}\""
+scope.collections.each do |c|
+  puts "  * \"#{c.name}\""
 end