pub_sub_model_sync 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0738657d975fdfaa12d2f28bfa942674faacd737e9be11435718204d3d90f3b
-  data.tar.gz: 234400d0857ad54f4498d531db75557e641b08dc3d237c37122cad07ecfa4d92
+  metadata.gz: 2c8298056c5729688a7abf53b29dbc2f9b97e2afec85d9db7a452819d60ab566
+  data.tar.gz: 44f820404c84f8b05af73e1a2a2c43417573f5145f6ecd4baa90e0c6534f8951
 SHA512:
-  metadata.gz: 92a83128b548aa1b0b495ad0c67617d30c62b4566e154609009b089d136d439e40b8a0d0c7fe8b48a13aa940f232129eca5c3c20bec4f3d3288411a4757d6ca3
-  data.tar.gz: 319cc08d44633713db44eae121fda9187536f4b34abdfa8a030fa519f6e48b9aa2bf9c43542b02c133eb095e95a42b03e9d8fd5b62100ee063264fecbb13c5b8
+  metadata.gz: 2edb2d736c84636863e6ab47141c5d8122be6ef105b3ca502e373bbf0b7f22aa41a0561731ee50de1ddc7c566c8bc51873a85c30112b7cbd170abdaf91c4e22a
+  data.tar.gz: 8e2ccf24555c630299a1ca751ec060a89aabe4af2610b4ef4213873d67a7ae19060fb5c0e00921e60a91f5268bde68ccd5848eae35151c6fa44523ab202c50c1

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+# 0.1.1
+- Add rabbitmq pub/sub service support
+- Reformat to support multiple pub/sub services
+
+# 0.1.0
+- Google pub/sub support

data/Gemfile

@@ -1,6 +1,8 @@
 source "https://rubygems.org"
 
-gem 'rubocop', '~> 0.80.1', require: false
+gem 'rubocop'
+gem 'bunny' # rabbit-mq
+gem 'google-cloud-pubsub' # google pub/sub
 
 # Specify your gem's dependencies in pub_sub_model_sync.gemspec
 gemspec

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (0.1.0)
+    pub_sub_model_sync (0.1.1)
       activesupport
-      google-cloud-pubsub
       rails
 
 GEM
@@ -52,9 +51,12 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    amq-protocol (2.3.0)
     arel (9.0.0)
     ast (2.4.0)
     builder (3.2.4)
+    bunny (2.14.3)
+      amq-protocol (~> 2.3, >= 2.3.0)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     diff-lcs (1.3)
@@ -79,7 +81,7 @@ GEM
       googleauth (>= 0.6.2, < 0.10.0)
       grpc (>= 1.7.2, < 2.0)
       rly (~> 0.2.3)
-    google-protobuf (3.11.4)
+    google-protobuf (3.11.4-universal-darwin)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -93,7 +95,7 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.7)
-    grpc (1.27.0)
+    grpc (1.27.0-universal-darwin)
       google-protobuf (~> 3.11)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.9)
@@ -206,10 +208,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  bunny
+  google-cloud-pubsub
   pub_sub_model_sync!
   rake
   rspec
-  rubocop (~> 0.80.1)
+  rubocop
   sqlite3
 
 BUNDLED WITH

data/README.md

@@ -1,40 +1,55 @@
 # PubSubModelSync
-Permit to sync models between rails apps through google (Proximately RabbitMQ) pub/sub service. 
+Permit to sync models data and make calls between rails apps using google or rabbitmq pub/sub service. 
+
 Note: This gem is based on [MultipleMan](https://github.com/influitive/multiple_man) which for now looks unmaintained.
 
-# Features
-- Sync CRUD operation between Rails apps. So, all changes made on App1, will be reflected on App2.
+## Features
+- Sync CRUD operations between Rails apps. So, all changes made on App1, will be reflected on App2, App3.
     Example: If User is created on App1, this user will be created on App2 too with the accepted attributes.
-- Ability to make class level communication 
-    Example: If User from App1 wants to generate_email, this can be listened on App2 to make corresponding actions
+- Ability to make class level communication
+    Example: If User from App1 wants to generate_email, this can be listened on App2, App3, ... to make corresponding actions
+- Change pub/sub service at any time
 
 ## Installation
 Add this line to your application's Gemfile:
 ```ruby
 gem 'pub_sub_model_sync'
+gem 'google-cloud-pubsub' # to use google pub/sub service
+gem 'bunny' # to use rabbit-mq pub/sub service
 ```
 And then execute: $ bundle install
 
 
 ## Usage
 
-- Configure pub/sub service (Google pub/sub)
+- Configuration for google pub/sub (You need google pub/sub service account)
     ```ruby
-        # initializers/pub_sub_config.rb
-        PubSubModelSync::Config.project = ''
-        PubSubModelSync::Config.credentials = ''
-        PubSubModelSync::Config.topic_name = ''
-        PubSubModelSync::Config.subscription_name = ''
+    # initializers/pub_sub_config.rb
+    PubSubModelSync::Config.service_name = :google 
+    PubSubModelSync::Config.project = 'project-id'
+    PubSubModelSync::Config.credentials = 'path-to-the-config'
+    PubSubModelSync::Config.topic_name = 'sample-topic'
+    PubSubModelSync::Config.subscription_name = 'p1-subscriber'
     ```
     See details here:
     https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-pubsub
 
+- configuration for RabbitMq (You need rabbitmq installed)
+    ```ruby
+    PubSubModelSync::Config.service_name = :rabbitmq
+    PubSubModelSync::Config.bunny_connection = 'amqp://guest:guest@localhost'
+    PubSubModelSync::Config.queue_name = ''
+    PubSubModelSync::Config.topic_name = 'sample-topic'
+    ```
+    See details here: https://github.com/ruby-amqp/bunny
+
 - Add publishers/subscribers to your models (See examples below)
 
-- Start listening for publishers (Only if the app has subscribers)
+- Start listening for publishers (Only in the app that has subscribers)
     ```ruby
     rake pub_sub_model_sync:start
     ```
+    Note: Publishers do not need todo this
 
 ## Examples
 ```ruby
@@ -88,15 +103,23 @@ end
 ```
 
 ## Testing
-- Rspec:
+- Rspec: (spec/rails_helper.rb)
     ```ruby
-      # mock google service
-      # rails_helper.rb
+      
+      # when using google service
       require 'pub_sub_model_sync/mock_google_service'
       config.before(:each) do
         pub_sub_mock = PubSubModelSync::MockGoogleService.new
         allow(Google::Cloud::Pubsub).to receive(:new).and_return(pub_sub_mock)
       end
+      
+      # when using rabbitmq service
+      require 'pub_sub_model_sync/mock_rabbit_service' 
+      config.before(:each) do
+        bunny_mock = PubSubModelSync::MockRabbitService.new
+        allow(Bunny).to receive(:new).and_return(bunny_mock)
+      end
+  
     ```
 - Examples:
     ```ruby
@@ -138,7 +161,7 @@ end
     end
     ```
     
-    There are two special methods to extract configured crud settings (attrs, id, ...):
+    There are two special methods to extract crud configuration settings (attrs, id, ...):
     
     Subscribers: ```User.ps_msync_subscriber_settings```
     
@@ -149,7 +172,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pub_sub_model_sync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/owen2345/pub_sub_model_sync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/pub_sub_model_sync.rb

@@ -11,6 +11,8 @@ require 'pub_sub_model_sync/publisher_concern'
 require 'pub_sub_model_sync/runner'
 require 'pub_sub_model_sync/connector'
 require 'pub_sub_model_sync/message_processor'
+require 'pub_sub_model_sync/service_google'
+require 'pub_sub_model_sync/service_rabbit'
 
 module PubSubModelSync
   class Error < StandardError; end

data/lib/pub_sub_model_sync/config.rb

@@ -3,8 +3,15 @@
 module PubSubModelSync
   class Config
     cattr_accessor :listeners, default: []
-    cattr_accessor :project, :credentials, :topic_name, :subscription_name
+    cattr_accessor :service_name, default: :google
     cattr_accessor :logger
+
+    # google service
+    cattr_accessor :project, :credentials, :topic_name, :subscription_name
+
+    # rabbitmq service
+    cattr_accessor :bunny_connection, :queue_name, :topic_name
+
     def self.log(msg, kind = :info)
       msg = "PS_MSYNC ==> #{msg}"
       logger ? logger.send(kind, msg) : puts(msg)

data/lib/pub_sub_model_sync/connector.rb

@@ -3,55 +3,22 @@
 require 'google/cloud/pubsub'
 module PubSubModelSync
   class Connector
-    attr_accessor :service, :topic, :subscription, :config, :subscriber
+    attr_accessor :service
+    delegate :listen_messages, :publish, :stop, to: :service
 
     def initialize
-      @config = PubSubModelSync::Config
-      @service = Google::Cloud::Pubsub.new(project: config.project,
-                                           credentials: config.credentials)
-      @topic = service.topic(config.topic_name) ||
-               service.create_topic(config.topic_name)
-    end
-
-    def listen_messages
-      @subscription = subscribe_to_topic
-      @subscriber = subscription.listen(&method(:process_message))
-      log('Listener starting...')
-      subscriber.start
-      log('Listener started')
-      sleep
-      subscriber.stop.wait!
-      log('Listener stopped')
-    end
-
-    def stop
-      log('Listener stopping...')
-      subscriber.stop!
+      @service = build_service
     end
 
     private
 
-    def subscribe_to_topic
-      topic.subscription(config.subscription_name) ||
-        topic.subscribe(config.subscription_name)
-    end
-
-    def process_message(received_message)
-      message = received_message.message
-      attrs = message.attributes.symbolize_keys
-      return unless attrs[:service_model_sync]
-
-      data = JSON.parse(message.data).symbolize_keys
-      args = [data, attrs[:klass], attrs[:action], attrs]
-      PubSubModelSync::MessageProcessor.new(*args).process
-    rescue => e
-      log("Error processing message: #{[received_message, e.message]}")
-    ensure
-      received_message.acknowledge!
-    end
-
-    def log(msg)
-      config.log(msg)
+    def build_service
+      case Config.service_name
+      when :google
+        PubSubModelSync::ServiceGoogle.new
+      else # :rabbit_mq
+        PubSubModelSync::ServiceRabbit.new
+      end
     end
   end
 end

data/lib/pub_sub_model_sync/mock_google_service.rb

@@ -7,6 +7,7 @@ module PubSubModelSync
         true
       end
     end
+
     class MockSubscriber
       def start
         true
@@ -15,12 +16,15 @@ module PubSubModelSync
       def stop
         @stop ||= MockStop.new
       end
+      alias stop! stop
     end
+
     class MockSubscription
       def listen(*_args)
         @listen ||= MockSubscriber.new
       end
     end
+
     class MockTopic
       def subscription(*_args)
         @subscription ||= MockSubscription.new
@@ -31,6 +35,7 @@ module PubSubModelSync
         true
       end
     end
+
     def topic(*_args)
       @topic ||= MockTopic.new
     end

data/lib/pub_sub_model_sync/mock_rabbit_service.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PubSubModelSync
+  class MockRabbitService
+    class MockTopic
+      def publish(*_args)
+        true
+      end
+    end
+
+    class MockQueue
+      def bind(*_args)
+        true
+      end
+
+      def subscribe(*_args)
+        true
+      end
+
+      def name
+        'name'
+      end
+    end
+
+    class MockChannel
+      def queue(*_args)
+        @queue ||= MockQueue.new
+      end
+
+      def topic(*_args)
+        @topic ||= MockTopic.new
+      end
+    end
+
+    def create_channel(*_args)
+      @create_channel ||= MockChannel.new
+    end
+    alias channel create_channel
+
+    def start
+      true
+    end
+
+    def close
+      true
+    end
+  end
+end

data/lib/pub_sub_model_sync/publisher.rb

@@ -9,7 +9,7 @@ module PubSubModelSync
 
     def publish_data(klass, data, action)
       attributes = self.class.build_attrs(klass, action)
-      publish(data, attributes)
+      connector.publish(data, attributes)
     end
 
     # @param settings (Hash): { attrs: [], as_klass: nil, id: nil }
@@ -20,7 +20,7 @@ module PubSubModelSync
       if action != 'destroy'
         data = model.as_json(only: settings[:attrs], methods: settings[:attrs])
       end
-      publish(data.symbolize_keys, attributes)
+      connector.publish(data.symbolize_keys, attributes)
     end
 
     def self.build_attrs(klass, action, id = nil)
@@ -34,11 +34,6 @@ module PubSubModelSync
 
     private
 
-    def publish(data, attributes)
-      log("Publishing: #{[data, attributes]}")
-      connector.topic.publish(data.to_json, attributes)
-    end
-
     def build_model_attrs(model, action, settings)
       as_klass = (settings[:as_klass] || model.class.name).to_s
       id_val = model.send(settings[:id] || :id)

data/lib/pub_sub_model_sync/runner.rb

@@ -6,6 +6,10 @@ module PubSubModelSync
     class ShutDown < StandardError; end
     attr_accessor :connector
 
+    def initialize
+      @connector = PubSubModelSync::Connector.new
+    end
+
     def run
       trap_signals!
       preload_framework!
@@ -17,7 +21,6 @@ module PubSubModelSync
     private
 
     def start_listeners
-      @connector = PubSubModelSync::Connector.new
       connector.listen_messages
     end
 

data/lib/pub_sub_model_sync/service_google.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'google/cloud/pubsub'
+module PubSubModelSync
+  class ServiceGoogle
+    attr_accessor :service, :topic, :subscription, :config, :subscriber
+
+    def initialize
+      @config = PubSubModelSync::Config
+      @service = Google::Cloud::Pubsub.new(project: config.project,
+                                           credentials: config.credentials)
+      @topic = service.topic(config.topic_name) ||
+               service.create_topic(config.topic_name)
+    end
+
+    def listen_messages
+      @subscription = subscribe_to_topic
+      @subscriber = subscription.listen(&method(:process_message))
+      log('Listener starting...')
+      subscriber.start
+      log('Listener started')
+      sleep
+      subscriber.stop.wait!
+      log('Listener stopped')
+    end
+
+    def publish(data, attributes)
+      log("Publishing message: #{[data, attributes]}")
+      topic.publish(data.to_json, attributes)
+    end
+
+    def stop
+      log('Listener stopping...')
+      subscriber.stop!
+    end
+
+    private
+
+    def subscribe_to_topic
+      topic.subscription(config.subscription_name) ||
+        topic.subscribe(config.subscription_name)
+    end
+
+    def process_message(received_message)
+      message = received_message.message
+      attrs = message.attributes.symbolize_keys
+      return unless attrs[:service_model_sync]
+
+      data = JSON.parse(message.data).symbolize_keys
+      args = [data, attrs[:klass], attrs[:action], attrs]
+      PubSubModelSync::MessageProcessor.new(*args).process
+    rescue => e
+      log("Error processing message: #{[received_message, e.message]}")
+    ensure
+      received_message.acknowledge!
+    end
+
+    def log(msg)
+      config.log("Google Service ==> #{msg}")
+    end
+  end
+end

data/lib/pub_sub_model_sync/service_rabbit.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'bunny'
+module PubSubModelSync
+  class ServiceRabbit
+    attr_accessor :service, :channel, :queue, :topic
+    attr_accessor :config
+    SERVICE_KEY = 'service_model_sync'
+
+    def initialize
+      @config = PubSubModelSync::Config
+      @service = Bunny.new(*config.bunny_connection)
+    end
+
+    def listen_messages
+      log('Listener starting...')
+      subscribe_to_queue
+      log('Listener started')
+      queue.subscribe(block: true, manual_ack: false, &method(:process_message))
+    rescue PubSubModelSync::Runner::ShutDown
+      raise
+    rescue => e
+      log("Error listening message: #{[e.message, e.backtrace]}")
+    end
+
+    def publish(data, attributes)
+      log("Publishing: #{[data, attributes]}")
+      subscribe_to_queue
+      payload = { data: data, attributes: attributes }
+      topic.publish(payload.to_json, routing_key: queue.name, type: SERVICE_KEY)
+    rescue => e
+      log("Error publishing: #{[data, attributes, e.message, e.backtrace]}")
+    end
+
+    def stop
+      log('Listener stopping...')
+      service.close
+    end
+
+    private
+
+    def process_message(_delivery_info, meta_info, payload)
+      return unless meta_info[:type] == SERVICE_KEY
+
+      data, attrs = parse_message_payload(payload)
+      args = [data, attrs[:klass], attrs[:action], attrs]
+      PubSubModelSync::MessageProcessor.new(*args).process
+    rescue => e
+      error = [payload, e.message, e.backtrace]
+      log("Error processing message: #{error}")
+    end
+
+    def parse_message_payload(payload)
+      message_payload = JSON.parse(payload).symbolize_keys
+      data = message_payload[:data].symbolize_keys
+      attrs = message_payload[:attributes].symbolize_keys
+      [data, attrs]
+    end
+
+    def subscribe_to_queue
+      service.start
+      @channel = service.create_channel
+      queue_settings = { durable: true, auto_delete: false }
+      @queue = channel.queue(config.queue_name, queue_settings)
+      subscribe_to_topic
+    end
+
+    def subscribe_to_topic
+      @topic = channel.topic(config.topic_name)
+      queue.bind(topic, routing_key: queue.name)
+    end
+
+    def log(msg)
+      config.log("Rabbit Service ==> #{msg}")
+    end
+  end
+end

data/lib/pub_sub_model_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PubSubModelSync
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/pub_sub_model_sync.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'google-cloud-pubsub'
   spec.add_dependency 'rails'
 
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Owen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: google-cloud-pubsub
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +105,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -132,10 +119,13 @@ files:
 - lib/pub_sub_model_sync/connector.rb
 - lib/pub_sub_model_sync/message_processor.rb
 - lib/pub_sub_model_sync/mock_google_service.rb
+- lib/pub_sub_model_sync/mock_rabbit_service.rb
 - lib/pub_sub_model_sync/publisher.rb
 - lib/pub_sub_model_sync/publisher_concern.rb
 - lib/pub_sub_model_sync/railtie.rb
 - lib/pub_sub_model_sync/runner.rb
+- lib/pub_sub_model_sync/service_google.rb
+- lib/pub_sub_model_sync/service_rabbit.rb
 - lib/pub_sub_model_sync/subscriber_concern.rb
 - lib/pub_sub_model_sync/tasks/worker.rake
 - lib/pub_sub_model_sync/version.rb