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

data/lib/couchbase/management/search_index_manager.rb

@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/errors"
+
 module Couchbase
   module Management
     class SearchIndexManager
@@ -21,6 +23,295 @@ module Couchbase
       def initialize(backend)
         @backend = backend
       end
+
+      # Fetches an index from the server if it exists
+      #
+      # @param [String] index_name name of the index
+      # @param [GetIndexOptions] options
+      #
+      # @return [SearchIndex]
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def get_index(index_name, options = GetIndexOptions.new)
+        # GET /api/index/{name}
+      end
+
+      # Fetches all indexes from the server
+      #
+      # @param [GetAllIndexesOptions] options
+      #
+      # @return [Array<SearchIndex>]
+      def get_all_indexes(options = GetAllIndexesOptions.new)
+        # GET /api/index
+      end
+
+      # Creates or updates the index
+      #
+      # @param [SearchIndex] index_definition the index definition
+      # @param [UpsertIndexOptions] options
+      #
+      # @raise [ArgumentError] if name, type or source_type is empty
+      def upsert_index(index_definition, options = UpsertIndexOptions.new)
+        # PUT /api/index/{index_name} "cache-control: no-cache"
+      end
+
+      # Drops the index
+      #
+      # @param [String] index_name name of the index
+      # @param [DropIndexOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def drop_index(index_name, options = DropIndexOptions.new)
+        # DELETE /api/index/{index_name}
+      end
+
+      # Retrieves the number of documents that have been indexed for an index
+      #
+      # @param [String] index_name name of the index
+      # @param [GetIndexedDocumentsOptions] options
+      #
+      # @return [Integer]
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def get_indexed_documents_count(index_name, options = GetIndexedDocumentsCountOptions.new)
+        # GET /api/index/{index_name}/count
+      end
+
+      # Pauses updates and maintenance for the index
+      #
+      # @param [String] index_name name of the index
+      # @param [PauseIngestOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def pause_ingest(index_name, options = PauseIngestOptions.new)
+        # POST /api/index/{index_name}/ingestControl/pause
+      end
+
+      # Resumes updates and maintenance for an index
+      #
+      # @param [String] index_name name of the index
+      # @param [ResumeIngestOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def resume_ingest(index_name, options = ResumeIngestOptions.new)
+        # POST /api/index/{index_name}/ingestControl/resume
+      end
+
+      # Allows querying against the index
+      #
+      # @param [String] index_name name of the index
+      # @param [AllowQueryingOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def allow_querying(index_name, options = AllowQueryingOptions.new)
+        # POST /api/index/{index_name}/queryControl/allow
+      end
+
+      # Disallows querying against the index
+      #
+      # @param [String] index_name name of the index
+      # @param [DisallowQueryingOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def disallow_querying(index_name, options = DisallowQueryingOptions.new)
+        # POST /api/index/{index_name}/queryControl/disallow
+      end
+
+      # Freeze the assignment of index partitions to nodes
+      #
+      # @param [String] index_name name of the index
+      # @param [FreezePlanOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def freeze_plan(index_name, options = FreezePlanOptions.new)
+        # POST /api/index/{index_name}/planFreezeControl/freeze
+      end
+
+      # Unfreeze the assignment of index partitions to nodes
+      #
+      # @param [String] index_name name of the index
+      # @param [UnfreezePlanOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def unfreeze_plan(index_name, options = UnfreezePlanOptions.new)
+        # POST /api/index/{index_name}/planFreezeControl/unfreeze
+      end
+
+      # Allows to see how a document is analyzed against a specific index
+      #
+      # @param [String] index_name name of the index
+      # @param [Hash] document the document to be analyzed
+      #
+      # @return [Array<Hash>]
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def analyze_document(index_name, document, options = AnalyzeDocumentOptions.new)
+        # POST /api/index/{index_name}/analyzeDoc
+      end
+
+      class GetIndexOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [GetIndexOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class GetAllIndexesOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [GetAllIndexesOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class UpsertIndexOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [UpsertIndexOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class DropIndexOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [DropIndexOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class GetIndexedDocumentsOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [GetIndexedDocumentOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class PauseIngestOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [PauseIngestOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class ResumeIngestOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [ResumeIngestOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class AllowQueryingOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [AllowQueryingOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class DisallowQueryingOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [DisallowQueryingOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class FreezePlanOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [FreezePlanOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class UnfreezePlanOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [UnfreezePlanOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class AnalyzeDocumentOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [AnalyzeDocumentOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+    end
+
+    class SearchIndex
+      # @return [String] name of the index
+      attr_accessor :name
+
+      # @return [String] type of the index
+      attr_accessor :type
+
+      # @return [String] UUID is required for update. It provides means of ensuring consistency.
+      attr_accessor :uuid
+
+      # @return [Hash] index properties such as store type and mappings
+      attr_accessor :params
+
+      # @return [String] name of the source of the data for the index (e.g. bucket name)
+      attr_accessor :source_name
+
+      # @return [String] type of the data source
+      attr_accessor :source_type
+
+      # @return [String] the UUID of the ata source, this can be used to more tightly tie the index to a source
+      attr_accessor :source_uuid
+
+      # @return [Hash] extra parameters for the source. These are usually things like advanced connection and tuning.
+      attr_accessor :source_params
+
+      # @return [Hash] plan properties such a number of replicas and number of partitions
+      attr_accessor :plan_params
+
+      # @yieldparam [SearchIndex] self
+      def initialize
+        yield self if block_given?
+      end
     end
   end
 end

data/lib/couchbase/management/user_manager.rb

@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/errors"
+
 module Couchbase
   module Management
     class UserManager
@@ -29,8 +31,8 @@ module Couchbase
       #
       # @return [UserAndMetadata]
       #
-      # @raise ArgumentError
-      # @raise UserNotFound
+      # @raise [ArgumentError]
+      # @raise [Error::UserNotFound]
       def get_user(user_name, options = GetUserOptions.new)
         # GET /settings/rbac/users/#{options.domain}/#{user_name}
       end
@@ -47,7 +49,7 @@ module Couchbase
       # @param [User] user the new version of the user
       # @param [UpsertUserOptions] options
       #
-      # @raise ArgumentError
+      # @raise [ArgumentError]
       def upsert_user(user, options = UpsertUserOptions.new)
         # PUT /settings/rbac/users/#{options.domain}/#{user_name}
       end
@@ -62,7 +64,7 @@ module Couchbase
 
       # Gets all roles supported by the server
       #
-      # @param [GetRolesOptions]
+      # @param [GetRolesOptions] options
       #
       # @return [Array<RoleAndDescription>]
       def get_roles(options = GetRolesOptions.new)
@@ -75,8 +77,8 @@ module Couchbase
       #
       # @return [Group]
       #
-      # @raise GroupNotFound
-      # @raise ArgumentError
+      # @raise [ArgumentError]
+      # @raise [Error::GroupNotFound]
       def get_group(group_name, options = GetGroupOptions.new)
         # GET /settings/rbac/groups/#{group_name}
       end
@@ -95,8 +97,8 @@ module Couchbase
       # @param [Group] group the new version of the group
       # @param [UpsertGroupOptions] options
       #
-      # @raise GroupNotFound
-      # @raise ArgumentError
+      # @raise [ArgumentError]
+      # @raise [Error::GroupNotFound]
       def upsert_group(group, options = UpsertGroupOptions.new)
         # PUT /settings/rbac/groups/#{group.name}
       end
@@ -106,7 +108,7 @@ module Couchbase
       # @param [String] group_name name of the group
       # @param [DropGroupOptions] options
       #
-      # @raise GroupNotFound
+      # @raise [Error::GroupNotFound]
       def drop_group(group_name, options = DropGroupOptions.new) end
 
       class GetUserOptions
@@ -318,4 +320,4 @@ module Couchbase
       end
     end
   end
-end
+end

data/lib/couchbase/management/view_index_manager.rb

@@ -12,8 +12,25 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "couchbase/errors"
+
 module Couchbase
   module Management
+    # The View Index Manager interface contains the means for managing design documents used for views.
+    #
+    # A design document belongs to either the "development" or "production" namespace. A development document has a name
+    # that starts with "dev_". This is an implementation detail we've chosen to hide from consumers of this API.
+    # Document names presented to the user (returned from the "get" and "get all" methods, for example) always have the
+    # "dev_" prefix stripped.
+    #
+    # Whenever the user passes a design document name to any method of this API, the user may refer to the document
+    # using the "dev_" prefix regardless of whether the user is referring to a development document or production
+    # document. The "dev_" prefix is always stripped from user input, and the actual document name passed to the server
+    # is determined by the "namespace" argument.
+    #
+    # All methods (except publish) have a required "namespace" argument indicating whether the operation targets a
+    # development document or a production document. The type of this argument is [Symbol] with allowed values
+    # +:production+ and +:development+.
     class ViewIndexManager
       alias_method :inspect, :to_s
 
@@ -23,6 +40,139 @@ module Couchbase
         @backend = backend
         @bucket_name = bucket_name
       end
+
+      # Fetches a design document from the server
+      #
+      # @param [String] name the name of the design document
+      # @param [:production, :development] namespace the namespace
+      # @param [GetDesignDocumentOptions] options
+      #
+      # @return [DesignDocument]
+      #
+      # @raise [Error::DesignDocumentNotFound]
+      def get_design_document(name, namespace, options = GetDesignDocumentOptions.new)
+        # GET /{bucket_name}/_design/{namespace}_{name}
+      end
+
+      # Fetches all design documents from the server
+      #
+      # @param [:production, :development] namespace the namespace
+      # @param [GetAllDesignDocumentsOptions] options
+      #
+      # @return [Array<DesignDocument>]
+      def get_all_design_documents(namespace, options = GetAllDesignDocumentsOptions.new)
+        # GET /pools/default/buckets/{bucket_name}/ddocs
+      end
+
+      # Updates or inserts the design document
+      #
+      # @param [DesignDocument] document
+      # @param [:production, :development] namespace the namespace
+      # @param [UpsertDesignDocumentOptions] options
+      def upsert_design_document(document, namespace, options = UpsertDesignDocumentOptions.new)
+        # PUT /{bucket_name}/_design/{namespace}_{name}
+      end
+
+      # Removes the design document
+      #
+      # @param [String] name design document name
+      # @param [:production, :development] namespace the namespace
+      # @param [DropDesignDocumentOptions] options
+      #
+      # @raise [Error::DesignDocumentNotFound]
+      def drop_design_document(name, namespace, options = DropDesignDocumentOptions.new)
+        # DELETE /{bucket_name}/_design/{namespace}_{name}
+      end
+
+      # Publishes the design document.
+      #
+      # This method is equivalent to getting a document from the development namespace and upserting
+      # it to the production namespace.
+      #
+      # @param [String] name design document name
+      # @param [PublishDesignDocumentOptions] options
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::DesignDocumentNotFound]
+      def publish_design_document(name, options = PublishDesignDocumentOptions.new)
+      end
+
+      class GetDesignDocumentOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [GetDesignDocumentOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class GetAllDesignDocumentsOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [GetAllDesignDocumentsOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class UpsertDesignDocumentOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [UpsertDesignDocumentOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class DropDesignDocumentOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [DropDesignDocumentOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class PublishDesignDocumentOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [PublishDesignDocumentOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+    end
+
+    class View
+      # @return [String] map function in javascript
+      attr_accessor :map
+
+      # @return [String] reduce function in javascript
+      attr_accessor :reduce
+
+      # @yieldparam [View] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class DesignDocument
+      # @return [String] name
+      attr_accessor :name
+
+      # @return [Hash<String, View>]
+      attr_accessor :views
+
+      # @yieldparam [DesignDocument] self
+      def initialize
+        yield self if block_given?
+      end
     end
   end
-end
+end