bson 4.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31e82028a4dbdd0ee59ad09a19bc8d1dac7c3fcd
-  data.tar.gz: 9773de56e955e3b0545804de618692bcd9bd74b7
+SHA256:
+  metadata.gz: f383730000f9b08a131535250a7855d8ec8dcb0e3bb334f4779dcdcc95b56023
+  data.tar.gz: 57cb5e6db027b6982263d4f4eb0228968b6fc71e6b6499ef5563c0a160a3b2b0
 SHA512:
-  metadata.gz: 8fb4637938de67b08963c79e02aef0e32050e27229c17cd09bb1d0c69072f528f861fdd0759b46ec9ed70353ebcc6f55e32530b30e8cba5f76445338ab8f0903
-  data.tar.gz: cdac6674f943e86cfe45e5742a9a361a3cc83ba5222ca82c5bf4b5ac50c7a43f8e70aa2804c63d233c6c2c2461627f116c63aee9c6c37e7a26ce9c67dcccf282
+  metadata.gz: 433d3758ccd6ad9222b98bf43a4746b71b5966d6eb01321dff869eca61acef89e58b42baae0bd9c979d41cc922b4baf227ae0b71fdc4f21d37b0d3ec7137a85b
+  data.tar.gz: 7f61000684c0acb7af4d2d50c3e2cbc1e47ab342c415fc91addf7e1c5533cb3e23cfe4d16ba2ccd5dea72d70d8a89698eec3f4520fee3320c3c64c7aec95f10d

data/README.md

@@ -1,38 +1,132 @@
-BSON [![Build Status](https://secure.travis-ci.org/mongodb/bson-ruby.png?branch=master&.png)](http://travis-ci.org/mongodb/bson-ruby)  [![Code Climate](https://codeclimate.com/github/mongodb/bson-ruby.png)](https://codeclimate.com/github/mongodb/bson-ruby) [![Coverage Status](https://coveralls.io/repos/mongodb/bson-ruby/badge.png?branch=master)](https://coveralls.io/r/mongodb/bson-ruby?branch=master) [![Inline docs](http://inch-ci.org/github/mongodb/bson-ruby.svg?branch=master)](http://inch-ci.org/github/mongodb/bson-ruby)
+BSON
+[![Gem Version][rubygems-img]][rubygems-url]
+[![Build Status][ghactions-img]][ghactions-url]
 ====
 
 An implementation of the BSON specification in Ruby.
 
+Installation
+------------
+
+BSON can be installed via RubyGems:
+
+```
+> gem install bson
+```
+
+Or by adding it to your project's Gemfile:
+
+```ruby
+gem 'bson'
+```
+
+### Release Integrity
+
+Each release of the BSON library for Ruby after version 5.0.0 has been automatically built and signed using the team's GPG key.
+
+To verify the bson gem file:
+
+1. [Download the GPG key](https://pgp.mongodb.com/ruby-driver.asc).
+2. Import the key into your GPG keyring with `gpg --import ruby-driver.asc`.
+3. Download the gem file (if you don't already have it). You can download it from RubyGems with `gem fetch bson`, or you can download it from the [releases page](https://github.com/mongodb/bson-ruby/releases) on GitHub.
+4. Download the corresponding detached signature file from the [same release](https://github.com/mongodb/bson-ruby/releases). Look at the bottom of the release that corresponds to the gem file, under the 'Assets' list, for a `.sig` file with the same version number as the gem you wish to install.
+5. Verify the gem with `gpg --verify bson-X.Y.Z.gem.sig bson-X.Y.Z.gem` (replacing `X.Y.Z` with the actual version number).
+
+You are looking for text like "Good signature from "MongoDB Ruby Driver Release Signing Key <packaging@mongodb.com>" in the output. If you see that, the signature was found to correspond to the given gem file.
+
+(Note that other output, like "This key is not certified with a trusted signature!", is related to *web of trust* and depends on how strongly you, personally, trust the `ruby-driver.asc` key that you downloaded from us. To learn more, see https://www.gnupg.org/gph/en/manual/x334.html)
+
+### Why not use RubyGems' gem-signing functionality?
+
+RubyGems' own gem signing is problematic, most significantly because there is no established chain of trust related to the keys used to sign gems. RubyGems' own documentation admits that "this method of signing gems is not widely used" (see https://guides.rubygems.org/security/). Discussions about this in the RubyGems community have been off-and-on for more than a decade, and while a solution will eventually arrive, we have settled on using GPG instead for the following reasons:
+
+1. Many of the other driver teams at MongoDB are using GPG to sign their product releases. Consistency with the other teams means that we can reuse existing tooling for our own product releases.
+2. GPG is widely available and has existing tools and procedures for dealing with web of trust (though they are admittedly quite arcane and intimidating to the uninitiated, unfortunately).
+
+Ultimately, most users do not bother to verify gems, and will not be impacted by our choice of GPG over RubyGems' native method.
+
 Compatibility
 -------------
 
-BSON is tested against MRI (1.9.2+), JRuby (1.7.0+) and Rubinius (2.0.0+).
+BSON is tested against MRI (2.7+) and JRuby (9.3+).
 
 Documentation
 -------------
 
-Current documentation can be found [here](http://docs.mongodb.org/ecosystem/tutorial/ruby-bson-tutorial/#ruby-bson-tutorial)
+Current documentation can be found
+[here](https://www.mongodb.com/docs/ruby-driver/current/bson-tutorials/).
 
 API Documentation
 -----------------
 
-The [API Documentation](http://rdoc.info/github/mongodb/bson-ruby/master/frames) is
-located at rdoc.info.
+The [API Documentation](https://www.mongodb.com/docs/ruby-driver/master/api/) is
+located at mongodb.com/docs.
 
 BSON Specification
 ------------------
 
 The [BSON specification](http://bsonspec.org) is at bsonspec.org.
 
+## Bugs & Feature Requests
+
+To report a bug in the `bson` gem or request a feature:
+
+1. Visit [our issue tracker](https://jira.mongodb.org/) and login
+   (or create an account if you do not have one already).
+2. Navigate to the [RUBY project](https://jira.mongodb.org/browse/RUBY).
+3. Click 'Create Issue' and fill out all of the applicable form fields, making
+sure to select `BSON` in the _Component/s_ field.
+
+When creating an issue, please keep in mind that all information in JIRA
+for the RUBY project, as well as the core server (the SERVER project),
+is publicly visible.
+
+**PLEASE DO:**
+
+- Provide as much information as possible about the issue.
+- Provide detailed steps for reproducing the issue.
+- Provide any applicable code snippets, stack traces and log data.
+- Specify version numbers of the `bson` gem and/or Ruby driver and MongoDB 
+server.
+
+**PLEASE DO NOT:**
+
+- Provide any sensitive data or server logs.
+- Report potential security issues publicly (see 'Security Issues' below).
+
+## Security Issues
+
+If you have identified a potential security-related issue in the `bson` gem
+(or any other MongoDB product), please report it by following the
+[instructions here](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
+
+## Product Feature Requests
+
+To request a feature which is not specific to the `bson` gem, or which
+affects more than the `bson` gem and/or Ruby driver alone (for example, a 
+feature which requires MongoDB server support), please submit your idea through 
+the [MongoDB Feedback Forum](https://feedback.mongodb.com/forums/924286-drivers).
+
+## Maintenance and Bug Fix Policy
+
+New library functionality is generally added in a backwards-compatible manner
+and results in new minor releases. Bug fixes are generally made on
+master first and are backported to the current minor library release. Exceptions
+may be made on a case-by-case basis, for example security fixes may be
+backported to older stable branches. Only the most recent minor release
+is officially supported. Customers should use the most recent release in
+their applications.
+
 Versioning
 ----------
 
-As of 2.0.0, this project adheres to the [Semantic Versioning Specification](http://semver.org/).
+As of 2.0.0, this project adheres to the
+[Semantic Versioning Specification](http://semver.org/).
 
 License
 -------
 
-Copyright (C) 2009-2016 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.
@@ -45,3 +139,8 @@ 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.
+
+[rubygems-img]: https://badge.fury.io/rb/bson.svg
+[rubygems-url]: http://badge.fury.io/rb/bson
+[ghactions-img]: https://github.com/mongodb/bson-ruby/actions/workflows/bson-ruby.yml/badge.svg?query=branch%3Amaster
+[ghactions-url]: https://github.com/mongodb/bson-ruby/actions/workflows/bson-ruby.yml?query=branch%3Amaster

data/Rakefile

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
 # Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,6 +23,11 @@ $LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
 require "rake"
 require "rake/extensiontask"
 require "rspec/core/rake_task"
+require 'fileutils'
+
+if File.exist?('./spec/shared/lib/tasks/candidate.rake')
+  load './spec/shared/lib/tasks/candidate.rake'
+end
 
 def jruby?
   defined?(JRUBY_VERSION)
@@ -31,45 +39,40 @@ if jruby?
     ext.name = "bson-ruby"
     ext.ext_dir = "src"
     ext.lib_dir = "lib"
+    ext.target_version = ENV['TARGET_VERSION'] if ENV['TARGET_VERSION']
+    ext.source_version = ENV['SOURCE_VERSION'] if ENV['SOURCE_VERSION']
   end
 else
   require "rake/extensiontask"
   Rake::ExtensionTask.new do |ext|
-    ext.name = "native"
+    ext.name = "bson_native"
     ext.ext_dir = "ext/bson"
     ext.lib_dir = "lib"
   end
 end
 
-require "bson/version"
+RSpec::Core::RakeTask.new(:rspec)
 
-def extension
-  RUBY_PLATFORM =~ /darwin/ ? "bundle" : "so"
+desc 'Build the bson gem'
+task :build => [ :clean_all, *(jruby? ? :compile : nil) ] do
+  command = [ 'gem', 'build' ]
+  command << "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
+  command << ENV['GEMSPEC'] || 'bson.gemspec'
+  system(*command)
 end
 
-require_relative "perf/bench"
-
-RSpec::Core::RakeTask.new(:rspec)
-
-if jruby?
-  task :build => [ :clean_all, :compile ] do
-    system "gem build bson.gemspec"
-  end
-else
-  task :build => :clean_all do
-    system "gem build bson.gemspec"
-  end
+# `rake version` is used by the deployment system so get the release version
+# of the product beng deployed. It must do nothing more than just print the
+# product version number.
+desc 'Print the current version of the Ruby-BSON library'
+task :version do
+  require 'bson/version'
+  puts BSON::VERSION
 end
 
 task :clean_all => :clean do
-  begin
-    Dir.chdir(Pathname(__FILE__).dirname + "lib") do
-      `rm native.#{extension}`
-      `rm native.o`
-      `rm bson-ruby.jar`
-    end
-  rescue Exception => e
-    puts e.message
+  %w[ bson-ruby.jar bson_native.bundle bson_native.so bson_native.o ].each do |file|
+    FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', file))
   end
 end
 
@@ -77,37 +80,77 @@ task :spec => :compile do
   Rake::Task["rspec"].invoke
 end
 
-# Run bundle exec rake release with mri and jruby. Ex:
-#
-# rvm use 2.1.0@bson
-# bundle exec rake release
-# rvm use jruby@bson
-# bundle exec rake release
-task :release => :build do
-  system "git tag -a v#{BSON::VERSION} -m 'Tagging release: #{BSON::VERSION}'"
-  system "git push --tags"
-  if jruby?
-    system "gem push bson-#{BSON::VERSION}-java.gem"
-    system "rm bson-#{BSON::VERSION}-java.gem"
-  else
-    system "gem push bson-#{BSON::VERSION}.gem"
-    system "rm bson-#{BSON::VERSION}.gem"
+# overrides the default Bundler-provided `release` task, which also
+# builds the gem. Our release process assumes the gem has already
+# been built (and signed via GPG), so we just need `rake release` to
+# push the gem to rubygems.
+task :release do
+  if ENV['GITHUB_ACTION'].nil?
+    abort <<~WARNING
+      `rake release` must be invoked from the `BSON Release` GitHub action,
+      and must not be invoked locally. This ensures the gem is properly signed
+      and distributed by the appropriate user.
+
+      Note that it is the `rubygems/release-gem@v1` step in the `BSON Release`
+      action that invokes this task. Do not rename or remove this task, or the
+      release-gem step will fail. Reimplement this task with caution.
+
+      NO GEMS were pushed to RubyGems.
+    WARNING
+  end
+
+  # confirm: there ought to be two gems, one for MRI, and one for Java. These
+  # will have been previously generated by the 'build' job.
+  gems = Dir['*.gem']
+  if gems.length != 2
+    abort "Expected two gem files to be ready to release; got #{gems.inspect}"
+  end
+
+  gems.each do |gem|
+    system 'gem', 'push', gem
   end
 end
 
 namespace :benchmark do
 
-  task :ruby => :clean_all do
+  task :prep do
+    require_relative "perf/bench"
+  end
+
+  task ruby: [ :clean_all, 'benchmark:prep' ] do
     puts "Benchmarking pure Ruby..."
-    require "bson"
     benchmark!
   end
 
-  task :native => :compile do
+  task native: [ :compile, 'benchmark:prep' ] do
     puts "Benchmarking with native extensions..."
-    require "bson"
     benchmark!
   end
+
+  namespace :decimal128 do
+    task from_string: 'benchmark:prep' do
+      puts "Benchmarking creating Decimal128 objects from a string"
+      benchmark_decimal128_from_string!
+    end
+
+    task to_string: 'benchmark:prep' do
+      puts "Benchmarking getting a string representation of a Decimal128"
+      benchmark_decimal128_to_string!
+    end
+  end
 end
 
 task :default => [ :clean_all, :spec ]
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    require 'bson/version'
+    out = File.join('yard-docs', BSON::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title bson-#{BSON::VERSION}"
+  end
+end

data/ext/bson/{native-endian.h → bson-endian.h}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 MongoDB, Inc.
+ * Copyright (C) 2015-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.
@@ -35,13 +35,14 @@
 # endif
 #endif
 
-#ifndef BSON_BYTE_ORDER
-# if BYTE_ORDER == LITTLE_ENDIAN
-#  define BSON_BYTE_ORDER 1234
-# elif BYTE_ORDER == BIG_ENDIAN
-#  define BSON_BYTE_ORDER 4321
-# endif
-#endif
+/* See a similar check in ruby's sha2.h */
+# ifndef BSON_BYTE_ORDER
+#  ifdef WORDS_BIGENDIAN
+#   define BSON_BYTE_ORDER	BSON_BIG_ENDIAN
+#  else
+#   define BSON_BYTE_ORDER	BSON_LITTLE_ENDIAN
+#  endif
+# endif /* BSON_BYTE_ORDER */
 
 #if defined(__sun)
 # define BSON_UINT16_SWAP_LE_BE(v) __bson_uint16_swap_slow((uint16_t)v)
@@ -59,7 +60,7 @@
 #  define BSON_UINT64_SWAP_LE_BE(v) __builtin_bswap64(v)
 # endif
 #elif defined(__GNUC__) && (__GNUC__ >= 4)
-# if __GNUC__ >= 4 && defined (__GNUC_MINOR__) && __GNUC_MINOR__ >= 3
+# if __GNUC__ > 4 || (defined (__GNUC_MINOR__) && __GNUC_MINOR__ >= 3)
 #  define BSON_UINT32_SWAP_LE_BE(v) __builtin_bswap32 ((uint32_t)v)
 #  define BSON_UINT64_SWAP_LE_BE(v) __builtin_bswap64 ((uint64_t)v)
 # endif
@@ -105,101 +106,7 @@
 # error "The endianness of target architecture is unknown."
 #endif
 
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_uint16_swap_slow --
- *
- *       Fallback endianness conversion for 16-bit integers.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static uint16_t __bson_uint16_swap_slow(uint16_t v)
-{
-   return ((v & 0x00FF) << 8) |
-          ((v & 0xFF00) >> 8);
-}
-
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_uint32_swap_slow --
- *
- *       Fallback endianness conversion for 32-bit integers.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static uint32_t __bson_uint32_swap_slow(uint32_t v)
-{
-   return ((v & 0x000000FFU) << 24) |
-          ((v & 0x0000FF00U) <<  8) |
-          ((v & 0x00FF0000U) >>  8) |
-          ((v & 0xFF000000U) >> 24);
-}
-
-
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_uint64_swap_slow --
- *
- *       Fallback endianness conversion for 64-bit integers.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static uint64_t __bson_uint64_swap_slow(uint64_t v)
-{
-   return ((v & 0x00000000000000FFULL) << 56) |
-          ((v & 0x000000000000FF00ULL) << 40) |
-          ((v & 0x0000000000FF0000ULL) << 24) |
-          ((v & 0x00000000FF000000ULL) <<  8) |
-          ((v & 0x000000FF00000000ULL) >>  8) |
-          ((v & 0x0000FF0000000000ULL) >> 24) |
-          ((v & 0x00FF000000000000ULL) >> 40) |
-          ((v & 0xFF00000000000000ULL) >> 56);
-}
-
-/*
- *--------------------------------------------------------------------------
- *
- * __bson_double_swap_slow --
- *
- *       Fallback endianness conversion for double floating point.
- *
- * Returns:
- *       The endian swapped version.
- *
- * Side effects:
- *       None.
- *
- *--------------------------------------------------------------------------
- */
-static double __bson_double_swap_slow(double v)
-{
-   uint64_t uv;
-
-   memcpy(&uv, &v, sizeof(v));
-   uv = BSON_UINT64_SWAP_LE_BE(uv);
-   memcpy(&v, &uv, sizeof(v));
-
-   return v;
-}
-
+uint16_t __bson_uint16_swap_slow(uint16_t v);
+uint32_t __bson_uint32_swap_slow(uint32_t v);
+uint64_t __bson_uint64_swap_slow(uint64_t v);
+double __bson_double_swap_slow(double v);

data/ext/bson/bson-native.h

@@ -0,0 +1,135 @@
+/*
+ * 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.
+ * 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.
+ */
+
+#include <ruby.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <time.h>
+#include "bson-endian.h"
+
+void
+rb_bson_utf8_validate (const char *utf8, /* IN */
+                    size_t utf8_len,  /* IN */
+                    bool allow_null, /* IN */
+                    const char *data_type);  /* IN */
+
+#define BSON_BYTE_BUFFER_SIZE 1024
+
+#ifndef HOST_NAME_HASH_MAX
+#define HOST_NAME_HASH_MAX 256
+#endif
+
+/* See the type list in http://bsonspec.org/spec.html. */
+#define BSON_TYPE_DOUBLE        1
+#define BSON_TYPE_STRING        2
+#define BSON_TYPE_DOCUMENT      3
+#define BSON_TYPE_ARRAY         4
+#define BSON_TYPE_BOOLEAN       8
+#define BSON_TYPE_SYMBOL        0x0E
+#define BSON_TYPE_INT32         0x10
+#define BSON_TYPE_INT64         0x12
+
+typedef struct {
+  size_t size;
+  size_t write_position;
+  size_t read_position;
+  char   buffer[BSON_BYTE_BUFFER_SIZE];
+  char   *b_ptr;
+} byte_buffer_t;
+
+#define READ_PTR(byte_buffer_ptr) \
+  (byte_buffer_ptr->b_ptr + byte_buffer_ptr->read_position)
+
+#define READ_SIZE(byte_buffer_ptr) \
+  (byte_buffer_ptr->write_position - byte_buffer_ptr->read_position)
+
+#define WRITE_PTR(byte_buffer_ptr) \
+  (byte_buffer_ptr->b_ptr + byte_buffer_ptr->write_position)
+
+#define ENSURE_BSON_WRITE(buffer_ptr, length) \
+  { if (buffer_ptr->write_position + length > buffer_ptr->size) rb_bson_expand_buffer(buffer_ptr, length); }
+
+#define ENSURE_BSON_READ(buffer_ptr, length) \
+  { if (buffer_ptr->read_position + length > buffer_ptr->write_position) \
+    rb_raise(rb_eRangeError, "Attempted to read %zu bytes, but only %zu bytes remain", (size_t)length, READ_SIZE(buffer_ptr)); }
+
+VALUE rb_bson_byte_buffer_allocate(VALUE klass);
+VALUE rb_bson_byte_buffer_initialize(int argc, VALUE *argv, VALUE self);
+VALUE rb_bson_byte_buffer_length(VALUE self);
+VALUE rb_bson_byte_buffer_get_byte(VALUE self);
+VALUE rb_bson_byte_buffer_get_bytes(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_get_cstring(VALUE self);
+VALUE rb_bson_byte_buffer_get_decimal128_bytes(VALUE self);
+VALUE rb_bson_byte_buffer_get_double(VALUE self);
+VALUE rb_bson_byte_buffer_get_int32(VALUE self);
+VALUE rb_bson_byte_buffer_get_uint32(VALUE self);
+VALUE rb_bson_byte_buffer_get_int64(VALUE self);
+VALUE rb_bson_byte_buffer_get_string(VALUE self);
+VALUE rb_bson_byte_buffer_get_hash(int argc, VALUE *argv, VALUE self);
+VALUE rb_bson_byte_buffer_get_array(int argc, VALUE *argv, VALUE self);
+VALUE rb_bson_byte_buffer_put_byte(VALUE self, VALUE byte);
+VALUE rb_bson_byte_buffer_put_bytes(VALUE self, VALUE bytes);
+VALUE rb_bson_byte_buffer_put_cstring(VALUE self, VALUE string);
+VALUE rb_bson_byte_buffer_put_decimal128(VALUE self, VALUE low, VALUE high);
+VALUE rb_bson_byte_buffer_put_double(VALUE self, VALUE f);
+VALUE rb_bson_byte_buffer_put_int32(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_put_uint32(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_put_int64(VALUE self, VALUE i);
+VALUE rb_bson_byte_buffer_put_string(VALUE self, VALUE string);
+VALUE rb_bson_byte_buffer_put_symbol(VALUE self, VALUE symbol);
+VALUE rb_bson_byte_buffer_put_hash(VALUE self, VALUE hash);
+VALUE rb_bson_byte_buffer_put_array(VALUE self, VALUE array);
+VALUE rb_bson_byte_buffer_read_position(VALUE self);
+VALUE rb_bson_byte_buffer_replace_int32(VALUE self, VALUE index, VALUE i);
+VALUE rb_bson_byte_buffer_rewind(VALUE self);
+VALUE rb_bson_byte_buffer_write_position(VALUE self);
+VALUE rb_bson_byte_buffer_to_s(VALUE self);
+
+VALUE rb_bson_object_id_generator_next(int argc, VALUE* args, VALUE self);
+VALUE rb_bson_object_id_generator_reset_counter(int argc, VALUE* args, VALUE self);
+
+size_t rb_bson_byte_buffer_memsize(const void *ptr);
+void rb_bson_byte_buffer_free(void *ptr);
+void rb_bson_expand_buffer(byte_buffer_t* buffer_ptr, size_t length);
+void rb_bson_generate_machine_id(VALUE rb_md5_class, char *rb_bson_machine_id);
+
+VALUE pvt_const_get_2(const char *c1, const char *c2);
+VALUE pvt_const_get_3(const char *c1, const char *c2, const char *c3);
+
+#define BSON_MODE_DEFAULT       0
+#define BSON_MODE_BSON          1
+
+int pvt_get_mode_option(int argc, VALUE *argv);
+
+#define BSON_OBJECT_ID_RANDOM_VALUE_LENGTH  ( 5 )
+
+uint8_t* pvt_get_object_id_random_value();
+void pvt_init_rand();
+void pvt_rand_buf(uint8_t* bytes, int len, int pid);
+int pvt_rand();
+
+/**
+ * The counter for incrementing object ids.
+ */
+extern uint32_t rb_bson_object_id_counter;
+
+extern VALUE rb_bson_registry;
+
+extern const rb_data_type_t rb_byte_buffer_data_type;
+
+extern VALUE _ref_str, _id_str, _db_str;