sync_client 0.0.14

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. data/README.md +80 -0
  2. data/Rakefile +27 -0
  3. data/app/models/jobs/sync_client_jobs/publish.rb +12 -0
  4. data/app/models/sync_client/message.rb +15 -0
  5. data/app/models/sync_client/pub_message.rb +34 -0
  6. data/app/models/sync_client/service_resource/base.rb +27 -0
  7. data/app/models/sync_client/sub_message.rb +38 -0
  8. data/lib/generators/sync_client/install_generator.rb +24 -0
  9. data/lib/generators/templates/script +8 -0
  10. data/lib/generators/templates/sync_client.rb +13 -0
  11. data/lib/sync_client.rb +46 -0
  12. data/lib/sync_client/configurations/message_handler.rb +15 -0
  13. data/lib/sync_client/configurator.rb +53 -0
  14. data/lib/sync_client/configurators/message_handlers.rb +15 -0
  15. data/lib/sync_client/engine.rb +13 -0
  16. data/lib/sync_client/poller.rb +12 -0
  17. data/lib/sync_client/publisher.rb +52 -0
  18. data/lib/sync_client/queue_publisher.rb +28 -0
  19. data/lib/sync_client/sync_queue.rb +32 -0
  20. data/lib/sync_client/task_queue/delayed_job.rb +7 -0
  21. data/lib/sync_client/task_queue/inline_task_queue.rb +7 -0
  22. data/lib/sync_client/task_queue/resque.rb +7 -0
  23. data/lib/sync_client/tasks.rb +9 -0
  24. data/lib/sync_client/version.rb +3 -0
  25. data/lib/sync_client/worker.rb +15 -0
  26. data/test/app/pub_message_test.rb +33 -0
  27. data/test/app/service_resource/base_test.rb +18 -0
  28. data/test/app/sub_message_test.rb +42 -0
  29. data/test/dummy/README.rdoc +261 -0
  30. data/test/dummy/Rakefile +7 -0
  31. data/test/dummy/app/assets/javascripts/application.js +15 -0
  32. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  33. data/test/dummy/app/controllers/application_controller.rb +3 -0
  34. data/test/dummy/app/helpers/application_helper.rb +2 -0
  35. data/test/dummy/app/models/game.rb +17 -0
  36. data/test/dummy/app/models/player.rb +8 -0
  37. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  38. data/test/dummy/config.ru +4 -0
  39. data/test/dummy/config/application.rb +61 -0
  40. data/test/dummy/config/boot.rb +10 -0
  41. data/test/dummy/config/database.yml +25 -0
  42. data/test/dummy/config/environment.rb +5 -0
  43. data/test/dummy/config/environments/test.rb +37 -0
  44. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  45. data/test/dummy/config/initializers/inflections.rb +15 -0
  46. data/test/dummy/config/initializers/mime_types.rb +5 -0
  47. data/test/dummy/config/initializers/secret_token.rb +7 -0
  48. data/test/dummy/config/initializers/session_store.rb +8 -0
  49. data/test/dummy/config/initializers/sync_client.rb +14 -0
  50. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  51. data/test/dummy/config/locales/en.yml +5 -0
  52. data/test/dummy/config/routes.rb +58 -0
  53. data/test/dummy/lib/tasks/sync_client.rake +5 -0
  54. data/test/dummy/public/404.html +26 -0
  55. data/test/dummy/public/422.html +26 -0
  56. data/test/dummy/public/500.html +25 -0
  57. data/test/dummy/public/favicon.ico +0 -0
  58. data/test/dummy/script/rails +6 -0
  59. data/test/dummy/script/sync_client +8 -0
  60. data/test/lib/configurator_test.rb +14 -0
  61. data/test/lib/publisher_test.rb +43 -0
  62. data/test/lib/queue_publisher_test.rb +34 -0
  63. data/test/lib/sync_queue_test.rb +60 -0
  64. data/test/sync_client_test.rb +12 -0
  65. data/test/test_helper.rb +39 -0
  66. metadata +335 -0
@@ -0,0 +1,12 @@
1
+ module SyncClient
2
+ class Poller
3
+
4
+ def self.run
5
+ new.run
6
+ end
7
+
8
+ def run
9
+ SyncClient::Worker.new.work
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,52 @@
1
+ module SyncClient
2
+ module Publisher
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+ before_update :publish_update
7
+ after_destroy :publish_destroy
8
+ after_create :publish_create
9
+ end
10
+
11
+ module ClassMethods
12
+ def publish_changes_of(*attributes, options)
13
+ @queue_publisher = SyncClient::QueuePublisher.new unless @queue_publisher
14
+ @queue_publisher.add_publisher(attributes, options)
15
+ end
16
+
17
+ attr_reader :queue_publisher
18
+ end
19
+
20
+ def queue_publisher
21
+ self.class.queue_publisher
22
+ end
23
+
24
+ def publish_update
25
+ queue_publisher.publish(:update, self)
26
+ end
27
+
28
+ def publish_destroy
29
+ queue_publisher.publish(:destroy, self)
30
+ end
31
+
32
+ def publish_create
33
+ queue_publisher.publish(:create, self)
34
+ end
35
+
36
+ def publisher_attributes
37
+ if self.respond_to?(:aliased_fields)
38
+ self.attributes.inject({}) { |attrs, (raw_key, raw_value)|
39
+ if raw_key =='_id'
40
+ attrs['id'] = raw_value
41
+ else
42
+ attrs[self.aliased_fields.invert.fetch(raw_key) { raw_key }] = raw_value
43
+ end
44
+ attrs
45
+ }
46
+ else
47
+ self.attributes
48
+ end
49
+ end
50
+ end
51
+ end
52
+
@@ -0,0 +1,28 @@
1
+ module SyncClient
2
+ class QueuePublisher
3
+ attr_accessor :sync_queues
4
+
5
+ def initialize
6
+ self.sync_queues = []
7
+ end
8
+
9
+ def add_publisher(attributes, options)
10
+ self.sync_queues << SyncClient::SyncQueue.new(attributes, options)
11
+ end
12
+
13
+ def publish(action, object)
14
+ sync_queues.each do |sync_queue|
15
+ SyncClient.logger.info("#{sync_queue.inspect}")
16
+ queue_message(action, object, sync_queue.queue).publish if sync_queue.publishable?(action, object)
17
+ end
18
+ end
19
+
20
+ def queue_message(action, object, queue)
21
+ SyncClient::PubMessage.new(
22
+ :queue => queue,
23
+ :action => action,
24
+ :object_type => object.class.to_s,
25
+ :object_attributes => object.publisher_attributes)
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,32 @@
1
+ module SyncClient
2
+ class SyncQueue
3
+ attr_accessor :attributes
4
+ attr_accessor :queue
5
+ attr_accessor :callbacks
6
+ attr_accessor :options
7
+
8
+ CALLBACK_DEFAULTS = [:update, :create, :destroy]
9
+
10
+ def initialize(attributes, options)
11
+ @attributes = attributes
12
+ @queue = options[:to]
13
+ @callbacks = options[:for] || CALLBACK_DEFAULTS
14
+ @options = options
15
+ end
16
+
17
+ def publishable?(action, object)
18
+ callbacks.include?(action) and update?(action, object) and resolve_condition(object)
19
+ end
20
+
21
+ def update?(action, object)
22
+ action.to_s != 'update' || attributes.any?{|attr| object.send("#{attr}_changed?")}
23
+ end
24
+
25
+ def resolve_condition(object)
26
+ return true if options[:if].nil? && options[:unless].nil?
27
+ result = options[:if] == true || (options[:if].respond_to?(:call) && options[:if].call(object)) if options.has_key?(:if)
28
+ result = options[:unless] == false || (options[:unless].respond_to?(:call) && !options[:unless].call(object)) if options.has_key?(:unless)
29
+ result
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,7 @@
1
+ module SyncClient
2
+ class DelayedJob
3
+ def self.enqueue(job, message)
4
+ job.delay.perform(message.instance_values)
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,7 @@
1
+ module SyncClient
2
+ class InlineTaskQueue
3
+ def self.enqueue(job, message)
4
+ job.perform(message.instance_values)
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,7 @@
1
+ module SyncClient
2
+ class Resque
3
+ def self.enqueue(job, message)
4
+ ::Resque.enqueue(job, message)
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,9 @@
1
+ require 'queuel'
2
+ namespace :sync_client do
3
+ task :setup
4
+
5
+ desc "Start a queue poller"
6
+ task :poll => :setup do
7
+ SyncClient::Worker.new.work
8
+ end
9
+ end
@@ -0,0 +1,3 @@
1
+ module SyncClient
2
+ VERSION = "0.0.14"
3
+ end
@@ -0,0 +1,15 @@
1
+ module SyncClient
2
+ class Worker
3
+ def work
4
+ puts "starting queuel worker"
5
+ ::Queuel.receive do |message|
6
+ begin
7
+ SyncClient::SubMessage.new(message.body).process if message and message.body
8
+ rescue Exception => e
9
+ SyncClient.logger.error("Exception Occurred:\n\t#{e.message}\n\t#{e.backtrace}")
10
+ false
11
+ end
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,33 @@
1
+ require 'test_helper'
2
+
3
+ class PubMessageTest < ActiveSupport::TestCase
4
+ context "PubMessage" do
5
+ context "ClassMethods" do
6
+ setup do
7
+ @player = Player.create(:name => 'joe')
8
+ queue_publisher = SyncClient::QueuePublisher.new
9
+ @message = queue_publisher.queue_message(:action, @player, 'dummy')
10
+ end
11
+
12
+ should "queue publish" do
13
+ SyncClient.background_task_queue.expects(:enqueue).with(Jobs::SyncClientJobs::Publish, @message).returns(true)
14
+ @message.publish
15
+ end
16
+
17
+ should "copy object queues" do
18
+ assert_not_nil @message.queue
19
+ end
20
+
21
+ should "wrap object type with service" do
22
+ assert_equal "Dummy::Player", @message.object_type_with_service
23
+ end
24
+
25
+ should "push message to queues" do
26
+ queuel = Queuel.with(@message.queue)
27
+ Queuel.expects(:with).with(@message.queue).once.returns(queuel)
28
+ @message.synchronous_publish
29
+ end
30
+
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,18 @@
1
+ require 'test_helper'
2
+
3
+ class BaseTest < ActiveSupport::TestCase
4
+ context "Base" do
5
+ context "ClassMethods" do
6
+ setup do
7
+ @game = Game.new(:name => 'game', :id => 1, :invalid => 'sdfas')
8
+ end
9
+
10
+ should "respond to meta_resource_name with defined resource" do
11
+ assert_equal 'game', @game.name
12
+ assert_equal 1, @game.id
13
+ assert_equal false, @game.respond_to?(:invalid)
14
+ end
15
+
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,42 @@
1
+ require 'test_helper'
2
+
3
+ class SubMessageTest < ActiveSupport::TestCase
4
+ context "SubMessage" do
5
+ context "ClassMethods" do
6
+ setup do
7
+ @message = ::SyncClient::SubMessage.new(
8
+ :object_type => 'Dummy::Game',
9
+ :object_attributes => {:id => 1, :name => 'game', :invalid => 'invalid'},
10
+ :action => :update)
11
+
12
+ @message.stubs(:handler).with
13
+ end
14
+
15
+ should "send action to valid message" do
16
+ assert_equal true, @message.process
17
+ end
18
+
19
+ should "skip message object " do
20
+ @message.object_type = 'invalid'
21
+ assert_equal true, @message.process
22
+ end
23
+
24
+ should "skip message action" do
25
+ @message.action = 'invalid'
26
+ assert_equal true, @message.process
27
+ end
28
+
29
+ should "create message_handler with attributes" do
30
+ assert_equal Game, @message.handler_class.handler
31
+ assert_equal [:update, :create, :destroy], @message.handler_class.actions
32
+ end
33
+
34
+ should "access errors if set" do
35
+ @message.action = 'destroy'
36
+ assert_equal true, @message.process
37
+ assert_not_nil @message.error
38
+ end
39
+
40
+ end
41
+ end
42
+ 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
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
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.