oa2c 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. data/.gitignore +9 -0
  2. data/.rspec +2 -0
  3. data/.travis.yml +3 -0
  4. data/Gemfile +18 -0
  5. data/README.md +29 -3
  6. data/app/controllers/oa2c/authorizations_controller.rb +12 -15
  7. data/app/models/oa2c/authorization_code.rb +2 -0
  8. data/app/models/oa2c/client.rb +1 -0
  9. data/app/models/oa2c/oauth2_token.rb +1 -1
  10. data/app/models/oa2c/refresh_token.rb +1 -1
  11. data/app/models/oa2c/user.rb +9 -0
  12. data/app/views/oa2c/{_form.html.erb → authorizations/_form.html.erb} +1 -1
  13. data/app/views/oa2c/{error.html.erb → authorizations/error.html.erb} +0 -0
  14. data/app/views/oa2c/{new.html.erb → authorizations/new.html.erb} +0 -0
  15. data/config/routes.rb +2 -2
  16. data/lib/oa2c.rb +24 -0
  17. data/lib/oa2c/authentication.rb +5 -5
  18. data/lib/oa2c/engine.rb +0 -1
  19. data/lib/oa2c/middleware.rb +10 -0
  20. data/lib/oa2c/version.rb +1 -1
  21. data/oa2c.gemspec +31 -0
  22. data/spec/dummy/README.rdoc +261 -0
  23. data/spec/dummy/Rakefile +7 -0
  24. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  25. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  26. data/spec/dummy/app/controllers/application_controller.rb +24 -0
  27. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  28. data/spec/dummy/app/mailers/.gitkeep +0 -0
  29. data/spec/dummy/app/models/.gitkeep +0 -0
  30. data/spec/dummy/app/models/user.rb +10 -0
  31. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  32. data/spec/dummy/config.ru +4 -0
  33. data/spec/dummy/config/application.rb +67 -0
  34. data/spec/dummy/config/boot.rb +10 -0
  35. data/spec/dummy/config/database.yml +25 -0
  36. data/spec/dummy/config/environment.rb +5 -0
  37. data/spec/dummy/config/environments/development.rb +37 -0
  38. data/spec/dummy/config/environments/production.rb +67 -0
  39. data/spec/dummy/config/environments/test.rb +37 -0
  40. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  41. data/spec/dummy/config/initializers/inflections.rb +15 -0
  42. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  43. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  44. data/spec/dummy/config/initializers/session_store.rb +8 -0
  45. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  46. data/spec/dummy/config/locales/en.yml +5 -0
  47. data/spec/dummy/config/mongoid.yml +68 -0
  48. data/spec/dummy/config/routes.rb +9 -0
  49. data/spec/dummy/db/.gitkeep +0 -0
  50. data/spec/dummy/lib/assets/.gitkeep +0 -0
  51. data/spec/dummy/log/.gitkeep +0 -0
  52. data/spec/dummy/public/404.html +26 -0
  53. data/spec/dummy/public/422.html +26 -0
  54. data/spec/dummy/public/500.html +25 -0
  55. data/spec/dummy/public/favicon.ico +0 -0
  56. data/spec/dummy/script/rails +6 -0
  57. data/spec/factories/access_token.rb +9 -0
  58. data/spec/factories/authorization_code.rb +7 -0
  59. data/spec/factories/client.rb +5 -0
  60. data/spec/factories/refresh_token.rb +6 -0
  61. data/spec/factories/user.rb +6 -0
  62. data/spec/models/oa2c/access_token_spec.rb +15 -0
  63. data/spec/models/oa2c/authorization_code_spec.rb +8 -0
  64. data/spec/models/oa2c/client_spec.rb +14 -0
  65. data/spec/models/oa2c/oauth2_token_spec.rb +31 -0
  66. data/spec/models/oa2c/refresh_token_spec.rb +8 -0
  67. data/spec/oa2c_spec.rb +6 -0
  68. data/spec/requests/autorization_request_spec.rb +57 -0
  69. data/spec/requests/resource_request_spec.rb +25 -0
  70. data/spec/requests/token_request_spec.rb +57 -0
  71. data/spec/spec_helper.rb +39 -0
  72. data/spec/support/devise.rb +15 -0
  73. metadata +172 -16
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ .bundle/
2
+ log/*.log
3
+ pkg/
4
+ spec/dummy/db/*.sqlite3
5
+ spec/dummy/log/*.log
6
+ spec/dummy/tmp/
7
+ spec/dummy/.sass-cache
8
+ vendor
9
+ Gemfile.lock
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --format progress
data/.travis.yml ADDED
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 1.9.3
data/Gemfile ADDED
@@ -0,0 +1,18 @@
1
+ source "http://rubygems.org"
2
+
3
+ # Declare your gem's dependencies in oa2c.gemspec.
4
+ # Bundler will treat runtime dependencies like base dependencies, and
5
+ # development dependencies will be added by default to the :development group.
6
+ gemspec
7
+
8
+ # jquery-rails is used by the dummy application
9
+ gem "jquery-rails"
10
+
11
+ # Declare any dependencies that are still in development here instead of in
12
+ # your gemspec. These might include edge Rails or gems from your path or
13
+ # Git. Remember to move these dependencies to your gemspec before releasing
14
+ # your gem to rubygems.org.
15
+
16
+ # To use debugger
17
+ # gem 'debugger'
18
+ gem "pry-rails"
data/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Oa2c - OAuth2 Container
2
2
 
3
+ [![Build Status](https://secure.travis-ci.org/adie/oa2c.png)](http://travis-ci.org/adie/oa2c)
4
+
3
5
  Rails OAuth2 provider engine to support embedded iframe applications from different sites. Just like games on Facebook.
4
6
 
5
7
  Heavily depends on [rack-oauth2](https://github.com/nov/rack-oauth2) gem.
@@ -8,10 +10,34 @@ It's mostly extract from [rack-oauth2-sample](https://github.com/nov/rack-oauth2
8
10
 
9
11
  Right now it supports only Mongoid 3 as ORM.
10
12
 
11
- # TODO
13
+ # Configuration
14
+
15
+ To change some settings, e.g. user model, add an initializer `config/initializers/oa2c.rb`:
16
+
17
+ ```ruby
18
+ Oa2c.setup do |config|
19
+ config.user_model = "User"
20
+ config.authentication_method = :authenticate_user!
21
+ config.login_method = :sign_in
22
+ config.current_user_method = :current_user
23
+ config.find_for_user_password_authentication = proc {|username, password|
24
+ user = Oa2c.user_model.constantize.where(email: username).first
25
+ user if user.valid_password? password
26
+ }
27
+ end
28
+ ```
29
+
30
+ **Note**: these are defaults for Devise. You don't need to do anything if you use the same settings
31
+
32
+ # User model
33
+
34
+ You need to add this line to your user model:
35
+
36
+ ```ruby
37
+ include Oa2c::User
38
+ ```
12
39
 
13
- * Write specs
14
- * Support for ActiveRecord
40
+ This will add `access_tokens` and `authorization_codes` associations.
15
41
 
16
42
  # License
17
43
 
@@ -1,6 +1,6 @@
1
1
  module Oa2c
2
- class AuthorizationsController < ActionController::Base
3
- before_filter :authorize, except: :token
2
+ class AuthorizationsController < ApplicationController
3
+ before_filter Oa2c.authentication_method, except: :token
4
4
 
5
5
  rescue_from Rack::OAuth2::Server::Authorize::BadRequest do |e|
6
6
  @error = e
@@ -8,11 +8,11 @@ module Oa2c
8
8
  end
9
9
 
10
10
  def new
11
- respond *authorize_endpoint.call(request.env)
11
+ respond(*authorize_endpoint.call(request.env))
12
12
  end
13
13
 
14
14
  def create
15
- respond *authorize_endpoint(true).call(request.env)
15
+ respond(*authorize_endpoint(true).call(request.env))
16
16
  end
17
17
 
18
18
  def token
@@ -34,16 +34,16 @@ module Oa2c
34
34
 
35
35
  def authorize_endpoint(allow_approval = false)
36
36
  Rack::OAuth2::Server::Authorize.new do |req, res|
37
- @client = Auth::Client.where(identifier: req.client_id).first || req.bad_request!
37
+ @client = Client.where(identifier: req.client_id).first || req.bad_request!
38
38
  res.redirect_uri = @redirect_uri = req.verify_redirect_uri!(@client.redirect_uri)
39
39
  if allow_approval
40
40
  if params[:approve]
41
41
  case req.response_type
42
42
  when :code
43
- authorization_code = current_user.authorization_codes.create(client_id: @client.id, redirect_uri: res.redirect_uri)
43
+ authorization_code = send(Oa2c.current_user_method).authorization_codes.create(client_id: @client.id, redirect_uri: res.redirect_uri)
44
44
  res.code = authorization_code.token
45
45
  when :token
46
- res.access_token = current_user.access_tokens.create(client_id: @client.id).to_bearer_token
46
+ res.access_token = send(Oa2c.current_user_method).access_tokens.create(client_id: @client.id).to_bearer_token
47
47
  end
48
48
  res.approve!
49
49
  else
@@ -57,23 +57,21 @@ module Oa2c
57
57
 
58
58
  def token_endpoint
59
59
  Rack::OAuth2::Server::Token.new do |req, res|
60
- client = Auth::Client.where(identifier: req.client_id).first || req.invalid_client!
60
+ client = Client.where(identifier: req.client_id).first || req.invalid_client!
61
61
  client.secret == req.client_secret || req.invalid_client!
62
62
  case req.grant_type
63
63
  when :authorization_code
64
- code = Auth::AuthorizationCode.valid.where(token: req.code).first
64
+ code = AuthorizationCode.valid.where(token: req.code).first
65
65
  req.invalid_grant! if code.blank? || code.redirect_uri != req.redirect_uri
66
66
  res.access_token = code.access_token.to_bearer_token(:with_refresh_token)
67
67
  when :password
68
- # NOTE: password is not hashed in this sample app. Don't do the same on your app.
69
- # FIXME
70
- account = Account.find_by_username_and_password(req.username, req.password) || req.invalid_grant!
71
- res.access_token = account.access_tokens.create(:client => client).to_bearer_token(:with_refresh_token)
68
+ user = Oa2c.find_user_for_password_authentication.call(req.username, req.password) || req.invalid_grant!
69
+ res.access_token = user.access_tokens.create(:client => client).to_bearer_token(:with_refresh_token)
72
70
  when :client_credentials
73
71
  # NOTE: client is already authenticated here.
74
72
  res.access_token = client.access_tokens.create.to_bearer_token
75
73
  when :refresh_token
76
- refresh_token = client.refresh_tokens.valid.wehre(token: req.refresh_token).first
74
+ refresh_token = client.refresh_tokens.valid.where(token: req.refresh_token).first
77
75
  req.invalid_grant! unless refresh_token
78
76
  res.access_token = refresh_token.access_tokens.create.to_bearer_token
79
77
  else
@@ -82,6 +80,5 @@ module Oa2c
82
80
  end
83
81
  end
84
82
  end
85
-
86
83
  end
87
84
  end
@@ -3,6 +3,8 @@ module Oa2c
3
3
  include Mongoid::Document
4
4
  include OAuth2Token
5
5
 
6
+ field :redirect_uri
7
+
6
8
  def access_token
7
9
  @access_token ||= expire! && user.access_tokens.create(client: client)
8
10
  end
@@ -5,6 +5,7 @@ module Oa2c
5
5
  field :identifier
6
6
  field :secret
7
7
  field :redirect_uri
8
+ field :name
8
9
 
9
10
  has_many :access_tokens
10
11
  has_many :refresh_tokens
@@ -9,7 +9,7 @@ module Oa2c
9
9
  field :token
10
10
  field :expires_at, type: Time
11
11
 
12
- belongs_to :user
12
+ belongs_to :user, class_name: Oa2c.user_model
13
13
  belongs_to :client
14
14
 
15
15
  before_validation :setup, on: :create
@@ -4,7 +4,7 @@ module Oa2c
4
4
  include OAuth2Token
5
5
 
6
6
  self.default_lifetime = 1.month
7
- has_many :access_tokens
7
+ has_many :access_tokens, autosave: true
8
8
  end
9
9
  end
10
10
 
@@ -0,0 +1,9 @@
1
+ module Oa2c
2
+ module User
3
+ extend ActiveSupport::Concern
4
+ included do
5
+ has_many :access_tokens, :class_name => "Oa2c::AccessToken"
6
+ has_many :authorization_codes, :class_name => "Oa2c::AuthorizationCode"
7
+ end
8
+ end
9
+ end
@@ -3,5 +3,5 @@
3
3
  <%= hidden_field_tag :response_type, response_type %>
4
4
  <%= hidden_field_tag :redirect_uri, redirect_uri %>
5
5
  <%= submit_tag action.to_s.capitalize %>
6
- <%= hiden_field_tag action, true %>
6
+ <%= hidden_field_tag action, true %>
7
7
  <% end %>
data/config/routes.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  Oa2c::Engine.routes.draw do
2
- post 'authorizations/create'
2
+ post 'authorizations/create' => 'authorizations#create', :as => 'authorizations'
3
3
  match 'authorize', to: 'authorizations#new'
4
- match 'token', to: proc {|env| Auth::AuthorizationsController.new.send(:token_endpoint).call(env) }
4
+ match 'token', to: proc {|env| Oa2c::AuthorizationsController.new.send(:token_endpoint).call(env) }
5
5
  end
data/lib/oa2c.rb CHANGED
@@ -3,4 +3,28 @@ require 'mongoid'
3
3
  require 'oa2c/engine'
4
4
 
5
5
  module Oa2c
6
+ autoload :Authentication, 'oa2c/authentication'
7
+ autoload :Middleware, 'oa2c/middleware'
8
+
9
+ mattr_accessor :user_model
10
+ @@user_model = "User"
11
+
12
+ mattr_accessor :authentication_method
13
+ @@authentication_method = :authenticate_user!
14
+
15
+ mattr_accessor :login_method
16
+ @@login_method = :sign_in
17
+
18
+ mattr_accessor :current_user_method
19
+ @@current_user_method = :current_user
20
+
21
+ mattr_accessor :find_user_for_password_authentication
22
+ @@find_user_for_password_authentication = proc {|username, password|
23
+ user = Oa2c.user_model.constantize.where(email: username).first
24
+ user if user.valid_password? password
25
+ }
26
+
27
+ def self.setup
28
+ yield self
29
+ end
6
30
  end
@@ -9,20 +9,20 @@ module Oa2c
9
9
  end
10
10
 
11
11
  def require_oauth_token
12
- @current_token = Auth::AccessToken.where(token: request.env[Rack::OAuth2::Server::Resource::ACCESS_TOKEN].token).first # FIXME Right now an AccessToken object is store here, need to store only token
12
+ @current_token = request.env[Rack::OAuth2::Server::Resource::ACCESS_TOKEN]
13
13
  raise Rack::OAuth2::Server::Resource::Bearer::Unauthorized unless @current_token
14
14
  end
15
15
 
16
16
  def require_oauth_user_token
17
17
  require_oauth_token
18
- raise Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(:invalid_token, 'User token is required') unless @current_token.user
19
- authenticate @current_token.user
18
+ raise Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(:invalid_token, 'User token is required') unless current_token.user
19
+ send Oa2c.login_method, current_token.user
20
20
  end
21
21
 
22
22
  def require_oauth_client_token
23
23
  require_oauth_token
24
- raise Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(:invalid_token, 'Client token is required') if @current_token.user
25
- @current_client = @current_token.client
24
+ raise Rack::OAuth2::Server::Resource::Bearer::Unauthorized.new(:invalid_token, 'Client token is required') if current_token.user
25
+ @current_client = current_token.client
26
26
  end
27
27
  end
28
28
  end
data/lib/oa2c/engine.rb CHANGED
@@ -1,6 +1,5 @@
1
1
  module Oa2c
2
2
  class Engine < Rails::Engine
3
3
  isolate_namespace Oa2c
4
- config.orm = :mongoid
5
4
  end
6
5
  end
@@ -0,0 +1,10 @@
1
+ module Oa2c
2
+ class Middleware < Rack::OAuth2::Server::Resource::Bearer
3
+ def initialize(app, realm = nil, &block)
4
+ block ||= proc { |req|
5
+ Oa2c::AccessToken.valid.where(token: req.access_token).first || req.invalid_token!
6
+ }
7
+ super app, realm, &block
8
+ end
9
+ end
10
+ end
data/lib/oa2c/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Oa2c
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
data/oa2c.gemspec ADDED
@@ -0,0 +1,31 @@
1
+ $:.push File.expand_path("../lib", __FILE__)
2
+
3
+ # Maintain your gem's version:
4
+ require "oa2c/version"
5
+
6
+ # Describe your gem and declare its dependencies:
7
+ Gem::Specification.new do |s|
8
+ s.name = "oa2c"
9
+ s.version = Oa2c::VERSION
10
+ s.authors = ["Anton Dieterle"]
11
+ s.email = ["antondie@gmail.com"]
12
+ s.homepage = "https://github.com/adie/oa2c"
13
+ s.summary = "OAuth2 authorization for embedded iframe applications."
14
+ s.description = "Rails engine to provide OAuth2 authorization for embedded iframe applications."
15
+
16
+ s.files = `git ls-files`.split("\n")
17
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
18
+
19
+ s.add_dependency "rails", "~> 3.2.0"
20
+ s.add_dependency "rack-oauth2", "~> 0.14.9"
21
+ s.add_dependency "mongoid", "~> 3.0"
22
+
23
+ s.add_development_dependency "rspec-rails"
24
+ s.add_development_dependency "sqlite3"
25
+ s.add_development_dependency "capybara"
26
+ s.add_development_dependency "timecop"
27
+ s.add_development_dependency "capybara"
28
+ s.add_development_dependency "devise"
29
+ s.add_development_dependency "factory_girl_rails"
30
+ s.add_development_dependency "database_cleaner"
31
+ end
@@ -0,0 +1,261 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.all
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.org/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- assets
160
+ | |-- images
161
+ | |-- javascripts
162
+ | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | `-- tasks
177
+ |-- log
178
+ |-- public
179
+ |-- script
180
+ |-- test
181
+ | |-- fixtures
182
+ | |-- functional
183
+ | |-- integration
184
+ | |-- performance
185
+ | `-- unit
186
+ |-- tmp
187
+ | |-- cache
188
+ | |-- pids
189
+ | |-- sessions
190
+ | `-- sockets
191
+ `-- vendor
192
+ |-- assets
193
+ `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.