mongo3 0.0.1

data/.bnignore

@@ -0,0 +1,3 @@
+*.log
+*.psd
+.git

data/.bnsignore

@@ -0,0 +1,16 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   PROJ.ignore_file = '.gitignore'
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/.gitignore

@@ -0,0 +1 @@
+*.psd

data/HISTORY

@@ -0,0 +1,2 @@
+0.0.1 - Initial Drop
+  not much there yet...

data/README.rdoc

@@ -0,0 +1,78 @@
+== Mongo3
+
+  Rule your mongoDB clusters!
+  A Sinatra based admin console for mongoDB
+  
+== DESCRIPTION:
+
+  Mongo3 allows you to manage your mongoDB clusters using a web based admin console.
+  The console provides for getting an overview of your mongo landscape and drilldown to
+  see various information about your databases. You will be able to manage your clusters
+  by performing common database admin tasks directly from the web console.
+  
+  The initial release of Mongo3 will be a read only shallow mode. Further development
+  still needs to take place to build up the functionality from the existing code base.
+
+== PROJECT INFORMATION
+
+* Developer:  Fernand Galiana
+* Site:       http://mongo3.com
+* Twitter:    http://twitter.com/mongo_3
+* Forum:      http://groups.google.com/group/mongo3
+
+== FEATURES:
+
+* Easily administer your mongo cluster information
+* Get a real time snapshot of what your configuration looks like
+* Drill down on clusters, databases, collections and indexes
+* Manage all mongo artifacts from a single web interface
+
+== ROAD MAP:
+
+* Provide support for db authentication
+* Ability to drilldown in collections and query for content
+* CRUD on dbs, collections, indexes, users
+* Support for managing shards and replication
+
+== INSTALL:
+  
+  sudo gem install mongo3
+  
+== USAGE:
+  
+=== Configure It!
+
+  You will need to give mongo3 some information about your mongo configuration. 
+  In order to do so create a .mongo3 directory in your home directory and create 
+  a file landscape.yml. You will need to specify the envs, host and ports specific
+  to your configuration, but here is a sample.
+  
+  landscape.yml  
+    development:
+      host: localhost
+      port: 27017
+    
+    beta:
+      host: beta_host_name
+      port: 27017
+    
+=== Launch It!
+
+    Launch it. Fires up sinatra and opens up the console  
+    > mongo3
+  
+== LICENSE:
+
+Copyright 2009-2010 LiquidRail LLC
+
+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. 

data/Rakefile

@@ -0,0 +1,31 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'mongo3'
+
+task :default => 'spec:run'
+
+PROJ.name        = 'mongo3'
+PROJ.authors     = 'Fernand Galiana'
+PROJ.email       = 'fernand.galiana@gmail.com'
+PROJ.url         = 'http://www.mongo3.com'
+PROJ.version     = Mongo3::VERSION
+PROJ.ruby_opts   = %w[-W0]
+PROJ.readme      = 'README.rdoc'
+PROJ.rcov.opts   = ["--sort", "coverage", "-T"]
+PROJ.ignore_file = "*.log"
+PROJ.spec.opts   << '--color'
+PROJ.rdoc.include = %w[.rb]

data/bin/mongo3

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'sinatra'
+require File.expand_path( File.join(File.dirname(__FILE__), %w[.. lib mongo3]))
+require File.join(File.dirname(__FILE__), %w[.. lib main.rb])
+
+def open(path)
+  case RUBY_PLATFORM
+    when /darwin/
+      system 'open', path
+    when /mswin(?!ce)|mingw|cygwin|bccwin/
+      system 'start', path
+    else
+      system 'firefox', path
+  end
+end
+
+Thread.new do 
+  puts "\n"*2
+  puts ">>> Waiting for Franky to warm up..."
+  puts "\n"*2  
+  sleep( 3 )
+  puts "\n"*2  
+  puts "\n\n >>> Opening console..."
+  puts "\n"*2
+  open( "http://localhost:6666/explore" )
+end
+
+Sinatra::Application.run! :port => 6666

data/config/mongo3.yml

@@ -0,0 +1,33 @@
+development:
+  :host: localhost
+  :port: 27017
+  
+beta:
+  :host:     dev8
+  :port:     27018
+  :user:     "blee"
+  :password: "fred"
+      
+# production:
+#   :host:     dev8
+#   :port:     27018
+#   :user:     "blee"
+#   :password: "fred"
+#   
+# serv1:
+#   :host:     dev8
+#   :port:     27018
+#   :user:     "blee"
+#   :password: "fred"  
+#   
+# serv2:
+#   :host:     dev8
+#   :port:     27018
+#   :user:     "blee"
+#   :password: "fred"    
+#   
+# serv3:
+#   :host:     dev8
+#   :port:     27018
+#   :user:     "blee"
+#   :password: "fred"

data/lib/controllers/collections.rb

@@ -0,0 +1,7 @@
+module Collections
+  
+  get "/cltns" do
+    puts "Cltns"
+  end
+  
+end

data/lib/controllers/databases.rb

@@ -0,0 +1,7 @@
+module Databases
+  
+  get "/dbs" do
+    puts "Dbs"
+  end
+  
+end

data/lib/controllers/explore.rb

@@ -0,0 +1,46 @@
+module Explore
+  
+  # -----------------------------------------------------------------------------
+  get '/explore' do
+    reset_crumbs!
+    @root = options.connection.build_tree
+    erb :explore
+  end
+
+  # -----------------------------------------------------------------------------
+  get '/explore/show/:path/:crumbs' do
+    path   = params[:path]
+    crumbs = params[:crumbs]
+    
+    @info = options.connection.show( path, crumbs )
+    
+    partial :info
+  end
+  
+  # -----------------------------------------------------------------------------
+  get '/explore/more_data/:path/:crumbs/*' do
+    path     = params[:path]
+    crumbs   = params[:crumbs]
+    
+    crumbs_from_path( path, crumbs )    
+    
+    @sub_tree = options.connection.build_sub_tree( path, crumbs )
+    @node_id  = @sub_tree.first[:id]
+    
+    erb :more_data_js, :layout => false
+  end
+
+  # -----------------------------------------------------------------------------
+  get '/explore/update_crumb/:path/:crumbs' do
+    crumbs_from_path( params[:path], params[:crumbs] )
+    erb :update_crumb_js, :layout => false
+  end
+  
+  # -----------------------------------------------------------------------------  
+  get '/explore/center/:node_id' do
+    @node_id = params[:node_id]    
+    pop_crumb!( @node_id )
+    erb :center_js, :layout => false
+  end
+      
+end

data/lib/helpers/crumb_helper.rb

@@ -0,0 +1,46 @@
+module CrumbHelper
+  
+  helpers do    
+    def crumbs_from_path( path, crumbs )
+      crumb_tokens  = crumbs.split( "|" )
+      path_tokens   = path.split( "|" )
+      
+      @crumbs = []
+      count   = 0
+      crumb_tokens.each do |crumb|
+        @crumbs << [crumb, "/explore/center/#{path_tokens[count]}"]
+        count += 1
+      end
+      session[:crumbs] = @crumbs
+    end
+    
+    def pop_crumb!( node_id )
+      level = 0
+      range = nil
+      path  = "/explore/center/#{node_id}"
+      @crumbs.each do |pair|
+        if pair.last == path
+          range = level
+          break
+        end
+        level += 1
+      end
+      @crumbs = ( range > 0 ? @crumbs[0..range] : [@crumbs[0]] )
+      session[:crumbs] = @crumbs
+    end
+  
+    def reset_crumbs!
+      @crumbs = [ ["home", '/explore/center/home'] ]
+      session[:crumbs] = @crumbs     
+    end
+  
+    def add_crumb( title, url )
+      titles = @crumbs.map{ |p| p.first }
+      unless titles.include?( title )        
+        @crumbs.pop if @crumbs.size == 3
+        @crumbs << [title, url]
+        session[:crumbs] = @crumbs
+      end
+    end
+  end
+end

data/lib/helpers/main_helper.rb

@@ -0,0 +1,43 @@
+module MainHelper
+
+  JS_ESCAPE_MAP = 
+  {
+    '\\'    => '\\\\',
+    '</'    => '<\/',
+    "\r\n"  => '\n',
+    "\n"    => '\n',
+    "\r"    => '\n',
+    '"'     => '\\"',
+    "'"     => "\\'" 
+  }
+  
+ helpers do   
+   
+    def display_info( info )
+      return info if info.is_a?( String )
+      if info.is_a?( Hash )
+        @info = info
+        partial :dump_hash
+      elsif info.is_a?( Array )
+        @info = info
+        partial :dump_array
+      else
+        info
+      end
+    end
+    
+    def partial( page, options={} )
+      erb "_#{page}".to_sym, options.merge!( :layout => false )
+    end
+   
+    def escape_javascript(javascript)
+      if javascript
+         javascript.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { JS_ESCAPE_MAP[$1] }
+      else
+         ''
+      end
+    end
+    
+  end
+  
+end

data/lib/main.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'sinatra'
+require 'forwardable'
+require File.join( File.dirname(__FILE__), 'mongo3.rb' )
+require 'mongo'
+
+set :public, File.join( File.dirname(__FILE__), %w[public] )
+set :views , File.join( File.dirname(__FILE__), %w[views] )
+
+# -----------------------------------------------------------------------------
+# Configuration
+configure do
+  Mongo3.load_all_libs_relative_to(__FILE__, 'helpers' )
+  Mongo3.load_all_libs_relative_to(__FILE__, 'controllers' )
+  
+  set :sessions  , true
+  set :connection, Mongo3::Connection.new( File.join( ENV['HOME'], %w[.mongo3 landscape.yml] ) )
+end
+
+# -----------------------------------------------------------------------------
+# Before filters
+before do
+  unless request.path =~ /\.[css gif png js]/
+    @crumbs = session[:crumbs] 
+    unless @crumbs
+      @crumbs = [ ['HOME', '/center'] ]
+      session[:crumbs] = @crumbs
+    end
+  end
+end
+
+# =============================================================================
+# Helpers
+helpers do
+        
+  # Convert size to mb
+  def to_mb( val )
+    return val if val < 1_000_000
+    "#{val/1_000_000}Mb"
+  end  
+end

data/lib/mongo3/connection.rb

@@ -0,0 +1,191 @@
+module Mongo3
+  class Connection
+    
+    def initialize( config_file )
+      @config_file = config_file
+    end
+        
+    # Connects to mongo given an environment
+    # BOZO !! Auth... 
+    # TODO - Need to close out connection via block
+    def connect_for( env, &block )
+      info = landscape[env]
+      puts ">>> Connecting for #{env} -- #{info[:host]}-#{info[:port]}"
+      con = Mongo::Connection.new( info[:host], info[:port] )
+      yield con
+      con.close()
+    end
+    
+    def show( path, crumbs )
+      path_tokens  = path.split( "|" )
+      crumb_tokens = crumbs.split( "|" )
+      info         = OrderedHash.new
+      env          = path_tokens[1]
+      
+      if path_tokens.size == 2
+        connect_for( env ) do |con|
+          info[:name]        = env
+          info[:host]        = con.host
+          info[:port]        = con.port
+          info[:databases]   = OrderedHash.new
+          con.database_info.sort { |a,b| b[1] <=> a[1] }.each { |e| info[:databases][e[0]] = to_mb( e[1] ) }
+          info[:server] = con.server_info
+        end
+      elsif path_tokens.size == 3
+        db_name = crumb_tokens.pop
+        connect_for( env ) do |con|
+          db = con.db( db_name )
+          info[:size] = to_mb( con.database_info[db_name] )
+          info[:node] = db.nodes
+          info[:collections] = db.collection_names.size
+          info[:error]       = db.error
+          info[:last_status] = db.last_status
+        end
+      elsif path_tokens.size == 4
+        cltn_name = crumb_tokens.pop
+        db_name   = crumb_tokens.pop
+        connect_for( env ) do |con|
+          db = con.db( db_name )
+          cltn = db[cltn_name]
+          info[:size] = cltn.count
+          
+          indexes = db.index_information( cltn_name )          
+          info[:indexes] = format_indexes( db.index_information( cltn_name ) ) if indexes and !indexes.empty?
+        end
+      end
+      
+      info
+    end
+        
+    def format_indexes( indexes )
+      formatted = {}
+      indexes.each_pair do |key, values|
+        buff = []
+        values.each do |pair|
+          buff << "#{pair.first} [#{pair.last}]"
+        end
+        formatted[key] = buff
+      end  
+      formatted    
+    end
+    
+    # Fetch the environment landscape from the config file
+    def landscape
+      config
+    end
+
+    # db request occurs within dist 2
+    def db_request?( path )
+      path.size == 2
+    end
+    
+    # cltn request occurs within dist 3
+    def cltn_request?( path )
+      path.size == 3
+    end
+
+    # Build environment tree
+    def build_tree
+      root = Node.new( "home", "home", :path => 'home', :crumbs => 'home' )
+      
+      # iterate thru envs
+      id = 1
+      config.each_pair do |env, info|
+        node = Node.new( env, env, :dyna => true )
+        root << node
+        id += 1
+      end
+      root
+    end
+    
+    # Build an appropriate subtree based on requested item
+    def build_sub_tree( path, crumbs )
+      path_tokens  = path.split( "|" )
+      crumb_tokens = crumbs.split( "|" )
+      parent_id    = path_tokens.last
+      db_name      = crumb_tokens.last
+      
+      if db_request?( path_tokens )
+        sub_tree = build_db_tree( parent_id, db_name )
+      else
+        env = crumb_tokens[1]
+        sub_tree = build_cltn_tree( parent_id, env, db_name )
+      end
+      sub_tree.to_adjacencies
+    end
+    
+    
+    # Connects to host and spews out all available dbs
+    # BOZO !! Need to deal with Auth?
+    def build_db_tree( parent_id, env )
+      sub_root = nil
+      connect_for( env ) do |con|      
+        root = Node.new( "home", "home" )
+        sub_root = Node.new( parent_id, env )
+      
+        root << sub_root
+      
+        count = 0
+        data  = { :dyna => true }
+        # excludes = %w[admin local]
+        con.database_names.each do |db_name|
+          # next if excludes.include?( db_name )
+          db    = con.db( db_name, :strict => true )
+          cltns = db.collection_names.size  
+          node  = Node.new( "#{env}_#{count}", "#{db_name}(#{cltns})", data.clone )
+          sub_root << node
+          count += 1
+        end
+      end
+      sub_root
+    end
+    
+    # Show collections
+    def build_cltn_tree( parent_id, env, db_name ) 
+      sub_root = nil
+      connect_for( env ) do |con|
+        db        = con.db( db_name )      
+        root      = Node.new( "home", "home" )
+        env_node  = Node.new( env, env )
+        sub_root  = Node.new( parent_id, db_name )
+        root     << env_node
+        env_node << sub_root
+      
+        count = 0
+        # excludes = %w[system.indexes]
+        data = { :dyna => false }
+        db.collection_names.each do |cltn_name|
+          # next if excludes.include?( cltn_name )
+          size = db[cltn_name].count
+          node = Node.new( "#{db_name}_#{count}", "#{cltn_name}(#{size})", data.clone )
+          sub_root << node
+          count += 1
+        end
+      end
+      sub_root
+    end
+    
+    # =========================================================================
+    private
+   
+      # Convert size to mb
+      def to_mb( val )
+        return val if val < 1_000_000
+        "#{format_number(val/1_000_000)}Mb"
+      end
+   
+      # Add thousand markers
+      def format_number( numb )
+        numb.to_s.gsub(/(\d)(?=\d{3}+(\.\d*)?$)/, '\1,')
+      end
+        
+      # Initialize the mongo installation landscape
+      def config
+        unless @config
+          @config = YAML.load_file( @config_file )
+        end
+        @config
+      end
+            
+  end
+end

data/lib/mongo3/node.rb

@@ -0,0 +1,80 @@
+require 'json'
+
+module Mongo3
+  class Node
+    attr_accessor :oid, :name, :children, :data, :parent
+    
+    def initialize( oid, name, data={} )
+      @oid      = oid
+      @name     = name
+      @children = []
+      @data     = data || {}
+      @parent   = nil
+    end
+    
+    # Add a child node
+    def <<( new_one )
+      new_one.parent = self
+      @children << new_one
+      update_paths( new_one )
+    end
+
+    def update_paths( node )
+      node.data[:crumbs] = node.path( :name )
+      node.data[:path]   = node.path
+      node.children.each do |child|
+        child.update_paths( child )
+      end
+    end  
+      
+    # convert a tree node to a set of adjacencies
+    def to_adjacencies
+      root_level = { :id => self.oid, :name => self.name, :data => self.data, :adjacencies => [] } 
+      cltn = [ root_level ]
+      self.children.each do |child|
+        root_level[:adjacencies] << child.oid
+        cltn << { :id => child.oid, :name => child.name, :data => child.data, :adjacencies => [] } 
+      end
+      cltn
+    end
+    
+    def path( accessor=:oid )
+      path = []
+      traverse( path, self, accessor )
+      path.reverse.join( "|" )
+    end
+    
+    def traverse( path, node, accessor )
+      path << node.send( accessor ).gsub( /\(\d+\)/, "" )
+      if node.parent
+        traverse( path, node.parent, accessor )
+      end
+    end
+    
+    # converts to json
+    def to_json(*a)
+      {
+        'id'         => oid,
+        'name'       => self.name,
+        'children'   => self.children,
+        'data'       => self.data
+      }.to_json(*a)
+    end
+
+    # Debug...
+        
+    # Dump nodes to stdout
+    def self.dump( node, level=0 )
+      puts '  '*level + "%-#{20-level}s (%d) [%s] -- %s" % [node.oid, node.children.size, node.name, (node.data ? node.data.inspect : 'N/A' )]
+      node.children.each { |c| dump( c, level+1 ) }
+    end
+
+    # Dump adjancencies to stdout
+    def self.dump_adj( adjs, level = 0 )
+      adjs.each do |adj|   
+        puts '  '*level + "%-#{20-level}s (%d) [%s] -- %s" % [adj[:id], adj[:adjacencies].size, adj[:name], (adj[:data] ? adj[:data].inspect : 'N/A' )]
+      end
+    end
+    
+  end
+end