devise_oam 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.md +67 -0
- data/Rakefile +38 -0
- data/lib/devise_oam/authenticatable_entity.rb +15 -0
- data/lib/devise_oam/strategies/header_authenticatable.rb +50 -0
- data/lib/devise_oam/version.rb +3 -0
- data/lib/devise_oam.rb +23 -0
- data/lib/tasks/devise_oam_tasks.rake +4 -0
- data/test/devise_oam_test.rb +96 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +4 -0
- data/test/dummy/app/controllers/users_controller.rb +2 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/models/user.rb +35 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/app/views/users/index.html.erb +3 -0
- data/test/dummy/config/application.rb +56 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +16 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/devise.rb +229 -0
- data/test/dummy/config/initializers/devise_oam.rb +5 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/devise.en.yml +57 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +63 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/db/migrate/20120514070218_devise_create_users.rb +49 -0
- data/test/dummy/db/migrate/20120521064519_add_roles_mask_to_users.rb +5 -0
- data/test/dummy/db/schema.rb +35 -0
- data/test/dummy/log/test.log +65 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/dummy/test/fixtures/users.yml +11 -0
- data/test/dummy/test/unit/user_test.rb +7 -0
- data/test/support/helpers.rb +19 -0
- data/test/test_helper.rb +18 -0
- metadata +194 -0
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2012 YOURNAME
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,67 @@
|
|
1
|
+
# DeviseOam [![Build Status](https://secure.travis-ci.org/whatthewhat/devise_oam.png)](http://travis-ci.org/whatthewhat/devise_oam)
|
2
|
+
|
3
|
+
OAM authentication strategy for devise.
|
4
|
+
|
5
|
+
This Rails engine adds header based authentication strategy to [devise](https://github.com/plataformatec/devise) for
|
6
|
+
integration with Oracle Access Manager.
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
In **Rails 3**, add this to your Gemfile and run the `bundle` command.
|
10
|
+
|
11
|
+
gem "devise_oam", github: "whatthewhat/devise_oam"
|
12
|
+
|
13
|
+
## Usage
|
14
|
+
1) Add the `HeaderAuthenticatable` strategy in devise initializer `config/initializers/devise.rb`:
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
# Add HeaderAuthenticatable strategy to Warden:
|
18
|
+
config.warden do |manager|
|
19
|
+
manager.strategies.add(:custom_auth, DeviseOam::Devise::Strategies::HeaderAuthenticatable)
|
20
|
+
manager.default_strategies(:scope => :user).unshift :custom_auth
|
21
|
+
end
|
22
|
+
```
|
23
|
+
|
24
|
+
2) Set `DeviseOam` settings (i.e. in `config/initializers/devise_oam.rb`):
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
DeviseOam.setup do |config|
|
28
|
+
config.oam_header = "OAM_REMOTE_USER"
|
29
|
+
config.user_class = "User"
|
30
|
+
config.user_login_field = "email"
|
31
|
+
config.create_user_if_not_found = false
|
32
|
+
end
|
33
|
+
```
|
34
|
+
### Settings explained:
|
35
|
+
* `oam_header` - HTTP header that triggers the authentication strategy, should have user login as a value
|
36
|
+
* `user_class` - class of your devise user model
|
37
|
+
* `user_login_field` - login field for the user model (should be unique)
|
38
|
+
* `create_user_if_not_found` - if set to true this will create a new user if no user was found
|
39
|
+
* `create_user_method` - method in the `user_class` to handle new user creation
|
40
|
+
* `ldap_header` - HTTP header for LDAP roles
|
41
|
+
* `roles_setter` - method in the `user_class` to handle updating user roles
|
42
|
+
|
43
|
+
### Automatic user creation
|
44
|
+
If you need to automatically create new users based on `oam_header` you need to do the following:
|
45
|
+
|
46
|
+
1. Set `create_user_if_not_found` setting to `true`
|
47
|
+
2. Add a method to your user class that will accept a hash of params (`user_login_field` and also `:roles` if you are using LDAP roles) and create a new user
|
48
|
+
3. In the initializer set the `create_user_method` setting to the method you've just added
|
49
|
+
|
50
|
+
For an example see `test/dummy` app.
|
51
|
+
|
52
|
+
### LDAP roles
|
53
|
+
To use LDAP roles parsing:
|
54
|
+
|
55
|
+
1. Set `ldap_header` setting to the HTTP header with roles (should be a comma separated string)
|
56
|
+
2. Add a method to your user class that will accept an array with roles and update the user
|
57
|
+
3. In the initializer set `roles_setter` setting to the method you've just created
|
58
|
+
|
59
|
+
For an example see `test/dummy` app.
|
60
|
+
|
61
|
+
## Links
|
62
|
+
* [Devise](https://github.com/plataformatec/devise)
|
63
|
+
* [Warden authentication strategies](https://github.com/hassox/warden/wiki/Strategies)
|
64
|
+
|
65
|
+
## License
|
66
|
+
|
67
|
+
This project uses MIT-LICENSE.
|
data/Rakefile
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
begin
|
3
|
+
require 'bundler/setup'
|
4
|
+
rescue LoadError
|
5
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
6
|
+
end
|
7
|
+
begin
|
8
|
+
require 'rdoc/task'
|
9
|
+
rescue LoadError
|
10
|
+
require 'rdoc/rdoc'
|
11
|
+
require 'rake/rdoctask'
|
12
|
+
RDoc::Task = Rake::RDocTask
|
13
|
+
end
|
14
|
+
|
15
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
16
|
+
rdoc.rdoc_dir = 'rdoc'
|
17
|
+
rdoc.title = 'DeviseOam'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('README.rdoc')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
Bundler::GemHelper.install_tasks
|
27
|
+
|
28
|
+
require 'rake/testtask'
|
29
|
+
|
30
|
+
Rake::TestTask.new(:test) do |t|
|
31
|
+
t.libs << 'lib'
|
32
|
+
t.libs << 'test'
|
33
|
+
t.pattern = 'test/**/*_test.rb'
|
34
|
+
t.verbose = false
|
35
|
+
end
|
36
|
+
|
37
|
+
|
38
|
+
task :default => :test
|
@@ -0,0 +1,15 @@
|
|
1
|
+
module DeviseOam
|
2
|
+
class AuthenticatableEntity
|
3
|
+
attr_accessor :login, :ldap_roles
|
4
|
+
|
5
|
+
def initialize(login, ldap_roles = nil)
|
6
|
+
@login = login.strip.downcase
|
7
|
+
@ldap_roles = parse_ldap_roles(ldap_roles) if ldap_roles
|
8
|
+
end
|
9
|
+
|
10
|
+
private
|
11
|
+
def parse_ldap_roles(ldap_roles)
|
12
|
+
ldap_roles.strip.downcase.split(',')
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
module DeviseOam
|
2
|
+
module Devise
|
3
|
+
module Strategies
|
4
|
+
class HeaderAuthenticatable < ::Devise::Strategies::Base
|
5
|
+
attr_reader :authenticatable
|
6
|
+
|
7
|
+
def valid?
|
8
|
+
# this strategy is only valid if there is a DeviseOam.oam_header header in the request
|
9
|
+
request.headers[DeviseOam.oam_header]
|
10
|
+
end
|
11
|
+
|
12
|
+
def authenticate!
|
13
|
+
failure_message = "OAM authentication failed"
|
14
|
+
|
15
|
+
oam_data = request.headers[DeviseOam.oam_header]
|
16
|
+
if DeviseOam.ldap_header
|
17
|
+
ldap_data = request.headers[DeviseOam.ldap_header] || ""
|
18
|
+
end
|
19
|
+
|
20
|
+
if oam_data.blank?
|
21
|
+
fail!(failure_message)
|
22
|
+
else
|
23
|
+
@authenticatable = AuthenticatableEntity.new(oam_data, ldap_data)
|
24
|
+
|
25
|
+
user = find_or_create_user
|
26
|
+
success!(user)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def set_roles?
|
31
|
+
!DeviseOam.ldap_header.blank? && @authenticatable.ldap_roles
|
32
|
+
end
|
33
|
+
|
34
|
+
private
|
35
|
+
|
36
|
+
def find_or_create_user
|
37
|
+
user = DeviseOam.user_class.where({ DeviseOam.user_login_field.to_sym => @authenticatable.login }).first
|
38
|
+
|
39
|
+
if user.nil? && DeviseOam.create_user_if_not_found
|
40
|
+
user = DeviseOam.user_class.send(DeviseOam.create_user_method, { DeviseOam.user_login_field.to_sym => @authenticatable.login, :roles => @authenticatable.ldap_roles })
|
41
|
+
elsif user && set_roles?
|
42
|
+
user.send(DeviseOam.roles_setter, @authenticatable.ldap_roles)
|
43
|
+
end
|
44
|
+
|
45
|
+
user
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
data/lib/devise_oam.rb
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
require "devise"
|
2
|
+
require "devise_oam/strategies/header_authenticatable"
|
3
|
+
require "devise_oam/authenticatable_entity"
|
4
|
+
|
5
|
+
module DeviseOam
|
6
|
+
|
7
|
+
# Settings
|
8
|
+
mattr_accessor :oam_header
|
9
|
+
mattr_accessor :user_class
|
10
|
+
mattr_accessor :user_login_field
|
11
|
+
mattr_accessor :create_user_if_not_found
|
12
|
+
mattr_accessor :create_user_method
|
13
|
+
mattr_accessor :ldap_header
|
14
|
+
mattr_accessor :roles_setter
|
15
|
+
|
16
|
+
def self.setup
|
17
|
+
yield self
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.user_class
|
21
|
+
@@user_class.constantize
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,96 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
include TestHelpers
|
3
|
+
|
4
|
+
class DeviseOamTest < ActiveSupport::TestCase
|
5
|
+
def setup
|
6
|
+
set_default_settings
|
7
|
+
|
8
|
+
@strategy = DeviseOam::Devise::Strategies::HeaderAuthenticatable.new(env_with_params("/", {}, { "HTTP_#{DeviseOam.oam_header}" => "foo" }))
|
9
|
+
end
|
10
|
+
|
11
|
+
test "truth" do
|
12
|
+
assert_kind_of Module, DeviseOam
|
13
|
+
end
|
14
|
+
|
15
|
+
test "setup block yields self" do
|
16
|
+
DeviseOam.setup do |config|
|
17
|
+
assert_equal DeviseOam, config
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
test "strategy is valid when specified header is in the request" do
|
22
|
+
assert @strategy.valid?, "Expected strategy to be valid since oam_header is in the request"
|
23
|
+
end
|
24
|
+
|
25
|
+
test "strategy is not valid when specified header is not in the request" do
|
26
|
+
DeviseOam.oam_header = "some_header_that_is_not_in_the_request"
|
27
|
+
invalid_strategy = DeviseOam::Devise::Strategies::HeaderAuthenticatable.new(env_with_params)
|
28
|
+
|
29
|
+
assert !invalid_strategy.valid?, "Expected strategy not to be valid since oam_header is not in the request"
|
30
|
+
end
|
31
|
+
|
32
|
+
test "authentication fails when oam_header is blank" do
|
33
|
+
strategy = DeviseOam::Devise::Strategies::HeaderAuthenticatable.new(env_with_params("/", {}, { "HTTP_#{DeviseOam.oam_header}" => "" }))
|
34
|
+
strategy._run!
|
35
|
+
|
36
|
+
assert_equal strategy.result, :failure
|
37
|
+
assert_equal strategy.user, nil
|
38
|
+
end
|
39
|
+
|
40
|
+
test "authentication succeeds when oam_header is present and not blank" do
|
41
|
+
user = DeviseOam.user_class.new(DeviseOam.user_login_field => "foo")
|
42
|
+
user.save(validate: false)
|
43
|
+
@strategy._run!
|
44
|
+
|
45
|
+
assert_equal @strategy.result, :success
|
46
|
+
assert_not_nil @strategy.user
|
47
|
+
end
|
48
|
+
|
49
|
+
test "creates new user when create_user_if_not_found is true" do
|
50
|
+
DeviseOam.create_user_if_not_found = true
|
51
|
+
@strategy._run!
|
52
|
+
|
53
|
+
assert_equal @strategy.result, :success
|
54
|
+
assert_not_nil @strategy.user
|
55
|
+
end
|
56
|
+
|
57
|
+
test "correctly parses ldap roles" do
|
58
|
+
ldap_roles = 'role-1,Role-2'
|
59
|
+
roles = ["role-1", "role-2"]
|
60
|
+
|
61
|
+
authenticatable = DeviseOam::AuthenticatableEntity.new("login", ldap_roles)
|
62
|
+
|
63
|
+
assert_equal authenticatable.ldap_roles, roles
|
64
|
+
end
|
65
|
+
|
66
|
+
test "sets user roles on creation" do
|
67
|
+
roles = ["role-1", "role-2"]
|
68
|
+
DeviseOam.create_user_if_not_found = true
|
69
|
+
|
70
|
+
strategy = DeviseOam::Devise::Strategies::HeaderAuthenticatable.new(
|
71
|
+
env_with_params("/", {}, { "HTTP_#{DeviseOam.oam_header}" => "foo", "HTTP_#{DeviseOam.ldap_header}" => roles.join(",") })
|
72
|
+
)
|
73
|
+
strategy._run!
|
74
|
+
|
75
|
+
user = DeviseOam.user_class.where(DeviseOam.user_login_field => "foo").first
|
76
|
+
|
77
|
+
assert_equal strategy.result, :success
|
78
|
+
assert_equal strategy.authenticatable.ldap_roles, roles
|
79
|
+
assert_equal user.roles, roles
|
80
|
+
end
|
81
|
+
|
82
|
+
test "updates excisting user roles" do
|
83
|
+
roles = ["role-2", "role-3"]
|
84
|
+
user = DeviseOam.user_class.new(DeviseOam.user_login_field => "foo", :roles => ["role-1", "role-2"])
|
85
|
+
user.save(validate: false)
|
86
|
+
|
87
|
+
strategy = DeviseOam::Devise::Strategies::HeaderAuthenticatable.new(
|
88
|
+
env_with_params("/", {}, { "HTTP_#{DeviseOam.oam_header}" => "foo", "HTTP_#{DeviseOam.ldap_header}" => roles.join(",") })
|
89
|
+
)
|
90
|
+
strategy._run!
|
91
|
+
|
92
|
+
assert_equal strategy.result, :success
|
93
|
+
assert_equal strategy.authenticatable.ldap_roles, roles
|
94
|
+
assert_equal user.reload.roles, roles
|
95
|
+
end
|
96
|
+
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.
|
data/test/dummy/Rakefile
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
4
|
+
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
6
|
+
|
7
|
+
Dummy::Application.load_tasks
|
@@ -0,0 +1,15 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// the compiled file.
|
9
|
+
//
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
12
|
+
//
|
13
|
+
//= require jquery
|
14
|
+
//= require jquery_ujs
|
15
|
+
//= require_tree .
|
@@ -0,0 +1,13 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the top of the
|
9
|
+
* compiled file, but it's generally better to create a new file per style scope.
|
10
|
+
*
|
11
|
+
*= require_self
|
12
|
+
*= require_tree .
|
13
|
+
*/
|
@@ -0,0 +1,35 @@
|
|
1
|
+
class User < ActiveRecord::Base
|
2
|
+
# Include default devise modules. Others available are:
|
3
|
+
# :token_authenticatable, :encryptable, :confirmable, :lockable, :timeoutable and :omniauthable
|
4
|
+
devise :database_authenticatable, :registerable,
|
5
|
+
:recoverable, :rememberable, :trackable, :validatable
|
6
|
+
|
7
|
+
# Setup accessible (or protected) attributes for your model
|
8
|
+
attr_accessible :email, :password, :password_confirmation, :remember_me, :roles
|
9
|
+
# attr_accessible :title, :body
|
10
|
+
|
11
|
+
ROLES = %w(admin role-1 role-2 role-3)
|
12
|
+
|
13
|
+
def self.create_oam_user(attributes)
|
14
|
+
user = User.new
|
15
|
+
user.email = attributes[:email]
|
16
|
+
user.roles = attributes[:roles] if attributes[:roles]
|
17
|
+
|
18
|
+
user.save validate:false
|
19
|
+
end
|
20
|
+
|
21
|
+
def roles=(roles)
|
22
|
+
self.roles_mask = (roles & ROLES).map { |r| 2**ROLES.index(r) }.sum
|
23
|
+
end
|
24
|
+
|
25
|
+
def roles
|
26
|
+
ROLES.reject do |r|
|
27
|
+
((roles_mask || 0) & 2**ROLES.index(r)).zero?
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def update_roles(roles)
|
32
|
+
self.roles = roles
|
33
|
+
self.save validate:false
|
34
|
+
end
|
35
|
+
end
|