pub_sub_model_sync 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2474d763e9b95cd2ddf83284ed095af1e1c8d53fe4ffc89fbe7249e8c198d38b
+  data.tar.gz: 87ab9ca1c4167ebf314c1bdbd48bd7216e7e1036acbbb2a6c93f82ddd7bb80e6
+SHA512:
+  metadata.gz: 7a9ecb33cb7e85a76d797de1e390cf2a6a1086c245512695e46610cc18c1fa9273c821002177d30bc78ffe4159239733f287a665b69ded4f0d4490486072ff97
+  data.tar.gz: be9b8bf52ae416e9bf2667c3a6aa18cbbdc30aad265d71f00f1b90594a1f09d5a7498843e6f5361dd1562f151f0a7d73b7166bc4351fe02992a4dd1080ec587c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'spec/spec_helper.rb'
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/*'
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+
+Style/SymbolArray:
+  Exclude:
+    - 'Gemfile'
+
+Style/Documentation:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 2.0.2
+
+script:
+  - bundle install
+  # disabled cause of: An error occurred while Style/PercentLiteralDelimiters cop
+  # - bundle exec rubocop
+  - bundle exec rspec

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at owenperedo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+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

@@ -0,0 +1,220 @@
+PATH
+  remote: .
+  specs:
+    pub_sub_model_sync (0.1.2)
+      activesupport
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      actionview (= 5.2.4.1)
+      activejob (= 5.2.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4.1)
+      actionview (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.1)
+      activesupport (= 5.2.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.4.1)
+      activesupport (= 5.2.4.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4.1)
+      activesupport (= 5.2.4.1)
+    activerecord (5.2.4.1)
+      activemodel (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      arel (>= 9.0)
+    activestorage (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      activerecord (= 5.2.4.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      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)
+    erubi (1.9.0)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    google-cloud-core (1.3.2)
+      google-cloud-env (~> 1.0)
+    google-cloud-env (1.2.1)
+      faraday (~> 0.11)
+    google-cloud-pubsub (1.0.2)
+      concurrent-ruby (~> 1.1)
+      google-cloud-core (~> 1.2)
+      google-gax (~> 1.7)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      grpc-google-iam-v1 (~> 0.6.9)
+    google-gax (1.7.1)
+      google-protobuf (~> 3.2)
+      googleapis-common-protos (>= 1.3.5, < 2.0)
+      googleauth (>= 0.6.2, < 0.10.0)
+      grpc (>= 1.7.2, < 2.0)
+      rly (~> 0.2.3)
+    google-protobuf (3.11.4-universal-darwin)
+    googleapis-common-protos (1.3.9)
+      google-protobuf (~> 3.0)
+      googleapis-common-protos-types (~> 1.0)
+      grpc (~> 1.0)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    googleauth (0.9.0)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    grpc (1.27.0-universal-darwin)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-google-iam-v1 (0.6.9)
+      googleapis-common-protos (>= 1.3.1, < 2.0)
+      grpc (~> 1.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jwt (2.2.1)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    memoist (0.16.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    os (1.0.1)
+    parallel (1.19.1)
+    parser (2.7.0.4)
+      ast (~> 2.4.0)
+    public_suffix (4.0.3)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.1)
+      actioncable (= 5.2.4.1)
+      actionmailer (= 5.2.4.1)
+      actionpack (= 5.2.4.1)
+      actionview (= 5.2.4.1)
+      activejob (= 5.2.4.1)
+      activemodel (= 5.2.4.1)
+      activerecord (= 5.2.4.1)
+      activestorage (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rly (0.2.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  bunny
+  google-cloud-pubsub
+  pub_sub_model_sync!
+  rake
+  rspec
+  rubocop
+  sqlite3
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Owen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,183 @@
+# PubSubModelSync
+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 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, 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
+
+- Configuration for google pub/sub (You need google pub/sub service account)
+    ```ruby
+    # 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 in the app that has subscribers)
+    ```ruby
+    rake pub_sub_model_sync:start
+    ```
+    Note: Publishers do not need todo this
+
+## Examples
+```ruby
+# App 1
+# attributes: name email age 
+class User < ActiveRecord::Base
+  include PubSubModelSync::PublisherConcern
+  ps_msync_publish(%i[name email])
+end
+
+# App 2
+class User < ActiveRecord::Base
+  include PubSubModelSync::SubscriberConcern
+  ps_msync_subscribe(%i[name])
+  ps_msync_class_subscribe(:greeting)
+
+  def self.greeting(data)
+    puts 'Class message called'
+  end
+end
+
+# Samples
+User.create(name: 'test user') # Review your App 2 to see the created user (only name will be saved)
+User.ps_msync_class_publish({ msg: 'Hello' }, action: :greeting) # User.greeting method (Class method) will be called in App2
+```
+
+## Advanced Example
+```ruby
+# App 1
+class User < ActiveRecord::Base
+  self.table_name = 'publisher_users'
+  include PubSubModelSync::PublisherConcern
+  ps_msync_publish(%i[name], actions: %i[update], as_klass: 'Client', id: :client_id)
+  
+  def ps_msync_skip_for?(_action)
+    false # here logic with action to skip push message
+  end
+end
+
+# App 2
+class User < ActiveRecord::Base
+  self.table_name = 'subscriber_users'
+  include PubSubModelSync::SubscriberConcern
+  ps_msync_subscribe(%i[name], actions: %i[update], as_klass: 'Client', id: :custom_id)
+  ps_msync_class_subscribe(:greeting, as_action: :custom_greeting, as_klass: 'CustomUser')
+  
+  def self.greeting(data)
+    puts 'Class message called through custom_greeting'
+  end
+end
+```
+
+## Testing
+- Rspec: (spec/rails_helper.rb)
+    ```ruby
+      
+      # 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
+    # Subscriber
+    it 'receive model message' do
+      action = :create
+      data = { name: 'name' }
+      user_id = 999
+      attrs = PubSubModelSync::Publisher.build_attrs('User', action, user_id)
+      publisher = PubSubModelSync::MessageProcessor.new(data, 'User', action, id: user_id)
+      publisher.process
+      expect(User.where(id: user_id).any?).to be_truth
+    end
+      
+    it 'receive class message' do
+      action = :greeting
+      data = { msg: 'hello' }
+      publisher = PubSubModelSync::MessageProcessor.new(data, 'User', action)
+      publisher.process
+      expect(User).to receive(action)
+    end
+  
+    # Publisher
+    it 'publish model action' do
+      publisher = PubSubModelSync::Publisher  
+      data = { name: 'hello'}
+      action = :create
+      User.ps_msync_class_publish(data, action: action)
+      user = User.create(name: 'name', email: 'email')
+      expect_any_instance_of(publisher).to receive(:publish_model).with(user, :create, anything)
+    end
+       
+    it 'publish class message' do
+      publisher = PubSubModelSync::Publisher  
+      data = {msg: 'hello'}
+      action = :greeting
+      User.ps_msync_class_publish(data, action: action)
+      expect_any_instance_of(publisher).to receive(:publish_data).with('User', data, action)
+    end
+    ```
+    
+    There are two special methods to extract crud configuration settings (attrs, id, ...):
+    
+    Subscribers: ```User.ps_msync_subscriber_settings```
+    
+    Publishers: ```User.ps_msync_publisher_settings```
+    
+    Note: Inspect all configured listeners with: 
+    ``` PubSubModelSync::Config.listeners ```
+
+## Contributing
+
+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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PubSubModelSync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pub_sub_model_sync/blob/master/CODE_OF_CONDUCT.md).