mongo 1.10.0-java

data/lib/mongo/utils.rb

@@ -0,0 +1,19 @@
+# Copyright (C) 2009-2013 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/utils/conversions'
+require 'mongo/utils/core_ext'
+require 'mongo/utils/server_version'
+require 'mongo/utils/support'
+require 'mongo/utils/thread_local_variable_manager'

data/lib/mongo/utils/conversions.rb

@@ -0,0 +1,110 @@
+# Copyright (C) 2009-2013 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 #:nodoc:
+
+  # Utility module to include when needing to convert certain types of
+  # objects to mongo-friendly parameters.
+  module Conversions
+
+    ASCENDING_CONVERSION  = ["ascending", "asc", "1"]
+    DESCENDING_CONVERSION = ["descending", "desc", "-1"]
+
+    # Allows sort parameters to be defined as a Hash.
+    # Does not allow usage of un-ordered hashes, therefore
+    # Ruby 1.8.x users must use BSON::OrderedHash.
+    #
+    # Example:
+    #
+    # <tt>hash_as_sort_parameters({:field1 => :asc, "field2" => :desc})</tt> =>
+    # <tt>{ "field1" => 1, "field2" => -1}</tt>
+    def hash_as_sort_parameters(value)
+      if RUBY_VERSION < '1.9' && !value.is_a?(BSON::OrderedHash)
+        raise InvalidSortValueError.new(
+          "Hashes used to supply sort order must maintain ordering." +
+          "Use BSON::OrderedHash."
+        )
+      else
+        order_by = value.inject({}) do |memo, (key, direction)|
+          memo[key.to_s] = sort_value(direction)
+          memo
+        end
+      end
+      order_by
+    end
+
+    # Converts the supplied +Array+ to a +Hash+ to pass to mongo as
+    # sorting parameters. The returned +Hash+ will vary depending
+    # on whether the passed +Array+ is one or two dimensional.
+    #
+    # Example:
+    #
+    # <tt>array_as_sort_parameters([["field1", :asc], ["field2", :desc]])</tt> =>
+    # <tt>{ "field1" => 1, "field2" => -1}</tt>
+    def array_as_sort_parameters(value)
+      order_by = BSON::OrderedHash.new
+      if value.first.is_a? Array
+        value.each do |param|
+          if (param.class.name == "String")
+            order_by[param] = 1
+          else
+            order_by[param[0]] = sort_value(param[1]) unless param[1].nil?
+          end
+        end
+      elsif !value.empty?
+        if order_by.size == 1
+          order_by[value.first] = 1
+        else
+          order_by[value.first] = sort_value(value[1])
+        end
+      end
+      order_by
+    end
+
+    # Converts the supplied +String+ or +Symbol+ to a +Hash+ to pass to mongo as
+    # a sorting parameter with ascending order. If the +String+
+    # is empty then an empty +Hash+ will be returned.
+    #
+    # Example:
+    #
+    # *DEPRECATED
+    #
+    # <tt>string_as_sort_parameters("field")</tt> => <tt>{ "field" => 1 }</tt>
+    # <tt>string_as_sort_parameters("")</tt> => <tt>{}</tt>
+    def string_as_sort_parameters(value)
+      return {} if (str = value.to_s).empty?
+      { str => 1 }
+    end
+
+    # Converts the +String+, +Symbol+, or +Integer+ to the
+    # corresponding sort value in MongoDB.
+    #
+    # Valid conversions (case-insensitive):
+    #
+    # <tt>ascending, asc, :ascending, :asc, 1</tt> => <tt>1</tt>
+    # <tt>descending, desc, :descending, :desc, -1</tt> => <tt>-1</tt>
+    #
+    # If the value is invalid then an error will be raised.
+    def sort_value(value)
+      return value if value.is_a?(Hash)
+      val = value.to_s.downcase
+      return 1 if ASCENDING_CONVERSION.include?(val)
+      return -1 if DESCENDING_CONVERSION.include?(val)
+      raise InvalidSortValueError.new(
+        "#{self} was supplied as a sort direction when acceptable values are: " +
+        "Mongo::ASCENDING, 'ascending', 'asc', :ascending, :asc, 1, Mongo::DESCENDING, " +
+        "'descending', 'desc', :descending, :desc, -1.")
+    end
+  end
+end

data/lib/mongo/utils/core_ext.rb

@@ -0,0 +1,70 @@
+# Copyright (C) 2009-2013 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.
+
+#:nodoc:
+class Object
+
+  #:nodoc:
+  def tap
+    yield self
+    self
+  end unless respond_to? :tap
+
+end
+
+#:nodoc:
+class Hash
+
+  #:nodoc:
+  def assert_valid_keys(*valid_keys)
+    unknown_keys = keys - [valid_keys].flatten
+    raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+  end
+
+end
+
+#:nodoc:
+class String
+
+  #:nodoc:
+  def to_bson_code
+    BSON::Code.new(self)
+  end
+
+end
+
+#:nodoc:
+class Class
+  def mongo_thread_local_accessor name, options = {}
+    m = Module.new
+    m.module_eval do
+      class_variable_set :"@@#{name}", Hash.new {|h,k| h[k] = options[:default] }
+    end
+    m.module_eval %{
+
+      def #{name}
+        @@#{name}[Thread.current.object_id]
+      end
+
+      def #{name}=(val)
+        @@#{name}[Thread.current.object_id] = val
+      end
+    }
+
+    class_eval do
+      include m
+      extend m
+    end
+  end
+end

data/lib/mongo/utils/server_version.rb

@@ -0,0 +1,69 @@
+# Copyright (C) 2009-2013 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
+
+  # Simple class for comparing server versions.
+  class ServerVersion
+    include Comparable
+
+    def initialize(version)
+      @version = version
+    end
+
+    # Implements comparable.
+    def <=>(new)
+      local, new  = self.to_a, to_array(new)
+      for n in 0...local.size do
+        break if elements_include_mods?(local[n], new[n])
+        if local[n] < new[n].to_i
+          result = -1
+          break;
+        elsif local[n] > new[n].to_i
+          result = 1
+          break;
+        end
+      end
+      result || 0
+    end
+
+    # Return an array representation of this server version.
+    def to_a
+      to_array(@version)
+    end
+
+    # Return a string representation of this server version.
+    def to_s
+      @version
+    end
+
+    private
+
+    # Returns true if any elements include mod symbols (-, +)
+    def elements_include_mods?(*elements)
+      elements.any? { |n| n =~ /[\-\+]/ }
+    end
+
+    # Converts argument to an array of integers,
+    # appending any mods as the final element.
+    def to_array(version)
+      array = version.split(".").map {|n| (n =~ /^\d+$/) ? n.to_i : n }
+      if array.last =~ /(\d+)([\-\+])/
+        array[array.length-1] = $1.to_i
+        array << $2
+      end
+      array
+    end
+  end
+end

data/lib/mongo/utils/support.rb

@@ -0,0 +1,80 @@
+# Copyright (C) 2009-2013 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 Support
+
+    include Mongo::Conversions
+    extend self
+
+    def validate_db_name(db_name)
+      unless [String, Symbol].include?(db_name.class)
+        raise TypeError, "db_name must be a string or symbol"
+      end
+
+      [" ", ".", "$", "/", "\\"].each do |invalid_char|
+        if db_name.include? invalid_char
+          raise Mongo::InvalidNSName, "database names cannot contain the character '#{invalid_char}'"
+        end
+      end
+      raise Mongo::InvalidNSName, "database name cannot be the empty string" if db_name.empty?
+      db_name
+    end
+
+    def format_order_clause(order)
+      case order
+        when Hash, BSON::OrderedHash then hash_as_sort_parameters(order)
+        when String, Symbol then string_as_sort_parameters(order)
+        when Array then array_as_sort_parameters(order)
+        else
+          raise InvalidSortValueError, "Illegal sort clause, '#{order.class.name}'; must be of the form " +
+            "[['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]"
+      end
+    end
+
+    def normalize_seeds(seeds)
+      pairs = Array(seeds)
+      pairs = [ seeds ] if pairs.last.is_a?(Fixnum)
+      pairs = pairs.collect do |hostport|
+        if hostport.is_a?(String)
+          if hostport[0,1] == '['
+            host, port = hostport.split(']:') << MongoClient::DEFAULT_PORT
+            host = host.end_with?(']') ? host[1...-1] : host[1..-1]
+          else
+            host, port = hostport.split(':') << MongoClient::DEFAULT_PORT
+          end
+          [ host, port.to_i ]
+        else
+          hostport
+        end
+      end
+      pairs.length > 1 ? pairs : pairs.first
+    end
+
+    def is_i?(value)
+      return !!(value =~ /^\d+$/)
+    end
+
+    # Determine if a database command has succeeded by
+    # checking the document response.
+    #
+    # @param [Hash] doc
+    #
+    # @return [Boolean] true if the 'ok' key is either 1 or *true*.
+    def ok?(doc)
+      ok = doc['ok']
+      ok == 1 || ok == 1.0 || ok == true
+    end
+  end
+end

data/lib/mongo/utils/thread_local_variable_manager.rb

@@ -0,0 +1,25 @@
+# Copyright (C) 2009-2013 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.
+
+#:nodoc:
+module Mongo
+  module ThreadLocalVariableManager
+    def thread_local
+      Thread.current[:mongo_thread_locals] ||= Hash.new do |hash, key|
+        hash[key] = Hash.new unless hash.key? key
+        hash[key]
+      end
+    end
+  end
+end

data/mongo.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |s|
+  s.name              = 'mongo'
+
+  s.version           = File.read(File.join(File.dirname(__FILE__), 'VERSION'))
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = ['Emily Stolfo', 'Durran Jordan', 'Gary Murakami', 'Tyler Brock', 'Brandon Black']
+  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.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']
+  else
+    warn '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']
+
+  if RUBY_PLATFORM =~ /java/
+    s.platform = 'java'
+    s.files    << 'ext/jsasl/target/jsasl.jar'
+  end
+
+  s.test_files        = Dir['test/**/*.rb'] - Dir['test/bson/*']
+  s.executables       = ['mongo_console']
+  s.require_paths     = ['lib']
+  s.has_rdoc          = 'yard'
+
+  s.add_dependency('bson', "~> #{s.version}")
+end

data/test/functional/authentication_test.rb

@@ -0,0 +1,35 @@
+# Copyright (C) 2009-2013 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 'test_helper'
+require 'shared/authentication/basic_auth_shared'
+require 'shared/authentication/sasl_plain_shared'
+require 'shared/authentication/bulk_api_auth_shared'
+require 'shared/authentication/gssapi_shared'
+
+
+class AuthenticationTest < Test::Unit::TestCase
+  include Mongo
+  include BasicAuthTests
+  include SASLPlainTests
+  include BulkAPIAuthTests
+  include GSSAPITests
+
+  def setup
+    @client    = MongoClient.new(TEST_HOST, TEST_PORT)
+    @version   = @client.server_version
+    @db        = @client[TEST_DB]
+    @host_info = host_port
+  end
+end