Skip to content

Commit

Permalink
Watching this project? It's got a new home at https://github.com/Rail…
Browse files Browse the repository at this point in the history 
…sApps/rails3-mongoid-devise
  • Loading branch information
@fortuity
fortuity committed May 20, 2011
1 parent 9ee44fd commit f870086
Showing 1 changed file with 3 additions and 346 deletions.
349 changes: 3 additions & 346 deletions README.textile
View file
Expand Up @@ -2,11 +2,11 @@ h1. Rails3 + Mongoid + Devise

This is an example *Rails 3 application* that combines *Devise* with *Mongoid*. The "Devise":http://github.com/plataformatec/devise gem gives you ready-made authentication and user management. MongoDB is used as a datastore with the "Mongoid":http://mongoid.org/ gem for quick development without schemas or migrations.

Best of all, there's a "detailed tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29 (walk-through) to show how it's built.
h2. The Project Has Moved!

You can clone this app or generate a new Rails application using this app as a template.
Please visit the project at its "new home":https://github.com/railsapps/rails3-mongoid-devise:

Any issues? Please create an "Issue":http://github.com/fortuity/rails3-mongoid-devise/issues on GitHub.
h4. "Rails 3 + Mongoid + Devise":https://github.com/railsapps/rails3-mongoid-devise

h2. !http://twitter-badges.s3.amazonaws.com/t_logo-a.png(Follow on Twitter)!:http://www.twitter.com/rails_apps Follow on Twitter

Expand All @@ -15,349 +15,6 @@ To keep up to date, follow the project on Twitter:

Please tweet some praise if you like what you've found.

h2. "Building It" Tutorial

A complete walkthrough tutorial is available on the GitHub wiki:

h4. "View the Tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29

The tutorial documents each step to follow to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere.

If you simply wish to modify the application for your own project, you can download the application and set it up as described below, without following the tutorial.

h2. What Is Implemented -- and What Is Not

This is a demonstration application that allows you to visit a home page and see a list of users. With the default user's email and password (supplied below), you can log in and view details for each user. You can customize this app as you need.

h4. Similar Examples and Tutorials

|_. Author |_. Example App |_. Comments |
| Plataformatec | "Devise":http://github.com/plataformatec/devise_example | Simple example using SQLite |
| Daniel Kehoe | "Devise, RSpec, Cucumber":https://github.com/fortuity/rails3-devise-rspec-cucumber | Detailed tutorial, app template, starter app, using SQLite |
| Daniel Kehoe | "OmniAuth, Mongoid":https://github.com/fortuity/rails3-mongoid-omniauth | Detailed tutorial, app template, starter app, using MongoDB |
| Fernando Tapia Rico | "Devise, OmniAuth, Mongoid":https://github.com/fertapric/rails3-mongoid-devise-omniauth | With tutorial, using MongoDB |
| Andi Altendorfer | "Community Base Application (CBA)":http://github.com/iboard/CBA | Devise, OmniAuth, Mongoid, CanCan, Paperclip, etc. |
| Kristian Mandrup | "Cream":https://github.com/kristianmandrup/cream | Gem-based app generator for apps with Devise, many ORMs, CanCan |

h2. Dependencies

Before running this app, you need to install

* The Ruby language (version 1.8.7 or 1.9.2)
* Rails (version 3.0.7)
* A working installation of "MongoDB":http://www.mongodb.org/ (version 1.6.0 or newer)

I recommend installing rvm, the "Ruby Version Manager":http://rvm.beginrescueend.com/, to manage multiple versions of Rails.

Check that appropriate versions of Ruby and Rails are installed in your development environment:
@$ ruby -v@
@$ rails -v@

h4. Installing MongoDB

If you don't have MongoDB installed on your computer, you'll need to install it and set it up to be always running on your computer (run at launch). On Mac OS X, the easiest way to install MongoDB is to install "Homebrew":http://mxcl.github.com/homebrew/ and then run the following:

<pre>
brew install mongodb
</pre>

Homebrew will provide post-installation instructions to get MongoDB running. The last line of the installation output shows you the MongoDB install location (for example, */usr/local/Cellar/mongodb/1.8.0-x86_64*). You'll find the MongoDB configuration file there. After an installation using Homebrew, the default data directory will be */usr/local/var/mongodb*.

h2. Getting the Application

You have several options for getting the code.

h4. Downloading the Code

If you simply wish to examine the example code, you can download the code ("clone the repository") with the command

@$ git clone git://github.com/fortuity/rails3-mongoid-devise.git@

The source code is managed with Git (a version control system). You'll need Git on your machine (install it from "http://git-scm.com/":http://git-scm.com/).

h4. Using the Ready-Made Application Template

You can use an application template to generate a new version of the example app. You’ll find an application template for this app in the "fortuity/rails3-application-templates":https://github.com/fortuity/rails3-application-templates repository.

Use the command:

@$ rails new APP_NAME -m https://github.com/fortuity/rails3-application-templates/raw/master/rails3-mongoid-devise-template.rb -T -O -J@

Use the @-T -O -J@ flags to skip Test::Unit files, Active Record files, and Prototype files.

bq. You MUST be using Rails 3.0.4 or newer. Generating a Rails application from an “HTTPS” URL does not work in Rails 3.0.3 and earlier versions.

This creates a new Rails app (with the @APP_NAME@ you provide) on your computer.

The application generator template will ask you for your preferences:

* Would you like to use jQuery instead of Prototype?
* Would you like to use jQuery UI?
* Would you like to use Haml instead of ERB?
* Would you like to use RSpec instead of TestUnit?
* Would you like to use factory_girl for test fixtures with RSpec?
* Would you like to use Cucumber for your BDD?
* Would you like to use Mongoid to connect to a MongoDB database?
* Would you like to use Devise for authentication?
* Would you like to set a robots.txt file to ban spiders?

h4. Use "Recipes" to Customize an Application Template

The "tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29 shows how a customized application template can be assembled from "recipes." The application template was created using the "rails3_devise_wizard":https://github.com/fortuity/rails3_devise_wizard gem which provides a convenient way to assemble a reusable application template by selecting various "recipes" for popular Rails development packages.

h4. Please Remember: Edit the README

If you're open sourcing the app on GitHub, please edit the README file to add a description of the app and your contact info. Changing the README is important if you're using a clone of the example app. I've been mistaken (and contacted) as the author of apps that are copied from my example.

h2. Getting Started

h3. About Required Gems

The application uses the following gems. I recommend checking for newer versions of these gems before proceeding:

* rails "(check rubygems.org for a newer gem)":http://rubygems.org/gems/rails
* mongoid "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/mongoid
* bson_ext "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/bson_ext
* devise "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/devise

If you are able to build the app with a newer gem, please create an "issue":http://github.com/fortuity/rails3-mongoid-devise/issues on GitHub and I will update the app.

h3. Install the Required Gems

Install the required gems on your computer:

@$ bundle install@

You can check which gems are installed on your computer with:

@$ gem list --local@

Keep in mind that you have installed these gems locally. When you deploy the app to another server, the same gems (and versions) must be available.

h3. Configure Mongoid

Mongoid provides access to the MongoDB database from Rails.

You can use the default configuration found in the file *config/mongoid.yml*.

If you want to see what's in your MongoDB databases, I recommend using the "MongoHub":http://mongohub.todayclose.com/ app (for Mac OS X).

h3. Set Up Configuration for Devise

This app uses Devise for user management and authentication. Devise is at "http://github.com/plataformatec/devise":http://github.com/plataformatec/devise.

You can modify the configuration file for Devise if you want to use something other than the defaults:

*config/initializers/devise.rb*

h3. Configure Email for Devise

Configure email by modifying

*config/initializers/devise.rb*

and setting the return email address for emails sent from the application.

You may need to set values for your mailhost in

*config/environments/development.rb*
*config/environments/production.rb*

h2. Create a Default User

h3. Set Up a Database Seed File

You'll want to set up a default user so you can easily log in to test the app. You can modify the file *db/seeds.rb* for your own name, email and password:

<pre>
puts 'EMPTY THE MONGODB DATABASE'
Mongoid.master.collections.reject { |c| c.name =~ /^system/}.each(&:drop)
puts 'SETTING UP DEFAULT USER LOGIN'
user = User.create! :name => 'First User', :email => 'user@test.com', :password => 'please', :password_confirmation => 'please'
puts 'New user created: ' << user.name
</pre>

Use the defaults or change the values for name, email, and password as you wish.

h3. Seed the Database

Add the default user to the MongoDB database by running the command:

@$ rake db:seed@

h3. Test the App

You can check that your app runs properly by entering the command

@$ rails server@

To see your application in action, open a browser window and navigate to "http://localhost:3000/":http://localhost:3000. You should see the default user listed on the home page. When you click on the user's name, you should be required to log in before seeing the user's detail page.

To sign in as the default user, (unless you've changed it) use

* email: user@test.com
* password: please

You should delete or change the pre-configured logins before you deploy your application.

h2. Deploying to Heroku

h3. Set Up Heroku

For your convenience, here are instructions for deploying your app to Heroku. Heroku provides low cost, easily configured Rails application hosting.

To deploy this app to Heroku, you must have a Heroku account. If you need to obtain one, visit "http://heroku.com/":http://heroku.com/ to set up an account.

Make sure the Heroku gem is in your *Gemfile* "(check rubygems.org for the latest heroku gem)":http://rubygems.org/gems/heroku:

@gem "heroku"

If it's not, add it and run

@$ bundle install@

to set up your gems again.

Add your public key immediately after installing the heroku gem so that you can use git to push or clone Heroku app repositories. See "http://devcenter.heroku.com/articles/heroku-command":http://devcenter.heroku.com/articles/heroku-command for details.

h3. Create Your Application on Heroku

Use the Heroku create command to create and name your new app.

@$ heroku create _myapp_@

As of 9 February 2011, bamboo-ree-1.8.7 is the default stack for new Heroku apps.

If you want to use Ruby 1.9.2, you can create your app with:

@heroku create _myapp_ --stack bamboo-mri-1.9.2@

h3. Heroku Add-on for MongoHQ

You can use a Heroku add-on to deploy your app using the MongoHQ service. See "details about the service":http://addons.heroku.com/mongohq and "details about installation":http://devcenter.heroku.com/articles/mongohq.

To enable the add-on, you can use the Heroku web interface or you can enter the following commands:

@$ heroku addons:add mongohq:free@

h3. Check Heroku Configuration

You can check that everything has been added correctly by running:

@$ heroku info --app myapp@

If you see @Stack: bamboo-ree-1.8.7@ and you want to use Ruby 1.9.2, you can migrate:

@heroku stack:migrate bamboo-mri-1.9.2@

h3. Push Your Application to Heroku

Push your application to Heroku:

@$ git push heroku master@

Initialize your application database:

@$ heroku rake db:seed@

h3. Fix Problems Connecting to MongoHQ

If you get the error message "failed to connect to any given host:port" or "Failed to connect to a master node at localhost:27017", the *config/mongoid.yml* file may not have the correct MongoHQ connection parameters.

If the file *config/mongoid.yml* contains this:

<pre>
# set these environment variables on your prod server
production:
host: <%= ENV['MONGOID_HOST'] %>
port: <%= ENV['MONGOID_PORT'] %>
username: <%= ENV['MONGOID_USERNAME'] %>
password: <%= ENV['MONGOID_PASSWORD'] %>
database: <%= ENV['MONGOID_DATABASE'] %>
</pre>

modify it to look like this:

<pre>
# set these environment variables on your prod server
production:
uri: <%= ENV['MONGOHQ_URL'] %>
</pre>

Then push your application to Heroku again with @$ git push heroku master@ and run @$ heroku rake db:seed@ again.

h3. Visit Your Site

Open your Heroku site in your default web browser:

@$ heroku open@

h3. Troubleshooting

If you get errors, you can troubleshoot by reviewing the log files:

@$ heroku logs@

h2. Customizing

"Devise":http://github.com/plataformatec/devise provides a variety of features for implementing authentication. See the Devise documentation for options.

This example application and tutorial demonstrates Devise and Mongoid working together on Rails 3. Add any models, controllers, and views that you need.

h2. Testing

The application contains RSpec unit tests and Cucumber scenarios and steps. The tests are minimal and can be improved.

Please send the author a message, create an issue, or submit a pull request if you can contribute improved RSpec or Cucumber files.

After installing the application, run @rake -T@ to check that rake tasks for RSpec and Cucumber are available.

Run @rake spec@ to run all RSpec tests.

Run @rake cucumber@ (or more simply, @cucumber@) to run all Cucumber scenarios and steps.

You can browse and search the Cucumber features at the "Relish":http://relishapp.com/fortuity/rails3-mongoid-devise website.

h2. Documentation and Support

See the "Tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29 for this app for details of how it was built. Please create an "Issue":http://github.com/fortuity/rails3-mongoid-devise/issues on GitHub if you identify any problems or have suggestions for improvements.

For a Mongoid introduction, Ryan Bates offers a "Railscast on Mongoid":http://railscasts.com/episodes/238-mongoid. You can find documentation for "Mongoid":http://mongoid.org/ at "http://mongoid.org/":http://mongoid.org/ There is an active "Mongoid mailing list":http://groups.google.com/group/mongoid and you can submit "Mongoid issues":http://github.com/durran/mongoid/issues at GitHub.

For a Devise introduction, Ryan Bates offers a "Railscast on Devise":http://railscasts.com/episodes/209-introducing-devise. You can find documentation for "Devise":http://github.com/plataformatec/devise at "http://github.com/plataformatec/devise":http://github.com/plataformatec/devise. There is an active "Devise mailing list":http://groups.google.com/group/plataformatec-devise and you can submit "Devise issues":http://github.com/plataformatec/devise/issues at GitHub.

h4. Issues

Please create an "issue on GitHub":http://github.com/fortuity/rails3-mongoid-devise/issues if you identify any problems or have suggestions for improvements.

h2. Contributing

If you make improvements to this application, please share with others.

Send the author a message, create an "issue":http://github.com/fortuity/rails3-mongoid-devise/issues, or fork the project and submit a pull request.

If you add functionality to this application, create an alternative implementation, or build an application that is similar, please contact me and I'll add a note to the README so that others can find your work.

h2. Credits

Daniel Kehoe ("http://danielkehoe.com/":http://danielkehoe.com/) implemented the application and wrote the tutorial.

Is the app useful to you? Follow the project on Twitter:
"http://twitter.com/rails_apps":http://twitter.com/rails_apps
and tweet some praise. I'd love to know you were helped out by what I've put together.

h4. Contributors

Thank you for improvements to the tutorial by contributors:

* "Cory Foy":https://github.com/CoryFoy
* "Luca G. Soave":https://github.com/lgs
* "Bob Clewell":https://github.com/bobclewell
* "Justin Workman":https://github.com/xtagon
* "Tom von Schwerdtner":https://github.com/tvon

h2. License

h4. Public Domain Dedication

This work is a compilation and derivation from other previously released works. With the exception of various included works, which may be restricted by other licenses, the author or authors of this code dedicate any and all copyright interest in this code to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this code under copyright law.

0 comments on commit f870086

Please sign in to comment.