couchbase 3.0.2 → 3.0.3

data/lib/couchbase/railtie.rb

@@ -0,0 +1,45 @@
+#    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 "rails"
+
+require "couchbase/configuration"
+
+module Rails
+  module Couchbase
+    class Railtie < ::Rails::Railtie
+      def self.rescue_responses
+        {
+          "Couchbase::Error::DocumentNotFound" => :not_found,
+        }
+      end
+
+      config.action_dispatch.rescue_responses&.merge!(rescue_responses)
+
+      config.couchbase = ::Couchbase::Configuration.new
+
+      initializer "couchbase.load-config" do
+        config_path = Rails.root.join("config", "couchbase.yml")
+        if config_path.file?
+          begin
+            config.couchbase.load!(config_path)
+          rescue ::Couchbase::Error::CouchbaseError => e
+            puts "There is a configuration error with the current couchbase.yml"
+            puts e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couchbase/scope.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#    Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@ require "couchbase/collection"
 require "couchbase/query_options"
 
 module Couchbase
+  # The scope identifies a group of collections and allows high application density as a result.
   class Scope
     attr_reader :bucket_name
     attr_reader :name
@@ -51,8 +52,8 @@ module Couchbase
     # @param [Options::Query] options the custom options for this query
     #
     # @example Select first ten hotels from travel sample dataset
-    #   cluster.query("SELECT * FROM `travel-sample` WHERE type = $type LIMIT 10",
-    #                 Options::Query(named_parameters: {type: "hotel"}, metrics: true))
+    #   scope.query("SELECT * FROM `travel-sample` WHERE type = $type LIMIT 10",
+    #                Options::Query(named_parameters: {type: "hotel"}, metrics: true))
     #
     # @return [QueryResult]
     def query(statement, options = Options::Query.new)
@@ -82,5 +83,45 @@ module Couchbase
         res.instance_variable_set("@rows", resp[:rows])
       end
     end
+
+    # Performs an analytics query
+    #
+    # The query will be implicitly scoped using current bucket and scope names.
+    #
+    # @param [String] statement the N1QL query statement
+    # @param [Options::Analytics] options the custom options for this query
+    #
+    # @example Select name of the given user
+    #   scope.analytics_query("SELECT u.name AS uname FROM GleambookUsers u WHERE u.id = $user_id ",
+    #                          Options::Analytics(named_parameters: {user_id: 2}))
+    #
+    # @return [AnalyticsResult]
+    def analytics_query(statement, options = Options::Analytics.new)
+      resp = @backend.document_analytics(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))
+
+      AnalyticsResult.new do |res|
+        res.transcoder = options.transcoder
+        res.meta_data = AnalyticsMetaData.new do |meta|
+          meta.status = resp[:meta][:status]
+          meta.request_id = resp[:meta][:request_id]
+          meta.client_context_id = resp[:meta][:client_context_id]
+          meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
+          meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
+          meta.metrics = AnalyticsMetrics.new do |metrics|
+            if resp[:meta][:metrics]
+              metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
+              metrics.execution_time = resp[:meta][:metrics][:execution_time]
+              metrics.result_count = resp[:meta][:metrics][:result_count]
+              metrics.result_size = resp[:meta][:metrics][:result_size]
+              metrics.error_count = resp[:meta][:metrics][:error_count]
+              metrics.warning_count = resp[:meta][:metrics][:warning_count]
+              metrics.processed_objects = resp[:meta][:metrics][:processed_objects]
+            end
+          end
+          res[:warnings] = resp[:warnings].map { |warn| QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
+        end
+        res.instance_variable_set("@rows", resp[:rows])
+      end
+    end
   end
 end

data/lib/couchbase/utils.rb

@@ -0,0 +1,21 @@
+#    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.
+
+module Couchbase
+  # Module for internal tools, extensions and utilities
+  module Utils
+  end
+end
+
+require "couchbase/utils/time"

data/lib/couchbase/utils/time.rb

@@ -0,0 +1,52 @@
+#    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 "time"
+
+module Couchbase
+  module Utils
+    # Various Time utilities
+    module Time
+      RELATIVE_EXPIRY_CUTOFF_SECONDS = 30 * 24 * 60 * 60
+      WORKAROUND_EXPIRY_CUTOFF_SECONDS = 50 * 365 * 24 * 60 * 60
+
+      module_function
+
+      # @param [Integer, #in_seconds, Time, nil] time_or_duration expiration time to associate with the document
+      def extract_expiry_time(time_or_duration)
+        if time_or_duration.respond_to?(:in_seconds) # Duration
+          time_or_duration.in_seconds
+        elsif time_or_duration.respond_to?(:tv_sec) # Time
+          time_or_duration.tv_sec
+        elsif time_or_duration.is_a?(Integer)
+          if time_or_duration < RELATIVE_EXPIRY_CUTOFF_SECONDS
+            # looks like valid relative duration as specified in protocol (less than 30 days)
+            time_or_duration
+          elsif time_or_duration > WORKAROUND_EXPIRY_CUTOFF_SECONDS
+            effective_expiry = ::Time.at(time_or_duration).utc
+            warn "The specified expiry duration #{time_or_duration} is longer than 50 years. For bug-compatibility " \
+                 "with previous versions of SDK 3.0.x, the number of seconds in the duration will be interpreted as " \
+                 "the epoch second when the document should expire (#{effective_expiry}). Stuffing an epoch second " \
+                 "into a Duration is deprecated and will no longer work in SDK 3.1. Consider using Time instance instead."
+            time_or_duration
+          else
+            ::Time.now.tv_sec + time_or_duration
+          end
+        else
+          time_or_duration
+        end
+      end
+    end
+  end
+end

data/lib/couchbase/version.rb

@@ -33,5 +33,5 @@ module Couchbase
   #    :openssl_headers=>"OpenSSL 1.1.1c FIPS  28 May 2019",
   #    :openssl_runtime=>"OpenSSL 1.1.1c FIPS  28 May 2019"}
   VERSION = {} unless defined?(VERSION) # rubocop:disable Style/MutableConstant
-  VERSION.update(:sdk => "3.0.2".freeze)
+  VERSION.update(:sdk => "3.0.3".freeze)
 end

data/lib/rails/generators/couchbase/config/config_generator.rb

@@ -0,0 +1,27 @@
+#    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.
+
+module Couchbase
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates a Couchbase configuration file at config/couchbase.yml"
+
+      source_root File.expand_path(File.join("..", "templates"), __FILE__)
+
+      def create_config_file
+        template "couchbase.yml", File.join("config", "couchbase.yml")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couchbase
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Sergey Avseyev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies: []
 description: Modern SDK for Couchbase Server
 email:
@@ -59,6 +59,12 @@ files:
 - ext/couchbase/couchbase.cxx
 - ext/couchbase/diagnostics.hxx
 - ext/couchbase/document_id.hxx
+- ext/couchbase/error_context/analytics.hxx
+- ext/couchbase/error_context/http.hxx
+- ext/couchbase/error_context/key_value.hxx
+- ext/couchbase/error_context/query.hxx
+- ext/couchbase/error_context/search.hxx
+- ext/couchbase/error_context/view.hxx
 - ext/couchbase/error_map.hxx
 - ext/couchbase/errors.hxx
 - ext/couchbase/io/dns_client.hxx
@@ -210,6 +216,7 @@ files:
 - ext/couchbase/protocol/cmd_upsert.hxx
 - ext/couchbase/protocol/datatype.hxx
 - ext/couchbase/protocol/durability_level.hxx
+- ext/couchbase/protocol/enhanced_error_info.hxx
 - ext/couchbase/protocol/frame_info_id.hxx
 - ext/couchbase/protocol/hello_feature.hxx
 - ext/couchbase/protocol/magic.hxx
@@ -1321,6 +1328,7 @@ files:
 - ext/third_party/spdlog/src/fmt.cpp
 - ext/third_party/spdlog/src/spdlog.cpp
 - ext/third_party/spdlog/src/stdout_sinks.cpp
+- lib/active_support/cache/couchbase_store.rb
 - lib/couchbase.rb
 - lib/couchbase/analytics_options.rb
 - lib/couchbase/authenticator.rb
@@ -1330,6 +1338,7 @@ files:
 - lib/couchbase/cluster.rb
 - lib/couchbase/collection.rb
 - lib/couchbase/collection_options.rb
+- lib/couchbase/configuration.rb
 - lib/couchbase/datastructures.rb
 - lib/couchbase/datastructures/couchbase_list.rb
 - lib/couchbase/datastructures/couchbase_map.rb
@@ -1339,6 +1348,7 @@ files:
 - lib/couchbase/errors.rb
 - lib/couchbase/json_transcoder.rb
 - lib/couchbase/logger.rb
+- lib/couchbase/management.rb
 - lib/couchbase/management/analytics_index_manager.rb
 - lib/couchbase/management/bucket_manager.rb
 - lib/couchbase/management/collection_manager.rb
@@ -1349,11 +1359,15 @@ files:
 - lib/couchbase/mutation_state.rb
 - lib/couchbase/options.rb
 - lib/couchbase/query_options.rb
+- lib/couchbase/railtie.rb
 - lib/couchbase/scope.rb
 - lib/couchbase/search_options.rb
 - lib/couchbase/subdoc.rb
+- lib/couchbase/utils.rb
+- lib/couchbase/utils/time.rb
 - lib/couchbase/version.rb
 - lib/couchbase/view_options.rb
+- lib/rails/generators/couchbase/config/config_generator.rb
 homepage: https://www.couchbase.com
 licenses:
 - Apache-2.0
@@ -1361,9 +1375,9 @@ metadata:
   homepage_uri: https://docs.couchbase.com/ruby-sdk/3.0/hello-world/start-using-sdk.html
   bug_tracker_uri: https://couchbase.com/issues/browse/RCBC
   mailing_list_uri: https://forums.couchbase.com/c/ruby-sdk
-  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.0.2
-  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.0.2
-  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.0.2/index.html
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.0.3
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.0.3
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.0.3/index.html
   github_repo: ssh://github.com/couchbase/couchbase-ruby-client
 post_install_message: 
 rdoc_options: