pay_fu 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.md +54 -0
  3. data/Rakefile +40 -0
  4. data/app/assets/javascripts/pay_fu/application.js +15 -0
  5. data/app/assets/stylesheets/pay_fu/application.css +13 -0
  6. data/app/controllers/pay_fu/alipay_transactions_controller.rb +28 -0
  7. data/app/controllers/pay_fu/application_controller.rb +4 -0
  8. data/app/controllers/pay_fu/paypal_transactions_controller.rb +28 -0
  9. data/app/helpers/pay_fu/alipay_helper.rb +24 -0
  10. data/app/helpers/pay_fu/application_helper.rb +4 -0
  11. data/app/helpers/pay_fu/paypal_helper.rb +8 -0
  12. data/app/models/pay_fu/alipay_transaction.rb +4 -0
  13. data/app/models/pay_fu/paypal_transaction.rb +4 -0
  14. data/app/models/pay_fu/transaction.rb +5 -0
  15. data/app/views/layouts/pay_fu/application.html.erb +14 -0
  16. data/config/routes.rb +4 -0
  17. data/lib/generators/pay_fu/install_generator.rb +19 -0
  18. data/lib/generators/pay_fu/templates/config.yml +23 -0
  19. data/lib/generators/pay_fu/templates/migration.rb +15 -0
  20. data/lib/generators/pay_fu/utils.rb +29 -0
  21. data/lib/pay_fu.rb +4 -0
  22. data/lib/pay_fu/engine.rb +27 -0
  23. data/lib/pay_fu/version.rb +3 -0
  24. data/lib/tasks/pay_fu_tasks.rake +4 -0
  25. data/test/dummy/README.rdoc +261 -0
  26. data/test/dummy/Rakefile +7 -0
  27. data/test/dummy/app/assets/javascripts/application.js +15 -0
  28. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  29. data/test/dummy/app/controllers/application_controller.rb +3 -0
  30. data/test/dummy/app/helpers/application_helper.rb +2 -0
  31. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  32. data/test/dummy/config.ru +4 -0
  33. data/test/dummy/config/application.rb +56 -0
  34. data/test/dummy/config/boot.rb +10 -0
  35. data/test/dummy/config/database.yml +25 -0
  36. data/test/dummy/config/environment.rb +5 -0
  37. data/test/dummy/config/environments/development.rb +37 -0
  38. data/test/dummy/config/environments/production.rb +67 -0
  39. data/test/dummy/config/environments/test.rb +37 -0
  40. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  41. data/test/dummy/config/initializers/inflections.rb +15 -0
  42. data/test/dummy/config/initializers/mime_types.rb +5 -0
  43. data/test/dummy/config/initializers/secret_token.rb +7 -0
  44. data/test/dummy/config/initializers/session_store.rb +8 -0
  45. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  46. data/test/dummy/config/locales/en.yml +5 -0
  47. data/test/dummy/config/routes.rb +4 -0
  48. data/test/dummy/public/404.html +26 -0
  49. data/test/dummy/public/422.html +26 -0
  50. data/test/dummy/public/500.html +25 -0
  51. data/test/dummy/public/favicon.ico +0 -0
  52. data/test/dummy/script/rails +6 -0
  53. data/test/fixtures/pay_fu/transactions.yml +27 -0
  54. data/test/integration/navigation_test.rb +10 -0
  55. data/test/pay_fu_test.rb +7 -0
  56. data/test/test_helper.rb +15 -0
  57. data/test/unit/pay_fu/transaction_test.rb +9 -0
  58. metadata +185 -0
@@ -0,0 +1,20 @@
1
+ Copyright 2012 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,54 @@
1
+ # pay_fu
2
+
3
+ a rails payment engine that supports both alipay and paypal.
4
+
5
+ ## Setup
6
+
7
+ 1) add to Gemfile
8
+
9
+ ```ruby
10
+ gem "pay_fu"
11
+ ```
12
+
13
+ 2) install gem
14
+
15
+ ```bash
16
+ bundle install
17
+ ```
18
+
19
+ 3) generate config file, route and migration file
20
+
21
+ ```bash
22
+ rails generate pay_fu:install
23
+ ```
24
+
25
+ 4) update config file config/pay_fu.yml
26
+
27
+ 5) run migration
28
+
29
+ ```bash
30
+ rake db:migrate
31
+ ```
32
+
33
+ 6) in controller file, after user clicking checkout, redirect him to
34
+ paypal gateway page.
35
+
36
+ ```ruby
37
+ include PayFu::PaypalHelper
38
+ def action
39
+ ...
40
+ redirect_to_paypal_gateway(:item_name => "subject", :amount => 123)
41
+ return
42
+ end
43
+ ```
44
+
45
+ 7) similar for alipay
46
+
47
+ ```ruby
48
+ include PayFu::AlipayHelper
49
+ def action
50
+ ...
51
+ redirect_to_alipay_gateway(:subject => "donatecn", :body => "donatecn", :amount => @donate.amount, :out_trade_no => "123", :notify_url => pay_fu.alipay_transactions_notify_url)
52
+ return
53
+ end
54
+ ```
@@ -0,0 +1,40 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ rescue LoadError
10
+ require 'rdoc/rdoc'
11
+ require 'rake/rdoctask'
12
+ RDoc::Task = Rake::RDocTask
13
+ end
14
+
15
+ RDoc::Task.new(:rdoc) do |rdoc|
16
+ rdoc.rdoc_dir = 'rdoc'
17
+ rdoc.title = 'PayFu'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+
27
+
28
+ Bundler::GemHelper.install_tasks
29
+
30
+ require 'rake/testtask'
31
+
32
+ Rake::TestTask.new(:test) do |t|
33
+ t.libs << 'lib'
34
+ t.libs << 'test'
35
+ t.pattern = 'test/**/*_test.rb'
36
+ t.verbose = false
37
+ end
38
+
39
+
40
+ task :default => :test
@@ -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,28 @@
1
+ module PayFu
2
+ class AlipayTransactionsController < ApplicationController
3
+ include ActiveMerchant::Billing::Integrations
4
+
5
+ def notify
6
+ notify = Alipay::Notification.new(request.new_post)
7
+ if notify.acknowledge
8
+ if transaction = PayFu::AlipayTransaction.find_by_transaction_id(notify.trade_no)
9
+ transaction.update_attributes(transaction_attributes(notify))
10
+ else
11
+ PayFu::AlipayTransaction.create(transaction_attributes(notify))
12
+ end
13
+ end
14
+ render :nothing => true
15
+ end
16
+
17
+ def transaction_attributes(notify)
18
+ @transaction_attributes ||= {
19
+ :transaction_id => notify.trade_no,
20
+ :transaction_type => notify.payment_type,
21
+ :payment_status => notify.trade_status,
22
+ :payment_date => notify.notify_time,
23
+ :gross => notify.total_fee,
24
+ :raw_post => notify.raw
25
+ }
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,4 @@
1
+ module PayFu
2
+ class ApplicationController < ActionController::Base
3
+ end
4
+ end
@@ -0,0 +1,28 @@
1
+ module PayFu
2
+ class PaypalTransactionsController < ApplicationController
3
+ include ActiveMerchant::Billing::Integrations
4
+
5
+ def notify
6
+ notify = Paypal::Notification.new(request.raw_post)
7
+ if notify.acknowledge
8
+ if transaction = PayFu::PaypalTransaction.find_by_transaction_id(notify.transaction_id)
9
+ transaction.update_attributes(transaction_attributes(notify))
10
+ else
11
+ PayFu::PaypalTransaction.create(transaction_attributes(notify))
12
+ end
13
+ end
14
+ render :nothing => true
15
+ end
16
+
17
+ def transaction_attributes(notify)
18
+ @transaction_attributes ||= {
19
+ :transaction_id => notify.transaction_id,
20
+ :transaction_type => notify.type,
21
+ :payment_status => notify.status,
22
+ :payment_date => notify.received_at,
23
+ :gross => notify.gross_cents,
24
+ :raw_post => notify.raw
25
+ }
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,24 @@
1
+ require 'digest/md5'
2
+
3
+ module PayFu
4
+ module AlipayHelper
5
+ def redirect_to_alipay_gateway(options={})
6
+ query_string = {
7
+ :partner => ActiveMerchant::Billing::Integrations::Alipay::ACCOUNT,
8
+ :out_trade_no => options[:out_trade_no],
9
+ :total_fee => options[:amount],
10
+ :seller_email => ActiveMerchant::Billing::Integrations::Alipay::EMAIL,
11
+ :notify_url => options[:notify_url],
12
+ :body => options[:body],
13
+ :"_input_charset" => 'utf-8',
14
+ :service => ActiveMerchant::Billing::Integrations::Alipay::Helper::CREATE_DIRECT_PAY_BY_USER,
15
+ :payment_type => "1",
16
+ :subject => options[:subject]
17
+ }.sort.map { |key, value| "#{key}=#{CGI.unescape(value)}" }.join("&")
18
+ sign = Digest::MD5.hexdigest(query_string + ActiveMerchant::Billing::Integrations::Alipay::KEY)
19
+ query_string += "&sign=#{sign}&sign_type=MD5"
20
+
21
+ redirect_to "https://www.alipay.com/cooperate/gateway.do?" + query_string
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,4 @@
1
+ module PayFu
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,8 @@
1
+ module PayFu
2
+ module PaypalHelper
3
+ def redirect_to_paypal_gateway(options={})
4
+ host = ActiveMerchant::Billing::Base.mode == "test" ? "www.sandbox.paypal.com" : "www.paypal.com"
5
+ redirect_to URI.encode("https://#{host}/cgi-bin/webscr?cmd=_ext-enter&redirect_cmd=_xclick&charset=utf-8&business=#{PayFu::CONFIGS["paypal"]["email"]}&currenct_code=USD&item_name=#{options[:item_name]}&amount=#{options[:amount]}")
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,4 @@
1
+ module PayFu
2
+ class AlipayTransaction < Transaction
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module PayFu
2
+ class PaypalTransaction < Transaction
3
+ end
4
+ end
@@ -0,0 +1,5 @@
1
+ module PayFu
2
+ class Transaction < ActiveRecord::Base
3
+ attr_accessible :transaction_id, :transaction_type, :payment_status, :payment_date, :gross, :raw_post, :type
4
+ end
5
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>PayFu</title>
5
+ <%= stylesheet_link_tag "pay_fu/application", :media => "all" %>
6
+ <%= javascript_include_tag "pay_fu/application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,4 @@
1
+ PayFu::Engine.routes.draw do
2
+ match '/paypal_transactions/notify' => 'paypal_transactions#notify'
3
+ match '/alipay_transactions/notify' => 'alipay_transactions#notify'
4
+ end
@@ -0,0 +1,19 @@
1
+ require 'rails/generators'
2
+ require File.expand_path('../utils', __FILE__)
3
+
4
+ module PayFu
5
+ class InstallGenerator < Rails::Generators::Base
6
+ source_root File.expand_path("../templates", __FILE__)
7
+ include Rails::Generators::Migration
8
+ include Generators::Utils::InstanceMethods
9
+ extend Generators::Utils::ClassMethods
10
+
11
+ desc "PayFu installation generator"
12
+ def install
13
+ migration_template 'migration.rb', 'db/migrate/create_pay_fu_transactions.rb' rescue display $!.message
14
+ route("mount PayFu::Engine => '/pay_fu', :as => 'pay_fu'")
15
+ template "config.yml", "config/pay_fu.yml"
16
+ display "PayFu engine is installed."
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,23 @@
1
+ development:
2
+ paypal:
3
+ mode: "test"
4
+ email: ""
5
+ login: ""
6
+ password: ""
7
+ signature: ""
8
+ alipay:
9
+ key: ""
10
+ account: ""
11
+ email: ""
12
+
13
+ production:
14
+ paypal:
15
+ mode: "production"
16
+ email: ""
17
+ login: ""
18
+ password: ""
19
+ signature: ""
20
+ alipay:
21
+ key: ""
22
+ account: ""
23
+ email: ""
@@ -0,0 +1,15 @@
1
+ class CreatePayFuTransactions < ActiveRecord::Migration
2
+ def change
3
+ create_table :pay_fu_transactions do |t|
4
+ t.string :type
5
+ t.string :transaction_id
6
+ t.string :transaction_type
7
+ t.string :payment_status
8
+ t.datetime :payment_date
9
+ t.integer :gross
10
+ t.string :raw_post
11
+
12
+ t.timestamps
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,29 @@
1
+ module PayFu
2
+ module Generators
3
+ module Utils
4
+ module InstanceMethods
5
+ def display(output, color = :green)
6
+ say(" - #{output}", color)
7
+ end
8
+
9
+ def ask_for(wording, default_value = nil, override_if_present_value = nil)
10
+ override_if_present_value.present? ?
11
+ display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value :
12
+ ask(" ? #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
13
+ end
14
+ end
15
+
16
+ module ClassMethods
17
+ def next_migration_number(dirname)
18
+ if ActiveRecord::Base.timestamped_migrations
19
+ migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
20
+ migration_number += 1
21
+ migration_number.to_s
22
+ else
23
+ "%.3d" % (current_migration_number(dirname) + 1)
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,4 @@
1
+ require "pay_fu/engine"
2
+
3
+ module PayFu
4
+ end
@@ -0,0 +1,27 @@
1
+ module PayFu
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace PayFu
4
+
5
+ initializer "pay_fu_engine.load_configs" do |app|
6
+ config_file = Rails.root.join("config/pay_fu.yml")
7
+ if config_file.file?
8
+ require 'active_merchant'
9
+ require 'activemerchant_patch_for_china'
10
+
11
+ PayFu::CONFIGS = YAML.load_file(config_file)[Rails.env]
12
+ paypal_config = PayFu::CONFIGS["paypal"]
13
+
14
+ ActiveMerchant::Billing::Base.mode = paypal_config["mode"].to_sym
15
+ ActiveMerchant::Billing::PaypalGateway.new(
16
+ :login => paypal_config["login"],
17
+ :password => paypal_config["password"],
18
+ :signature => paypal_config["signature"]
19
+ )
20
+
21
+ ActiveMerchant::Billing::Integrations::Alipay::KEY = PayFu::CONFIGS["alipay"]["key"]
22
+ ActiveMerchant::Billing::Integrations::Alipay::ACCOUNT = PayFu::CONFIGS["alipay"]["account"]
23
+ ActiveMerchant::Billing::Integrations::Alipay::EMAIL = PayFu::CONFIGS["alipay"]["email"]
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,3 @@
1
+ module PayFu
2
+ VERSION = "1.0.0"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :pay_fu do
3
+ # # Task goes here
4
+ # 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.