moped 1.5.3 → 2.0.0.beta

data/lib/moped/operation.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require "moped/operation/read"
+require "moped/operation/write"

data/lib/moped/operation/read.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+module Moped
+  module Operation
+
+    # Represents a read from the database that is executed on a specific node
+    # determined by a read preference.
+    #
+    # @since 2.0.0
+    class Read
+
+      # @!attribute database
+      #   @return [ String ] The database the read is from.
+      # @!attribute operation
+      #   @return [ Protocol::Query, Protocol::GetMore, Protocol::Command ]
+      #     The read operation.
+      attr_reader :database, :operation
+
+      # Instantiate the read operation.
+      #
+      # @example Instantiate the read.
+      #   Read.new(get_more)
+      #
+      # @param [ Protocol::Query, Protocol::GetMore, Protocol::Command ] operation
+      #   The read operation.
+      #
+      # @since 2.0.0
+      def initialize(operation)
+        @operation = operation
+        @database = operation.database
+      end
+
+      # Execute the read operation on the provided node. If the query failed, we
+      # will check if the failure was due to authorization and attempt the
+      # operation again. This could sometimes happen in the case of a step down
+      # or reconfiguration on the server side.
+      #
+      # @example Execute the operation.
+      #   read.execute(node)
+      #
+      # @param [ Node ] node The node to execute the read on.
+      #
+      # @raise [ Failure ] If the read operation failed.
+      #
+      # @return [ Protocol::Reply ] The reply from the database.
+      #
+      # @since 2.0.0
+      def execute(node)
+        node.process(operation) do |reply|
+          if operation.failure?(reply)
+            if reply.unauthorized? && node.credentials.has_key?(database)
+              node.login(database, *node.credentials[database])
+              return execute(node)
+            else
+              raise operation.failure_exception(reply)
+            end
+          end
+          operation.results(reply)
+        end
+      end
+    end
+  end
+end

data/lib/moped/operation/write.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+module Moped
+  module Operation
+
+    # Encapsulates behaviour for write operations.
+    #
+    # @since 2.0.0
+    class Write
+
+      # @!attribute concern
+      #   @return [ Object ] The configured write concern.
+      # @!attribute database
+      #   @return [ String ] The database the read is from.
+      # @!attribute operation
+      #   @return [ Protocol::Insert, Protocol::Update, Protocol::Delete ]
+      #     The write operation.
+      attr_reader :concern, :database, :operation
+
+      # Instantiate the write operation.
+      #
+      # @example Instantiate the write.
+      #   Write.new(insert)
+      #
+      # @param [ Protocol::Insert, Protocol::Update, Protocol::Delete ] operation
+      #   The write operation.
+      #
+      # @since 2.0.0
+      def initialize(operation, concern)
+        @operation = operation
+        @database = operation.database
+        @concern = concern
+      end
+
+      # Execute the write operation on the provided node. If the write concern
+      # is propagating, then the gle command will be piggybacked onto the
+      # initial write operation.
+      #
+      # @example Execute the operation.
+      #   write.execute(node)
+      #
+      # @param [ Node ] node The node to execute the write on.
+      #
+      # @since 2.0.0
+      def execute(node)
+        propagate = concern.operation
+        if propagate
+          node.pipeline do
+            node.process(operation)
+            node.command(database, propagate)
+          end
+        else
+          node.process(operation)
+        end
+      end
+    end
+  end
+end

data/lib/moped/protocol/command.rb

@@ -7,19 +7,80 @@ module Moped
     # @example
     #   command = Moped::Protocol::Command.new :moped, ismaster: 1
     #   socket.write command.serialize
+    #
+    # @since 1.0.0
     class Command < Query
 
-      # @param [String, Symbol] database the database to run this command on
-      # @param [Hash] command the command to run
-      # @param [Hash] additional query options
+      # Determine if the provided reply message is a failure with respect to a
+      # command.
+      #
+      # @example Is the reply a command failure?
+      #   command.failure?(reply)
+      #
+      # @param [ Reply ] reply The reply to the command.
+      #
+      # @return [ true, false ] If the reply is a failure.
+      #
+      # @since 2.0.0
+      def failure?(reply)
+        reply.command_failure?
+      end
+
+      # Get the exception specific to a failure of this particular operation.
+      #
+      # @example Get the failure exception.
+      #   command.failure_exception(document)
+      #
+      # @param [ Moped::Protocol::Reply ] reply The reply from the database.
+      #
+      # @return [ Moped::Errors::OperationFailure ] The failure exception.
+      #
+      # @since 2.0.0
+      def failure_exception(reply)
+        Errors::OperationFailure.new(self, reply.documents.first)
+      end
+
+      # Instantiate the new command.
+      #
+      # @example Instantiate the new command.
+      #   Moped::Protocol::Command.new(:moped_test, ismaster: 1)
+      #
+      # @param [ String, Symbol ] database The database to run the command on.
+      # @param [ Hash ] command The command to run.
+      # @param [ Hash ] options And additional query options.
+      #
+      # @since 1.0.0
       def initialize(database, command, options = {})
-        super database, '$cmd', command, options.merge(limit: -1)
+        super(database, '$cmd', command, options.merge(limit: -1))
       end
 
+      # Provide the value that will be logged when the command runs.
+      #
+      # @example Provide the log inspection.
+      #   command.log_inspect
+      #
+      # @return [ String ] The string value for logging.
+      #
+      # @since 1.0.0
       def log_inspect
         type = "COMMAND"
         "%-12s database=%s command=%s" % [type, database, selector.inspect]
       end
+
+      # Take the provided reply and return the expected results to api
+      # consumers. In the case of the command it's the first document.
+      #
+      # @example Get the expected results of the reply.
+      #   command.results(reply)
+      #
+      # @param [ Moped::Protocol::Reply ] reply The reply from the database.
+      #
+      # @return [ Hash ] The first document in the reply.
+      #
+      # @since 2.0.0
+      def results(reply)
+        reply.documents.first
+      end
     end
   end
 end

data/lib/moped/protocol/commands/authenticate.rb

@@ -22,7 +22,7 @@ module Moped
         # @param [String] nonce the nonce returned from running the getnonce
         # command.
         def initialize(database, username, password, nonce)
-          super database, build_auth_command(username, password, nonce)
+          super(database, build_auth_command(username, password, nonce))
         end
 
         # @param [String] username
@@ -47,7 +47,6 @@ module Moped
             key: digest(username, password, nonce)
           }
         end
-
       end
     end
   end

data/lib/moped/protocol/delete.rb

@@ -90,6 +90,22 @@ module Moped
         "%-12s database=%s collection=%s selector=%s flags=%s" % [type, database, collection, selector.inspect, flags.inspect]
       end
 
+      private
+
+      # Duplicate the attributes in the delete that need to be.
+      #
+      # @api private
+      #
+      # @example Clone the delete.
+      #   delete.clone
+      #
+      # @param [ Delete ] The delete that was cloned from.
+      #
+      # @since 2.0.0
+      def initialize_copy(_)
+        @selector = selector.dup
+        @flags = flags.dup
+      end
     end
   end
 end

data/lib/moped/protocol/get_more.rb

@@ -3,15 +3,7 @@ module Moped
 
     # The Protocol class for retrieving more documents from a cursor.
     #
-    # @example Get more results using database default limit
-    #   insert = GetMore.new "moped", "people", 29301021, 0
-    #
-    # @example Get more results using custom limit
-    #   insert = Insert.new "moped", "people", 29301021, 10
-    #
-    # @example Setting the request id
-    #   insert = Insert.new "moped", "people", 29301021, 10,
-    #     request_id: 123
+    # @since 1.0.0
     class GetMore
       include Message
 
@@ -29,54 +21,118 @@ module Moped
       # @return [Number] the operation code of this message
       int32 :op_code
 
-      int32    :reserved # reserved for future use
+      int32 :reserved # reserved for future use
 
       # @attribute
       # @return [String] the namespaced collection name
-      cstring  :full_collection_name
+      cstring :full_collection_name
 
       # @attribute
       # @return [Number] the number of documents to return
-      int32    :limit
+      int32 :limit
 
       # @attribute
       # @return [Number] the id of the cursor to get more documents from
-      int64    :cursor_id
+      int64 :cursor_id
 
       finalize
 
-      undef op_code
-      # @return [Number] OP_GETMORE operation code (2005)
-      def op_code
-        2005
-      end
+      # @!attribute collection
+      #   @return [ String ] The collection to query.
+      # @!attribute database
+      #   @return [ String ] The database to query
+      attr_reader :collection, :database
 
-      # @return [String, Symbol] the database this insert targets
-      attr_reader :database
+      # Determine if the provided reply message is a failure with respect to a
+      # get more operation.
+      #
+      # @example Is the reply a query failure?
+      #   get_more.failure?(reply)
+      #
+      # @param [ Reply ] reply The reply to the get more.
+      #
+      # @return [ true, false ] If the reply is a failure.
+      #
+      # @since 2.0.0
+      def failure?(reply)
+        reply.cursor_not_found? || reply.query_failure?
+      end
 
-      # @return [String, Symbol] the collection this insert targets
-      attr_reader :collection
+      # Get the exception specific to a failure of this particular operation.
+      #
+      # @example Get the failure exception.
+      #   get_more.failure_exception(document)
+      #
+      # @param [ Moped::Protocol::Reply ] reply The reply from the database.
+      #
+      # @return [ Moped::Errors::CursorNotFound ] The failure exception.
+      #
+      # @since 2.0.0
+      def failure_exception(reply)
+        if reply.cursor_not_found?
+          Errors::CursorNotFound.new(self, cursor_id)
+        else
+          Errors::QueryFailure.new(self, reply.documents.first)
+        end
+      end
 
-      # Create a new +GetMore+ command. The +database+ and +collection+ arguments
-      # are joined together to set the +full_collection_name+.
+      # Create a new GetMore command. The database and collection arguments
+      # are joined together to set the full_collection_name.
+      #
+      # @example Get more results using database default limit.
+      #   GetMore.new("moped", "people", 29301021, 0)
       #
-      # @example
-      #   GetMore.new "moped", "users", 29301021, 10, request_id: 123
+      # @example Get more results using custom limit.
+      #   GetMore.new("moped", "people", 29301021, 10)
+      #
+      # @example Get more with a request id.
+      #   GetMore.new("moped", "people", 29301021, 10, request_id: 123)
+      #
+      # @param [ String ] database The database name.
+      # @param [ String ] collection The collection name.
+      # @param [ Integer ] cursor_id The id of the cursor.
+      # @param [ Integer ] limit The number of documents to limit.
+      # @param [ Hash ] options The get more options.
+      #
+      # @option options [ Integer ] :request_id The operation's request id.
+      #
+      # @since 1.0.0
       def initialize(database, collection, cursor_id, limit, options = {})
-        @database   = database
+        @database = database
         @collection = collection
-
         @full_collection_name = "#{database}.#{collection}"
-        @cursor_id            = cursor_id
-        @limit                = limit
-        @request_id           = options[:request_id]
+        @cursor_id = cursor_id
+        @limit = limit
+        @request_id = options[:request_id]
       end
 
+      # Provide the value that will be logged when the get more runs.
+      #
+      # @example Provide the log inspection.
+      #   get_more.log_inspect
+      #
+      # @return [ String ] The string value for logging.
+      #
+      # @since 1.0.0
       def log_inspect
         type = "GET_MORE"
         "%-12s database=%s collection=%s limit=%s cursor_id=%s" % [type, database, collection, limit, cursor_id]
       end
 
+      undef op_code
+
+      # Get the code for a get more operation.
+      #
+      # @example Get the operation code.
+      #   get_more.op_code
+      #
+      # @return [ Integer ] OP_GETMORE operation code (2005).
+      #
+      # @since 1.0.0
+      def op_code
+        2005
+      end
+
       # Receive replies to the message.
       #
       # @example Receive replies.
@@ -90,6 +146,21 @@ module Moped
       def receive_replies(connection)
         connection.read
       end
+
+      # Take the provided reply and return the expected results to api
+      # consumers.
+      #
+      # @example Get the expected results of the reply.
+      #   get_more.results(reply)
+      #
+      # @param [ Moped::Protocol::Reply ] reply The reply from the database.
+      #
+      # @return [ Moped::Protocol::Reply ] The reply.
+      #
+      # @since 2.0.0
+      def results(reply)
+        reply
+      end
     end
   end
 end

data/lib/moped/protocol/insert.rb

@@ -90,6 +90,23 @@ module Moped
 
         "%-12s database=%s collection=%s documents=%s flags=%s" % [type, database, collection, documents.inspect, flags.inspect]
       end
+
+      private
+
+      # Duplicate the attributes in the insert that need to be.
+      #
+      # @api private
+      #
+      # @example Clone the insert.
+      #   insert.clone
+      #
+      # @param [ Insert ] The insert that was cloned from.
+      #
+      # @since 2.0.0
+      def initialize_copy(_)
+        @documents = documents.dup
+        @flags = flags.dup
+      end
     end
   end
 end