oauth2_facebook_grantable 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +5 -0
- data/.rspec +2 -0
- data/Gemfile +8 -0
- data/LICENSE.txt +19 -0
- data/README.md +81 -0
- data/Rakefile +1 -0
- data/lib/devise/oauth2_facebook_grantable/models/oauth2_facebook_grantable.rb +23 -0
- data/lib/devise/oauth2_facebook_grantable/strategies/facebook_grant_type.rb +25 -0
- data/lib/devise/oauth2_facebook_grantable/version.rb +5 -0
- data/lib/generators/oauth2_facebook_grantable/install_generator.rb +32 -0
- data/lib/generators/oauth2_facebook_grantable/templates/migration_add_column.rb +6 -0
- data/lib/oauth2_facebook_grantable.rb +43 -0
- data/oauth2_facebook_grantable.gemspec +25 -0
- data/spec/spec_helper.rb +8 -0
- data/tests/.gitignore +15 -0
- data/tests/Gemfile +41 -0
- data/tests/README.rdoc +261 -0
- data/tests/Rakefile +7 -0
- data/tests/app/assets/images/rails.png +0 -0
- data/tests/app/assets/javascripts/application.js +15 -0
- data/tests/app/assets/stylesheets/application.css +13 -0
- data/tests/app/controllers/application_controller.rb +3 -0
- data/tests/app/helpers/application_helper.rb +2 -0
- data/tests/app/mailers/.gitkeep +0 -0
- data/tests/app/models/.gitkeep +0 -0
- data/tests/app/models/user.rb +12 -0
- data/tests/app/views/layouts/application.html.erb +14 -0
- data/tests/config.ru +4 -0
- data/tests/config/application.rb +59 -0
- data/tests/config/boot.rb +6 -0
- data/tests/config/database.yml +25 -0
- data/tests/config/environment.rb +5 -0
- data/tests/config/environments/development.rb +37 -0
- data/tests/config/environments/production.rb +67 -0
- data/tests/config/environments/test.rb +37 -0
- data/tests/config/initializers/backtrace_silencers.rb +7 -0
- data/tests/config/initializers/devise.rb +223 -0
- data/tests/config/initializers/inflections.rb +15 -0
- data/tests/config/initializers/mime_types.rb +5 -0
- data/tests/config/initializers/secret_token.rb +7 -0
- data/tests/config/initializers/session_store.rb +8 -0
- data/tests/config/initializers/wrap_parameters.rb +14 -0
- data/tests/config/locales/devise.en.yml +57 -0
- data/tests/config/locales/en.yml +5 -0
- data/tests/config/routes.rb +61 -0
- data/tests/config/yetting.yml +12 -0
- data/tests/db/migrate/20120426123002_devise_create_users.rb +49 -0
- data/tests/db/migrate/20120426123040_create_devise_oauth2_providable_schema.devise_oauth2_providable.rb +55 -0
- data/tests/db/migrate/20120426124308_add_facebook_identifier_to_users.rb +6 -0
- data/tests/db/schema.rb +91 -0
- data/tests/db/seeds.rb +7 -0
- data/tests/doc/README_FOR_APP +2 -0
- data/tests/lib/assets/.gitkeep +0 -0
- data/tests/lib/tasks/.gitkeep +0 -0
- data/tests/log/.gitkeep +0 -0
- data/tests/public/404.html +26 -0
- data/tests/public/422.html +26 -0
- data/tests/public/500.html +25 -0
- data/tests/public/favicon.ico +0 -0
- data/tests/public/index.html +241 -0
- data/tests/public/robots.txt +5 -0
- data/tests/script/rails +6 -0
- data/tests/test/fixtures/.gitkeep +0 -0
- data/tests/test/fixtures/users.yml +26 -0
- data/tests/test/functional/.gitkeep +0 -0
- data/tests/test/integration/.gitkeep +0 -0
- data/tests/test/integration/facebook_oauth_test.rb +69 -0
- data/tests/test/performance/browsing_test.rb +12 -0
- data/tests/test/test_helper.rb +13 -0
- data/tests/test/unit/.gitkeep +0 -0
- data/tests/test/unit/user_test.rb +7 -0
- data/tests/vendor/assets/javascripts/.gitkeep +0 -0
- data/tests/vendor/assets/stylesheets/.gitkeep +0 -0
- data/tests/vendor/plugins/.gitkeep +0 -0
- metadata +214 -0
data/.gitignore
ADDED
data/.rspec
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
Copyright (C) 2012 Pierre-Luc Simard
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
4
|
+
this software and associated documentation files (the "Software"), to deal in
|
5
|
+
the Software without restriction, including without limitation the rights to
|
6
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
7
|
+
of the Software, and to permit persons to whom the Software is furnished to do
|
8
|
+
so, subject to the following conditions:
|
9
|
+
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
11
|
+
copies or substantial portions of the Software.
|
12
|
+
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
19
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,81 @@
|
|
1
|
+
# oauth2_facebook_grantable
|
2
|
+
|
3
|
+
Adds a grant_type "facebook" to the existing installation of
|
4
|
+
[devise_oauth2_providable](https://github.com/socialcast/devise_oauth2_providable)
|
5
|
+
|
6
|
+
## Features
|
7
|
+
|
8
|
+
* Allows to provide facebook_id and facebook_access_token to authenticate
|
9
|
+
against an OAuth2 API made with [devise_oauth2_providable](https://github.com/socialcast/devise_oauth2_providable)
|
10
|
+
|
11
|
+
|
12
|
+
## Requirements
|
13
|
+
|
14
|
+
* [Devise](https://github.com/plataformatec/devise) authentication library
|
15
|
+
* [Rails](http://rubyonrails.org/) 3.1 or higher
|
16
|
+
* [Devise OAuth2 Providable](https://github.com/socialcast/devise_oauth2_providable)
|
17
|
+
|
18
|
+
## Installation
|
19
|
+
|
20
|
+
#### Install gem
|
21
|
+
```ruby
|
22
|
+
# Gemfile
|
23
|
+
gem 'oauth2_facebook_grantable'
|
24
|
+
```
|
25
|
+
|
26
|
+
#### Migrate database
|
27
|
+
|
28
|
+
It essentially adds a facebook_identifier column to the User model. It's
|
29
|
+
required so the plugin can find a user based on its facebook_id
|
30
|
+
|
31
|
+
```
|
32
|
+
$ rails g oauth2_facebook_grantable:install
|
33
|
+
$ rake db:migrate
|
34
|
+
```
|
35
|
+
|
36
|
+
|
37
|
+
#### Configure User model to support Facebook authentication
|
38
|
+
|
39
|
+
Add `:oauth2_facebook_grantable` to your `devise` declaration as seen bellow.
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
class User
|
43
|
+
devise :oauth2_providable,
|
44
|
+
:oauth2_password_grantable,
|
45
|
+
:oauth2_refresh_token_grantable,
|
46
|
+
:oauth2_facebook_grantable
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
|
51
|
+
## Using with Facebook grant_type on the client-side
|
52
|
+
|
53
|
+
To authentitcate against to the API using Facebook credentials you need to post
|
54
|
+
the API with the parameter `facebook_identifier` and `facebook_access_token` as
|
55
|
+
shown bellow:
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
post("/oauth/token",
|
59
|
+
:format => :json,
|
60
|
+
:facebook_identifier => facebook_id,
|
61
|
+
:facebook_access_token => facebook_access_token,
|
62
|
+
:grant_type => "facebook",
|
63
|
+
:client_secret => client_secret,
|
64
|
+
:client_id => client_identifier)
|
65
|
+
```
|
66
|
+
|
67
|
+
|
68
|
+
## Contributing
|
69
|
+
|
70
|
+
* Fork the project
|
71
|
+
* Fix the issue
|
72
|
+
* Add unit tests
|
73
|
+
* Submit pull request on github
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
## License
|
78
|
+
|
79
|
+
Copyright (C) 2012 Pierre-Luc Simard
|
80
|
+
See LICENSE.txt for further details.
|
81
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module Devise
|
2
|
+
module Models
|
3
|
+
module Oauth2FacebookGrantable
|
4
|
+
extend ActiveSupport::Concern
|
5
|
+
def valid_facebook_access_token?(token)
|
6
|
+
begin
|
7
|
+
@graph = Koala::Facebook::API.new(token)
|
8
|
+
fb_user = @graph.get_object("me")
|
9
|
+
if(fb_user && fb_user["id"])
|
10
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantable => User with facebook identifier \"#{fb_user["id"]}\" was authenticated successfully by Facebook")
|
11
|
+
return (fb_user["id"].to_s == self.facebook_identifier.to_s)
|
12
|
+
else
|
13
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantable => Could not authenticate user against Facebook (#{fb_user})")
|
14
|
+
return false
|
15
|
+
end
|
16
|
+
rescue => e
|
17
|
+
Devise::Oauth2ProvidableFacebook.logger.error("Oauth2FacebookGrantable => Could not authenticate user: #{e}")
|
18
|
+
return false
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
module Devise
|
2
|
+
module Strategies
|
3
|
+
class Oauth2FacebookGrantTypeStrategy < Oauth2GrantTypeStrategy
|
4
|
+
def grant_type
|
5
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Facebook Grant Loaded")
|
6
|
+
'facebook'
|
7
|
+
end
|
8
|
+
|
9
|
+
def authenticate_grant_type(client)
|
10
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Searching for user with facebook identifier:\"#{params[:facebook_identifier]}\"")
|
11
|
+
resource = mapping.to.find_for_authentication(:facebook_identifier => params[:facebook_identifier])
|
12
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Validating access token for user with facebook identifier:\"#{params[:facebook_identifier]}\"")
|
13
|
+
if validate(resource) { resource.valid_facebook_access_token?(params[:facebook_access_token]) }
|
14
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Token is valid")
|
15
|
+
success! resource
|
16
|
+
elsif !halted?
|
17
|
+
Devise::Oauth2ProvidableFacebook.logger.debug("Oauth2FacebookGrantTypeStrategy => Token is not valid")
|
18
|
+
oauth_error! :invalid_grant, 'could not authenticate to facebook'
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
Warden::Strategies.add(:oauth2_facebook_grantable, Devise::Strategies::Oauth2FacebookGrantTypeStrategy)
|
@@ -0,0 +1,32 @@
|
|
1
|
+
require 'rails/generators'
|
2
|
+
|
3
|
+
module Oauth2FacebookGrantable
|
4
|
+
class InstallGenerator < Rails::Generators::Base
|
5
|
+
include Rails::Generators::Migration
|
6
|
+
source_root File.expand_path('../../templates', __FILE__)
|
7
|
+
desc "Add facebook_identifier column to the 'User' model"
|
8
|
+
|
9
|
+
# Commandline options can be defined here using Thor-like options:
|
10
|
+
class_option :table_name, :type => :string, :default => "users", :desc => "User model name"
|
11
|
+
|
12
|
+
def self.source_root
|
13
|
+
@source_root ||= File.join(File.dirname(__FILE__), 'templates')
|
14
|
+
end
|
15
|
+
|
16
|
+
# Generator Code. Remember this is just suped-up Thor so methods are executed in order
|
17
|
+
def copy_migrations
|
18
|
+
@table_name = options[:table_name]
|
19
|
+
migration_template "migration_add_column.rb", "db/migrate/add_facebook_identifier_to_#{@table_name}"
|
20
|
+
end
|
21
|
+
|
22
|
+
def self.next_migration_number(path)
|
23
|
+
unless @prev_migration_nr
|
24
|
+
@prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
|
25
|
+
else
|
26
|
+
@prev_migration_nr += 1
|
27
|
+
end
|
28
|
+
@prev_migration_nr.to_s
|
29
|
+
end
|
30
|
+
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
require 'devise'
|
2
|
+
require 'rack/oauth2'
|
3
|
+
require 'koala'
|
4
|
+
require 'devise_oauth2_providable'
|
5
|
+
|
6
|
+
require 'devise/oauth2_facebook_grantable/strategies/facebook_grant_type'
|
7
|
+
require 'devise/oauth2_facebook_grantable/models/oauth2_facebook_grantable'
|
8
|
+
|
9
|
+
module Devise
|
10
|
+
module Oauth2ProvidableFacebook
|
11
|
+
def self.logger
|
12
|
+
@@logger
|
13
|
+
end
|
14
|
+
def self.logger=(logger)
|
15
|
+
@@logger = logger
|
16
|
+
end
|
17
|
+
def self.debugging?
|
18
|
+
@@debugging
|
19
|
+
end
|
20
|
+
def self.debugging=(boolean)
|
21
|
+
@@debugging = boolean
|
22
|
+
end
|
23
|
+
|
24
|
+
class Railties < ::Rails::Railtie
|
25
|
+
initializer 'Rails logger' do
|
26
|
+
Devise::Oauth2ProvidableFacebook.logger = Rails.logger
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
class Engine < Rails::Engine
|
31
|
+
engine_name 'oauth2_facebook_grantable'
|
32
|
+
isolate_namespace Devise::Oauth2ProvidableFacebook
|
33
|
+
initializer "oauth2_facebook_grantable.initialize_application", :before=> :load_config_initializers do |app|
|
34
|
+
app.config.filter_parameters << :facebook_access_token
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
Devise.add_module(:oauth2_facebook_grantable,
|
42
|
+
:strategy => true,
|
43
|
+
:model => "devise/oauth2_facebook_grantable/models/oauth2_facebook_grantable")
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.push File.expand_path("../lib", __FILE__)
|
3
|
+
require 'devise/oauth2_facebook_grantable/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |s|
|
6
|
+
s.name = "oauth2_facebook_grantable"
|
7
|
+
s.version = Devise::OAuth2FacebookGrantable::VERSION
|
8
|
+
s.authors = ["Pierre-Luc Simard"]
|
9
|
+
s.email = ["p-l@6x9.ca"]
|
10
|
+
s.homepage = "http://github.com/p-l/oauth2_facebook_grantable"
|
11
|
+
s.summary = %q{Facebook grant type for OAuth2 authentication}
|
12
|
+
s.description = %q{Add facebook as a grant_type to the authentication done through devise_oauth2_providable}
|
13
|
+
|
14
|
+
s.rubyforge_project = "oauth2_facebook_grantable"
|
15
|
+
|
16
|
+
# specify any dependencies here; for example:
|
17
|
+
s.add_runtime_dependency "koala", "~> 1.4.1"
|
18
|
+
s.add_runtime_dependency "devise_oauth2_providable", "~> 1.1.0"
|
19
|
+
s.files = `git ls-files`.split("\n")
|
20
|
+
|
21
|
+
s.test_files = `git ls-files -- {tests,spec,features}/*`.split("\n")
|
22
|
+
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
23
|
+
s.require_paths = ["lib"]
|
24
|
+
|
25
|
+
end
|
data/spec/spec_helper.rb
ADDED
data/tests/.gitignore
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# See http://help.github.com/ignore-files/ for more about ignoring files.
|
2
|
+
#
|
3
|
+
# If you find yourself ignoring temporary files generated by your text editor
|
4
|
+
# or operating system, you probably want to add a global ignore instead:
|
5
|
+
# git config --global core.excludesfile ~/.gitignore_global
|
6
|
+
|
7
|
+
# Ignore bundler config
|
8
|
+
/.bundle
|
9
|
+
|
10
|
+
# Ignore the default SQLite database.
|
11
|
+
/db/*.sqlite3
|
12
|
+
|
13
|
+
# Ignore all logfiles and tempfiles.
|
14
|
+
/log/*.log
|
15
|
+
/tmp
|
data/tests/Gemfile
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
source 'https://rubygems.org'
|
2
|
+
|
3
|
+
gem 'rails', '3.2.2'
|
4
|
+
|
5
|
+
# Bundle edge Rails instead:
|
6
|
+
# gem 'rails', :git => 'git://github.com/rails/rails.git'
|
7
|
+
|
8
|
+
gem 'sqlite3'
|
9
|
+
|
10
|
+
|
11
|
+
# Gems used only for assets and not required
|
12
|
+
# in production environments by default.
|
13
|
+
group :assets do
|
14
|
+
gem 'sass-rails', '~> 3.2.3'
|
15
|
+
gem 'coffee-rails', '~> 3.2.1'
|
16
|
+
|
17
|
+
# See https://github.com/sstephenson/execjs#readme for more supported runtimes
|
18
|
+
# gem 'therubyracer'
|
19
|
+
|
20
|
+
gem 'uglifier', '>= 1.0.3'
|
21
|
+
end
|
22
|
+
|
23
|
+
gem 'jquery-rails'
|
24
|
+
|
25
|
+
gem 'oauth2_facebook_grantable', :path => '..'
|
26
|
+
gem 'yettings'
|
27
|
+
|
28
|
+
# To use ActiveModel has_secure_password
|
29
|
+
# gem 'bcrypt-ruby', '~> 3.0.0'
|
30
|
+
|
31
|
+
# To use Jbuilder templates for JSON
|
32
|
+
# gem 'jbuilder'
|
33
|
+
|
34
|
+
# Use unicorn as the app server
|
35
|
+
# gem 'unicorn'
|
36
|
+
|
37
|
+
# Deploy with Capistrano
|
38
|
+
# gem 'capistrano'
|
39
|
+
|
40
|
+
# To use debugger
|
41
|
+
# gem 'ruby-debug19', :require => 'ruby-debug'
|
data/tests/README.rdoc
ADDED
@@ -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.
|