simply_mongo 0.0.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Robert Birch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,110 @@
+= SimplyMongo
+
+This project uses an MIT-LICENSE.
+
+Installing the *simply_mongo* gem sets up a Rails environment where the standard mongo driver can be easily used.
+After installing the gem run the rails generator:  
+
+    $ rails g simply_mongo:install
+
+The YAML file +config/mongo.yml+ are where the database configuration parameters can be set.
+
+== Snippet of  Code
+A simple controller example of adding a document to a collection
+
+  e = params[:enterprise]                    # extract the JSON document
+  ec = SimplyMongo.db['CollectionName']      # get reference to collection
+  id = BSON::ObjectId.new                    # set the ID
+  e[:_id] = id  
+  ec.insert(e)                               # stuff document into collection
+
+== Simple JSON
+
+    "enterprise": {
+        "city": "Bedrock", 
+        "contacts": [
+            {
+                "email": [
+                    {
+                        "description": "Work Email", 
+                        "email": "fflintstone@bedrock.com"
+                    }
+                ], 
+                "first_name": "Fred", 
+                "last_name": "Flintstone", 
+                "phone": [
+                    {
+                        "description": "Home Phone", 
+                        "number": "1-123-1234"
+                    }
+                ]
+            }
+        ], 
+        "country": "US", 
+        "description": "We dig and move rocks and gravel using the latest technologies", 
+        "name": "Slate Rock and Gravel", 
+        "phone": "1.123.1234", 
+        "street": "123 Quarry Pit", 
+        "web_site": "http://www.slaterockandgravel.com", 
+        "zip": "12345"
+    }
+
+
+== Simple JSON Controller
+
+    require 'simply_mongo'
+
+    class EnterprisesController < ApplicationController
+
+      def create
+        e = params[:enterprise]
+        ec = SimplyMongo.db['enterprises']
+        id = BSON::ObjectId.new
+        e[:_id] = id
+        ec.insert(e)
+        eid = ec.find_one({'_id' => id}, { :fields => [ '_id'] } )
+        j = { :id => eid['_id'].to_s}
+        render :text => j.to_json
+      end
+
+      def index
+        ec = SimplyMongo.db['enterprises']
+        c = ec.find()
+        e = [ ]
+        c.each { |ce| e.push(ce) }
+        render :text => e.to_json
+      end
+
+      def show
+        ec = SimplyMongo.db['enterprises']
+        id = params['id']
+        bid = BSON::ObjectId id
+        one = ec.find_one({ '_id' => bid})
+        if one.nil?
+          render :text => { }.to_json
+        else
+          oid = one['_id']
+          one['_id'] = oid.to_s
+          render :text => one.to_json
+        end
+      end
+
+      def update
+        p = params.clone
+        id = p.delete('id')
+        bid = BSON::ObjectId id
+        p['_id'] = bid
+        ec = SimplyMongo.eb['enterprises']
+        ec.update({'_id' => bid}, p)
+        render :text => "{ 'code': 'success'}"
+      end
+
+      def destroy
+        ec = SimplyMongo.db['enterprises']
+        id = params['id']
+        bid = BSON::ObjectId id
+        ec.remove({ '_id' => bid})
+        render :text => { :removed =>"removed"}
+      end
+
+    end

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimplyMongo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/simply_mongo/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module SimplyMongo
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This will install the template mongo.yml and  the SimplyMongo Initializer file"
+      
+      def install
+        copy_file "mongo.yml", "config/mongo.yml"
+        copy_file "mongo.rb", "config/initializers/mongo.rb"
+        puts "Now configure config/mongo.yml"
+      end
+      
+    end
+  end
+end

data/lib/generators/simply_mongo/install/templates/mongo.rb

@@ -0,0 +1,47 @@
+require 'simply_mongo'
+module SimplyMongo
+
+  Rails.application.config.after_initialize do
+    mongo_config_file = File.join("#{Rails.root}", 'config', 'mongo.yml')
+    raise "#{mongo_config_file} is missing!" unless File.exists? mongo_config_file
+    mongo_config = YAML.load_file(mongo_config_file)
+
+    db_config = mongo_config.fetch(Rails.env)
+
+    db_name = db_config['database']
+    raise "Mongo database not set for environment #{Rails.env}" unless not db_name.nil?
+
+    host = db_config['host']
+    if host.nil? then
+      host = localhost
+    end
+
+    port = db_config['port']
+    if port.nil? then
+      port = 27017
+    end
+
+    options = db_config['options']
+    if options.nil?
+      options = {}
+    end
+
+    @@driver = SimplyMongo::Driver.new(db_name, host, port, options);
+    @@connection = @@driver.conn
+    @@db = @@driver.db
+  end
+  
+  def SimplyMongo.db
+    @@db
+  end
+  
+  def SimplyMongo.connction
+    @@connection
+  end
+  
+  def SimplyMongo.driver
+    @@driver
+  end
+end
+
+

data/lib/generators/simply_mongo/install/templates/mongo.yml

@@ -0,0 +1,45 @@
+#------------------------------------------------------------------------------------------------------------------------------------------------
+# Simply Mongo Driver Specification
+#
+# OPTIONS:
+# :safe (Boolean, Hash)    — default: false  — Set the default safe-mode options propogated to
+#                                               DB objects instantiated off of this Connection. This default can
+#                                               be overridden upon instantiation of any DB by explicity setting a :safe value on initialization.
+# :slave_ok (Boolean)      — default: false  — Must be set to true when connecting to a single, slave node.
+# :logger (Logger, #debug) — default: nil    — A Logger instance for debugging driver ops.
+#                                               Note that logging negatively impacts performance; therefore, it should not be
+#                                               used for high-performance apps.
+# :pool_size (Integer)     — default: 1     —  The maximum number of socket self.connections allowed per connection pool. Note: this
+#                                               setting is relevant only for multi-threaded applications.
+# :timeout (Float)         — default: 5.0   —  When all of the self.connections a pool are checked out, this is the number of seconds
+#                                                to wait for a new connection to be released before throwing an exception. Note: this
+#                                               setting is relevant only for multi-threaded applications (which in Ruby are rare).
+# :op_timeout (Float)      — default: nil   —  The number of seconds to wait for a read operation to time out. Disabled by default.
+# :connect_timeout (Float) — default: nil   —  The number of seconds to wait before timing out a connection attempt.
+# :ssl (Boolean)           — default: false —  If true, create the connection to the server using SSL.
+#------------------------------------------------------------------------------------------------------------------------------------------------
+
+development:
+        adapter: mongodb
+        database: dyntech-dev
+        host: localhost
+        port: 27017
+        options:
+                safe: true
+
+
+test:
+        adapter: mongodb
+        database: dyntech-test
+        host: localhost
+        port: 27017
+        options:
+                safe: true
+
+production:
+        adapter: mongodb
+        database: dyntech
+        host: localhost
+        port: 27017
+        options:
+                safe: true

data/lib/simply_mongo.rb

@@ -0,0 +1,7 @@
+require 'simply_mongo/simply_mongo'
+
+module SimplyMongo
+  NAME = "SimplyMongo"
+  LICENSE = "See MIT-LICENSE"
+
+end

data/lib/simply_mongo/simply_mongo.rb

@@ -0,0 +1,20 @@
+require 'mongo'
+
+module SimplyMongo
+
+  class Driver
+    attr :db, :conn
+
+    def initialize(database=nil, host='localhost', port=27017, options={})
+      @conn = Mongo::Connection.new(host, port, options)
+      if not database.nil? then
+        @db = @conn[database]
+      end
+    end
+
+    def to_s
+      " " + @conn.to_s + " " +  @db.to_s
+    end
+  end
+
+end

data/lib/simply_mongo/version.rb

@@ -0,0 +1,3 @@
+module SimplyMongo
+  VERSION = "0.0.5"
+end

data/lib/tasks/simply_mongo_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simply_mongo do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.