sync_client 0.0.14 → 0.1.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWFkZjA0MTY4NTkyNDdjMWJiYTQ0ZThjNjg5NzVmNzI5MDYyZmIxZg==
+  data.tar.gz: !binary |-
+    YWNjM2EzNzJhY2M3NDE4MmI5NDNkODljMzE2NzRmMjQ2MjQ3ODMxYw==
+SHA512:
+  metadata.gz: !binary |-
+    MjEzYjc0NjY1Yjc2M2VkMzkwNzUwYWNjNmI2MmNlNDZiNDJlMWQ3NmI2MDFh
+    NzQwMTJkZTUxN2ViMGE5NzQ3YzU2YmNkNmZkZWUzZDgwMDdjNzVlMjE0OGNm
+    ZjA4YzQ4MDJmZmY3MGUzMGNkNDQzYWM5MTY2YmU4Yjk0NmUwM2Q=
+  data.tar.gz: !binary |-
+    YjU3ZmNkMDc3MGE2YzAwZDNmZmQ0OTVjOTk5NjQ1MjBiYTRkZDk0MzcyNjM5
+    NDlkZDVmNWQ3NGQ5MjJlZmQyNTQyOGNlMDg3NDU1NWRkODFjYzE5MGQwNGM5
+    OThhNDhmYTliNDNiMmZmODE2YzAxMzU5ODYwN2Q5ZDc3NGNhYzg=

data/README.md

@@ -1,6 +1,9 @@
 # SyncClient
+[![Build Status][build_status_image]][build_status]
+[![Coverage Status][coverage_status_image]][coverage_status]
+
+This gem simplifies syncing data between services by using delayed job processing and a message queue for guaranteed delivery and eventual consistency. SyncClient defines messages based on a resource and action system to simplify message publishing and handling. It supports inline processing and delayed job processeding by Resque, DelayedJob, and Sidekiq. See [Queuel](https://rubygems.org/gems/sync_client) for a list of supported message queues.
 
-This gem simplifies syncing data between services by using a resque queue and a message queue for guaranteed delivery and eventual consistency of data.
 
 ## Installation
 
@@ -24,12 +27,35 @@ $ rails g sync_client:install
 
 Edit configuation in `config/initializers/sync_client.rb`
 
+## Configuration
+
+SyncClient requires that message queue creditials, a background task queue, and message handler definitions to be defined in the configuration file. Note that any message that does not match a defined handler is simply dropped from the queue.
+
+```ruby
+SyncClient.config do |config|
+
+  config.queuel do |c|
+    # c.default_queue 'VenueService'
+    # c.credentials token: [token], project_id: 'project_id'
+    # c.engine :iron_mq
+  end
+  # config.background_task_queue SyncClient::Resque #or SyncClient::DelayedJob or write your own.
+  # config.queue_suffix 'suffix'
+  # config.logger Logger.new
+  # config.add_message_handler object_name, handler_class, actions
+  # config.add_message_handler 'Service::Game', 'Service::Game', [:update, :create, :destroy]
+end
+```
+
+
 ## Usage
 
-Within the model you want to publish attributes to a service include something like the following:
+### Publisher
+
+SyncClient provides a simple interface to define what attributes to publish to a service for associated actions where the message class is the class of the resource. For models that inherit from `ActiveRecord::Base` or include `Mongoid::Document`, add the `SyncClient::Publisher` module and configure like the following:
 
 ```ruby
-class Team
+class Team < ActiveRecord::Base
   include SyncClient::Publisher
   publish_changes_of :name, :color, to: :queue, for: [:update, :destroy], if: lambda{|team| !team.name.nil?}
     # options:
@@ -39,8 +65,34 @@ class Team
 end
 ```
 
+If you are just working with a "Plain Old Ruby Object", you can do something
+like this:
+
+```ruby
+class TeamSchedulerService
+  include SyncClient::Publisher
+  publish_to :queue
+    # options:
+    #   for: callbacks for publishing (default: :sync)
+    #   if/unless: condition for publishing
+
+  def do_some_stuffs
+    # CODEZ
+    sync
+    # return value
+  end
+end
+```
+
+And then in a seperate method, you are able to call the `sync` method and fire
+the queue syncing yourself.
+
+The `sync` method is mapped to the `:sync` action in the ServiceResource by
+default, but `:create`, `:update` and `:destroy` are still available for you to
+use as well.
 
-A priority is used for publishing to ensure eventual delivery if the message queue does not respond. Supported priority queues include Delayed Job and Resque.
+
+### Poller
 
 Run the message queue poller:
 
@@ -51,30 +103,47 @@ $ bundle exec script/sync_client restart
 $ bundle exec script/sync_client stop
 ```
 
-Define handlers for the all messages such as the following:
-
-```ruby
-class Game < SyncClient::ServiceResource::Base
-  attr_accessor :id
-  attr_accessor :starts_at
-  attr_accessor :ends_at
 
-  def create
-    Game.create(:game_id => self.id, :starts_at => self.starts_at, :ends_at => self.ends_at)
-  end
+### Service Resource
 
-  def update
-    game = Game.find(self.id).first
-    game.update_attributes(:starts_at => self.starts_at, :ends_at => self.ends_at)
-  end
+Message handlers for the actions are then defined matching the handler class set in the configuration file where each method corresponds to the message action as follows:
 
-  def destroy
-    game = Game.find(self.id)
-    game.each do |ga|
-      ga.destroy
+```ruby
+module Service
+  class Game < SyncClient::ServiceResource::Base
+  
+    # Determine what attributes are to be accessible using attr_accessors
+    attr_accessor :id
+    attr_accessor :starts_at
+    attr_accessor :ends_at
+  
+    def create
+      Game.create(:game_id => self.id, :starts_at => self.starts_at, :ends_at =>  self.ends_at)
+    end
+  
+    def update
+      game = Game.find(self.id).first
+      game.update_attributes(:starts_at => self.starts_at, :ends_at => self.  ends_at)
+    end
+  
+    def destroy
+      game = Game.find(self.id)
+      game.destroy
     end
   end
 end
 ```
 
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sync_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[build_status]: https://travis-ci.org/sportngin/sync_client
+[build_status_image]: https://travis-ci.org/sportngin/sync_client.svg?branch=master
+[coverage_status]: https://coveralls.io/r/sportngin/sync_client
+[coverage_status_image]: https://img.shields.io/coveralls/sportngin/sync_client.svg
 

data/app/models/sync_client/pub_message.rb

@@ -1,5 +1,5 @@
 module SyncClient
-  class PubMessage < Message
+  class PubMessage < SyncClient::Message
 
     def publish
       SyncClient.background_task_queue.enqueue(Jobs::SyncClientJobs::Publish, self)

data/app/models/sync_client/service_resource/base.rb

@@ -22,6 +22,10 @@ module SyncClient
       def destroy
         raise NotImplementedError
       end
+
+      def sync
+        raise NotImplementedError
+      end
     end
   end
 end

data/app/models/sync_client/sub_message.rb

@@ -1,5 +1,5 @@
 module SyncClient
-  class SubMessage < Message
+  class SubMessage < SyncClient::Message
     attr_accessor :success
 
     def process
@@ -29,7 +29,7 @@ module SyncClient
 
     def with_logging(&block)
       SyncClient.logger.info("------------------------------------------")
-      SyncClient.logger.info("Recieved Message: #{object_type}##{action}")
+      SyncClient.logger.info("Received Message: #{object_type}##{action}")
       yield
       SyncClient.logger.info("Error Occured: #{error}") if error
       SyncClient.logger.info("Processed Message: #{!!success}")

data/lib/generators/templates/sync_client.rb

@@ -2,12 +2,12 @@ SyncClient.config do |config|
 
   config.queuel do |c|
     # c.default_queue 'VenueService'
-    # c.credentials token: 'asdufasdf8a7sd8fa7sdf', project_id: 'project_id'
+    # c.credentials token: [token], project_id: 'project_id'
     # c.engine :iron_mq
   end
   # config.background_task_queue SyncClient::Resque #or SyncClient::DelayedJob or write your own.
   # config.queue_suffix 'suffix'
   # config.logger Logger.new
-  # config.add_message_object_handler object_name, handler_class, actions
-  # config.add_message_object_handler 'StatNgin::Game', 'Resource::StatNgin::Game', [:update, :create, :destroy]
+  # config.add_message_handler object_name, handler_class, actions
+  # config.add_message_handler 'StatNgin::Game', 'Resource::StatNgin::Game', [:update, :create, :destroy]
 end

data/lib/sync_client/configurator.rb

@@ -1,6 +1,7 @@
 require 'sync_client/configurators/message_handlers'
 require 'sync_client/task_queue/delayed_job'
 require 'sync_client/task_queue/resque'
+require 'sync_client/task_queue/sidekiq'
 require 'sync_client/task_queue/inline_task_queue'
 
 module SyncClient

data/lib/sync_client/publisher/active_record_publisher.rb

@@ -0,0 +1,20 @@
+require 'sync_client/publisher/base_publisher'
+
+module SyncClient
+  module Publisher
+    module ActiveRecordPublisher
+      extend ActiveSupport::Concern
+      included do
+        include SyncClient::Publisher::BasePublisher
+      end
+
+      def any_attributes_changed?(attributes)
+        attributes.any?{|attr| send("#{attr}_changed?")}
+      end
+
+      def publisher_attributes
+        self.attributes
+      end
+    end
+  end
+end

data/lib/sync_client/publisher/base_publisher.rb

@@ -0,0 +1,39 @@
+module SyncClient
+  module Publisher
+    module BasePublisher
+      extend ActiveSupport::Concern
+
+      included do
+        after_create :publish_create
+        before_update :publish_update
+        after_destroy :publish_destroy
+      end
+
+      module ClassMethods
+        def publish_changes_of(*attributes, options)
+          @queue_publisher = SyncClient::QueuePublisher.new unless @queue_publisher
+          @queue_publisher.add_publisher(attributes, options)
+        end
+
+        attr_reader :queue_publisher
+      end
+
+      def queue_publisher
+        self.class.queue_publisher
+      end
+
+      def publish_create(options = {})
+        queue_publisher.publish(:create, self, options)
+      end
+
+      def publish_update(options = {})
+        queue_publisher.publish(:update, self, options)
+      end
+
+      def publish_destroy(options = {})
+        queue_publisher.publish(:destroy, self, options)
+      end
+    end
+  end
+end
+

data/lib/sync_client/publisher/mongoid_publisher.rb

@@ -0,0 +1,28 @@
+require 'sync_client/publisher/base_publisher'
+
+module SyncClient
+  module Publisher
+    module MongoidPublisher
+      extend ActiveSupport::Concern
+
+      included do
+        include SyncClient::Publisher::BasePublisher
+      end
+
+      def any_attributes_changed?(attributes)
+        attributes.any?{|attr| send("#{attr}_changed?")}
+      end
+
+      def publisher_attributes
+        self.attributes.inject({}) { |attrs, (raw_key, raw_value)|
+          if raw_key =='_id'
+            attrs['id'] = raw_value
+          else
+            attrs[self.aliased_fields.invert.fetch(raw_key) { raw_key }] = raw_value
+          end
+          attrs
+        }
+      end
+    end
+  end
+end

data/lib/sync_client/publisher/poro_publisher.rb

@@ -0,0 +1,33 @@
+module SyncClient
+  module Publisher
+    module PoroPublisher
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def publish_to(*args)
+          @queue_publisher ||= SyncClient::QueuePublisher.new
+          options = args.last.is_a?(Hash) ? args.pop : {:for => :sync}
+          args.each do |end_point|
+            @queue_publisher.add_publisher([], options.merge(:to => end_point))
+          end
+        end
+
+        attr_reader :queue_publisher
+      end
+
+      def queue_publisher
+        self.class.queue_publisher
+      end
+
+      def sync(action=:sync)
+        queue_publisher.publish(action, self)
+      end
+
+      def publisher_attributes
+        instance_variable_names.inject({}) do |result, var|
+          result.merge Hash[var.gsub('@', ''), instance_variable_get(var)]
+        end
+      end
+    end
+  end
+end

data/lib/sync_client/publisher.rb

@@ -1,50 +1,18 @@
+require 'sync_client/publisher/active_record_publisher'
+require 'sync_client/publisher/mongoid_publisher'
+require 'sync_client/publisher/poro_publisher'
+
 module SyncClient
   module Publisher
     extend ActiveSupport::Concern
 
     included do
-      before_update :publish_update
-      after_destroy :publish_destroy
-      after_create :publish_create
-    end
-
-    module ClassMethods
-      def publish_changes_of(*attributes, options)
-        @queue_publisher = SyncClient::QueuePublisher.new unless @queue_publisher
-        @queue_publisher.add_publisher(attributes, options)
-      end
-
-      attr_reader :queue_publisher
-    end
-
-    def queue_publisher
-      self.class.queue_publisher
-    end
-
-    def publish_update
-      queue_publisher.publish(:update, self)
-    end
-
-    def publish_destroy
-      queue_publisher.publish(:destroy, self)
-    end
-
-    def publish_create
-      queue_publisher.publish(:create, self)
-    end
-
-    def publisher_attributes
-      if self.respond_to?(:aliased_fields)
-        self.attributes.inject({}) { |attrs, (raw_key, raw_value)|
-          if raw_key =='_id'
-            attrs['id'] = raw_value
-          else
-            attrs[self.aliased_fields.invert.fetch(raw_key) { raw_key }] = raw_value
-          end
-          attrs
-        }
+      if defined?(::ActiveRecord::Base) && self <= ::ActiveRecord::Base
+        include SyncClient::Publisher::ActiveRecordPublisher
+      elsif defined?(::Mongoid::Document) && self.included_modules.include?(::Mongoid::Document)
+        include SyncClient::Publisher::MongoidPublisher
       else
-        self.attributes
+        include SyncClient::Publisher::PoroPublisher
       end
     end
   end

data/lib/sync_client/queue_publisher.rb

@@ -10,10 +10,10 @@ module SyncClient
       self.sync_queues << SyncClient::SyncQueue.new(attributes, options)
     end
 
-    def publish(action, object)
+    def publish(action, object, options = {})
       sync_queues.each do |sync_queue|
         SyncClient.logger.info("#{sync_queue.inspect}")
-        queue_message(action, object, sync_queue.queue).publish if sync_queue.publishable?(action, object)
+        queue_message(action, object, sync_queue.queue).publish if options[:force] || sync_queue.publishable?(action, object)
       end
     end
 

data/lib/sync_client/sync_queue.rb

@@ -10,7 +10,7 @@ module SyncClient
     def initialize(attributes, options)
       @attributes = attributes
       @queue = options[:to]
-      @callbacks = options[:for] || CALLBACK_DEFAULTS
+      @callbacks = options[:for] ? Array(options[:for]) : CALLBACK_DEFAULTS
       @options = options
     end
 
@@ -19,7 +19,7 @@ module SyncClient
     end
 
     def update?(action, object)
-      action.to_s != 'update' || attributes.any?{|attr| object.send("#{attr}_changed?")}
+      action.to_s != 'update' || object.any_attributes_changed?(attributes)
     end
 
     def resolve_condition(object)

data/lib/sync_client/task_queue/sidekiq.rb

@@ -0,0 +1,7 @@
+module SyncClient
+  class Sidekiq
+    def self.enqueue(job, message)
+      ::Sidekiq::Client.enqueue(job, message)
+    end
+  end
+end

data/lib/sync_client/version.rb

@@ -1,3 +1,3 @@
 module SyncClient
-  VERSION = "0.0.14"
+  VERSION = "0.1.7"
 end

data/test/dummy/app/models/stat.rb

@@ -0,0 +1,11 @@
+require 'mongoid'
+
+class Stat
+  include ::Mongoid::Document
+  include SyncClient::Publisher
+
+  publish_changes_of :values, :to => :test
+
+  field :pid, :as => :player_id
+  field :values, :type => Hash
+end

data/test/dummy/app/services/game_publisher.rb

@@ -0,0 +1,6 @@
+class GamePublisher
+  include SyncClient::Publisher
+
+  attr_reader :game_id, :result
+  attr_accessor :score
+end

data/test/dummy/config/initializers/sync_client.rb

@@ -2,13 +2,13 @@ SyncClient.config do |config|
 
   config.queuel do |c|
     c.default_queue 'Dummy'
-    # c.credentials token: 'asdufasdf8a7sd8fa7sdf', project_id: 'project_id'
+    c.credentials token: '', project_id: ''
     # c.engine :iron_mq
   end
   config.background_task_queue SyncClient::InlineTaskQueue
   config.queue_suffix ''
   config.logger Logger.new(STDOUT)
-  
-  # config.add_message_object_handler object_name, handler_class, actions
+
+  # config.add_message_handler object_name, handler_class, actions
   config.add_message_handler 'Dummy::Game', 'Game', [:update, :create, :destroy]
 end