一个使用 Mongoid 存储数据、OmniAuth 进行身份验证的 Rails 3.2 应用程序示例,附带教程。
一个使用 Mongoid 存储数据、OmniAuth 进行身份验证的 Rails 3.2 应用程序示例,附带教程。
h1. !http://railsapps.github.io/images/rails-36x36.jpg(Rails Application for Omniauth with Mongoid)! Rails App for Omniauth with Mongoid
For a Rails 4.1 example application with OmniAuth, see the "rails-omniauth":https://github.com/RailsApps/rails-omniauth application, with an "OmniAuth Tutorial":http://railsapps.github.io/rails-omniauth/.
This is a Rails 3.2 example application for Omniauth with Mongoid.
"OmniAuth":https://github.com/intridea/omniauth manages authentication using a service provider such as Twitter or Facebook.
MongoDB is used as a datastore with the "Mongoid":http://mongoid.org/ gem for quick development without schemas or migrations.
Service Providers: Facebook, Twitter, GitHub, LinkedIn, and "many more":https://github.com/intridea/omniauth.
Gems: Mongoid and OmniAuth plus optional jQuery, Haml, RSpec and Cucumber.
You can build this application in only a few minutes using the "Rails Composer":http://railsapps.github.io/rails-composer/ tool.
h2. !http://twitter-badges.s3.amazonaws.com/t_logo-a.png(Follow on Twitter)!:http://www.twitter.com/rails_apps Follow on Twitter
Follow the project on Twitter: "@rails_apps":http://twitter.com/rails_apps. Please tweet some praise if you like what you've found.
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. You can log in using a service provider such as Twitter and view a profile for each user. You can customize this app as you need.
h4. Single Provider or Multiple Providers?
This application is designed for sign-in with a single provider. For example, you may be creating an application just for Twitter users. Alternatively, it's possible to create an application that lets a user log in using multiple providers. For these more complex applications, see other examples and tutorials listed below.
h4. When to use Devise?
"Devise":http://github.com/plataformatec/devise provides authentication using username (or email address) and password. If you don't need the option of using a username/password, that is, if you wish to have all your users sign in using a service provider's account (such as Twitter or Facebook), there's no need to use Devise. Devise can be used in conjunction with the OmniAuth gem when you need to offer users the option of signing up for access to a website using an email address. For example, combine Devise with OmniAuth to accommodate users who want to log in with various service providers (Twitter, Facebook, etc.) as well as users who don't have external accounts and want to sign up with just an email address. See suggestions below for tutorials and examples that combine Devise with OmniAuth.
h4. The Email Problem
You don't need to ask a visitor for an email address when you build an application that allows a user to log in using a service provider such as Twitter or Facebook. You may consider that an advantage: if a user is logged in with Twitter or Facebook, they don't need to enter an email address and password to access your application. However, the lack of an email address may be a business drawback, if you want the opportunity to stay in contact with the user by email. Some service providers provide the user's email address to your application (Facebook). Some service providers only provide the email address at the user's option (GitHub supplies it if the user has provided a public email address). And other service providers do not provide the email address at all (Twitter, Meetup, LinkedIn).
This example app shows how to request an email address from the user when he or she first requests access to your application. It is easy to remove this feature if you don't require it.
h4. Similar Examples and Tutorials
This is one in a series of Rails example apps and tutorials from the "RailsApps Project":http://railsapps.github.io/. See a list of additional "Rails examples, tutorials, and starter apps":http://railsapps.github.io/rails-examples-tutorials.html.
h2. Obtaining API Keys
Before installing the application, you may wish to contact the service provider you'll use to obtain any required API keys. The example assumes you will be using Twitter.
h4. Twitter
Visit "https://dev.twitter.com/apps/new":https://dev.twitter.com/apps/new to register your application. When you register your application, use the following values:
|. Application Website |. Callback URL |_. Notes | | http://example.com | http://127.0.0.1:3000/ | http://localhost:3000/ doesn't work |
h4. Facebook
Visit "http://developers.facebook.com/setup":http://developers.facebook.com/setup to register your application.
h4. GitHub
Visit "https://github.com/settings/applications/new":https://github.com/settings/applications/new to register your application.
h2. Dependencies
Before running this app, you will need:
See the article "Installing Rails":http://railsapps.github.io/installing-rails.html for advice about updating Rails and your development environment.
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:
brew install mongodb
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.
On the Debian GNU/Linux operating system, as of March 2013, the latest stable version is MongoDB 2.0.0. With MongoDB 2.0.0, the Mongoid gem must be version 3.0.x. See the "Mongoid installation instructions":http://mongoid.org/en/mongoid/docs/installation.html#installation. Change your Gemfile to use an earlier Mongoid version:
gem 'mongoid', '~> 3.0.1'
h2. Getting the Application
You have several options for getting the code.
h3. Fork
If you'd like to add features (or bug fixes) to improve the example application, you can fork the GitHub repo and "make pull requests":http://help.github.com/send-pull-requests/. Your code contributions are welcome!
h3. Clone
If you want to copy and customize the app with changes that are only useful for your own project, you can clone the GitHub repo. You'll need to search-and-replace the project name throughout the application. You probably should generate the app instead (see below). To clone:
$ git clone git://github.com/RailsApps/rails3-mongoid-omniauth.git
You'll need "git":http://git-scm.com/ on your machine. See "Rails and Git":http://railsapps.github.io/rails-git.html.
h3. Generate
If you want to use the project as a starter app, use the "Rails Composer":http://railsapps.github.io/rails-composer/ tool to generate a new version of the example app. You'll be able to give it your own project name when you generate the app. Generating the application gives you many additional options.
To build the example application, run the command:
$ rails new rails3-mongoid-omniauth -m https://raw.github.com/RailsApps/rails-composer/master/composer-Rails3_2.rb -T -O
Use the @-T -O@ flags to skip Test::Unit files and Active Record files.
The @$@ character indicates a shell prompt; don't include it when you run the command.
This creates a new Rails app named @rails3-mongoid-omniauth@ on your computer.
You'll see a prompt:
question Install an example application? 1) I want to build my own application 2) membership/subscription/saas 3) rails-prelaunch-signup 4) rails3-bootstrap-devise-cancan 5) rails3-devise-rspec-cucumber 6) rails3-mongoid-devise 7) rails3-mongoid-omniauth 8) rails3-subdomains
Choose rails3-mongoid-omniauth. The Rails Composer tool may give you other options (other choices may have been added since these notes were written).
The application generator template will ask you for additional preferences:
question Web server for development? 1) WEBrick (default) 2) Thin 3) Unicorn 4) Puma question Web server for production? 1) Same as development 2) Thin 3) Unicorn 4) Puma question Template engine? 1) ERB 2) Haml 3) Slim extras Set a robots.txt file to ban spiders? (y/n) extras Use or create a project-specific rvm gemset? (y/n) extras Create a GitHub repository? (y/n)
h4. Web Servers
Use the default WEBrick server for convenience. If you plan to deploy to Heroku, select "thin" as your production webserver.
h4. Template Engine
The example application uses the default "ERB" Rails template engine. Optionally, you can use another template engine, such as Haml or Slim. See instructions for "Haml and Rails":http://railsapps.github.io/rails-haml.html.
h4. Other Choices
Set a robots.txt file to ban spiders if you want to keep your new site out of Google search results.
It is a good idea to use "rvm":https://rvm.io/, the Ruby Version Manager, and create a project-specific rvm gemset (not available on Windows). See "Installing Rails":http://railsapps.github.io/installing-rails.html.
If you choose to create a GitHub repository, the generator will prompt you for a GitHub username and password.
h4. Troubleshooting
If you get an error "OpenSSL certificate verify failed" or "Gem::RemoteFetcher::FetchError: SSL_connect" see the article "OpenSSL errors and Rails":http://railsapps.github.io/openssl-certificate-verify-failed.html.
If you get an error like this:
Your bundle is complete! Use bundle show [gemname] to see where a bundled gem is installed.
composer Running 'after bundler' callbacks.
The template [...] could not be loaded.
Error: You have already activated ..., but your Gemfile requires ....
Using bundle exec may solve this.
It's due to conflicting gem versions. See the article "Rails Error: “You have already activated (…)”":http://railsapps.github.io/rails-error-you-have-already-activated.html.
Other problems? Check the "issues":https://github.com/RailsApps/rails3-mongoid-omniauth/issues.
h3. Edit the README
If you're storing the app in a GitHub repository, please edit the README files to add a description of the app and your contact info. If you don't change the README, people will think I am the author of your version of the application.
h2. Getting Started
h3. Install the Required Gems
Check the Gemfile to see which gems are used by this application.
If you used the "Rails Composer":http://railsapps.github.io/rails-composer/ tool to generate the example app, the application template script has already run the @bundle install@ command.
If not, you should run the @bundle install@ command to install the required gems on your computer:
$ bundle install
You can check which gems are installed on your computer with:
$ gem list
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.
I recommend using "rvm":https://rvm.io/, the Ruby Version Manager, to create a project-specific gemset for the application. See the article "Installing Rails":http://railsapps.github.io/installing-rails.html.
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. Configure Email
This example application doesn't send email messa
暂无开放 Issues,或尚未同步最近议题。