robocall 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (60) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +26 -0
  4. data/Rakefile +37 -0
  5. data/app/controllers/robocall/application_controller.rb +4 -0
  6. data/app/controllers/robocall/robocalls_controller.rb +87 -0
  7. data/app/helpers/robocall/application_helper.rb +4 -0
  8. data/app/models/robocall/robocall.rb +13 -0
  9. data/app/views/layouts/robocall/application.html.erb +14 -0
  10. data/app/views/robocall/robocalls/render.xml.erb +0 -0
  11. data/config/routes.rb +5 -0
  12. data/db/migrate/20130807225623_create_robocall_robocalls.rb +10 -0
  13. data/lib/robocall.rb +58 -0
  14. data/lib/robocall/engine.rb +12 -0
  15. data/lib/robocall/version.rb +3 -0
  16. data/lib/tasks/robocall_tasks.rake +4 -0
  17. data/spec/controllers/robocall/robocalls_controller_spec.rb +45 -0
  18. data/spec/dummy/README.rdoc +261 -0
  19. data/spec/dummy/Rakefile +7 -0
  20. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  21. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  22. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  23. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  24. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  25. data/spec/dummy/bin/bundle +3 -0
  26. data/spec/dummy/bin/rails +4 -0
  27. data/spec/dummy/bin/rake +4 -0
  28. data/spec/dummy/config.ru +4 -0
  29. data/spec/dummy/config/application.rb +59 -0
  30. data/spec/dummy/config/boot.rb +10 -0
  31. data/spec/dummy/config/database.yml +25 -0
  32. data/spec/dummy/config/environment.rb +5 -0
  33. data/spec/dummy/config/environments/development.rb +37 -0
  34. data/spec/dummy/config/environments/production.rb +67 -0
  35. data/spec/dummy/config/environments/test.rb +37 -0
  36. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  37. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  38. data/spec/dummy/config/initializers/inflections.rb +15 -0
  39. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  40. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  41. data/spec/dummy/config/initializers/session_store.rb +8 -0
  42. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  43. data/spec/dummy/config/locales/en.yml +5 -0
  44. data/spec/dummy/config/routes.rb +4 -0
  45. data/spec/dummy/db/development.sqlite3 +0 -0
  46. data/spec/dummy/db/schema.rb +23 -0
  47. data/spec/dummy/db/test.sqlite3 +0 -0
  48. data/spec/dummy/log/development.log +112 -0
  49. data/spec/dummy/log/test.log +455 -0
  50. data/spec/dummy/public/404.html +26 -0
  51. data/spec/dummy/public/422.html +26 -0
  52. data/spec/dummy/public/500.html +25 -0
  53. data/spec/dummy/public/favicon.ico +0 -0
  54. data/spec/dummy/script/rails +6 -0
  55. data/spec/factories/robocall_robocalls.rb +8 -0
  56. data/spec/lib/robocall.spec +10 -0
  57. data/spec/models/robocall/robocall_spec.rb +7 -0
  58. data/spec/routing/robocall/robocalls_routing_spec.rb +13 -0
  59. data/spec/spec_helper.rb +14 -0
  60. metadata +214 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5f6349a07831bbdcded5479ffd91fa2b071dfc55
4
+ data.tar.gz: c1fd906aa985e033a2dcc84f420256bf6fa067ab
5
+ SHA512:
6
+ metadata.gz: 9cbf99e5fac4dd4a523b3cd10835ed75e2b0545078c3bfe673e26aca9b52de375b3506cf86b3114ccd4449bbb8aa4ade8c5f5fd827a31d47659ad138f5d28ca8
7
+ data.tar.gz: 804e43f82b5b7f2bebcad8a25d3e3252c6ad215a6bb7970272bbae44ed2d2c45503926c8d3237975c1acd86c0564e4af0df79da019bfc54718522dad52377926
@@ -0,0 +1,20 @@
1
+ Copyright 2013 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.
@@ -0,0 +1,26 @@
1
+ ## About
2
+
3
+ A rails gem to easily add sending synthesized messages from Rails to any phone number.
4
+
5
+ ## Install
6
+
7
+ Add the robocall gem to your Gemfile:
8
+ ``` ruby
9
+ gem 'robocall'
10
+ ```
11
+
12
+ Update your bundle and run the migrations from the command line:
13
+ ``` shell
14
+ bundle install
15
+ rake robocall:install:migrations
16
+ rake db:migrate
17
+ ```
18
+
19
+ In conf/environment.rb, add the configuration:
20
+ ``` ruby
21
+ Robocall.from_phone_number = '555-555-5555'
22
+ Robocall.sid = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
23
+ Robocall.auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
24
+ ```
25
+
26
+
@@ -0,0 +1,37 @@
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 = 'Robocall'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.md')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+ Bundler::GemHelper.install_tasks
27
+
28
+ Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
29
+
30
+ require 'rspec/core'
31
+ require 'rspec/core/rake_task'
32
+
33
+
34
+ desc "Run all specs in spec directory (excluding plugin specs)"
35
+ RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
36
+
37
+ task :default => :spec
@@ -0,0 +1,4 @@
1
+ module Robocall
2
+ class ApplicationController < ActionController::Base
3
+ end
4
+ end
@@ -0,0 +1,87 @@
1
+ require_dependency "robocall/application_controller"
2
+
3
+ module Robocall
4
+ class RobocallsController < ApplicationController
5
+ # GET /robocalls
6
+ # GET /robocalls.json
7
+ def index
8
+ @robocalls = Robocall.all
9
+
10
+ respond_to do |format|
11
+ format.html # index.html.erb
12
+ format.json { render json: @robocalls }
13
+ end
14
+ end
15
+
16
+ # GET /robocalls/1
17
+ # GET /robocalls/1.json
18
+ def show
19
+ @robocall = Robocall.find(params[:id])
20
+
21
+ respond_to do |format|
22
+ format.html # show.html.erb
23
+ format.json { render json: @robocall }
24
+ end
25
+ end
26
+
27
+ # GET /robocalls/new
28
+ # GET /robocalls/new.json
29
+ def new
30
+ @robocall = Robocall.new
31
+
32
+ respond_to do |format|
33
+ format.html # new.html.erb
34
+ format.json { render json: @robocall }
35
+ end
36
+ end
37
+
38
+ # GET /robocalls/1/edit
39
+ def edit
40
+ @robocall = Robocall.find(params[:id])
41
+ end
42
+
43
+ # POST /robocalls
44
+ # POST /robocalls.json
45
+ def create
46
+ @robocall = Robocall.new(params[:robocall])
47
+
48
+ respond_to do |format|
49
+ if @robocall.save
50
+ format.html { redirect_to @robocall, notice: 'Robocall was successfully created.' }
51
+ format.json { render json: @robocall, status: :created, location: @robocall }
52
+ else
53
+ format.html { render action: "new" }
54
+ format.json { render json: @robocall.errors, status: :unprocessable_entity }
55
+ end
56
+ end
57
+ end
58
+
59
+ # PUT /robocalls/1
60
+ # PUT /robocalls/1.json
61
+ def update
62
+ @robocall = Robocall.find(params[:id])
63
+
64
+ respond_to do |format|
65
+ if @robocall.update_attributes(params[:robocall])
66
+ format.html { redirect_to @robocall, notice: 'Robocall was successfully updated.' }
67
+ format.json { head :no_content }
68
+ else
69
+ format.html { render action: "edit" }
70
+ format.json { render json: @robocall.errors, status: :unprocessable_entity }
71
+ end
72
+ end
73
+ end
74
+
75
+ # DELETE /robocalls/1
76
+ # DELETE /robocalls/1.json
77
+ def destroy
78
+ @robocall = Robocall.find(params[:id])
79
+ @robocall.destroy
80
+
81
+ respond_to do |format|
82
+ format.html { redirect_to robocalls_url }
83
+ format.json { head :no_content }
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,4 @@
1
+ module Robocall
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,13 @@
1
+ require 'securerandom'
2
+
3
+ module Robocall
4
+ class Robocall < ActiveRecord::Base
5
+ self.table_name = 'robocall_robocalls'
6
+ attr_accessible :token, :xml
7
+
8
+ def initialize(attributes = {})
9
+ super
10
+ self.token = SecureRandom.hex
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Robocall</title>
5
+ <%= stylesheet_link_tag "robocall/application", :media => "all" %>
6
+ <%= javascript_include_tag "robocall/application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,5 @@
1
+ Rails.application.routes.draw do
2
+ resource :robocall, :only => [:connected_to_caller] do
3
+ post '/:call_id/:token' => 'robocall#connected_to_caller'
4
+ end
5
+ end
@@ -0,0 +1,10 @@
1
+ class CreateRobocallRobocalls < ActiveRecord::Migration
2
+ def change
3
+ create_table :robocall_robocalls do |t|
4
+ t.string :token
5
+ t.text :xml
6
+
7
+ t.timestamps
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,58 @@
1
+
2
+ require 'twilio-ruby'
3
+ require File.dirname(__FILE__) + "/../app/models/robocall/robocall"
4
+
5
+ module Robocall
6
+ class << self
7
+ attr_accessor :sid, :auth_token, :from_phone_number, :base_path
8
+
9
+ def send_text(to: to, text: text, from: from_phone_number)
10
+ return true
11
+ twilio = get_twilio
12
+ twilio.account.sms.messages.create(
13
+ :from => from,
14
+ :to => to,
15
+ :body => text
16
+ )
17
+ end
18
+
19
+ def send_robocall_xml(to: to, xml: xml, from: from_phone_number)
20
+ return true
21
+ twilio = get_twilio
22
+ # Store the xml in a record
23
+ debugger
24
+ callback_record = Robocall.new
25
+ debugger
26
+ callback_record.xml = xml
27
+ callback_record.save
28
+ # construct the callback URL
29
+ robocall_path(callback_record)
30
+ twilio.account.calls.create(
31
+ :from => from,
32
+ :to => to,
33
+ :url => url
34
+ )
35
+ end
36
+
37
+ def send_robocall(to: to, text: text, language: :english, from: from_phone_number)
38
+ return true
39
+ # Render XML
40
+ xml = "foo"
41
+ send_robocall_xml(to: to, xml: xml, from: from)
42
+ end
43
+
44
+ private
45
+
46
+ def get_twilio
47
+ verify_configuration_values(:sid, :auth_token, :from_phone_number)
48
+ return Twilio::REST::Client.new sid, auth_token
49
+ end
50
+
51
+ def verify_configuration_values(*symbols)
52
+ absent_values = symbols.select{|symbol| instance_variable_get("@#{symbol}").nil? }
53
+ raise("Must configure #{absent_values.join(", ")} before making this request.") unless absent_values.empty?
54
+ end
55
+
56
+ end
57
+
58
+ end
@@ -0,0 +1,12 @@
1
+ module Robocall
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace Robocall
4
+
5
+ config.generators do |g|
6
+ g.test_framework :rspec, :fixture => false
7
+ g.fixture_replacement :factory_girl, :dir => 'spec/factories'
8
+ g.assets false
9
+ g.helper false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ module Robocall
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :robocall do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,45 @@
1
+ require 'spec_helper'
2
+
3
+ module Robocall
4
+ describe RobocallsController do
5
+
6
+ # This should return the minimal set of attributes required to create a valid
7
+ # Robocall. As you add validations to Robocall, be sure to
8
+ # adjust the attributes here as well.
9
+ let(:valid_attributes) { { 'token' => 'MyString', 'xml' => '<foo>' } }
10
+
11
+ # This should return the minimal set of values that should be in the session
12
+ # in order to pass any filters (e.g. authentication) defined in
13
+ # RobocallsController. Be sure to keep this updated too.
14
+ let(:valid_session) { {} }
15
+
16
+ describe "POST see response" do
17
+ describe "with valid params" do
18
+ it "returns the xml" do
19
+ expect {
20
+ post :create, {:robocall => valid_attributes}, valid_session
21
+ }.to change(Robocall, :count).by(1)
22
+ end
23
+
24
+ it "cleans up the record after the callback has been received" do
25
+ pending
26
+ end
27
+ end
28
+
29
+ describe "with invalid params" do
30
+ it "does not work when there's a token missmatch" do
31
+ pending
32
+ end
33
+
34
+ it "does not work when there's no token" do
35
+ pending
36
+ end
37
+
38
+ it "does not work when there's no id" do
39
+ pending
40
+ end
41
+ end
42
+ end
43
+
44
+ end
45
+ 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
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
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.