mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/address.rb

@@ -0,0 +1,111 @@
+# 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/address/ipv4'
+require 'mongo/address/ipv6'
+require 'mongo/address/unix'
+
+module Mongo
+
+  # Represents an address to a server, either with an IP address or socket
+  # path.
+  #
+  # @since 2.0.0
+  class Address
+    extend Forwardable
+
+    # Delegate the ip, host, and port methods to the resolver.
+    #
+    # @since 2.0.0
+    def_delegators :@resolver, :host, :port, :socket, :seed, :to_s
+
+    # @return [ Integer ] port The port to the connect to.
+    attr_reader :resolver
+
+    # Check equality of the address to another.
+    #
+    # @example Check address equality.
+    #   address == other
+    #
+    # @param [ Object ] other The other object.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Address)
+      host == other.host && port == other.port
+    end
+
+    # Calculate the hash value for the address.
+    #
+    # @example Calculate the hash value.
+    #   address.hash
+    #
+    # @return [ Integer ] The hash value.
+    #
+    # @since 2.0.0
+    def hash
+      [ host, port ].hash
+    end
+
+    # Initialize the address.
+    #
+    # @example Initialize the address with a DNS entry and port.
+    #   Mongo::Address.new("app.example.com:27017")
+    #
+    # @example Initialize the address with a DNS entry and no port.
+    #   Mongo::Address.new("app.example.com")
+    #
+    # @example Initialize the address with an IPV4 address and port.
+    #   Mongo::Address.new("127.0.0.1:27017")
+    #
+    # @example Initialize the address with an IPV4 address and no port.
+    #   Mongo::Address.new("127.0.0.1")
+    #
+    # @example Initialize the address with an IPV6 address and port.
+    #   Mongo::Address.new("[::1]:27017")
+    #
+    # @example Initialize the address with an IPV6 address and no port.
+    #   Mongo::Address.new("[::1]")
+    #
+    # @example Initialize the address with a unix socket.
+    #   Mongo::Address.new("/path/to/socket.sock")
+    #
+    # @param [ String ] seed The provided address.
+    # @param [ Hash ] options The address options.
+    #
+    # @since 2.0.0
+    def initialize(seed, options = {})
+      address = seed.downcase
+      case address
+        when Unix::MATCH then @resolver = Unix.new(address)
+        when IPv6::MATCH then @resolver = IPv6.new(address)
+        else @resolver = IPv4.new(address)
+      end
+    end
+
+    # Get a pretty printed address inspection.
+    #
+    # @example Get the address inspection.
+    #   address.inspect
+    #
+    # @return [ String ] The nice inspection string.
+    #
+    # @since 2.0.0
+    def inspect
+      "#<Mongo::Address:0x#{object_id} address=#{resolver.to_s}>"
+    end
+  end
+end

data/lib/mongo/address/ipv4.rb

@@ -0,0 +1,85 @@
+# 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
+  class Address
+
+    # Sets up resolution with IPv4 support if the address is an ip
+    # address.
+    #
+    # @since 2.0.0
+    class IPv4
+
+      # @return [ String ] host The original host name.
+      attr_reader :host
+
+      # @return [ Integer ] port The port.
+      attr_reader :port
+
+      # @return [ String ] seed The seed address.
+      attr_reader :seed
+
+      # The regular expression to use to match an IPv4 ip address.
+      #
+      # @since 2.0.0
+      MATCH = Regexp.new('/\./').freeze
+
+      # Initialize the IPv4 resolver.
+      #
+      # @example Initialize the resolver.
+      #   IPv4.new("127.0.0.1:28011")
+      #
+      # @param [ String ] address The address to resolve.
+      #
+      # @since 2.0.0
+      def initialize(address)
+        parts = address.split(':')
+        @host = parts[0]
+        @port = (parts[1] || 27017).to_i
+        @seed = address
+      end
+
+      # Get a socket for the provided address type, given the options.
+      #
+      # @example Get an IPv4 socket.
+      #   ipv4.socket(5, :ssl => true)
+      #
+      # @param [ Float ] timeout The socket timeout.
+      # @param [ Hash ] ssl_options SSL options.
+      #
+      # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
+      #
+      # @since 2.0.0
+      def socket(timeout, ssl_options = {})
+        unless ssl_options.empty?
+          Socket::SSL.new(host, port, timeout, Socket::PF_INET, ssl_options)
+        else
+          Socket::TCP.new(host, port, timeout, Socket::PF_INET)
+        end
+      end
+
+      # Get the address as a string.
+      #
+      # @example Get the address as a string.
+      #   ipv4.to_s
+      #
+      # @return [ String ] The nice string.
+      #
+      # @since 2.0.0
+      def to_s
+        "#{host}:#{port}"
+      end
+    end
+  end
+end

data/lib/mongo/address/ipv6.rb

@@ -0,0 +1,85 @@
+# 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
+  class Address
+
+    # Sets up resolution with IPv6 support if the address is an ip
+    # address.
+    #
+    # @since 2.0.0
+    class IPv6
+
+      # @return [ String ] host The original host name.
+      attr_reader :host
+
+      # @return [ Integer ] port The port.
+      attr_reader :port
+
+      # @return [ String ] seed The seed address.
+      attr_reader :seed
+
+      # The regular expression to use to match an IPv6 ip address.
+      #
+      # @since 2.0.0
+      MATCH = Regexp.new('::').freeze
+
+      # Initialize the IPv6 resolver.
+      #
+      # @example Initialize the resolver.
+      #   IPv6.new("[::1]:28011")
+      #
+      # @param [ String ] address The address to resolve.
+      #
+      # @since 2.0.0
+      def initialize(address)
+        parts = address.match(/\[(.+)\]:?(.+)?/)
+        @host = parts[1]
+        @port = (parts[2] || 27017).to_i
+        @seed = address
+      end
+
+      # Get a socket for the provided address type, given the options.
+      #
+      # @example Get an IPv6 socket.
+      #   ipv4.socket(5, :ssl => true)
+      #
+      # @param [ Float ] timeout The socket timeout.
+      # @param [ Hash ] ssl_options SSL options.
+      #
+      # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
+      #
+      # @since 2.0.0
+      def socket(timeout, ssl_options = {})
+        unless ssl_options.empty?
+          Socket::SSL.new(host, port, timeout, Socket::PF_INET6, ssl_options)
+        else
+          Socket::TCP.new(host, port, timeout, Socket::PF_INET6)
+        end
+      end
+
+      # Get the address as a string.
+      #
+      # @example Get the address as a string.
+      #   ipv4.to_s
+      #
+      # @return [ String ] The nice string.
+      #
+      # @since 2.0.0
+      def to_s
+        "#{host}:#{port}"
+      end
+    end
+  end
+end

data/lib/mongo/address/unix.rb

@@ -0,0 +1,76 @@
+# 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
+  class Address
+
+    # Sets up socket addresses.
+    #
+    # @since 2.0.0
+    class Unix
+
+      # @return [ String ] host The original host name.
+      attr_reader :host
+
+      # @return [ nil ] port Will always be nil.
+      attr_reader :port
+
+      # @return [ String ] seed The seed address.
+      attr_reader :seed
+
+      # The regular expression to use to match a socket path.
+      #
+      # @since 2.0.0
+      MATCH = Regexp.new('\.sock').freeze
+
+      # Initialize the socket resolver.
+      #
+      # @example Initialize the resolver.
+      #   Sock.new("/path/to/socket.sock")
+      #
+      # @param [ String ] address The socket path.
+      #
+      # @since 2.0.0
+      def initialize(address)
+        @host = address
+        @seed = address
+      end
+
+      # Get a socket for the provided address type, given the options.
+      #
+      # @example Get a Unix socket.
+      #   ipv4.socket(5)
+      #
+      # @param [ Float ] timeout The socket timeout.
+      # @param [ Hash ] ssl_options SSL options - ignored.
+      #
+      # @return [ Pool::Socket::Unix ] The socket.
+      #
+      # @since 2.0.0
+      def socket(timeout, ssl_options = {})
+        Socket::Unix.new(host, timeout, Socket::AF_UNIX)
+      end
+
+      # Get the address as a string.
+      #
+      # @example Get the address as a string.
+      #   ipv4.to_s
+      #
+      # @return [ String ] The nice string.
+      #
+      # @since 2.0.0
+      alias :to_s :host
+    end
+  end
+end

data/lib/mongo/auth.rb

@@ -0,0 +1,108 @@
+# 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/auth/executable'
+require 'mongo/auth/cr'
+require 'mongo/auth/ldap'
+require 'mongo/auth/scram'
+require 'mongo/auth/user'
+require 'mongo/auth/x509'
+require 'mongo/auth/roles'
+
+module Mongo
+
+  # This namespace contains all authentication related behaviour.
+  #
+  # @since 2.0.0
+  module Auth
+    extend self
+
+    # The external database name.
+    #
+    # @since 2.0.0
+    EXTERNAL = '$external'.freeze
+
+    # Constant for the nonce command.
+    #
+    # @since 2.0.0
+    GET_NONCE = { getnonce: 1 }.freeze
+
+    # Constant for the nonce field.
+    #
+    # @since 2.0.0
+    NONCE = 'nonce'.freeze
+
+    # Map the symbols parsed from the URI connection string to strategies.
+    #
+    # @since 2.0.0
+    SOURCES = {
+      mongodb_cr: CR,
+      mongodb_x509: X509,
+      plain: LDAP,
+      scram: SCRAM
+    }
+
+    # Get the authorization strategy for the provided auth mechanism.
+    #
+    # @example Get the strategy.
+    #   Auth.get(:mongodb_cr)
+    #
+    # @param [ Symbol ] mechanism The authorization mechanism.
+    #
+    # @return [ CR, X509, LDAP, Kerberos ] The auth strategy.
+    #
+    # @since 2.0.0
+    def get(user)
+      mechanism = user.mechanism
+      raise InvalidMechanism.new(mechanism) if !SOURCES.has_key?(mechanism)
+      SOURCES[mechanism].new(user)
+    end
+
+    # Raised when trying to get an invalid authorization mechanism.
+    #
+    # @since 2.0.0
+    class InvalidMechanism < RuntimeError
+
+      # Instantiate the new error.
+      #
+      # @example Instantiate the error.
+      #   Mongo::Auth::InvalidMechanism.new(:test)
+      #
+      # @param [ Symbol ] mechanism The provided mechanism.
+      #
+      # @since 2.0.0
+      def initialize(mechanism)
+        super("#{mechanism.inspect} is invalid, please use mongodb_cr, mongodb_x509, gssapi or plain.")
+      end
+    end
+
+    # Raised when a user is not authorized on a database.
+    #
+    # @since 2.0.0
+    class Unauthorized < RuntimeError
+
+      # Instantiate the new error.
+      #
+      # @example Instantiate the error.
+      #   Mongo::Auth::Unauthorized.new(user)
+      #
+      # @param [ Mongo::Auth::User ] user The unauthorized user.
+      #
+      # @since 2.0.0
+      def initialize(user)
+        super("User #{user.name} is not authorized to access #{user.database}.")
+      end
+    end
+  end
+end