actor_sync 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5f9f5654cdec9203414a628d5201e85dde64d52f4abaf9295e344af868b436b
+  data.tar.gz: 9a4e76d74e49f1439a92f1227fa6c8836d758a4bf52f6c472088e960222cff58
+SHA512:
+  metadata.gz: 899e7fd172a818377a4de0d2b914edbe350be8eac609dd977d3305572ac8b49d4d2aa3777593c6820eb99dc8713fd053a5bd3017c08e20eb8a992a2b487e5335
+  data.tar.gz: 4bd1456b2a145087dda48c42efd2945022f63fb534117fd38e88412b3d7b09b03cb04cb0c890d8d2b1cc16d98d9911a8031de49df1063fa199b87f918d645045

data/.github/workflows/unit-tests.yml

@@ -0,0 +1,35 @@
+name: Unit testing
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Ruby 2.7.2
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Repository
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+
+      - name: Set up gems cache
+        uses: actions/cache@preview
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-ruby-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-ruby-
+
+      - name: Install Ruby dependencies
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --without rubocop --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in actor_sync.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'zeitwerk', '~> 2.4.2'
+
+group :development do 
+  gem 'webmock', '>= 3.8.0'
+end
+
+# TODO: Ideally this should not live in the main gem.
+# Adapters
+gem 'mixpanel-ruby'
+gem 'sendgrid-ruby'
+gem 'analytics-ruby'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Subomi Oluwalana
+
+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,59 @@
+# Actor Sync
+Automatically synchronise actor information to your third party systems e.g. Mixpanel, Sendgrid, Segment etc. 
+
+## Getting Started
+`config/initializers/actor_sync.rb`
+
+```ruby
+ActorSync.configure do |config|
+   config.sync = true
+   config.mixpanel = { project_token: '' }
+   config.mailchimp = { api_key: '' }
+end
+```
+
+`app/models/user.rb`
+```ruby
+class User < ApplicationRecord
+   include ActorSync
+
+   actor_sync :mixpanel, user_profile: true
+   actor_sync :mailchimp, audience: monthly_mailing_lists
+
+   def data_to_export_to_mixpanel
+      {
+         '$first_name': profile.first_name,
+         '$last_name': profile.last_name,
+         '$email': email
+      }
+   end
+end
+```
+
+`app/models/company.rb`
+```ruby
+class Company < ApplicationRecord
+   include ActorSync
+
+   actor_sync :mixpanel, group_profile: true
+
+   def data_to_export_to_mixpanel
+      {
+         '$name': name,
+         'products': products_count
+      }
+   end
+end
+
+```
+
+# TODO
+- Write tests.
+- Build plugin system.
+- Add Instrumentation
+- Add support for other activejob backends - Resque etc.
+- Add support for NoSQL Databases
+- Add support for Sinatra (Non-Rails environment)
+- More documentation
+- Add rake tasks to manually sync data
+- Add support for mixpanel lookup tables

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/actor_sync.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/actor_sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'actor_sync'
+  spec.version       = ActorSync::VERSION
+  spec.authors       = ['Subomi']
+  spec.email         = ['subomioluwalana71@gmail.com']
+
+  spec.summary       = 'Automatically synchronise actor information to your third party systems e.g. Mixpanel, Sendgrid, etc.'
+  spec.homepage      = 'https://github.com/Subomi/ActorSync'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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(__dir__)) 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 'mixpanel-ruby'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'listen', '~> 3.0'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actor_sync"
+
+# 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/actor_sync/adapters/intercom.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActorSync
+  module Adapters
+    class Intercom
+    end
+  end
+end

data/lib/actor_sync/adapters/mixpanel.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module ActorSync
+  module Adapters
+    module Mixpanel
+
+      class UnknownActionError < StandardError
+        def message
+          'action provided in options isn\'t legal'
+        end
+      end
+
+      class DataMethodNotFoundError < StandardError
+        def message
+          'actor must define data_to_export_to_mixpanel'
+        end
+      end
+
+      class User
+        def initialize(distinct_id, tracker, data, action)
+          @distinct_id = distinct_id
+          @tracker = tracker
+          @data = data
+          @action = action
+        end
+
+        def call
+          create if [:create, :update].include? @action
+          destroy if @action == :destroy
+        end
+
+        def create
+          @tracker.people.set(@distinct_id, @data)
+        end
+
+        def destroy
+          @tracker.people.delete_user(@distinct_id)
+        end
+      end
+
+      class Group 
+        def initialize(group_key, group_id, tracker, data, action)
+          @group_key = group_key
+          @group_id = group_id
+          @tracker = tracker
+          @data = data
+          @action = action
+        end
+
+        def call
+          create if [:create, :update].include? @action
+          destroy if @action == :destroy
+        end
+
+        def create
+          @tracker.groups.set(@group_key, @group_id, @data)
+        end
+
+        def destroy
+          @tracker.groups.delete_group(@group_key, @group_id)
+        end
+      end
+
+      class << self
+
+        def send(actor, options, config)
+          @config = config
+          action = retrieve_action options
+          data = retrieve_data(actor)
+
+          case 
+          when !options[:group].nil?
+            Group.new(actor.class.name, actor.id, tracker, data, action).call
+          else # Default to user profiles.
+            User.new(actor.id, tracker, data, action).call
+          end
+        end
+  
+        private
+        
+        def tracker
+          @tracker ||= ::Mixpanel::Tracker.new(@config.mixpanel[:project_token])
+        end
+  
+        def retrieve_data(actor)
+          raise DataMethodNotFoundError unless actor.respond_to?(:data_to_export_to_mixpanel)
+          actor.data_to_export_to_mixpanel
+        end
+
+        def retrieve_action(options)
+          action = options[:callback_type]
+          raise UnknownActionError unless %i(create update destroy).include?(action)
+          action
+        end
+      end
+    end
+  end
+end

data/lib/actor_sync/adapters/segment.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActorSync
+  module Adapters
+    class Segment
+      def initialize(actor)
+        @actor = actor
+      end
+  
+      def send
+        analytics = Segment::Analytics.new(write_key: ENV['SEGMENT_WRITE_KEY'])
+        analytics.identify(@actor.id, traits: data)
+      end
+  
+      private
+  
+      def data
+        @actor.data_to_segment
+      end
+    end
+  end
+end

data/lib/actor_sync/adapters/sendgrid.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActorSync
+  module Adapters
+    class Sendgrid
+      def initialize(actor)
+        @actor = actor
+      end
+  
+      def send
+        sg = Sendgrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+        sg.client.marketing.contacts.put(request_body: data)
+      end
+  
+      def data
+        @actor.data_to_sendgrid
+      end
+    end
+  end
+end

data/lib/actor_sync/adapters.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string'
+
+module ActorSync
+  module Adapters
+    class << self
+      def get_adapter_klass(destination)
+        klass = "ActorSync::Adapters::#{destination.to_s.camelize}"
+        klass.constantize
+      end
+    end
+  end
+end

data/lib/actor_sync/configuration.rb

@@ -0,0 +1,8 @@
+module ActorSync
+  class Configuration
+
+    class << self
+      attr_accessor :sync, :mixpanel, :sengrid
+    end
+  end
+end

data/lib/actor_sync/sync.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActorSync
+  class Sync
+    def initialize(actor, destination, opts = {})
+      @actor = actor
+      @destination = destination
+      @options = opts
+    end
+  
+    def call
+      Worker.perform_later(@actor.class, @actor.id, @destination, @options) if config.sync
+    end
+  
+    private 
+    
+    def config
+      Configuration
+    end
+  end
+end

data/lib/actor_sync/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActorSync
+  VERSION = "0.1.3"
+end

data/lib/actor_sync/worker.rb

@@ -0,0 +1,12 @@
+module ActorSync
+  class Worker < ::ApplicationJob
+    queue_as :default
+
+    def perform(actor_klass, actor_id, destination, options)
+      actor = actor_klass.find(actor_id)
+      adapter_klass = Adapters.get_adapter_klass(destination)
+
+      adapter_klass.send(actor, options, Configuration)
+    end
+  end
+end

data/lib/actor_sync.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'mixpanel-ruby'
+require 'zeitwerk'
+
+GEM_PATH = File.expand_path('..', __dir__)
+
+loader = Zeitwerk::Loader.for_gem
+loader.enable_reloading
+loader.setup
+
+module ActorSync
+  class Error < StandardError; end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def self.configure 
+    yield Configuration if block_given?
+  end
+
+  module ClassMethods
+    # Generate an instance method to be passed to after_commit
+    # Call class method after_commit & pass earlier defined instance method.
+    def actor_sync(destination, opts = {})
+      callback_types = %i(create update destroy)
+
+      callback_types.each do |callback_name|
+        method_name = "export_to_#{destination}_on_#{callback_name}"
+
+        instance_eval do
+          define_method method_name  do
+            opts[:callback_type] = callback_name
+            Sync.new(self, destination, opts).call
+          end
+        end
+
+        class_eval <<-METHODS, __FILE__, __LINE__ + 1
+          after_commit :#{method_name}, on: :#{callback_name}
+        METHODS
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: actor_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Subomi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  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: 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: pry
+  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: listen
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+description: 
+email:
+- subomioluwalana71@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/unit-tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- actor_sync.gemspec
+- bin/console
+- bin/setup
+- lib/actor_sync.rb
+- lib/actor_sync/adapters.rb
+- lib/actor_sync/adapters/intercom.rb
+- lib/actor_sync/adapters/mixpanel.rb
+- lib/actor_sync/adapters/segment.rb
+- lib/actor_sync/adapters/sendgrid.rb
+- lib/actor_sync/configuration.rb
+- lib/actor_sync/sync.rb
+- lib/actor_sync/version.rb
+- lib/actor_sync/worker.rb
+homepage: https://github.com/Subomi/ActorSync
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Subomi/ActorSync
+  source_code_uri: https://github.com/Subomi/ActorSync
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Automatically synchronise actor information to your third party systems e.g.
+  Mixpanel, Sendgrid, etc.
+test_files: []