hubspot 0.0.2 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/hubspot.rb +53 -4
- data/lib/hubspot/api/transaction_email/single_send.rb +37 -0
- data/lib/hubspot/delivery_method.rb +18 -0
- data/lib/hubspot/errors.rb +21 -0
- data/lib/hubspot/http_request.rb +44 -0
- data/lib/hubspot/http_response.rb +31 -0
- data/lib/hubspot/mailer.rb +18 -0
- data/lib/hubspot/object.rb +33 -0
- data/lib/hubspot/railtie.rb +13 -0
- data/lib/hubspot/transaction_email/delivery_method.rb +17 -0
- data/lib/hubspot/transaction_email/mailer.rb +12 -0
- data/lib/hubspot/version.rb +1 -1
- metadata +245 -158
- data/MIT-LICENSE +0 -20
- data/README.rdoc +0 -158
- data/Rakefile +0 -38
- data/app/helpers/hubspot_helper.rb +0 -17
- data/app/models/hubspot/base.rb +0 -40
- data/app/models/hubspot/blog.rb +0 -35
- data/app/models/hubspot/blogs/blog_association.rb +0 -35
- data/app/models/hubspot/blogs/comment.rb +0 -5
- data/app/models/hubspot/blogs/post.rb +0 -12
- data/app/models/hubspot/blogs/posts/comment.rb +0 -23
- data/app/models/hubspot/connection.rb +0 -46
- data/app/models/hubspot/event.rb +0 -39
- data/app/models/hubspot/keyword.rb +0 -49
- data/app/models/hubspot/lead.rb +0 -26
- data/app/models/hubspot/performable/event.rb +0 -67
- data/lib/hubspot/action_controller_extensions.rb +0 -15
- data/lib/hubspot/engine.rb +0 -30
- data/lib/tasks/hubspot_tasks.rake +0 -4
- data/test/dummy/README.rdoc +0 -261
- data/test/dummy/Rakefile +0 -7
- data/test/dummy/app/assets/javascripts/application.js +0 -15
- data/test/dummy/app/assets/stylesheets/application.css +0 -13
- data/test/dummy/app/controllers/application_controller.rb +0 -3
- data/test/dummy/app/helpers/application_helper.rb +0 -2
- data/test/dummy/app/views/layouts/application.html.erb +0 -14
- data/test/dummy/config.ru +0 -4
- data/test/dummy/config/application.rb +0 -56
- data/test/dummy/config/boot.rb +0 -10
- data/test/dummy/config/database.yml +0 -25
- data/test/dummy/config/environment.rb +0 -5
- data/test/dummy/config/environments/development.rb +0 -37
- data/test/dummy/config/environments/production.rb +0 -67
- data/test/dummy/config/environments/test.rb +0 -37
- data/test/dummy/config/initializers/backtrace_silencers.rb +0 -7
- data/test/dummy/config/initializers/inflections.rb +0 -15
- data/test/dummy/config/initializers/mime_types.rb +0 -5
- data/test/dummy/config/initializers/secret_token.rb +0 -7
- data/test/dummy/config/initializers/session_store.rb +0 -8
- data/test/dummy/config/initializers/wrap_parameters.rb +0 -14
- data/test/dummy/config/locales/en.yml +0 -5
- data/test/dummy/config/routes.rb +0 -58
- data/test/dummy/db/test.sqlite3 +0 -0
- data/test/dummy/log/test.log +0 -2326
- data/test/dummy/public/404.html +0 -26
- data/test/dummy/public/422.html +0 -26
- data/test/dummy/public/500.html +0 -25
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +0 -6
- data/test/fixtures/vcr_cassettes/blog-comments.yml +0 -74
- data/test/fixtures/vcr_cassettes/blog-find.yml +0 -36
- data/test/fixtures/vcr_cassettes/blog-posts.yml +0 -75
- data/test/fixtures/vcr_cassettes/blogs-list.yml +0 -39
- data/test/fixtures/vcr_cassettes/event-create.yml +0 -36
- data/test/fixtures/vcr_cassettes/event-record.yml +0 -47
- data/test/fixtures/vcr_cassettes/events-list.yml +0 -41
- data/test/fixtures/vcr_cassettes/keyword-create.yml +0 -36
- data/test/fixtures/vcr_cassettes/keywords-list.yml +0 -385
- data/test/fixtures/vcr_cassettes/lead-find.yml +0 -103
- data/test/fixtures/vcr_cassettes/lead-update.yml +0 -239
- data/test/fixtures/vcr_cassettes/leads-list.yml +0 -190
- data/test/fixtures/vcr_cassettes/post-comments.yml +0 -72
- data/test/fixtures/vcr_cassettes/post-find.yml +0 -39
- data/test/hubspot_test.rb +0 -5
- data/test/test_helper.rb +0 -22
- data/test/unit/blog_test.rb +0 -37
- data/test/unit/event_test.rb +0 -21
- data/test/unit/keyword_test.rb +0 -22
- data/test/unit/lead_test.rb +0 -31
- data/test/unit/performable_event_test.rb +0 -22
- data/test/unit/post_test.rb +0 -20
@@ -1,49 +0,0 @@
|
|
1
|
-
module Hubspot
|
2
|
-
|
3
|
-
# Finds and updates leads
|
4
|
-
#
|
5
|
-
# Finds:
|
6
|
-
# Hubspot::Keyword.find :all
|
7
|
-
# Hubspot::Keyword.find <GUID>
|
8
|
-
#
|
9
|
-
# Creates:
|
10
|
-
# Hubspot::Keyword.create({ :keyword => { :keyword => 'sleutel' }})
|
11
|
-
# Note that you should pass in the root element 'keyword', as activeresource removes the root element name when it matches the object name
|
12
|
-
class Keyword < Hubspot::Base
|
13
|
-
self.site = 'https://api.hubapi.com/keywords/v1'
|
14
|
-
|
15
|
-
schema do
|
16
|
-
string 'keyword'
|
17
|
-
end
|
18
|
-
|
19
|
-
alias_attribute :id, :keyword_guid
|
20
|
-
|
21
|
-
class << self
|
22
|
-
def instantiate_collection(collection, prefix_options = {})
|
23
|
-
collection = collection['keywords'] if collection.is_a?(Hash)
|
24
|
-
collection.collect! { |record| instantiate_record(record, prefix_options) }
|
25
|
-
end
|
26
|
-
|
27
|
-
def collection_path(prefix_options = {}, query_options = nil)
|
28
|
-
prefix_options, query_options = split_options(prefix_options) if query_options.nil?
|
29
|
-
"#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
|
30
|
-
end
|
31
|
-
end
|
32
|
-
|
33
|
-
protected
|
34
|
-
|
35
|
-
# Override to support the object returned after create
|
36
|
-
def load_attributes_from_response(response)
|
37
|
-
if (response_code_allows_body?(response.code) &&
|
38
|
-
(response['Content-Length'].nil? || response['Content-Length'] != "0") &&
|
39
|
-
!response.body.nil? && response.body.strip.size > 0)
|
40
|
-
|
41
|
-
response_data = self.class.format.decode(response.body)
|
42
|
-
load(response_data.is_a?(Array) ? response_data.first : response_data, true)
|
43
|
-
@persisted = true
|
44
|
-
end
|
45
|
-
end
|
46
|
-
|
47
|
-
end
|
48
|
-
|
49
|
-
end
|
data/app/models/hubspot/lead.rb
DELETED
@@ -1,26 +0,0 @@
|
|
1
|
-
module Hubspot
|
2
|
-
|
3
|
-
# Finds and updates leads
|
4
|
-
#
|
5
|
-
# Finds:
|
6
|
-
# Hubspot::Lead.find :all, :params => { :search => 'test' }
|
7
|
-
# Hubspot::Lead.find <GUID>
|
8
|
-
#
|
9
|
-
# Updates:
|
10
|
-
# lead.firstName = 'Reinier'; lead.save!
|
11
|
-
# lead.update_attributes(:firstName => 'Reinier')
|
12
|
-
class Lead < Hubspot::Base
|
13
|
-
self.site = 'https://api.hubapi.com/leads/v1'
|
14
|
-
|
15
|
-
schema do
|
16
|
-
string 'guid', 'salutation', 'firstName', 'lastName', 'email', 'website', 'company'
|
17
|
-
string 'address', 'state', 'city', 'zip', 'country'
|
18
|
-
string 'phone', 'fax', 'userToken', 'industry', 'jobTitle', 'twitterHandle', 'ipAddress'
|
19
|
-
float 'score'
|
20
|
-
end
|
21
|
-
|
22
|
-
alias_attribute :id, :guid
|
23
|
-
|
24
|
-
end
|
25
|
-
|
26
|
-
end
|
@@ -1,67 +0,0 @@
|
|
1
|
-
require 'uri'
|
2
|
-
require 'net/http'
|
3
|
-
|
4
|
-
module Hubspot
|
5
|
-
module Performable
|
6
|
-
|
7
|
-
# The Event class can be used to record events using the Performable API.
|
8
|
-
# Example: Hubspot::Event.new('event_32145').record!
|
9
|
-
# The response will always be a 1X1 transparent GIF, this is because the HTTP API can be used via an HTML image tag as well :)
|
10
|
-
class Event < Struct.new(:event_id, :performed_at, :completed_at, :url, :ip, :value, :order_id, :custom_parameters)
|
11
|
-
include ActiveModel::Validations
|
12
|
-
|
13
|
-
validates :event_id, :presence => true
|
14
|
-
|
15
|
-
# _a - Your Performable API key. (Your API Key can be found in Account Settings within your Performable account.)
|
16
|
-
# _n - The EVENT_ID of the event you want to record. You can get an event id in two ways:
|
17
|
-
# Log into your Performable account, click Setup, and then click on the event that you wish to record. Finally, click the configuration link to bring up a dialog which shows you the event id.
|
18
|
-
# Use your own unique label as the id, and Performable will automatically generate the corresponding event in your account. You can rename it from within the app later if you'd like.
|
19
|
-
# There are also optional parameters:
|
20
|
-
#
|
21
|
-
# _t - The timestamp of the event (in seconds as a UTC Unix epoch). By default this is ignored - it is used only to help make requests unique and the time that our servers receive the event is used for the timestamp of the event.
|
22
|
-
# _d - If equal to the string true, implies that the timestamp sent with this event should be used as the time of completion for this event. The timestamp will be ignored if it represents a future date (within some reason), or is more than a few years old. Servers generating timestamps should use some mechanism (like NTP) for syncing clocks to a reasonable standard. The API expects timestamps are in seconds, but may detect timestamps in milliseconds and attempt to resolve them to seconds.
|
23
|
-
# _l (that's a lowercase L) - The URL that triggered this event.
|
24
|
-
# _ip - The IP address of the user who completed this event. This is useful if you want Performable to assign location data to a user based on their IP address.
|
25
|
-
#
|
26
|
-
# If you are recording an e-commerce transaction you may use any of the following parameters:
|
27
|
-
#
|
28
|
-
# value - A monetary value associated with this event, such as the purchase amount or expected conversion value. This value should be a number with no formatting other than a period representing the decimal point (if necessary.)
|
29
|
-
# order_id - A unique identifier associated with the order or transaction. This is used to make sure this transaction is not counted more than once.
|
30
|
-
PARAMETER_MAPPING = { :event_id => '_n', :performed_at => '_t', :completed_at => '_d', :url => '_l', :ip => '_ip', :value => 'value', :order_id => 'order_id'}
|
31
|
-
|
32
|
-
def record!
|
33
|
-
return false unless valid?
|
34
|
-
|
35
|
-
uri.query = to_param
|
36
|
-
http = Net::HTTP.new(uri.host, uri.port)
|
37
|
-
http.set_debug_output(Hubspot.config.debug_http_output) if Hubspot.config.debug_http_output
|
38
|
-
|
39
|
-
return http.request_get(uri.request_uri).code.to_i
|
40
|
-
end
|
41
|
-
|
42
|
-
# Records, but doesn't raise an error when the record fails and returns flase instead.
|
43
|
-
def record
|
44
|
-
record! rescue false
|
45
|
-
end
|
46
|
-
|
47
|
-
# Sets the Performable API URI
|
48
|
-
def uri
|
49
|
-
@uri ||= URI('http://analytics.performable.com/v1/event')
|
50
|
-
end
|
51
|
-
|
52
|
-
# Converts the event to encoded form data.
|
53
|
-
def to_param
|
54
|
-
parameters = PARAMETER_MAPPING.keys.inject({}) do |hash, parameter|
|
55
|
-
parameter_value = send(parameter)
|
56
|
-
hash[PARAMETER_MAPPING[parameter]] = parameter_value if parameter_value.present?
|
57
|
-
hash
|
58
|
-
end
|
59
|
-
|
60
|
-
parameters.merge!(custom_parameters) if custom_parameters
|
61
|
-
parameters.merge!('_a' => Hubspot.config.hubspot_key)
|
62
|
-
parameters.to_param
|
63
|
-
end
|
64
|
-
|
65
|
-
end
|
66
|
-
end
|
67
|
-
end
|
@@ -1,15 +0,0 @@
|
|
1
|
-
module Hubspot
|
2
|
-
module ActionControllerExtensions
|
3
|
-
extend ActiveSupport::Concern
|
4
|
-
|
5
|
-
included do
|
6
|
-
helper_method :hubspot_user_token
|
7
|
-
end
|
8
|
-
|
9
|
-
# Returns the user token (GUID). This can be used to check whether the current user has been recorded as a Lead.
|
10
|
-
def hubspot_user_token
|
11
|
-
@hubspot_user_token ||= cookies[:hubspotutk]
|
12
|
-
end
|
13
|
-
|
14
|
-
end
|
15
|
-
end
|
data/lib/hubspot/engine.rb
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
module Hubspot
|
2
|
-
|
3
|
-
class Engine < Rails::Engine
|
4
|
-
|
5
|
-
# The domain of your Hubspot site, which is used in the javascript tracker code
|
6
|
-
config.hubspot_site = 'demo.app11.hubspot.com'
|
7
|
-
|
8
|
-
# The access token for authenticating to several Hubspot services, e.g. 'demooooo-oooo-oooo-oooo-oooooooooooo'
|
9
|
-
config.hubspot_access_token = nil
|
10
|
-
|
11
|
-
# Your API key
|
12
|
-
config.hubspot_key = 'demo'
|
13
|
-
|
14
|
-
# Your Portal ID
|
15
|
-
config.hubspot_portal_id = '62515'
|
16
|
-
|
17
|
-
# Enables/disables logging of HTTP requests and response.
|
18
|
-
# false - Disables debugging
|
19
|
-
# STDOUT - logs to STDOUT. Of course you can specify any IO object you want.
|
20
|
-
config.debug_http_output = false # STDOUT
|
21
|
-
|
22
|
-
ActiveSupport.on_load(:action_controller) do
|
23
|
-
include Hubspot::ActionControllerExtensions
|
24
|
-
end
|
25
|
-
|
26
|
-
end
|
27
|
-
|
28
|
-
def self.config; Hubspot::Engine.config; end
|
29
|
-
|
30
|
-
end
|
data/test/dummy/README.rdoc
DELETED
@@ -1,261 +0,0 @@
|
|
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.
|