Building Ruby MongoDB Driver

The instructions provided below specify the steps to build MongoDB Ruby Driver version 2.5.1 on Linux on IBM Z for following distributions:

• RHEL (6.10, 7.3, 7.4, 7.5)
• SLES (12 SP3, 15)
• Ubuntu (16.04, 18.04)

General Notes:

• When following the steps below please use a standard permission user unless otherwise specified.
• A directory /<source_root>/ will be referred to in these instructions, this is a temporary writeable directory anywhere you'd like to place it
• For convenience vi has been used in the instructions below when editing files, replace with your desired editing program if required

1. Install the build dependencies

   • RHEL (6.10, 7.3, 7.4, 7.5)

     sudo yum install ruby ruby-devel make gcc gcc-c++
     

   • SLES (12 SP3, 15)

     sudo zypper install ruby ruby-devel make gcc gcc-c++
     

   • Ubuntu (16.04, 18.04)

     sudo apt-get update
     sudo apt-get install ruby ruby-dev make gcc g++
     

You may already have some of these packages installed - just install any that are missing.

2. Build Ruby from source (only for RHEL 6.10)

   Ruby MongoDB Driver 2.x requires Ruby version >= 1.9.3. Instructions for building Ruby 2.5.1 are available here.

3. Correct the gem environment for a standard user

   export GEM_HOME=/home/<USER>/.gem/ruby
   export PATH=/home/<USER>/.gem/ruby/bin:$PATH

   Where <USER> is the standard user you are installing under.
   Note: Run gem env to verify the state of the environment, if later on you have issues installing / running ruby gems please ensure the environment is set correctly.

4. Install the mongo gem (and dependent bson gem)

   For the 2.5.1 version install mongo gem as given below:

    gem install mongo -v 2.5.1

   Note: If the -v flag is omitted entirely the latest version will be installed

Basic validation test

The example code section given below is used to perform a basic test to ensure that the MongoDB Ruby Driver is working as expected, and can connect to, modify and query a MongoDB server.

1. Prerequisites

   The MongoDB Driver needs access to a running MongoDB Server, either on your local server or a remote system. The following commands are an example of how to start up a MongodDB server and then connect to it with the client shell, but note that MongoDB has not been installed as part of these instructions, and typically you would be running MongoDB on a remote server.

   mongod > /tmp/mongodb.log &
   mongo --host localhost 

   Which would typically give a command prompt such as:

   MongoDB shell version: 3.6.2 connecting to: localhost:27017/test > 

   The example code below will need to be modified to use your remote server hostname or IP address instead of "localhost", if you are attempting to connect to your own (remote) server.

2. The Test Code

   Create a file named test.rb with the content shown below. This code connects to a MongoDB server, inserts some documents and then queries the database to read them back and display them.

   Remember, if you are connecting to a remote server then you need to substitute the localhost with the hostname or IP address of the MongoDB server.

   Mongo Ruby Driver 2.5.1

    require 'mongo'
   
    server="localhost"
    test_db='ibm_test_db'
    collection='mongodb_ruby_driver_2_x'
   
    server_addr=server + ":27017"
   
    Mongo::Logger.logger.level = ::Logger::FATAL   # hide DEBUG logging
   
    db = Mongo::Client.new([ server_addr ], :database => test_db)
   
    db[:collection].drop
   
    result = db[:collection].insert_one({ company: 'IBM' , project: 'MongoDB Driver', language: 'Ruby', version: '2.5.1'})
   
    3.times { |i| db[:collection].insert_one({ _id: i+1, line: i+1 }) }
   
    db[:collection].find().each do |document|
       printf("%s\n", document) #=> Yields a BSON::Document.
    end

   Execute the test program by:

   export GEM_HOME=~/.gem/ruby
   ruby test.rb

   Executing the test program should produce output similar to this (the Object Ids will vary, but typically will be consecutive):

   {"_id"=>BSON::ObjectId('000002aafe4122006d000002'), "company"=>"IBM", "project"=>"MongoDB Driver", "language"=>"Ruby", "version"=>"2.5.1"}
   {"_id"=>1, "line"=>1}
   {"_id"=>2, "line"=>2}
   {"_id"=>3, "line"=>3}