rubysync 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/bin/rubysync +312 -0
- data/examples/ar_client_webapp/README +182 -0
- data/examples/ar_client_webapp/Rakefile +10 -0
- data/examples/ar_client_webapp/app/controllers/application.rb +7 -0
- data/examples/ar_client_webapp/app/controllers/user_controller.rb +5 -0
- data/examples/ar_client_webapp/app/helpers/application_helper.rb +3 -0
- data/examples/ar_client_webapp/app/helpers/user_helper.rb +2 -0
- data/examples/ar_client_webapp/app/models/user.rb +2 -0
- data/examples/ar_client_webapp/config/boot.rb +45 -0
- data/examples/ar_client_webapp/config/database.yml +36 -0
- data/examples/ar_client_webapp/config/environment.rb +60 -0
- data/examples/ar_client_webapp/config/environments/development.rb +21 -0
- data/examples/ar_client_webapp/config/environments/production.rb +18 -0
- data/examples/ar_client_webapp/config/environments/test.rb +19 -0
- data/examples/ar_client_webapp/config/routes.rb +23 -0
- data/examples/ar_client_webapp/db/migrate/001_create_users.rb +13 -0
- data/examples/ar_client_webapp/db/schema.rb +13 -0
- data/examples/ar_client_webapp/doc/README_FOR_APP +2 -0
- data/examples/ar_client_webapp/public/404.html +30 -0
- data/examples/ar_client_webapp/public/500.html +30 -0
- data/examples/ar_client_webapp/public/dispatch.cgi +10 -0
- data/examples/ar_client_webapp/public/dispatch.fcgi +24 -0
- data/examples/ar_client_webapp/public/dispatch.rb +10 -0
- data/examples/ar_client_webapp/public/favicon.ico +0 -0
- data/examples/ar_client_webapp/public/images/rails.png +0 -0
- data/examples/ar_client_webapp/public/index.html +277 -0
- data/examples/ar_client_webapp/public/javascripts/application.js +2 -0
- data/examples/ar_client_webapp/public/javascripts/controls.js +833 -0
- data/examples/ar_client_webapp/public/javascripts/dragdrop.js +942 -0
- data/examples/ar_client_webapp/public/javascripts/effects.js +1088 -0
- data/examples/ar_client_webapp/public/javascripts/prototype.js +2515 -0
- data/examples/ar_client_webapp/public/robots.txt +1 -0
- data/examples/ar_client_webapp/script/about +3 -0
- data/examples/ar_client_webapp/script/breakpointer +3 -0
- data/examples/ar_client_webapp/script/console +3 -0
- data/examples/ar_client_webapp/script/destroy +3 -0
- data/examples/ar_client_webapp/script/generate +3 -0
- data/examples/ar_client_webapp/script/performance/benchmarker +3 -0
- data/examples/ar_client_webapp/script/performance/profiler +3 -0
- data/examples/ar_client_webapp/script/plugin +3 -0
- data/examples/ar_client_webapp/script/process/inspector +3 -0
- data/examples/ar_client_webapp/script/process/reaper +3 -0
- data/examples/ar_client_webapp/script/process/spawner +3 -0
- data/examples/ar_client_webapp/script/runner +3 -0
- data/examples/ar_client_webapp/script/server +3 -0
- data/examples/ar_client_webapp/test/fixtures/users.yml +5 -0
- data/examples/ar_client_webapp/test/functional/user_controller_test.rb +18 -0
- data/examples/ar_client_webapp/test/test_helper.rb +28 -0
- data/examples/ar_client_webapp/test/unit/user_test.rb +10 -0
- data/examples/ar_webapp/README +1 -0
- data/examples/ar_webapp/Rakefile +10 -0
- data/examples/ar_webapp/app/controllers/application.rb +7 -0
- data/examples/ar_webapp/app/controllers/hobbies_controller.rb +10 -0
- data/examples/ar_webapp/app/controllers/interests_controller.rb +9 -0
- data/examples/ar_webapp/app/controllers/people_controller.rb +14 -0
- data/examples/ar_webapp/app/controllers/ruby_sync_associations_controller.rb +10 -0
- data/examples/ar_webapp/app/helpers/application_helper.rb +3 -0
- data/examples/ar_webapp/app/models/hobby.rb +5 -0
- data/examples/ar_webapp/app/models/interest.rb +6 -0
- data/examples/ar_webapp/app/models/person.rb +9 -0
- data/examples/ar_webapp/app/models/ruby_sync_association.rb +5 -0
- data/examples/ar_webapp/app/models/ruby_sync_event.rb +9 -0
- data/examples/ar_webapp/app/models/ruby_sync_observer.rb +28 -0
- data/examples/ar_webapp/app/models/ruby_sync_operation.rb +20 -0
- data/examples/ar_webapp/app/models/ruby_sync_state.rb +2 -0
- data/examples/ar_webapp/app/models/ruby_sync_value.rb +7 -0
- data/examples/ar_webapp/app/views/layouts/application.rhtml +19 -0
- data/examples/ar_webapp/app/views/people/show.rhtml +18 -0
- data/examples/ar_webapp/config/boot.rb +45 -0
- data/examples/ar_webapp/config/database.yml +36 -0
- data/examples/ar_webapp/config/environment.rb +61 -0
- data/examples/ar_webapp/config/environments/development.rb +21 -0
- data/examples/ar_webapp/config/environments/production.rb +18 -0
- data/examples/ar_webapp/config/environments/test.rb +19 -0
- data/examples/ar_webapp/config/routes.rb +23 -0
- data/examples/ar_webapp/db/migrate/001_create_people.rb +12 -0
- data/examples/ar_webapp/db/migrate/002_create_interests.rb +12 -0
- data/examples/ar_webapp/db/migrate/003_create_hobbies.rb +11 -0
- data/examples/ar_webapp/db/migrate/004_create_ruby_sync_associations.rb +18 -0
- data/examples/ar_webapp/db/migrate/005_create_ruby_sync_events.rb +16 -0
- data/examples/ar_webapp/db/migrate/006_create_ruby_sync_operations.rb +15 -0
- data/examples/ar_webapp/db/migrate/007_create_ruby_sync_values.rb +12 -0
- data/examples/ar_webapp/db/migrate/008_ruby_sync_tracking.rb +16 -0
- data/examples/ar_webapp/db/migrate/009_create_ruby_sync_states.rb +10 -0
- data/examples/ar_webapp/db/schema.rb +56 -0
- data/examples/ar_webapp/doc/README_FOR_APP +2 -0
- data/examples/ar_webapp/public/404.html +30 -0
- data/examples/ar_webapp/public/500.html +30 -0
- data/examples/ar_webapp/public/dispatch.cgi +10 -0
- data/examples/ar_webapp/public/dispatch.fcgi +24 -0
- data/examples/ar_webapp/public/dispatch.rb +10 -0
- data/examples/ar_webapp/public/favicon.ico +0 -0
- data/examples/ar_webapp/public/images/rails.png +0 -0
- data/examples/ar_webapp/public/index.html +277 -0
- data/examples/ar_webapp/public/javascripts/application.js +2 -0
- data/examples/ar_webapp/public/javascripts/controls.js +833 -0
- data/examples/ar_webapp/public/javascripts/dragdrop.js +942 -0
- data/examples/ar_webapp/public/javascripts/effects.js +1088 -0
- data/examples/ar_webapp/public/javascripts/prototype.js +2515 -0
- data/examples/ar_webapp/public/robots.txt +1 -0
- data/examples/ar_webapp/script/about +3 -0
- data/examples/ar_webapp/script/breakpointer +3 -0
- data/examples/ar_webapp/script/console +3 -0
- data/examples/ar_webapp/script/destroy +3 -0
- data/examples/ar_webapp/script/generate +3 -0
- data/examples/ar_webapp/script/performance/benchmarker +3 -0
- data/examples/ar_webapp/script/performance/profiler +3 -0
- data/examples/ar_webapp/script/plugin +3 -0
- data/examples/ar_webapp/script/process/inspector +3 -0
- data/examples/ar_webapp/script/process/reaper +3 -0
- data/examples/ar_webapp/script/process/spawner +3 -0
- data/examples/ar_webapp/script/runner +3 -0
- data/examples/ar_webapp/script/server +3 -0
- data/examples/ar_webapp/test/fixtures/association_keys.yml +5 -0
- data/examples/ar_webapp/test/fixtures/hobbies.yml +5 -0
- data/examples/ar_webapp/test/fixtures/interests.yml +5 -0
- data/examples/ar_webapp/test/fixtures/people.yml +9 -0
- data/examples/ar_webapp/test/fixtures/ruby_sync_events.yml +5 -0
- data/examples/ar_webapp/test/fixtures/ruby_sync_operations.yml +5 -0
- data/examples/ar_webapp/test/fixtures/ruby_sync_states.yml +5 -0
- data/examples/ar_webapp/test/fixtures/ruby_sync_values.yml +5 -0
- data/examples/ar_webapp/test/test_helper.rb +28 -0
- data/examples/ar_webapp/test/unit/association_key_test.rb +8 -0
- data/examples/ar_webapp/test/unit/hobby_test.rb +10 -0
- data/examples/ar_webapp/test/unit/interest_test.rb +10 -0
- data/examples/ar_webapp/test/unit/person_test.rb +10 -0
- data/examples/ar_webapp/test/unit/ruby_sync_event_test.rb +12 -0
- data/examples/ar_webapp/test/unit/ruby_sync_observer_test.rb +57 -0
- data/examples/ar_webapp/test/unit/ruby_sync_operation_test.rb +10 -0
- data/examples/ar_webapp/test/unit/ruby_sync_state_test.rb +10 -0
- data/examples/ar_webapp/test/unit/ruby_sync_value_test.rb +10 -0
- data/examples/ims2/connectors/hr_db_connector.rb +8 -0
- data/examples/ims2/connectors/my_csv_connector.rb +12 -0
- data/examples/ims2/pipelines/hr_import_pipeline.rb +33 -0
- data/examples/my_ims/connectors/corp_directory_connector.rb +12 -0
- data/examples/my_ims/connectors/finance_connector.rb +7 -0
- data/examples/my_ims/connectors/hr_db_connector.rb +7 -0
- data/examples/my_ims/pipelines/finance_pipeline.rb +33 -0
- data/examples/my_ims/pipelines/hr_import_pipeline.rb +29 -0
- data/lib/ruby_sync/connectors/active_record_connector.rb +198 -0
- data/lib/ruby_sync/connectors/base_connector.rb +317 -0
- data/lib/ruby_sync/connectors/connector_event_processing.rb +78 -0
- data/lib/ruby_sync/connectors/csv_file_connector.rb +95 -0
- data/lib/ruby_sync/connectors/file_connector.rb +74 -0
- data/lib/ruby_sync/connectors/ldap_connector.rb +192 -0
- data/lib/ruby_sync/connectors/memory_connector.rb +185 -0
- data/lib/ruby_sync/event.rb +220 -0
- data/lib/ruby_sync/operation.rb +82 -0
- data/lib/ruby_sync/pipelines/base_pipeline.rb +360 -0
- data/lib/ruby_sync/util/metaid.rb +24 -0
- data/lib/ruby_sync/util/utilities.rb +115 -0
- data/lib/ruby_sync.rb +81 -0
- data/test/hashlike_tests.rb +111 -0
- data/test/ruby_sync_test.rb +48 -0
- data/test/test_active_record_vault.rb +113 -0
- data/test/test_csv_file_connector.rb +75 -0
- data/test/test_event.rb +40 -0
- data/test/test_ldap_connector.rb +89 -0
- data/test/test_memory_connectors.rb +40 -0
- data/test/ts_rubysync.rb +20 -0
- metadata +316 -0
data/bin/rubysync
ADDED
@@ -0,0 +1,312 @@
|
|
1
|
+
#!/opt/local/bin/ruby
|
2
|
+
|
3
|
+
|
4
|
+
# == Synopsis
|
5
|
+
#
|
6
|
+
# Command line tool for running *rubysync* <em>A Free MetaDirectory.</em>
|
7
|
+
#
|
8
|
+
# == Usage
|
9
|
+
#
|
10
|
+
# rubysync command name [options]
|
11
|
+
#
|
12
|
+
# Valid commands are::
|
13
|
+
# * create {name}:: Create a rubysync configuration directory
|
14
|
+
#
|
15
|
+
# * connector {name} -t {type} [--vault {name}] [--client {name}]
|
16
|
+
# ; Create a connector of the given name in
|
17
|
+
# ; the current rubysync configuration directory
|
18
|
+
#
|
19
|
+
# * fields {name} ; list the fields detected by the named connector
|
20
|
+
#
|
21
|
+
# * pipeline {name} ; Create a rubysync pipeline of the given name
|
22
|
+
# ; in the current rubysync configuration directory
|
23
|
+
#
|
24
|
+
# * once {name}::
|
25
|
+
# Execute the named pipeline within the current configuration directory once and then exit
|
26
|
+
#
|
27
|
+
# * example:: Show an example of how this command might be used
|
28
|
+
#
|
29
|
+
# == Example
|
30
|
+
#
|
31
|
+
# This sets up the skeleton of a configuration for importing comma delimeted
|
32
|
+
# text files into a database. Note, if the application happens to be a Rails app
|
33
|
+
# then it can also export changes.
|
34
|
+
# <tt>
|
35
|
+
# $ rubysync create db_demo
|
36
|
+
# $ cd db_demo
|
37
|
+
# $ rubysync connector my_csv -t csv_file
|
38
|
+
# $ rubysync connector my_db -t active_record
|
39
|
+
# </tt>
|
40
|
+
#
|
41
|
+
# You would then edit the files::
|
42
|
+
#
|
43
|
+
# * +connectors/my_csv_connector.rb+:: where to get the CSV files, field names, etc
|
44
|
+
# * +connectors/my_db_connector.rb+:: how to connect to your database or Rails app.
|
45
|
+
#
|
46
|
+
# And enter::
|
47
|
+
# <tt>
|
48
|
+
# $ rubysync pipeline my_pipeline -C my_csv -V my_db
|
49
|
+
# </tt>
|
50
|
+
#
|
51
|
+
# You would then edit the file +pipelines/my_pipeline.rb+ to configure the
|
52
|
+
# policy for synchronizing between the two connectors.
|
53
|
+
#
|
54
|
+
# You may then execute the pipeline in one-shot mode (daemon mode is coming)::
|
55
|
+
#
|
56
|
+
# <tt>
|
57
|
+
# $ rubysync once my_pipeline
|
58
|
+
# </tt>
|
59
|
+
#
|
60
|
+
# == Author
|
61
|
+
# Ritchie Young, 9 to 5 Magic (http://9to5magic.com.au)
|
62
|
+
#
|
63
|
+
# == Copyright
|
64
|
+
# Copyright (c) 2007 Ritchie Young. All rights reserved.
|
65
|
+
#
|
66
|
+
# This file is part of RubySync.
|
67
|
+
#
|
68
|
+
# RubySync is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License
|
69
|
+
# as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
|
70
|
+
#
|
71
|
+
# RubySync is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
|
72
|
+
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
73
|
+
#
|
74
|
+
# You should have received a copy of the GNU General Public License along with RubySync; if not, write to the
|
75
|
+
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
76
|
+
|
77
|
+
|
78
|
+
lib_path = File.dirname(__FILE__) + '/../lib'
|
79
|
+
$:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
|
80
|
+
require "ruby_sync"
|
81
|
+
require "simpleconsole"
|
82
|
+
require 'rdoc/usage'
|
83
|
+
|
84
|
+
|
85
|
+
class Controller < SimpleConsole::Controller
|
86
|
+
|
87
|
+
include RubySync::Utilities
|
88
|
+
|
89
|
+
before_filter :configure_logging
|
90
|
+
|
91
|
+
params :string => {:p => :pipe,
|
92
|
+
:t => :type,
|
93
|
+
:V => :vault,
|
94
|
+
:C => :client},
|
95
|
+
:int =>{:v => :verbose}
|
96
|
+
|
97
|
+
def default
|
98
|
+
#RDoc::usage 'Usage'
|
99
|
+
end
|
100
|
+
|
101
|
+
def example
|
102
|
+
#RDoc::usage 'Example'
|
103
|
+
end
|
104
|
+
|
105
|
+
# Run specified pipeline once then exit
|
106
|
+
def once
|
107
|
+
pipeline_name = params[:id]
|
108
|
+
pipeline = pipeline_called pipeline_name
|
109
|
+
if pipeline
|
110
|
+
pipeline.run_once
|
111
|
+
else
|
112
|
+
log.error "Couldn't find a pipeline called '#{pipeline_name}'"
|
113
|
+
end
|
114
|
+
end
|
115
|
+
|
116
|
+
# Create a Rubysync project directory
|
117
|
+
def create
|
118
|
+
config_path = params[:id]
|
119
|
+
ensure_dir_exists config_path
|
120
|
+
ensure_dir_exists config_path + "/pipelines"
|
121
|
+
ensure_dir_exists config_path + "/connectors"
|
122
|
+
end
|
123
|
+
|
124
|
+
# Create a connector configuration file
|
125
|
+
def connector
|
126
|
+
name = params[:id]
|
127
|
+
type = params[:type]
|
128
|
+
unless name and type
|
129
|
+
puts "Usage: rubysync connector connector_name -t connector_type"
|
130
|
+
return
|
131
|
+
end
|
132
|
+
if base_path
|
133
|
+
File.open("#{base_path}/connectors/#{name}_connector.rb", "w") do |file|
|
134
|
+
file.puts connector_template(name, type)
|
135
|
+
end
|
136
|
+
else
|
137
|
+
puts 'Change into a config dir and try again or create a config dir with "rubysync create"'
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
# List the fields that the named connector can detect. This is
|
142
|
+
# a good way to test if a connector config is functional.
|
143
|
+
def fields
|
144
|
+
connector_name = params[:id]
|
145
|
+
connector = (connector_name)? ::RubySync::Connectors::BaseConnector.class_for(connector_name) : nil
|
146
|
+
@field_names = connector && connector.fields || []
|
147
|
+
end
|
148
|
+
|
149
|
+
def pipeline
|
150
|
+
name = params[:id]
|
151
|
+
vault_name = params[:vault]
|
152
|
+
client_name = params[:client]
|
153
|
+
unless name
|
154
|
+
puts "Usage: rubysync pipeline pipeline_name [-V vault] [-C client]"
|
155
|
+
return
|
156
|
+
end
|
157
|
+
if base_path
|
158
|
+
File.open("#{base_path}/pipelines/#{name}_pipeline.rb", "w") do |file|
|
159
|
+
file.puts pipeline_template(name, vault_name, client_name)
|
160
|
+
end
|
161
|
+
else
|
162
|
+
puts 'Change into a config dir and try again or create a config dir with "rubysync create"'
|
163
|
+
end
|
164
|
+
|
165
|
+
end
|
166
|
+
|
167
|
+
|
168
|
+
private
|
169
|
+
|
170
|
+
def configure_logging
|
171
|
+
log_levels = [Logger::WARN, Logger::INFO, Logger::DEBUG]
|
172
|
+
verbosity = [(params[:verbose]||0), log_levels.size-1].min
|
173
|
+
log.level = log_levels[verbosity]
|
174
|
+
end
|
175
|
+
|
176
|
+
end
|
177
|
+
|
178
|
+
|
179
|
+
class View < SimpleConsole::View
|
180
|
+
|
181
|
+
|
182
|
+
def default
|
183
|
+
puts <<"END"
|
184
|
+
Usage:
|
185
|
+
|
186
|
+
rubysync command name [options]
|
187
|
+
|
188
|
+
Valid commands are:
|
189
|
+
* create {name}: Create a rubysync configuration directory
|
190
|
+
|
191
|
+
* connector {name} -t {type} [--vault {name}] [--client {name}]
|
192
|
+
; Create a connector of the given name in
|
193
|
+
; the current rubysync configuration directory
|
194
|
+
|
195
|
+
* fields {name} ; list the fields detected by the named connector
|
196
|
+
|
197
|
+
* pipeline {name} ; Create a rubysync pipeline of the given name
|
198
|
+
; in the current rubysync configuration directory
|
199
|
+
|
200
|
+
* once {name}
|
201
|
+
; Execute the named pipeline within the current
|
202
|
+
; configuration directory once and then exit
|
203
|
+
|
204
|
+
* example ; Show an example of how this command might be used
|
205
|
+
|
206
|
+
END
|
207
|
+
end
|
208
|
+
|
209
|
+
|
210
|
+
def example
|
211
|
+
puts <<"END"
|
212
|
+
This sets up the skeleton of a configuration for importing comma delimeted
|
213
|
+
text files into a database. Note, if the application happens to be a Rails
|
214
|
+
app then it can also export changes.
|
215
|
+
|
216
|
+
$ rubysync create db_demo
|
217
|
+
$ cd db_demo
|
218
|
+
$ rubysync connector my_csv -t csv_file
|
219
|
+
$ rubysync connector my_db -t active_record
|
220
|
+
|
221
|
+
You would then edit the files:
|
222
|
+
|
223
|
+
connectors/my_csv_connector.rb ;where to get CSV files, field names, etc
|
224
|
+
connectors/my_db_connector.rb ;how to connect to your DB or Rails app.
|
225
|
+
|
226
|
+
And enter:
|
227
|
+
$ rubysync pipeline my_pipeline -C my_csv -V my_db
|
228
|
+
|
229
|
+
You would then edit the file +pipelines/my_pipeline.rb+ to configure the
|
230
|
+
policy for synchronizing between the two connectors.
|
231
|
+
|
232
|
+
You may then execute the pipeline in one-shot mode (daemon mode is coming):
|
233
|
+
|
234
|
+
$ rubysync once my_pipeline
|
235
|
+
END
|
236
|
+
end
|
237
|
+
|
238
|
+
def fields
|
239
|
+
puts @field_names.join("\n")
|
240
|
+
end
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
def start
|
245
|
+
puts "Not yet implemented"
|
246
|
+
end
|
247
|
+
|
248
|
+
end
|
249
|
+
|
250
|
+
|
251
|
+
def connector_template name, type
|
252
|
+
type_class_name = "RubySync::Connectors::#{type.to_s.camelize}Connector"
|
253
|
+
type_class = eval(type_class_name)
|
254
|
+
sample_config = (type_class && type_class.respond_to?("sample_config")) ?
|
255
|
+
type_class.sample_config : ""
|
256
|
+
return <<-"end;"
|
257
|
+
class #{name.to_s.camelize}Connector < #{type_class_name}
|
258
|
+
#{sample_config}
|
259
|
+
end
|
260
|
+
end;
|
261
|
+
end
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
def pipeline_template name, vault_name, client_name
|
266
|
+
vault = (vault_name)? ::RubySync::Connectors::BaseConnector.class_for(vault_name) : nil
|
267
|
+
vault_fields = vault && vault.fields || %w{allow these fields through}
|
268
|
+
possible_fields = (vault_fields.map {|n| ":#{n}"}).join(", ")
|
269
|
+
|
270
|
+
client = (client_name)? ::RubySync::Connectors::BaseConnector.class_for(client_name) : nil
|
271
|
+
client_fields = client && client.fields || []
|
272
|
+
|
273
|
+
vault_specifier = (vault_name)? "vault :#{vault_name}" : "#vault :vault_connector_name"
|
274
|
+
client_specifier = (client_name)? "client :#{client_name}" : "#client :client_connector_name"
|
275
|
+
return <<-"end;"
|
276
|
+
class #{name.to_s.camelize}Pipeline < RubySync::Pipelines::BasePipeline
|
277
|
+
|
278
|
+
#{client_specifier}
|
279
|
+
|
280
|
+
#{vault_specifier}
|
281
|
+
|
282
|
+
# Remove any fields that you don't want to set in the client from the vault
|
283
|
+
allow_out #{possible_fields}
|
284
|
+
|
285
|
+
# Remove any fields that you don't want to set in the vault from the client
|
286
|
+
allow_in #{possible_fields}
|
287
|
+
|
288
|
+
# If the client and vault have different names for the same field, define the
|
289
|
+
# the mapping here. For example, if the vault has a field called "first name" and
|
290
|
+
# the client has a field called givenName you may put:
|
291
|
+
# 'first name' => 'givenName'
|
292
|
+
# separate each mapping with a comma.
|
293
|
+
# The following fields were detected on the client:
|
294
|
+
# #{(client_fields.map {|f| "'#{f}'"}).join(", ")}
|
295
|
+
map_vault_to_client(
|
296
|
+
#{(vault_fields.map {|f| "#'#{f}' => 'a_client_field'"}).join(",\n\t\t")}
|
297
|
+
)
|
298
|
+
|
299
|
+
# "in" means going from client to vault
|
300
|
+
#in_transform do
|
301
|
+
#end
|
302
|
+
|
303
|
+
# "out" means going from vault to client
|
304
|
+
#out_transform do
|
305
|
+
#end
|
306
|
+
|
307
|
+
end
|
308
|
+
end;
|
309
|
+
end
|
310
|
+
|
311
|
+
|
312
|
+
SimpleConsole::Application.run(ARGV, Controller, View)
|
@@ -0,0 +1,182 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application and persistence framework that includes everything
|
4
|
+
needed to create database-backed web-applications according to the
|
5
|
+
Model-View-Control pattern of separation. This pattern splits the view (also
|
6
|
+
called the presentation) into "dumb" templates that are primarily responsible
|
7
|
+
for inserting pre-built data in between HTML tags. The model contains the
|
8
|
+
"smart" domain objects (such as Account, Product, Person, Post) that holds all
|
9
|
+
the business logic and knows how to persist themselves to a database. The
|
10
|
+
controller handles the incoming requests (such as Save New Account, Update
|
11
|
+
Product, Show Post) by manipulating the model and directing data to the view.
|
12
|
+
|
13
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
14
|
+
layer entitled Active Record. This layer allows you to present the data from
|
15
|
+
database rows as objects and embellish these data objects with business logic
|
16
|
+
methods. You can read more about Active Record in
|
17
|
+
link:files/vendor/rails/activerecord/README.html.
|
18
|
+
|
19
|
+
The controller and view are handled by the Action Pack, which handles both
|
20
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
21
|
+
are bundled in a single package due to their heavy interdependence. This is
|
22
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
23
|
+
more separate. Each of these packages can be used independently outside of
|
24
|
+
Rails. You can read more about Action Pack in
|
25
|
+
link:files/vendor/rails/actionpack/README.html.
|
26
|
+
|
27
|
+
|
28
|
+
== Getting started
|
29
|
+
|
30
|
+
1. At the command prompt, start a new rails application using the rails command
|
31
|
+
and your application name. Ex: rails myapp
|
32
|
+
(If you've downloaded rails in a complete tgz or zip, this step is already done)
|
33
|
+
2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
|
34
|
+
3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
|
35
|
+
4. Follow the guidelines to start developing your application
|
36
|
+
|
37
|
+
|
38
|
+
== Web Servers
|
39
|
+
|
40
|
+
By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
|
41
|
+
Rails will use the WEBrick, the webserver that ships with Ruby. When you run script/server,
|
42
|
+
Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
|
43
|
+
that you can always get up and running quickly.
|
44
|
+
|
45
|
+
Mongrel is a Ruby-based webserver with a C-component (which requires compilation) that is
|
46
|
+
suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
|
47
|
+
getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
|
48
|
+
More info at: http://mongrel.rubyforge.org
|
49
|
+
|
50
|
+
If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
|
51
|
+
Mongrel and WEBrick and also suited for production use, but requires additional
|
52
|
+
installation and currently only works well on OS X/Unix (Windows users are encouraged
|
53
|
+
to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
|
54
|
+
http://www.lighttpd.net.
|
55
|
+
|
56
|
+
And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
|
57
|
+
web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
|
58
|
+
for production.
|
59
|
+
|
60
|
+
But of course its also possible to run Rails on any platform that supports FCGI.
|
61
|
+
Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
|
62
|
+
please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
|
63
|
+
|
64
|
+
|
65
|
+
== Debugging Rails
|
66
|
+
|
67
|
+
Have "tail -f" commands running on the server.log and development.log. Rails will
|
68
|
+
automatically display debugging and runtime information to these files. Debugging
|
69
|
+
info will also be shown in the browser on requests from 127.0.0.1.
|
70
|
+
|
71
|
+
|
72
|
+
== Breakpoints
|
73
|
+
|
74
|
+
Breakpoint support is available through the script/breakpointer client. This
|
75
|
+
means that you can break out of execution at any point in the code, investigate
|
76
|
+
and change the model, AND then resume execution! Example:
|
77
|
+
|
78
|
+
class WeblogController < ActionController::Base
|
79
|
+
def index
|
80
|
+
@posts = Post.find(:all)
|
81
|
+
breakpoint "Breaking out from the list"
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
So the controller will accept the action, run the first line, then present you
|
86
|
+
with a IRB prompt in the breakpointer window. Here you can do things like:
|
87
|
+
|
88
|
+
Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
|
89
|
+
|
90
|
+
>> @posts.inspect
|
91
|
+
=> "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
|
92
|
+
#<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
|
93
|
+
>> @posts.first.title = "hello from a breakpoint"
|
94
|
+
=> "hello from a breakpoint"
|
95
|
+
|
96
|
+
...and even better is that you can examine how your runtime objects actually work:
|
97
|
+
|
98
|
+
>> f = @posts.first
|
99
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
100
|
+
>> f.
|
101
|
+
Display all 152 possibilities? (y or n)
|
102
|
+
|
103
|
+
Finally, when you're ready to resume execution, you press CTRL-D
|
104
|
+
|
105
|
+
|
106
|
+
== Console
|
107
|
+
|
108
|
+
You can interact with the domain model by starting the console through <tt>script/console</tt>.
|
109
|
+
Here you'll have all parts of the application configured, just like it is when the
|
110
|
+
application is running. You can inspect domain models, change values, and save to the
|
111
|
+
database. Starting the script without arguments will launch it in the development environment.
|
112
|
+
Passing an argument will specify a different environment, like <tt>script/console production</tt>.
|
113
|
+
|
114
|
+
To reload your controllers and models after launching the console run <tt>reload!</tt>
|
115
|
+
|
116
|
+
To reload your controllers and models after launching the console run <tt>reload!</tt>
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
== Description of contents
|
121
|
+
|
122
|
+
app
|
123
|
+
Holds all the code that's specific to this particular application.
|
124
|
+
|
125
|
+
app/controllers
|
126
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
127
|
+
automated URL mapping. All controllers should descend from ApplicationController
|
128
|
+
which itself descends from ActionController::Base.
|
129
|
+
|
130
|
+
app/models
|
131
|
+
Holds models that should be named like post.rb.
|
132
|
+
Most models will descend from ActiveRecord::Base.
|
133
|
+
|
134
|
+
app/views
|
135
|
+
Holds the template files for the view that should be named like
|
136
|
+
weblogs/index.rhtml for the WeblogsController#index action. All views use eRuby
|
137
|
+
syntax.
|
138
|
+
|
139
|
+
app/views/layouts
|
140
|
+
Holds the template files for layouts to be used with views. This models the common
|
141
|
+
header/footer method of wrapping views. In your views, define a layout using the
|
142
|
+
<tt>layout :default</tt> and create a file named default.rhtml. Inside default.rhtml,
|
143
|
+
call <% yield %> to render the view using this layout.
|
144
|
+
|
145
|
+
app/helpers
|
146
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are generated
|
147
|
+
for you automatically when using script/generate for controllers. Helpers can be used to
|
148
|
+
wrap functionality for your views into methods.
|
149
|
+
|
150
|
+
config
|
151
|
+
Configuration files for the Rails environment, the routing map, the database, and other dependencies.
|
152
|
+
|
153
|
+
components
|
154
|
+
Self-contained mini-applications that can bundle together controllers, models, and views.
|
155
|
+
|
156
|
+
db
|
157
|
+
Contains the database schema in schema.rb. db/migrate contains all
|
158
|
+
the sequence of Migrations for your schema.
|
159
|
+
|
160
|
+
doc
|
161
|
+
This directory is where your application documentation will be stored when generated
|
162
|
+
using <tt>rake doc:app</tt>
|
163
|
+
|
164
|
+
lib
|
165
|
+
Application specific libraries. Basically, any kind of custom code that doesn't
|
166
|
+
belong under controllers, models, or helpers. This directory is in the load path.
|
167
|
+
|
168
|
+
public
|
169
|
+
The directory available for the web server. Contains subdirectories for images, stylesheets,
|
170
|
+
and javascripts. Also contains the dispatchers and the default HTML files. This should be
|
171
|
+
set as the DOCUMENT_ROOT of your web server.
|
172
|
+
|
173
|
+
script
|
174
|
+
Helper scripts for automation and generation.
|
175
|
+
|
176
|
+
test
|
177
|
+
Unit and functional tests along with fixtures. When using the script/generate scripts, template
|
178
|
+
test files will be generated for you and placed in this directory.
|
179
|
+
|
180
|
+
vendor
|
181
|
+
External libraries that the application depends on. Also includes the plugins subdirectory.
|
182
|
+
This directory is in the load path.
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
2
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
3
|
+
|
4
|
+
require(File.join(File.dirname(__FILE__), 'config', 'boot'))
|
5
|
+
|
6
|
+
require 'rake'
|
7
|
+
require 'rake/testtask'
|
8
|
+
require 'rake/rdoctask'
|
9
|
+
|
10
|
+
require 'tasks/rails'
|
@@ -0,0 +1,7 @@
|
|
1
|
+
# Filters added to this controller apply to all controllers in the application.
|
2
|
+
# Likewise, all the methods added will be available for all controllers.
|
3
|
+
|
4
|
+
class ApplicationController < ActionController::Base
|
5
|
+
# Pick a unique cookie name to distinguish our session data from others'
|
6
|
+
session :session_key => '_ar_client_webapp_session_id'
|
7
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# Don't change this file. Configuration is done in config/environment.rb and config/environments/*.rb
|
2
|
+
|
3
|
+
unless defined?(RAILS_ROOT)
|
4
|
+
root_path = File.join(File.dirname(__FILE__), '..')
|
5
|
+
|
6
|
+
unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
|
7
|
+
require 'pathname'
|
8
|
+
root_path = Pathname.new(root_path).cleanpath(true).to_s
|
9
|
+
end
|
10
|
+
|
11
|
+
RAILS_ROOT = root_path
|
12
|
+
end
|
13
|
+
|
14
|
+
unless defined?(Rails::Initializer)
|
15
|
+
if File.directory?("#{RAILS_ROOT}/vendor/rails")
|
16
|
+
require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
|
17
|
+
else
|
18
|
+
require 'rubygems'
|
19
|
+
|
20
|
+
environment_without_comments = IO.readlines(File.dirname(__FILE__) + '/environment.rb').reject { |l| l =~ /^#/ }.join
|
21
|
+
environment_without_comments =~ /[^#]RAILS_GEM_VERSION = '([\d.]+)'/
|
22
|
+
rails_gem_version = $1
|
23
|
+
|
24
|
+
if version = defined?(RAILS_GEM_VERSION) ? RAILS_GEM_VERSION : rails_gem_version
|
25
|
+
# Asking for 1.1.6 will give you 1.1.6.5206, if available -- makes it easier to use beta gems
|
26
|
+
rails_gem = Gem.cache.search('rails', "~>#{version}.0").sort_by { |g| g.version.version }.last
|
27
|
+
|
28
|
+
if rails_gem
|
29
|
+
gem "rails", "=#{rails_gem.version.version}"
|
30
|
+
require rails_gem.full_gem_path + '/lib/initializer'
|
31
|
+
else
|
32
|
+
STDERR.puts %(Cannot find gem for Rails ~>#{version}.0:
|
33
|
+
Install the missing gem with 'gem install -v=#{version} rails', or
|
34
|
+
change environment.rb to define RAILS_GEM_VERSION with your desired version.
|
35
|
+
)
|
36
|
+
exit 1
|
37
|
+
end
|
38
|
+
else
|
39
|
+
gem "rails"
|
40
|
+
require 'initializer'
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
Rails::Initializer.run(:set_load_path)
|
45
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# MySQL (default setup). Versions 4.1 and 5.0 are recommended.
|
2
|
+
#
|
3
|
+
# Install the MySQL driver:
|
4
|
+
# gem install mysql
|
5
|
+
# On MacOS X:
|
6
|
+
# gem install mysql -- --include=/usr/local/lib
|
7
|
+
# On Windows:
|
8
|
+
# gem install mysql
|
9
|
+
# Choose the win32 build.
|
10
|
+
# Install MySQL and put its /bin directory on your path.
|
11
|
+
#
|
12
|
+
# And be sure to use new-style password hashing:
|
13
|
+
# http://dev.mysql.com/doc/refman/5.0/en/old-client.html
|
14
|
+
development:
|
15
|
+
adapter: mysql
|
16
|
+
database: ar_client_webapp_development
|
17
|
+
username: root
|
18
|
+
password:
|
19
|
+
socket: /tmp/mysql.sock
|
20
|
+
|
21
|
+
# Warning: The database defined as 'test' will be erased and
|
22
|
+
# re-generated from your development database when you run 'rake'.
|
23
|
+
# Do not set this db to the same as development or production.
|
24
|
+
test:
|
25
|
+
adapter: mysql
|
26
|
+
database: ar_client_webapp_test
|
27
|
+
username: root
|
28
|
+
password:
|
29
|
+
socket: /tmp/mysql.sock
|
30
|
+
|
31
|
+
production:
|
32
|
+
adapter: mysql
|
33
|
+
database: ar_client_webapp_production
|
34
|
+
username: root
|
35
|
+
password:
|
36
|
+
socket: /tmp/mysql.sock
|
@@ -0,0 +1,60 @@
|
|
1
|
+
# Be sure to restart your web server when you modify this file.
|
2
|
+
|
3
|
+
# Uncomment below to force Rails into production mode when
|
4
|
+
# you don't control web/app server and can't set it the proper way
|
5
|
+
# ENV['RAILS_ENV'] ||= 'production'
|
6
|
+
|
7
|
+
# Specifies gem version of Rails to use when vendor/rails is not present
|
8
|
+
RAILS_GEM_VERSION = '1.2.3' unless defined? RAILS_GEM_VERSION
|
9
|
+
|
10
|
+
# Bootstrap the Rails environment, frameworks, and default configuration
|
11
|
+
require File.join(File.dirname(__FILE__), 'boot')
|
12
|
+
|
13
|
+
Rails::Initializer.run do |config|
|
14
|
+
# Settings in config/environments/* take precedence over those specified here
|
15
|
+
|
16
|
+
# Skip frameworks you're not going to use (only works if using vendor/rails)
|
17
|
+
# config.frameworks -= [ :action_web_service, :action_mailer ]
|
18
|
+
|
19
|
+
# Only load the plugins named here, by default all plugins in vendor/plugins are loaded
|
20
|
+
# config.plugins = %W( exception_notification ssl_requirement )
|
21
|
+
|
22
|
+
# Add additional load paths for your own custom dirs
|
23
|
+
# config.load_paths += %W( #{RAILS_ROOT}/extras )
|
24
|
+
|
25
|
+
# Force all environments to use the same logger level
|
26
|
+
# (by default production uses :info, the others :debug)
|
27
|
+
# config.log_level = :debug
|
28
|
+
|
29
|
+
# Use the database for sessions instead of the file system
|
30
|
+
# (create the session table with 'rake db:sessions:create')
|
31
|
+
# config.action_controller.session_store = :active_record_store
|
32
|
+
|
33
|
+
# Use SQL instead of Active Record's schema dumper when creating the test database.
|
34
|
+
# This is necessary if your schema can't be completely dumped by the schema dumper,
|
35
|
+
# like if you have constraints or database-specific column types
|
36
|
+
# config.active_record.schema_format = :sql
|
37
|
+
|
38
|
+
# Activate observers that should always be running
|
39
|
+
# config.active_record.observers = :cacher, :garbage_collector
|
40
|
+
|
41
|
+
# Make Active Record use UTC-base instead of local time
|
42
|
+
# config.active_record.default_timezone = :utc
|
43
|
+
|
44
|
+
# See Rails::Configuration for more options
|
45
|
+
end
|
46
|
+
|
47
|
+
# Add new inflection rules using the following format
|
48
|
+
# (all these examples are active by default):
|
49
|
+
# Inflector.inflections do |inflect|
|
50
|
+
# inflect.plural /^(ox)$/i, '\1en'
|
51
|
+
# inflect.singular /^(ox)en/i, '\1'
|
52
|
+
# inflect.irregular 'person', 'people'
|
53
|
+
# inflect.uncountable %w( fish sheep )
|
54
|
+
# end
|
55
|
+
|
56
|
+
# Add new mime types for use in respond_to blocks:
|
57
|
+
# Mime::Type.register "text/richtext", :rtf
|
58
|
+
# Mime::Type.register "application/x-mobile", :mobile
|
59
|
+
|
60
|
+
# Include your application configuration below
|