bson 4.7.1 → 4.9.1

data/ext/bson/write.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2019 MongoDB, Inc.
+ * Copyright (C) 2009-2020 MongoDB Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -125,40 +125,44 @@ VALUE rb_bson_byte_buffer_put_bytes(VALUE self, VALUE bytes)
   return self;
 }
 
-/* write the byte denoting the BSON type for the passed object*/
+/* write the byte denoting the BSON type for the passed object */
 void pvt_put_type_byte(byte_buffer_t *b, VALUE val){
-  switch(TYPE(val)){
+  char type_byte;
+  
+  switch (TYPE(val)){
     case T_BIGNUM:
     case T_FIXNUM:
-      if(fits_int32(NUM2LL(val))){
-        pvt_put_byte(b, BSON_TYPE_INT32);
-      }else{
-        pvt_put_byte(b, BSON_TYPE_INT64);
+      if (fits_int32(NUM2LL(val))) {
+        type_byte = BSON_TYPE_INT32;
+      } else {
+        type_byte = BSON_TYPE_INT64;
       }
       break;
     case T_STRING:
-      pvt_put_byte(b, BSON_TYPE_STRING);
+      type_byte = BSON_TYPE_STRING;
       break;
     case T_ARRAY:
-      pvt_put_byte(b, BSON_TYPE_ARRAY);
+      type_byte = BSON_TYPE_ARRAY;
       break;
     case T_TRUE:
     case T_FALSE:
-      pvt_put_byte(b, BSON_TYPE_BOOLEAN);
+      type_byte = BSON_TYPE_BOOLEAN;
       break;
     case T_HASH:
-      pvt_put_byte(b, BSON_TYPE_DOCUMENT);
+      type_byte = BSON_TYPE_DOCUMENT;
       break;
     case T_FLOAT:
-      pvt_put_byte(b, BSON_TYPE_DOUBLE);
+      type_byte = BSON_TYPE_DOUBLE;
       break;
     default:{
-      VALUE type = rb_funcall(val, rb_intern("bson_type"),0);
+      VALUE type = rb_funcall(val, rb_intern("bson_type"), 0);
+      type_byte = *RSTRING_PTR(type);
       RB_GC_GUARD(type);
-      pvt_put_byte(b, *RSTRING_PTR(type));
       break;
     }
   }
+  
+  pvt_put_byte(b, type_byte);
 }
 
 /**

data/lib/bson.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -57,6 +57,7 @@ module BSON
 end
 
 require "bson/config"
+require "bson/error"
 require "bson/registry"
 require "bson/specialized"
 require "bson/json"
@@ -70,8 +71,10 @@ require "bson/code"
 require "bson/code_with_scope"
 require "bson/date"
 require "bson/date_time"
+require "bson/db_pointer"
 require "bson/decimal128"
 require "bson/document"
+require "bson/ext_json"
 require "bson/false_class"
 require "bson/float"
 require "bson/hash"

data/lib/bson/active_support.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/array.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -85,26 +85,55 @@ module BSON
       map { |value| value.to_bson_normalized_value }
     end
 
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # This method recursively invokes +as_extended_json+ with the provided
+    # options on each array element.
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Array ] This array converted to extended json representation.
+    def as_extended_json(**options)
+      map do |item|
+        item.as_extended_json(**options)
+      end
+    end
+
     module ClassMethods
 
       # Deserialize the array from BSON.
       #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
+      # @option options [ nil | :bson ] :mode Decoding mode to use.
+      #
       # @return [ Array ] The decoded array.
       #
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
+      def from_bson(buffer, **options)
         if buffer.respond_to?(:get_array)
-          buffer.get_array
+          buffer.get_array(**options)
         else
           array = new
-          buffer.get_int32 # throw away the length
+          start_position = buffer.read_position
+          expected_byte_size = buffer.get_int32
           while (type = buffer.get_byte) != NULL_BYTE
             buffer.get_cstring
-            array << BSON::Registry.get(type).from_bson(buffer)
+            cls = BSON::Registry.get(type)
+            value = if options.empty?
+              cls.from_bson(buffer)
+            else
+              cls.from_bson(buffer, **options)
+            end
+            array << value
+          end
+          actual_byte_size = buffer.read_position - start_position
+          if actual_byte_size != expected_byte_size
+            raise Error::BSONDecodeError, "Expected array to take #{expected_byte_size} bytes but it took #{actual_byte_size} bytes"
           end
           array
         end

data/lib/bson/binary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -31,6 +31,12 @@ module BSON
 
     # The mappings of subtypes to their single byte identifiers.
     #
+    # @note subtype 6 (ciphertext) is used for the Client-Side Encryption
+    #   feature. Data represented by this subtype is often encrypted, but
+    #   may also be plaintext. All instances of this subtype necessary for
+    #   Client-Side Encryption will be created internally by the Ruby driver.
+    #   An application should not create new BSON::Binary objects of this subtype.
+    #
     # @since 2.0.0
     SUBTYPES = {
       :generic => 0.chr,
@@ -39,6 +45,7 @@ module BSON
       :uuid_old => 3.chr,
       :uuid => 4.chr,
       :md5 => 5.chr,
+      :ciphertext => 6.chr,
       :user => 128.chr
     }.freeze
 
@@ -94,8 +101,31 @@ module BSON
     # @return [ Hash ] The binary as a JSON hash.
     #
     # @since 2.0.0
+    # @deprecated Use as_extended_json instead.
     def as_json(*args)
-      { "$binary" => Base64.encode64(data), "$type" => type }
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
+      subtype = SUBTYPES[type].each_byte.map { |c| c.to_s(16) }.join
+      if subtype.length == 1
+        subtype = "0#{subtype}"
+      end
+
+      value = Base64.encode64(data).strip
+
+      if options[:mode] == :legacy
+        { "$binary" => value, "$type" => subtype }
+      else
+        { "$binary" => {'base64' => value, "subType" => subtype }}
+      end
     end
 
     # Instantiate the new binary object.
@@ -228,14 +258,22 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
     # @return [ Binary ] The decoded binary data.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
+    def self.from_bson(buffer, **options)
       length = buffer.get_int32
-      type = TYPES[buffer.get_byte]
+      type_byte = buffer.get_byte
+      type = TYPES[type_byte]
+      if type.nil?
+        raise Error::UnsupportedBinarySubtype,
+          "BSON data contains unsupported binary subtype #{'0x%02x' % type_byte.ord}"
+      end
+
       length = buffer.get_int32 if type == :old
       data = buffer.get_bytes(length)
       new(data, type)

data/lib/bson/boolean.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -31,13 +31,22 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
     # @return [ TrueClass, FalseClass ] The decoded boolean.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
-      buffer.get_byte == TrueClass::TRUE_BYTE
+    def self.from_bson(buffer, **options)
+      case v = buffer.get_byte
+      when TrueClass::TRUE_BYTE
+        true
+      when FalseClass::FALSE_BYTE
+        false
+      else
+        raise Error::BSONDecodeError, "Invalid boolean byte value: #{v}"
+      end
     end
 
     # Register this type when the module is loaded.

data/lib/bson/code.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -55,7 +55,19 @@ module BSON
     # @return [ Hash ] The code as a JSON hash.
     #
     # @since 2.0.0
+    # @deprecated Use as_extended_json instead.
     def as_json(*args)
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
       { "$code" => javascript }
     end
 
@@ -89,12 +101,14 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
     # @return [ TrueClass, FalseClass ] The decoded code.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
+    def self.from_bson(buffer, **options)
       new(buffer.get_string)
     end
 

data/lib/bson/code_with_scope.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -59,8 +59,20 @@ module BSON
     # @return [ Hash ] The code with scope as a JSON hash.
     #
     # @since 2.0.0
+    # @deprecated Use as_extended_json instead.
     def as_json(*args)
-      { "$code" => javascript, "$scope" => scope }
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
+    #   (default is canonical extended JSON)
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
+      { "$code" => javascript, "$scope" => scope.as_extended_json(**options) }
     end
 
     # Instantiate the new code with scope.
@@ -99,14 +111,29 @@ module BSON
     #
     # @param [ ByteBuffer ] buffer The byte buffer.
     #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
     # @return [ TrueClass, FalseClass ] The decoded code with scope.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def self.from_bson(buffer)
-      buffer.get_int32 # Throw away the total length.
-      new(buffer.get_string, ::Hash.from_bson(buffer))
+    def self.from_bson(buffer, **options)
+      # Code with scope has a length (?) field which is not needed for
+      # decoding, but spec tests want this field validated.
+      start_position = buffer.read_position
+      length = buffer.get_int32
+      javascript = buffer.get_string
+      scope = if options.empty?
+        ::Hash.from_bson(buffer)
+      else
+        ::Hash.from_bson(buffer, **options)
+      end
+      read_bytes = buffer.read_position - start_position
+      if read_bytes != length
+        raise Error::BSONDecodeError, "CodeWithScope invalid: claimed length #{length}, actual length #{read_bytes}"
+      end
+      new(javascript, scope)
     end
 
     # Register this type when the module is loaded.

data/lib/bson/config.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/date.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/date_time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/bson/db_pointer.rb

@@ -0,0 +1,110 @@
+# Copyright (C) 2020 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 BSON
+
+  # Injects behaviour for encoding and decoding DBPointer values to and from
+  # raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  class DbPointer
+    include JSON
+
+    # A DBPointer is type 0x0C in the BSON spec.
+    BSON_TYPE = 0x0C.chr.force_encoding(BINARY).freeze
+
+    # Create a new DBPointer object.
+    #
+    # @param [ String ] ref The database collection name.
+    # @param [ BSON::ObjectId ] id The DBPointer id.
+    def initialize(ref, id)
+      @ref = ref
+      @id = id
+    end
+
+    # Return the collection name.
+    #
+    # @return [ String ] The database collection name.
+    attr_reader :ref
+
+    # Return the DbPointer's id.
+    #
+    # @return [ BSON::ObjectId ] The id of the DbPointer instance
+    attr_reader :id
+
+    # Determine if this DBPointer object is equal to another object.
+    #
+    # @param [ Object ] other The object to compare against.
+    #
+    # @return [ true | false ] If the objects are equal
+    def ==(other)
+      return false unless other.is_a?(DbPointer)
+      ref == other.ref && id == other.id
+    end
+
+    # Get the DBPointer as JSON hash data
+    #
+    # @return [ Hash ] The DBPointer as a JSON hash.
+    #
+    # @deprecated Use as_extended_json instead.
+    def as_json(*args)
+      as_extended_json
+    end
+
+    # Converts this object to a representation directly serializable to
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    #
+    # @option options [ true | false ] :relaxed Whether to produce relaxed
+    #   extended JSON representation.
+    #
+    # @return [ Hash ] The extended json representation.
+    def as_extended_json(**options)
+      {'$dbPointer' => { "$ref" => ref, '$id' => id.as_extended_json }}
+    end
+
+    # Encode the DBPointer.
+    #
+    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
+    #
+    # @see http://bsonspec.org/#/specification
+    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+      buffer.put_string(ref)
+      id.to_bson(buffer, validating_keys)
+      buffer
+    end
+
+    # Deserialize a DBPointer from BSON.
+    #
+    # @param [ ByteBuffer ] buffer The byte buffer.
+    # @param [ Hash ] options
+    #
+    # @option options [ nil | :bson ] :mode Decoding mode to use.
+    #
+    # @return [ BSON::DbPointer ] The decoded DBPointer.
+    #
+    # @see http://bsonspec.org/#/specification
+    def self.from_bson(buffer, **options)
+      ref = buffer.get_string
+      id = if options.empty?
+        ObjectId.from_bson(buffer)
+      else
+        ObjectId.from_bson(buffer, **options)
+      end
+      new(ref, id)
+    end
+
+    # Register this type when the module is loaded.
+    Registry.register(BSON_TYPE, self)
+  end
+end