sync_machine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 594e4e0870147957bb2f36f65b6b028433bf5ee3
+  data.tar.gz: 58a8af1ae9acd3b64fdff79414d6fcc3e7499332
+SHA512:
+  metadata.gz: da5e1182ccf5d8623190e170826e122bc6b60a819a707c4f16c61167009d90140e35263ce9f634f95bf66d17065c047cbffa940320e68a475a0939b2ca48ee80
+  data.tar.gz: 0a94e81f19b4096e233fa457946c59ee5a0e669e95e908fe9e80ba9efa49b359f8a8b7ccf3517ebb7e839789057bf2c8e8b8a1b684cabaf6938653ee25f15921

data/.circleci/config.yml

@@ -0,0 +1,69 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.1-node-browsers
+      - image: circleci/mongo:3.6.9
+      - image: redis:3.2.11
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              -r rspec_junit_formatter \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec/results.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.codeclimate.yml

@@ -0,0 +1,38 @@
+version: "2"         # required to adjust maintainability checks
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 250
+  method-complexity:
+    config:
+      threshold: 5
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 25
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: 150
+  identical-code:
+    config:
+      threshold: 75
+plugins:
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+

data/.gitignore

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

data/.reek.yml

@@ -0,0 +1,9 @@
+---
+detectors:
+  DuplicateMethodCall:
+    max_calls: 3
+  UtilityFunction:
+    public_methods_only: true
+
+exclude_paths:
+  - spec

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,55 @@
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/TrailingBlankLines:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'sync_machine.gemspec'
+
+Metrics/LineLength:
+  Max: 100
+
+# Handled by Reek
+Metrics/MethodLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/EmptyMethod:
+  Exclude:
+    - 'spec/**/*'
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RandomWithOffset:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SymbolProc:
+  Exclude:
+    - 'spec/**/*'
+
+Style/UnneededPercentQ:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 2.0.1

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 sera@fhwang.net. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sync_machine.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    sync_machine (0.1.0)
+      activesupport
+      fhwang-wisper-mongoid
+      mongoid
+      sidekiq
+      wisper
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    bson (4.3.0)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    factory_bot (5.0.2)
+      activesupport (>= 4.2.0)
+    fhwang-wisper-mongoid (0.2.0)
+      mongoid (>= 6)
+      wisper
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    mongo (2.6.2)
+      bson (>= 4.3.0, < 5.0.0)
+    mongoid (6.4.2)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    rack (2.0.6)
+    rack-protection (2.0.4)
+      rack
+    rake (10.4.2)
+    redis (4.0.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    sidekiq (5.0.5)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.4, < 5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    wisper (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  factory_bot
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  sync_machine!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Francis Hwang
+
+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,43 @@
+# SyncMachine
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sync_machine`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sync_machine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sync_machine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sync_machine. 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 SyncMachine project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sync_machine/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sync_machine"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sync_machine/change_listener.rb

@@ -0,0 +1,57 @@
+require "wisper"
+
+module SyncMachine
+  # Listen to changes in any model that could result in a change to the
+  # published document, and enqueue a FindSubjectsWorker job when the change
+  # occurs.
+  class ChangeListener
+    def self.inherited(base)
+      base.cattr_accessor :model_syms
+    end
+
+    def self.listen_to_models(*model_syms)
+      self.model_syms = model_syms
+      model_syms.each do |model_sym|
+        send(
+          :alias_method,
+          "update_#{model_sym}_successful".to_sym,
+          :after_subject_saved
+        )
+      end
+    end
+
+    def self.subscribe
+      Wisper.subscribe(new)
+    end
+
+    def after_create(subject)
+      model_sym = subject.class.name.underscore.to_sym
+      return unless self.class.model_syms.include?(model_sym)
+      after_subject_saved(subject)
+    end
+
+    def after_subject_saved(subject)
+      return unless changed_keys(subject).present?
+      sync_module = SyncMachine.sync_module(self.class)
+      finder_class = sync_module.const_get('FindSubjectsWorker')
+      finder_class.perform_async(
+        subject.class.name,
+        subject.id.to_s,
+        changed_keys(subject),
+        Time.now.iso8601
+      )
+    end
+
+    private
+
+    def changed_keys(subject)
+      changed_keys = subject.changes.keys
+      subject.class.reflect_on_all_associations.each do |assoc|
+        if assoc.macro == :embeds_one && subject.send(assoc.name).try(:changed?)
+          changed_keys << assoc.name
+        end
+      end
+      changed_keys
+    end
+  end
+end

data/lib/sync_machine/ensure_publication/deduper.rb

@@ -0,0 +1,46 @@
+module SyncMachine
+  class EnsurePublication
+    # Ensures that the current job is not:
+    # 1. Currently being run by another worker
+    # 2. Rendered unnecessary by the fact another job with the same subject was
+    #    completed since the time this job was requested.
+    class Deduper
+      def initialize(enqueue_time_str:, last_job_finished_at:, job_class:, subject_id:)
+        @enqueue_time_str = enqueue_time_str
+        @job_class = job_class
+        @last_job_finished_at = last_job_finished_at
+        @subject_id = subject_id
+      end
+
+      def dedupe
+        if acquire_lock
+          begin
+            yield unless performed_since_enqueue_time?
+          ensure
+            Redis.current.del(redis_lock)
+          end
+        else
+          @job_class.perform_in(1 + rand(10), @subject_id, @enqueue_time_str)
+        end
+      end
+
+      private
+
+      def acquire_lock
+        Redis.current.set(redis_lock, "true", nx: true, ex: 10.minutes)
+      end
+
+      def enqueue_time
+        @enqueue_time ||= Time.parse(@enqueue_time_str)
+      end
+
+      def performed_since_enqueue_time?
+        @last_job_finished_at && @last_job_finished_at > enqueue_time
+      end
+
+      def redis_lock
+        "#{@job_class.name}:#{@subject_id}"
+      end
+    end
+  end
+end

data/lib/sync_machine/ensure_publication/publication_history.rb

@@ -0,0 +1,54 @@
+module SyncMachine
+  class EnsurePublication
+    # Manage logic around whether the document was previously published at all,
+    # and maintaining history for future jobs.
+    class PublicationHistory
+      def initialize(subject_id:, sync_module:)
+        @subject_id = subject_id
+        @sync_module = sync_module
+      end
+
+      def last_publish_equals?(payload_body)
+        return false unless previous_payload
+        HashWithIndifferentAccess.new(previous_payload.body) ==
+          HashWithIndifferentAccess.new(payload_body)
+      end
+
+      def last_job_finished_at
+        previous_payload.try(:generated_at)
+      end
+
+      def record_generation_time
+        previous_payload.update_attribute(:generated_at, Time.now)
+      end
+
+      def update(payload_body)
+        if previous_payload
+          previous_payload.update_attributes(
+            body: payload_body, generated_at: Time.now
+          )
+        else
+          create_payload_record(payload_body)
+        end
+      end
+
+      private
+
+      def create_payload_record(payload_body)
+        payload_class.create!(
+          body: payload_body,
+          generated_at: Time.now,
+          subject_id: @subject_id.to_s
+        )
+      end
+
+      def payload_class
+        @payload_class ||= @sync_module.const_get('Payload')
+      end
+
+      def previous_payload
+        @previous_payload ||= payload_class.where(subject_id: @subject_id).first
+      end
+    end
+  end
+end

data/lib/sync_machine/ensure_publication.rb

@@ -0,0 +1,62 @@
+module SyncMachine
+  # Orchestrate logic around a change notification and whether to publish a new
+  # document to the service.
+  class EnsurePublication
+    def initialize(enqueue_time_str:, hooks:, subject:, sync_module:)
+      @enqueue_time_str = enqueue_time_str
+      @hooks = hooks
+      @subject = subject
+      @sync_module = sync_module
+    end
+
+    def run
+      dedupe { run_deduped }
+    end
+
+    private
+
+    def call_after_publish
+      return unless (after_publish_hook = hook(:after_publish))
+      after_publish_hook.call(@subject)
+    end
+
+    def dedupe
+      deduper = Deduper.new(
+        job_class: @sync_module.const_get('EnsurePublicationWorker'),
+        last_job_finished_at: publication_history.last_job_finished_at,
+        subject_id: subject_id,
+        enqueue_time_str: @enqueue_time_str
+      )
+      deduper.dedupe { yield }
+    end
+
+    def hook(hook_sym)
+      @hooks[hook_sym]
+    end
+
+    def payload_body
+      @payload_body ||= hook(:build).call(@subject)
+    end
+
+    def publication_history
+      @publication_history ||= PublicationHistory.new(
+        subject_id: subject_id, sync_module: @sync_module
+      )
+    end
+
+    def run_deduped
+      return unless hook(:check_publishable).call(@subject)
+      if publication_history.last_publish_equals?(payload_body)
+        publication_history.record_generation_time
+      else
+        hook(:publish).call(@subject, payload_body)
+        publication_history.update(payload_body)
+      end
+      call_after_publish
+    end
+
+    def subject_id
+      @subject.id.to_s
+    end
+  end
+end

data/lib/sync_machine/ensure_publication_worker.rb

@@ -0,0 +1,39 @@
+require "active_support/core_ext/class"
+require "sidekiq"
+
+module SyncMachine
+  # Call EnsurePublication service via a Sidekiq job.
+  class EnsurePublicationWorker
+    include Sidekiq::Worker
+
+    class_attribute :hooks
+
+    [:build, :check_publishable, :publish, :after_publish].each do |hook|
+      define_singleton_method(hook) do |&block|
+        hooks[hook] = block
+      end
+    end
+
+    def self.inherited(subclass)
+      subclass.hooks = {}
+    end
+
+    def perform(subject_id, enqueue_time_str)
+      subject = find_subject(subject_id)
+      EnsurePublication.new(
+        enqueue_time_str: enqueue_time_str,
+        hooks: self.class.hooks,
+        subject: subject,
+        sync_module: SyncMachine.sync_module(self.class)
+      ).run
+    end
+
+    private
+
+    def find_subject(subject_id)
+      sync_module = SyncMachine.sync_module(self.class)
+      subject_class = sync_module.subject_class
+      subject_class.find(subject_id)
+    end
+  end
+end

data/lib/sync_machine/find_subjects_worker.rb

@@ -0,0 +1,60 @@
+require "sidekiq"
+
+module SyncMachine
+  # After one observed model has changed, find all relevant subjects whose
+  # documents may have changed.  Enqueues one EnsurePublicationWorker job for
+  # each relevant subject.
+  class FindSubjectsWorker
+    include Sidekiq::Worker
+
+    class_attribute :hooks
+
+    def self.inherited(subclass)
+      subclass.hooks = {}
+    end
+
+    def self.method_missing(meth, *args, &block)
+      if meth.to_s =~ /^subject_ids_from_.*/
+        hooks[meth] = Hook.new(block)
+      else
+        super
+      end
+    end
+
+    # :reek:LongParameterList is unavoidable here since this is a Sidekiq
+    # worker
+    def perform(record_class_name, record_id, changed_keys, enqueue_time)
+      record = record_class_name.constantize.find(record_id)
+      source_ids = find_source_ids(record, changed_keys)
+      (source_ids || []).each do |source_id|
+        self.class.parent.const_get('EnsurePublicationWorker').perform_async(
+          source_id, enqueue_time
+        )
+      end
+    end
+
+    private
+
+    def find_source_ids(record, changed_keys)
+      hook_name = (
+        "subject_ids_from_" + record.class.name.gsub(/::/, '').underscore).to_sym
+      self.class.hooks[hook_name].call(record, changed_keys)
+    end
+
+    # Wrap a "subject_ids_from_*" block.
+    class Hook
+      def initialize(block)
+        @block = block
+      end
+
+      def call(record, changed_keys)
+        raw_source_ids = if @block.arity == 2
+                           @block.call(record, changed_keys)
+                         else
+                           @block.call(record)
+                         end
+        Array.wrap(raw_source_ids).map(&:to_s)
+      end
+    end
+  end
+end

data/lib/sync_machine/version.rb

@@ -0,0 +1,3 @@
+module SyncMachine
+  VERSION = "0.1.0".freeze
+end

data/lib/sync_machine.rb

@@ -0,0 +1,56 @@
+require "active_support/core_ext/class"
+require "active_support/core_ext/string"
+require "mongoid"
+require "sync_machine/change_listener"
+require "sync_machine/ensure_publication"
+require "sync_machine/ensure_publication/deduper"
+require "sync_machine/ensure_publication/publication_history"
+require "sync_machine/ensure_publication_worker"
+require "sync_machine/find_subjects_worker"
+require "sync_machine/version"
+require "wisper/mongoid"
+
+# A mini-framework for intelligently publishing complex model changes to an
+# external API..
+module SyncMachine
+  def self.extended(base)
+    base.mattr_accessor :subject_sym
+  end
+
+  def self.sync_module(child_const)
+    child_const.name.split(/::/).first.constantize
+  end
+
+  def subject(subject_sym)
+    self.subject_sym = subject_sym
+  end
+
+  def subject_class
+    subject_sym.to_s.camelize.constantize
+  end
+
+  def setup
+    define_payload_class unless const_defined?('Payload')
+    const_get('ChangeListener').subscribe
+  end
+
+  # :reek:TooManyStatements is unavoidable with this sort of dynamic class
+  # definition
+  def define_payload_class
+    collection_name = name.underscore + '_payloads'
+    payload_class = Class.new do
+      include Mongoid::Document
+      store_in collection: collection_name
+
+      field :body, type: Hash
+      field :generated_at, type: Time
+      field :subject_id, type: String
+
+      validates :generated_at, presence: true
+      validates :subject_id, presence: true, uniqueness: true
+    end
+    const_set('Payload', payload_class)
+  end
+end
+
+Wisper::Mongoid.extend_all

data/sync_machine.gemspec

@@ -0,0 +1,49 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sync_machine/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sync_machine"
+  spec.version       = SyncMachine::VERSION
+  spec.authors       = ["Francis Hwang"]
+  spec.email         = ["sera@fhwang.net"]
+
+  spec.summary       =
+    %q{A mini-framework for intelligently publishing complex model changes to an external API.}
+  spec.description   =
+    %q{A mini-framework for intelligently publishing complex model changes to an external API.}
+  spec.homepage      = "https://github.com/fhwang/sync_machine"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/fhwang/sync_machine"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "fhwang-wisper-mongoid"
+  spec.add_runtime_dependency "mongoid"
+  spec.add_runtime_dependency "sidekiq"
+  spec.add_runtime_dependency "wisper"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "factory_bot"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: sync_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francis Hwang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: fhwang-wisper-mongoid
+  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: mongoid
+  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: sidekiq
+  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: wisper
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A mini-framework for intelligently publishing complex model changes to
+  an external API.
+email:
+- sera@fhwang.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sync_machine.rb
+- lib/sync_machine/change_listener.rb
+- lib/sync_machine/ensure_publication.rb
+- lib/sync_machine/ensure_publication/deduper.rb
+- lib/sync_machine/ensure_publication/publication_history.rb
+- lib/sync_machine/ensure_publication_worker.rb
+- lib/sync_machine/find_subjects_worker.rb
+- lib/sync_machine/version.rb
+- sync_machine.gemspec
+homepage: https://github.com/fhwang/sync_machine
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fhwang/sync_machine
+  source_code_uri: https://github.com/fhwang/sync_machine
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A mini-framework for intelligently publishing complex model changes to an
+  external API.
+test_files: []