ffcrm_endpoint 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +15 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +77 -0
  4. data/Rakefile +38 -0
  5. data/app/controllers/ffcrm_endpoint/endpoints_controller.rb +26 -0
  6. data/app/views/ffcrm_endpoint/endpoints/consume.html.haml +4 -0
  7. data/app/views/ffcrm_endpoint/endpoints/consume.js.erb +0 -0
  8. data/config/routes.rb +5 -0
  9. data/lib/ffcrm_endpoint/endpoint.rb +78 -0
  10. data/lib/ffcrm_endpoint/engine.rb +16 -0
  11. data/lib/ffcrm_endpoint/version.rb +3 -0
  12. data/lib/ffcrm_endpoint.rb +4 -0
  13. data/lib/tasks/ffcrm_endpoint_tasks.rake +4 -0
  14. data/spec/controllers/endpoints_controller_spec.rb +27 -0
  15. data/spec/dummy/README.rdoc +261 -0
  16. data/spec/dummy/Rakefile +7 -0
  17. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  18. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  19. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  20. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  21. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  22. data/spec/dummy/config/application.rb +65 -0
  23. data/spec/dummy/config/boot.rb +10 -0
  24. data/spec/dummy/config/database.yml +17 -0
  25. data/spec/dummy/config/environment.rb +5 -0
  26. data/spec/dummy/config/environments/development.rb +37 -0
  27. data/spec/dummy/config/environments/production.rb +67 -0
  28. data/spec/dummy/config/environments/test.rb +37 -0
  29. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  30. data/spec/dummy/config/initializers/inflections.rb +15 -0
  31. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  32. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  33. data/spec/dummy/config/initializers/session_store.rb +8 -0
  34. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  35. data/spec/dummy/config/locales/en.yml +5 -0
  36. data/spec/dummy/config/routes.rb +58 -0
  37. data/spec/dummy/config.ru +4 -0
  38. data/spec/dummy/db/schema.rb +457 -0
  39. data/spec/dummy/log/development.log +221 -0
  40. data/spec/dummy/log/test.log +374 -0
  41. data/spec/dummy/public/404.html +26 -0
  42. data/spec/dummy/public/422.html +26 -0
  43. data/spec/dummy/public/500.html +25 -0
  44. data/spec/dummy/public/favicon.ico +0 -0
  45. data/spec/dummy/script/rails +6 -0
  46. data/spec/lib/endpoint_spec.rb +34 -0
  47. data/spec/routing/endpoint_routing_spec.rb +21 -0
  48. data/spec/spec_helper.rb +17 -0
  49. metadata +197 -0
checksums.yaml ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ YmYxNThhZjFmMWNmOTA0ZjI4ZjJkMDdiYjU0NjlkZTczNzhkMTMyZg==
5
+ data.tar.gz: !binary |-
6
+ NDg0N2MyZWViZTFiYjMzYmQ2NzQ0NmZkM2FiMWI4MDY0MzEzMTY4Ng==
7
+ !binary "U0hBNTEy":
8
+ metadata.gz: !binary |-
9
+ NTExZTc1MmVkODlmYWI2MTQ3YmI0ZWE0MGQxMjk0NmM4YzUyMWQwYzhkNzQw
10
+ ZGUxNjVlOTAyZWEzMTgyNDU0OTQxOTQ4ODVkNTk2YTQ3MGViOGMwNjQ3ZTNk
11
+ YmEyYWVhMzZjMGJhMWEzMDZmZDZhZTlmZTkzNjBlMDVhNzgxYTg=
12
+ data.tar.gz: !binary |-
13
+ NTcyNDU1N2M3NGY4NzQwMjE5NzIzNzUwNjY4YWE1ZTRlMDI0OWZkMzYwYWIz
14
+ MDQ1NTA1MDY2YzdiYTA5ZWU3MWE0NDE0ZDNiYWI3OTc2OTdjNDVjZjY3MDQ4
15
+ Njc2MzI0ODYxMjIwNmViYTViZmQyOGVmNDYxNTcyODU3ODNiNGM=
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2013 Steve Kenworthy
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,77 @@
1
+ # FfcrmEndpoint
2
+
3
+ A plugin that enables Fat Free CRM (http://www.fatfreecrm.com) to receive webhooks.
4
+
5
+ Many websites allow you to send webhooks whenever actions take place. This plugin provides a framework to quickly write custom classes that consume these webhooks and process the data into Fat Free CRM objects.
6
+
7
+ It was originally built to consume user submitted forms sent via formstack.com but was turned into a generic solution to support wider varieties of input data.
8
+
9
+ This plugin is aimed at Fat Free CRM developers who want to quickly integrate incoming requests from other websites / services.
10
+
11
+ Please note this is *not* yet production ready code.
12
+
13
+ ## Installation
14
+
15
+ Add ```ffcrm_endpoint``` to your Fat Free CRM application Gemfile and run bundle install.
16
+
17
+ ```gem 'ffcrm_endpoint'```
18
+
19
+ ## How it works / Setup steps
20
+
21
+ * Create a class called ```MyCustomEndpoint``` in ```/app/services/my_custom_endpoint.rb```
22
+ * Subclass from FfcrmEndpoint::Endpoint
23
+ * Define a ```process``` method which will receive the request data.
24
+ * Define an ```authenticate``` method which should return true if the request is allowed to proceed.
25
+
26
+ ```ruby
27
+ class MyPluginName::MyCustomEndpoint < FfcrmEndpoint::Endpoint
28
+
29
+ #
30
+ # This is where you write code to turn the data into Fat Free CRM objects.
31
+ # You have access to request and params here
32
+ def process
33
+ end
34
+
35
+ #
36
+ # return true only if allowed to proceed.
37
+ def authenticate
38
+ params[:token].present? && params[:token] == Setting.my_custom_endpoint[:token]
39
+ end
40
+
41
+ end
42
+ ```
43
+
44
+ * Point your browser to http://path.to.ffcrm/endpoints/my_custom_endpoint
45
+
46
+ That's it!
47
+
48
+ ## Under the hood / More details
49
+
50
+ Simply by going to the URL ```/endpoints/my_custom_endpoint```, the plugin knows to look for the ```MyCustomEndpoint``` class.
51
+
52
+ ### Keeping things secure
53
+
54
+ ```MyCustomEndpoint``` must be subclassed from ```FfcrmEndpoint::Endpoint``` otherwise it will not be allowed as an action. This is deliberate in order to ensure that arbitary ruby classes cannot be called. Consider for a moment what would happen on the URL ```/endpoints/object``` if this protection wasn't built in!
55
+
56
+ Also note, that you are responsible for sanitizing your data... just as you would in a normal rails action. Be careful.
57
+
58
+ ### Authentication / Tokens
59
+
60
+ The ```endpoints``` controller delegates authentication to the custom class. This is to allow you to define your own security. A common practice is to use a token that is shared between your external service and Fat Free CRM. Implementation is left to the developer. Just be sure to define the ```authenticate``` method.
61
+
62
+ ## TODO list
63
+
64
+ * More tests
65
+ * Consolidate how to pass in data
66
+
67
+ ## Bug Fixes / Contributions
68
+
69
+ Please open issues in the GitHub issue tracker and use pull requests for new features.
70
+
71
+ ## License
72
+
73
+ MIT (see LICENSE for more details)
74
+
75
+ ## Author
76
+
77
+ Steve Kenworthy (steveyken@gmail.com)
data/Rakefile ADDED
@@ -0,0 +1,38 @@
1
+
2
+ #!/usr/bin/env rake
3
+ begin
4
+ require 'bundler/setup'
5
+ rescue LoadError
6
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
7
+ end
8
+
9
+ begin
10
+ require 'rdoc/task'
11
+ rescue LoadError
12
+ require 'rdoc/rdoc'
13
+ require 'rake/rdoctask'
14
+ RDoc::Task = Rake::RDocTask
15
+ end
16
+
17
+ RDoc::Task.new(:rdoc) do |rdoc|
18
+ rdoc.rdoc_dir = 'rdoc'
19
+ rdoc.title = 'FfcrmEndpoint'
20
+ rdoc.options << '--line-numbers'
21
+ rdoc.rdoc_files.include('README.md')
22
+ rdoc.rdoc_files.include('lib/**/*.rb')
23
+ end
24
+
25
+ APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
26
+ load 'rails/tasks/engine.rake'
27
+
28
+ Bundler::GemHelper.install_tasks
29
+
30
+ Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
31
+
32
+ require 'rspec/core'
33
+ require 'rspec/core/rake_task'
34
+
35
+ desc "Run all specs in spec directory (excluding plugin specs)"
36
+ RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
37
+
38
+ task :default => :spec
@@ -0,0 +1,26 @@
1
+ module FfcrmEndpoint
2
+
3
+ class EndpointsController < ActionController::Base
4
+
5
+ respond_to :json, :js, :html
6
+
7
+ def consume
8
+
9
+ if endpoint.authenticate
10
+ endpoint.process
11
+ respond_with('', location: nil, status: 201)
12
+ else
13
+ respond_with('', location: nil, status: :unauthorized)
14
+ end
15
+
16
+ end
17
+
18
+ private
19
+
20
+ def endpoint
21
+ @endpoint ||= FfcrmEndpoint::Endpoint.new(params)
22
+ end
23
+
24
+ end
25
+
26
+ end
@@ -0,0 +1,4 @@
1
+ - if response.code == "201"
2
+ Success!
3
+ - else response.code == "401"
4
+ Authentication failed
File without changes
data/config/routes.rb ADDED
@@ -0,0 +1,5 @@
1
+ Rails.application.routes.draw do
2
+
3
+ match 'endpoints/:klass_name', controller: 'ffcrm_endpoint/endpoints', action: 'consume', via: [:get, :post, :put]
4
+
5
+ end
@@ -0,0 +1,78 @@
1
+ module FfcrmEndpoint
2
+
3
+ class EndpointNotDefinedError < StandardError; end
4
+ class EndpointNoActionError < StandardError; end
5
+ class EndpointDuplicateError < StandardError; end
6
+
7
+ class Endpoint
8
+
9
+ attr_accessor :params
10
+ cattr_accessor :klasses do
11
+ []
12
+ end
13
+
14
+ def initialize(params)
15
+ @params = params
16
+ raise EndpointNoActionError, "No action defined." unless params[:klass_name].present?
17
+ end
18
+
19
+ #
20
+ # The main function to process the incoming data.
21
+ # It delegates to the process function in your custom endpoint class.
22
+ def process
23
+ klass.new(params).process
24
+ end
25
+
26
+ #
27
+ # The authentication method is called by the endpoint controller before 'process' is run.
28
+ # 'process' will only be called if authenticate returns true
29
+ def authenticate
30
+ klass.new(params).authenticate == true
31
+ end
32
+
33
+ protected
34
+
35
+ #
36
+ # Configuration is assumed to be in Settings namespaced under the name of the action
37
+ # If class is MyCustomEndpoint, then configuration should be in Setting[:my_custom_endpoint]
38
+ # You can override this behaviour in the endpoint subclass if desired
39
+ def config
40
+ Setting[klass_name]
41
+ end
42
+
43
+ #
44
+ # klasses are stored as MyPluginName::MyCustomEndpoint
45
+ # Return first match on "MyCustomEndpoint"
46
+ def klass
47
+ @klass ||= klasses.select{|k| k.to_s.demodulize == klass_name}.compact.first
48
+ raise EndpointNotDefinedError, "To call /endpoints/#{params[:klass_name]} you must define 'class #{params[:klass_name].classify} < FfcrmEndpoint::Endpoint'" if !@klass.present?
49
+ @klass
50
+ end
51
+
52
+ #
53
+ # We derive the name of the endpoint subclass from the action
54
+ # /endpoints/my_custom_endpoint corresponds to MyCustomEndpoint
55
+ def klass_name
56
+ "#{params[:klass_name].classify}"
57
+ end
58
+
59
+ private
60
+
61
+ #
62
+ # Endpoints must be registered (by subclassing) before they can be called.
63
+ # This ensures actions such as "/endpoints/object" don't result in dangerous calls to the Object class
64
+ def self.inherited(subclass)
65
+ # handle name duplicates
66
+ if (duplicates = klasses.select{ |klass| klass.to_s.demodulize == subclass.to_s.demodulize }).any?
67
+ raise EndpointDuplicateError, "You cannot have endpoints with the same name: #{duplicates.join(', ')}"
68
+ else
69
+ klasses << subclass
70
+ end
71
+ end
72
+
73
+ end
74
+
75
+ # Use this hook to load your endpoint subclasses
76
+ ActiveSupport.run_load_hooks(:ffcrm_endpoint, self)
77
+
78
+ end
@@ -0,0 +1,16 @@
1
+ module FfcrmEndpoint
2
+ class Engine < ::Rails::Engine
3
+
4
+ config.to_prepare do
5
+ require "ffcrm_endpoint/endpoint"
6
+ end
7
+
8
+ config.generators do |g|
9
+ g.test_framework :rspec, :fixture => false
10
+ g.fixture_replacement :factory_girl, :dir => 'spec/factories'
11
+ g.assets false
12
+ g.helper false
13
+ end
14
+
15
+ end
16
+ end
@@ -0,0 +1,3 @@
1
+ module FfcrmEndpoint
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,4 @@
1
+ require "ffcrm_endpoint/engine"
2
+
3
+ module FfcrmEndpoint
4
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :ffcrm_endpoint do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,27 @@
1
+ require 'spec_helper'
2
+
3
+ describe EndpointsController do
4
+
5
+ let(:endpoint) { mock(FfcrmEndpoint::Endpoint) }
6
+
7
+ describe "consume" do
8
+
9
+ it "should call process when authenticate returns true" do
10
+ endpoint.should_receive(:process)
11
+ endpoint.should_receive(:authenticate).and_return(true)
12
+ controller.stub!(:endpoint).and_return(endpoint)
13
+ get :consume, klass_name: :my_custom_endpoint, format: :js
14
+ expect(response.status).to eql(201)
15
+ end
16
+
17
+ it "should not call process when authenticate returns false" do
18
+ endpoint.should_not_receive(:process)
19
+ endpoint.should_receive(:authenticate).and_return(false)
20
+ controller.stub!(:endpoint).and_return(endpoint)
21
+ get :consume, klass_name: :my_custom_endpoint, format: :js
22
+ #~ expect(response.status).to eql(401)
23
+ end
24
+
25
+ end
26
+
27
+ 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.
@@ -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
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application", :media => "all" %>
6
+ <%= javascript_include_tag "application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>