ruby-saml-idp 0.2.6 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. data/README.md +1 -1
  2. data/app/views/saml_idp/idp/saml_post.html.erb +5 -2
  3. data/lib/ruby-saml-idp.rb +5 -5
  4. data/lib/{saml-idp → saml_idp}/configurator.rb +2 -1
  5. data/lib/{saml-idp → saml_idp}/controller.rb +32 -8
  6. data/lib/{saml-idp → saml_idp}/default.rb +0 -0
  7. data/lib/{saml-idp → saml_idp}/engine.rb +0 -0
  8. data/lib/{saml-idp → saml_idp}/version.rb +1 -1
  9. data/ruby-saml-idp.gemspec +3 -1
  10. data/spec/acceptance/acceptance_helper.rb +9 -0
  11. data/spec/acceptance/idp_controller_spec.rb +16 -0
  12. data/spec/rails_app/.gitignore +15 -0
  13. data/spec/rails_app/README.rdoc +261 -0
  14. data/spec/rails_app/Rakefile +7 -0
  15. data/spec/rails_app/app/assets/images/rails.png +0 -0
  16. data/spec/rails_app/app/assets/javascripts/application.js +15 -0
  17. data/spec/rails_app/app/assets/stylesheets/application.css +13 -0
  18. data/spec/rails_app/app/controllers/application_controller.rb +3 -0
  19. data/spec/rails_app/app/controllers/saml_controller.rb +8 -0
  20. data/spec/rails_app/app/controllers/saml_idp_controller.rb +11 -0
  21. data/spec/rails_app/app/helpers/application_helper.rb +2 -0
  22. data/spec/rails_app/app/mailers/.gitkeep +0 -0
  23. data/spec/rails_app/app/models/.gitkeep +0 -0
  24. data/spec/rails_app/app/views/layouts/application.html.erb +14 -0
  25. data/spec/rails_app/config.ru +4 -0
  26. data/spec/rails_app/config/application.rb +60 -0
  27. data/spec/rails_app/config/boot.rb +6 -0
  28. data/spec/rails_app/config/database.yml +25 -0
  29. data/spec/rails_app/config/environment.rb +5 -0
  30. data/spec/rails_app/config/environments/development.rb +37 -0
  31. data/spec/rails_app/config/environments/production.rb +67 -0
  32. data/spec/rails_app/config/environments/test.rb +37 -0
  33. data/spec/rails_app/config/initializers/backtrace_silencers.rb +7 -0
  34. data/spec/rails_app/config/initializers/inflections.rb +15 -0
  35. data/spec/rails_app/config/initializers/mime_types.rb +5 -0
  36. data/spec/rails_app/config/initializers/secret_token.rb +7 -0
  37. data/spec/rails_app/config/initializers/session_store.rb +8 -0
  38. data/spec/rails_app/config/initializers/wrap_parameters.rb +14 -0
  39. data/spec/rails_app/config/locales/en.yml +5 -0
  40. data/spec/rails_app/config/routes.rb +6 -0
  41. data/spec/rails_app/db/seeds.rb +7 -0
  42. data/spec/rails_app/doc/README_FOR_APP +2 -0
  43. data/spec/rails_app/lib/assets/.gitkeep +0 -0
  44. data/spec/rails_app/lib/tasks/.gitkeep +0 -0
  45. data/spec/rails_app/log/.gitkeep +0 -0
  46. data/spec/rails_app/public/404.html +26 -0
  47. data/spec/rails_app/public/422.html +26 -0
  48. data/spec/rails_app/public/500.html +25 -0
  49. data/spec/rails_app/public/favicon.ico +0 -0
  50. data/spec/rails_app/public/index.html +241 -0
  51. data/spec/rails_app/public/robots.txt +5 -0
  52. data/spec/rails_app/script/rails +6 -0
  53. data/spec/rails_app/test/fixtures/.gitkeep +0 -0
  54. data/spec/rails_app/test/functional/.gitkeep +0 -0
  55. data/spec/rails_app/test/integration/.gitkeep +0 -0
  56. data/spec/rails_app/test/performance/browsing_test.rb +12 -0
  57. data/spec/rails_app/test/test_helper.rb +13 -0
  58. data/spec/rails_app/test/unit/.gitkeep +0 -0
  59. data/spec/rails_app/vendor/assets/javascripts/.gitkeep +0 -0
  60. data/spec/rails_app/vendor/assets/stylesheets/.gitkeep +0 -0
  61. data/spec/rails_app/vendor/plugins/.gitkeep +0 -0
  62. data/spec/saml_idp/controller_spec.rb +60 -0
  63. data/spec/spec_helper.rb +12 -2
  64. data/spec/support/saml_request_macros.rb +19 -0
  65. metadata +147 -12
  66. data/spec/controller_spec.rb +0 -49
data/README.md CHANGED
@@ -72,7 +72,7 @@ The fingerprint to use, if you use the default X.509 certificate of this gem, is
72
72
  Service Providers
73
73
  -----------------
74
74
 
75
- To act as a Service Provider which generates SAML Requests use the excellent [ruby-saml](https://github.com/onelogin/ruby-saml) gem.
75
+ To act as a Service Provider which generates SAML Requests and can react to SAML Responses use the excellent [ruby-saml](https://github.com/onelogin/ruby-saml) gem.
76
76
 
77
77
 
78
78
  Author
data/app/views/saml_idp/idp/saml_post.html.erb CHANGED
@@ -4,7 +4,10 @@
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
6
6
  </head>
7
- <body onload="document.forms[0].submit();">
8
- <%= form_tag(@saml_acs_url) { hidden_field_tag("SAMLResponse", @saml_response) } %>
7
+ <body onload="document.forms[0].submit();" style="visibility:hidden;">
8
+ <%= form_tag(@saml_acs_url) do %>
9
+ <%= hidden_field_tag("SAMLResponse", @saml_response) %>
10
+ <%= submit_tag "Submit" %>
11
+ <% end %>
9
12
  </body>
10
13
  </html>
data/lib/ruby-saml-idp.rb CHANGED
@@ -1,10 +1,10 @@
1
1
  # encoding: utf-8
2
2
  module SamlIdp
3
- require 'saml-idp/configurator'
4
- require 'saml-idp/controller'
5
- require 'saml-idp/default'
6
- require 'saml-idp/version'
7
- require 'saml-idp/engine' if defined?(::Rails) && Rails::VERSION::MAJOR > 2
3
+ require 'saml_idp/configurator'
4
+ require 'saml_idp/controller'
5
+ require 'saml_idp/default'
6
+ require 'saml_idp/version'
7
+ require 'saml_idp/engine' if defined?(::Rails) && Rails::VERSION::MAJOR > 2
8
8
 
9
9
  def self.config=(config)
10
10
  @config = config
data/lib/{saml-idp → saml_idp}/configurator.rb RENAMED
@@ -1,11 +1,12 @@
1
1
  # encoding: utf-8
2
2
  module SamlIdp
3
3
  class Configurator
4
- attr_accessor :x509_certificate, :secret_key
4
+ attr_accessor :x509_certificate, :secret_key, :algorithm
5
5
 
6
6
  def initialize(config_file = nil)
7
7
  self.x509_certificate = Default::X509_CERTIFICATE
8
8
  self.secret_key = Default::SECRET_KEY
9
+ self.algorithm = :sha1
9
10
  instance_eval(File.read(config_file), config_file) if config_file
10
11
  end
11
12
  end
data/lib/{saml-idp → saml_idp}/controller.rb RENAMED
@@ -5,7 +5,7 @@ module SamlIdp
5
5
  require 'base64'
6
6
  require 'time'
7
7
 
8
- attr_accessor :x509_certificate, :secret_key
8
+ attr_accessor :x509_certificate, :secret_key, :algorithm
9
9
  attr_accessor :saml_acs_url
10
10
 
11
11
  def x509_certificate
@@ -18,6 +18,30 @@ module SamlIdp
18
18
  @secret_key = SamlIdp.config.secret_key
19
19
  end
20
20
 
21
+ def algorithm
22
+ return @algorithm if defined?(@algorithm)
23
+ self.algorithm = SamlIdp.config.algorithm
24
+ @algorithm
25
+ end
26
+
27
+ def algorithm=(algorithm)
28
+ @algorithm = algorithm
29
+ if algorithm.is_a?(Symbol)
30
+ @algorithm = case algorithm
31
+ when :sha256 then OpenSSL::Digest::SHA256
32
+ when :sha384 then OpenSSL::Digest::SHA384
33
+ when :sha512 then OpenSSL::Digest::SHA512
34
+ else
35
+ OpenSSL::Digest::SHA1
36
+ end
37
+ end
38
+ @algorithm
39
+ end
40
+
41
+ def algorithm_name
42
+ algorithm.to_s.split('::').last.downcase
43
+ end
44
+
21
45
  protected
22
46
 
23
47
  def validate_saml_request(saml_request = params[:SAMLRequest])
@@ -26,11 +50,11 @@ module SamlIdp
26
50
 
27
51
  def decode_SAMLRequest(saml_request)
28
52
  zstream = Zlib::Inflate.new(-Zlib::MAX_WBITS)
29
- text = zstream.inflate(Base64.decode64(saml_request))
53
+ @saml_request = zstream.inflate(Base64.decode64(saml_request))
30
54
  zstream.finish
31
55
  zstream.close
32
- @saml_request_id = text[/ID='(.+?)'/, 1]
33
- @saml_acs_url = text[/AssertionConsumerServiceURL='(.+?)'/, 1]
56
+ @saml_request_id = @saml_request[/ID='(.+?)'/, 1]
57
+ @saml_acs_url = @saml_request[/AssertionConsumerServiceURL='(.+?)'/, 1]
34
58
  end
35
59
 
36
60
  def encode_SAMLResponse(nameID, opts = {})
@@ -41,11 +65,11 @@ module SamlIdp
41
65
 
42
66
  assertion = %[<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion" ID="_#{reference_id}" IssueInstant="#{now.iso8601}" Version="2.0"><Issuer>#{issuer_uri}</Issuer><Subject><NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress">#{nameID}</NameID><SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"><SubjectConfirmationData InResponseTo="#{@saml_request_id}" NotOnOrAfter="#{(now+3*60).iso8601}" Recipient="#{@saml_acs_url}"></SubjectConfirmationData></SubjectConfirmation></Subject><Conditions NotBefore="#{(now-5).iso8601}" NotOnOrAfter="#{(now+60*60).iso8601}"><AudienceRestriction><Audience>#{audience_uri}</Audience></AudienceRestriction></Conditions><AttributeStatement><Attribute Name="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"><AttributeValue>#{nameID}</AttributeValue></Attribute></AttributeStatement><AuthnStatement AuthnInstant="#{now.iso8601}" SessionIndex="_#{reference_id}"><AuthnContext><AuthnContextClassRef>urn:federation:authentication:windows</AuthnContextClassRef></AuthnContext></AuthnStatement></Assertion>]
43
67
 
44
- digest_value = Base64.encode64(OpenSSL::Digest::SHA1.digest(assertion)).chomp
68
+ digest_value = Base64.encode64(algorithm.digest(assertion)).gsub(/\n/, '')
45
69
 
46
- signed_info = %[<ds:SignedInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></ds:CanonicalizationMethod><ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"></ds:SignatureMethod><ds:Reference URI="#_#{reference_id}"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"></ds:Transform><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></ds:Transform></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"></ds:DigestMethod><ds:DigestValue>#{digest_value}</ds:DigestValue></ds:Reference></ds:SignedInfo>]
70
+ signed_info = %[<ds:SignedInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></ds:CanonicalizationMethod><ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-#{algorithm_name}"></ds:SignatureMethod><ds:Reference URI="#_#{reference_id}"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"></ds:Transform><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"></ds:Transform></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig##{algorithm_name}"></ds:DigestMethod><ds:DigestValue>#{digest_value}</ds:DigestValue></ds:Reference></ds:SignedInfo>]
47
71
 
48
- signature_value = sign(signed_info)
72
+ signature_value = sign(signed_info).gsub(/\n/, '')
49
73
 
50
74
  signature = %[<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">#{signed_info}<ds:SignatureValue>#{signature_value}</ds:SignatureValue><KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#"><ds:X509Data><ds:X509Certificate>#{self.x509_certificate}</ds:X509Certificate></ds:X509Data></KeyInfo></ds:Signature>]
51
75
 
@@ -60,7 +84,7 @@ module SamlIdp
60
84
 
61
85
  def sign(data)
62
86
  key = OpenSSL::PKey::RSA.new(self.secret_key)
63
- Base64.encode64(key.sign(OpenSSL::Digest::SHA1.new, data))
87
+ Base64.encode64(key.sign(algorithm.new, data))
64
88
  end
65
89
 
66
90
  end
data/lib/{saml-idp → saml_idp}/default.rb RENAMED
File without changes
data/lib/{saml-idp → saml_idp}/engine.rb RENAMED
File without changes
data/lib/{saml-idp → saml_idp}/version.rb RENAMED
@@ -1,4 +1,4 @@
1
1
  # encoding: utf-8
2
2
  module SamlIdp
3
- VERSION = '0.2.6'
3
+ VERSION = '0.3.0'
4
4
  end
data/ruby-saml-idp.gemspec CHANGED
@@ -1,6 +1,6 @@
1
1
  # -*- encoding: utf-8 -*-
2
2
  $:.push File.expand_path("../lib", __FILE__)
3
- require "saml-idp/version"
3
+ require "saml_idp/version"
4
4
 
5
5
  Gem::Specification.new do |s|
6
6
  s.name = %q{ruby-saml-idp}
@@ -27,5 +27,7 @@ Gem::Specification.new do |s|
27
27
  # s.add_development_dependency "rcov"
28
28
  s.add_development_dependency "rspec"
29
29
  s.add_development_dependency "ruby-saml"
30
+ s.add_development_dependency("rails", "~> 3.2")
31
+ s.add_development_dependency("capybara")
30
32
  end
31
33
 
data/spec/acceptance/acceptance_helper.rb ADDED
@@ -0,0 +1,9 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+ require 'capybara/rspec'
3
+
4
+ # Put your acceptance spec helpers inside /spec/acceptance/support
5
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
6
+
7
+ RSpec.configure do |config|
8
+ config.include Rails.application.routes.url_helpers, :type => :request
9
+ end
data/spec/acceptance/idp_controller_spec.rb ADDED
@@ -0,0 +1,16 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/acceptance_helper')
2
+
3
+ feature 'IdpController' do
4
+
5
+ scenario 'Login via default signup page' do
6
+ saml_request = make_saml_request("http://foo.example.com/saml/consume")
7
+ visit "/saml/auth?SAMLRequest=#{CGI.escape(saml_request)}"
8
+ fill_in 'Email', :with => "brad.copa@example.com"
9
+ fill_in 'Password', :with => "okidoki"
10
+ click_button 'Sign in'
11
+ click_button 'Submit' # simulating onload
12
+ current_url.should == 'http://foo.example.com/saml/consume'
13
+ page.should have_content "brad.copa@example.com"
14
+ end
15
+
16
+ end
data/spec/rails_app/.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/spec/rails_app/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.