couchbase 3.0.0.alpha.3 → 3.0.0.alpha.4

data/lib/couchbase/management/analytics_index_manager.rb

@@ -29,18 +29,34 @@ module Couchbase
       # @param [String] dataverse_name
       # @param [CreateDataverseOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::DataverseExists]
-      def create_dataverse(dataverse_name, options = CreateDataverseOptions.new) end
+      def create_dataverse(dataverse_name, options = CreateDataverseOptions.new)
+        @backend.analytics_dataverse_create(
+            dataverse_name,
+            options.ignore_if_exists,
+            options.timeout
+        )
+      end
 
       # Drops a dataverse
       #
       # @param [String] dataverse_name name of the dataverse
       # @param [DropDataverseOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::DataverseNotFound]
-      def drop_dataverse(dataverse_name, options = DropDataverseOptions.new) end
+      def drop_dataverse(dataverse_name, options = DropDataverseOptions.new)
+        @backend.analytics_dataverse_drop(
+            dataverse_name,
+            options.ignore_if_does_not_exist,
+            options.timeout
+        )
+      end
 
       # Creates a new dataset
       #
@@ -48,18 +64,39 @@ module Couchbase
       # @param [String] bucket_name name of the bucket
       # @param [CreateDatasetOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::DatasetExists]
-      def create_dataset(dataset_name, bucket_name, options = CreateDatasetOptions.new) end
+      # @raise [Error::LinkNotFound]
+      def create_dataset(dataset_name, bucket_name, options = CreateDatasetOptions.new)
+        @backend.analytics_dataset_create(
+            dataset_name,
+            bucket_name,
+            options.condition,
+            options.dataverse_name,
+            options.ignore_if_exists,
+            options.timeout
+        )
+      end
 
       # Drops a dataset
       #
       # @param [String] dataset_name name of the dataset
-      # @param [DropDataverseOptions] options
-      # 
+      # @param [DropDatasetOptions] options
+      #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::DatasetNotFound]
-      def drop_dataset(dataset_name, options = DropDatasetOptions.new) end
+      def drop_dataset(dataset_name, options = DropDatasetOptions.new)
+        @backend.analytics_dataset_drop(
+            dataset_name,
+            options.dataverse_name,
+            options.ignore_if_does_not_exist,
+            options.timeout
+        )
+      end
 
       # Gets all datasets
       #
@@ -67,19 +104,38 @@ module Couchbase
       #
       # @return [Array<AnalyticsDataset>]
       def get_all_datasets(options = GetAllDatasetsOptions.new)
-        # SELECT d.* FROM Metadata.`Dataset` d WHERE d.DataverseName <> "Metadata"
+        resp = @backend.analytics_dataset_get_all(options.timeout)
+        resp.map do |entry|
+          AnalyticsDataset.new do |dataset|
+            dataset.name = entry[:name]
+            dataset.dataverse_name = entry[:dataverse_name]
+            dataset.link_name = entry[:link_name]
+            dataset.bucket_name = entry[:bucket_name]
+          end
+        end
       end
 
       # Creates a new index
       #
       # @param [String] index_name name of the index
       # @param [String] dataset_name name of the dataset
-      # @param [Hash<String, String>] fields mapping of the field name to field type
+      # @param [Hash<String => String>] fields mapping of the field name to field type
       # @param [CreateIndexOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexExists]
-      def create_index(index_name, dataset_name, fields, options = CreateIndexOptions.new) end
+      def create_index(index_name, dataset_name, fields, options = CreateIndexOptions.new)
+        @backend.analytics_index_create(
+            index_name,
+            dataset_name,
+            fields.entries,
+            options.dataverse_name,
+            options.ignore_if_exists,
+            options.timeout
+        )
+      end
 
       # Drops an index
       #
@@ -87,9 +143,19 @@ module Couchbase
       # @param [String] dataset_name name of the dataset
       # @param [DropIndexOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
-      def drop_index(index_name, dataset_name, options = DropIndexOptions.new) end
+      def drop_index(index_name, dataset_name, options = DropIndexOptions.new)
+        @backend.analytics_index_drop(
+            index_name,
+            dataset_name,
+            options.dataverse_name,
+            options.ignore_if_does_not_exist,
+            options.timeout
+        )
+      end
 
       # Gets all indexes
       #
@@ -97,36 +163,63 @@ module Couchbase
       #
       # @return [Array<AnalyticsIndex>]
       def get_all_indexes(options = GetAllIndexesOptions.new)
-        # SELECT d.* FROM Metadata.`Index` d WHERE d.DataverseName <> "Metadata"
+        resp = @backend.analytics_index_get_all(options.timeout)
+        resp.map do |entry|
+          AnalyticsIndex.new do |dataset|
+            dataset.name = entry[:name]
+            dataset.dataverse_name = entry[:dataverse_name]
+            dataset.dataset_name = entry[:dataset_name]
+            dataset.is_primary = entry[:is_primary]
+          end
+        end
       end
 
       # Connects a link
       #
       # @param [ConnectLinkOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::LinkNotFound]
-      def connect_link(options = ConnectLinkOptions.new) end
+      def connect_link(options = ConnectLinkOptions.new)
+        @backend.analytics_link_connect(
+            options.link_name,
+            options.force,
+            options.dataverse_name,
+            options.timeout
+        )
+      end
 
       # Disconnects a link,
       #
       # @param [DisconnectLinkOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::LinkNotFound]
-      def disconnect_link(options = DisconnectLinkOptions.new) end
+      def disconnect_link(options = DisconnectLinkOptions.new)
+        @backend.analytics_link_disconnect(
+            options.link_name,
+            options.dataverse_name,
+            options.timeout
+        )
+      end
 
       # Gets the pending mutations for all datasets.
-      # 
+      #
       # @note If a link is disconnected then it will return no results. If all links are disconnected, then
       # an empty object is returned.
       #
       # @param [GetPendingMutationsOptions] options
       #
-      # @return [Hash<String, Integer>] dictionary, where keys are dataset coordinates encoded as +"dataverse.dataset"+
+      # @return [Hash<String => Integer>] dictionary, where keys are dataset coordinates encoded as +"dataverse.dataset"+
       #   and values are number of mutations for given dataset.
       def get_pending_mutations(options = GetPendingMutationsOptions.new)
-        # GET http://localhost:8095/analytics/node/agg/stats/remaining
+        @backend.analytics_get_pending_mutations(
+            options.timeout
+        )
       end
 
       class CreateDataverseOptions
@@ -136,6 +229,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [CreateDataverseOptions]
         def initialize
           @ignore_if_exists = false
           yield self if block_given?
@@ -144,11 +238,12 @@ module Couchbase
 
       class DropDataverseOptions
         # @return [Boolean] ignore if the dataverse does not exists
-        attr_accessor :ignore_if_not_exists
+        attr_accessor :ignore_if_does_not_exist
 
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DropDataverseOptions]
         def initialize
           @ignore_if_exists = false
           yield self if block_given?
@@ -168,6 +263,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [CreateDatasetOptions]
         def initialize
           @ignore_if_exists = false
           yield self if block_given?
@@ -176,7 +272,7 @@ module Couchbase
 
       class DropDatasetOptions
         # @return [Boolean] ignore if the dataset does not exists
-        attr_accessor :ignore_if_not_exists
+        attr_accessor :ignore_if_does_not_exist
 
         # @return [String] The name of the dataverse to use (defaults to +nil+)
         attr_accessor :dataverse_name
@@ -184,8 +280,9 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DropDatasetOptions]
         def initialize
-          @ignore_if_not_exists = false
+          @ignore_if_does_not_exist = false
           yield self if block_given?
         end
       end
@@ -194,8 +291,8 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetAllDatasetsOptions]
         def initialize
-          @ignore_if_not_exists = false
           yield self if block_given?
         end
       end
@@ -210,6 +307,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [CreateIndexOptions]
         def initialize
           @ignore_if_exists = false
           yield self if block_given?
@@ -218,7 +316,7 @@ module Couchbase
 
       class DropIndexOptions
         # @return [Boolean] ignore if the index does not exists
-        attr_accessor :ignore_if_not_exists
+        attr_accessor :ignore_if_does_not_exist
 
         # @return [String] The name of the dataverse to use (defaults to +nil+)
         attr_accessor :dataverse_name
@@ -226,8 +324,9 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DropIndexOptions]
         def initialize
-          @ignore_if_not_exists = false
+          @ignore_if_does_not_exist = false
           yield self if block_given?
         end
       end
@@ -236,6 +335,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetAllIndexesOptions]
         def initialize
           yield self if block_given?
         end
@@ -246,7 +346,7 @@ module Couchbase
         attr_accessor :link_name
 
         # @return [Boolean] Whether to force link creation even if the bucket UUID changed, for example due to the
-        # bucket being deleted and recreated (defaults to +false+)
+        #  bucket being deleted and recreated (defaults to +false+)
         attr_accessor :force
 
         # @return [String] The name of the dataverse to use (defaults to +nil+)
@@ -255,6 +355,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [ConnectLinkOptions]
         def initialize
           @link_name = "Local"
           @force = false
@@ -272,6 +373,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DisconnectLinkOptions]
         def initialize
           @link_name = "Local"
           yield self if block_given?
@@ -282,6 +384,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetPendingMutationsOptions]
         def initialize
           yield self if block_given?
         end
@@ -300,6 +403,11 @@ module Couchbase
 
       # @return [String]
       attr_accessor :bucket_name
+
+      # @yieldparam [AnalyticsDataset]
+      def initialize
+        yield self if block_given?
+      end
     end
 
     class AnalyticsIndex
@@ -314,6 +422,12 @@ module Couchbase
 
       # @return [Boolean]
       attr_accessor :is_primary
+      alias_method :primary?, :is_primary
+
+      # @yieldparam [AnalyticsIndex]
+      def initialize
+        yield self if block_given?
+      end
     end
   end
-end
+end

data/lib/couchbase/management/view_index_manager.rb

@@ -34,6 +34,9 @@ module Couchbase
     class ViewIndexManager
       alias_method :inspect, :to_s
 
+      # @return [String] name of the bucket
+      attr_accessor :bucket_name
+
       # @param [Couchbase::Backend] backend
       # @param [String] bucket_name
       def initialize(backend, bucket_name)
@@ -51,7 +54,8 @@ module Couchbase
       #
       # @raise [Error::DesignDocumentNotFound]
       def get_design_document(name, namespace, options = GetDesignDocumentOptions.new)
-        # GET /{bucket_name}/_design/{namespace}_{name}
+        resp = @backend.view_index_get(@bucket_name, name, namespace, options.timeout)
+        extract_design_document(resp)
       end
 
       # Fetches all design documents from the server
@@ -61,7 +65,10 @@ module Couchbase
       #
       # @return [Array<DesignDocument>]
       def get_all_design_documents(namespace, options = GetAllDesignDocumentsOptions.new)
-        # GET /pools/default/buckets/{bucket_name}/ddocs
+        resp = @backend.view_index_get_all(@bucket_name, namespace, options.timeout)
+        resp.map do |entry|
+          extract_design_document(entry)
+        end
       end
 
       # Updates or inserts the design document
@@ -69,8 +76,13 @@ module Couchbase
       # @param [DesignDocument] document
       # @param [:production, :development] namespace the namespace
       # @param [UpsertDesignDocumentOptions] options
+      #
+      # @return [void]
       def upsert_design_document(document, namespace, options = UpsertDesignDocumentOptions.new)
-        # PUT /{bucket_name}/_design/{namespace}_{name}
+        @backend.view_index_upsert(@bucket_name, {
+            name: document.name,
+            views: document.views.map { |name, view| {name: name, map: view.map_function, reduce: view.reduce_function} }
+        }, namespace, options.timeout)
       end
 
       # Removes the design document
@@ -79,9 +91,11 @@ module Couchbase
       # @param [:production, :development] namespace the namespace
       # @param [DropDesignDocumentOptions] options
       #
+      # @return [void]
+      #
       # @raise [Error::DesignDocumentNotFound]
       def drop_design_document(name, namespace, options = DropDesignDocumentOptions.new)
-        # DELETE /{bucket_name}/_design/{namespace}_{name}
+        @backend.view_index_drop(@bucket_name, name, namespace, options.timeout)
       end
 
       # Publishes the design document.
@@ -92,9 +106,13 @@ module Couchbase
       # @param [String] name design document name
       # @param [PublishDesignDocumentOptions] options
       #
+      # @return [void]
+      #
       # @raise [ArgumentError]
       # @raise [Error::DesignDocumentNotFound]
       def publish_design_document(name, options = PublishDesignDocumentOptions.new)
+        document = get_design_document(name, :development, GetDesignDocumentOptions.new { |o| o.timeout = options.timeout })
+        upsert_design_document(document, :production, UpsertDesignDocumentOptions.new { |o| o.timeout = options.timeout })
       end
 
       class GetDesignDocumentOptions
@@ -147,17 +165,48 @@ module Couchbase
         end
       end
 
+      private
+
+      def extract_design_document(resp)
+        DesignDocument.new do |design_document|
+          design_document.name = resp[:name]
+          design_document.namespace = resp[:namespace]
+          resp[:views].each do |name, view_resp|
+            design_document.views[name] = View.new(view_resp[:map], view_resp[:reduce])
+          end
+        end
+      end
     end
 
     class View
-      # @return [String] map function in javascript
-      attr_accessor :map
+      # @return [String] name of the view
+      attr_accessor :view
 
-      # @return [String] reduce function in javascript
-      attr_accessor :reduce
+      # @return [String] map function in javascript as String
+      attr_accessor :map_function
+      alias_method :map, :map_function
 
+      # @return [String] reduce function in javascript as String
+      attr_accessor :reduce_function
+      alias_method :reduce, :reduce_function
+
+      # @return [Boolean] true if map function is defined
+      def has_map?
+        !@map_function.nil?
+      end
+
+      # @return [Boolean] true if map function is defined
+      def has_reduce?
+        !@reduce_function.nil?
+      end
+
+      # @param [String] map
+      # @param [String] reduce
+      #
       # @yieldparam [View] self
-      def initialize
+      def initialize(map = nil, reduce = nil)
+        @map_function = map
+        @reduce_function = reduce
         yield self if block_given?
       end
     end
@@ -166,11 +215,15 @@ module Couchbase
       # @return [String] name
       attr_accessor :name
 
-      # @return [Hash<String, View>]
+      # @return [Hash<String => View>]
       attr_accessor :views
 
+      # @return [:production, :development]
+      attr_accessor :namespace
+
       # @yieldparam [DesignDocument] self
       def initialize
+        @views = {}
         yield self if block_given?
       end
     end