quickbooks_web_connector 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.md +109 -0
  3. data/Rakefile +28 -0
  4. data/app/assets/javascripts/quickbooks_web_connector/application.js +15 -0
  5. data/app/assets/stylesheets/quickbooks_web_connector/application.css +13 -0
  6. data/app/controllers/quickbooks_web_connector/application_controller.rb +5 -0
  7. data/app/controllers/quickbooks_web_connector/qwc_controller.rb +12 -0
  8. data/app/controllers/quickbooks_web_connector/soap_controller.rb +10 -0
  9. data/app/helpers/quickbooks_web_connector/application_helper.rb +4 -0
  10. data/app/views/layouts/quickbooks_web_connector/application.html.erb +14 -0
  11. data/app/views/quickbooks_web_connector/qwc/qwc.xml.builder +12 -0
  12. data/config/routes.rb +6 -0
  13. data/lib/quickbooks_web_connector/config.rb +35 -0
  14. data/lib/quickbooks_web_connector/engine.rb +5 -0
  15. data/lib/quickbooks_web_connector/job.rb +61 -0
  16. data/lib/quickbooks_web_connector/json_coder.rb +23 -0
  17. data/lib/quickbooks_web_connector/soap_wrapper/QBWebConnectorSvc.rb +72 -0
  18. data/lib/quickbooks_web_connector/soap_wrapper/default.rb +204 -0
  19. data/lib/quickbooks_web_connector/soap_wrapper/defaultMappingRegistry.rb +166 -0
  20. data/lib/quickbooks_web_connector/soap_wrapper/defaultServant.rb +140 -0
  21. data/lib/quickbooks_web_connector/soap_wrapper.rb +30 -0
  22. data/lib/quickbooks_web_connector/version.rb +3 -0
  23. data/lib/quickbooks_web_connector.rb +127 -0
  24. data/lib/tasks/quickbooks_web_connector_tasks.rake +4 -0
  25. data/spec/config/config_spec.rb +83 -0
  26. data/spec/controllers/quickbooks_web_connector/qwc_controller_spec.rb +29 -0
  27. data/spec/controllers/quickbooks_web_connector/soap_controller_spec.rb +306 -0
  28. data/spec/dummy/README.rdoc +261 -0
  29. data/spec/dummy/Rakefile +7 -0
  30. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  31. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  32. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  33. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  34. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  35. data/spec/dummy/config/application.rb +59 -0
  36. data/spec/dummy/config/boot.rb +10 -0
  37. data/spec/dummy/config/database.yml +25 -0
  38. data/spec/dummy/config/environment.rb +5 -0
  39. data/spec/dummy/config/environments/development.rb +37 -0
  40. data/spec/dummy/config/environments/production.rb +67 -0
  41. data/spec/dummy/config/environments/test.rb +37 -0
  42. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  43. data/spec/dummy/config/initializers/inflections.rb +15 -0
  44. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  45. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  46. data/spec/dummy/config/initializers/session_store.rb +8 -0
  47. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  48. data/spec/dummy/config/locales/en.yml +5 -0
  49. data/spec/dummy/config/routes.rb +6 -0
  50. data/spec/dummy/config.ru +4 -0
  51. data/spec/dummy/db/test.sqlite3 +0 -0
  52. data/spec/dummy/log/development.log +0 -0
  53. data/spec/dummy/log/test.log +26009 -0
  54. data/spec/dummy/public/404.html +26 -0
  55. data/spec/dummy/public/422.html +26 -0
  56. data/spec/dummy/public/500.html +25 -0
  57. data/spec/dummy/public/favicon.ico +0 -0
  58. data/spec/dummy/script/rails +6 -0
  59. data/spec/quickbooks_web_connector/soap_wrapper/defaultServant_spec.rb +150 -0
  60. data/spec/quickbooks_web_connector_spec.rb +47 -0
  61. data/spec/routing/quickbooks_web_connector_spec.rb +17 -0
  62. data/spec/spec_helper.rb +50 -0
  63. data/spec/support/redis/dump.rdb +1 -0
  64. data/spec/support/redis/redis-test.conf +115 -0
  65. data/spec/views/quickbooks_web_connector/qwc/qwc.xml.builder_spec.rb +56 -0
  66. metadata +232 -0
@@ -0,0 +1,306 @@
1
+ require 'spec_helper'
2
+
3
+ describe QuickbooksWebConnector::SoapController do
4
+
5
+ describe 'POST :endpoint' do
6
+
7
+ def do_post
8
+ post :endpoint, use_route: 'quickbooks_web_connector'
9
+ end
10
+
11
+ before do
12
+ request.env['CONTENT_TYPE'] = 'text/xml; charset=utf-8'
13
+ request.env['RAW_POST_DATA'] = request_xml
14
+ end
15
+
16
+ let(:result) { REXML::Document.new(response.body).root }
17
+
18
+ context 'serverVersion' do
19
+ # Request
20
+ let(:request_xml) do
21
+ <<-EOT
22
+ <?xml version=\"1.0\" encoding=\"utf-8\"?>
23
+ <soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">
24
+ <soap:Body>
25
+ <serverVersion xmlns=\"http://developer.intuit.com/\" />
26
+ </soap:Body>
27
+ </soap:Envelope>
28
+ EOT
29
+ end
30
+
31
+ # Response:
32
+ # <env:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
33
+ # <env:Body>
34
+ # <n1:serverVersionResponse xmlns:n1="http://developer.intuit.com/">
35
+ # <n1:serverVersionResult xsi:type="xsd:string">1.2.3</n1:serverVersionResult>
36
+ # </n1:serverVersionResponse>
37
+ # </env:Body>
38
+ # </env:Envelope>
39
+
40
+ before do
41
+ QuickbooksWebConnector.configure { |c| c.server_version = '1.2.3' }
42
+
43
+ post :endpoint, { use_route: 'quickbooks_web_connector' }
44
+ end
45
+
46
+ it 'responds with success' do
47
+ expect(response).to be_success
48
+ end
49
+
50
+ it 'responds as XML' do
51
+ expect(response.header['Content-Type']).to match(/text\/xml/)
52
+ end
53
+
54
+ it 'returns the version' do
55
+ expect(result.text('env:Body/n1:serverVersionResponse/n1:serverVersionResult')).to eq('1.2.3')
56
+ end
57
+ end
58
+
59
+ context 'clientVersion' do
60
+ let(:request_xml) do
61
+ <<-EOT
62
+ <?xml version="1.0" encoding="utf-8"?>
63
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
64
+ <soap:Body>
65
+ <clientVersion xmlns="http://developer.intuit.com/">
66
+ <strVersion>2.1.0.30</strVersion>
67
+ </clientVersion>
68
+ </soap:Body>
69
+ </soap:Envelope>
70
+ EOT
71
+ end
72
+
73
+ # Response
74
+ # <?xml version="1.0" encoding="utf-8" ?>
75
+ # <env:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
76
+ # <env:Body>
77
+ # <n1:clientVersionResponse xmlns:n1="http://developer.intuit.com/"></n1:clientVersionResponse>
78
+ # </env:Body>
79
+ # </env:Envelope>
80
+
81
+ before do
82
+ post :endpoint, { use_route: 'quickbooks_web_connector' }
83
+ end
84
+
85
+ it 'responds with success' do
86
+ expect(response).to be_success
87
+ end
88
+
89
+ it 'returns the version' do
90
+ expect(result.text('env:Body/n1:clientVersionResponse')).to be_nil
91
+ end
92
+ end
93
+
94
+ context 'authenticate' do
95
+ let(:request_xml) do
96
+ <<-EOT
97
+ <?xml version="1.0" encoding="utf-8"?>
98
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
99
+ <soap:Body>
100
+ <authenticate xmlns="http://developer.intuit.com/">
101
+ <strUserName>foo</strUserName>
102
+ <strPassword>bar</strPassword>
103
+ </authenticate>
104
+ </soap:Body>
105
+ </soap:Envelope>
106
+ EOT
107
+ end
108
+
109
+ # Response
110
+ # <?xml version="1.0" encoding="utf-8" ?>
111
+ # <env:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
112
+ # xmlns:xsd="http://www.w3.org/2001/XMLSchema"
113
+ # xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
114
+ # <env:Body>
115
+ # <n1:authenticateResponse xmlns:n1="http://developer.intuit.com/">
116
+ # <n1:authenticateResult xsi:type="n1:ArrayOfString">
117
+ # <n1:string xsi:type="xsd:string">5c7e2e0d-8912-4f13-ad60-cac3a3e68bf5</n1:string>
118
+ # <n1:string xsi:type="xsd:string">none</n1:string>
119
+ # <n1:string xsi:nil="true"
120
+ # xsi:type="xsd:nil"></n1:string>
121
+ # <n1:string xsi:nil="true"
122
+ # xsi:type="xsd:nil"></n1:string>
123
+ # </n1:authenticateResult>
124
+ # </n1:authenticateResponse>
125
+ # </env:Body>
126
+ # </env:Envelope>
127
+
128
+ before do
129
+ QuickbooksWebConnector.configure do |c|
130
+ c.username = 'foo'
131
+ c.password = 'bar'
132
+ end
133
+
134
+ do_post
135
+ end
136
+
137
+ after do
138
+ QuickbooksWebConnector.configure do |c|
139
+ c.username = 'web_connector'
140
+ c.password = 'secret'
141
+ end
142
+ end
143
+
144
+ it 'responds with success' do
145
+ expect(response).to be_success
146
+ end
147
+
148
+ it 'returns a token' do
149
+ expect(result.text('env:Body/n1:authenticateResponse/n1:authenticateResult/n1:string[1]')).to_not be_nil
150
+ end
151
+
152
+ it 'returns "none" for having no data to send' do
153
+ expect(result.text('env:Body/n1:authenticateResponse/n1:authenticateResult/n1:string[2]')).to eq('none')
154
+ end
155
+ end
156
+
157
+ context 'sendRequestXML' do
158
+ let(:request_xml) do
159
+ <<-EOT
160
+ <?xml version="1.0" encoding="utf-8"?>
161
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
162
+ <soap:Body>
163
+ <sendRequestXML xmlns="http://developer.intuit.com/">
164
+ <ticket>0358d44e-9d87-4d40-8299-3026881951bb</ticket>
165
+ <strHCPResponse></strHCPResponse>
166
+ <strCompanyFileName>C:\\Documents and Settings\\All Users\\Documents\\Intuit\\QuickBooks\\Company Files\\Sample.QBW</strCompanyFileName>
167
+ <qbXMLCountry>US</qbXMLCountry>
168
+ <qbXMLMajorVers>6</qbXMLMajorVers>
169
+ <qbXMLMinorVers>0</qbXMLMinorVers>
170
+ </sendRequestXML>
171
+ </soap:Body>
172
+ </soap:Envelope>
173
+ EOT
174
+ end
175
+
176
+ # Response
177
+ # <?xml version="1.0" encoding="utf-8" ?>
178
+ # <env:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
179
+ # xmlns:xsd="http://www.w3.org/2001/XMLSchema"
180
+ # xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
181
+ # <env:Body>
182
+ # <n1:sendRequestXMLResponse xmlns:n1="http://developer.intuit.com/">
183
+ # <n1:sendRequestXMLResult xsi:type="xsd:string">&lt;some&gt;&lt;xml&gt;&lt;/xml&gt;&lt;/some&gt;</n1:sendRequestXMLResult>
184
+ # </n1:sendRequestXMLResponse>
185
+ # </env:Body>
186
+ # </env:Envelope>
187
+
188
+ before do
189
+ QuickbooksWebConnector.enqueue '<some><xml></xml></some>', SomeHandler, 1
190
+
191
+ do_post
192
+ end
193
+
194
+ it 'responds with success' do
195
+ expect(response).to be_success
196
+ end
197
+
198
+ it 'returns the request XML' do
199
+ expect(result.text('env:Body/n1:sendRequestXMLResponse/n1:sendRequestXMLResult')).to eq('<some><xml></xml></some>')
200
+ end
201
+ end
202
+
203
+ context 'receiveResponseXML' do
204
+ let(:request_xml) do
205
+ <<-EOT
206
+ <?xml version="1.0" encoding="utf-8"?>
207
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
208
+ <soap:Body>
209
+ <receiveResponseXML xmlns="http://developer.intuit.com/">
210
+ <ticket>3dde5f3d-dc68-4500-9391-69f75e824330</ticket>
211
+ <response>
212
+ &lt;?xml version="1.0" ?&gt;
213
+ &lt;QBXML&gt;
214
+ &lt;QBXMLMsgsRs&gt;
215
+ &lt;CustomerAddRs statusCode="0" statusSeverity="Info" statusMessage="Status OK"&gt;
216
+ &lt;CustomerRet&gt;
217
+ &lt;ListID&gt;80000006-1354334808&lt;/ListID&gt;
218
+ &lt;TimeCreated&gt;2012-11-30T23:06:48-05:00&lt;/TimeCreated&gt;
219
+ &lt;TimeModified&gt;2012-11-30T23:06:48-05:00&lt;/TimeModified&gt;
220
+ &lt;EditSequence&gt;1354334808&lt;/EditSequence&gt;
221
+ &lt;Name&gt;Test Inc&lt;/Name&gt;
222
+ &lt;FullName&gt;Test Inc&lt;/FullName&gt;
223
+ &lt;IsActive&gt;true&lt;/IsActive&gt;
224
+ &lt;Sublevel&gt;0&lt;/Sublevel&gt;
225
+ &lt;Balance&gt;0.00&lt;/Balance&gt;
226
+ &lt;TotalBalance&gt;0.00&lt;/TotalBalance&gt;
227
+ &lt;JobStatus&gt;None&lt;/JobStatus&gt;
228
+ &lt;/CustomerRet&gt;
229
+ &lt;/CustomerAddRs&gt;
230
+ &lt;/QBXMLMsgsRs&gt;
231
+ &lt;/QBXML&gt;
232
+ </response>
233
+ <hresult />
234
+ <message />
235
+ </receiveResponseXML>
236
+ </soap:Body>
237
+ </soap:Envelope>
238
+ EOT
239
+ end
240
+
241
+ # Response
242
+ # <?xml version="1.0" encoding="utf-8" ?>
243
+ # <env:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
244
+ # xmlns:xsd="http://www.w3.org/2001/XMLSchema"
245
+ # xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
246
+ # <env:Body>
247
+ # <n1:receiveResponseXMLResponse xmlns:n1="http://developer.intuit.com/">
248
+ # <n1:receiveResponseXMLResult xsi:type="xsd:int">100</n1:receiveResponseXMLResult>
249
+ # </n1:receiveResponseXMLResponse>
250
+ # </env:Body>
251
+ # </env:Envelope>
252
+
253
+ before do
254
+ QuickbooksWebConnector.enqueue '<some><xml></xml></some>', SomeHandler, 1
255
+
256
+ do_post
257
+ end
258
+
259
+ it 'responds with success' do
260
+ expect(response).to be_success
261
+ end
262
+
263
+ it 'returns the percentage done' do
264
+ expect(result.text('env:Body/n1:receiveResponseXMLResponse/n1:receiveResponseXMLResult')).to eq('100')
265
+ end
266
+ end
267
+
268
+ context 'closeConnection' do
269
+ # Request
270
+ let(:request_xml) do
271
+ <<-EOT
272
+ <?xml version="1.0" encoding="utf-8"?>
273
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
274
+ <soap:Body>
275
+ <closeConnection xmlns="http://developer.intuit.com/">
276
+ <ticket>934ea5d9-231e-4426-9ae9-720d1020c472</ticket>
277
+ </closeConnection>
278
+ </soap:Body>
279
+ </soap:Envelope>
280
+ EOT
281
+ end
282
+
283
+ # Response
284
+ # <?xml version="1.0" encoding="utf-8" ?>
285
+ # <env:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
286
+ # xmlns:xsd="http://www.w3.org/2001/XMLSchema"
287
+ # xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
288
+ # <env:Body>
289
+ # <n1:closeConnectionResponse xmlns:n1="http://developer.intuit.com/"></n1:closeConnectionResponse>
290
+ # </env:Body>
291
+ # </env:Envelope>
292
+
293
+ before { do_post }
294
+
295
+ it 'responds with success' do
296
+ expect(response).to be_success
297
+ end
298
+
299
+ it 'returns the closeConnectionResponse' do
300
+ expect(result.elements['env:Body/n1:closeConnectionResponse']).to_not be_nil
301
+ end
302
+ end
303
+
304
+ end
305
+
306
+ 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
@@ -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>