thincloud-postmark 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/.gitignore +7 -0
  2. data/Gemfile +4 -0
  3. data/README.md +114 -12
  4. data/lib/thincloud/postmark/configuration.rb +27 -2
  5. data/lib/thincloud/postmark/engine.rb +40 -15
  6. data/lib/thincloud/postmark/interceptor.rb +20 -0
  7. data/lib/thincloud/postmark/version.rb +1 -1
  8. data/lib/thincloud-postmark.rb +1 -0
  9. data/test/configuration_test.rb +29 -12
  10. data/test/dummy/README.rdoc +261 -0
  11. data/test/dummy/Rakefile +7 -0
  12. data/test/dummy/app/assets/javascripts/application.js +15 -0
  13. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  14. data/test/dummy/app/controllers/application_controller.rb +3 -0
  15. data/test/dummy/app/helpers/application_helper.rb +2 -0
  16. data/test/dummy/app/mailers/.gitkeep +0 -0
  17. data/test/dummy/app/models/.gitkeep +0 -0
  18. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  19. data/test/dummy/config/application.rb +58 -0
  20. data/test/dummy/config/boot.rb +10 -0
  21. data/test/dummy/config/database.yml +25 -0
  22. data/test/dummy/config/environment.rb +5 -0
  23. data/test/dummy/config/environments/development.rb +37 -0
  24. data/test/dummy/config/environments/production.rb +67 -0
  25. data/test/dummy/config/environments/test.rb +40 -0
  26. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  27. data/test/dummy/config/initializers/inflections.rb +15 -0
  28. data/test/dummy/config/initializers/mime_types.rb +5 -0
  29. data/test/dummy/config/initializers/secret_token.rb +7 -0
  30. data/test/dummy/config/initializers/session_store.rb +8 -0
  31. data/test/dummy/config/initializers/thincloud_postmark.rb +3 -0
  32. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  33. data/test/dummy/config/locales/en.yml +5 -0
  34. data/test/dummy/config/routes.rb +58 -0
  35. data/test/dummy/config.ru +4 -0
  36. data/test/dummy/db/seeds.rb +7 -0
  37. data/test/dummy/lib/assets/.gitkeep +0 -0
  38. data/test/dummy/log/.gitkeep +0 -0
  39. data/test/dummy/public/404.html +26 -0
  40. data/test/dummy/public/422.html +26 -0
  41. data/test/dummy/public/500.html +25 -0
  42. data/test/dummy/public/favicon.ico +0 -0
  43. data/test/dummy/script/rails +6 -0
  44. data/test/integration/configuration_test.rb +42 -0
  45. data/test/integration/interceptor_test.rb +13 -0
  46. data/test/interceptor_test.rb +49 -0
  47. data/test/minitest_helper.rb +5 -2
  48. data/thincloud-postmark.gemspec +4 -2
  49. metadata +83 -8
  50. data/lib/generators/thincloud/postmark/postmark_generator.rb +0 -30
  51. data/lib/generators/thincloud/postmark/templates/action_mailer.rb +0 -2
  52. data/lib/generators/thincloud/postmark/templates/mail_interceptor.rb +0 -7
  53. data/lib/generators/thincloud/postmark/templates/thincloud_postmark.rb +0 -3
data/.gitignore CHANGED
@@ -1,3 +1,4 @@
1
+ .DS_Store
1
2
  *.gem
2
3
  *.rbc
3
4
  .bundle
@@ -6,6 +7,7 @@
6
7
  Gemfile.lock
7
8
  InstalledFiles
8
9
  _yardoc
10
+ bin
9
11
  coverage
10
12
  doc/
11
13
  lib/bundler/man
@@ -15,3 +17,8 @@ spec/reports
15
17
  test/tmp
16
18
  test/version_tmp
17
19
  tmp
20
+ log/*.log
21
+ test/dummy/db/*.sqlite3
22
+ test/dummy/log/*.log
23
+ test/dummy/tmp/
24
+ test/dummy/.sass-cache
data/Gemfile CHANGED
@@ -2,8 +2,12 @@ source "https://rubygems.org"
2
2
 
3
3
  gemspec
4
4
 
5
+ # jquery-rails is used by the dummy application
6
+ gem "jquery-rails"
7
+
5
8
  group :test do
6
9
  platforms :ruby do
7
10
  gem "simplecov"
11
+ gem "sqlite3"
8
12
  end
9
13
  end
data/README.md CHANGED
@@ -2,7 +2,12 @@
2
2
 
3
3
  ## Description
4
4
 
5
- [Postmark](http://postmarkapp.com) configuration for Rails apps.
5
+ Rails Engine to provide [Postmark](http://postmarkapp.com) configuration for Thincloud applications.
6
+
7
+ The Thincloud::Postmark engine:
8
+
9
+ * Manages all of the `Postmark` dependencies for your application
10
+ * Optionally registers a `Mail` interceptor
6
11
 
7
12
  ## Requirements
8
13
 
@@ -23,11 +28,7 @@ Add this line to your application's Gemfile:
23
28
  gem "thincloud-postmark"
24
29
  ```
25
30
 
26
- And then execute:
27
-
28
- ```
29
- $ bundle
30
- ```
31
+ * Run `bundle`
31
32
 
32
33
  Or install it yourself as:
33
34
 
@@ -37,12 +38,114 @@ $ gem install thincloud-postmark
37
38
 
38
39
  ## Usage
39
40
 
40
- This gem adds a generator to Rails, `thincloud:postmark`. Running the generator will install a mail interceptor for non-production environments and a configuration initializer in `config/initializers/thincloud_postmark.rb` where your API key or environment variable can be defined.
41
+ ### Configuration
42
+
43
+ Thincloud::Postmark configuration options are available to customize the engine behavior. Available options and their default values:
44
+
45
+ ```ruby
46
+ api_key = "POSTMARK_API_TEST"
47
+ interceptor_to = nil
48
+ interceptor_cc = nil
49
+ interceptor_bcc = nil
50
+
51
+ # Rails environment(s) as a symbol that should have mail intercepted
52
+ interceptor_environments = []
53
+ ```
54
+
55
+ _Note: Don't forget to set the `default_url_options`_
56
+
57
+ ```ruby
58
+ config.action_mailer.default_url_options = { host: "mydomain.com" }
59
+ ```
60
+
61
+ #### Environment Variables
62
+
63
+ Several of the options will use environment variables when found.
64
+
65
+ ```
66
+ api_key -> ENV["POSTMARK_API_KEY"]
67
+ secure -> ENV["POSTMARK_SECURE"]
68
+ interceptor_to -> ENV["THINCLOUD_INTERCEPTOR_TO"]
69
+ interceptor_cc -> ENV["THINCLOUD_INTERCEPTOR_CC"]
70
+ interceptor_bcc -> ENV["THINCLOUD_INTERCEPTOR_BCC"]
71
+ ```
72
+
73
+ #### Configuration Block
74
+
75
+ The `Thincloud::Postmark` module accepts a `configure` block that takes the same options listed above. This block can be put into an initializer or inside of a `config\environments` file.
41
76
 
42
- * Invoke the generator:
77
+ ```ruby
78
+ Thincloud::Postmark do |config|
79
+ config.api_key = "MY_API_KEY"
80
+ config.secure = true
81
+ config.interceptor_to = "keymaster@zuul.com"
82
+ config.interceptor_cc = "gatekeeper@zuul.com"
83
+ config.interceptor_environments = [:test, :development]
84
+ # ...
85
+ end
86
+ ```
87
+
88
+ #### Rails Configuration
89
+
90
+ You can also access the configuration via the Rails configuration object. In fact, the engine uses the Rails config as storage when the block syntax is used. The `Thincloud::Postmark::Configuration` object is made available under `config.thincloud.postmark`. You can access this configuration in `config/application.rb` or in your `config/environments` files.
43
91
 
92
+ ```ruby
93
+ #...
94
+ config.thincloud.postmark.api_key = "MY_API_KEY"
95
+ config.thincloud.postmark.secure = false
96
+ config.thincloud.postmark.interceptor_environments = [:staging]
97
+ #...
44
98
  ```
45
- $ rails generate thincloud:postmark
99
+
100
+ _Note: Configuration values take precendence over environment variables._
101
+
102
+ #### Default Interceptor
103
+
104
+ The default interceptor is registered for environments included in the `interceptor_environments` array. It replaces the recipients with those contained in the configuration and replaces the subject of outgoing email with the original `to` combined with the original `subject`.
105
+
106
+ ```ruby
107
+ class Thincloud::Postmark::Interceptor
108
+ # ...
109
+ def self.delivering_email(message)
110
+ message.subject = "#{message.to} #{message.subject}"
111
+ message.to = self.to
112
+ message.cc = self.cc
113
+ message.bcc = self.bcc
114
+ message
115
+ end
116
+ end
117
+ ```
118
+
119
+ #### Overriding the Interceptor
120
+
121
+ You may find that the default Interceptor does not meet your requirements. In that case you can easily create your own and prevent the default from being registered.
122
+
123
+ * Disable the default interceptor
124
+
125
+ ```ruby
126
+ interceptor_environments = []
127
+ ```
128
+
129
+ * Create your interceptor
130
+
131
+ ```ruby
132
+ # Public: Mail Interceptor to use when overriding defaults
133
+ class MailInterceptor
134
+ def self.delivering_email(message)
135
+ message.subject = "#{message.to} #{message.subject}"
136
+ message.to = "#{ENV["USER"]}@localhost"
137
+ message.cc = nil
138
+ message.bcc = nil
139
+ end
140
+ end
141
+ ```
142
+
143
+ * Register your interceptor in an initializer
144
+
145
+ ```ruby
146
+ require "mail_interceptor"
147
+
148
+ Mail.register_interceptor(MailInterceptor) unless Rails.env.production?
46
149
  ```
47
150
 
48
151
  ## Contributing
@@ -56,7 +159,6 @@ $ rails generate thincloud:postmark
56
159
 
57
160
  ## License
58
161
 
59
- * Freely distributable and licensed under the MIT-style license. See LICENSE file for details.
60
- * Copyright (c) 2012 New Leaders
162
+ * Freely distributable and licensed under the [MIT license](http://newleaders.mit-license.org/2012/license.html).
163
+ * Copyright (c) 2012 New Leaders ([opensource@newleaders.com](opensource@newleaders.com))
61
164
  * [https://newleaders.com](https://newleaders.com)
62
-
@@ -6,15 +6,40 @@ module Thincloud
6
6
 
7
7
  def self.configure
8
8
  self.configuration ||= Configuration.new
9
- yield configuration
9
+ yield configuration if block_given?
10
+ configuration
10
11
  end
11
12
 
12
13
  # Public: Configuration options for the Thincloud::Postmark module
13
14
  class Configuration
14
15
  attr_accessor :api_key
16
+ attr_accessor :interceptor_to
17
+ attr_accessor :interceptor_cc
18
+ attr_accessor :interceptor_bcc
19
+ attr_accessor :interceptor_environments
15
20
 
16
21
  def initialize
17
- @api_key = "POSTMARK_API_TEST"
22
+ api_key = ENV["POSTMARK_API_KEY"] || "POSTMARK_API_TEST"
23
+ secure = ENV["POSTMARK_SECURE"] || true
24
+ interceptor_to = ENV["THINCLOUD_INTERCEPTOR_TO"]
25
+ interceptor_cc = ENV["THINCLOUD_INTERCEPTOR_CC"]
26
+ interceptor_bcc = ENV["THINCLOUD_INTERCEPTOR_BCC"]
27
+
28
+ @api_key ||= api_key
29
+ @interceptor_to ||= interceptor_to
30
+ @interceptor_cc ||= interceptor_cc
31
+ @interceptor_bcc ||= interceptor_bcc
32
+
33
+ @interceptor_environments = []
34
+ self.secure = secure
35
+ end
36
+
37
+ def secure=(s)
38
+ ::Postmark.secure = s
39
+ end
40
+
41
+ def secure
42
+ ::Postmark.secure
18
43
  end
19
44
  end
20
45
  end
@@ -1,19 +1,44 @@
1
- class Engine < ::Rails::Engine
1
+ module Thincloud
2
+ module Postmark
3
+ # Public: Thincloud Postmark Engine
4
+ class Engine < ::Rails::Engine
2
5
 
3
- # Require the config initializer in advance so it is available for
4
- # the "thincloud.postmark.action_mailer" initializer
5
- initializer "thincloud.postmark.configuration", before: "thincloud.postmark.action_mailer" do
6
- config_initializer = File.expand_path("config/initializers/thincloud_postmark.rb")
7
- require config_initializer if File.exists?(config_initializer)
8
- end
6
+ # convenience method for engine options / configuration
7
+ def configuration
8
+ Thincloud::Postmark.configuration
9
+ end
10
+
11
+ # initialize the configuration so it is available during rails init
12
+ ActiveSupport.on_load :before_configuration do
13
+ unless config.respond_to? :thincloud
14
+ config.thincloud = ActiveSupport::OrderedOptions.new
15
+ end
16
+
17
+ config.thincloud.postmark ||= Thincloud::Postmark.configure
18
+ end
19
+
20
+ initializer "thincloud.postmark.interceptor", after: "finisher_hook" do
21
+ interceptor = Thincloud::Postmark::Interceptor.tap do |i|
22
+ i.to = configuration.interceptor_to
23
+ i.cc = configuration.interceptor_cc
24
+ i.bcc = configuration.interceptor_bcc
25
+ end
26
+
27
+ if configuration.interceptor_environments.include?(Rails.env.to_sym)
28
+ ::Mail.register_interceptor(interceptor)
29
+ end
30
+ end
31
+
32
+ # Apply the postmark settings just before ActionMailer applies them
33
+ initializer "thincloud.postmark.settings", after: "finisher_hook" do |app|
34
+ if configuration.api_key
35
+ postmark_settings = { api_key: configuration.api_key }
36
+
37
+ config.action_mailer.delivery_method = :postmark
38
+ config.action_mailer.postmark_settings = postmark_settings
39
+ end
40
+ end
9
41
 
10
- # Apply the postmark settings just before ActionMailer applies them
11
- initializer "thincloud.postmark.action_mailer", before: "action_mailer.set_configs" do
12
- if api_key = Thincloud::Postmark.configuration.try(:api_key)
13
- Postmark.secure = true
14
- Rails.application.config.action_mailer.delivery_method = :postmark
15
- Rails.application.config.action_mailer.postmark_settings = { api_key: api_key }
16
42
  end
17
43
  end
18
-
19
- end
44
+ end
@@ -0,0 +1,20 @@
1
+ module Thincloud
2
+ module Postmark
3
+ # Public: Default Rails mail interceptor
4
+ class Interceptor
5
+ class << self
6
+ attr_accessor :to
7
+ attr_accessor :cc
8
+ attr_accessor :bcc
9
+ end
10
+
11
+ def self.delivering_email(message)
12
+ message.subject = "#{message.to} #{message.subject}"
13
+ message.to = self.to
14
+ message.cc = self.cc
15
+ message.bcc = self.bcc
16
+ message
17
+ end
18
+ end
19
+ end
20
+ end
@@ -1,5 +1,5 @@
1
1
  module Thincloud
2
2
  module Postmark
3
- VERSION = "0.2.0 "
3
+ VERSION = "0.3.0 "
4
4
  end
5
5
  end
@@ -1,6 +1,7 @@
1
1
  require "rails"
2
2
  require "postmark-rails"
3
3
  require "thincloud/postmark/configuration"
4
+ require "thincloud/postmark/interceptor"
4
5
  require "thincloud/postmark/engine"
5
6
  require "thincloud/postmark/version"
6
7
 
@@ -1,21 +1,38 @@
1
1
  require "minitest_helper"
2
2
 
3
3
  describe Thincloud::Postmark::Configuration do
4
+ let(:config) { Thincloud::Postmark::Configuration.new }
4
5
 
5
- describe "api_key" do
6
- describe "default" do
7
- it { Thincloud::Postmark::Configuration.new.api_key.must_equal "POSTMARK_API_TEST" }
8
- end
6
+ it { config.must_be_kind_of Thincloud::Postmark::Configuration }
7
+ it { config.must_respond_to :api_key }
8
+ it { config.must_respond_to :api_key= }
9
+ it { config.must_respond_to :secure }
10
+ it { config.must_respond_to :secure= }
11
+ it { config.must_respond_to :interceptor_environments }
12
+ it { config.must_respond_to :interceptor_to }
13
+ it { config.must_respond_to :interceptor_to= }
14
+ it { config.must_respond_to :interceptor_bcc }
15
+ it { config.must_respond_to :interceptor_bcc= }
9
16
 
10
- describe "provided" do
11
- before do
12
- Thincloud::Postmark.configure do |config|
13
- config.api_key = "abc123"
14
- end
15
- end
17
+ describe "defaults" do
18
+ it { config.api_key.must_equal "POSTMARK_API_TEST" }
19
+ it { config.secure.must_equal true }
20
+ it { ::Postmark.secure.must_equal true }
21
+ it { config.interceptor_environments.must_equal [] }
22
+ it { config.interceptor_to.must_be_nil }
23
+ it { config.interceptor_cc.must_be_nil }
24
+ it { config.interceptor_bcc.must_be_nil }
25
+ end
16
26
 
17
- it { Thincloud::Postmark.configuration.api_key.must_equal "abc123" }
27
+ describe "changes Postmark secure setting" do
28
+ before do
29
+ @original_setting = ::Postmark.secure
30
+ config.secure = false
18
31
  end
19
- end
20
32
 
33
+ after { ::Postmark.secure = @original_setting }
34
+
35
+ it { config.secure.must_equal false }
36
+ it { ::Postmark.secure.must_equal false }
37
+ end
21
38
  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.
@@ -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,3 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+ end