sequenced_mailer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f10a1518274cbebdac21ddee3a8fe759b53bba5f65601991025bad9822d53ca6
+  data.tar.gz: 2675de6f53963f9cd1ce5fc8e9f0e6e97811a6b7ec5d170f2a8cf5f225c92ce5
+SHA512:
+  metadata.gz: a8071455c749d4facad14150af141f65ed425c6743b20aad4ca257cd47a837db8727e434400d8f0ddeb4e2f588f1e27e43917a2a9abd79afd192c7303df5e8d9
+  data.tar.gz: 2e41f703928a33497433ebb6b942a03077c05bf1bf8bcd8b93775252cdd325bfd303362e85df9edd50a4d9469daa4ec597426e8ac1be1f4bd4f0c6b793a9fb14

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at thomas@rougecardinal.fr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Thomas Darde
+
+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,30 @@
+# SequencedMailer
+
+Allow to send emails at a specific time
+Allow to send a serie of emails
+
+
+
+## Installation & Setup
+
+To install add the following to your Gemfile:
+
+```ruby
+  gem 'sequenced_mailer'
+```
+
+
+To setup just run:
+
+```bash
+  $ rake sequenced_mailer:setup
+```
+
+and follow the guide!
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: [:spec, :standard]

data/app/concerns/mailing/sequenceable.rb

@@ -0,0 +1,27 @@
+module Mailing::Sequenceable
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :sequence_owners, class_name: "Mailing::SequenceOwner", dependent: :destroy, inverse_of: :owner, as: :owner
+
+    def add_to_sequence(name)
+      logger.debug { "Will try to add to sequence: #{name}" }
+      sequence = Mailing::Sequence.find_by(name: name)
+      return unless sequence.present?
+
+      if sequence_owners.where(mailing_sequence_id: sequence.id, canceled_at: nil).any?
+        logger.debug { "User is already in the sequence" }
+        return
+      end
+      logger.debug { "Sequence found: #{sequence.name} with #{sequence.steps.count} step" }
+      sequence_owners.create(sequence: sequence)
+    end
+
+    def cancel_sequence(name)
+      sequence_owner = sequence_owners.joins(:sequence).where(sequence: { name: name }).first
+      return if sequence_owner.blank?
+
+      sequence_owner.cancel!
+    end
+  end
+end

data/app/models/mailing/sequence.rb

@@ -0,0 +1,41 @@
+class Mailing::Sequence < ActiveRecord::Base
+  validates :name, presence: true, uniqueness: true
+
+  has_many :sequence_owners, class_name: "Mailing::SequenceOwner", dependent: :destroy, inverse_of: :sequence, foreign_key: "mailing_sequence_id"
+  has_many :steps, class_name: "Mailing::SequenceStep", dependent: :destroy, foreign_key: :mailing_sequence_id, inverse_of: :sequence
+  has_many :owners, through: :sequence_owners, source_type: "User"
+
+  def self.name_and_steps_count
+    left_joins(:steps).group(:name).count("mailing_sequence_steps.id")
+  end
+
+  #  Mailing::Sequence.send_mails(dry_run: true)
+  def self.send_mails(dry_run: false)
+    name_and_steps_count.each do |name, steps_count|
+      logger.debug { "Sending mails for #{name} (#{steps_count} steps)" }
+      Mailing::SequenceOwner.joins(:sequence).where(sequence: {name: name}).where("current_step < ? ", steps_count).where(canceled_at: nil).each do |owner|
+        logger.debug { "\tVerify to send mail to #{owner.owner_name} current_step is #{owner.current_step}" }
+        owner.send_next_step_if_ready(dry_run: dry_run)
+      end
+    end
+  end
+
+  def self.sequences_and_steps_names
+    {"onboarding_admin_sigilium" => {user_promoted: 0},
+     "onboarding_sigilium" => {welcome: 1},
+     "subscription_failed_payment" => {first_alert: 1}}
+  end
+
+  def self.seed
+    sequences_and_steps_names.each do |sequence_name, steps_details|
+      sequence = Mailing::Sequence.find_or_create_by(name: sequence_name)
+      steps_details.each.with_index do |step_details, index|
+        step_name, days_after_last_step = step_details
+        step = sequence.steps.find_or_initialize_by(name: step_name)
+        step.days_after_last_step = days_after_last_step
+        step.position = index + 1
+        step.save!
+      end
+    end
+  end
+end

data/app/models/mailing/sequence_owner.rb

@@ -0,0 +1,61 @@
+class Mailing::SequenceOwner < ActiveRecord::Base
+  belongs_to :sequence, class_name: "Mailing::Sequence", foreign_key: "mailing_sequence_id", inverse_of: :sequence_owners
+  belongs_to :owner, polymorphic: true
+  delegate :steps, to: :sequence
+  after_create :send_next_step_if_ready
+
+  delegate :name, to: :next_step, prefix: true
+  delegate :name, to: :owner, prefix: true
+  delegate :name, to: :sequence, prefix: true
+
+  def owner_name
+    if owner.respond_to?(:full_name)
+      owner.full_name
+    else
+      owner.name
+    end
+  end
+
+  def description
+    ["Sequence: #{sequence_name}", "Owner: #{owner_name}", "Step: #{next_step_name}"].join(" - ")
+  end
+
+  def cancel!
+    update!(canceled_at: Time.zone.now)
+  end
+
+  def canceled?
+    canceled_at.present?
+  end
+
+  def send_next_step_if_ready(dry_run: false)
+    # First email is sent at creation if no delay is set
+    # This method is then called every day of the week
+
+    if ready_to_send_next_step?
+      logger.debug { "Will send email to owner" }
+      next_step.send_to_owner(self) unless dry_run
+    else
+      logger.debug { "Not ready to send next step" }
+      nil
+    end
+  end
+
+  def ready_to_send_next_step?
+    return false if canceled?
+    return false if last_step?
+    next_step.ready_to_send?(last_activity_at)
+  end
+
+  def last_step?
+    next_step.blank?
+  end
+
+  def next_step
+    @next_step ||= steps.where("position > ?", current_step).order(position: :asc).first
+  end
+
+  def last_activity_at
+    last_email_sent_at.presence || created_at
+  end
+end

data/app/models/mailing/sequence_step.rb

@@ -0,0 +1,37 @@
+class Mailing::SequenceStep < ActiveRecord::Base
+  belongs_to :sequence, class_name: "Mailing::Sequence", foreign_key: "mailing_sequence_id", inverse_of: :steps
+
+  def ready_to_send?(last_activity_at)
+    return true if days_after_last_step == 0
+    last_activity_at.beginning_of_day + days_after_last_step.days <= Time.zone.now
+  end
+
+  def send_to_owner(sequence_owner)
+    # on a un scheduler qui appel les mails à envoyer les jours ouvrés
+    #
+
+    send_the_mail(sequence_owner.owner)
+    sequence_owner.current_step = position
+    sequence_owner.last_email_sent_at = Time.zone.now
+    sequence_owner.save
+  end
+
+  def send_the_mail(owner)
+    # InstallationMailer.user_promoted(owner.becomes(User)).deliver_later
+    SequenceMailer.send(email_name, casted_owner(owner)).deliver_later
+  end
+
+  def email_name
+    [sequence.name, name].join("_")
+  end
+
+  def casted_owner(owner)
+    # Avoid an issue with serialization
+    case owner.class.name
+    when "CompanyAdmin", "OrganizationAdmin", "SimpleUser"
+      owner.becomes(User)
+    else
+      owner
+    end
+  end
+end

data/app/models/mailing.rb

@@ -0,0 +1,5 @@
+module Mailing
+  def self.table_name_prefix
+    "mailing_"
+  end
+end

data/lib/generators/sequenced_mailer/install_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators"
+require File.expand_path("utils", __dir__)
+
+module SequencedMailer
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+    include Rails::Generators::Migration
+
+    desc "This generator creates the migrations for sequenced_mailer"
+    def create_sequenced_mailer_migrations_file
+      migration_template "migration.rb", "db/migrate/create_sequenced_mailer_tables.rb"
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        format("%.3d", (current_migration_number(dirname) + 1))
+      end
+    end
+  end
+end

data/lib/generators/sequenced_mailer/templates/migration.rb

@@ -0,0 +1,36 @@
+class CreateSequencedMailerTables < ActiveRecord::Migration[7.0]
+  def self.up
+    create_table :mailing_sequences do |t|
+      t.string :name, null: false
+
+      t.timestamps
+    end
+
+    add_index :mailing_sequences, :name, unique: true
+
+    create_table :mailing_sequence_steps do |t|
+      t.string :name, null: false
+      t.integer :days_after_last_step, null: false
+      t.integer :position, null: false
+      t.references :mailing_sequence, null: false, foreign_key: true
+
+      t.timestamps
+    end
+
+    create_table :mailing_sequence_owners do |t|
+      t.references :mailing_sequence, null: false, foreign_key: true
+      t.references :owner, polymorphic: true, null: false
+      t.integer :current_step, null: false, default: 0
+      t.datetime :last_email_sent_at
+      t.datetime :canceled_at
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :mailing_sequences
+    drop_table :mailing_sequence_steps
+    drop_table :mailing_sequence_owners
+  end
+end

data/lib/generators/sequenced_mailer/utils.rb

@@ -0,0 +1,24 @@
+module SequencedMailer
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+
+        def ask_for(wording, default_value = nil, override_if_present_value = nil)
+          if override_if_present_value.present?
+            display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value
+          else
+            ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
+          end
+        end
+
+        def ask_boolean(wording, _default_value = nil)
+          value = ask_for(wording, 'Y')
+          value = (value == 'Y')
+        end
+      end
+    end
+  end
+end

data/lib/sequenced_mailer/railtie.rb

@@ -0,0 +1,7 @@
+module SequencedMailer
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "sequenced_mailer/tasks.rb"
+    end
+  end
+end

data/lib/sequenced_mailer/tasks.rb

@@ -0,0 +1,8 @@
+namespace :sequenced_mailer do
+  desc "Add database tables for SequencedMailer"
+  task setup: :environment do
+    system "rails g sequenced_mailer:install"
+
+    Rake::Task["db:migrate"].invoke
+  end
+end

data/lib/sequenced_mailer/version.rb

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

data/lib/sequenced_mailer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "sequenced_mailer/version"
+require "rails"
+require "sequenced_mailer/railtie" if defined?(Rails::Railtie)
+require_relative "../app/models/mailing"
+require_relative "../app/models/mailing/sequence"
+require_relative "../app/models/mailing/sequence_owner"
+require_relative "../app/models/mailing/sequence_step"
+require_relative "../app/concerns/mailing/sequenceable"
+module SequencedMailer
+  class Error < StandardError; end
+  Mailing::Sequence
+  Mailing::SequenceOwner
+  Mailing::SequenceStep
+  Mailing::Sequenceable
+end

data/sig/sequenced_mailer.rbs

@@ -0,0 +1,4 @@
+module SequencedMailer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: sequenced_mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Darde
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+description: Send emails at a specific time, in sequence
+email:
+- thomas@rougecardinal.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/concerns/mailing/sequenceable.rb
+- app/models/mailing.rb
+- app/models/mailing/sequence.rb
+- app/models/mailing/sequence_owner.rb
+- app/models/mailing/sequence_step.rb
+- lib/generators/sequenced_mailer/install_generator.rb
+- lib/generators/sequenced_mailer/templates/migration.rb
+- lib/generators/sequenced_mailer/utils.rb
+- lib/sequenced_mailer.rb
+- lib/sequenced_mailer/railtie.rb
+- lib/sequenced_mailer/tasks.rb
+- lib/sequenced_mailer/version.rb
+- sig/sequenced_mailer.rbs
+homepage: https://github.com/thomasdarde/sequenced_mailer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/thomasdarde/sequenced_mailer
+  source_code_uri: https://github.com/thomasdarde/sequenced_mailer
+  changelog_uri: https://github.com/thomasdarde/sequenced_mailer/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: Send emails in sequence.
+test_files: []