sermepa 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.rdoc +3 -0
- data/Rakefile +38 -0
- data/lib/sermepa/config.rb +13 -0
- data/lib/sermepa/constants.rb +28 -0
- data/lib/sermepa/errors.rb +149 -0
- data/lib/sermepa/sermepa.rb +83 -0
- data/lib/sermepa/signature.rb +19 -0
- data/lib/sermepa/version.rb +3 -0
- data/lib/sermepa.rb +17 -0
- data/lib/tasks/sermepa_tasks.rake +10 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config/application.rb +59 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +58 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/sermepa_test.rb +7 -0
- data/test/test_helper.rb +15 -0
- metadata +164 -0
data/MIT-LICENSE
ADDED
@@ -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.
|
data/README.rdoc
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,38 @@
|
|
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 = 'Sermepa'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('README.rdoc')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
Bundler::GemHelper.install_tasks
|
27
|
+
|
28
|
+
require 'rake/testtask'
|
29
|
+
|
30
|
+
Rake::TestTask.new(:test) do |t|
|
31
|
+
t.libs << 'lib'
|
32
|
+
t.libs << 'test'
|
33
|
+
t.pattern = 'test/**/*_test.rb'
|
34
|
+
t.verbose = false
|
35
|
+
end
|
36
|
+
|
37
|
+
|
38
|
+
task :default => :test
|
@@ -0,0 +1,13 @@
|
|
1
|
+
module Sermepa
|
2
|
+
|
3
|
+
Config = Struct.new(:_logger, :service_url, :merchant_code, :secret, :terminal, :currency, :raise_errors, :callback_url) do
|
4
|
+
|
5
|
+
def self.default
|
6
|
+
config = new
|
7
|
+
config._logger = Logger.new STDOUT
|
8
|
+
config.raise_errors = true
|
9
|
+
config
|
10
|
+
end
|
11
|
+
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
module Sermepa
|
2
|
+
|
3
|
+
CURRENCIES = {
|
4
|
+
:EUR => '978',
|
5
|
+
:USD => '840',
|
6
|
+
:GBP => '826',
|
7
|
+
:JPY => '392'
|
8
|
+
}
|
9
|
+
|
10
|
+
TRANSACTION_TYPES = {
|
11
|
+
# Payment Requests
|
12
|
+
:traditional_payment => 'A',
|
13
|
+
:preauthorization => '1',
|
14
|
+
:deferred_authorization => 'O',
|
15
|
+
# Recurrent payments
|
16
|
+
:recurrent_transaction => '5',
|
17
|
+
:deferred_initial_recurrent_authorization => 'R',
|
18
|
+
# Confirmation/Refund requests
|
19
|
+
:confirmation => '2',
|
20
|
+
:automatic_refund => '3',
|
21
|
+
:successive_transaction => '6',
|
22
|
+
:preauthorization_cancel => '9',
|
23
|
+
:deferred_authorization_confirmation => 'P',
|
24
|
+
:deferred_authorization_cancel => 'Q',
|
25
|
+
:deferred_successive_transaction_authorization => 'S'
|
26
|
+
}
|
27
|
+
|
28
|
+
end
|
@@ -0,0 +1,149 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
|
3
|
+
module Sermepa
|
4
|
+
|
5
|
+
ERRORS = {
|
6
|
+
:SIS0007 => "Error al desmontar el XML de entrada",
|
7
|
+
:SIS0008 => "Error falta Ds_Merchant_MerchantCode",
|
8
|
+
:SIS0009 => "Error de formato en Ds_Merchant_MerchantCode",
|
9
|
+
:SIS0010 => "Error falta Ds_Merchant_Terminal",
|
10
|
+
:SIS0011 => "Error de formato en Ds_Merchant_Terminal",
|
11
|
+
:SIS0014 => "Error de formato en Ds_Merchant_Order",
|
12
|
+
:SIS0015 => "Error falta Ds_Merchant_Currency",
|
13
|
+
:SIS0016 => "Error de formato en Ds_Merchant_Currency",
|
14
|
+
:SIS0018 => "Error falta Ds_Merchant_Amount",
|
15
|
+
:SIS0019 => "Error de formato en Ds_Merchant_Amount",
|
16
|
+
:SIS0020 => "Error falta Ds_Merchant_MerchantSignature",
|
17
|
+
:SIS0021 => "Error la Ds_Merchant_MerchantSignature viene vacía",
|
18
|
+
:SIS0022 => "Error de formato en Ds_Merchant_TransactionType",
|
19
|
+
:SIS0023 => "Error Ds_Merchant_TransactionType desconocido",
|
20
|
+
:SIS0026 => "Error No existe el comercio / terminal enviado",
|
21
|
+
:SIS0027 => "Error Moneda enviada por el comercio es diferente a la que tiene asignada para ese terminal",
|
22
|
+
:SIS0028 => "Error Comercio / terminal está dado de baja",
|
23
|
+
:SIS0030 => "Error en un pago con tarjeta ha llegado un tipo de operación no valido",
|
24
|
+
:SIS0031 => "Método de pago no definido",
|
25
|
+
:SIS0034 => "Error de acceso a la Base de Datos ",
|
26
|
+
:SIS0038 => "Error en java",
|
27
|
+
:SIS0040 => "Error el comercio / terminal no tiene ningún método de pago asignado",
|
28
|
+
:SIS0041 => "Error en el cálculo de la firma de datos del comercio",
|
29
|
+
:SIS0042 => "La firma enviada no es correcta",
|
30
|
+
:SIS0046 => "El BIN de la tarjeta no está dado de alta",
|
31
|
+
:SIS0051 => "Error número de pedido repetido",
|
32
|
+
:SIS0054 => "Error no existe operación sobre la que realizar la devolución",
|
33
|
+
:SIS0055 => "Error no existe más de un pago con el mismo número de pedido",
|
34
|
+
:SIS0056 => "La operación sobre la que se desea devolver no está autorizada",
|
35
|
+
:SIS0057 => "El importe a devolver supera el permitido",
|
36
|
+
:SIS0058 => "Inconsistencia de datos, en la validación de una confirmación",
|
37
|
+
:SIS0059 => "Error no existe operación sobre la que realizar la devolución",
|
38
|
+
:SIS0060 => "Ya existe una confirmación asociada a la preautorización",
|
39
|
+
:SIS0061 => "La preautorización sobre la que se desea confirmar no está autorizada",
|
40
|
+
:SIS0062 => "El importe a confirmar supera el permitido",
|
41
|
+
:SIS0063 => "Error. Número de tarjeta no disponible",
|
42
|
+
:SIS0064 => "Error. El número de tarjeta no puede tener más de 19 posiciones",
|
43
|
+
:SIS0065 => "Error. El número de tarjeta no es numérico",
|
44
|
+
:SIS0066 => "Error. Mes de caducidad no disponible",
|
45
|
+
:SIS0067 => "Error. El mes de la caducidad no es numérico",
|
46
|
+
:SIS0068 => "Error. El mes de la caducidad no es válido",
|
47
|
+
:SIS0069 => "Error. Año de caducidad no disponible",
|
48
|
+
:SIS0070 => "Error. El Año de la caducidad no es numérico",
|
49
|
+
:SIS0071 => "Tarjeta caducada",
|
50
|
+
:SIS0072 => "Operación no anulable",
|
51
|
+
:SIS0074 => "Error falta Ds_Merchant_Order",
|
52
|
+
:SIS0075 => "Error el Ds_Merchant_Order tiene menos de 4 posiciones o más de 12",
|
53
|
+
:SIS0076 => "Error el Ds_Merchant_Order no tiene las cuatro primeras posiciones numéricas",
|
54
|
+
:SIS0078 => "Método de pago no disponible",
|
55
|
+
:SIS0079 => "Error al realizar el pago con tarjeta",
|
56
|
+
:SIS0081 => "La sesión es nueva, se han perdido los datos almacenados",
|
57
|
+
:SIS0089 => "El valor de Ds_Merchant_ExpiryDate no ocupa 4 posiciones",
|
58
|
+
:SIS0092 => "El valor de Ds_Merchant_ExpiryDate es nulo",
|
59
|
+
:SIS0093 => "Tarjeta no encontrada en la tabla de rangos",
|
60
|
+
:SIS0112 => "Error. El tipo de transacción especificado en Ds_Merchant_Transaction_Type no esta permitido",
|
61
|
+
:SIS0115 => "Error no existe operación sobre la que realizar el pago de la cuota",
|
62
|
+
:SIS0116 => "La operación sobre la que se desea pagar una cuota no es una operación válida",
|
63
|
+
:SIS0117 => "La operación sobre la que se desea pagar una cuota no está autorizada",
|
64
|
+
:SIS0118 => "Se ha excedido el importe total de las cuotas",
|
65
|
+
:SIS0119 => "Valor del campo Ds_Merchant_DateFrecuency no válido",
|
66
|
+
:SIS0120 => "Valor del campo Ds_Merchant_CargeExpiryDate no válido",
|
67
|
+
:SIS0121 => "Valor del campo Ds_Merchant_SumTotal no válido",
|
68
|
+
:SIS0122 => "Valor del campo Ds_merchant_DateFrecuency o Ds_Merchant_SumTotal tiene formato incorrecto",
|
69
|
+
:SIS0123 => "Se ha excedido la fecha tope para realizar transacciones",
|
70
|
+
:SIS0124 => "No ha transcurrido la frecuencia mínima en un pago recurrente sucesivo",
|
71
|
+
:SIS0132 => "La fecha de Confirmación de Autorización no puede superar en más de 7 días a la de Preautorización",
|
72
|
+
:SIS0139 => "Error el pago recurrente inicial está duplicado SIS0142 Tiempo excedido para el pago",
|
73
|
+
:SIS0216 => "Error Ds_Merchant_CVV2 tiene mas de 3/4 posiciones",
|
74
|
+
:SIS0217 => "Error de formato en Ds_Merchant_CVV2",
|
75
|
+
:SIS0221 => "Error el CVV2 es obligatorio",
|
76
|
+
:SIS0222 => "Ya existe una anulación asociada a la preautorización",
|
77
|
+
:SIS0223 => "La preautorización que se desea anular no está autorizada",
|
78
|
+
:SIS0225 => "Error no existe operación sobre la que realizar la anulación",
|
79
|
+
:SIS0226 => "Inconsistencia de datos, en la validación de una anulación",
|
80
|
+
:SIS0227 => "Valor del campo Ds_Merchan_TransactionDate no válido",
|
81
|
+
:SIS0252 => "El comercio no permite el envío de tarjeta",
|
82
|
+
:SIS0253 => "La tarjeta no cumple el check-digit",
|
83
|
+
:SIS0261 => "Operación detenida por superar el control de restricciones en la entrada al SIS SIS0274 Tipo de operación desconocida o no permitida por esta entrada al SIS"
|
84
|
+
}
|
85
|
+
|
86
|
+
RESPONSE_CODES = {
|
87
|
+
:'0101' => "Tarjeta Caducada",
|
88
|
+
:'0102' => "Tarjeta en excepción transitoria o bajo sospecha de fraude",
|
89
|
+
:'0116' => "Disponible Insuficiente",
|
90
|
+
:'0118' => "Tarjeta no Registrada",
|
91
|
+
:'0180' => "Tarjeta ajena al servicio",
|
92
|
+
:'0184' => "Error en la autenticación del titular",
|
93
|
+
:'0190' => "Denegación sin especificar motivo",
|
94
|
+
:'0191' => "Fecha de caducidad errónea",
|
95
|
+
:'0202' => "Tarjeta en excepción transitoria o bajo sospecha de fraude con retirada de tarjeta",
|
96
|
+
:'0912' => "Emisor no Disponible",
|
97
|
+
:'9912' => "Emisor no Disponible",
|
98
|
+
:'0904' => "Comercio no registrado en FUC",
|
99
|
+
:'9064' => "Número de posiciones de la tarjeta incorrecto",
|
100
|
+
:'9078' => "No existe método de pago válido para esa tarjeta",
|
101
|
+
:'9093' => "Tarjeta no existente",
|
102
|
+
:'9218' => "El comercio no permite op. seguras por entrada /operaciones",
|
103
|
+
:'9253' => "Tarjeta no cumple el check-digit",
|
104
|
+
:'9256' => "El comercio no puede realizar preautorizaciones",
|
105
|
+
:'9257' => "Esta tarjeta no permite operativa de preautorizaciones",
|
106
|
+
:'9261' => "Operación detenida por superar el control de restricciones en la entrada al SIS",
|
107
|
+
:'9913' => "Error en la confirmación que el comercio envía al TPV Virtual (solo aplicable en la opción de sincronización SOAP)",
|
108
|
+
:'9914' => "Confirmación “KO” del comercio (solo aplicable en la opción de sincronización SOAP)",
|
109
|
+
:'9928' => "Anulación de autorización en diferido realizada por el SIS (proceso batch)",
|
110
|
+
:'9929' => "Anulación de autorización en diferido realizada por el comercio",
|
111
|
+
}
|
112
|
+
|
113
|
+
class SermepaRemoteError < StandardError
|
114
|
+
def initialize(error_code)
|
115
|
+
@error_code = error_code
|
116
|
+
end
|
117
|
+
|
118
|
+
def message
|
119
|
+
ERRORS[self.error_code]
|
120
|
+
end
|
121
|
+
|
122
|
+
def error_code
|
123
|
+
@error_code
|
124
|
+
end
|
125
|
+
|
126
|
+
def to_s
|
127
|
+
"#{ @error_code }: #{ message }"
|
128
|
+
end
|
129
|
+
end
|
130
|
+
|
131
|
+
class SermepaPaymentError < StandardError
|
132
|
+
def initialize(error_code)
|
133
|
+
@error_code = error_code
|
134
|
+
end
|
135
|
+
|
136
|
+
def message
|
137
|
+
RESPONSE_CODES[self.error_code]
|
138
|
+
end
|
139
|
+
|
140
|
+
def error_code
|
141
|
+
@error_code
|
142
|
+
end
|
143
|
+
|
144
|
+
def to_s
|
145
|
+
"#{ @error_code }: #{ message }"
|
146
|
+
end
|
147
|
+
end
|
148
|
+
|
149
|
+
end
|
@@ -0,0 +1,83 @@
|
|
1
|
+
require 'active_support/core_ext'
|
2
|
+
require 'sermepa/constants'
|
3
|
+
require 'sermepa/errors'
|
4
|
+
require 'sermepa/signature'
|
5
|
+
|
6
|
+
module Sermepa
|
7
|
+
|
8
|
+
def build_values(params, transaction_type)
|
9
|
+
values = {
|
10
|
+
DS_MERCHANT_MERCHANTCODE: params[:merchant_code] || Sermepa.config.merchant_code,
|
11
|
+
DS_MERCHANT_CURRENCY: CURRENCIES[params[:currency] || Sermepa.config.currency],
|
12
|
+
DS_MERCHANT_TERMINAL: params[:terminal] || Sermepa.config.terminal,
|
13
|
+
DS_MERCHANT_AMOUNT: (params[:amount].to_f * 100).to_i.to_s,
|
14
|
+
DS_MERCHANT_ORDER: params[:order].to_s,
|
15
|
+
DS_MERCHANT_TRANSACTIONTYPE: TRANSACTION_TYPES[transaction_type]
|
16
|
+
}
|
17
|
+
|
18
|
+
#values[:DS_MERCHANT_MERCHANTURL] = Sermepa.config.callback_url if Sermepa.config.callback_url
|
19
|
+
|
20
|
+
values
|
21
|
+
end
|
22
|
+
|
23
|
+
def pay_request(params)
|
24
|
+
values = build_values(params, :traditional_payment)
|
25
|
+
values[:DS_MERCHANT_PAN] = params[:pan]
|
26
|
+
values[:DS_MERCHANT_CVV2] = params[:cvv2]
|
27
|
+
values[:DS_MERCHANT_EXPIRYDATE] = params[:expiration]
|
28
|
+
|
29
|
+
values[:DS_MERCHANT_MERCHANTSIGNATURE] = signature(values)
|
30
|
+
call(values)
|
31
|
+
end
|
32
|
+
|
33
|
+
def confirmation_request(params)
|
34
|
+
values = build_values(params, :confirmation)
|
35
|
+
|
36
|
+
values[:DS_MERCHANT_MERCHANTSIGNATURE] = signature(values)
|
37
|
+
call(values)
|
38
|
+
end
|
39
|
+
|
40
|
+
def refund_request(params)
|
41
|
+
values = build_values(params, :automatic_refund)
|
42
|
+
|
43
|
+
values[:DS_MERCHANT_MERCHANTSIGNATURE] = signature(values)
|
44
|
+
call(values)
|
45
|
+
end
|
46
|
+
|
47
|
+
def call(values = {})
|
48
|
+
client = Savon.client(config.service_url)
|
49
|
+
|
50
|
+
response = client.request :trata_peticion do
|
51
|
+
soap.body do |xml|
|
52
|
+
request_xml = values.to_xml(root: :DATOSENTRADA, dasherize: false, skip_instruct: true)
|
53
|
+
xml.DATOSENTRADA(request_xml)
|
54
|
+
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
result = Hash.from_xml response.to_hash[:trata_peticion_response][:trata_peticion_return]
|
59
|
+
error_code = result['RETORNOXML']['CODIGO'].to_sym
|
60
|
+
remote_error = error_code != :'0'
|
61
|
+
|
62
|
+
if remote_error
|
63
|
+
config._logger.warn("[Sermepa] Remote Error (#{error_code}): #{ERRORS[error_code]}")
|
64
|
+
if config.raise_errors
|
65
|
+
raise SermepaRemoteError.new(error_code)
|
66
|
+
else
|
67
|
+
return error_code
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
response_code = result['RETORNOXML']['OPERACION']['Ds_Response']
|
72
|
+
|
73
|
+
unless (0..99).include?(response_code.to_i) || response_code.to_i == 900
|
74
|
+
if config.raise_errors
|
75
|
+
raise SermepaPaymentError.new(response_code.to_sym)
|
76
|
+
else
|
77
|
+
return response_code.to_sym
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
return false # No errors
|
82
|
+
end
|
83
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'digest/sha1'
|
2
|
+
|
3
|
+
module Sermepa
|
4
|
+
def signature(values, secret = nil)
|
5
|
+
token = ""
|
6
|
+
token += values[:DS_MERCHANT_AMOUNT].to_s
|
7
|
+
token += values[:DS_MERCHANT_ORDER].to_s
|
8
|
+
token += values[:DS_MERCHANT_MERCHANTCODE].to_s
|
9
|
+
token += values[:DS_MERCHANT_CURRENCY].to_s
|
10
|
+
token += values[:DS_MERCHANT_PAN].to_s
|
11
|
+
token += values[:DS_MERCHANT_CVV2].to_s
|
12
|
+
token += values[:DS_MERCHANT_TRANSACTIONTYPE].to_s
|
13
|
+
#token += values[:DS_MERCHANT_MERCHANTURL].to_s
|
14
|
+
token += secret || config.secret
|
15
|
+
|
16
|
+
Digest::SHA1.hexdigest(token)
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
data/lib/sermepa.rb
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
require "sermepa/sermepa"
|
2
|
+
require "sermepa/config"
|
3
|
+
require "sermepa/signature"
|
4
|
+
require "sermepa/version"
|
5
|
+
|
6
|
+
module Sermepa
|
7
|
+
extend self
|
8
|
+
|
9
|
+
def configure
|
10
|
+
yield config
|
11
|
+
end
|
12
|
+
|
13
|
+
def config
|
14
|
+
@config ||= Config.default
|
15
|
+
end
|
16
|
+
|
17
|
+
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.
|
data/test/dummy/Rakefile
ADDED
@@ -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 .
|