mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/version.rb

@@ -0,0 +1,21 @@
+# 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
+
+  # The current version of the driver.
+  #
+  # @since 2.0.0
+  VERSION = '2.0.0.beta'.freeze
+end

data/lib/mongo/write_concern.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 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/write_concern/normalizable'
+require 'mongo/write_concern/acknowledged'
+require 'mongo/write_concern/unacknowledged'
+
+module Mongo
+
+  # Base module for all write concern specific behaviour.
+  #
+  # @since 2.0.0
+  module WriteConcern
+    extend self
+
+    # The number of servers write concern.
+    #
+    # @since 2.0.0
+    W = :w.freeze
+
+    # The journal write concern.
+    #
+    # @since 2.0.0
+    J = :j.freeze
+
+    # The file sync write concern.
+    #
+    # @since 2.0.0
+    FSYNC = :fsync.freeze
+
+    # The wtimeout write concern.
+    #
+    # @since 2.0.0
+    WTIMEOUT = :wtimeout.freeze
+
+    # The GLE command name.
+    #
+    # @since 2.0.0
+    GET_LAST_ERROR = :getlasterror.freeze
+
+    # The default write concern is to acknowledge on a single server.
+    #
+    # @since 2.0.0
+    DEFAULT = { W => 1 }.freeze
+
+    # Get a write concern mode for the provided options.
+    #
+    # @example Get a write concern mode.
+    #   Mongo::WriteConcern.get(:w => 1)
+    #
+    # @param [ Hash ] options The options to instantiate with.
+    #
+    # @option options :w [ Integer, String ] The number of servers or the
+    #   custom mode to acknowledge.
+    # @option options :j [ true, false ] Whether to acknowledge a write to
+    #   the journal.
+    # @option options :fsync [ true, false ] Should the write be synced to
+    #   disc.
+    # @option options :wtimeout [ Integer ] The number of milliseconds to
+    #   wait for acknowledgement before raising an error.
+    #
+    # @return [ Unacknowledged, Acknowledged ] The appropriate concern.
+    #
+    # @since 2.0.0
+    def get(options)
+      if unacknowledged?(options)
+        Unacknowledged.new(options)
+      else
+        Acknowledged.new(options || DEFAULT)
+      end
+    end
+
+    private
+
+    # Determine if the options are for an unacknowledged write concern.
+    #
+    # @api private
+    #
+    # @param [ Hash ] options The options to check.
+    #
+    # @return [ true, false ] If the options are unacknowledged.
+    #
+    # @since 2.0.0
+    def unacknowledged?(options)
+      options && (options[W] == 0 || options[W] == -1)
+    end
+  end
+end

data/lib/mongo/write_concern/acknowledged.rb

@@ -0,0 +1,38 @@
+# 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 WriteConcern
+
+    # An acknowledged write concern provides a get last error command with the
+    # appropriate options on each write operation.
+    #
+    # @since 2.0.0
+    class Acknowledged
+      include Normalizable
+
+      # Get the get last error command for the concern.
+      #
+      # @example Get the gle command.
+      #   acknowledged.get_last_error
+      #
+      # @return [ Hash ] The gle command.
+      #
+      # @since 2.0.0
+      def get_last_error
+        @get_last_error ||= { GET_LAST_ERROR => 1 }.merge(normalize(options))
+      end
+    end
+  end
+end

data/lib/mongo/write_concern/normalizable.rb

@@ -0,0 +1,73 @@
+# 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 WriteConcern
+
+    # Defines default behavior for write concerns and provides a factory
+    # interface to get a proper object from options.
+    #
+    # @since 2.0.0
+    module Normalizable
+
+      # @return [ Hash ] The write concern options.
+      attr_reader :options
+
+      # Instantiate a new write concern given the options.
+      #
+      # @api private
+      #
+      # @example Instantiate a new write concern mode.
+      #   Mongo::WriteConcern.new(:w => 1)
+      #
+      # @param [ Hash ] options The options to instantiate with.
+      #
+      # @option options :w [ Integer, String ] The number of servers or the
+      #   custom mode to acknowledge.
+      # @option options :j [ true, false ] Whether to acknowledge a write to
+      #   the journal.
+      # @option options :fsync [ true, false ] Should the write be synced to
+      #   disc.
+      # @option options :wtimeout [ Integer ] The number of milliseconds to
+      #   wait for acknowledgement before raising an error.
+      #
+      # @since 2.0.0
+      def initialize(options)
+        @options = options.freeze
+      end
+
+      private
+
+      # Normalizes symbol option values into strings, since symbol will raise
+      # an error on the server side with the gle.
+      #
+      # @api private
+      #
+      # @example Normalize the options.
+      #   mode.normalize(:w => :majority)
+      #
+      # @param [ Hash ] options The options to normalize.
+      #
+      # @return [ Hash ] The hash with normalized values.
+      #
+      # @since 2.0.0
+      def normalize(options)
+        options.reduce({}) do |options, (key, value)|
+          options[key] = value.is_a?(Symbol) ? value.to_s : value
+          options
+        end
+      end
+    end
+  end
+end

data/lib/mongo/write_concern/unacknowledged.rb

@@ -0,0 +1,43 @@
+# 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 WriteConcern
+
+    # An unacknowledged write concern will provide no error on write outside of
+    # network and connection exceptions.
+    #
+    # @since 2.0.0
+    class Unacknowledged
+      include Normalizable
+
+      # The noop constant for the gle.
+      #
+      # @since 2.0.0
+      NOOP = nil
+
+      # Get the gle command for an unacknowledged write.
+      #
+      # @example Get the gle command.
+      #   unacknowledged.get_last_error
+      #
+      # @return [ nil ] The noop.
+      #
+      # @since 2.0.0
+      def get_last_error
+        NOOP
+      end
+    end
+  end
+end

data/mongo.gemspec

@@ -1,31 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo/version'
+
 Gem::Specification.new do |s|
   s.name              = 'mongo'
-
-  s.version           = File.read(File.join(File.dirname(__FILE__), 'VERSION'))
+  s.rubyforge_project = 'mongo'
+  s.version           = Mongo::VERSION
   s.platform          = Gem::Platform::RUBY
-  s.authors           = ['Emily Stolfo', 'Durran Jordan', 'Gary Murakami', 'Tyler Brock', 'Brandon Black']
+
+  s.authors           = ['Tyler Brock', 'Emily Stolfo', 'Durran Jordan']
   s.email             = 'mongodb-dev@googlegroups.com'
   s.homepage          = 'http://www.mongodb.org'
   s.summary           = 'Ruby driver for MongoDB'
-  s.description       = 'A Ruby driver for MongoDB. For more information about Mongo, see http://www.mongodb.org.'
-  s.rubyforge_project = 'mongo'
+  s.description       = 'A Ruby driver for MongoDB'
   s.license           = 'Apache License Version 2.0'
 
   if File.exists?('gem-private_key.pem')
-    s.signing_key = 'gem-private_key.pem'
-    s.cert_chain  = ['gem-public_cert.pem']
+    s.signing_key     = 'gem-private_key.pem'
+    s.cert_chain      = ['gem-public_cert.pem']
   else
-    warn 'Warning: No private key present, creating unsigned gem.'
+    warn "[#{s.name}] Warning: No private key present, creating unsigned gem."
   end
 
-  s.files             = ['mongo.gemspec', 'LICENSE', 'VERSION']
-  s.files             += ['README.md', 'Rakefile', 'bin/mongo_console']
-  s.files             += ['lib/mongo.rb'] + Dir['lib/mongo/**/*.rb']
+  s.files             = Dir.glob('{bin,lib,spec}/**/*')
+  s.files             += %w[mongo.gemspec LICENSE README.md CONTRIBUTING.md Rakefile]
+  s.test_files        = Dir.glob('spec/**/*')
 
-  s.test_files        = Dir['test/**/*.rb'] - Dir['test/bson/*']
-  s.executables       = ['mongo_console']
   s.require_paths     = ['lib']
   s.has_rdoc          = 'yard'
+  s.bindir            = 'bin'
 
-  s.add_dependency('bson', "#{s.version}")
+  s.add_dependency 'bson', '~> 3.0'
 end

data/spec/mongo/address/ipv4_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Mongo::Address::IPv4 do
+
+  describe '#initialize' do
+
+    context 'when a port is provided' do
+
+      let(:resolver) do
+        described_class.new('127.0.0.1:27017')
+      end
+
+      it 'sets the port' do
+        expect(resolver.port).to eq(27017)
+      end
+
+      it 'sets the host' do
+        expect(resolver.host).to eq('127.0.0.1')
+      end
+    end
+
+    context 'when no port is provided' do
+
+      let(:resolver) do
+        described_class.new('127.0.0.1')
+      end
+
+      it 'sets the port to 27017' do
+        expect(resolver.port).to eq(27017)
+      end
+
+      it 'sets the host' do
+        expect(resolver.host).to eq('127.0.0.1')
+      end
+    end
+  end
+
+  describe '#socket' do
+
+    let(:resolver) do
+      described_class.new('127.0.0.1')
+    end
+
+    context 'when ssl options are provided' do
+
+      let(:socket) do
+        resolver.socket(5, :ssl => true)
+      end
+
+      it 'returns an ssl socket' do
+        expect(socket).to be_a(Mongo::Socket::SSL)
+      end
+
+      it 'sets the family as ipv4' do
+        expect(socket.family).to eq(Socket::PF_INET)
+      end
+    end
+
+    context 'when ssl options are not provided' do
+
+      let(:socket) do
+        resolver.socket(5)
+      end
+
+      it 'returns a tcp socket' do
+        expect(socket).to be_a(Mongo::Socket::TCP)
+      end
+
+      it 'sets the family a ipv4' do
+        expect(socket.family).to eq(Socket::PF_INET)
+      end
+    end
+  end
+end

data/spec/mongo/address/ipv6_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Mongo::Address::IPv6 do
+
+  describe '#initialize' do
+
+    context 'when a port is provided' do
+
+      let(:resolver) do
+        described_class.new('[::1]:27017')
+      end
+
+      it 'sets the port' do
+        expect(resolver.port).to eq(27017)
+      end
+
+      it 'sets the host' do
+        expect(resolver.host).to eq('::1')
+      end
+    end
+
+    context 'when no port is provided' do
+
+      let(:resolver) do
+        described_class.new('[::1]')
+      end
+
+      it 'sets the port to 27017' do
+        expect(resolver.port).to eq(27017)
+      end
+
+      it 'sets the host' do
+        expect(resolver.host).to eq('::1')
+      end
+    end
+  end
+
+  describe '#socket' do
+
+    let(:resolver) do
+      described_class.new('[::1]')
+    end
+
+    context 'when ssl options are provided' do
+
+      let(:socket) do
+        resolver.socket(5, :ssl => true)
+      end
+
+      it 'returns an ssl socket' do
+        expect(socket).to be_a(Mongo::Socket::SSL)
+      end
+
+      it 'sets the family as ipv6' do
+        expect(socket.family).to eq(Socket::PF_INET6)
+      end
+    end
+
+    context 'when ssl options are not provided' do
+
+      let(:socket) do
+        resolver.socket(5)
+      end
+
+      it 'returns a tcp socket' do
+        expect(socket).to be_a(Mongo::Socket::TCP)
+      end
+
+      it 'sets the family a ipv6' do
+        expect(socket.family).to eq(Socket::PF_INET6)
+      end
+    end
+  end
+end