bson 4.0.4 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 102b6e1ecbcea8594a6bec1c1f0f80f0ad33186a
-  data.tar.gz: 7d21bbdc3197fbf22feed60d9dac7960def90c55
+  metadata.gz: 47d29b1cc3748faca5e80d2fd891f3afef42a63f
+  data.tar.gz: c9cc5e18df9aa9bb2dc5ed6e007648adf05ac845
 SHA512:
-  metadata.gz: 16772cdfb99cfd32022abba1a63d763d3b0e8da6a77825b25aebace05f73e31455a723db12e6738e64c7a711ffe34d5b9005c6eac65c8adca00c696d7b7c2e1b
-  data.tar.gz: a21557e5e8080c90ae8869115c5a199617ca34a0aec7d06b74ce137e32bd128a65aaa58dc4b1a4a158f3de85e08cea2d6db392d6dd8dd8fc4c45052929ed3281
+  metadata.gz: 433674c25e326d02c357f2b2fad8861c63ee4d3de379bd6310ea0da84c208c433d3fe8f5366a97bf6c731ab174b27d17ace2fde7046f248bcf301182059ebf3c
+  data.tar.gz: 05a96d4fd7446788c97a8d2cb0254432e46d6d66c7e32d9e17ba345fdb1c6f18dbe088cb76920bfa8446436ea66d4b1d106ee27e29084ec5887b39c6e1029214

data/lib/bson.rb

@@ -56,6 +56,7 @@ module BSON
   UTF8 = "UTF-8".freeze
 end
 
+require "bson/config"
 require "bson/registry"
 require "bson/specialized"
 require "bson/json"

data/lib/bson/config.rb

@@ -0,0 +1,51 @@
+# Copyright (C) 2016 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
+
+  # Provides configuration options for the BSON library.
+  #
+  # @since 4.1.0
+  module Config
+    extend self
+
+    # Set the configuration option for BSON to validate keys or not.
+    #
+    # @example Set the config option.
+    #   BSON::Config.validating_keys = true
+    #
+    # @param [ true, false ] value The value to set.
+    #
+    # @return [ true, false ] The value.
+    #
+    # @since 4.1.0
+    def validating_keys=(value)
+      @validating_keys = value
+    end
+
+    # Returns true if BSON will validate the document keys on serialization to
+    # determine if they contain invalid MongoDB values. Invalid keys start with
+    # '$' or contain a '.' in them.
+    #
+    # @example Is BSON validating keys?
+    #   BSON::Config.validating_keys?
+    #
+    # @return [ true, false ] If BSON is validating keys?
+    #
+    # @since 4.1.0
+    def validating_keys?
+      !!@validating_keys
+    end
+  end
+end

data/lib/bson/hash.rb

@@ -37,12 +37,12 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(buffer = ByteBuffer.new)
+    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
       position = buffer.length
       buffer.put_int32(0)
       each do |field, value|
         buffer.put_byte(value.bson_type)
-        buffer.put_cstring(field.to_bson_key)
+        buffer.put_cstring(field.to_bson_key(validating_keys))
         value.to_bson(buffer)
       end
       buffer.put_byte(NULL_BYTE)

data/lib/bson/integer.rb

@@ -145,8 +145,18 @@ module BSON
       encoded << ((self >> 56) & 255)
     end
 
-    def to_bson_key
-      to_s
+    # Convert the integer to a BSON string key.
+    #
+    # @example Convert the integer to a BSON key string.
+    #   1.to_bson_key
+    #
+    # @param [ true, false ] validating_keys If BSON should validate the key.
+    #
+    # @return [ String ] The string key.
+    #
+    # @since 2.0.0
+    def to_bson_key(validating_keys = Config.validating_keys?)
+      to_s.to_bson_key(validating_keys)
     end
 
     private

data/lib/bson/object.rb

@@ -31,7 +31,7 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.2.4
-    def to_bson_key(buffer = ByteBuffer.new)
+    def to_bson_key(validating_keys = Config.validating_keys?)
       raise InvalidKey.new(self)
     end
 

data/lib/bson/string.rb

@@ -28,6 +28,11 @@ module BSON
     # @since 2.0.0
     BSON_TYPE = 2.chr.force_encoding(BINARY).freeze
 
+    # Regex for matching illegal BSON keys.
+    #
+    # @since 4.1.0
+    ILLEGAL_KEY = /(\A[$])|(\.)/.freeze
+
     # Get the string as encoded BSON.
     #
     # @example Get the string as encoded BSON.
@@ -51,12 +56,18 @@ module BSON
     #
     # @raise [ EncodingError ] If the string is not UTF-8.
     #
+    # @raise [ IllegalKey ] If validating keys and it contains a '.' or starts
+    #   with '$'.
+    #
     # @return [ String ] The encoded string.
     #
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson_key
+    def to_bson_key(validating_keys = Config.validating_keys?)
+      if validating_keys
+        raise IllegalKey.new(self) if ILLEGAL_KEY =~ self
+      end
       self
     end
 
@@ -89,6 +100,24 @@ module BSON
       unpack("H*")[0]
     end
 
+    # Raised when validating keys and a key is illegal in MongoDB
+    #
+    # @since 4.1.0
+    class IllegalKey < RuntimeError
+
+      # Instantiate the exception.
+      #
+      # @example Instantiate the exception.
+      #   BSON::Object::IllegalKey.new(string)
+      #
+      # @param [ String ] string The illegal string.
+      #
+      # @since 4.1.0
+      def initialize(string)
+        super("'#{string}' is an illegal key in MongoDB. Keys may not start with '$' or contain a '.'.")
+      end
+    end
+
     module ClassMethods
 
       # Deserialize a string from BSON.

data/lib/bson/symbol.rb

@@ -70,8 +70,8 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson_key
-      to_s.to_bson_key
+    def to_bson_key(validating_keys = Config.validating_keys?)
+      to_s.to_bson_key(validating_keys)
     end
 
     # Converts the symbol to a normalized key in a BSON document.

data/lib/bson/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.0.4".freeze
+  VERSION = "4.1.0".freeze
 end

data/spec/bson/config_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe BSON::Config do
+
+  describe "#validating_keys?" do
+
+    context "when the default is used" do
+
+      it "returns false" do
+        expect(described_class).to_not be_validating_keys
+      end
+    end
+
+    context "when configuring to false" do
+
+      before do
+        BSON::Config.validating_keys = false
+      end
+
+      it "returns false" do
+        expect(described_class).to_not be_validating_keys
+      end
+    end
+
+    context "when configuring to true" do
+
+      before do
+        BSON::Config.validating_keys = true
+      end
+
+      after do
+        BSON::Config.validating_keys = false
+      end
+
+      it "returns true" do
+        expect(described_class).to be_validating_keys
+      end
+    end
+  end
+end

data/spec/bson/hash_spec.rb

@@ -52,6 +52,54 @@ describe Hash do
       end
     end
 
+    context "when the hash has invalid keys" do
+
+      let(:obj) do
+        { "$testing" => "value" }
+      end
+
+      context "when validating keys" do
+
+        context "when validating globally" do
+
+          before do
+            BSON::Config.validating_keys = true
+          end
+
+          after do
+            BSON::Config.validating_keys = false
+          end
+
+          it "raises an error" do
+            expect {
+              obj.to_bson
+            }.to raise_error(BSON::String::IllegalKey)
+          end
+        end
+
+        context "when validating locally" do
+
+          it "raises an error" do
+            expect {
+              obj.to_bson(BSON::ByteBuffer.new, true)
+            }.to raise_error(BSON::String::IllegalKey)
+          end
+        end
+      end
+
+      context "when not validating keys" do
+
+        let(:bson) do
+          "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
+          "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+        end
+
+        it "serializes the hash" do
+          expect(obj.to_bson.to_s).to eq(bson)
+        end
+      end
+    end
+
     context "when the hash is embedded" do
 
       let(:obj) do

data/spec/bson/string_spec.rb

@@ -87,4 +87,47 @@ describe String do
       expect(string.to_hex_string).to eq("74657374696e67313233")
     end
   end
+
+  describe "#to_bson_key" do
+
+    context "when validating keys" do
+
+      context "when validating globally" do
+
+        before do
+          BSON::Config.validating_keys = true
+        end
+
+        after do
+          BSON::Config.validating_keys = false
+        end
+
+        let(:validated) do
+          string.to_bson_key
+        end
+
+        it_behaves_like "a validated BSON key"
+      end
+
+      context "when validating locally" do
+
+        let(:validated) do
+          string.to_bson_key(true)
+        end
+
+        it_behaves_like "a validated BSON key"
+      end
+    end
+
+    context "when allowing invalid keys" do
+
+      let(:string) do
+        "$testing.testing"
+      end
+
+      it "allows invalid keys" do
+        expect(string.to_bson_key).to eq(string)
+      end
+    end
+  end
 end

data/spec/bson/symbol_spec.rb

@@ -43,4 +43,31 @@ describe Symbol do
       expect(symbol.to_bson_key).to eq(encoded)
     end
   end
+
+  describe "#to_bson_key" do
+
+    context "when validating keys" do
+
+      let(:symbol) do
+        :'$testing.testing'
+      end
+
+      it "raises an exception" do
+        expect {
+          symbol.to_bson_key(true)
+        }.to raise_error(BSON::String::IllegalKey)
+      end
+    end
+
+    context "when not validating keys" do
+
+      let(:symbol) do
+        :'$testing.testing'
+      end
+
+      it "allows invalid keys" do
+        expect(symbol.to_bson_key).to eq(symbol.to_s)
+      end
+    end
+  end
 end

data/spec/support/shared_examples.rb

@@ -96,3 +96,60 @@ shared_examples_for "a class which converts to Time" do
     expect(described_class.new.bson_type).to eq(Time::BSON_TYPE)
   end
 end
+
+shared_examples_for "a validated BSON key" do
+
+  context "when the string is valid" do
+
+    context "when the string has no invalid characters" do
+
+      let(:string) do
+        "testing"
+      end
+
+      it "returns the key" do
+        expect(validated).to eq(string)
+      end
+    end
+
+    context "when the string contains a $" do
+
+      let(:string) do
+        "te$ting"
+      end
+
+      it "returns the key" do
+        expect(validated).to eq(string)
+      end
+    end
+  end
+
+  context "when the string is invalid" do
+
+    context "when the string starts with $" do
+
+      let(:string) do
+        "$testing"
+      end
+
+      it "raises an exception" do
+        expect {
+          validated
+        }.to raise_error(BSON::String::IllegalKey)
+      end
+    end
+
+    context "when the string contains a ." do
+
+      let(:string) do
+        "testing.testing"
+      end
+
+      it "raises an exception" do
+        expect {
+          validated
+        }.to raise_error(BSON::String::IllegalKey)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 4.1.0
 platform: ruby
 authors:
 - Tyler Brock
@@ -16,7 +16,7 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRQwEgYDVQQDDAtkcml2
   ZXItcnVieTEVMBMGCgmSJomT8ixkARkWBTEwZ2VuMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMB4XDTE1MDMzMTA5NDIzNVoXDTE2MDMzMDA5NDIzNVowQjEUMBIGA1UEAwwL
+  Y29tMB4XDTE2MDQwODE0MTE0NVoXDTE3MDQwODE0MTE0NVowQjEUMBIGA1UEAwwL
   ZHJpdmVyLXJ1YnkxFTATBgoJkiaJk/IsZAEZFgUxMGdlbjETMBEGCgmSJomT8ixk
   ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANFdSAa8fRm1
   bAM9za6Z0fAH4g02bqM1NGnw8zJQrE/PFrFfY6IFCT2AsLfOwr1maVm7iU1+kdVI
@@ -27,14 +27,14 @@ cert_chain:
   u8KAcPHm5KkCAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
   BBYEFFt3WbF+9JpUjAoj62cQBgNb8HzXMCAGA1UdEQQZMBeBFWRyaXZlci1ydWJ5
   QDEwZ2VuLmNvbTAgBgNVHRIEGTAXgRVkcml2ZXItcnVieUAxMGdlbi5jb20wDQYJ
-  KoZIhvcNAQEFBQADggEBAH+jEbhVRjZke7ZgM3EjERSblLM8RtHZBczjQKuG0Eor
-  HUF/hyq7D+mz75Ch7K8m5NRwvppePbBV4lAF+DzuDGjh+V6cz4wNKaWWFIL8eNCY
-  F+0vDVtGok06CXnb2swHEtd1Z8zpQviJ3xpSGAvF88+glzvPQmCyA071kPUAmDvd
-  5og5x3Bv8IxaxmEpFndXhT3NHL/tOBeT9VJuJWMCxOXRCv4y9bBBTrxoRVuos59Z
-  XZOS48LlWh15EG4yZo/gRzqNAW2LUIkYA5eMS2Kp6r+KV8IBUO/LaHdrXbdilpa8
-  BRsuCo7UZDbFVRns04HLyjVvkj+K/ywIcdKdS0csz5M=
+  KoZIhvcNAQEFBQADggEBAKe478140EL5v2vJMjRSGCTtv9tD7jH7595aW267n9Tg
+  nuFFwHVC3cTz7xbWi8s7Dat3uC1qWhg7qPFjrF5QZymP7R3vC887XiXwJCnkilx4
+  tqIhdDCk/PU1G8RvS2GtCjxcDZLzr2sLNlqC1OCplJrL8YAY6vF8i46WKudH/189
+  HPLRJ8tx0aFZY7c6MO1NLqCtBs+wdB9sip7CvCA/w4Ly1MkLzVPXvzjkDJPwkoF1
+  yVPbgNJA2D/PnLe8ZFMhgJf+VIA1V4oybP/o+9aqlghTtNfYHJpRCAluUiaywwXl
+  KzD4mmIBpxtbWrWB3hx7tsVJmWx5zgO9aDAfvWnXfoo=
   -----END CERTIFICATE-----
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies: []
 description: A full featured BSON specification implementation, in Ruby
 email:
@@ -59,6 +59,7 @@ files:
 - lib/bson/boolean.rb
 - lib/bson/code.rb
 - lib/bson/code_with_scope.rb
+- lib/bson/config.rb
 - lib/bson/date.rb
 - lib/bson/date_time.rb
 - lib/bson/document.rb
@@ -91,6 +92,7 @@ files:
 - spec/bson/byte_buffer_spec.rb
 - spec/bson/code_spec.rb
 - spec/bson/code_with_scope_spec.rb
+- spec/bson/config_spec.rb
 - spec/bson/date_spec.rb
 - spec/bson/date_time_spec.rb
 - spec/bson/document_spec.rb
@@ -148,6 +150,7 @@ test_files:
 - spec/bson/byte_buffer_spec.rb
 - spec/bson/code_spec.rb
 - spec/bson/code_with_scope_spec.rb
+- spec/bson/config_spec.rb
 - spec/bson/date_spec.rb
 - spec/bson/date_time_spec.rb
 - spec/bson/document_spec.rb