mongo_web 0.0.1 → 0.0.2

data/README.markdown

@@ -1,7 +1,7 @@
-Mongo_Web
+MongoWeb
 ========
 
-Mongo_Web is the stylish way of inspecting MongoDB databases.
+MongoWeb is the stylish way of inspecting MongoDB databases.
 
 Installing
 ----------
@@ -15,17 +15,29 @@ Starting MongoWeb is simple
 
     $ mongo-web
 
-You can also pass it a specific port
+You can also pass it a specific port for the MongoWeb web server
 
     $ mongo-web -p 6969
+    
+You can connect to remote databases as well
+
+    $ mongo-web [DATABASE CONNECTION STRING] --mongo-username USERNAME --mongo-password PASSWORD
+
+Valid connection strings are
+
+    foo                   # equivalent to localhost:27017/foo
+    localhost/foo         # equivalent to localhost:27017/foo
+    localhost:27018/foo
 
 TODO
 -----------
 
 Support for:
+
 * GridFS
 * Editing Data
-* Ports
-* Usernames, passwords
 
-![Screenshot] (http://img.skitch.com/20100430-jdmu6nxijpbmq5ur72gwayghs7.jpg)
+Screenshot
+-----------------
+
+![Screenshot](http://img.skitch.com/20100430-jdmu6nxijpbmq5ur72gwayghs7.jpg)

data/bin/mongo-web

@@ -9,4 +9,9 @@ rescue LoadError
 end  
 require 'server'
 
-Vegas::Runner.new(MongoWeb::Server, 'mongo-web')
+Vegas::Runner.new(
+  MongoWeb::Server, 
+  'mongo-web', 
+  { :before_run => MongoWeb::Server::MONGO_CONNECTION_SETUP },
+  &MongoWeb::Server::OPTIONS_SETUP
+) 

data/lib/server.rb

@@ -2,17 +2,57 @@ require 'rubygems'
 require 'sinatra'
 require 'haml'
 require 'mongo'
+require 'yajl'
 
 module MongoWeb
   class Server < Sinatra::Base
+    DEFAULT_MONGO_HOST       = "localhost"
+    DEFAULT_MONGO_PORT       = 27017
+    MONGO_CONNECTION_SETUP   = lambda { |r| r.app.set_mongo_connection_from_args(r.args.first) }
+    OPTIONS_SETUP            = proc do |runner, opts, app|
+      opts.on('--mongo-username USERNAME', 'username for authentication against MongoDB database') do |mongo_username|
+        app.set(:mongo_username, mongo_username)
+      end
+
+      opts.on('--mongo-password PASSWORD', 'password for authentication against MongoDB database') do |mongo_password|
+        app.set(:mongo_password, mongo_password)
+      end
+      
+      opts.banner = "Usage: #{$0 || app_name} [options] [database_connection_string]"
+    end
+    
     dir = File.dirname(File.expand_path(__FILE__))
     set :views,  "#{dir}/server/views"
+    set :public, "public"
     set :static, true
     set :haml, { :format => :html5 }
     
+    set :mongo, nil
+    set :mongo_username, nil
+    set :mongo_password, nil
+    set :mongo_database_name, nil
+    set :mongo_admin, false
+    
+    def self.set_mongo_connection_from_args(connection_string)
+      host, port, database_name = connection_string.to_s.scan(/^(?:([^:]+?)(?::([^\/]+?))?\/)?(.+)$/).first
+      effective_host = host || DEFAULT_MONGO_HOST
+      effective_port = port || DEFAULT_MONGO_PORT
+      
+      connection = Mongo::Connection.new(effective_host, effective_port)
+      set(:mongo, connection)
+      
+      if database_name && self.mongo_username && self.mongo_password
+        database = mongo.db(database_name)
+        database.authenticate(self.mongo_username, self.mongo_password)
+        set(:mongo_database_name, database_name)
+      else
+        set(:mongo_admin, true)
+      end
+    end
+    
     helpers do
       def mongo
-        @mongo ||= Mongo::Connection.new
+        settings.mongo
       end
     
       def databases
@@ -20,30 +60,108 @@ module MongoWeb
       end
       
       def collections(database_name)
-        mongo.db(database_name).collections
+        collections = mongo.db(database_name).collections
+        unless settings.mongo_admin
+          collections.reject { |collection| collection.name.match(/^system\./) }
+        else
+          collections
+        end
       end
       
       def documents(database_name, collection_name)   
         mongo.db(database_name)[collection_name].find()
-      end 
+      end
+      
+      def document(database_name, collection_name, id)
+        mongo.db(database_name)[collection_name].find_one({ '_id' => BSON::ObjectID.from_string(id) })
+      end
+      
+      def breadcrumbs
+        bc = []
+        
+        if @database_name && @collection && @document
+          bc << %Q{<a href="/overview">databases</a>}
+          bc << %Q{<a href="/database/#{@database_name}">#{@database_name}</a>}
+          bc << %Q{<a href="/database/#{@database_name}/#{@collection}">#{@collection}</a>}
+          bc << @document_id
+        elsif @database_name && @collection
+          bc << %Q{<a href="/overview">databases</a>}
+          bc << %Q{<a href="/database/#{@database_name}">#{@database_name}</a>}
+          bc << @collection
+        elsif @database_name
+          bc << %Q{<a href="/overview">databases</a>}
+          bc << @database_name
+        end
+        
+        bc
+      end
+      
+      def pretty_value(value)
+        case value
+        when String, Fixnum, BSON::ObjectID
+          value.to_s
+        when Hash, Array
+          "<pre>#{Yajl::Encoder.encode(value, :pretty => true)}</pre>"
+        else
+          value.inspect
+        end
+      end
+      
+      def truncate(text, length = 30, omission = '...')
+        return unless text
+        return text if text.length < length
+        
+        out_text_length = (length / 2).floor
+        text.slice(0, out_text_length) + omission + text.slice(-out_text_length, out_text_length)
+      end
+      
+      def hash_without(hash, *keys)
+        hash.inject({}) do |out, pair|
+          key, value = pair
+          next out if keys.include?(key)
+          
+          out[key] = value
+          out
+        end
+      end
     end
 
     get '/' do
-      redirect '/overview'
+      if settings.mongo_admin
+        redirect '/overview'
+      else
+        redirect "/database/#{settings.mongo_database_name}"
+      end
     end
 
     get '/overview' do
+      unless settings.mongo_admin
+        redirect "/database/#{settings.mongo_database_name}"
+      end
+      
       haml :overview
     end
     
-    get '/database/:name' do
+    get '/database/:database_name' do |database_name|
+      @database_name = database_name
       haml :database
     end
     
-    get '/database/:name/:collection' do
+    get '/database/:database_name/:collection' do |database_name, collection|
+      @database_name = database_name
+      @collection = collection
       haml :collection
     end
     
+    get '/database/:database_name/:collection/:id' do |database_name, collection, id|
+      @database_name = database_name
+      @collection = collection
+      @document_id = id
+      
+      @document = document(database_name, collection, id)
+      haml :document
+    end
+    
     get '/stylesheet.css' do
       content_type 'text/css', :charset => 'utf-8'
       sass :stylesheet

data/lib/server/views/collection.haml

@@ -1,15 +1,9 @@
--name = params[:name]
--collection = params[:collection]
-
-%h2 #{name} >> #{collection} >> documents
-
 %table
   %tr
-    %th 
-      %h3 Id
-    %th 
-      %h3 Values
-  -for document in documents(name, collection)
+    %th ID
+    %th Values
+  -for document in documents(@database_name, @collection)
     %tr
-      %td= document['_id']
-      %td= document.inspect
+      %td{ :class => 'monospace' }
+        %a{ :href => "/database/#{@database_name}/#{@collection}/#{document['_id']}" }= document['_id']
+      %td{ :class => 'monospace' }= truncate(hash_without(document, '_id').inspect, 80)

data/lib/server/views/database.haml

@@ -1,15 +1,9 @@
--name = params[:name]
-
-%h2 #{name} >> collections
-
 %table
   %tr
-    %th 
-      %h3 Name
-    %th 
-      %h3 Size
-  -for collection in collections(name)
+    %th Name
+    %th Size
+  -for collection in collections(@database_name)
     %tr
       %td
-        %a{:href => "#{name}/#{collection.name}"}= collection.name
+        %a{:href => "#{@database_name}/#{collection.name}"}= collection.name
       %td= collection.size

data/lib/server/views/document.haml

@@ -0,0 +1,8 @@
+%table
+  %tr
+    %th Key
+    %th Value
+  -@document.each do |key, value|
+    %tr
+      %td{ :class => 'key' }= key
+      %td{ :class => 'value' }= pretty_value(value)

data/lib/server/views/layout.haml

@@ -4,8 +4,16 @@
     %title MongoWeb
     %link{ :href => '/stylesheet.css', :media => 'screen', :rel => 'stylesheet', :type => 'text/css'}
   %body
-    #wrapper
-      %h1 MongoWeb
-      #site= yield
-      %a{ :href => 'http://mongodb.org' }
-        %img{ :src => 'http://api.mongodb.org/wiki/current/attachments/132305/1605648.png' }
+    #container
+      #header
+        %h1 MongoWeb
+        
+        -unless breadcrumbs.empty?
+          %ul
+            -for breadcrumb in breadcrumbs
+              %li= breadcrumb
+      
+      #content= yield
+      
+    #footer
+      %img{ :src => '/images/PoweredMongoDBblue50.png' }

data/lib/server/views/overview.haml

@@ -1,6 +1,7 @@
-%h2 Databases
-
 %table
+  %tr
+    %th= "database name"
+  
   -for name in databases
     %tr
       %td

data/lib/server/views/stylesheet.sass

@@ -1,49 +1,77 @@
-!dark_brown = #402817
-!light_brown = #F6F4CD
-!light_gray = #FDFCF7
+body
+  background-color= #CCC
+  font-family= Helvetica, Arial, sans-serif
 
-=plain_anchor
-  a
-    text-decoration: none
-    color: black
-    font:
-      size: 1.2em
-      weight: 600
-  a:hover
-    text-decoration: underline
+a
+  color= #000
 
-html
-  background-color= !light_brown
-
-h2
-  margin: 0px
-  font-size: 1.3em
+#container
+  background-color= #FFF
+  margin= 40px auto 0
+  width= 960px
+  -webkit-box-shadow= 0 0 5px rgba(0, 0, 0, .2)
+  -moz-box-shadow= 0 0 5px rgba(0, 0, 0, .2)
+  -webkit-border-radius= 5px
+  -moz-border-radius= 5px
   
-h3
-  margin:
-    top: 15px
-    bottom: 5px
-
-#wrapper
-  width: 800px
-  margin:
-    right: auto
-    left: auto
-  #site
-    -webkit-border-radius: 15px
-    -moz-border-radius: 15px
-    border: 2px solid
-      color= !dark_brown
-    padding: 15px
-    background-color= !light_gray
+  #header
+    h1
+      font-size= 1.5em
+      background-color= #77BED2
+      margin= 0
+      padding= 7px 0 7px 15px
+      -webkit-border-top-left-radius= 5px
+      -webkit-border-top-right-radius= 5px
+      -moz-border-radius-topleft= 5px
+      -moz-border-radius-topright= 5px
+    
+    ul
+      border-bottom= 1px solid #CCC
+      list-style= none
+      padding= 10px 0 10px 15px
+      margin= 0
+      overflow= auto
+      
+      li
+        float= left
+        margin-right= 15px
+        text-transform= uppercase
+        
+        &:after
+          :content '>>'
+          :padding-left 15px
+        
+        &:last-child
+          :font-weight bold
+          
+          &:after
+            :content ''
+        
+  #content
+    padding= 5px 15px 15px 15px
+    
     table
-      +plain_anchor
-      border-collapse: collapse
-      width: 100%
-      text-align: left
+      border-collapse= collapse
+      width= 100%
+      text-align= left
+      
+      th
+        padding= 10px
+        text-transform= uppercase
+      
       td
-        padding: 10px
-        border: 1px solid black
-img
-  float: right
-  margin-top: 10px
+        padding= 10px
+        border= 1px solid black
+        vertical-align= top
+        
+      td.monospace
+        font-family= monospace
+        
+      td.key
+        font-weight= bold
+
+#footer
+  margin= 0 auto 25px
+  padding-top= 10px
+  text-align= right
+  width= 960px

metadata

@@ -5,16 +5,17 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ethan Gunderson
+- Ryan Briones
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-30 00:00:00 -05:00
+date: 2010-06-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +58,30 @@ dependencies:
         version: 0.9.2
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
 description: "    Mongo_Web is a sinatra application for viewing MongoDB databases.\n    \n    If the code looks a lot like resque_web, that would be because I borrowed heavily from their implementation.\n"
 email: ethan@ethangunderson.com
 executables: 
@@ -69,6 +94,7 @@ files:
 - README.markdown
 - lib/server/views/collection.haml
 - lib/server/views/database.haml
+- lib/server/views/document.haml
 - lib/server/views/layout.haml
 - lib/server/views/overview.haml
 - lib/server/views/stylesheet.css
@@ -76,6 +102,7 @@ files:
 - lib/server.rb
 - bin/mongo-web
 - spec/mongo_web_spec.rb
+- public/images/PoweredMongoDBblue50.png
 has_rdoc: true
 homepage: http://github.com/ethangunderson/mongo_web
 licenses: []