oauth2_facebook_grantable 0.5.0 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +6 -0
- data/Gemfile +3 -3
- data/lib/devise/oauth2_facebook_grantable/models/oauth2_facebook_grantable.rb +1 -7
- data/lib/devise/oauth2_facebook_grantable/strategies/facebook_grant_type.rb +27 -6
- data/lib/devise/oauth2_facebook_grantable/version.rb +1 -1
- data/lib/oauth2_facebook_grantable.rb +15 -3
- data/oauth2_facebook_grantable.gemspec +1 -1
- data/tests/Gemfile +1 -1
- data/tests/README.md +17 -0
- data/tests/config/environments/test.rb +3 -0
- data/tests/config/initializers/devise.rb +0 -7
- data/tests/test/fixtures/users.yml +3 -0
- data/tests/test/integration/facebook_oauth_test.rb +22 -1
- metadata +7 -7
- data/tests/README.rdoc +0 -261
data/.gitignore
CHANGED
data/Gemfile
CHANGED
@@ -3,6 +3,6 @@ source "http://rubygems.org"
|
|
3
3
|
# Specify your gem's dependencies in oauth2_providable_facebook.gemspec
|
4
4
|
gemspec
|
5
5
|
|
6
|
-
gem 'rspec'
|
7
|
-
gem 'devise_oauth2_providable', '~> 1.1.0'
|
8
|
-
gem 'koala', '~> 1.4.1'
|
6
|
+
#gem 'rspec'
|
7
|
+
#gem 'devise_oauth2_providable', '~> 1.1.0'
|
8
|
+
#gem 'koala', '~> 1.4.1'
|
@@ -3,9 +3,7 @@ module Devise
|
|
3
3
|
module Oauth2FacebookGrantable
|
4
4
|
extend ActiveSupport::Concern
|
5
5
|
def valid_facebook_access_token?(token)
|
6
|
-
|
7
|
-
@graph = Koala::Facebook::API.new(token)
|
8
|
-
fb_user = @graph.get_object("me")
|
6
|
+
fb_user = Devise::Oauth2ProvidableFacebook.facebook_user_for_token(token)
|
9
7
|
if(fb_user && fb_user["id"])
|
10
8
|
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantable => User with facebook identifier \"#{fb_user["id"]}\" was authenticated successfully by Facebook")
|
11
9
|
return (fb_user["id"].to_s == self.facebook_identifier.to_s)
|
@@ -13,10 +11,6 @@ module Devise
|
|
13
11
|
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantable => Could not authenticate user against Facebook (#{fb_user})")
|
14
12
|
return false
|
15
13
|
end
|
16
|
-
rescue => e
|
17
|
-
Devise::Oauth2ProvidableFacebook.logger.error("Oauth2FacebookGrantable => Could not authenticate user: #{e}")
|
18
|
-
return false
|
19
|
-
end
|
20
14
|
end
|
21
15
|
end
|
22
16
|
end
|
@@ -9,13 +9,34 @@ module Devise
|
|
9
9
|
def authenticate_grant_type(client)
|
10
10
|
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Searching for user with facebook identifier:\"#{params[:facebook_identifier]}\"")
|
11
11
|
resource = mapping.to.find_for_authentication(:facebook_identifier => params[:facebook_identifier])
|
12
|
+
|
13
|
+
# If the app could not be found
|
14
|
+
if(!resource)
|
15
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Could not find user with facebook identifer:\"#{params[:facebook_identifier]}\"")
|
16
|
+
fb_user = Devise::Oauth2ProvidableFacebook.facebook_user_for_token(params[:facebook_access_token])
|
17
|
+
if(fb_user && fb_user["email"])
|
18
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Falling back to email:\"#{fb_user["email"]}\"")
|
19
|
+
resource = mapping.to.find_for_authentication(:email => fb_user["email"].to_s)
|
20
|
+
if(resource)
|
21
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Found user with email:\"#{fb_user["email"]}\" saving facebook_idenfier: #{fb_user["id"]}")
|
22
|
+
resource.facebook_identifier = fb_user["id"].to_s
|
23
|
+
resource.save
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
12
28
|
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Validating access token for user with facebook identifier:\"#{params[:facebook_identifier]}\"")
|
13
|
-
if
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
29
|
+
if(resource)
|
30
|
+
if(validate(resource) { resource.valid_facebook_access_token?(params[:facebook_access_token]) })
|
31
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Token is valid")
|
32
|
+
success!(resource)
|
33
|
+
elsif(!halted?)
|
34
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Token is not valid")
|
35
|
+
oauth_error! :invalid_grant, 'could not authenticate to facebook'
|
36
|
+
end
|
37
|
+
else
|
38
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => User not found")
|
39
|
+
oauth_error! :invalid_grant, 'could not authenticate'
|
19
40
|
end
|
20
41
|
end
|
21
42
|
end
|
@@ -21,6 +21,18 @@ module Devise
|
|
21
21
|
@@debugging = boolean
|
22
22
|
end
|
23
23
|
|
24
|
+
def self.facebook_user_for_token(token)
|
25
|
+
begin
|
26
|
+
@@logger.error("Oauth2FacebookGrantable => Getting information from user token: #{token}")
|
27
|
+
@graph = Koala::Facebook::API.new(token)
|
28
|
+
return @graph.get_object("me")
|
29
|
+
rescue => e
|
30
|
+
@@logger.error("Oauth2FacebookGrantable => Could not authenticate with token: #{e}")
|
31
|
+
return false
|
32
|
+
end
|
33
|
+
|
34
|
+
end
|
35
|
+
|
24
36
|
class Railties < ::Rails::Railtie
|
25
37
|
initializer 'Rails logger' do
|
26
38
|
Devise::Oauth2ProvidableFacebook.logger = Rails.logger
|
@@ -34,10 +46,10 @@ module Devise
|
|
34
46
|
app.config.filter_parameters << :facebook_access_token
|
35
47
|
end
|
36
48
|
end
|
37
|
-
|
49
|
+
|
38
50
|
end
|
39
51
|
end
|
40
52
|
|
41
53
|
Devise.add_module(:oauth2_facebook_grantable,
|
42
|
-
|
43
|
-
|
54
|
+
:strategy => true,
|
55
|
+
:model => "devise/oauth2_facebook_grantable/models/oauth2_facebook_grantable")
|
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
|
|
14
14
|
s.rubyforge_project = "oauth2_facebook_grantable"
|
15
15
|
|
16
16
|
# specify any dependencies here; for example:
|
17
|
-
s.add_runtime_dependency "koala", "~> 1.
|
17
|
+
s.add_runtime_dependency "koala", "~> 1.6.0"
|
18
18
|
s.add_runtime_dependency "devise_oauth2_providable", "~> 1.1.0"
|
19
19
|
s.files = `git ls-files`.split("\n")
|
20
20
|
|
data/tests/Gemfile
CHANGED
data/tests/README.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# oauth2_facebook_grantable Test Rails App
|
2
|
+
|
3
|
+
## Before running the tests
|
4
|
+
|
5
|
+
If it's the first time you're running the test you need to install dependancies.
|
6
|
+
|
7
|
+
```
|
8
|
+
bundle install
|
9
|
+
```
|
10
|
+
|
11
|
+
## Running tests
|
12
|
+
|
13
|
+
Simple, just:
|
14
|
+
|
15
|
+
```
|
16
|
+
rake test:integration
|
17
|
+
```
|
@@ -9,9 +9,6 @@ Devise.setup do |config|
|
|
9
9
|
# Configure the class responsible to send e-mails.
|
10
10
|
# config.mailer = "Devise::Mailer"
|
11
11
|
|
12
|
-
# Automatically apply schema changes in tableless databases
|
13
|
-
config.apply_schema = false
|
14
|
-
|
15
12
|
# ==> ORM configuration
|
16
13
|
# Load and configure the ORM. Supports :active_record (default) and
|
17
14
|
# :mongoid (bson_ext recommended) by default. Other ORMs may be
|
@@ -111,10 +108,6 @@ Devise.setup do |config|
|
|
111
108
|
# If true, extends the user's remember period when remembered via cookie.
|
112
109
|
# config.extend_remember_period = false
|
113
110
|
|
114
|
-
# If true, uses the password salt as remember token. This should be turned
|
115
|
-
# to false if you are not using database authenticatable.
|
116
|
-
config.use_salt_as_remember_token = true
|
117
|
-
|
118
111
|
# Options to be passed to the created cookie. For instance, you can set
|
119
112
|
# :secure => true in order to force SSL only cookies.
|
120
113
|
# config.cookie_options = {}
|
@@ -12,6 +12,7 @@ class FacebookOauthTest < ActionDispatch::IntegrationTest
|
|
12
12
|
|
13
13
|
# Setup a default user
|
14
14
|
@user = users(:user)
|
15
|
+
@email_user = users(:email_user)
|
15
16
|
|
16
17
|
# Get facebook application credentials
|
17
18
|
fb_key = Yetting.facebook_api_key
|
@@ -21,10 +22,17 @@ class FacebookOauthTest < ActionDispatch::IntegrationTest
|
|
21
22
|
@test_users = Koala::Facebook::TestUsers.new(:app_id => fb_key, :secret => fb_secret)
|
22
23
|
@fb_user = @test_users.create(true, "read_stream")
|
23
24
|
@other_fb_user = @test_users.create(true, "read_stream")
|
25
|
+
@email_fb_user = @test_users.create(true, "read_stream,email")
|
26
|
+
|
24
27
|
|
25
28
|
# Associate the facebook user with the default user
|
26
29
|
@user.facebook_identifier = @fb_user["id"]
|
27
30
|
@user.save
|
31
|
+
|
32
|
+
# Associate the facebook email with the email user
|
33
|
+
@email_user.email = @email_fb_user["email"]
|
34
|
+
@email_user.save
|
35
|
+
|
28
36
|
end
|
29
37
|
|
30
38
|
def teardown
|
@@ -52,7 +60,7 @@ class FacebookOauthTest < ActionDispatch::IntegrationTest
|
|
52
60
|
:grant_type => "facebook",
|
53
61
|
:client_secret => @client.secret,
|
54
62
|
:client_id => @client.identifier)
|
55
|
-
assert_response :
|
63
|
+
assert_response :unauthorized
|
56
64
|
end
|
57
65
|
|
58
66
|
test "Authenticate with valid token but invalid id" do
|
@@ -66,4 +74,17 @@ class FacebookOauthTest < ActionDispatch::IntegrationTest
|
|
66
74
|
assert_response :bad_request
|
67
75
|
end
|
68
76
|
|
77
|
+
test "Authenticate with with valid email fallback and token" do
|
78
|
+
post_via_redirect("/oauth/token",
|
79
|
+
:format => :json,
|
80
|
+
:facebook_identifier => @email_fb_user["id"],
|
81
|
+
:facebook_access_token => @email_fb_user["access_token"],
|
82
|
+
:grant_type => "facebook",
|
83
|
+
:client_secret => @client.secret,
|
84
|
+
:client_id => @client.identifier)
|
85
|
+
assert_response :ok
|
86
|
+
user = User.where(:facebook_identifier => @email_fb_user["id"]).first
|
87
|
+
assert(user, "User was not updated with valide facebook identifier")
|
88
|
+
end
|
89
|
+
|
69
90
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: oauth2_facebook_grantable
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-
|
12
|
+
date: 2012-12-18 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: koala
|
@@ -18,7 +18,7 @@ dependencies:
|
|
18
18
|
requirements:
|
19
19
|
- - ~>
|
20
20
|
- !ruby/object:Gem::Version
|
21
|
-
version: 1.
|
21
|
+
version: 1.6.0
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ~>
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 1.
|
29
|
+
version: 1.6.0
|
30
30
|
- !ruby/object:Gem::Dependency
|
31
31
|
name: devise_oauth2_providable
|
32
32
|
requirement: !ruby/object:Gem::Requirement
|
@@ -69,7 +69,7 @@ files:
|
|
69
69
|
- spec/spec_helper.rb
|
70
70
|
- tests/.gitignore
|
71
71
|
- tests/Gemfile
|
72
|
-
- tests/README.
|
72
|
+
- tests/README.md
|
73
73
|
- tests/Rakefile
|
74
74
|
- tests/app/assets/images/rails.png
|
75
75
|
- tests/app/assets/javascripts/application.js
|
@@ -147,14 +147,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
147
147
|
version: '0'
|
148
148
|
requirements: []
|
149
149
|
rubyforge_project: oauth2_facebook_grantable
|
150
|
-
rubygems_version: 1.8.
|
150
|
+
rubygems_version: 1.8.23
|
151
151
|
signing_key:
|
152
152
|
specification_version: 3
|
153
153
|
summary: Facebook grant type for OAuth2 authentication
|
154
154
|
test_files:
|
155
155
|
- spec/spec_helper.rb
|
156
156
|
- tests/Gemfile
|
157
|
-
- tests/README.
|
157
|
+
- tests/README.md
|
158
158
|
- tests/Rakefile
|
159
159
|
- tests/app/assets/images/rails.png
|
160
160
|
- tests/app/assets/javascripts/application.js
|
data/tests/README.rdoc
DELETED
@@ -1,261 +0,0 @@
|
|
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.
|