mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/{functional.rb → operation/read.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# Copyright (C) 2014-2015 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/functional/authentication'
-require 'mongo/functional/logging'
-require 'mongo/functional/read_preference'
-require 'mongo/functional/write_concern'
-require 'mongo/functional/uri_parser'
-require 'mongo/functional/scram'
+require 'mongo/operation/read/query'
+require 'mongo/operation/read/get_more'
+require 'mongo/operation/read/indexes'
+require 'mongo/operation/read/list_indexes'
+require 'mongo/operation/read/list_collections'
+require 'mongo/operation/read/collections_info'

data/lib/mongo/operation/read/collections_info.rb

@@ -0,0 +1,67 @@
+# Copyright (C) 2014-2015 MongoDB, 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 Mongo
+  module Operation
+    module Read
+
+      # A MongoDB operation to get a list of collection names in a database.
+      #
+      # @example Create the collection names operation.
+      #   Read::CollectionNames.new(:db_name => 'test-db')
+      #
+      # @param [ Hash ] spec The specifications for the collection names operation.
+      #
+      # @option spec :db_name [ String ] The name of the database whose collection
+      #   names is requested.
+      # @option spec :options [ Hash ] Options for the operation.
+      #
+      # @since 2.0.0
+      class CollectionsInfo
+        include Executable
+        include Specifiable
+        include ReadPreferrable
+
+        # Execute the operation.
+        # The context gets a connection on which the operation
+        # is sent in the block.
+        #
+        # @params [ Mongo::Server::Context ] The context for this operation.
+        #
+        # @return [ Result ] The operation response, if there is one.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.list_collections_enabled?
+            ListCollections.new(spec).execute(context)
+          else
+            context.with_connection do |connection|
+              Result.new(connection.dispatch([ message(context) ])).validate!
+            end
+          end
+        end
+
+        private
+
+        def selector
+          { :name => { '$not' => /system\.|\$/ } }
+        end
+
+        def query_coll
+          Database::NAMESPACES
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/read/get_more.rb

@@ -0,0 +1,71 @@
+# Copyright (C) 2014-2015 MongoDB, 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 Mongo
+  module Operation
+    module Read
+
+      # A MongoDB get more operation.
+      #
+      # @example Create a get more operation.
+      #   Read::GetMore.new({
+      #     :to_return => 50,
+      #     :cursor_id => 1,
+      #     :db_name   => 'test_db',
+      #     :coll_name => 'test_coll'
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the operation.
+      #
+      # @option spec :to_return [ Integer ] The number of results to return.
+      # @option spec :cursor_id [ Integer ] The id of the cursor.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the operation should be executed.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the operation should be executed.
+      #
+      # @since 2.0.0
+      class GetMore
+        include Executable
+        include Specifiable
+
+        # Execute the get more operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @params [ Mongo::Server::Context ] The context for this operation.
+        #
+        # @return [ Result ] The operation response, if there is one.
+        #
+        # @since 2.0.0
+        def execute(context)
+          execute_message(context)
+        end
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message ]))
+          end
+        end
+
+        def message
+          Protocol::GetMore.new(db_name, coll_name, to_return, cursor_id)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/read/indexes.rb

@@ -0,0 +1,68 @@
+# Copyright (C) 2014-2015 MongoDB, 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 Mongo
+  module Operation
+    module Read
+
+      # A MongoDB get indexes operation.
+      #
+      # Initialize the get indexes operation.
+      #
+      # @example Instantiate the operation.
+      #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
+      #
+      # @param [ Hash ] spec The specifications for the insert.
+      #
+      # @option spec :db_name [ String ] The name of the database.
+      # @option spec :coll_name [ String ] The name of the collection.
+      #
+      # @since 2.0.0
+      class Indexes
+        include Executable
+        include Specifiable
+        include ReadPreferrable
+
+        # Execute the operation.
+        # The context gets a connection on which the operation
+        # is sent in the block.
+        #
+        # @params [ Mongo::Server::Context ] The context for this operation.
+        #
+        # @return [ Result ] The indexes operation response.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.list_indexes_enabled?
+            ListIndexes.new(spec).execute(context)
+          else
+            context.with_connection do |connection|
+              Result.new(connection.dispatch([ message(context) ]))
+            end
+          end
+        end
+
+        private
+
+        def selector
+          { ns: namespace }
+        end
+
+        def query_coll
+          Index::COLLECTION
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/read/list_collections.rb

@@ -0,0 +1,75 @@
+# Copyright (C) 2014-2015 MongoDB, 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 'mongo/operation/list_collections/result'
+
+module Mongo
+  module Operation
+    module Read
+
+      # A MongoDB listCollections command operation.
+      #
+      # @example Create the listCollections command operation.
+      #   Mongo::Operation::Read::ListCollections.new(db_name: 'test')
+      #
+      # @note A command is actually a query on the virtual '$cmd' collection.
+      #
+      # @param [ Hash ] spec The specifications for the command.
+      #
+      # @option spec :db_name [ String ] The name of the database whose list of
+      #   collection names is requested.
+      # @option spec :options [ Hash ] Options for the command.
+      #
+      # @since 2.0.0
+      class ListCollections
+        include Executable
+        include Specifiable
+        include Limited
+        include ReadPreferrable
+
+        # Execute the listCollections command operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @params [ Mongo::Server::Context ] The context for this operation.
+        #
+        # @return [ Result ] The operation result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          execute_message(context)
+        end
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ])).validate!
+          end
+        end
+
+        def query_coll
+          Database::COMMAND
+        end
+
+        def selector
+          (spec[SELECTOR] || {}).merge(
+            listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/read/list_indexes.rb

@@ -0,0 +1,77 @@
+# Copyright (C) 2014-2015 MongoDB, 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 'mongo/operation/list_indexes/result'
+
+module Mongo
+  module Operation
+    module Read
+
+      # A MongoDB listIndexes command operation.
+      #
+      # @example Create the listIndexes command operation.
+      #   Mongo::Operation::Read::ListIndexes.new({ db_name: 'test', coll_name: 'example' })
+      #
+      # @note A command is actually a query on the virtual '$cmd' collection.
+      #
+      # @param [ Hash ] spec The specifications for the command.
+      #
+      # @option spec :coll_name [ Hash ] The name of the collection whose index
+      #   info is requested.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the command should be executed.
+      # @option spec :options [ Hash ] Options for the command.
+      #
+      # @since 2.0.0
+      class ListIndexes
+        include Executable
+        include Specifiable
+        include Limited
+        include ReadPreferrable
+
+        # Execute the listIndexes command operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @params [ Mongo::Server::Context ] The context for this operation.
+        #
+        # @return [ Result ] The operation result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          execute_message(context)
+        end
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ])).validate!
+          end
+        end
+
+        def query_coll
+          Database::COMMAND
+        end
+
+        def selector
+          (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
+        end
+      end
+    end
+  end
+end
+
+

data/lib/mongo/operation/read/query.rb

@@ -0,0 +1,71 @@
+# Copyright (C) 2014-2015 MongoDB, 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 Mongo
+  module Operation
+    module Read
+
+      # A MongoDB query operation.
+      #
+      # @example Create the query operation.
+      #   Read::Query.new({
+      #     :selector => { :foo => 1 },
+      #     :db_name => 'test-db',
+      #     :coll_name => 'test-coll',
+      #     :options => { :limit => 2 }
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the query.
+      #
+      # @option spec :selector [ Hash ] The query selector.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the query should be run.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the query should be run.
+      # @option spec :options [ Hash ] Options for the query.
+      #
+      # @since 2.0.0
+      class Query
+        include Executable
+        include Specifiable
+        include ReadPreferrable
+
+        # Execute the operation.
+        # The context gets a connection on which the operation
+        # is sent in the block.
+        #
+        # @params [ Mongo::Server::Context ] The context for this operation.
+        #
+        # @return [ Result ] The operation response, if there is one.
+        #
+        # @since 2.0.0
+        def execute(context)
+          execute_message(context)
+        end
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ]))
+          end
+        end
+
+        def query_coll
+          coll_name
+        end
+      end
+    end
+  end
+end